mijiaAPI 1.3.9__tar.gz → 1.3.10__tar.gz

{mijiaapi-1.3.9 → mijiaapi-1.3.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mijiaAPI
-Version: 1.3.9
+Version: 1.3.10
 Summary: A Python API for Xiaomi Mijia
 License: GPLv3
 Author: Do1e
@@ -63,7 +63,7 @@ pip install mijiaAPI
 
 ### 针对设备的封装
 
-最简单的使用方法是直接使用自然语言调用小爱音箱，参见[demos/test_device_wifispeaker.py](demos/test_device_wifispeaker.py)
+最简单的使用方法是直接使用自然语言调用小爱音箱，参见[demos/test_devices_wifispeaker.py](demos/test_devices_wifispeaker.py)
 
 `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`为每次调用设备属性的间隔时间（注：设置属性后立刻获取属性会不符合预期，需要延迟一段时间）

{mijiaapi-1.3.9 → mijiaapi-1.3.10}/README.md

@@ -39,7 +39,7 @@ pip install mijiaAPI
 
 ### 针对设备的封装
 
-最简单的使用方法是直接使用自然语言调用小爱音箱，参见[demos/test_device_wifispeaker.py](demos/test_device_wifispeaker.py)
+最简单的使用方法是直接使用自然语言调用小爱音箱，参见[demos/test_devices_wifispeaker.py](demos/test_devices_wifispeaker.py)
 
 `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`为每次调用设备属性的间隔时间（注：设置属性后立刻获取属性会不符合预期，需要延迟一段时间）

{mijiaapi-1.3.9 → mijiaapi-1.3.10}/mijiaAPI/devices.py

@@ -1,353 +1,353 @@
-from typing import Union, Optional
-import json
-import re
-import requests
-from time import sleep
-from .apis import mijiaAPI
-from .code import ERROR_CODE
-from .urls import deviceURL
-
-
-class DevProp(object):
-    def __init__(self, prop_dict: dict):
-        """
-        Initialize the property object 初始化属性对象
-        :param prop_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):
-        """
-        String representation of the property 返回属性的名称、描述、类型、读写权限、单位和范围
-        :return:
-        """
-        lines = [
-            f"  {self.name}: {self.desc}",
-            f"    valuetype: {self.type}, rw: {self.rw}, unit: {self.unit}, range: {self.range}"
-        ]
-
-        if self.value_list:
-            value_lines = [f"    {item['value']}: {item['description']}" for item in self.value_list]
-            lines.extend(value_lines)
-
-        return '\n'.join(lines)
-
-
-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: Optional[dict] = None,
-            dev_name: Optional[str] = None,
-            did: Optional[str] = None,
-            sleep_time: Optional[Union[int, float]] = 0.5
-    ):
-        """
-        Initialize the device object 初始化设备对象
-        若未提供设备信息，则根据设备名称获取设备信息，若两者均未提供，则抛出异常
-        若提供了设备信息的同时提供了设备名称，则以设备信息为准
-        :param api: 米家API对象
-        :param dev_info: 设备信息字典（可选）
-        :param dev_name: 设备名称（可选）
-        :param did: 设备ID（可选）
-        :param sleep_time: 调用设备属性的间隔时间（可选，默认0.5秒）
-        """
-        assert dev_info is not None or dev_name is not None, "Either 'dev_info' or 'dev_name' must be provided."
-        if dev_info is not None and dev_name is not None:
-            print("Warning: Both 'dev_info' and 'dev_name' provided. Using 'dev_info' for initialization.")
-
-        self.api = api
-        if dev_info is None:
-            devices_list = self.api.get_devices_list()
-            matches = [device for device in devices_list.get('list', []) if device['name'] == dev_name]
-            if not matches:
-                raise ValueError(f"Device {dev_name} not found")
-            elif len(matches) > 1:
-                raise ValueError(f"Multiple devices named {dev_name} found")
-            else:
-                dev_info = get_device_info(matches[0]['model'])
-                did = matches[0]['did']
-        self.name = dev_info['name']
-        self.model = dev_info['model']
-
-        self.prop_list = {}
-        for prop in dev_info.get('properties', []):
-            prop_obj = DevProp(prop)
-            name = prop['name']
-            self.prop_list[name] = prop_obj
-            if '-' in name:
-                self.prop_list[name.replace('-', '_')] = prop_obj
-
-        self.action_list = {
-            act['name']: DevAction(act)
-            for act in dev_info.get('actions', [])
-        }
-        self.did = did
-        self.sleep_time = sleep_time
-
-    def __str__(self) -> str:
-        """
-        String representation of the device 返回设备的属性和动作列表
-        :return: 设备的属性和动作列表
-        """
-        prop_list_str = '\n'.join(filter(None, (str(v) for k, v in self.prop_list.items() if '_' not in k)))
-        action_list_str = '\n'.join(map(str, self.action_list.values()))
-        return (f"{self.name} ({self.model})\n"
-                f"Properties:\n{prop_list_str if prop_list_str else 'No properties available'}\n"
-                f"Actions:\n{action_list_str if action_list_str else 'No actions available'}")
-
-    def set(self, name: str, did: str, value: Union[bool, int]) -> Union[bool, int]:
-        """
-        Set property value 设置设备的属性值
-        :param name: 属性名称
-        :param did: 设备ID
-        :param value: 属性值
-        :return: 执行结果（True/False）
-        """
-        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']:
-            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[:2]}')
-                if len(prop.range) >= 3 and prop.range[2] != 1:
-                    if (value - prop.range[0]) % prop.range[2] != 0:
-                        raise ValueError(
-                            f'Invalid value: {value}, should be in range {prop.range[:2]} with step {prop.range[2]}')
-        elif prop.type == 'float':
-            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[:2]}')
-                if len(prop.range) >= 3 and isinstance(prop.range[2], int):
-                    if int(value - prop.range[0]) % prop.range[2] != 0:
-                        raise ValueError(
-                            f'Invalid value: {value}, should be in range {prop.range[:2]} with step {prop.range[2]}')
-        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
-        result = self.api.set_devices_prop([method])[0]
-        if result['code'] != 0:
-            raise RuntimeError(
-                f"Failed to set property: {name}, "
-                f"code: {result['code']}, "
-                f"message: {ERROR_CODE.get(str(result['code']), 'Unknown error')}"
-            )
-        sleep(self.sleep_time)
-        return result['code'] == 0
-
-    def set_v2(self, name: str, value: Union[bool, int], did: Optional[str] = None) -> Union[bool, int]:
-        """
-        Set property value_v2 设置设备的属性值_v2（需在实例化时指定did）
-        :param name: 属性名称
-        :param value: 属性值
-        :param did: 设备ID（若未指定，则使用实例化时的did）
-        :return: 执行结果（True/False）
-        """
-        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]:
-        """
-        Get property value 获取设备的属性值
-        :param name: 属性名称
-        :param did: 设备ID（若未指定，则使用实例化时的did）
-        :return: 属性值
-        """
-        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
-        result = self.api.get_devices_prop([method])[0]
-        if result['code'] != 0:
-            raise RuntimeError(
-                f"Failed to get property: {name}, "
-                f"code: {result['code']}, "
-                f"message: {ERROR_CODE.get(str(result['code']), 'Unknown error')}"
-            )
-        sleep(self.sleep_time)
-        return result['value']
-
-    def __setattr__(self, name: str, value: Union[bool, int]) -> None:
-        """
-        Set property value 设置设备的属性值（需在实例化时指定did）
-        :param name: 属性名称
-        :param value: 属性值
-        :return: 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]:
-        """
-        Get property value 获取设备的属性值（需在实例化时指定did）
-        :param name: 属性名称
-        :return: 属性值
-        """
-        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,
-            **kwargs
-    ) -> bool:
-        """
-        Run action 运行设备动作
-        :param name: 动作名称
-        :param did: 设备ID（若未指定，则使用实例化时的did）
-        :param value: 动作参数（若动作不需要参数，则不需要指定）
-        :param kwargs: 其它动作参数（若动作不需要参数，则不需要指定）
-        :return: 执行结果（True/False）
-        """
-        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
-        if kwargs:
-            for k, v in kwargs.items():
-                if k.startswith("_"):
-                    k = k[1:]
-                if k in method:
-                    raise ValueError(f'Invalid argument: {k}. Do not use arguments in ({", ".join(method.keys())})')
-                method[k] = v
-        result = self.api.run_action(method)
-        if result['code'] != 0:
-            raise RuntimeError(
-                f"Failed to run action: {name}, "
-                f"code: {result['code']}, "
-                f"message: {ERROR_CODE.get(str(result['code']), 'Unknown error')}"
-            )
-        sleep(self.sleep_time)
-        return result['code'] == 0
-
-
-def get_device_info(device_model: str) -> dict:
-    """
-    Get device info 获取设备信息
-    :param device_model: 设备型号
-    :return: 设备信息字典
-    """
-    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 = {
-        'name': content['props']['product']['name'],
-        'model': content['props']['product']['model'],
-        'properties': [],
-        'actions': []
-    }
-    services = content['props']['spec']['services']
-
-    properties_name = []
-    actions_name = []
-    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['name'] in properties_name:
-                    item["name"] = f'{services[siid]["name"]}-{item["name"]}'
-                properties_name.append(item['name'])
-                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]
-                if act['name'] in actions_name:
-                    act['name'] = f'{services[siid]["name"]}-{act["name"]}'
-                actions_name.append(act['name'])
-                result['actions'].append({
-                    'name': act['name'],
-                    'description': act['description'],
-                    'method': {
-                        'siid': int(siid),
-                        'aiid': int(aiid)
-                    }
-                })
-    return result
+from typing import Union, Optional
+import json
+import re
+import requests
+from time import sleep
+from .apis import mijiaAPI
+from .code import ERROR_CODE
+from .urls import deviceURL
+from .logger import logger
+
+class DevProp(object):
+    def __init__(self, prop_dict: dict):
+        """
+        Initialize the property object 初始化属性对象
+        :param prop_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):
+        """
+        String representation of the property 返回属性的名称、描述、类型、读写权限、单位和范围
+        :return:
+        """
+        lines = [
+            f"  {self.name}: {self.desc}",
+            f"    valuetype: {self.type}, rw: {self.rw}, unit: {self.unit}, range: {self.range}"
+        ]
+
+        if self.value_list:
+            value_lines = [f"    {item['value']}: {item['description']}" for item in self.value_list]
+            lines.extend(value_lines)
+
+        return '\n'.join(lines)
+
+
+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: Optional[dict] = None,
+            dev_name: Optional[str] = None,
+            did: Optional[str] = None,
+            sleep_time: Optional[Union[int, float]] = 0.5
+    ):
+        """
+        Initialize the device object 初始化设备对象
+        若未提供设备信息，则根据设备名称获取设备信息，若两者均未提供，则抛出异常
+        若提供了设备信息的同时提供了设备名称，则以设备信息为准
+        :param api: 米家API对象
+        :param dev_info: 设备信息字典（可选）
+        :param dev_name: 设备名称（可选）
+        :param did: 设备ID（可选）
+        :param sleep_time: 调用设备属性的间隔时间（可选，默认0.5秒）
+        """
+        assert dev_info is not None or dev_name is not None, "Either 'dev_info' or 'dev_name' must be provided."
+        if dev_info is not None and dev_name is not None:
+            logger.warning("Both 'dev_info' and 'dev_name' provided. Using 'dev_info' for initialization.")
+
+        self.api = api
+        if dev_info is None:
+            devices_list = self.api.get_devices_list()
+            matches = [device for device in devices_list.get('list', []) if device['name'] == dev_name]
+            if not matches:
+                raise ValueError(f"Device {dev_name} not found")
+            elif len(matches) > 1:
+                raise ValueError(f"Multiple devices named {dev_name} found")
+            else:
+                dev_info = get_device_info(matches[0]['model'])
+                did = matches[0]['did']
+        self.name = dev_info['name']
+        self.model = dev_info['model']
+
+        self.prop_list = {}
+        for prop in dev_info.get('properties', []):
+            prop_obj = DevProp(prop)
+            name = prop['name']
+            self.prop_list[name] = prop_obj
+            if '-' in name:
+                self.prop_list[name.replace('-', '_')] = prop_obj
+
+        self.action_list = {
+            act['name']: DevAction(act)
+            for act in dev_info.get('actions', [])
+        }
+        self.did = did
+        self.sleep_time = sleep_time
+
+    def __str__(self) -> str:
+        """
+        String representation of the device 返回设备的属性和动作列表
+        :return: 设备的属性和动作列表
+        """
+        prop_list_str = '\n'.join(filter(None, (str(v) for k, v in self.prop_list.items() if '_' not in k)))
+        action_list_str = '\n'.join(map(str, self.action_list.values()))
+        return (f"{self.name} ({self.model})\n"
+                f"Properties:\n{prop_list_str if prop_list_str else 'No properties available'}\n"
+                f"Actions:\n{action_list_str if action_list_str else 'No actions available'}")
+
+    def set(self, name: str, did: str, value: Union[bool, int]) -> Union[bool, int]:
+        """
+        Set property value 设置设备的属性值
+        :param name: 属性名称
+        :param did: 设备ID
+        :param value: 属性值
+        :return: 执行结果（True/False）
+        """
+        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']:
+            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[:2]}')
+                if len(prop.range) >= 3 and prop.range[2] != 1:
+                    if (value - prop.range[0]) % prop.range[2] != 0:
+                        raise ValueError(
+                            f'Invalid value: {value}, should be in range {prop.range[:2]} with step {prop.range[2]}')
+        elif prop.type == 'float':
+            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[:2]}')
+                if len(prop.range) >= 3 and isinstance(prop.range[2], int):
+                    if int(value - prop.range[0]) % prop.range[2] != 0:
+                        raise ValueError(
+                            f'Invalid value: {value}, should be in range {prop.range[:2]} with step {prop.range[2]}')
+        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
+        result = self.api.set_devices_prop([method])[0]
+        if result['code'] != 0:
+            raise RuntimeError(
+                f"Failed to set property: {name}, "
+                f"code: {result['code']}, "
+                f"message: {ERROR_CODE.get(str(result['code']), 'Unknown error')}"
+            )
+        sleep(self.sleep_time)
+        return result['code'] == 0
+
+    def set_v2(self, name: str, value: Union[bool, int], did: Optional[str] = None) -> Union[bool, int]:
+        """
+        Set property value_v2 设置设备的属性值_v2（需在实例化时指定did）
+        :param name: 属性名称
+        :param value: 属性值
+        :param did: 设备ID（若未指定，则使用实例化时的did）
+        :return: 执行结果（True/False）
+        """
+        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]:
+        """
+        Get property value 获取设备的属性值
+        :param name: 属性名称
+        :param did: 设备ID（若未指定，则使用实例化时的did）
+        :return: 属性值
+        """
+        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
+        result = self.api.get_devices_prop([method])[0]
+        if result['code'] != 0:
+            raise RuntimeError(
+                f"Failed to get property: {name}, "
+                f"code: {result['code']}, "
+                f"message: {ERROR_CODE.get(str(result['code']), 'Unknown error')}"
+            )
+        sleep(self.sleep_time)
+        return result['value']
+
+    def __setattr__(self, name: str, value: Union[bool, int]) -> None:
+        """
+        Set property value 设置设备的属性值（需在实例化时指定did）
+        :param name: 属性名称
+        :param value: 属性值
+        :return: 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]:
+        """
+        Get property value 获取设备的属性值（需在实例化时指定did）
+        :param name: 属性名称
+        :return: 属性值
+        """
+        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,
+            **kwargs
+    ) -> bool:
+        """
+        Run action 运行设备动作
+        :param name: 动作名称
+        :param did: 设备ID（若未指定，则使用实例化时的did）
+        :param value: 动作参数（若动作不需要参数，则不需要指定）
+        :param kwargs: 其它动作参数（若动作不需要参数，则不需要指定）
+        :return: 执行结果（True/False）
+        """
+        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
+        if kwargs:
+            for k, v in kwargs.items():
+                if k.startswith("_"):
+                    k = k[1:]
+                if k in method:
+                    raise ValueError(f'Invalid argument: {k}. Do not use arguments in ({", ".join(method.keys())})')
+                method[k] = v
+        result = self.api.run_action(method)
+        if result['code'] != 0:
+            raise RuntimeError(
+                f"Failed to run action: {name}, "
+                f"code: {result['code']}, "
+                f"message: {ERROR_CODE.get(str(result['code']), 'Unknown error')}"
+            )
+        sleep(self.sleep_time)
+        return result['code'] == 0
+
+
+def get_device_info(device_model: str) -> dict:
+    """
+    Get device info 获取设备信息
+    :param device_model: 设备型号
+    :return: 设备信息字典
+    """
+    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 = {
+        'name': content['props']['product']['name'],
+        'model': content['props']['product']['model'],
+        'properties': [],
+        'actions': []
+    }
+    services = content['props']['spec']['services']
+
+    properties_name = []
+    actions_name = []
+    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['name'] in properties_name:
+                    item["name"] = f'{services[siid]["name"]}-{item["name"]}'
+                properties_name.append(item['name'])
+                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]
+                if act['name'] in actions_name:
+                    act['name'] = f'{services[siid]["name"]}-{act["name"]}'
+                actions_name.append(act['name'])
+                result['actions'].append({
+                    'name': act['name'],
+                    'description': act['description'],
+                    'method': {
+                        'siid': int(siid),
+                        'aiid': int(aiid)
+                    }
+                })
+    return result

