Skip to content

CLI 参数参考 ​

安装 ​

从 uv 安装(推荐) ​

使用 uv 以独立工具方式安装,无需管理虚拟环境,mijiaAPI 命令全局可用:

bash
uv tool install mijiaAPI

AUR(Arch User Repository) ​

如果你使用 Arch Linux 或基于 Arch 的发行版,可以通过 AUR 安装:

bash
yay -S python-mijia-api

主命令 ​

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,play,mcp,login,get,set,action,statistics} ...

全局参数 ​

参数说明
-h, --help显示帮助信息并退出
-v, --version显示版本信息并退出
-p, --auth_path AUTH_PATH认证文件保存路径,默认 ~/.config/mijia-api/auth.json
--list_homes列出家庭列表
-l, --list_devices列出所有米家设备,包含共享设备
--list_scenes列出场景列表
--list_consumable_items列出耗材列表
--run_scene SCENE_ID/SCENE_NAME [...]运行场景,指定场景ID或名称(可多个)
--get_device_info DEVICE_MODEL获取设备信息,指定设备 model

环境变量 ​

环境变量默认值说明
MIJIA_LOG_LEVELINFO日志级别,可选值:DEBUG, INFO, WARNING, ERROR, CRITICAL

子命令:login ​

二维码登录米家账号。

usage: mijiaAPI login [-h] [-p AUTH_PATH]
参数说明
-h, --help显示帮助信息并退出
-p, --auth_path AUTH_PATH认证文件保存路径

login 子命令会尝试刷新 token;若仍不可用则在终端打印二维码并阻塞等待扫码。其他子命令(get/set/action/statistics/run/play/mcp 及全局参数)在认证文件缺失、损坏或失效且刷新失败时,不会自动触发登录,而是打印 请调用 'mijiaAPI login' 进行扫描登录 并以退出码 1 退出。

子命令:get ​

获取设备属性。

usage: mijiaAPI get [-h] [-p AUTH_PATH] [--did DID] [--dev_name DEV_NAME] --prop_name PROP_NAME
参数说明
-h, --help显示帮助信息并退出
-p, --auth_path AUTH_PATH认证文件保存路径
--did DID设备 did,优先于 --dev_name 使用
--dev_name DEV_NAME设备名称,指定为米家APP中设定的名称
--prop_name PROP_NAME属性名称(必填),先使用 --get_device_info 获取

子命令:set ​

设置设备属性。

usage: mijiaAPI set [-h] [-p AUTH_PATH] [--did DID] [--dev_name DEV_NAME] --prop_name PROP_NAME --value VALUE
参数说明
-h, --help显示帮助信息并退出
-p, --auth_path AUTH_PATH认证文件保存路径
--did DID设备 did,优先于 --dev_name 使用
--dev_name DEV_NAME设备名称,指定为米家APP中设定的名称
--prop_name PROP_NAME属性名称(必填),先使用 --get_device_info 获取
--value VALUE需要设定的属性值(必填)

子命令:action ​

按设备规格中的动作名执行设备动作。

usage: mijiaAPI action [-h] [-p AUTH_PATH] (--did DID | --dev_name DEV_NAME)
                       --action_name ACTION_NAME [--params PARAMS]
参数说明
-h, --help显示帮助信息并退出
-p, --auth_path AUTH_PATH认证文件保存路径
--did DID设备 did,与 --dev_name 二选一
--dev_name DEV_NAME设备名称,与 --did 二选一
--action_name ACTION_NAME动作名称(必填),先使用 --get_device_info 获取
--params PARAMS可选的动作参数 JSON 对象,例如 {"value":[2]}

子命令:statistics ​

获取设备统计数据。

usage: mijiaAPI statistics [-h] [-p AUTH_PATH] --did DID --key KEY
                           --data_type DATA_TYPE [--limit LIMIT]
                           [--time_start TIME_START] [--time_end TIME_END]
参数说明
-h, --help显示帮助信息并退出
-p, --auth_path AUTH_PATH认证文件保存路径
--did DID设备 did(必填)
--key KEY设备相关的统计键,如 lumi.acpartner.mcn04 的 7.1(必填)
--data_type DATA_TYPE统计类型,如 stat_month_v3;旧设备可能不带 _v3(必填)
--limit LIMIT最大条目数,默认 6
--time_start TIME_START开始 Unix 时间戳(秒),默认结束时间前 30 天
--time_end TIME_END结束 Unix 时间戳(秒),默认当前时间

常用统计类型为 stat_hour_v3、stat_day_v3、stat_week_v3、stat_month_v3,旧设备可能 使用不带 _v3 的对应类型。统计接口仅支持部分设备,key、data_type 和返回值格式均可能 因型号而异。例如 lumi.acpartner.mcn04 的耗电量使用 7.1,lumi.acpartner.mcn02 使用 powerCost。

子命令:run ​

使用自然语言描述你的需求,通过小爱音箱执行。

usage: mijiaAPI run [-h] [-p AUTH_PATH]
                       [--wifispeaker_name WIFISPEAKER_NAME] [--quiet | --no-quiet]
                       PROMPT
参数说明
PROMPT使用自然语言描述你的需求(位置参数,必填)
-h, --help显示帮助信息并退出
-p, --auth_path AUTH_PATH认证文件保存路径
--wifispeaker_name WIFISPEAKER_NAME指定小爱音箱名称,默认是获取到的第一个小爱音箱
--quiet, --no-quiet默认静默执行;--no-quiet 播报回复

run 使用小爱音箱的 execute-text-directive 动作,处理自然语言控制指令。

子命令:play ​

通过小爱音箱直接朗读文本(play-text 动作),不执行设备控制指令。

usage: mijiaAPI play [-h] [-p AUTH_PATH]
                     [--wifispeaker_name WIFISPEAKER_NAME]
                     TEXT
参数说明
TEXT要朗读的文本(位置参数,必填)
-h, --help显示帮助信息并退出
-p, --auth_path AUTH_PATH认证文件保存路径
--wifispeaker_name WIFISPEAKER_NAME指定小爱音箱名称,默认是获取到的第一个小爱音箱

子命令:mcp ​

启动 MCP server(stdio 传输)。该子命令需要可选依赖 fastmcp,未安装时会提示并退出。

usage: mijiaAPI mcp [-h] [-p AUTH_PATH]
参数说明
-h, --help显示帮助信息并退出
-p, --auth_path AUTH_PATH认证文件保存路径

安装可选依赖后即可运行:

bash
pip install "mijiaAPI[mcp]"
# uvx 用户直接在命令中指定 extra
uvx "mijiaAPI[mcp]" mcp

基于 GPL-3.0 许可证发布