Skip to main content

A Python API for Xiaomi Mijia

Project description

mijiaAPI

米家 API,可以使用代码、CLI、MCP 直接控制米家设备。

🎉 v4.0.0 版本已支持 MCP,详见 MCP 使用文档
🎉 v4.1.0 版本已支持 Agent Skill,详见 Agent Skill 使用文档

GitHub PyPI License: GPL-3.0

📖 完整文档请见 mijia-api.do1e.com

常见问题 | 更新日志

安装

要求 Python >= 3.10

pip install mijiaAPI
# Or `uv add mijiaAPI` for uv users

其他安装方式(源码安装、AUR)请参考文档

快速开始

from mijiaAPI import mijiaAPI, mijiaDevice

# 初始化并扫码登录(认证文件默认保存在 ~/.config/mijia-api/auth.json)
api = mijiaAPI()
api.login()

# 通过设备名称控制设备(推荐)
device = mijiaDevice(api, dev_name="我的台灯")
device.on = True              # 打开设备
device.brightness = 60        # 设置亮度为 60%

# 查看设备支持的所有属性和动作
print(device)

CLI 用法:

mijiaAPI login                          # 扫码登录
mijiaAPI -l                             # 列出所有设备
mijiaAPI set --dev_name "台灯" --prop_name "brightness" --value 60

MCP 用法:

执行 uvx mijiaAPI login -p /path/to/auth.json 登录后,在 MCP 客户端配置中添加以下内容即可接入米家:

{
  "mcpServers": {
    "mijia-api": {
      "command": "uvx",
      "args": ["mijiaAPI", "mcp", "-p", "/path/to/auth.json"]
    }
  }
}

更多用法(API 基础调用、MCP Server、CLI 完整参数、最佳实践等)请查阅完整文档

致谢

开源许可

本项目采用 GPL-3.0 开源许可证。

请注意:GPL-3.0 是具有“强传染性”的开源许可证。
如果您在您的项目中使用、修改或分发本项目的代码(包括作为库依赖),您的整个项目也必须以 GPL-3.0 或兼容许可证开源发布。

免责声明

  • 本项目仅供学习交流使用,不得用于商业用途,如有侵权请联系删除
  • 用户使用本项目所产生的任何后果,需自行承担风险
  • 开发者不对使用本项目产生的任何直接或间接损失负责

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mijiaapi-4.2.0.tar.gz (145.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mijiaapi-4.2.0-py3-none-any.whl (41.2 kB view details)

Uploaded Python 3

File details

Details for the file mijiaapi-4.2.0.tar.gz.

File metadata

  • Download URL: mijiaapi-4.2.0.tar.gz
  • Upload date:
  • Size: 145.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mijiaapi-4.2.0.tar.gz
Algorithm Hash digest
SHA256 6ca456a20d8c28cf0037074d91bced72c767406958a091926d3b7daba3e02e62
MD5 7f447ee613a71d513672b9c6717875da
BLAKE2b-256 b716b113fce93cea9a88e4236eb600b75bf0741ca933943d45b6b76263ebdcc1

See more details on using hashes here.

File details

Details for the file mijiaapi-4.2.0-py3-none-any.whl.

File metadata

  • Download URL: mijiaapi-4.2.0-py3-none-any.whl
  • Upload date:
  • Size: 41.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mijiaapi-4.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d2d33ffe6478bc02b5516ebaaca603a519b958a7f722385b8404c0cad47ba0e9
MD5 0f2911dbaab5a6367ff8862ecb48750b
BLAKE2b-256 3e14cb52328b43801f80a1d6a2c6afa3aa71ceb21c34960acbb273da8294b133

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page