Passwordless QR login to the official Xiaomi cloud: extract per-device miIO tokens / BLE keys and control cloud IR remotes (TV / A-C / fan / DIY)
Project description
mihome-ctl
Passwordless QR login to the official Xiaomi cloud — extract every device's miIO token / local IP / BLE beacon-key, and control cloud IR remotes (TV / air-conditioner / fan / DIY on-off) through your home's parent blaster (e.g. a Xiao AI speaker). No local hardware, no Home Assistant required.
- Talks only to official hosts:
account.xiaomi.com+{region}.api.io.mi.com - Supports the
tw/sgregions (python-miio / micloud have notwlocale) - Produces per-device token + local IP + BLE key
- Passwordless (QR); secrets written with
chmod 600
· Docs: https://daviddwlee84.github.io/mihome-ctl/ · 中文說明見文件站
A thin wrapper over the Xiaomi-cloud-tokens-extractor connector (MIT, vendored + trimmed into
mihome_ctl/connector.py, seeTHIRD_PARTY_LICENSES/) plus a cloud-IR control layer.
Install
uv tool install mihome-ctl # or: pipx install mihome-ctl
# From source:
uv sync && uv run mihome-ctl --help
Optional extras:
uv tool install 'mihome-ctl[verify]' # verify: LAN token check (python-miio)
uv tool install 'mihome-ctl[mcp]' # MCP server (for Claude / agents)
Claude integration — skill + MCP (one step)
After installing, wire up the agent skill and MCP server in one command:
mihome-ctl setup # lists what it will do, asks [y/N], then installs the skill + registers the MCP
mihome-ctl setup -y # skip the confirmation prompt (non-interactive)
mihome-ctl setup --project # install into ./.claude instead of the user dir
mihome-ctl setup --npx # install the skill via `npx skills add` (vercel-labs/skills) instead
mihome-ctl setup --dry-run # preview what it would do, write nothing
mihome-ctl setup --uninstall # remove the skill + unregister the MCP (also honors -y / --dry-run)
setup ships the skill inside the wheel, so the default path needs no Node —
it copies SKILL.md locally and runs claude mcp add mihome-ctl -- mihome-ctl-mcp
(or prints the config if the claude CLI isn't found). So the whole onboarding is:
uv tool install 'mihome-ctl[mcp]' && mihome-ctl setup
- Agent Skill
mihome-ir— lets Claude control the TV / A-C / fan by voice-style requests. Also installable directly:npx skills add daviddwlee84/mihome-ctl --skill mihome-ir. - MCP server
mihome-ctl-mcp— exposeslist_remotes/list_keys/ir_send/ir_acplusdevice_prop_get/device_prop_set/device_action(control any device) as MCP tools (reuses the QR session cached bymihome-ctl ir).
Usage
mihome-ctl extract # QR login, extract tokens (scans tw sg cn)
mihome-ctl extract --server tw sg # specific regions (space-separated, not repeated flags)
mihome-ctl list # reprint last result offline
mihome-ctl verify --did <DID> # LAN-verify one device (needs [verify])
mihome-ctl ir # list cloud miir.* remotes + parent blaster
mihome-ctl ir-send --remote <name> --key VOL+ [--repeat 3]
mihome-ctl ir-send --remote <name> # omit --key to list a remote's keys
mihome-ctl ir-ac --temp 26 --mode cool # absolute A/C control (state-based)
mihome-ctl ir-ac --off | --status
mihome-ctl ir-code --matchid xm_1_199 # IRDB matchid → per-key Pronto (see notes)
# control any (non-IR) device by MIoT siid/piid — cloud by default, --local for LAN
mihome-ctl devices # pretty table of devices + did (--md for markdown)
mihome-ctl spec --did <DID> # named properties/actions (from miot-spec.org) — so you know which siid/piid
mihome-ctl prop-get --did <DID> --siid 2 --piid 1 # read a property
mihome-ctl prop-set --did <DID> --siid 2 --piid 1 --value true # write a property
mihome-ctl action --did <DID> --siid 2 --aiid 1 --args '[]' # call an action
mihome-ctl miio --did <DID> --method get_prop --params '["power"]' # raw local miIO
On first run a QR is drawn in the terminal (or open http://127.0.0.1:31415) — scan
once with the Mi Home app; the session is cached in the state dir's
mi-session.json, so subsequent runs skip the scan. Use --relogin to force a re-login.
State directory
Resolved in this order (secret filenames: mi-tokens.json / mi-session.json /
mi-ir.json / devices.md):
MIHOME_CTL_HOMEenvironment variable- the nearest
./.secrets/walking up from the cwd (convenient when embedded as a submodule inside another repo) - otherwise the user state dir — honoring
XDG_STATE_HOMEon every platform (incl. macOS), else theplatformdirsdefault (~/Library/Application Support/mihome-ctlon macOS,~/.local/state/mihome-ctlon Linux). An existing legacy dir is still read so nothing is orphaned.
All secrets are written with mode 0600.
Architecture — one core, many front-ends
mihome_ctl.core is a UI-agnostic layer (connector, cloud API, IR codec,
operations) that only does work and returns structured data. Everything on top
is a thin presentation layer:
mihome_ctl.commands+__main__— the Tyro CLI (commands above)mihome_ctl.mcp_server— an MCP server (mihome-ctl-mcp, needs[mcp])- the TUI (
mihome-ctl tui,[tui]extra) — Remotes / Air-Con / Devices tabs — is another layer over the same core. The Devices tab resolves each device's MIoT spec into a live per-property panel: a toggle for on/off, a dropdown for modes, a numeric box for ranges, each showing the property's current value inline (auto-loaded when you open a device, or via Refresh) with per-row Get/Set — no siid/piid guessing. A manualsiid/piid/aiidform stays for spec-less devices (blt.*/miir.*) and raw calls.
ir-code and licensing (important)
ir-code decodes a Xiaomi IRDB matchid into Pronto:
base64 → AES-128-ECB → gzip → microsecond timings → Pronto. The decoder is a
clean-room implementation (from the public protocol, using pycryptodome), so
this package contains no AGPL code, vendors nothing AGPL, and downloads no AGPL
tool at runtime — it stays cleanly MIT.
Limitation (stated honestly): the public {region}-urc.io.mi.com/controller/code/1
endpoint currently requires a Mi Home app signature (anonymous requests return
status:19), so fetching codes online by matchid is experimental. The decoder
itself is verified by a round-trip test. To use an external IRDB tool (e.g. the
AGPL-licensed ysard/mi_remote_database), install it yourself and opt in — this
package deliberately does not depend on or bundle it (core/ircodec/base.py keeps an
IRCodecBackend extension point for an external backend).
Development
uv sync --extra verify --extra mcp
uv run pytest -q
uv run ruff check . && uv run ruff format --check .
Releasing
Publishing is automated: cut a GitHub Release tagged vX.Y.Z (matching the
pyproject.toml version) and .github/workflows/release.yml builds and uploads
to PyPI via Trusted Publishing (OIDC —
no stored token). One-time PyPI setup instructions are in the workflow header.
License
MIT (see LICENSE). The bundled Xiaomi connector derives from an upstream MIT
project — see THIRD_PARTY_LICENSES/.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mihome_ctl-0.7.0.tar.gz.
File metadata
- Download URL: mihome_ctl-0.7.0.tar.gz
- Upload date:
- Size: 60.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dd8d7c12ef8068e79a9759ad48d8f9a21400624a63a6e54a4db5f955d2f84ced
|
|
| MD5 |
72ac99acb26980a6f818f40a4d620bbc
|
|
| BLAKE2b-256 |
c64df4e43913042c18924e7aed45ec5ef582bfae86f89ebbb4170d62c7b757c6
|
File details
Details for the file mihome_ctl-0.7.0-py3-none-any.whl.
File metadata
- Download URL: mihome_ctl-0.7.0-py3-none-any.whl
- Upload date:
- Size: 54.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a84530633e215e473df58130a9f4097ca495001f1035a1f4ee3965152b166ac1
|
|
| MD5 |
73701ca5f36989d794b27e78ab072b96
|
|
| BLAKE2b-256 |
cfb9035679729da46846f6e078d6743095e87f384d7f17c5a2cf560a262b838c
|