mijiaAPI 1.4.0__tar.gz → 1.4.2__tar.gz

{mijiaapi-1.4.0 → mijiaapi-1.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mijiaAPI
-Version: 1.4.0
+Version: 1.4.2
 Summary: A Python API for Xiaomi Mijia
 License: GPLv3
 Author: Do1e
@@ -167,9 +167,10 @@ current_temp = device.color_temperature  # 获取色温
 ```
 > python -m mijiaAPI --help
 > mijiaAPI --help
-usage: __main__.py [-h] [-p AUTH_PATH] [-l] [--list_homes] [--list_scenes] [--list_consumable_items]
-                   [--run_scene SCENE_ID/SCENE_NAME [SCENE_ID/SCENE_NAME ...]] [--get_device_info DEVICE_MODEL]
-                   {get,set} ...
+usage: mijiaAPI [-h] [-p AUTH_PATH] [-l] [--list_homes] [--list_scenes] [--list_consumable_items]
+                [--run_scene SCENE_ID/SCENE_NAME [SCENE_ID/SCENE_NAME ...]] [--get_device_info DEVICE_MODEL] [--run PROMPT]
+                [--wifispeaker_name WIFISPEAKER_NAME] [--quiet]
+                {get,set} ...
 
 Mijia API CLI
 
@@ -191,6 +192,10 @@ options:
                         运行场景，指定场景ID或名称
   --get_device_info DEVICE_MODEL
                         获取设备信息，指定设备model，先使用 --list_devices 获取
+  --run PROMPT          使用自然语言描述你的需求，如果你有小爱音箱的话
+  --wifispeaker_name WIFISPEAKER_NAME
+                        指定小爱音箱名称，默认是获取到的第一个小爱音箱
+  --quiet               小爱音箱静默执行
 ```
 
 ```
@@ -222,6 +227,27 @@ options:
   --value VALUE         需要设定的属性值
 ```
 
+或者直接使用`uvx`忽略安装步骤：
+
+```bash
+uvx mijiaAPI --help
+```
+
+#### 示例：
+
+```bash
+mijiaAPI -l # 列出所有米家设备
+mijiaAPI --list_homes # 列出家庭列表
+mijiaAPI --list_scenes # 列出场景列表
+mijiaAPI --list_consumable_items # 列出耗材列表
+mijiaAPI --run_scene SCENE_ID/SCENE_NAME # 运行场景，指定场景ID或名称
+mijiaAPI --get_device_info DEVICE_MODEL # 获取设备信息，指定设备model，先使用 --list_devices 获取
+mijiaAPI get --dev_name DEV_NAME --prop_name PROP_NAME # 获取设备属性
+mijiaAPI set --dev_name DEV_NAME --prop_name PROP_NAME --value VALUE # 设置设备属性
+mijiaAPI --run 明天天气如何
+mijiaAPI --run 打开台灯并将亮度调至最大 --quiet
+```
+
 ## 致谢
 
 * [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)

{mijiaapi-1.4.0 → mijiaapi-1.4.2}/README.md

@@ -143,9 +143,10 @@ current_temp = device.color_temperature  # 获取色温
 ```
 > python -m mijiaAPI --help
 > mijiaAPI --help
-usage: __main__.py [-h] [-p AUTH_PATH] [-l] [--list_homes] [--list_scenes] [--list_consumable_items]
-                   [--run_scene SCENE_ID/SCENE_NAME [SCENE_ID/SCENE_NAME ...]] [--get_device_info DEVICE_MODEL]
-                   {get,set} ...
+usage: mijiaAPI [-h] [-p AUTH_PATH] [-l] [--list_homes] [--list_scenes] [--list_consumable_items]
+                [--run_scene SCENE_ID/SCENE_NAME [SCENE_ID/SCENE_NAME ...]] [--get_device_info DEVICE_MODEL] [--run PROMPT]
+                [--wifispeaker_name WIFISPEAKER_NAME] [--quiet]
+                {get,set} ...
 
 Mijia API CLI
 
@@ -167,6 +168,10 @@ options:
                         运行场景，指定场景ID或名称
   --get_device_info DEVICE_MODEL
                         获取设备信息，指定设备model，先使用 --list_devices 获取
+  --run PROMPT          使用自然语言描述你的需求，如果你有小爱音箱的话
+  --wifispeaker_name WIFISPEAKER_NAME
+                        指定小爱音箱名称，默认是获取到的第一个小爱音箱
+  --quiet               小爱音箱静默执行
 ```
 
 ```
@@ -198,6 +203,27 @@ options:
   --value VALUE         需要设定的属性值
 ```
 
+或者直接使用`uvx`忽略安装步骤：
+
+```bash
+uvx mijiaAPI --help
+```
+
+#### 示例：
+
+```bash
+mijiaAPI -l # 列出所有米家设备
+mijiaAPI --list_homes # 列出家庭列表
+mijiaAPI --list_scenes # 列出场景列表
+mijiaAPI --list_consumable_items # 列出耗材列表
+mijiaAPI --run_scene SCENE_ID/SCENE_NAME # 运行场景，指定场景ID或名称
+mijiaAPI --get_device_info DEVICE_MODEL # 获取设备信息，指定设备model，先使用 --list_devices 获取
+mijiaAPI get --dev_name DEV_NAME --prop_name PROP_NAME # 获取设备属性
+mijiaAPI set --dev_name DEV_NAME --prop_name PROP_NAME --value VALUE # 设置设备属性
+mijiaAPI --run 明天天气如何
+mijiaAPI --run 打开台灯并将亮度调至最大 --quiet
+```
+
 ## 致谢
 
 * [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)

{mijiaapi-1.4.0 → mijiaapi-1.4.2}/mijiaAPI/__main__.py

@@ -15,8 +15,8 @@ def parse_args(args):
     parser.add_argument(
         '-p', '--auth_path',
         type=str,
-        default=os.path.join(os.path.expanduser("~"), ".config", "mijia-api-auth.json"),
-        help="认证文件保存路径，默认保存在~/.config/mijia-api-auth.json",
+        default=os.path.join(os.path.expanduser("~"), ".config/mijia-api", "mijia-api-auth.json"),
+        help="认证文件保存路径，默认保存在~/.config/mijia-api/mijia-api-auth.json",
     )
     parser.add_argument(
         '-l', '--list_devices',
@@ -51,6 +51,23 @@ def parse_args(args):
         help="获取设备信息，指定设备model，先使用 --list_devices 获取",
         metavar='DEVICE_MODEL',
     )
+    parser.add_argument(
+        '--run',
+        type=str,
+        help="使用自然语言描述你的需求，如果你有小爱音箱的话",
+        metavar='PROMPT',
+    )
+    parser.add_argument(
+        '--wifispeaker_name',
+        type=str,
+        help="指定小爱音箱名称，默认是获取到的第一个小爱音箱",
+        default=None,
+    )
+    parser.add_argument(
+        '--quiet',
+        action='store_true',
+        help="小爱音箱静默执行",
+    )
 
     get = subparsers.add_parser(
         'get',
@@ -60,8 +77,8 @@ def parse_args(args):
     get.add_argument(
         '-p', '--auth_path',
         type=str,
-        default=os.path.join(os.path.expanduser("~"), ".config", "mijia-api-auth.json"),
-        help="认证文件保存路径，默认保存在~/.config/mijia-api-auth.json",
+        default=os.path.join(os.path.expanduser("~"), ".config/mijia-api", "mijia-api-auth.json"),
+        help="认证文件保存路径，默认保存在~/.config/mijia-api/mijia-api-auth.json",
     )
     get.add_argument(
         '--dev_name',
@@ -84,8 +101,8 @@ def parse_args(args):
     set.add_argument(
         '-p', '--auth_path',
         type=str,
-        default=os.path.join(os.path.expanduser("~"), ".config", "mijia-api-auth.json"),
-        help="认证文件保存路径，默认保存在~/.config/mijia-api-auth.json",
+        default=os.path.join(os.path.expanduser("~"), ".config/mijia-api", "mijia-api-auth.json"),
+        help="认证文件保存路径，默认保存在~/.config/mijia-api/mijia-api-auth.json",
     )
     set.add_argument(
         '--dev_name',
@@ -273,6 +290,20 @@ def main(args):
     if args.get_device_info:
         device_info = get_device_info(args.get_device_info)
         print(json.dumps(device_info, indent=2, ensure_ascii=False))
+    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 = mijiaDevices(api, dev_name=device['name'])
+                    break
+            if wifispeaker is None:
+                raise ValueError("No wifispeaker found")
+        else:
+            wifispeaker = mijiaDevices(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)

{mijiaapi-1.4.0 → mijiaapi-1.4.2}/mijiaAPI/devices.py

@@ -1,5 +1,6 @@
 from typing import Union, Optional
 import json
+import os
 import re
 import requests
 from time import sleep
@@ -370,12 +371,13 @@ class mijiaDevices(object):
         return result['code'] == 0
 
 
-def get_device_info(device_model: str) -> dict:
+def get_device_info(device_model: str, cache_path: Optional[str] = os.path.join(os.path.expanduser("~"), ".config/mijia-api")) -> dict:
     """
     获取设备信息，用于初始化mijiaDevices对象。
 
     Args:
         device_model (str): 设备型号，从get_devices_list获取。
+        cache_path (str, optional): 缓存文件路径。默认为~/.config/mijia-api，设置为None则不使用缓存。
 
     Returns:
         dict: 设备信息字典。
@@ -383,6 +385,11 @@ def get_device_info(device_model: str) -> dict:
     Raises:
         RuntimeError: 如果获取设备信息失败。
     """
+    if cache_path is not None:
+        cache_file = os.path.join(cache_path, f'{device_model}.json')
+        if os.path.exists(cache_file):
+            with open(cache_file, 'r', encoding='utf-8') as f:
+                return json.load(f)
     response = requests.get(deviceURL + device_model)
     if response.status_code != 200:
         raise RuntimeError(f'Failed to get device info')
@@ -446,4 +453,9 @@ def get_device_info(device_model: str) -> dict:
                         'aiid': int(aiid)
                     }
                 })
+    if cache_path is not None:
+        cache_file = os.path.join(cache_path, f'{device_model}.json')
+        os.makedirs(cache_path, exist_ok=True)
+        with open(cache_file, 'w', encoding='utf-8') as f:
+            json.dump(result, f, indent=2, ensure_ascii=False)
     return result

{mijiaapi-1.4.0 → mijiaapi-1.4.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mijiaAPI"
-version = "1.4.0"
+version = "1.4.2"
 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.4.0"
+version = "1.4.2"
 description = "A Python API for Xiaomi Mijia"
 authors = ["Do1e <dpj.email@qq.com>"]
 license = "GPLv3"