mijiaapi-1.3.10/mijiaAPI/logger.py

@@ -0,0 +1,37 @@
+import logging
+import sys
+
+class ColorFormatter(logging.Formatter):
+    COLORS = {
+        'DEBUG': '\033[36m',      # 青色
+        'INFO': '\033[32m',       # 绿色
+        'WARNING': '\033[33m',    # 黄色
+        'ERROR': '\033[31m',      # 红色
+        'CRITICAL': '\033[1;31m', # 加粗红色
+        'RESET': '\033[0m',       # 重置颜色
+    }
+
+    def __init__(self, fmt=None, datefmt=None, style='%'):
+        super().__init__(fmt, datefmt, style)
+        self.use_colors = sys.stdout.isatty()
+
+    def format(self, record):
+        log_message = super().format(record)
+        if self.use_colors:
+            color_code = self.COLORS.get(record.levelname, self.COLORS['RESET'])
+            return f"{color_code}{log_message}{self.COLORS['RESET']}"
+        return log_message
+
+logger = logging.getLogger('mijiaAPI')
+logger.setLevel(logging.INFO)
+
+console_handler = logging.StreamHandler()
+console_handler.setLevel(logging.INFO)
+
+formatter = ColorFormatter(
+    '%(asctime)s - %(name)s - %(levelname)s: %(message)s',
+    datefmt='%Y-%m-%d %H:%M:%S',
+)
+console_handler.setFormatter(formatter)
+
+logger.addHandler(console_handler)

