mijiaAPI 3.0.5__tar.gz → 3.2.0__tar.gz

{mijiaapi-3.0.5 → mijiaapi-3.2.0}/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 本文档记录了项目的v1.3.7以来的重要变更。
 
+## [3.2.0](https://github.com/Do1e/mijia-api/compare/v3.1.0...v3.2.0) - 2026-06-09
+### improvement
+* 将 `--run` 参数重构为独立的 `run` 子命令，提升 CLI 结构一致性
+* 保留 `--run` 作为隐藏的废弃参数，并显示迁移提示
+
+## [3.1.0](https://github.com/Do1e/mijia-api/compare/v3.0.5...v3.1.0) - 2026-05-27
+### new feature
+* 删除设备属性的单位`unit`属性，因为 home.miot-spec.com 上已废弃
+### bugfix
+* 适配 home.miot-spec.com 新的规格页格式
+* 修复 execute-text-directive 中 quiet 参数的类型转换
+
 ## [3.0.5](https://github.com/Do1e/mijia-api/compare/v3.0.4...v3.0.5) - 2026-01-24
 ### bugfix
 * 蓝牙设备控制返回 code 为 1 时表示网关已经接收指令，视为成功。

{mijiaapi-3.0.5 → mijiaapi-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mijiaAPI
-Version: 3.0.5
+Version: 3.2.0
 Summary: A Python API for Xiaomi Mijia
 Author-email: Do1e <i@do1e.cn>
 License-Expression: GPL-3.0-or-later
@@ -26,12 +26,6 @@ Dynamic: license-file
 [![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 和 v3.0.0包含多项破坏性变更！**
-
-如果您正在从旧版本升级，请务必查看 [CHANGELOG.md](CHANGELOG.md) 以了解详细的变更内容和迁移指南。
-
 常见问题见 [FAQ.md](FAQ.md)。
 
 ## 安装
@@ -365,14 +359,17 @@ MIJIA_LOG_LEVEL=WARNING mijiaAPI get --dev_name "卧室台灯" --prop_name "brig
 完整的命令行参数说明：
 
 ```
-usage: mijiaAPI [-h] [-p AUTH_PATH] [--list_homes] [-l] [--list_scenes] 
-                 [--list_consumable_items] [--run_scene SCENE_ID/SCENE_NAME ...] 
-                 [--get_device_info DEVICE_MODEL] [--run PROMPT] 
-                 [--wifispeaker_name WIFISPEAKER_NAME] [--quiet]
-                 {get,set} ...
+usage: mijiaAPI [-h] [-v] [-p AUTH_PATH] [--list_homes] [-l]
+                   [--list_scenes] [--list_consumable_items]
+                   [--run_scene SCENE_ID/SCENE_NAME [SCENE_ID/SCENE_NAME ...]]
+                   [--get_device_info DEVICE_MODEL]
+                   {run,get,set} ...
+
+Mijia API CLI (v3.1.0)
 
 positional arguments:
-  {get,set}
+  {run,get,set}
+    run                 使用自然语言描述你的需求，如果你有小爱音箱的话
     get                 获取设备属性
     set                 设置设备属性
 
@@ -390,10 +387,6 @@ options:
                         运行场景，指定场景ID或名称
   --get_device_info DEVICE_MODEL
                         获取设备信息，指定设备model，先使用 --list_devices 获取
-  --run PROMPT          使用自然语言描述你的需求，如果你有小爱音箱的话
-  --wifispeaker_name WIFISPEAKER_NAME
-                        指定小爱音箱名称，默认是获取到的第一个小爱音箱
-  --quiet               小爱音箱静默执行
 ```
 
 ```
@@ -423,6 +416,23 @@ options:
   --value VALUE         需要设定的属性值
 ```
 
+```
+usage: mijiaAPI run [-h] [-p AUTH_PATH]
+                       [--wifispeaker_name WIFISPEAKER_NAME] [--quiet]
+                       PROMPT
+
+positional arguments:
+  PROMPT                使用自然语言描述你的需求
+
+options:
+  -h, --help            show this help message and exit
+  -p, --auth_path AUTH_PATH
+                        认证文件保存路径，默认保存在 ~/.config/mijia-api/auth.json
+  --wifispeaker_name WIFISPEAKER_NAME
+                        指定小爱音箱名称，默认是获取到的第一个小爱音箱
+  --quiet               小爱音箱静默执行
+```
+
 #### 获取设备属性
 
 ```bash
@@ -471,9 +481,9 @@ mijiaAPI --get_device_info yeelink.light.lamp4
 mijiaAPI --list_consumable_items
 
 # 使用小爱音箱执行自然语言命令
-mijiaAPI --run "打开卧室台灯"
-mijiaAPI --run "把亮度调到50%" --wifispeaker_name "卧室小爱"
-mijiaAPI --run "关闭所有灯" --quiet
+mijiaAPI run "打开卧室台灯"
+mijiaAPI run "把亮度调到50%" --wifispeaker_name "卧室小爱"
+mijiaAPI run "关闭所有灯" --quiet
 ```
 
 #### 直接使用 uvx（无需安装）

{mijiaapi-3.0.5 → mijiaapi-3.2.0}/README.md

@@ -6,12 +6,6 @@
 [![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 和 v3.0.0包含多项破坏性变更！**
-
-如果您正在从旧版本升级，请务必查看 [CHANGELOG.md](CHANGELOG.md) 以了解详细的变更内容和迁移指南。
-
 常见问题见 [FAQ.md](FAQ.md)。
 
 ## 安装
@@ -345,14 +339,17 @@ MIJIA_LOG_LEVEL=WARNING mijiaAPI get --dev_name "卧室台灯" --prop_name "brig
 完整的命令行参数说明：
 
 ```
-usage: mijiaAPI [-h] [-p AUTH_PATH] [--list_homes] [-l] [--list_scenes] 
-                 [--list_consumable_items] [--run_scene SCENE_ID/SCENE_NAME ...] 
-                 [--get_device_info DEVICE_MODEL] [--run PROMPT] 
-                 [--wifispeaker_name WIFISPEAKER_NAME] [--quiet]
-                 {get,set} ...
+usage: mijiaAPI [-h] [-v] [-p AUTH_PATH] [--list_homes] [-l]
+                   [--list_scenes] [--list_consumable_items]
+                   [--run_scene SCENE_ID/SCENE_NAME [SCENE_ID/SCENE_NAME ...]]
+                   [--get_device_info DEVICE_MODEL]
+                   {run,get,set} ...
+
+Mijia API CLI (v3.1.0)
 
 positional arguments:
-  {get,set}
+  {run,get,set}
+    run                 使用自然语言描述你的需求，如果你有小爱音箱的话
     get                 获取设备属性
     set                 设置设备属性
 
@@ -370,10 +367,6 @@ options:
                         运行场景，指定场景ID或名称
   --get_device_info DEVICE_MODEL
                         获取设备信息，指定设备model，先使用 --list_devices 获取
-  --run PROMPT          使用自然语言描述你的需求，如果你有小爱音箱的话
-  --wifispeaker_name WIFISPEAKER_NAME
-                        指定小爱音箱名称，默认是获取到的第一个小爱音箱
-  --quiet               小爱音箱静默执行
 ```
 
 ```
@@ -403,6 +396,23 @@ options:
   --value VALUE         需要设定的属性值
 ```
 
+```
+usage: mijiaAPI run [-h] [-p AUTH_PATH]
+                       [--wifispeaker_name WIFISPEAKER_NAME] [--quiet]
+                       PROMPT
+
+positional arguments:
+  PROMPT                使用自然语言描述你的需求
+
+options:
+  -h, --help            show this help message and exit
+  -p, --auth_path AUTH_PATH
+                        认证文件保存路径，默认保存在 ~/.config/mijia-api/auth.json
+  --wifispeaker_name WIFISPEAKER_NAME
+                        指定小爱音箱名称，默认是获取到的第一个小爱音箱
+  --quiet               小爱音箱静默执行
+```
+
 #### 获取设备属性
 
 ```bash
@@ -451,9 +461,9 @@ mijiaAPI --get_device_info yeelink.light.lamp4
 mijiaAPI --list_consumable_items
 
 # 使用小爱音箱执行自然语言命令
-mijiaAPI --run "打开卧室台灯"
-mijiaAPI --run "把亮度调到50%" --wifispeaker_name "卧室小爱"
-mijiaAPI --run "关闭所有灯" --quiet
+mijiaAPI run "打开卧室台灯"
+mijiaAPI run "把亮度调到50%" --wifispeaker_name "卧室小爱"
+mijiaAPI run "关闭所有灯" --quiet
 ```
 
 #### 直接使用 uvx（无需安装）

{mijiaapi-3.0.5 → mijiaapi-3.2.0}/mijiaAPI/__main__.py

@@ -69,16 +69,36 @@ def parse_args(args):
     parser.add_argument(
         '--run',
         type=str,
+        help=argparse.SUPPRESS,
+        nargs='?',
+        default=None,
+        metavar='PROMPT',
+    )
+
+    run = subparsers.add_parser(
+        'run',
         help="使用自然语言描述你的需求，如果你有小爱音箱的话",
+    )
+    run.set_defaults(func='run')
+    run.add_argument(
+        '-p', '--auth_path',
+        type=Path,
+        default=Path.home() / ".config" / "mijia-api" / "auth.json",
+        help="认证文件保存路径，默认保存在 ~/.config/mijia-api/auth.json",
+    )
+    run.add_argument(
+        'prompt',
+        type=str,
+        help="使用自然语言描述你的需求",
         metavar='PROMPT',
     )
-    parser.add_argument(
+    run.add_argument(
         '--wifispeaker_name',
         type=str,
         help="指定小爱音箱名称，默认是获取到的第一个小爱音箱",
         default=None,
     )
-    parser.add_argument(
+    run.add_argument(
         '--quiet',
         action='store_true',
         help="小爱音箱静默执行",
@@ -265,8 +285,7 @@ def get(args):
     api = init_api(args.auth_path)
     device = mijiaDevice(api, did=args.did, dev_name=args.dev_name)
     value = device.get(args.prop_name)
-    unit = device.prop_list[args.prop_name].unit
-    print(f"{device.name} ({device.did}) 的 {args.prop_name} 值为 {value} {unit if unit else ''}")
+    print(f"{device.name} ({device.did}) 的 {args.prop_name} 值为 {value}")
 
 def set(args):
     api = init_api(args.auth_path)
@@ -276,12 +295,16 @@ def set(args):
     except Exception as e:
         print(f"设置 {args.dev_name} 的 {args.prop_name} 值为 {args.value} 失败: {e}")
         return
-    unit = device.prop_list[args.prop_name].unit
-    print(f"{device.name} ({device.did}) 的 {args.prop_name} 值已设置为 {args.value} {unit if unit else ''}")
+    print(f"{device.name} ({device.did}) 的 {args.prop_name} 值已设置为 {args.value}")
 
 def main(args):
     args = parse_args(args)
 
+    if args.run is not None:
+        print("错误: '--run' 参数已弃用，请使用 'run' 子命令代替。")
+        print(f"新用法: mijiaAPI run \"{args.run}\"")
+        sys.exit(1)
+
     if args.get_device_info:
         device_info = get_device_info(args.get_device_info)
         print(json.dumps(device_info, indent=2, ensure_ascii=False))
@@ -290,7 +313,6 @@ def main(args):
             args.list_scenes or
             args.list_consumable_items or
             args.run_scene or
-            args.run or
             hasattr(args, 'func') and args.func is not None):
         return
 
@@ -310,25 +332,25 @@ def main(args):
     if args.run_scene:
         for scene_id in args.run_scene:
             run_scene(api, scene_id, scene_mapping=scenes_mapping)
-    if args.run:
-        if device_mapping is None:
-            device_mapping = get_devices_list(api, verbose=False)
-        if args.wifispeaker_name is None:
-            wifispeaker = None
-            for device in device_mapping.values():
-                if 'xiaomi.wifispeaker' in device['model']:
-                    wifispeaker = mijiaDevice(api, dev_name=device['name'])
-                    break
-            if wifispeaker is None:
-                raise ValueError("未找到小爱音箱设备")
-        else:
-            wifispeaker = mijiaDevice(api, dev_name=args.wifispeaker_name)
-        wifispeaker.run_action('execute-text-directive', _in=[args.run, args.quiet])
     if hasattr(args, 'func') and args.func is not None:
         if args.func == 'get':
             get(args)
         if args.func == 'set':
             set(args)
+        if args.func == 'run':
+            if device_mapping is None:
+                device_mapping = get_devices_list(api, verbose=False)
+            if args.wifispeaker_name is None:
+                wifispeaker = None
+                for device in device_mapping.values():
+                    if 'xiaomi.wifispeaker' in device['model']:
+                        wifispeaker = mijiaDevice(api, dev_name=device['name'])
+                        break
+                if wifispeaker is None:
+                    raise ValueError("未找到小爱音箱设备")
+            else:
+                wifispeaker = mijiaDevice(api, dev_name=args.wifispeaker_name)
+            wifispeaker.run_action('execute-text-directive', _in=[args.prompt, 1 if args.quiet else 0])
 
 def cli():
     main(sys.argv[1:])

{mijiaapi-3.0.5 → mijiaapi-3.2.0}/mijiaAPI/devices.py

@@ -30,7 +30,6 @@ class DevProp():
         if self.type not in ["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"]
         self.value_list = prop_dict.get("value-list", None)
         self.method = prop_dict["method"]
@@ -38,7 +37,7 @@ class DevProp():
     def __str__(self):
         lines = [
             f"  {self.name}: {self.desc}",
-            f"    valuetype: {self.type}, rw: {self.rw}, unit: {self.unit}, range: {self.range}"
+            f"    valuetype: {self.type}, rw: {self.rw}, range: {self.range}"
         ]
 
         if self.value_list:
@@ -260,7 +259,6 @@ def get_device_info(device_model: str, cache_path: Optional[Union[str, Path]] =
                 - description (str): 属性描述
                 - type (str): 属性数据类型（int、uint、float、bool、string）
                 - rw (str): 读写权限（'r' 可读，'w' 可写，'rw' 可读写）
-                - unit (str): 属性单位
                 - range (list): 属性值范围 [min, max, step]
                 - value-list (list): 枚举值列表
                 - method (dict): API 调用方法参数
@@ -288,72 +286,84 @@ def get_device_info(device_model: str, cache_path: Optional[Union[str, Path]] =
     })
     if response.status_code != 200:
         raise GetDeviceInfoError(device_model)
-    content = re.search(r"data-page=\"(.*?)\">", response.text)
+    content = re.search(r"<script data-page=\"app\" type=\"application/json\">(.*?)</script>", response.text)
     if content is None:
         raise GetDeviceInfoError(device_model)
     content = content.group(1)
-    content = json.loads(content.replace("&quot;", "\""))
-
-    if content["props"]["product"]:
-        name = content["props"]["product"]["name"]
-        model = content["props"]["product"]["model"]
-    else:
-        name = content["props"]["spec"]["name"]
-        model = device_model
+    content = json.loads(content)
+
+    product = content["props"]["product"]
+    name = product["name"]
+    model = product["model"]
+    i18n_zh = content["props"]["i18n"]["zh_cn"]
     result = {
         "name": name,
         "model": model,
         "properties": [],
         "actions": []
     }
-    services = content["props"]["spec"]["services"]
+    services = content["props"]["tree"]["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": f"{prop.get('description', '')} / {prop.get('desc_zh_cn', '')}",
-                    "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)
-                    }
+    for svc in services:
+        siid = svc["iid"]
+        svc_type = svc["type"]
+        for prop in svc.get("properties", []):
+            piid = prop["iid"]
+            if prop["format"].startswith("int"):
+                prop_type = "int"
+            elif prop["format"].startswith("uint"):
+                prop_type = "uint"
+            else:
+                prop_type = prop["format"]
+            access_str = "".join([
+                "r" if "read" in prop["access"] else "",
+                "w" if "write" in prop["access"] else ""
+            ])
+            zh_cn = i18n_zh.get(f"service:{siid:03d}:property:{piid:03d}", "")
+            item = {
+                "name": prop["type"],
+                "description": f"{prop['description']} / {zh_cn}".rstrip(" / "),
+                "type": prop_type,
+                "rw": access_str,
+                "range": prop.get("valueRange", None),
+                "value-list": None,
+                "method": {
+                    "siid": siid,
+                    "piid": 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": f"{act.get('description', '')} / {act.get('desc_zh_cn', '')}",
-                    "method": {
-                        "siid": int(siid),
-                        "aiid": int(aiid)
+            }
+            if prop.get("valueList"):
+                item["value-list"] = []
+                for vl_item in prop["valueList"]:
+                    vl_zh = i18n_zh.get(vl_item.get("i18nKey", ""), "")
+                    vl_entry = {
+                        "value": vl_item["value"],
+                        "description": vl_item["description"]
                     }
-                })
+                    if vl_zh:
+                        vl_entry["desc_zh_cn"] = vl_zh
+                    item["value-list"].append(vl_entry)
+            if item["name"] in properties_name:
+                item["name"] = f"{svc_type}-{item['name']}"
+            properties_name.append(item["name"])
+            result["properties"].append(item)
+        for act in svc.get("actions", []):
+            aiid = act["iid"]
+            zh_cn = i18n_zh.get(f"service:{siid:03d}:action:{aiid:03d}", "")
+            act_item = {
+                "name": act["type"],
+                "description": f"{act['description']} / {zh_cn}".rstrip(" / "),
+                "method": {
+                    "siid": siid,
+                    "aiid": aiid
+                }
+            }
+            if act_item["name"] in actions_name:
+                act_item["name"] = f"{svc_type}-{act_item['name']}"
+            actions_name.append(act_item["name"])
+            result["actions"].append(act_item)
 
     if cache_path is not None:
         cache_path = Path(cache_path)

mijiaapi-3.2.0/mijiaAPI/version.py

@@ -0,0 +1 @@
+version = "3.2.0"

{mijiaapi-3.0.5 → mijiaapi-3.2.0}/mijiaAPI.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mijiaAPI
-Version: 3.0.5
+Version: 3.2.0
 Summary: A Python API for Xiaomi Mijia
 Author-email: Do1e <i@do1e.cn>
 License-Expression: GPL-3.0-or-later
@@ -26,12 +26,6 @@ Dynamic: license-file
 [![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 和 v3.0.0包含多项破坏性变更！**
-
-如果您正在从旧版本升级，请务必查看 [CHANGELOG.md](CHANGELOG.md) 以了解详细的变更内容和迁移指南。
-
 常见问题见 [FAQ.md](FAQ.md)。
 
 ## 安装
@@ -365,14 +359,17 @@ MIJIA_LOG_LEVEL=WARNING mijiaAPI get --dev_name "卧室台灯" --prop_name "brig
 完整的命令行参数说明：
 
 ```
-usage: mijiaAPI [-h] [-p AUTH_PATH] [--list_homes] [-l] [--list_scenes] 
-                 [--list_consumable_items] [--run_scene SCENE_ID/SCENE_NAME ...] 
-                 [--get_device_info DEVICE_MODEL] [--run PROMPT] 
-                 [--wifispeaker_name WIFISPEAKER_NAME] [--quiet]
-                 {get,set} ...
+usage: mijiaAPI [-h] [-v] [-p AUTH_PATH] [--list_homes] [-l]
+                   [--list_scenes] [--list_consumable_items]
+                   [--run_scene SCENE_ID/SCENE_NAME [SCENE_ID/SCENE_NAME ...]]
+                   [--get_device_info DEVICE_MODEL]
+                   {run,get,set} ...
+
+Mijia API CLI (v3.1.0)
 
 positional arguments:
-  {get,set}
+  {run,get,set}
+    run                 使用自然语言描述你的需求，如果你有小爱音箱的话
     get                 获取设备属性
     set                 设置设备属性
 
@@ -390,10 +387,6 @@ options:
                         运行场景，指定场景ID或名称
   --get_device_info DEVICE_MODEL
                         获取设备信息，指定设备model，先使用 --list_devices 获取
-  --run PROMPT          使用自然语言描述你的需求，如果你有小爱音箱的话
-  --wifispeaker_name WIFISPEAKER_NAME
-                        指定小爱音箱名称，默认是获取到的第一个小爱音箱
-  --quiet               小爱音箱静默执行
 ```
 
 ```
@@ -423,6 +416,23 @@ options:
   --value VALUE         需要设定的属性值
 ```
 
+```
+usage: mijiaAPI run [-h] [-p AUTH_PATH]
+                       [--wifispeaker_name WIFISPEAKER_NAME] [--quiet]
+                       PROMPT
+
+positional arguments:
+  PROMPT                使用自然语言描述你的需求
+
+options:
+  -h, --help            show this help message and exit
+  -p, --auth_path AUTH_PATH
+                        认证文件保存路径，默认保存在 ~/.config/mijia-api/auth.json
+  --wifispeaker_name WIFISPEAKER_NAME
+                        指定小爱音箱名称，默认是获取到的第一个小爱音箱
+  --quiet               小爱音箱静默执行
+```
+
 #### 获取设备属性
 
 ```bash
@@ -471,9 +481,9 @@ mijiaAPI --get_device_info yeelink.light.lamp4
 mijiaAPI --list_consumable_items
 
 # 使用小爱音箱执行自然语言命令
-mijiaAPI --run "打开卧室台灯"
-mijiaAPI --run "把亮度调到50%" --wifispeaker_name "卧室小爱"
-mijiaAPI --run "关闭所有灯" --quiet
+mijiaAPI run "打开卧室台灯"
+mijiaAPI run "把亮度调到50%" --wifispeaker_name "卧室小爱"
+mijiaAPI run "关闭所有灯" --quiet
 ```
 
 #### 直接使用 uvx（无需安装）

mijiaapi-3.0.5/mijiaAPI/version.py

@@ -1 +0,0 @@
-version = "3.0.5"