Skip to main content

A Python API for Xiaomi Mijia

Project description

mijiaAPI

小米米家设备的 API,可以使用代码直接控制米家设备。

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

更多用法(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.0.0.tar.gz (146.6 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.0.0-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mijiaapi-4.0.0.tar.gz
  • Upload date:
  • Size: 146.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":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.0.0.tar.gz
Algorithm Hash digest
SHA256 f108f39f2a640e1a4f0b3d7f7a2b886bba4ba66431e4827c322a97758bc7465a
MD5 a49a16f314e68e9f4cddd8e2ff5e93b5
BLAKE2b-256 f1113619e2686d36549124b9ec313e21674e7f539666456170dbdb7d1257ac4a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mijiaapi-4.0.0-py3-none-any.whl
  • Upload date:
  • Size: 38.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":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.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 30ad786a3a4995b711fa6b5fc9f8aa1d1c78bca7de2f676e151ceff197a2e7cf
MD5 8b63705cf87bc01bb5af174847953302
BLAKE2b-256 beeb07fb64538c7eac00bc90349d8930bfd17056c1bd3f1da22dff92d591f127

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