mijiaAPI 1.3.13__tar.gz → 1.4.0__tar.gz

mijiaapi-1.4.0/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.3
+Name: mijiaAPI
+Version: 1.4.0
+Summary: A Python API for Xiaomi Mijia
+License: GPLv3
+Author: Do1e
+Author-email: dpj.email@qq.com
+Requires-Python: >=3.9,<4.0
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: pillow (>=11.0.0,<12.0.0)
+Requires-Dist: qrcode (>=8.0,<9.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Project-URL: Homepage, https://github.com/Do1e/mijia-api
+Project-URL: Repository, https://github.com/Do1e/mijia-api
+Description-Content-Type: text/markdown
+
+# mijiaAPI
+
+小米米家设备的API，可以使用代码直接控制米家设备。
+
+[![GitHub](https://img.shields.io/badge/GitHub-Do1e%2Fmijia--api-blue)](https://github.com/Do1e/mijia-api)
+[![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)
+
+## 安装
+
+### 从 PyPI 安装（推荐）
+
+```bash
+pip install mijiaAPI
+```
+
+### 从源码安装
+
+```bash
+git clone https://github.com/Do1e/mijia-api.git
+cd mijia-api
+pip install .
+# Or `pip install -e .` for editable mode
+```
+
+或者使用 poetry：
+
+```bash
+poetry install
+```
+
+## 使用
+
+使用实例可以参考 `demos` 文件夹下的示例代码，以下是基本使用说明。
+
+### 登录
+
+`mijiaLogin`：登录小米账号，获取控制设备必须的 `userId`, `ssecurity`, `deviceId`, `serviceToken` 等信息。
+
+#### 登录方法：
+
+* `QRlogin() -> dict`：扫描二维码登录（推荐）
+  - 在支持 tty 的终端直接显示二维码
+  - 或在当前目录查看生成的 `qr.png` 文件
+  
+* `login(username: str, password: str) -> dict`：账号密码登录
+  - **注意：此方法大概率需要手机验证码验证，建议优先使用二维码登录**
+
+
+### API
+
+`mijiaAPI`：核心API实现，使用 `mijiaLogin` 登录后返回的信息进行初始化。
+
+#### 初始化与状态检查：
+
+* `__init__(auth_data: dict)`：初始化 API 对象
+  - `auth_data` 必须包含 `userId`, `deviceId`, `ssecurity`, `serviceToken` 四个字段
+
+* `available -> bool`：检查传入的 `auth_data` 是否有效，根据 `auth_data` 中的 `expireTime` 字段判断
+
+#### 设备与场景获取与控制：
+
+* `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_devices_prop(data: list) -> list`：获取设备属性
+* `set_devices_prop(data: list) -> list`：设置设备属性
+* `run_action(data: dict) -> dict`：执行设备的特定动作
+
+设备属性和动作的相关参数（`siid`, `piid`, `aiid`）可以从 [米家产品库](https://home.miot-spec.com) 查询：
+* 访问 `https://home.miot-spec.com/spec/{model}`（`model` 在设备列表中获取）
+* 例如：[米家台灯 1S](https://home.miot-spec.com/spec/yeelink.light.lamp4)
+
+**注意**：并非所有米家产品库中列出的方法都可用，需要自行测试验证。
+
+### 设备信息获取
+
+使用 `get_device_info()` 函数可从米家规格平台在线获取设备属性字典：
+
+```python
+from mijiaAPI import get_device_info
+
+# 获取设备规格信息
+device_info = get_device_info('yeelink.light.lamp4')  # 米家台灯 1S 的 model
+```
+
+详细示例：[demos/test_get_device_info.py](demos/test_get_device_info.py)
+
+### 设备控制封装
+
+`mijiaDevices`：基于 `mijiaAPI` 的高级封装，提供更简便的设备控制方式。
+
+#### 初始化：
+
+```python
+mijiaDevices(api: mijiaAPI, dev_info: dict = None, dev_name: str = None, did: str = None, sleep_time: float = 0.5)
+```
+
+* `api`：已初始化的 `mijiaAPI` 对象
+* `dev_info`：设备属性字典（可选）
+  - 可通过 `get_device_info()` 函数获取
+  - **注意**：如果提供了 `dev_info`，则不需要提供 `dev_name`
+* `dev_name`：设备名称，用于自动查找设备（可选）
+  - 例如：`dev_name='台灯'`，会自动查找名称包含“台灯”的设备
+  - **注意**：如果提供了 `dev_name`，则不需要提供 `dev_info` 和 `did`
+* `did`：设备ID，便于直接通过属性名访问（可选）
+  - 如果初始化时未提供，无法使用属性样式访问，需要使用 `get()` 和 `set()` 方法指定 `did`
+  - 使用 `dev_name` 初始化时，`did` 会自动获取
+* `sleep_time`：属性操作间隔时间，单位秒（默认0.5秒）
+  - **重要**：设置属性后立即获取可能不符合预期，需设置适当延迟
+
+#### 使用方法控制：
+
+* `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`：执行设备动作
+
+#### 属性样式访问：
+
+需在初始化时提供 `did` 或者使用 `dev_name` 初始化
+
+```python
+# 示例：控制台灯
+device = mijiaDevices(api, dev_name='台灯')
+device.on = True                 # 打开灯
+device.brightness = 60           # 设置亮度
+current_temp = device.color_temperature  # 获取色温
+```
+
+属性名规则：使用下划线替代连字符（如 `color-temperature` 变为 `color_temperature`）
+
+#### 示例：
+
+* 使用自然语言让小爱音箱执行：[demos/test_devices_wifispeaker.py](demos/test_devices_wifispeaker.py)
+* 通过属性直接控制台灯：[demos/test_devices_v2_light.py](demos/test_devices_v2_light.py)
+
+### Mijia API CLI
+`mijiaAPI` 还提供了一个命令行工具，可以直接在终端中使用。
+
+```
+> 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} ...
+
+Mijia API CLI
+
+positional arguments:
+  {get,set}
+    get                 获取设备属性
+    set                 设置设备属性
+
+options:
+  -h, --help            show this help message and exit
+  -p AUTH_PATH, --auth_path AUTH_PATH
+                        认证文件保存路径，默认保存在~/.config/mijia-api-auth.json
+  -l, --list_devices    列出所有米家设备
+  --list_homes          列出家庭列表
+  --list_scenes         列出场景列表
+  --list_consumable_items
+                        列出耗材列表
+  --run_scene SCENE_ID/SCENE_NAME [SCENE_ID/SCENE_NAME ...]
+                        运行场景，指定场景ID或名称
+  --get_device_info DEVICE_MODEL
+                        获取设备信息，指定设备model，先使用 --list_devices 获取
+```
+
+```
+> python -m mijiaAPI get --help
+> mijiaAPI get --help
+usage: __main__.py get [-h] [-p AUTH_PATH] --dev_name DEV_NAME --prop_name PROP_NAME
+
+options:
+  -h, --help            show this help message and exit
+  -p AUTH_PATH, --auth_path AUTH_PATH
+                        认证文件保存路径，默认保存在~/.config/mijia-api-auth.json
+  --dev_name DEV_NAME   设备名称，指定为米家APP中设定的名称
+  --prop_name PROP_NAME
+                        属性名称，先使用 --get_device_info 获取
+```
+
+```
+> python -m mijiaAPI set --help
+> mijiaAPI set --help
+usage: __main__.py set [-h] [-p AUTH_PATH] --dev_name DEV_NAME --prop_name PROP_NAME --value VALUE
+
+options:
+  -h, --help            show this help message and exit
+  -p AUTH_PATH, --auth_path AUTH_PATH
+                        认证文件保存路径，默认保存在~/.config/mijia-api-auth.json
+  --dev_name DEV_NAME   设备名称，指定为米家APP中设定的名称
+  --prop_name PROP_NAME
+                        属性名称，先使用 --get_device_info 获取
+  --value VALUE         需要设定的属性值
+```
+
+## 致谢
+
+* [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)
+
+## 开源许可
+
+本项目采用 [GPL-3.0](LICENSE) 开源许可证。
+
+## 免责声明
+
+* 本项目仅供学习交流使用，不得用于商业用途，如有侵权请联系删除
+* 用户使用本项目所产生的任何后果，需自行承担风险
+* 开发者不对使用本项目产生的任何直接或间接损失负责
+

mijiaapi-1.4.0/README.md

@@ -0,0 +1,213 @@
+# mijiaAPI
+
+小米米家设备的API，可以使用代码直接控制米家设备。
+
+[![GitHub](https://img.shields.io/badge/GitHub-Do1e%2Fmijia--api-blue)](https://github.com/Do1e/mijia-api)
+[![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)
+
+## 安装
+
+### 从 PyPI 安装（推荐）
+
+```bash
+pip install mijiaAPI
+```
+
+### 从源码安装
+
+```bash
+git clone https://github.com/Do1e/mijia-api.git
+cd mijia-api
+pip install .
+# Or `pip install -e .` for editable mode
+```
+
+或者使用 poetry：
+
+```bash
+poetry install
+```
+
+## 使用
+
+使用实例可以参考 `demos` 文件夹下的示例代码，以下是基本使用说明。
+
+### 登录
+
+`mijiaLogin`：登录小米账号，获取控制设备必须的 `userId`, `ssecurity`, `deviceId`, `serviceToken` 等信息。
+
+#### 登录方法：
+
+* `QRlogin() -> dict`：扫描二维码登录（推荐）
+  - 在支持 tty 的终端直接显示二维码
+  - 或在当前目录查看生成的 `qr.png` 文件
+  
+* `login(username: str, password: str) -> dict`：账号密码登录
+  - **注意：此方法大概率需要手机验证码验证，建议优先使用二维码登录**
+
+
+### API
+
+`mijiaAPI`：核心API实现，使用 `mijiaLogin` 登录后返回的信息进行初始化。
+
+#### 初始化与状态检查：
+
+* `__init__(auth_data: dict)`：初始化 API 对象
+  - `auth_data` 必须包含 `userId`, `deviceId`, `ssecurity`, `serviceToken` 四个字段
+
+* `available -> bool`：检查传入的 `auth_data` 是否有效，根据 `auth_data` 中的 `expireTime` 字段判断
+
+#### 设备与场景获取与控制：
+
+* `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_devices_prop(data: list) -> list`：获取设备属性
+* `set_devices_prop(data: list) -> list`：设置设备属性
+* `run_action(data: dict) -> dict`：执行设备的特定动作
+
+设备属性和动作的相关参数（`siid`, `piid`, `aiid`）可以从 [米家产品库](https://home.miot-spec.com) 查询：
+* 访问 `https://home.miot-spec.com/spec/{model}`（`model` 在设备列表中获取）
+* 例如：[米家台灯 1S](https://home.miot-spec.com/spec/yeelink.light.lamp4)
+
+**注意**：并非所有米家产品库中列出的方法都可用，需要自行测试验证。
+
+### 设备信息获取
+
+使用 `get_device_info()` 函数可从米家规格平台在线获取设备属性字典：
+
+```python
+from mijiaAPI import get_device_info
+
+# 获取设备规格信息
+device_info = get_device_info('yeelink.light.lamp4')  # 米家台灯 1S 的 model
+```
+
+详细示例：[demos/test_get_device_info.py](demos/test_get_device_info.py)
+
+### 设备控制封装
+
+`mijiaDevices`：基于 `mijiaAPI` 的高级封装，提供更简便的设备控制方式。
+
+#### 初始化：
+
+```python
+mijiaDevices(api: mijiaAPI, dev_info: dict = None, dev_name: str = None, did: str = None, sleep_time: float = 0.5)
+```
+
+* `api`：已初始化的 `mijiaAPI` 对象
+* `dev_info`：设备属性字典（可选）
+  - 可通过 `get_device_info()` 函数获取
+  - **注意**：如果提供了 `dev_info`，则不需要提供 `dev_name`
+* `dev_name`：设备名称，用于自动查找设备（可选）
+  - 例如：`dev_name='台灯'`，会自动查找名称包含“台灯”的设备
+  - **注意**：如果提供了 `dev_name`，则不需要提供 `dev_info` 和 `did`
+* `did`：设备ID，便于直接通过属性名访问（可选）
+  - 如果初始化时未提供，无法使用属性样式访问，需要使用 `get()` 和 `set()` 方法指定 `did`
+  - 使用 `dev_name` 初始化时，`did` 会自动获取
+* `sleep_time`：属性操作间隔时间，单位秒（默认0.5秒）
+  - **重要**：设置属性后立即获取可能不符合预期，需设置适当延迟
+
+#### 使用方法控制：
+
+* `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`：执行设备动作
+
+#### 属性样式访问：
+
+需在初始化时提供 `did` 或者使用 `dev_name` 初始化
+
+```python
+# 示例：控制台灯
+device = mijiaDevices(api, dev_name='台灯')
+device.on = True                 # 打开灯
+device.brightness = 60           # 设置亮度
+current_temp = device.color_temperature  # 获取色温
+```
+
+属性名规则：使用下划线替代连字符（如 `color-temperature` 变为 `color_temperature`）
+
+#### 示例：
+
+* 使用自然语言让小爱音箱执行：[demos/test_devices_wifispeaker.py](demos/test_devices_wifispeaker.py)
+* 通过属性直接控制台灯：[demos/test_devices_v2_light.py](demos/test_devices_v2_light.py)
+
+### Mijia API CLI
+`mijiaAPI` 还提供了一个命令行工具，可以直接在终端中使用。
+
+```
+> 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} ...
+
+Mijia API CLI
+
+positional arguments:
+  {get,set}
+    get                 获取设备属性
+    set                 设置设备属性
+
+options:
+  -h, --help            show this help message and exit
+  -p AUTH_PATH, --auth_path AUTH_PATH
+                        认证文件保存路径，默认保存在~/.config/mijia-api-auth.json
+  -l, --list_devices    列出所有米家设备
+  --list_homes          列出家庭列表
+  --list_scenes         列出场景列表
+  --list_consumable_items
+                        列出耗材列表
+  --run_scene SCENE_ID/SCENE_NAME [SCENE_ID/SCENE_NAME ...]
+                        运行场景，指定场景ID或名称
+  --get_device_info DEVICE_MODEL
+                        获取设备信息，指定设备model，先使用 --list_devices 获取
+```
+
+```
+> python -m mijiaAPI get --help
+> mijiaAPI get --help
+usage: __main__.py get [-h] [-p AUTH_PATH] --dev_name DEV_NAME --prop_name PROP_NAME
+
+options:
+  -h, --help            show this help message and exit
+  -p AUTH_PATH, --auth_path AUTH_PATH
+                        认证文件保存路径，默认保存在~/.config/mijia-api-auth.json
+  --dev_name DEV_NAME   设备名称，指定为米家APP中设定的名称
+  --prop_name PROP_NAME
+                        属性名称，先使用 --get_device_info 获取
+```
+
+```
+> python -m mijiaAPI set --help
+> mijiaAPI set --help
+usage: __main__.py set [-h] [-p AUTH_PATH] --dev_name DEV_NAME --prop_name PROP_NAME --value VALUE
+
+options:
+  -h, --help            show this help message and exit
+  -p AUTH_PATH, --auth_path AUTH_PATH
+                        认证文件保存路径，默认保存在~/.config/mijia-api-auth.json
+  --dev_name DEV_NAME   设备名称，指定为米家APP中设定的名称
+  --prop_name PROP_NAME
+                        属性名称，先使用 --get_device_info 获取
+  --value VALUE         需要设定的属性值
+```
+
+## 致谢
+
+* [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)
+
+## 开源许可
+
+本项目采用 [GPL-3.0](LICENSE) 开源许可证。
+
+## 免责声明
+
+* 本项目仅供学习交流使用，不得用于商业用途，如有侵权请联系删除
+* 用户使用本项目所产生的任何后果，需自行承担风险
+* 开发者不对使用本项目产生的任何直接或间接损失负责

mijiaapi-1.4.0/mijiaAPI/__main__.py

@@ -0,0 +1,286 @@
+from typing import Optional
+import argparse
+import json
+import os
+import sys
+import time
+
+from .apis import mijiaAPI
+from .devices import mijiaDevices, get_device_info
+from .login import mijiaLogin
+
+def parse_args(args):
+    parser = argparse.ArgumentParser(description="Mijia API CLI")
+    subparsers = parser.add_subparsers(dest='command')
+    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",
+    )
+    parser.add_argument(
+        '-l', '--list_devices',
+        action='store_true',
+        help="列出所有米家设备",
+    )
+    parser.add_argument(
+        '--list_homes',
+        action='store_true',
+        help="列出家庭列表",
+    )
+    parser.add_argument(
+        '--list_scenes',
+        action='store_true',
+        help="列出场景列表",
+    )
+    parser.add_argument(
+        '--list_consumable_items',
+        action='store_true',
+        help="列出耗材列表",
+    )
+    parser.add_argument(
+        '--run_scene',
+        type=str,
+        help="运行场景，指定场景ID或名称",
+        nargs='+',
+        metavar='SCENE_ID/SCENE_NAME',
+    )
+    parser.add_argument(
+        '--get_device_info',
+        type=str,
+        help="获取设备信息，指定设备model，先使用 --list_devices 获取",
+        metavar='DEVICE_MODEL',
+    )
+
+    get = subparsers.add_parser(
+        'get',
+        help="获取设备属性",
+    )
+    get.set_defaults(func='get')
+    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",
+    )
+    get.add_argument(
+        '--dev_name',
+        type=str,
+        help="设备名称，指定为米家APP中设定的名称",
+        required=True,
+    )
+    get.add_argument(
+        '--prop_name',
+        type=str,
+        help="属性名称，先使用 --get_device_info 获取",
+        required=True,
+    )
+
+    set = subparsers.add_parser(
+        'set',
+        help="设置设备属性",
+    )
+    set.set_defaults(func='set')
+    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",
+    )
+    set.add_argument(
+        '--dev_name',
+        type=str,
+        help="设备名称，指定为米家APP中设定的名称",
+        required=True,
+    )
+    set.add_argument(
+        '--prop_name',
+        type=str,
+        help="属性名称，先使用 --get_device_info 获取",
+        required=True,
+    )
+    set.add_argument(
+        '--value',
+        type=str,
+        help="需要设定的属性值",
+        required=True,
+    )
+    return parser.parse_args(args)
+
+def init_api(auth_path: str) -> mijiaAPI:
+    if os.path.isdir(auth_path):
+        auth_path = os.path.join(auth_path, "mijia-api-auth.json")
+    if os.path.exists(auth_path):
+        try:
+            with open(auth_path, 'r') as f:
+                auth = json.load(f)
+            api = mijiaAPI(auth_data=auth)
+            if not api.available:
+                raise ValueError("Saved auth is no longer valid")
+        except (json.JSONDecodeError, ValueError):
+            api = mijiaLogin(save_path=auth_path)
+            auth = api.QRlogin()
+            api = mijiaAPI(auth_data=auth)
+    else:
+        api = mijiaLogin(save_path=auth_path)
+        auth = api.QRlogin()
+        api = mijiaAPI(auth_data=auth)
+    return api
+
+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:")
+        for device in devices:
+            print(f"  - {device['name']}\n"
+                    f"    did: {device['did']}\n"
+                    f"    model: {device['model']}\n"
+                    f"    online: {device['isOnline']}")
+    device_mapping = {device['did']: device for device in devices}
+    return device_mapping
+
+def get_homes_list(api: mijiaAPI, verbose: bool = True, device_mapping: Optional[dict] = None) -> dict:
+    if verbose:
+        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:")
+        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:")
+            for room in home['roomlist']:
+                devices_name = []
+                if room['dids']:
+                    for did in room['dids']:
+                        if did in device_mapping:
+                            devices_name.append(device_mapping[did]['name'])
+                        else:
+                            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']))}")
+    home_mapping = {home['id']: home for home in homes}
+    return home_mapping
+
+def get_scenes_list(api: mijiaAPI, verbose: bool = True, home_mapping: Optional[dict] = None) -> dict:
+    if home_mapping is None:
+        home_mapping = get_homes_list(api, verbose=False)
+    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}):")
+            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"    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
+
+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}):")
+        for item in items:
+            print(f"  - {item['details'][0]['description']} in {item['name']}({item['did']})\n"
+                  f"    value: {item['details'][0]['value']}")
+
+def run_scene(api: mijiaAPI, scene_id: str, scene_mapping: Optional[dict] = None) -> bool:
+    if scene_mapping is None:
+        scene_mapping = get_scenes_list(api, verbose=False)
+    if scene_id not in scene_mapping:
+        scene_name_to_find = scene_id
+        found = False
+        for sid, scene in scene_mapping.items():
+            if scene['name'] == scene_name_to_find:
+                scene_id = sid
+                found = True
+                break
+        if not found:
+            print(f"Scene {scene_name_to_find} not found")
+            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")
+        return True
+    else:
+        print(f"Failed to run scene {scene_name}({scene_id})")
+        return False
+
+def get(args):
+    api = init_api(args.auth_path)
+    device = mijiaDevices(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 ''}")
+
+def set(args):
+    api = init_api(args.auth_path)
+    device = mijiaDevices(api, dev_name=args.dev_name)
+    ret = device.set_v2(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 ''}")
+    else:
+        print(f"Failed to set the {args.prop_name} of {args.dev_name} to {args.value}")
+
+
+def main(args):
+    args = parse_args(args)
+    api = init_api(args.auth_path)
+    device_mapping = None
+    home_mapping = None
+    scenes_mapping = None
+
+    if args.list_devices:
+        device_mapping = get_devices_list(api)
+    if args.list_homes:
+        home_mapping = get_homes_list(api, device_mapping=device_mapping)
+    if args.list_scenes:
+        scenes_mapping = get_scenes_list(api, home_mapping=home_mapping)
+    if args.list_consumable_items:
+        get_consumable_items(api, home_mapping=home_mapping)
+    if args.run_scene:
+        for scene_id in args.run_scene:
+            run_scene(api, scene_id, scene_mapping=scenes_mapping)
+    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 hasattr(args, 'func') and args.func is not None:
+        if args.func == 'get':
+            get(args)
+        if args.func == 'set':
+            set(args)
+
+def cli():
+    main(sys.argv[1:])
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

{mijiaapi-1.3.13 → mijiaapi-1.4.0}/mijiaAPI/apis.py

@@ -23,6 +23,7 @@ class mijiaAPI(object):
         self.userId = auth_data['userId']
         self.ssecurity = auth_data['ssecurity']
         self.session = requests.Session()
+        self.expireTime = auth_data.get('expireTime', None)
         self.session.headers.update({
             'User-Agent': defaultUA,
             'x-xiaomi-protocal-flag-cli': 'PROTOCAL-HTTP2',
@@ -45,8 +46,8 @@ class mijiaAPI(object):
         Returns:
             bool: API可用返回True，否则返回False。
         """
-        if 'expireTime' in self.session.cookies:
-            expire_time = datetime.strptime(self.session.cookies['expireTime'], '%Y-%m-%d %H:%M:%S')
+        if self.expireTime:
+            expire_time = datetime.strptime(self.expireTime, '%Y-%m-%d %H:%M:%S')
             if expire_time < datetime.now():
                 return False
             return True

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

@@ -174,7 +174,23 @@ class mijiaDevices(object):
             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):
+            if isinstance(value, str):
+                if value.lower() == 'true':
+                    value = True
+                elif value.lower() == 'false':
+                    value = False
+                elif value in ['0', '1']:
+                    value = bool(int(value))
+                else:
+                    raise ValueError(f'Invalid value for bool: {value}, should be True or False')
+            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')
+            elif 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)

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

@@ -1,6 +1,6 @@
 [project]
 name = "mijiaAPI"
-version = "1.3.13"
+version = "1.4.0"
 description = "A Python API for Xiaomi Mijia"
 readme = "README.md"
 requires-python = ">=3.9,<4.0"
@@ -10,9 +10,12 @@ dependencies = [
     "requests>=2.32.3,<3.0.0",
 ]
 
+[project.scripts]
+mijiaAPI = "mijiaAPI.__main__:cli"
+
 [tool.poetry]
 name = "mijiaAPI"
-version = "1.3.13"
+version = "1.4.0"
 description = "A Python API for Xiaomi Mijia"
 authors = ["Do1e <dpj.email@qq.com>"]
 license = "GPLv3"
@@ -34,6 +37,9 @@ requests = "^2.32.3"
 qrcode = "^8.0"
 pillow = "^11.0.0"
 
+[tool.poetry.scripts]
+mijiaAPI = "mijiaAPI.__main__:cli"
+
 [tool.poetry-dynamic-versioning]
 enable = false
 

mijiaapi-1.3.13/PKG-INFO

@@ -1,81 +0,0 @@
-Metadata-Version: 2.3
-Name: mijiaAPI
-Version: 1.3.13
-Summary: A Python API for Xiaomi Mijia
-License: GPLv3
-Author: Do1e
-Author-email: dpj.email@qq.com
-Requires-Python: >=3.9,<4.0
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Classifier: License :: Other/Proprietary License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: pillow (>=11.0.0,<12.0.0)
-Requires-Dist: qrcode (>=8.0,<9.0)
-Requires-Dist: requests (>=2.32.3,<3.0.0)
-Project-URL: Homepage, https://github.com/Do1e/mijia-api
-Project-URL: Repository, https://github.com/Do1e/mijia-api
-Description-Content-Type: text/markdown
-
-# mijiaAPI
-小米米家设备的api，可以使用代码直接控制米家设备的功能，[Github link](https://github.com/Do1e/mijia-api)，[PyPI link](https://pypi.org/project/mijiaAPI/)。
-
-## 安装
-```bash
-poetry install
-```
-或者
-```bash
-pip install mijiaAPI
-```
-
-## 使用
-使用实例可以参考`demos`文件夹下的示例代码，以下是简单的使用说明
-
-### 登录
-
-`mijiaLogin`：登录小米账号，获取控制设备必须的`userId`, `ssecurity`, `deviceId`, `serviceToken`，方法列表：
-* `login(username: str, password: str) -> dict`：账号密码登录，返回上述信息。**注意，目前这一方法大概率遇到手机验证码，请尽可能使用`QRlogin`。**
-* `QRlogin() -> dict`：扫描二维码登录，返回上述信息（会在支持tty的终端打印二维码，若打印识别可查看当前文件夹下的`qr.png`）
-
-
-### API
-
-`mijiaAPI`：API的实现，使用`mijiaLogin`登录后返回的信息进行初始化
-* `__init__(auth_data: dict)`：初始化
-* `available -> bool`：传入的`auth_data`是否有效
-* `get_devices_list() -> list`：获取设备列表
-* `get_homes_list() -> list`：获取家庭列表，家庭字典中包含房间列表
-* `get_scenes_list(home_id: str) -> list`：获取手动场景列表，在 *米家->添加->手动控制* 中设置
-* `run_scene(scene_id: str) -> bool`：运行手动场景
-* `get_consumable_items(home_id: str) -> list`：获取设备的耗材信息
-* `get_devices_prop(data: list) -> list`：获取设备的属性
-* `set_devices_prop(data: list) -> list`：设置设备的属性
-  * `data`为一个字典的列表，字典需要包含`did`, `siid`, `piid`，后面两个键可从 *https://home.miot-spec.com/spec/{model}* 中获取，其中`model`为设备的model，在设备列表中获取，如[米家台灯 1S](https://home.miot-spec.com/spec/yeelink.light.lamp4)。
-  * 网站上的方法并非全部可用，需要自行测试
-* `run_action(data: dict) -> dict`：执行设备的action
-  * `data`为一个字典，需要包含`did`, `siid`, `aiid`，获取方法同上
-
-### 针对设备的封装
-
-最简单的使用方法是直接使用自然语言调用小爱音箱，参见[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`为每次调用设备属性的间隔时间（注：设置属性后立刻获取属性会不符合预期，需要延迟一段时间）
-* `set(name: str, did: str, value: Union[bool, int]) -> Union[bool, int]`：设置设备属性
-* `get(name: str, did: str) -> Union[bool, int]`：获取设备属性
-* v1.2.0 新增直接通过名称设置/获取属性，需要在初始化时传入`did`，详见[demos/test_devices_v2_light.py](demos/test_devices_v2_light.py)。名称中包含`-`的属性需要替换为`_`。
-* 可以调用`get_device_info(device_model: str) -> dict`函数从[米家设备列表](https://home.miot-spec.com/)在线获取设备属性字典，详见[demos/test_get_device_info.py](demos/test_get_device_info.py)
-
-## 致谢
-* [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)
-
-## 声明
-* 本项目仅供学习交流使用，不得用于商业用途，如有侵权请联系删除。
-* 本项目作者不对使用本项目产生的任何后果负责，请用户自行承担使用本项目的风险。
-

mijiaapi-1.3.13/README.md

@@ -1,56 +0,0 @@
-# mijiaAPI
-小米米家设备的api，可以使用代码直接控制米家设备的功能，[Github link](https://github.com/Do1e/mijia-api)，[PyPI link](https://pypi.org/project/mijiaAPI/)。
-
-## 安装
-```bash
-poetry install
-```
-或者
-```bash
-pip install mijiaAPI
-```
-
-## 使用
-使用实例可以参考`demos`文件夹下的示例代码，以下是简单的使用说明
-
-### 登录
-
-`mijiaLogin`：登录小米账号，获取控制设备必须的`userId`, `ssecurity`, `deviceId`, `serviceToken`，方法列表：
-* `login(username: str, password: str) -> dict`：账号密码登录，返回上述信息。**注意，目前这一方法大概率遇到手机验证码，请尽可能使用`QRlogin`。**
-* `QRlogin() -> dict`：扫描二维码登录，返回上述信息（会在支持tty的终端打印二维码，若打印识别可查看当前文件夹下的`qr.png`）
-
-
-### API
-
-`mijiaAPI`：API的实现，使用`mijiaLogin`登录后返回的信息进行初始化
-* `__init__(auth_data: dict)`：初始化
-* `available -> bool`：传入的`auth_data`是否有效
-* `get_devices_list() -> list`：获取设备列表
-* `get_homes_list() -> list`：获取家庭列表，家庭字典中包含房间列表
-* `get_scenes_list(home_id: str) -> list`：获取手动场景列表，在 *米家->添加->手动控制* 中设置
-* `run_scene(scene_id: str) -> bool`：运行手动场景
-* `get_consumable_items(home_id: str) -> list`：获取设备的耗材信息
-* `get_devices_prop(data: list) -> list`：获取设备的属性
-* `set_devices_prop(data: list) -> list`：设置设备的属性
-  * `data`为一个字典的列表，字典需要包含`did`, `siid`, `piid`，后面两个键可从 *https://home.miot-spec.com/spec/{model}* 中获取，其中`model`为设备的model，在设备列表中获取，如[米家台灯 1S](https://home.miot-spec.com/spec/yeelink.light.lamp4)。
-  * 网站上的方法并非全部可用，需要自行测试
-* `run_action(data: dict) -> dict`：执行设备的action
-  * `data`为一个字典，需要包含`did`, `siid`, `aiid`，获取方法同上
-
-### 针对设备的封装
-
-最简单的使用方法是直接使用自然语言调用小爱音箱，参见[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`为每次调用设备属性的间隔时间（注：设置属性后立刻获取属性会不符合预期，需要延迟一段时间）
-* `set(name: str, did: str, value: Union[bool, int]) -> Union[bool, int]`：设置设备属性
-* `get(name: str, did: str) -> Union[bool, int]`：获取设备属性
-* v1.2.0 新增直接通过名称设置/获取属性，需要在初始化时传入`did`，详见[demos/test_devices_v2_light.py](demos/test_devices_v2_light.py)。名称中包含`-`的属性需要替换为`_`。
-* 可以调用`get_device_info(device_model: str) -> dict`函数从[米家设备列表](https://home.miot-spec.com/)在线获取设备属性字典，详见[demos/test_get_device_info.py](demos/test_get_device_info.py)
-
-## 致谢
-* [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)
-
-## 声明
-* 本项目仅供学习交流使用，不得用于商业用途，如有侵权请联系删除。
-* 本项目作者不对使用本项目产生的任何后果负责，请用户自行承担使用本项目的风险。