mijiaAPI 1.3.0__tar.gz → 1.3.2__tar.gz

{mijiaapi-1.3.0 → mijiaapi-1.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mijiaAPI
-Version: 1.3.0
+Version: 1.3.2
 Summary: A Python API for Xiaomi Mijia
 Home-page: https://github.com/Do1e/mijia-api
 License: GPLv3
@@ -61,6 +61,7 @@ pip install mijiaAPI
   * `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中，方便大家使用**
+  * 也可以调用`get_device_info(device_model: str) -> dict`函数从[米家设备列表](https://home.miot-spec.com/)在线获取设备属性字典，详见[demos/test_get_device_info.py](demos/test_get_device_info.py)
 
 ## 致谢
 * [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)

{mijiaapi-1.3.0 → mijiaapi-1.3.2}/README.md

@@ -41,6 +41,7 @@ pip install mijiaAPI
   * `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中，方便大家使用**
+  * 也可以调用`get_device_info(device_model: str) -> dict`函数从[米家设备列表](https://home.miot-spec.com/)在线获取设备属性字典，详见[demos/test_get_device_info.py](demos/test_get_device_info.py)
 
 ## 致谢
 * [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)

{mijiaapi-1.3.0 → mijiaapi-1.3.2}/mijiaAPI/__init__.py

@@ -1,3 +1,3 @@
 from .login import mijiaLogin
 from .apis import mijiaAPI
-from .devices import mijiaDevices
+from .devices import mijiaDevices, get_device_info

{mijiaapi-1.3.0 → mijiaapi-1.3.2}/mijiaAPI/devices.py

@@ -1,141 +1,209 @@
-from typing import Union, Optional
-from time import sleep
-from .apis import mijiaAPI
-
-class DevProp(object):
-    def __init__(self, prop_dict: dict):
-        self.name = prop_dict['name']
-        self.desc = prop_dict['description']
-        self.type = prop_dict['type']
-        if self.type not in ['bool', 'int', 'uint', 'float', 'string']:
-            raise ValueError(f'Unsupported type: {self.type}, available types: bool, int, uint, float, string')
-        self.rw = prop_dict['rw']
-        self.unit = prop_dict['unit']
-        self.range = prop_dict['range']
-        self.method = prop_dict['method']
-
-    def __str__(self):
-        return f'  {self.name}: {self.desc}\n' \
-               f'    valuetype: {self.type}, rw: {self.rw}, unit: {self.unit}, range: {self.range}'
-
-class DevAction(object):
-    def __init__(self, act_dict: dict):
-        self.name = act_dict['name']
-        self.desc = act_dict['description']
-        self.method = act_dict['method']
-
-    def __str__(self):
-        return f'  {self.name}: {self.desc}'
-
-class mijiaDevices(object):
-    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']})
-        if 'actions' in dev_info:
-            self.action_list = {act['name']: DevAction(act) for act in dev_info['actions']}
-        else:
-            self.action_list = {}
-        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]
-        action_list = [str(v) for v in self.action_list.values()]
-        return f'{self.name} ({self.model})\n' \
-               'Properties:\n' + '\n'.join(prop_list) + '\n' \
-               'Actions:\n' + '\n'.join(action_list)
-
-    def set(self, name: str, did: str, value: Union[bool, int]) -> Union[bool, int]:
-        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]
-        if 'w' not in prop.rw:
-            raise ValueError(f'Property {name} is read-only')
-        if prop.type == 'bool':
-            if not isinstance(value, bool):
-                raise ValueError(f'Invalid value for bool: {value}, should be True or False')
-        elif prop.type in ['int', 'uint']:
-            try:
-                value = int(value)
-                if prop.range:
-                    if value < prop.range[0] or value > prop.range[1]:
-                        raise ValueError(f'Value out of range: {value}, should be in range {prop.range}')
-            except ValueError:
-                raise ValueError(f'Invalid value for int: {value}, should be an integer')
-        elif prop.type == 'float':
-            try:
-                value = float(value)
-                if prop.range:
-                    if value < prop.range[0] or value > prop.range[1]:
-                        raise ValueError(f'Value out of range: {value}, should be in range {prop.range}')
-            except ValueError:
-                raise ValueError(f'Invalid value for float: {value}, should be a float')
-        elif prop.type == 'string':
-            if not isinstance(value, str):
-                raise ValueError(f'Invalid value for string: {value}, should be a string')
-        else:
-            raise ValueError(f'Unsupported type: {prop.type}, available types: bool, int, uint, float, string')
-        method = prop.method.copy()
-        method['did'] = did
-        method['value'] = value
-        ret = self.api.set_devices_prop([method])[0]['code'] == 0
-        sleep(self.sleep_time)
-        return ret
-
-    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]
-        if 'r' not in prop.rw:
-            raise ValueError(f'Property {name} is write-only')
-        method = prop.method.copy()
-        method['did'] = did
-        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)
-
-    def run_action(self, name: str, did: Optional[str] = None, value: Optional[Union[list, tuple]] = None) -> bool:
-        if did is None:
-            did = self.did
-        if did is None:
-            raise ValueError('Please specify the did')
-        if name not in self.action_list:
-            raise ValueError(f'Unsupported action: {name}, available actions: {list(self.action_list.keys())}')
-        act = self.action_list[name]
-        method = act.method.copy()
-        method['did'] = did
-        if value is not None:
-            method['value'] = value
-        ret = self.api.run_action(method)['code'] == 0
-        sleep(self.sleep_time)
-        return ret
+from typing import Union, Optional
+import json
+import re
+import requests
+from time import sleep
+from .apis import mijiaAPI
+from .urls import deviceURL
+
+class DevProp(object):
+    def __init__(self, prop_dict: dict):
+        self.name = prop_dict['name']
+        self.desc = prop_dict['description']
+        self.type = prop_dict['type']
+        if self.type not in ['bool', 'int', 'uint', 'float', 'string']:
+            raise ValueError(f'Unsupported type: {self.type}, available types: bool, int, uint, float, string')
+        self.rw = prop_dict['rw']
+        self.unit = prop_dict['unit']
+        self.range = prop_dict['range']
+        self.value_list = prop_dict.get('value-list', None)
+        self.method = prop_dict['method']
+
+    def __str__(self):
+        return f'  {self.name}: {self.desc}\n' \
+               f'    valuetype: {self.type}, rw: {self.rw}, unit: {self.unit}, range: {self.range}' + \
+               (('\n    ' + ', '.join([f'{item["value"]}: {item["description"]}' for item in self.value_list])) if self.value_list else '')
+
+class DevAction(object):
+    def __init__(self, act_dict: dict):
+        self.name = act_dict['name']
+        self.desc = act_dict['description']
+        self.method = act_dict['method']
+
+    def __str__(self):
+        return f'  {self.name}: {self.desc}'
+
+class mijiaDevices(object):
+    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']})
+        if 'actions' in dev_info:
+            self.action_list = {act['name']: DevAction(act) for act in dev_info['actions']}
+        else:
+            self.action_list = {}
+        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]
+        action_list = [str(v) for v in self.action_list.values()]
+        return f'{self.name} ({self.model})\n' \
+               'Properties:\n' + '\n'.join(prop_list) + '\n' \
+               'Actions:\n' + '\n'.join(action_list)
+
+    def set(self, name: str, did: str, value: Union[bool, int]) -> Union[bool, int]:
+        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]
+        if 'w' not in prop.rw:
+            raise ValueError(f'Property {name} is read-only')
+        if prop.value_list:
+            if value not in [item['value'] for item in prop.value_list]:
+                raise ValueError(f'Invalid value: {value}, should be in {prop.value_list}')
+        if prop.type == 'bool':
+            if not isinstance(value, bool):
+                raise ValueError(f'Invalid value for bool: {value}, should be True or False')
+        elif prop.type in ['int', 'uint']:
+            try:
+                value = int(value)
+                if prop.range:
+                    if value < prop.range[0] or value > prop.range[1]:
+                        raise ValueError(f'Value out of range: {value}, should be in range {prop.range}')
+            except ValueError:
+                raise ValueError(f'Invalid value for int: {value}, should be an integer')
+        elif prop.type == 'float':
+            try:
+                value = float(value)
+                if prop.range:
+                    if value < prop.range[0] or value > prop.range[1]:
+                        raise ValueError(f'Value out of range: {value}, should be in range {prop.range}')
+            except ValueError:
+                raise ValueError(f'Invalid value for float: {value}, should be a float')
+        elif prop.type == 'string':
+            if not isinstance(value, str):
+                raise ValueError(f'Invalid value for string: {value}, should be a string')
+        else:
+            raise ValueError(f'Unsupported type: {prop.type}, available types: bool, int, uint, float, string')
+        method = prop.method.copy()
+        method['did'] = did
+        method['value'] = value
+        ret = self.api.set_devices_prop([method])[0]['code'] == 0
+        sleep(self.sleep_time)
+        return ret
+
+    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]
+        if 'r' not in prop.rw:
+            raise ValueError(f'Property {name} is write-only')
+        method = prop.method.copy()
+        method['did'] = did
+        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)
+
+    def run_action(self, name: str, did: Optional[str] = None, value: Optional[Union[list, tuple]] = None) -> bool:
+        if did is None:
+            did = self.did
+        if did is None:
+            raise ValueError('Please specify the did')
+        if name not in self.action_list:
+            raise ValueError(f'Unsupported action: {name}, available actions: {list(self.action_list.keys())}')
+        act = self.action_list[name]
+        method = act.method.copy()
+        method['did'] = did
+        if value is not None:
+            method['value'] = value
+        ret = self.api.run_action(method)['code'] == 0
+        sleep(self.sleep_time)
+        return ret
+
+def get_device_info(device_model: str) -> dict:
+    response = requests.get(deviceURL + device_model)
+    if response.status_code != 200:
+        raise RuntimeError(f'Failed to get device info')
+    content = re.search(r'data-page="(.*?)">', response.text)
+    if content is None:
+        raise RuntimeError(f'Failed to get device info')
+    content = content.group(1)
+    content = json.loads(content.replace('&quot;', '"'))
+
+    result = {}
+    result['name'] = content['props']['product']['name']
+    result['model'] = content['props']['product']['model']
+    result['properties'] = []
+    result['actions'] = []
+    services = content['props']['spec']['services']
+
+    for siid in services:
+        if 'properties' in services[siid]:
+            for piid in services[siid]['properties']:
+                prop = services[siid]['properties'][piid]
+                if prop['format'].startswith('int'):
+                    prop_type = 'int'
+                elif prop['format'].startswith('uint'):
+                    prop_type = 'uint'
+                else:
+                    prop_type = prop['format']
+                item ={
+                    'name': prop['name'],
+                    'description': prop['description'],
+                    'type': prop_type,
+                    'rw': ''.join([
+                        'r' if 'read' in prop['access'] else '',
+                        'w' if 'write' in prop['access'] else ''
+                    ]),
+                    'unit': prop.get('unit', None),
+                    'range': prop.get('value-range', None),
+                    'value-list': prop.get('value-list', None),
+                    'method': {
+                        'siid': int(siid),
+                        'piid': int(piid)
+                    }
+                }
+                if item['range'] is not None:
+                    item['range'] = item['range'][:2]
+                result['properties'].append({k: None if v == 'none' else v for k, v in item.items()})
+        if 'actions' in services[siid]:
+            for aiid in services[siid]['actions']:
+                act = services[siid]['actions'][aiid]
+                result['actions'].append({
+                    'name': act['name'],
+                    'description': act['description'],
+                    'method': {
+                        'siid': int(siid),
+                        'aiid': int(aiid)
+                    }
+                })
+    return result

{mijiaapi-1.3.0 → mijiaapi-1.3.2}/mijiaAPI/urls.py

@@ -1,5 +1,6 @@
-sid = 'xiaomiio'
-msgURL = 'https://account.xiaomi.com/pass/serviceLogin?sid=%s&_json=true' % sid
-loginURL = 'https://account.xiaomi.com/pass/serviceLoginAuth2'
-qrURL = 'https://account.xiaomi.com/longPolling/loginUrl'
-apiURL = 'https://api.io.mi.com/app'
+sid = 'xiaomiio'
+msgURL = 'https://account.xiaomi.com/pass/serviceLogin?sid=%s&_json=true' % sid
+loginURL = 'https://account.xiaomi.com/pass/serviceLoginAuth2'
+qrURL = 'https://account.xiaomi.com/longPolling/loginUrl'
+apiURL = 'https://api.io.mi.com/app'
+deviceURL = 'https://home.miot-spec.com/spec/'

{mijiaapi-1.3.0 → mijiaapi-1.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mijiaAPI"
-version = "1.3.0"
+version = "1.3.2"
 description = "A Python API for Xiaomi Mijia"
 authors = ["Do1e <dpj.email@qq.com>"]
 license = "GPLv3"