{mijiaapi-1.3.9 → mijiaapi-1.3.10}/mijiaAPI/login.py

@@ -12,6 +12,7 @@ import requests
 
 from .urls import msgURL, loginURL, qrURL, accountURL
 from .utils import defaultUA
+from .logger import logger
 
 
 class LoginError(Exception):
@@ -66,9 +67,9 @@ class mijiaLogin(object):
                 self.save_path = os.path.abspath(self.save_path)
             with open(self.save_path, 'w') as f:
                 json.dump(self.auth_data, f, indent=2)
-            print(f'Auth data saved to [{self.save_path}]')
+            logger.info(f'Auth data saved to [{self.save_path}]')
         else:
-            print('Auth data not saved')
+            logger.info('Auth data not saved')
 
     def login(self, username: str, password: str) -> dict:
         """login with username and password
@@ -81,11 +82,7 @@ class mijiaLogin(object):
         @return
         dict, data for authorization, including userId, ssecurity, deviceId, serviceToken
         """
-        warning_msg = 'WARNING: there is a high probability of verification code with account and password. Please try other login methods'
-        if sys.stdout.isatty():
-            print(f'\033[33;1m{warning_msg}\033[0m')
-        else:
-            print(warning_msg)
+        logger.warning('There is a high probability of verification code with account and password. Please try other login methods')
         data = self._get_index()
         post_data = {
             'qs': data['qs'],
@@ -125,7 +122,7 @@ class mijiaLogin(object):
 
     @staticmethod
     def _print_qr(loginurl: str, box_size: int = 10) -> None:
-        print('Scan the QR code below with Mi Home app')
+        logger.info('Scan the QR code below with Mi Home app')
         qr = QRCode(border=1, box_size=box_size)
         qr.add_data(loginurl)
         qr.make_image().save('qr.png')
@@ -133,8 +130,10 @@ class mijiaLogin(object):
             qr.print_ascii(invert=True, tty=True)
         except OSError:
             qr.print_ascii(invert=True, tty=False)
-            print('If the QR code can not be scanned, please change the font of the terminal, such as "Maple Mono", "Fira Code", etc.')
-            print('Or just use the qr.png file in the current directory.')
+            logger.info('If the QR code can not be scanned, '
+                        'please change the font of the terminal, '
+                        'such as "Maple Mono", "Fira Code", etc.\n'
+                        'Or just use the qr.png file in the current directory.')
 
     def QRlogin(self) -> dict:
         """login with QR code

{mijiaapi-1.3.9 → mijiaapi-1.3.10}/mijiaAPI/urls.py

@@ -1,7 +1,7 @@
-sid = 'xiaomiio'
-msgURL = f'https://account.xiaomi.com/pass/serviceLogin?sid={sid}&_json=true'
-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/'
-accountURL = 'https://account.xiaomi.com/pass2/profile/home?bizFlag=&userId='
+sid = 'xiaomiio'
+msgURL = f'https://account.xiaomi.com/pass/serviceLogin?sid={sid}&_json=true'
+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/'
+accountURL = 'https://account.xiaomi.com/pass2/profile/home?bizFlag=&userId='

{mijiaapi-1.3.9 → mijiaapi-1.3.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mijiaAPI"
-version = "1.3.9"
+version = "1.3.10"
 description = "A Python API for Xiaomi Mijia"
 readme = "README.md"
 requires-python = ">=3.9,<4.0"
@@ -12,7 +12,7 @@ dependencies = [
 
 [tool.poetry]
 name = "mijiaAPI"
-version = "1.3.9"
+version = "1.3.10"
 description = "A Python API for Xiaomi Mijia"
 authors = ["Do1e <dpj.email@qq.com>"]
 license = "GPLv3"