mijiaAPI 1.1.0__tar.gz → 1.2.0__tar.gz

mijiaapi-1.2.0/.gitignore

@@ -0,0 +1,8 @@
+jsons/*
+!.gitkeep
+*.pyc
+build
+dist
+*.png
+*.egg-info
+scripts

mijiaapi-1.2.0/.vscode/launch.json

@@ -0,0 +1,40 @@
+{
+    // 使用 IntelliSense 了解相关属性。
+    // 悬停以查看现有属性的描述。
+    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "current file",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal"
+        },
+        {
+            "name": "test_login",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "demos/test_login.py",
+            "console": "integratedTerminal",
+            "env": {
+                "XIAOMI_USERNAME": "xxxx",
+                "XIAOMI_PASSWORD": "xxxx"
+            }
+        },
+        {
+            "name": "test_QRlogin",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "demos/test_QRlogin.py",
+            "console": "integratedTerminal"
+        },
+        {
+            "name": "test_apis",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "demos/test_apis.py",
+            "console": "integratedTerminal"
+        }
+    ]
+}

{mijiaAPI-1.1.0 → mijiaapi-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mijiaAPI
-Version: 1.1.0
+Version: 1.2.0
 Summary: A Python API for Xiaomi Mijia
 Home-page: https://github.com/Do1e/mijia-api
 Author: Do1e
@@ -29,24 +29,33 @@ pip install mijiaAPI
 ## 使用
 使用实例可以参考`demos`文件夹下的示例代码，以下是简单的使用说明
 
-有两个类分别用于登录和API调用
+有三个类分别用于登录和API调用
 
 * `mijiaLogin`：登录小米账号，获取控制设备必须的`userId`, `ssecurity`, `deviceId`, `serviceToken`，方法列表
   * `login(username: str, password: str) -> dict`：账号密码登录，返回上述信息
   * `QRlogin() -> dict`：扫描二维码登录，返回上述信息（会在支持tty的终端打印二维码，若打印识别可查看当前文件夹下的`qr.png`）
 
 * `mijiaAPI`：API的实现，使用`mijiaLogin`登录后返回的信息进行初始化
-  * `__init__(self, auth_data: dict)`：初始化
+  * `__init__(auth_data: dict)`：初始化
+  * `available -> bool`：传入的`auth_data`是否有效
   * `get_devices_list() -> list`：获取设备列表
   * `get_homes_list() -> list`：获取家庭列表，家庭字典中包含房间列表
   * `get_scenes_list(home_id: str) -> list`：获取手动场景列表，在 *米家->添加->手动控制* 中设置
   * `run_scene(scene_id: str) -> bool`：运行手动场景
-  * `get_consumable_items(did: str) -> list`：获取设备的耗材信息，`did`为设备id，在设备列表中获取
+  * `get_consumable_items(home_id: str) -> list`：获取设备的耗材信息
   * `get_devices_prop(data: list) -> list`：获取设备的属性
   * `set_devices_prop(data: list) -> list`：设置设备的属性
     * `data`为一个字典的列表，字典需要包含`did`, `siid`, `piid`，后面两个键可从 *https://home.miot-spec.com/spec/{model}* 中获取，其中`model`为设备的model，在设备列表中获取，如[米家台灯 1S](https://home.miot-spec.com/spec/yeelink.light.lamp4)。
     * 网站上的方法并非全部可用，需要自行测试
 
+
+* `mijiaDevices`：使用`mijiaAPI`和设备属性字典初始化，以便更方便地调用设备属性
+  * `__init__(api: mijiaAPI, dev_info: dict. did: str = None, sleep_time: float = 0.5)`：初始化，`dev_info`为设备属性，参考[demos/dev_info_example](demos/dev_info_example)，`sleep_time`为每次调用设备属性的间隔时间（注：设置属性后立刻获取属性会不符合预期，需要延迟一段时间）
+  * `set(name: str, did: str, value: Union[bool, int]) -> Union[bool, int]`：设置设备属性
+  * `get(name: str, did: str) -> Union[bool, int]`：获取设备属性
+  * v1.2.0 新增直接通过名称设置/获取属性，需要在初始化时传入`did`，详见[demos/test_devices_v2_light.py](demos/test_devices_v2_light.py)。名称中包含`-`的属性需要替换为`_`。
+  * **欢迎大家把自己编写的设备属性字典分享到Issues中，方便大家使用**
+
 ## 致谢
 * [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)
 

{mijiaAPI-1.1.0 → mijiaapi-1.2.0}/README.md

@@ -13,24 +13,33 @@ pip install mijiaAPI
 ## 使用
 使用实例可以参考`demos`文件夹下的示例代码，以下是简单的使用说明
 
-有两个类分别用于登录和API调用
+有三个类分别用于登录和API调用
 
 * `mijiaLogin`：登录小米账号，获取控制设备必须的`userId`, `ssecurity`, `deviceId`, `serviceToken`，方法列表
   * `login(username: str, password: str) -> dict`：账号密码登录，返回上述信息
   * `QRlogin() -> dict`：扫描二维码登录，返回上述信息（会在支持tty的终端打印二维码，若打印识别可查看当前文件夹下的`qr.png`）
 
 * `mijiaAPI`：API的实现，使用`mijiaLogin`登录后返回的信息进行初始化
-  * `__init__(self, auth_data: dict)`：初始化
+  * `__init__(auth_data: dict)`：初始化
+  * `available -> bool`：传入的`auth_data`是否有效
   * `get_devices_list() -> list`：获取设备列表
   * `get_homes_list() -> list`：获取家庭列表，家庭字典中包含房间列表
   * `get_scenes_list(home_id: str) -> list`：获取手动场景列表，在 *米家->添加->手动控制* 中设置
   * `run_scene(scene_id: str) -> bool`：运行手动场景
-  * `get_consumable_items(did: str) -> list`：获取设备的耗材信息，`did`为设备id，在设备列表中获取
+  * `get_consumable_items(home_id: str) -> list`：获取设备的耗材信息
   * `get_devices_prop(data: list) -> list`：获取设备的属性
   * `set_devices_prop(data: list) -> list`：设置设备的属性
     * `data`为一个字典的列表，字典需要包含`did`, `siid`, `piid`，后面两个键可从 *https://home.miot-spec.com/spec/{model}* 中获取，其中`model`为设备的model，在设备列表中获取，如[米家台灯 1S](https://home.miot-spec.com/spec/yeelink.light.lamp4)。
     * 网站上的方法并非全部可用，需要自行测试
 
+
+* `mijiaDevices`：使用`mijiaAPI`和设备属性字典初始化，以便更方便地调用设备属性
+  * `__init__(api: mijiaAPI, dev_info: dict. did: str = None, sleep_time: float = 0.5)`：初始化，`dev_info`为设备属性，参考[demos/dev_info_example](demos/dev_info_example)，`sleep_time`为每次调用设备属性的间隔时间（注：设置属性后立刻获取属性会不符合预期，需要延迟一段时间）
+  * `set(name: str, did: str, value: Union[bool, int]) -> Union[bool, int]`：设置设备属性
+  * `get(name: str, did: str) -> Union[bool, int]`：获取设备属性
+  * v1.2.0 新增直接通过名称设置/获取属性，需要在初始化时传入`did`，详见[demos/test_devices_v2_light.py](demos/test_devices_v2_light.py)。名称中包含`-`的属性需要替换为`_`。
+  * **欢迎大家把自己编写的设备属性字典分享到Issues中，方便大家使用**
+
 ## 致谢
 * [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)
 

mijiaapi-1.2.0/demos/dev_info_example/miaomiaoce.sensor_ht.t1.json

@@ -0,0 +1,42 @@
+{
+    "name": "小米米家电子温湿度计Pro",
+    "model": "miaomiaoce.sensor_ht.t1",
+    "properties": [
+        {
+            "name": "temperature",
+            "description": "温度",
+            "type": "float",
+            "rw": "r",
+            "unit": "celsius",
+            "range": [-30, 100],
+            "method": {
+                "siid": 2,
+                "piid": 1
+            }
+        },
+        {
+            "name": "relative-humidity",
+            "description": "相对湿度",
+            "type": "float",
+            "rw": "r",
+            "unit": "percentage",
+            "range": [0, 100],
+            "method": {
+                "siid": 2,
+                "piid": 2
+            }
+        },
+        {
+            "name": "battery-level",
+            "description": "电池电量",
+            "type": "uint",
+            "rw": "r",
+            "unit": "percentage",
+            "range": [0, 100],
+            "method": {
+                "siid": 3,
+                "piid": 1
+            }
+        }
+    ]
+}

mijiaapi-1.2.0/demos/dev_info_example/yeelink.light.lamp4.json

@@ -0,0 +1,125 @@
+{
+    "name": "米家台灯 1S",
+    "model": "yeelink.light.lamp4",
+    "properties": [
+        {
+            "name": "on",
+            "description": "开关",
+            "type": "bool",
+            "rw": "rw",
+            "unit": null,
+            "range": null,
+            "method": {
+                "siid": 2,
+                "piid": 1
+            }
+        },
+        {
+            "name": "brightness",
+            "description": "亮度",
+            "type": "uint",
+            "rw": "rw",
+            "unit": "percentage",
+            "range": [
+                1,
+                100
+            ],
+            "method": {
+                "siid": 2,
+                "piid": 2
+            }
+        },
+        {
+            "name": "color-temperature",
+            "description": "色温",
+            "type": "uint",
+            "rw": "rw",
+            "unit": "kelvin",
+            "range": [
+                2600,
+                5000
+            ],
+            "method": {
+                "siid": 2,
+                "piid": 3
+            }
+        },
+        {
+            "name": "mode",
+            "description": "模式，0-6分别为[Reading, Computer, Night Reading, Anti-blue, Effective Work, Candle, Twinkle]",
+            "type": "uint",
+            "rw": "w",
+            "unit": null,
+            "range": [
+                0,
+                6
+            ],
+            "method": {
+                "siid": 2,
+                "piid": 4
+            }
+        },
+        {
+            "name": "brightness-delta",
+            "description": "百分比调节亮度",
+            "type": "int",
+            "rw": "w",
+            "unit": "percentage",
+            "range": [
+                -100,
+                100
+            ],
+            "method": {
+                "siid": 3,
+                "piid": 1
+            }
+        },
+        {
+            "name": "ct-delta",
+            "description": "百分比调节色温",
+            "type": "int",
+            "rw": "w",
+            "unit": "percentage",
+            "range": [
+                -100,
+                100
+            ],
+            "method": {
+                "siid": 3,
+                "piid": 2
+            }
+        },
+        {
+            "name": "ct-adjust-alexa-increase",
+            "description": "色温增加",
+            "type": "uint",
+            "rw": "w",
+            "unit": null,
+            "range": [
+                1,
+                1
+            ],
+            "method": {
+                "siid": 3,
+                "piid": 3,
+                "value": 1
+            }
+        },
+        {
+            "name": "ct-adjust-alexa-decrease",
+            "description": "色温减少",
+            "type": "uint",
+            "rw": "w",
+            "unit": null,
+            "range": [
+                2,
+                2
+            ],
+            "method": {
+                "siid": 3,
+                "piid": 3,
+                "value": 2
+            }
+        }
+    ]
+}

mijiaapi-1.2.0/demos/test_QRlogin.py

@@ -0,0 +1,13 @@
+import json
+import os
+import sys
+sys.path.extend(['.', '..'])
+from mijiaAPI import mijiaLogin
+
+if not os.path.exists('jsons'):
+    os.mkdir('jsons')
+
+api = mijiaLogin()
+auth = api.QRlogin()
+with open('jsons/auth.json', 'w') as f:
+    json.dump(auth, f, indent=2)

mijiaapi-1.2.0/demos/test_apis.py

@@ -0,0 +1,66 @@
+import json
+import time
+import sys
+sys.path.extend(['.', '..'])
+from mijiaAPI import mijiaAPI
+
+with open('jsons/auth.json') as f:
+    auth = json.load(f)
+api = mijiaAPI(auth)
+
+
+# ---------------------- get devices list ----------------------
+devices = api.get_devices_list()['list']
+with open('jsons/devices.json', 'w') as f:
+    json.dump(devices, f, indent=2, ensure_ascii=False)
+time.sleep(2)
+
+# ---------------------- get homes list ------------------------
+homes = api.get_homes_list()['homelist']
+with open('jsons/homes.json', 'w') as f:
+    json.dump(homes, f, indent=2, ensure_ascii=False)
+time.sleep(2)
+
+# ---------------------- get scenes list -----------------------
+home_id = homes[0]['id']
+scenes = api.get_scenes_list(home_id)['scene_info_list']
+with open('jsons/scenes.json', 'w') as f:
+    json.dump(scenes, f, indent=2, ensure_ascii=False)
+time.sleep(2)
+
+# ---------------------- run scene -----------------------------
+scence_id = scenes[0]['scene_id']
+scence_name = scenes[0]['name']
+ret = api.run_scene(scence_id)
+print(f'Run scene {scence_name}: {ret}')
+time.sleep(2)
+
+# ---------------------- get consumable items ------------------
+consumable_items = api.get_consumable_items(home_id)['items']
+with open('jsons/consumable_items.json', 'w') as f:
+    json.dump(consumable_items, f, indent=2, ensure_ascii=False)
+time.sleep(2)
+
+# ---------------------- get/set device properties -------------
+# look for did and model in devices.json
+# look for siid and piid in https://home.miot-spec.com/spec/{model}
+# or it's feasible to use `run_scene`` to set the device properties
+did = devices[0]['did']
+name = devices[0]['name']
+ret = api.get_devices_prop([
+    {"did": did, "siid": 2, "piid": 2},
+    {"did": did, "siid": 2, "piid": 3},
+])
+brightness = ret[0]['value']
+color_temperature = ret[1]['value']
+print(f'Get device {name} properties:\nBrightness: {brightness}%\n'
+      f'Color temperature: {color_temperature}K')
+time.sleep(2)
+
+ret = api.set_devices_prop([
+    {"did": did, "siid": 2, "piid": 2, "value": 50},
+    {"did": did, "siid": 2, "piid": 3, "value": 2700},
+])
+print(f'Set device {name} properties:\n'
+      f'Brightness: {"Success" if ret[0]["code"] == 0 else "Failed"}\n'
+      f'Color temperature: {"Success" if ret[1]["code"] == 0 else "Failed"}')

mijiaapi-1.2.0/demos/test_available.py

@@ -0,0 +1,10 @@
+import json
+import sys
+sys.path.extend(['.', '..'])
+from mijiaAPI import mijiaAPI
+
+with open('jsons/auth.json') as f:
+    auth = json.load(f)
+api = mijiaAPI(auth)
+
+print(api.available)

mijiaapi-1.2.0/demos/test_devices_airconditioner.py

@@ -0,0 +1,96 @@
+import json
+import sys
+sys.path.extend(['.', '..'])
+from mijiaAPI import mijiaDevices, mijiaAPI
+
+with open('jsons/auth.json') as f:
+    auth = json.load(f)
+api = mijiaAPI(auth)
+
+with open('jsons/devices.json') as f:
+    devices = json.load(f)
+    did = devices[2]['did']
+dev_info = {
+    "name": "米家空调伴侣Pro 万能遥控版",
+    "model": "lumi.acpartner.mcn04",
+    "properties": [
+        {
+            "name": "on",
+            "description": "开关",
+            "type": "bool",
+            "rw": "rw",
+            "unit": None,
+            "range": None,
+            "method": {
+                "siid": 3,
+                "piid": 1
+            }
+        },
+        {
+            "name": "mode",
+            "description": "空调模式，0-4分别是制冷、制热、自动、送风、除湿",
+            "type": "uint",
+            "rw": "rw",
+            "unit": None,
+            "range": [0, 4],
+            "method": {
+                "siid": 3,
+                "piid": 2
+            }
+        },
+        {
+            "name": "target-temperature",
+            "description": "目标温度",
+            "type": "uint",
+            "rw": "rw",
+            "unit": "celsius",
+            "range": [16, 30],
+            "method": {
+                "siid": 3,
+                "piid": 4
+            }
+        },
+        {
+            "name": "power-consumption",
+            "description": "耗电量",
+            "type": "float",
+            "rw": "r",
+            "unit": None,
+            "range": [0, 3.4e38],
+            "method": {
+                "siid": 7,
+                "piid": 1
+            }
+        },
+        {
+            "name": "electric-power",
+            "description": "功率",
+            "type": "float",
+            "rw": "r",
+            "unit": "watt",
+            "range": [0, 3.4e38],
+            "method": {
+                "siid": 7,
+                "piid": 2
+            }
+        },
+    ]
+}
+
+# sleep_time is optional, default is 0.5
+# get after set shuold be delayed for a while, or the result may be incorrect
+device = mijiaDevices(api, dev_info, sleep_time=2)
+print(device)
+print('---------------------')
+print(device.get('on', did))
+print(device.set('on', did, True))
+print(device.get('on', did))
+print('---------------------')
+print(device.get('mode', did))
+print('---------------------')
+print(device.get('target-temperature', did))
+print(device.set('target-temperature', did, 26))
+print(device.get('target-temperature', did))
+print('---------------------')
+print(device.get('power-consumption', did))
+print(device.get('electric-power', did))

mijiaapi-1.2.0/demos/test_devices_light.py

@@ -0,0 +1,43 @@
+import json
+import sys
+sys.path.extend(['.', '..'])
+from mijiaAPI import mijiaDevices, mijiaAPI
+
+with open('jsons/auth.json') as f:
+    auth = json.load(f)
+api = mijiaAPI(auth)
+
+with open('demos/dev_info_example/yeelink.light.lamp4.json', encoding='utf-8') as f:
+    dev_info = json.load(f)
+with open('jsons/devices.json') as f:
+    devices = json.load(f)
+    did = devices[0]['did']
+# sleep_time is optional, default is 0.5
+# get after set shuold be delayed for a while, or the result may be incorrect
+device = mijiaDevices(api, dev_info, sleep_time=2)
+print(device)
+print('---------------------')
+print(device.get('on', did))
+print(device.set('on', did, True))
+print('---------------------')
+print(f"{device.get('brightness', did)} {device.prop_list['brightness'].unit}")
+print(device.set('brightness', did, 60))
+print(f"{device.get('brightness', did)} {device.prop_list['brightness'].unit}")
+print('---------------------')
+print(f"{device.get('color-temperature', did)} {device.prop_list['color-temperature'].unit}")
+print(device.set('color-temperature', did, 5000))
+print(f"{device.get('color-temperature', did)} {device.prop_list['color-temperature'].unit}")
+print('---------------------')
+print(device.set('mode', did, 0))
+print('---------------------')
+print(f"{device.get('brightness', did)} {device.prop_list['brightness'].unit}")
+print(device.set('brightness-delta', did, -10))
+print(f"{device.get('brightness', did)} {device.prop_list['brightness'].unit}")
+print('---------------------')
+print(f"{device.get('color-temperature', did)} {device.prop_list['color-temperature'].unit}")
+print(device.set('ct-delta', did, -10))
+print(f"{device.get('color-temperature', did)} {device.prop_list['color-temperature'].unit}")
+print(device.set('ct-adjust-alexa-increase', did, 1))
+print(f"{device.get('color-temperature', did)} {device.prop_list['color-temperature'].unit}")
+print(device.set('ct-adjust-alexa-decrease', did, 2))
+print(f"{device.get('color-temperature', did)} {device.prop_list['color-temperature'].unit}")

mijiaapi-1.2.0/demos/test_devices_sensor.py

@@ -0,0 +1,20 @@
+import json
+import sys
+sys.path.extend(['.', '..'])
+from mijiaAPI import mijiaDevices, mijiaAPI
+
+with open('jsons/auth.json') as f:
+    auth = json.load(f)
+api = mijiaAPI(auth)
+
+with open('demos/dev_info_example/miaomiaoce.sensor_ht.t1.json', encoding='utf-8') as f:
+    dev_info = json.load(f)
+with open('jsons/devices.json') as f:
+    devices = json.load(f)
+    did = devices[5]['did']
+device = mijiaDevices(api, dev_info)
+print(device)
+print('---------------------')
+print(device.get('temperature', did))
+print(device.get('relative-humidity', did))
+print(device.get('battery-level', did))

mijiaapi-1.2.0/demos/test_devices_v2_light.py

@@ -0,0 +1,43 @@
+import json
+import sys
+sys.path.extend(['.', '..'])
+from mijiaAPI import mijiaDevices, mijiaAPI
+
+with open('jsons/auth.json') as f:
+    auth = json.load(f)
+api = mijiaAPI(auth)
+
+with open('demos/dev_info_example/yeelink.light.lamp4.json', encoding='utf-8') as f:
+    dev_info = json.load(f)
+with open('jsons/devices.json') as f:
+    devices = json.load(f)
+    did = devices[0]['did']
+# sleep_time is optional, default is 0.5
+# get after set shuold be delayed for a while, or the result may be incorrect
+device = mijiaDevices(api, dev_info, did=did, sleep_time=2)
+print(device)
+print('---------------------')
+print(device.on)
+device.on = True
+print('---------------------')
+print(f"{device.brightness} {device.prop_list['brightness'].unit}")
+device.brightness = 60
+print(f"{device.brightness} {device.prop_list['brightness'].unit}")
+print('---------------------')
+print(f"{device.color_temperature} {device.prop_list['color-temperature'].unit}")
+device.color_temperature = 5000
+print(f"{device.color_temperature} {device.prop_list['color-temperature'].unit}")
+print('---------------------')
+device.mode = 0
+print('---------------------')
+print(f"{device.brightness} {device.prop_list['brightness'].unit}")
+device.brightness_delta = -10
+print(f"{device.brightness} {device.prop_list['brightness'].unit}")
+print('---------------------')
+print(f"{device.color_temperature} {device.prop_list['color-temperature'].unit}")
+device.ct_delta = -10
+print(f"{device.color_temperature} {device.prop_list['color-temperature'].unit}")
+device.ct_adjust_alexa_increase = 1
+print(f"{device.color_temperature} {device.prop_list['color-temperature'].unit}")
+device.ct_adjust_alexa_decrease = 2
+print(f"{device.color_temperature} {device.prop_list['color-temperature'].unit}")

mijiaapi-1.2.0/demos/test_login.py

@@ -0,0 +1,15 @@
+import json
+import os
+import sys
+sys.path.extend(['.', '..'])
+from mijiaAPI import mijiaLogin
+
+if not os.path.exists('jsons'):
+    os.mkdir('jsons')
+
+username = os.getenv('XIAOMI_USERNAME')
+password = os.getenv('XIAOMI_PASSWORD')
+api = mijiaLogin()
+auth = api.login(username, password)
+with open('jsons/auth.json', 'w') as f:
+    json.dump(auth, f, indent=2)

{mijiaAPI-1.1.0 → mijiaapi-1.2.0}/mijiaAPI/__version__.py

@@ -1,5 +1,5 @@
 __title__ = "mijiaAPI"
-__version__ = "1.1.0"
+__version__ = "1.2.0"
 __description__ = "A Python API for Xiaomi Mijia"
 __url__ = "https://github.com/Do1e/mijia-api"
 __author__ = "Do1e"

{mijiaAPI-1.1.0 → mijiaapi-1.2.0}/mijiaAPI/apis.py

@@ -2,7 +2,7 @@ from typing import Union
 import requests
 import requests.cookies
 
-from .utils import defaultUA, post_data
+from .utils import defaultUA, post_data, PostDataError
 
 class mijiaAPI(object):
     def __init__(self, auth_data: dict):
@@ -25,6 +25,17 @@ class mijiaAPI(object):
             raise Exception(f'Failed to get data, {data["message"]}')
         return data['result']
 
+    @property
+    def available(self) -> bool:
+        """check if the API is available"""
+        uri = '/home/device_list'
+        data = {"getVirtualModel": False, "getHuamiDevices": 0}
+        try:
+            post_data(self.session, self.ssecurity, uri, data)
+            return True
+        except PostDataError:
+            return False
+
     def get_devices_list(self) -> list:
         """get devices list
         mijiaAPI.get_devices_list() -> list

{mijiaAPI-1.1.0 → mijiaapi-1.2.0}/mijiaAPI/devices.py

@@ -1,4 +1,4 @@
-from typing import Union
+from typing import Union, Optional
 from time import sleep
 from .apis import mijiaAPI
 
@@ -19,16 +19,21 @@ class DevProp(object):
                f'  valuetype: {self.type}, rw: {self.rw}, unit: {self.unit}, range: {self.range}'
 
 class mijiaDevices(object):
-    def __init__(self, api: mijiaAPI, dev_info: dict, sleep_time: float = 0.5):
+    def __init__(self, api: mijiaAPI, dev_info: dict,
+                 did: Optional[str] = None,
+                 sleep_time: Optional[Union[int, float]] = 0.5):
         self.api = api
         self.name = dev_info['name']
         self.model = dev_info['model']
         self.prop_list = {prop['name']: DevProp(prop) for prop in dev_info['properties']}
+        self.prop_list.update({prop['name'].replace('-', '_'): DevProp(prop) for prop in dev_info['properties'] if '-' in prop['name']})
+        self.did = did
         self.sleep_time = sleep_time
 
     def __str__(self):
+        prop_list = [str(v) for k, v in self.prop_list.items() if '_' not in k]
         return f'{self.name} ({self.model})\n' \
-               f'Properties:\n' + '\n'.join([str(v) for v in self.prop_list.values()])
+               f'Properties:\n' + '\n'.join(prop_list)
 
     def set(self, name: str, did: str, value: Union[bool, int]) -> Union[bool, int]:
         if name not in self.prop_list:
@@ -67,7 +72,19 @@ class mijiaDevices(object):
         sleep(self.sleep_time)
         return ret
 
-    def get(self, name: str, did: str) -> Union[bool, int]:
+    def set_v2(self, name: str, value: Union[bool, int], did: Optional[str] = None) -> Union[bool, int]:
+        if did is not None:
+            return self.set(name, did, value)
+        elif self.did is not None:
+            return self.set(name, self.did, value)
+        else:
+            raise ValueError('Please specify the did')
+
+    def get(self, name: str, did: Optional[str] = None) -> Union[bool, int]:
+        if did is None:
+            did = self.did
+        if did is None:
+            raise ValueError('Please specify the did')
         if name not in self.prop_list:
             raise ValueError(f'Unsupported property: {name}, available properties: {list(self.prop_list.keys())}')
         prop = self.prop_list[name]
@@ -78,3 +95,16 @@ class mijiaDevices(object):
         ret = self.api.get_devices_prop([method])[0]['value']
         sleep(self.sleep_time)
         return ret
+
+    def __setattr__(self, name: str, value: Union[bool, int]) -> None:
+        if 'prop_list' in self.__dict__ and name in self.prop_list:
+            if not self.set_v2(name, value):
+                raise RuntimeError(f'Failed to set property: {name}')
+        else:
+            super().__setattr__(name, value)
+
+    def __getattr__(self, name: str) -> Union[bool, int]:
+        if 'prop_list' in self.__dict__ and name in self.prop_list:
+            return self.get(name)
+        else:
+            return super().__getattr__(name)

{mijiaAPI-1.1.0 → mijiaapi-1.2.0}/mijiaAPI.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mijiaAPI
-Version: 1.1.0
+Version: 1.2.0
 Summary: A Python API for Xiaomi Mijia
 Home-page: https://github.com/Do1e/mijia-api
 Author: Do1e
@@ -29,24 +29,33 @@ pip install mijiaAPI
 ## 使用
 使用实例可以参考`demos`文件夹下的示例代码，以下是简单的使用说明
 
-有两个类分别用于登录和API调用
+有三个类分别用于登录和API调用
 
 * `mijiaLogin`：登录小米账号，获取控制设备必须的`userId`, `ssecurity`, `deviceId`, `serviceToken`，方法列表
   * `login(username: str, password: str) -> dict`：账号密码登录，返回上述信息
   * `QRlogin() -> dict`：扫描二维码登录，返回上述信息（会在支持tty的终端打印二维码，若打印识别可查看当前文件夹下的`qr.png`）
 
 * `mijiaAPI`：API的实现，使用`mijiaLogin`登录后返回的信息进行初始化
-  * `__init__(self, auth_data: dict)`：初始化
+  * `__init__(auth_data: dict)`：初始化
+  * `available -> bool`：传入的`auth_data`是否有效
   * `get_devices_list() -> list`：获取设备列表
   * `get_homes_list() -> list`：获取家庭列表，家庭字典中包含房间列表
   * `get_scenes_list(home_id: str) -> list`：获取手动场景列表，在 *米家->添加->手动控制* 中设置
   * `run_scene(scene_id: str) -> bool`：运行手动场景
-  * `get_consumable_items(did: str) -> list`：获取设备的耗材信息，`did`为设备id，在设备列表中获取
+  * `get_consumable_items(home_id: str) -> list`：获取设备的耗材信息
   * `get_devices_prop(data: list) -> list`：获取设备的属性
   * `set_devices_prop(data: list) -> list`：设置设备的属性
     * `data`为一个字典的列表，字典需要包含`did`, `siid`, `piid`，后面两个键可从 *https://home.miot-spec.com/spec/{model}* 中获取，其中`model`为设备的model，在设备列表中获取，如[米家台灯 1S](https://home.miot-spec.com/spec/yeelink.light.lamp4)。
     * 网站上的方法并非全部可用，需要自行测试
 
+
+* `mijiaDevices`：使用`mijiaAPI`和设备属性字典初始化，以便更方便地调用设备属性
+  * `__init__(api: mijiaAPI, dev_info: dict. did: str = None, sleep_time: float = 0.5)`：初始化，`dev_info`为设备属性，参考[demos/dev_info_example](demos/dev_info_example)，`sleep_time`为每次调用设备属性的间隔时间（注：设置属性后立刻获取属性会不符合预期，需要延迟一段时间）
+  * `set(name: str, did: str, value: Union[bool, int]) -> Union[bool, int]`：设置设备属性
+  * `get(name: str, did: str) -> Union[bool, int]`：获取设备属性
+  * v1.2.0 新增直接通过名称设置/获取属性，需要在初始化时传入`did`，详见[demos/test_devices_v2_light.py](demos/test_devices_v2_light.py)。名称中包含`-`的属性需要替换为`_`。
+  * **欢迎大家把自己编写的设备属性字典分享到Issues中，方便大家使用**
+
 ## 致谢
 * [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)
 

mijiaapi-1.2.0/mijiaAPI.egg-info/SOURCES.txt

@@ -0,0 +1,28 @@
+.gitignore
+LICENSE
+README.md
+requirements.txt
+setup.py
+.vscode/launch.json
+demos/test_QRlogin.py
+demos/test_apis.py
+demos/test_available.py
+demos/test_devices_airconditioner.py
+demos/test_devices_light.py
+demos/test_devices_sensor.py
+demos/test_devices_v2_light.py
+demos/test_login.py
+demos/dev_info_example/miaomiaoce.sensor_ht.t1.json
+demos/dev_info_example/yeelink.light.lamp4.json
+mijiaAPI/__init__.py
+mijiaAPI/__version__.py
+mijiaAPI/apis.py
+mijiaAPI/devices.py
+mijiaAPI/login.py
+mijiaAPI/urls.py
+mijiaAPI/utils.py
+mijiaAPI.egg-info/PKG-INFO
+mijiaAPI.egg-info/SOURCES.txt
+mijiaAPI.egg-info/dependency_links.txt
+mijiaAPI.egg-info/requires.txt
+mijiaAPI.egg-info/top_level.txt

mijiaapi-1.2.0/requirements.txt

@@ -0,0 +1,2 @@
+requests
+qrcode

mijiaAPI-1.1.0/mijiaAPI.egg-info/SOURCES.txt

@@ -1,15 +0,0 @@
-LICENSE
-README.md
-setup.py
-mijiaAPI/__init__.py
-mijiaAPI/__version__.py
-mijiaAPI/apis.py
-mijiaAPI/devices.py
-mijiaAPI/login.py
-mijiaAPI/urls.py
-mijiaAPI/utils.py
-mijiaAPI.egg-info/PKG-INFO
-mijiaAPI.egg-info/SOURCES.txt
-mijiaAPI.egg-info/dependency_links.txt
-mijiaAPI.egg-info/requires.txt
-mijiaAPI.egg-info/top_level.txt