mijiaAPI 1.5.0__tar.gz → 2.0.1__tar.gz

{mijiaapi-1.5.0 → mijiaapi-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mijiaAPI
-Version: 1.5.0
+Version: 2.0.1
 Summary: A Python API for Xiaomi Mijia
 License: GPLv3
 Author: Do1e
@@ -30,6 +30,12 @@ Description-Content-Type: text/markdown
 [![PyPI](https://img.shields.io/badge/PyPI-mijiaAPI-blue)](https://pypi.org/project/mijiaAPI/)
 [![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-green.svg)](https://opensource.org/licenses/GPL-3.0)
 
+## ⚠️ 重要提醒
+
+**自 v1.5.0 版本以来，本项目包含多项破坏性变更！**
+
+如果您正在从旧版本升级，请务必查看 [CHANGELOG.md](CHANGELOG.md) 以了解详细的变更内容和迁移指南。
+
 ## 安装
 
 ### 从 PyPI 安装（推荐）
@@ -91,15 +97,18 @@ yay -S python-mijia-api
 
 #### 设备与场景获取与控制：
 
+下述方法可参考 [demos/test_apis.py](demos/test_apis.py) 中的示例。
+
 * `get_devices_list() -> list`：获取设备列表
 * `get_homes_list() -> list`：获取家庭列表（包含房间信息）
 * `get_scenes_list(home_id: str) -> list`：获取手动场景列表
   - 在米家 App 中通过 **米家→添加→手动控制** 设置
 * `run_scene(scene_id: str) -> bool`：运行指定场景
-* `get_consumable_items(home_id: str) -> list`：获取设备的耗材信息
+* `get_consumable_items(home_id: str, owner_id: Optional[int] = None) -> list`：获取设备的耗材信息，如果是共享家庭，需要额外指定 `owner_id` 参数
 * `get_devices_prop(data: list) -> list`：获取设备属性
 * `set_devices_prop(data: list) -> list`：设置设备属性
 * `run_action(data: dict) -> dict`：执行设备的特定动作
+* `get_statistics(data: dict) -> list`：获取设备的统计信息，如空调每个月的耗电量，参考 [demos/test_get_statistics.py](demos/test_get_statistics.py)
 
 设备属性和动作的相关参数（`siid`, `piid`, `aiid`）可以从 [米家产品库](https://home.miot-spec.com) 查询：
 * 访问 `https://home.miot-spec.com/spec/{model}`（`model` 在设备列表中获取）
@@ -145,9 +154,9 @@ mijiaDevice(api: mijiaAPI, dev_info: dict = None, dev_name: str = None, did: str
 
 #### 使用方法控制：
 
-* `set(name: str, did: str, value: Union[bool, int]) -> bool`：设置设备属性
-* `get(name: str, did: str) -> Union[bool, int, float, str]`：获取设备属性
-* `run_action(name: str, did: str = None, value: Any = None, **kwargs) -> bool`：执行设备动作
+* `set(name: str, value: Union[bool, int, float, str], did: Optional[str] = None) -> bool`：设置设备属性
+* `get(name: str, did: Optional[str] = None) -> Union[bool, int, float, str]`：获取设备属性
+* `run_action(name: str, did: Optional[str] = None, value: Optional[Union[list, tuple]] = None, **kwargs) -> bool`：执行设备动作
 
 #### 属性样式访问：
 
@@ -255,6 +264,23 @@ mijiaAPI --run 明天天气如何
 mijiaAPI --run 打开台灯并将亮度调至最大 --quiet
 ```
 
+## 常见问题
+
+### 账号密码登录失败
+
+现在登录似乎100%遇到验证码，建议使用扫码登录。
+
+### XXX设备的XXX如何获取/设置
+
+我拥有的设备有限，无法保证能解答这类问题，但也欢迎提交 [issue](https://github.com/Do1e/mijia-api/issues)，可能需要你将设备共享给我进行抓包或者自行抓包给我提供请求和响应，提供har文件的话注意自行删除cookie等敏感信息。
+
+### 如何抓包
+
+小米官方给了一个[抓包教程](https://iot.mi.com/new/doc/accesses/direct-access/extension-development/troubleshooting/packet_capture)，我没试过，不确定是否能行，如果抓包成功数据是加密的，可以使用 [demos/decrypt.py](demos/decrypt.py) 解密。
+
+我自己的解决方案是使用一个获取了root的手机，安装 [reqable](https://reqable.com/zh-CN/) 进行抓包，导出 HAR 文件后使用 [demos/decrypt_har.py](demos/decrypt_har.py) 解密。
+
+
 ## 致谢
 
 * [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)

{mijiaapi-1.5.0 → mijiaapi-2.0.1}/README.md

@@ -6,6 +6,12 @@
 [![PyPI](https://img.shields.io/badge/PyPI-mijiaAPI-blue)](https://pypi.org/project/mijiaAPI/)
 [![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-green.svg)](https://opensource.org/licenses/GPL-3.0)
 
+## ⚠️ 重要提醒
+
+**自 v1.5.0 版本以来，本项目包含多项破坏性变更！**
+
+如果您正在从旧版本升级，请务必查看 [CHANGELOG.md](CHANGELOG.md) 以了解详细的变更内容和迁移指南。
+
 ## 安装
 
 ### 从 PyPI 安装（推荐）
@@ -67,15 +73,18 @@ yay -S python-mijia-api
 
 #### 设备与场景获取与控制：
 
+下述方法可参考 [demos/test_apis.py](demos/test_apis.py) 中的示例。
+
 * `get_devices_list() -> list`：获取设备列表
 * `get_homes_list() -> list`：获取家庭列表（包含房间信息）
 * `get_scenes_list(home_id: str) -> list`：获取手动场景列表
   - 在米家 App 中通过 **米家→添加→手动控制** 设置
 * `run_scene(scene_id: str) -> bool`：运行指定场景
-* `get_consumable_items(home_id: str) -> list`：获取设备的耗材信息
+* `get_consumable_items(home_id: str, owner_id: Optional[int] = None) -> list`：获取设备的耗材信息，如果是共享家庭，需要额外指定 `owner_id` 参数
 * `get_devices_prop(data: list) -> list`：获取设备属性
 * `set_devices_prop(data: list) -> list`：设置设备属性
 * `run_action(data: dict) -> dict`：执行设备的特定动作
+* `get_statistics(data: dict) -> list`：获取设备的统计信息，如空调每个月的耗电量，参考 [demos/test_get_statistics.py](demos/test_get_statistics.py)
 
 设备属性和动作的相关参数（`siid`, `piid`, `aiid`）可以从 [米家产品库](https://home.miot-spec.com) 查询：
 * 访问 `https://home.miot-spec.com/spec/{model}`（`model` 在设备列表中获取）
@@ -121,9 +130,9 @@ mijiaDevice(api: mijiaAPI, dev_info: dict = None, dev_name: str = None, did: str
 
 #### 使用方法控制：
 
-* `set(name: str, did: str, value: Union[bool, int]) -> bool`：设置设备属性
-* `get(name: str, did: str) -> Union[bool, int, float, str]`：获取设备属性
-* `run_action(name: str, did: str = None, value: Any = None, **kwargs) -> bool`：执行设备动作
+* `set(name: str, value: Union[bool, int, float, str], did: Optional[str] = None) -> bool`：设置设备属性
+* `get(name: str, did: Optional[str] = None) -> Union[bool, int, float, str]`：获取设备属性
+* `run_action(name: str, did: Optional[str] = None, value: Optional[Union[list, tuple]] = None, **kwargs) -> bool`：执行设备动作
 
 #### 属性样式访问：
 
@@ -231,6 +240,23 @@ mijiaAPI --run 明天天气如何
 mijiaAPI --run 打开台灯并将亮度调至最大 --quiet
 ```
 
+## 常见问题
+
+### 账号密码登录失败
+
+现在登录似乎100%遇到验证码，建议使用扫码登录。
+
+### XXX设备的XXX如何获取/设置
+
+我拥有的设备有限，无法保证能解答这类问题，但也欢迎提交 [issue](https://github.com/Do1e/mijia-api/issues)，可能需要你将设备共享给我进行抓包或者自行抓包给我提供请求和响应，提供har文件的话注意自行删除cookie等敏感信息。
+
+### 如何抓包
+
+小米官方给了一个[抓包教程](https://iot.mi.com/new/doc/accesses/direct-access/extension-development/troubleshooting/packet_capture)，我没试过，不确定是否能行，如果抓包成功数据是加密的，可以使用 [demos/decrypt.py](demos/decrypt.py) 解密。
+
+我自己的解决方案是使用一个获取了root的手机，安装 [reqable](https://reqable.com/zh-CN/) 进行抓包，导出 HAR 文件后使用 [demos/decrypt_har.py](demos/decrypt_har.py) 解密。
+
+
 ## 致谢
 
 * [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)

mijiaapi-2.0.1/mijiaAPI/__init__.py

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

{mijiaapi-1.5.0 → mijiaapi-2.0.1}/mijiaAPI/__main__.py

@@ -133,7 +133,7 @@ def init_api(auth_path: str) -> mijiaAPI:
                 auth = json.load(f)
             api = mijiaAPI(auth_data=auth)
             if not api.available:
-                raise ValueError("Saved auth is no longer valid")
+                raise ValueError("认证信息已过期")
         except (json.JSONDecodeError, ValueError):
             api = mijiaLogin(save_path=auth_path)
             auth = api.QRlogin()
@@ -146,12 +146,8 @@ def init_api(auth_path: str) -> mijiaAPI:
 
 def get_devices_list(api: mijiaAPI, verbose: bool = True) -> dict:
     devices = api.get_devices_list()
-    if 'list' in devices:
-        devices = devices['list']
-    else:
-        devices = []
     if verbose:
-        print("Devices:")
+        print("设备列表:")
         for device in devices:
             print(f"  - {device['name']}\n"
                     f"    did: {device['did']}\n"
@@ -165,19 +161,15 @@ def get_homes_list(api: mijiaAPI, verbose: bool = True, device_mapping: Optional
         if device_mapping is None:
             device_mapping = get_devices_list(api, verbose=False)
     homes = api.get_homes_list()
-    if 'homelist' in homes:
-        homes = homes['homelist']
-    else:
-        homes = []
     if verbose:
-        print("Homes:")
+        print("家庭列表:")
         for home in homes:
             print(f"  - {home['name']}\n"
-                f"    id: {home['id']}\n"
-                f"    address: {home['address']}\n"
-                f"    room count: {len(home['roomlist'])}\n"
-                f"    create time: {time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(home['create_time']))}")
-            print("    Rooms:")
+                  f"    ID: {home['id']}\n"
+                  f"    地址: {home['address']}\n"
+                  f"    房间数量: {len(home['roomlist'])}\n"
+                  f"    创建时间: {time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(home['create_time']))}")
+            print( "    房间列表:")
             for room in home['roomlist']:
                 devices_name = []
                 if room['dids']:
@@ -188,9 +180,9 @@ def get_homes_list(api: mijiaAPI, verbose: bool = True, device_mapping: Optional
                             devices_name.append(did)
                 dids = ', '.join(devices_name)
                 print(f"    - {room['name']}\n"
-                      f"      id: {room['id']}\n"
-                      f"      dids: {dids}\n"
-                      f"      create time: {time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(room['create_time']))}")
+                      f"      ID: {room['id']}\n"
+                      f"      设备列表: {dids}\n"
+                      f"      创建时间: {time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(room['create_time']))}")
     home_mapping = {home['id']: home for home in homes}
     return home_mapping
 
@@ -200,16 +192,12 @@ def get_scenes_list(api: mijiaAPI, verbose: bool = True, home_mapping: Optional[
     scene_mapping = {}
     for home_id, home in home_mapping.items():
         scenes = api.get_scenes_list(home_id)
-        if 'scene_info_list' in scenes:
-            scenes = scenes['scene_info_list']
-        else:
-            scenes = []
         if scenes and verbose:
-            print(f"Scenes in {home['name']} ({home_id}):")
+            print(f"{home['name']} ({home_id}) 中的场景:")
             for scene in scenes:
                 print(f"  - {scene['name']}\n"
-                      f"    id: {scene['scene_id']}\n"
-                      f"    create time: {time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(int(scene['create_time'])))}\n"
+                      f"    ID: {scene['scene_id']}\n"
+                      f"    创建时间: {time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(int(scene['create_time'])))}\n"
                       f"    update time: {time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(int(scene['update_time'])))}")
         scene_mapping.update({scene['scene_id']: scene for scene in scenes})
     return scene_mapping
@@ -218,15 +206,12 @@ def get_consumable_items(api: mijiaAPI, home_mapping: Optional[dict] = None):
     if home_mapping is None:
         home_mapping = get_homes_list(api, verbose=False)
     for home_id, home in home_mapping.items():
-        items = api.get_consumable_items(home_id)
-        if 'items' in items:
-            items = items['items'][0]['consumes_data']
-        else:
-            items = []
-        print(f"Consumable items in {home['name']} ({home_id}):")
+        items = api.get_consumable_items(home_id, home['uid'])
+        print(f"{home['name']} ({home_id}) 中的耗材:")
         for item in items:
-            print(f"  - {item['details'][0]['description']} in {item['name']}({item['did']})\n"
-                  f"    value: {item['details'][0]['value']}")
+            for consumes_data in item['consumes_data']:
+                print(f"  - {consumes_data['details'][0]['description']} 在 {consumes_data['name']}({consumes_data['did']})\n"
+                      f"    值: {consumes_data['details'][0]['value']}")
 
 def run_scene(api: mijiaAPI, scene_id: str, scene_mapping: Optional[dict] = None) -> bool:
     if scene_mapping is None:
@@ -240,15 +225,15 @@ def run_scene(api: mijiaAPI, scene_id: str, scene_mapping: Optional[dict] = None
                 found = True
                 break
         if not found:
-            print(f"Scene {scene_name_to_find} not found")
+            print(f"场景 {scene_name_to_find} 未找到")
             return False
     scene_name = scene_mapping[scene_id]['name']
     ret = api.run_scene(scene_id)
     if ret:
-        print(f"Scene {scene_name}({scene_id}) run successfully")
+        print(f"场景 {scene_name}({scene_id}) 运行成功")
         return True
     else:
-        print(f"Failed to run scene {scene_name}({scene_id})")
+        print(f"运行场景 {scene_name}({scene_id}) 失败")
         return False
 
 def get(args):
@@ -256,17 +241,17 @@ def get(args):
     device = mijiaDevice(api, dev_name=args.dev_name)
     value = device.get(args.prop_name)
     unit = device.prop_list[args.prop_name].unit
-    print(f"The {args.prop_name} of {args.dev_name} is {value} {unit if unit else ''}")
+    print(f"{args.dev_name} 的 {args.prop_name} 值为 {value} {unit if unit else ''}")
 
 def set(args):
     api = init_api(args.auth_path)
     device = mijiaDevice(api, dev_name=args.dev_name)
-    ret = device.set_v2(args.prop_name, args.value)
+    ret = device.set(args.prop_name, args.value)
     unit = device.prop_list[args.prop_name].unit
     if ret:
-        print(f"The {args.prop_name} of {args.dev_name} is set to {args.value} {unit if unit else ''}")
+        print(f"{args.dev_name} 的 {args.prop_name} 值已设置为 {args.value} {unit if unit else ''}")
     else:
-        print(f"Failed to set the {args.prop_name} of {args.dev_name} to {args.value}")
+        print(f"设置 {args.dev_name} 的 {args.prop_name} 值为 {args.value} 失败")
 
 
 def main(args):
@@ -310,7 +295,7 @@ def main(args):
                     wifispeaker = mijiaDevice(api, dev_name=device['name'])
                     break
             if wifispeaker is None:
-                raise ValueError("No wifispeaker found")
+                raise ValueError("未找到小爱音箱设备")
         else:
             wifispeaker = mijiaDevice(api, dev_name=args.wifispeaker_name)
         wifispeaker.run_action('execute-text-directive', _in=[args.run, args.quiet])

{mijiaapi-1.5.0 → mijiaapi-2.0.1}/mijiaAPI/apis.py

@@ -1,10 +1,11 @@
 from datetime import datetime
-from typing import Union
+from typing import Union, Optional
 
 import requests
 import requests.cookies
 
-from .utils import defaultUA, post_data, PostDataError
+from .consts import defaultUA
+from .utils import post_data
 
 
 class mijiaAPI(object):
@@ -19,7 +20,7 @@ class mijiaAPI(object):
             Exception: 当授权数据不完整时抛出异常。
         """
         if any(k not in auth_data for k in ['userId', 'deviceId', 'ssecurity', 'serviceToken']):
-            raise Exception('Invalid authorize data')
+            raise Exception('授权数据无效')
         self.userId = auth_data['userId']
         self.ssecurity = auth_data['ssecurity']
         self.session = requests.Session()
@@ -35,7 +36,7 @@ class mijiaAPI(object):
     @staticmethod
     def _post_process(data: dict) -> Union[list, bool]:
         if data['code'] != 0:
-            raise Exception(f'Failed to get data, {data["message"]}')
+            raise Exception(f'获取数据失败, {data["message"]}')
         return data['result']
 
     @property
@@ -53,16 +54,38 @@ class mijiaAPI(object):
             return True
         return False
 
-    def get_devices_list(self) -> dict:
+    def get_devices_list(self) -> list:
         """
         获取设备列表。
 
         Returns:
             dict: 设备列表。
         """
-        uri = '/home/device_list'
-        data = {"getVirtualModel": False, "getHuamiDevices": 0}
-        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
+        uri = '/home/home_device_list'
+        home_list = self.get_homes_list()
+        devices = []
+        for home in home_list:
+            start_did = ''
+            has_more = True
+            while has_more:
+                data = {
+                    "home_owner": home['uid'],
+                    "home_id": int(home['id']),
+                    "limit": 200,
+                    "start_did": start_did,
+                    "get_split_device": True,
+                    "support_smart_home": True,
+                    "get_cariot_device": True,
+                    "get_third_device": True
+                }
+                ret = self._post_process(post_data(self.session, self.ssecurity, uri, data))
+                if ret and ret.get('device_info'):
+                    devices.extend(ret['device_info'])
+                    start_did = ret.get('max_did', '')
+                    has_more = ret.get('has_more', False) and start_did != ''
+                else:
+                    has_more = False
+        return devices
 
     def get_homes_list(self) -> list:
         """
@@ -71,9 +94,9 @@ class mijiaAPI(object):
         Returns:
             list: 家庭列表，包括房间信息。
         """
-        uri = '/v2/homeroom/gethome'
-        data = {"fg": False, "fetch_share": True, "fetch_share_dev": True, "limit": 300, "app_ver": 7}
-        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
+        uri = '/v2/homeroom/gethome_merged'
+        data = {"fg": True, "fetch_share": True, "fetch_share_dev": True, "limit": 300, "app_ver": 7}
+        return self._post_process(post_data(self.session, self.ssecurity, uri, data))['homelist']
 
     def get_scenes_list(self, home_id: str) -> list:
         """
@@ -89,7 +112,10 @@ class mijiaAPI(object):
         """
         uri = '/appgateway/miot/appsceneservice/AppSceneService/GetSceneList'
         data = {"home_id": home_id}
-        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
+        ret = self._post_process(post_data(self.session, self.ssecurity, uri, data))
+        if ret and 'scene_info_list' in ret:
+            return ret['scene_info_list']
+        return []
 
     def run_scene(self, scene_id: str) -> bool:
         """
@@ -105,19 +131,23 @@ class mijiaAPI(object):
         data = {"scene_id": scene_id, "trigger_key": "user.click"}
         return self._post_process(post_data(self.session, self.ssecurity, uri, data))
 
-    def get_consumable_items(self, home_id: str) -> list:
+    def get_consumable_items(self, home_id: str, owner_id: Optional[int] = None) -> list:
         """
         获取耗材列表。
 
         Args:
             home_id (str): 家庭ID，从get_homes_list获取。
+            owner_id (str, optional): 用户ID，默认为None，如果`home_id`为共享家庭，则需要提供owner_id。
 
         Returns:
             list: 耗材列表。
         """
         uri = '/v2/home/standard_consumable_items'
-        data = {"home_id": int(home_id), "owner_id": self.userId}
-        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
+        data = {"home_id": int(home_id), "owner_id": int(owner_id) if owner_id else self.userId}
+        ret = self._post_process(post_data(self.session, self.ssecurity, uri, data))
+        if ret and 'items' in ret:
+            return ret['items']
+        return []
 
     def get_devices_prop(self, data: list) -> list:
         """
@@ -155,7 +185,7 @@ class mijiaAPI(object):
 
                 示例(yeelink.light.lamp4)：
                 [
-                    {"did": "1234567890", "siid": 2, "piid": 2, "value": 50} # 设置亮度为50%
+                    {"did": "1234567890", "siid": 2, "piid": 2, "value": 50},  # 设置亮度为50%
                     {"did": "1234567890", "siid": 2, "piid": 3, "value": 2700} # 设置色温为2700K
                 ]
 
@@ -178,7 +208,7 @@ class mijiaAPI(object):
                 - value: 参数列表
 
                 示例(xiaomi.feeder.pi2001)：
-                {"did": "1234567890", "siid": 2, "aiid": 1, "value": [2]}, # 远程喂食2份
+                {"did": "1234567890", "siid": 2, "aiid": 1, "value": [2]} # 远程喂食2份
 
         Returns:
             dict: 操作结果。
@@ -186,3 +216,36 @@ class mijiaAPI(object):
         uri = '/miotspec/action'
         data = {"params": data}
         return self._post_process(post_data(self.session, self.ssecurity, uri, data))
+
+    def get_statistics(self, data: dict) -> list:
+        """
+        获取设备的统计信息。
+
+        Args:
+            data (dict): 请求参数，包含以下键：
+                - did: 设备ID，从get_devices_list获取
+                - key: siid.piid，表示要获取统计数据的属性
+                - data_type: 统计类型，可选值包括：
+                    - 'stat_hour_v3': 按小时统计
+                    - 'stat_day_v3': 按天统计
+                    - 'stat_week_v3': 按周统计
+                    - 'stat_month_v3': 按月统计
+                - limit: 返回的最大条目数，可选参数
+                - time_start: 开始时间戳，单位为秒
+                - time_end: 结束时间戳，单位为秒
+
+                示例(lumi.acpartner.mcn04 的 power-consumption)：
+                {
+                    "did": "1234567890",
+                    "key": "7.1",
+                    "data_type": "stat_month_v3",
+                    "limit": 24,
+                    "time_start": 1685548800,
+                    "time_end": 1750694400,
+                } # 2023-06-01 00:00:00 到 2025-06-24 00:00:00 的月度统计数据
+
+        Returns:
+            list: 统计信息列表。
+        """
+        uri = '/v2/user/statistics'
+        return self._post_process(post_data(self.session, self.ssecurity, uri, data))

mijiaapi-1.5.0/mijiaAPI/urls.py → mijiaapi-2.0.1/mijiaAPI/consts.py

@@ -5,3 +5,5 @@ 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='
+
+defaultUA = 'Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Mobile Safari/537.36 Edg/126.0.0.0'

{mijiaapi-1.5.0 → mijiaapi-2.0.1}/mijiaAPI/devices.py

@@ -6,7 +6,7 @@ import requests
 from time import sleep
 from .apis import mijiaAPI
 from .code import ERROR_CODE
-from .urls import deviceURL
+from .consts import deviceURL
 from .logger import get_logger
 
 logger = get_logger(__name__)
@@ -26,7 +26,7 @@ class DevProp(object):
         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')
+            raise ValueError(f'不支持的类型: {self.type}, 可选类型: bool, int, uint, float, string')
         self.rw = prop_dict['rw']
         self.unit = prop_dict['unit']
         self.range = prop_dict['range']
@@ -106,18 +106,18 @@ class mijiaDevice(object):
             - 如果只提供了dev_info，则直接使用该信息。
         """
         if dev_info is None and dev_name is None:
-            raise RuntimeError("Either 'dev_info' or 'dev_name' must be provided.")
+            raise RuntimeError("必须提供 'dev_info' 或 'dev_name' 中的一个参数。")
         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.")
+            logger.warning("同时提供了 'dev_info' 和 'dev_name'。将使用 'dev_info' 进行初始化。")
 
         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]
+            matches = [device for device in devices_list if device['name'] == dev_name]
             if not matches:
-                raise ValueError(f"Device {dev_name} not found")
+                raise ValueError(f"未找到设备 {dev_name}")
             elif len(matches) > 1:
-                raise ValueError(f"Multiple devices named {dev_name} found")
+                raise ValueError(f"找到多个名为 {dev_name} 的设备")
             else:
                 dev_info = get_device_info(matches[0]['model'])
                 did = matches[0]['did']
@@ -152,14 +152,14 @@ class mijiaDevice(object):
                 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, float, str]) -> bool:
+    def set(self, name: str, value: Union[bool, int, float, str], did: Optional[str] = None) -> bool:
         """
         设置设备的属性值。
 
         Args:
             name (str): 属性名称。
-            did (str): 设备ID。
             value (Union[bool, int, float, str]): 属性值。
+            did (str, optional): 设备ID。如未指定，则使用实例化时的did。默认为None。
 
         Returns:
             bool: 执行结果（True/False）。
@@ -168,14 +168,18 @@ class mijiaDevice(object):
             ValueError: 如果属性不存在、属性为只读或值无效。
             RuntimeError: 如果设置属性失败。
         """
+        if did is None:
+            did = self.did
+        if did is None:
+            raise ValueError('请指定设备ID (did)')
         if name not in self.prop_list:
-            raise ValueError(f'Unsupported property: {name}, available properties: {list(self.prop_list.keys())}')
+            raise ValueError(f'不支持的属性: {name}, 可用属性: {list(self.prop_list.keys())}')
         prop = self.prop_list[name]
         if 'w' not in prop.rw:
-            raise ValueError(f'Property {name} can not be written')
+            raise ValueError(f'属性 {name} 不可写入')
         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}')
+                raise ValueError(f'无效值: {value}, 请使用 {prop.value_list}')
         if prop.type == 'bool':
             if isinstance(value, str):
                 if value.lower() == 'true':
@@ -185,75 +189,53 @@ class mijiaDevice(object):
                 elif value in ['0', '1']:
                     value = bool(int(value))
                 else:
-                    raise ValueError(f'Invalid value for bool: {value}, should be True or False')
+                    raise ValueError(f'无效布尔值: {value}')
             elif isinstance(value, int):
                 if value == 0:
                     value = False
                 elif value == 1:
                     value = True
                 else:
-                    raise ValueError(f'Invalid value for bool: {value}, should be True or False')
+                    raise ValueError(f'无效布尔值: {value}')
             elif not isinstance(value, bool):
-                raise ValueError(f'Invalid value for bool: {value}, should be True or False')
+                raise ValueError(f'无效布尔值: {value}')
         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]}')
+                    raise ValueError(f'{value} 超出数值范围, 应该在 {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]}')
+                            f'无效的值: {value}, 应该在范围 {prop.range[:2]} 内且步长为 {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]}')
+                    raise ValueError(f'{value} 超出数值范围, 应该在 {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]}')
+                            f'无效的值: {value}, 应该在范围 {prop.range[:2]} 内且步长为 {prop.range[2]}')
         elif prop.type == 'string':
             if not isinstance(value, str):
-                raise ValueError(f'Invalid value for string: {value}, should be a string')
+                raise ValueError(f'无效字符串值: {value}')
         else:
-            raise ValueError(f'Unsupported type: {prop.type}, available types: bool, int, uint, float, string')
+            raise ValueError(f'不支持的类型: {prop.type}, 可用类型: 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')}"
+                f"设置属性 {name} 失败, "
+                f"错误码: {result['code']}, "
+                f"错误信息: {ERROR_CODE.get(str(result['code']), '未知错误')}"
             )
         sleep(self.sleep_time)
-        logger.debug(f"Set property: {self.name} -> {name}, value: {value}, result: {result}")
+        logger.debug(f"设置属性: {self.name} -> {name}, 值: {value}, 结果: {result}")
         return result['code'] == 0
 
-    def set_v2(self, name: str, value: Union[bool, int, float, str], did: Optional[str] = None) -> bool:
-        """
-        设置设备的属性值（v2版本，需在实例化时指定did或在调用时提供）。
-
-        Args:
-            name (str): 属性名称。
-            value (Union[bool, int, float, str]): 属性值。
-            did (str, optional): 设备ID。如未指定，则使用实例化时的did。默认为None。
-
-        Returns:
-            bool: 执行结果（True/False）。
-
-        Raises:
-            ValueError: 如果未指定设备ID。
-        """
-        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, float, str]:
         """
         获取设备的属性值。
@@ -272,23 +254,23 @@ class mijiaDevice(object):
         if did is None:
             did = self.did
         if did is None:
-            raise ValueError('Please specify the did')
+            raise ValueError('请指定设备ID (did)')
         if name not in self.prop_list:
-            raise ValueError(f'Unsupported property: {name}, available properties: {list(self.prop_list.keys())}')
+            raise ValueError(f'不支持的属性: {name}, 可用属性: {list(self.prop_list.keys())}')
         prop = self.prop_list[name]
         if 'r' not in prop.rw:
-            raise ValueError(f'Property {name} can not be read')
+            raise ValueError(f'属性 {name} 不可读取')
         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')}"
+                f"获取属性 {name} 失败, "
+                f"错误码: {result['code']}, "
+                f"错误信息: {ERROR_CODE.get(str(result['code']), '未知错误')}"
             )
         sleep(self.sleep_time)
-        logger.debug(f"Get property: {self.name} -> {name}, result: {result}")
+        logger.debug(f"获取属性: {self.name} -> {name}, 结果: {result}")
         return result['value']
 
     def __setattr__(self, name: str, value: Union[bool, int, float, str]) -> None:
@@ -303,8 +285,8 @@ class mijiaDevice(object):
             RuntimeError: 如果设置属性失败。
         """
         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}')
+            if not self.set(name, value):
+                raise RuntimeError(f'设置属性 {name} 失败')
         else:
             super().__setattr__(name, value)
 
@@ -349,9 +331,9 @@ class mijiaDevice(object):
         if did is None:
             did = self.did
         if did is None:
-            raise ValueError('Please specify the did')
+            raise ValueError('请指定设备ID (did)')
         if name not in self.action_list:
-            raise ValueError(f'Unsupported action: {name}, available actions: {list(self.action_list.keys())}')
+            raise ValueError(f'不支持的动作: {name}, 可用动作: {list(self.action_list.keys())}')
         act = self.action_list[name]
         method = act.method.copy()
         method['did'] = did
@@ -362,55 +344,20 @@ class mijiaDevice(object):
                 if k.startswith("_"):
                     k = k[1:]
                 if k in method:
-                    raise ValueError(f'Invalid argument: {k}. Do not use arguments in ({", ".join(method.keys())})')
+                    raise ValueError(f'无效的参数: {k}. 请勿使用以下参数 ({", ".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')}"
+                f"执行动作 {name} 失败, "
+                f"错误码: {result['code']}, "
+                f"错误信息: {ERROR_CODE.get(str(result['code']), '未知错误')}"
             )
         sleep(self.sleep_time)
-        logger.debug(f"Run action: {self.name} -> {name}, result: {result}")
+        logger.debug(f"执行动作: {self.name} -> {name}, 结果: {result}")
         return result['code'] == 0
 
 
-class mijiaDevices(mijiaDevice):
-    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
-    ):
-        """
-        初始化设备对象。
-
-        如果未提供设备信息，则根据设备名称获取设备信息。如果两者均未提供，则抛出异常。
-        如果同时提供了设备信息和设备名称，则以设备信息为准。
-
-        Args:
-            api (mijiaAPI): 米家API对象。
-            dev_info (dict, optional): 设备信息字典，从get_device_info获取。默认为None。
-            dev_name (str, optional): 设备名称，从get_devices_list获取。默认为None。
-            did (str, optional): 设备ID，如未指定，则需要在调用get/set时指定。默认为None。
-            sleep_time ([int, float], optional): 调用设备属性的间隔时间。默认为0.5秒。
-
-        Raises:
-            RuntimeError: 如果dev_info和dev_name都未提供。
-            ValueError: 如果找不到指定设备或找到多个同名设备。
-
-        Note:
-            - 如果同时提供了dev_info和dev_name，则以dev_info为准。
-            - 如果只提供了dev_name，则根据名称自动获取设备信息。
-            - 如果只提供了dev_info，则直接使用该信息。
-        """
-        super().__init__(api, dev_info, dev_name, did, sleep_time)
-        logger.warning("`mijiaDevices` will be deprecated in future versions, use `mijiaDevice` instead.")
-
-
 def get_device_info(device_model: str, cache_path: Optional[str] = os.path.join(os.path.expanduser("~"), ".config/mijia-api")) -> dict:
     """
     获取设备信息，用于初始化mijiaDevice对象。
@@ -432,10 +379,10 @@ def get_device_info(device_model: str, cache_path: Optional[str] = os.path.join(
                 return json.load(f)
     response = requests.get(deviceURL + device_model)
     if response.status_code != 200:
-        raise RuntimeError(f'Failed to get device info')
+        raise RuntimeError(f'获取设备信息失败')
     content = re.search(r'data-page="(.*?)">', response.text)
     if content is None:
-        raise RuntimeError(f'Failed to get device info')
+        raise RuntimeError(f'获取设备信息失败')
     content = content.group(1)
     content = json.loads(content.replace('&quot;', '"'))
 

{mijiaapi-1.5.0 → mijiaapi-2.0.1}/mijiaAPI/login.py

@@ -13,8 +13,7 @@ import requests
 from qrcode import QRCode
 
 from .logger import get_logger
-from .urls import msgURL, loginURL, qrURL, accountURL
-from .utils import defaultUA
+from .consts import msgURL, loginURL, qrURL, accountURL, defaultUA
 
 logger = get_logger(__name__)
 
@@ -65,7 +64,7 @@ class mijiaLogin(object):
         """
         ret = self.session.get(msgURL)
         if ret.status_code != 200:
-            raise LoginError(ret.status_code, f'Failed to get index page, {ret.text}')
+            raise LoginError(ret.status_code, f'获取索引页失败, {ret.text}')
         ret_data = json.loads(ret.text[11:])
         data = {'deviceId': self.deviceId}
         data.update({
@@ -90,7 +89,7 @@ class mijiaLogin(object):
         try:
             ret = self.session.get(accountURL + str(user_id))
             if ret.status_code != 200:
-                raise LoginError(ret.status_code, f'Failed to get account page, {ret.text}')
+                raise LoginError(ret.status_code, f'获取账户页面失败, {ret.text}')
             data = json.loads(ret.text[11:])['data']
         except (KeyError, json.JSONDecodeError) as e:
             data = {}
@@ -117,11 +116,13 @@ class mijiaLogin(object):
         ]
 
         if not gmt_time_keys:
-            raise LoginError(-1, 'No GMT time keys found in the data')
+            raise LoginError(-1, '在cookie中未找到GMT时间键')
         parsed_times = [datetime.strptime(k, '%d-%b-%Y %H:%M:%S GMT') for k in gmt_time_keys]
         latest_utc_time = max(parsed_times)
         china_time = latest_utc_time + timedelta(hours=8)
 
+        # [FIXME] 实测此处的过期时间并不准确，实际过期时间可能大于此处获取的时间
+        #         cookie 中唯一用到的 serviceToken 并无过期时间
         return china_time
 
     def _save_auth(self) -> None:
@@ -134,14 +135,14 @@ class mijiaLogin(object):
             if not os.path.isabs(self.save_path):
                 self.save_path = os.path.abspath(self.save_path)
             if os.path.exists(self.save_path) and not os.path.isfile(self.save_path):
-                raise ValueError(f'Path [{self.save_path}] is not a file')
+                raise ValueError(f'[{self.save_path}] 不是文件')
             if not os.path.exists(os.path.dirname(self.save_path)):
                 os.makedirs(os.path.dirname(self.save_path))
             with open(self.save_path, 'w') as f:
                 json.dump(self.auth_data, f, indent=2)
-            logger.info(f'Auth data saved to [{self.save_path}]')
+            logger.info(f'认证文件已保存到 [{self.save_path}]')
         else:
-            logger.info('Auth data not saved')
+            logger.info('认证文件未保存')
 
     def login(self, username: str, password: str) -> dict:
         """
@@ -157,7 +158,7 @@ class mijiaLogin(object):
         Raises:
             LoginError: 登录失败时抛出。
         """
-        logger.warning('There is a high probability of verification code with account and password. Please try `QRlogin` method.')
+        logger.warning('使用账号密码登录很可能需要验证码。请尝试使用 `QRlogin` 方法。')
         data = self._get_index()
         post_data = {
             'qs': data['qs'],
@@ -170,17 +171,17 @@ class mijiaLogin(object):
         }
         ret = self.session.post(loginURL, data=post_data)
         if ret.status_code != 200:
-            raise LoginError(ret.status_code, f'Failed to post login page, {ret.text}')
+            raise LoginError(ret.status_code, f'登录页面提交失败, {ret.text}')
         ret_data = json.loads(ret.text[11:])
         if ret_data['code'] != 0:
             raise LoginError(ret_data['code'], ret_data['desc'])
         if 'location' not in ret_data:
-            raise LoginError(-1, 'Failed to get location')
+            raise LoginError(-1, '获取跳转位置失败')
         if 'notificationUrl' in ret_data:
-            raise LoginError(-1, 'Verification code required, please try `QRlogin` method')
+            raise LoginError(-1, '需要验证码，请尝试使用 `QRlogin` 方法')
         ret = self.session.get(ret_data['location'])
         if ret.status_code != 200:
-            raise LoginError(ret.status_code, f'Failed to get location, {ret.text}')
+            raise LoginError(ret.status_code, f'获取跳转位置失败, {ret.text}')
         cookies = self.session.cookies.get_dict()
 
         self.auth_data = {
@@ -188,6 +189,7 @@ class mijiaLogin(object):
             'ssecurity': ret_data['ssecurity'],
             'deviceId': data['deviceId'],
             'serviceToken': cookies['serviceToken'],
+            'cUserId': cookies['cUserId'],
             'expireTime': self._extract_latest_gmt_datetime(cookies).strftime('%Y-%m-%d %H:%M:%S'),
             'account_info': self._get_account_info(ret_data['userId'])
         }
@@ -204,7 +206,7 @@ class mijiaLogin(object):
             loginurl (str): 包含登录信息的URL。
             box_size (int, optional): 二维码大小。默认为10。
         """
-        logger.info('Scan the QR code below with Mi Home app')
+        logger.info('请使用米家APP扫描下方二维码')
         qr = QRCode(border=1, box_size=box_size)
         qr.add_data(loginurl)
         qr.make_image().save('qr.png')
@@ -212,10 +214,10 @@ class mijiaLogin(object):
             qr.print_ascii(invert=True, tty=True)
         except OSError:
             qr.print_ascii(invert=True, tty=False)
-            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.')
+            logger.info('如果无法扫描二维码，'
+                        '请更改终端字体，'
+                        '如"Maple Mono"、"Fira Code"等。\n'
+                        '或者直接使用当前目录下的qr.png文件。')
 
     def QRlogin(self) -> dict:
         """
@@ -248,7 +250,7 @@ class mijiaLogin(object):
         url = qrURL + '?' + parse.urlencode(params)
         ret = self.session.get(url)
         if ret.status_code != 200:
-            raise LoginError(ret.status_code, f'Failed to get QR code URL, {ret.text}')
+            raise LoginError(ret.status_code, f'获取二维码URL失败, {ret.text}')
         ret_data = json.loads(ret.text[11:])
         if ret_data['code'] != 0:
             raise LoginError(ret_data['code'], ret_data['desc'])
@@ -257,15 +259,15 @@ class mijiaLogin(object):
         try:
             ret = self.session.get(ret_data['lp'], timeout=60, headers={'Connection': 'keep-alive'})
         except requests.exceptions.Timeout:
-            raise LoginError(-1, 'Timeout, please try again')
+            raise LoginError(-1, '超时，请重试')
         if ret.status_code != 200:
-            raise LoginError(ret.status_code, f'Failed to wait for login, {ret.text}')
+            raise LoginError(ret.status_code, f'等待登录失败, {ret.text}')
         ret_data = json.loads(ret.text[11:])
         if ret_data['code'] != 0:
             raise LoginError(ret_data['code'], ret_data['desc'])
         ret = self.session.get(ret_data['location'])
         if ret.status_code != 200:
-            raise LoginError(ret.status_code, f'Failed to get location, {ret.text}')
+            raise LoginError(ret.status_code, f'获取跳转位置失败, {ret.text}')
         cookies = self.session.cookies.get_dict()
 
         self.auth_data = {
@@ -273,6 +275,7 @@ class mijiaLogin(object):
             'ssecurity': ret_data['ssecurity'],
             'deviceId': data['deviceId'],
             'serviceToken': cookies['serviceToken'],
+            'cUserId': cookies['cUserId'],
             'expireTime': self._extract_latest_gmt_datetime(cookies).strftime('%Y-%m-%d %H:%M:%S'),
             'account_info': self._get_account_info(ret_data['userId'])
         }

{mijiaapi-1.5.0 → mijiaapi-2.0.1}/mijiaAPI/utils.py

@@ -6,9 +6,8 @@ import string
 
 import requests
 
-from .urls import apiURL
+from .consts import apiURL
 
-defaultUA = 'Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Mobile Safari/537.36 Edg/126.0.0.0'
 
 class PostDataError(Exception):
     def __init__(self, code: int, message: str):
@@ -38,6 +37,6 @@ def post_data(session: requests.Session, ssecurity: str, uri: str, data: dict) -
     post_data = {'_nonce': nonce, 'data': data, 'signature': signature}
     ret = session.post(apiURL + uri, data=post_data)
     if ret.status_code != 200:
-        raise PostDataError(ret.status_code, f'Failed to post data, {ret.text}')
+        raise PostDataError(ret.status_code, f'发送数据失败, {ret.text}')
     ret_data = ret.json()
     return ret_data

{mijiaapi-1.5.0 → mijiaapi-2.0.1}/pyproject.toml

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

mijiaapi-1.5.0/mijiaAPI/__init__.py

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