[](https://github.com/al-one/hass-xiaomi-miot/releases/latest) [](https://github.com/al-one/hass-xiaomi-miot/releases) [](https://github.com/al-one/hass-xiaomi-miot/stargazers) [](https://github.com/al-one/hass-xiaomi-miot/issues) [](https://hacs.xyz) # Xiaomi Miot For HomeAssistant English | [简体中文](https://github.com/al-one/hass-xiaomi-miot/blob/master/README_zh.md) [MIoT-Spec](https://iot.mi.com/new/doc/design/spec/overall): The protocol specification for Xiaomi IoT devices, is a standard designed by the Xiaomi IoT platform to describe the function definition of hardware products according to the networking mode of hardware products, the characteristics of product functions, the characteristics of user usage scenarios and the user's requirements for hardware product use experience specification. This component uses the **miot** protocol to automatically integrate Xiaomi devices into [HomeAssistant](https://www.home-assistant.io), and currently supports most Xiaomi IoT devices. And it supports HA Web UI, and you can easily integrate Xiaomi devices into HA without configuring yaml. ## Installation #### Method 1: [HACS](https://hacs.xyz) - First installation > HACS > Integrations > ➕ EXPLORE & DOWNLOAD REPOSITORIES > [`Xiaomi Miot`](https://my.home-assistant.io/redirect/hacs_repository/?owner=al-one&repository=hass-xiaomi-miot) > DOWNLOAD THIS REPOSITORY - Update component > HACS > Integrations > [`Xiaomi Miot`](https://my.home-assistant.io/redirect/hacs_repository/?owner=al-one&repository=hass-xiaomi-miot) > UPDATE / Redownload #### Method 2: Manually installation via Samba / SFTP > Download and copy `custom_components/xiaomi_miot` folder to `custom_components` folder in your HomeAssistant config folder #### Method 3: Onkey shell via SSH / Terminal & SSH add-on ```shell wget -O - https://get.hacs.vip | DOMAIN=xiaomi_miot bash - # Or wget -O - https://raw.githubusercontent.com/al-one/hass-xiaomi-miot/master/install.sh | ARCHIVE_TAG=latest bash - ``` #### Method 4: shell_command service 1. Copy this code to file `configuration.yaml` ```yaml shell_command: update_xiaomi_miot: |- wget -O - https://get.hacs.vip | DOMAIN=xiaomi_miot bash - ``` 2. Restart HA core 3. Call this [`service: shell_command.update_xiaomi_miot`](https://my.home-assistant.io/redirect/developer_call_service/?service=shell_command.update_xiaomi_miot) in Developer Tools 2. Restart HA core again ## Config > [⚙️ Configuration](https://my.home-assistant.io/redirect/config) > Devices and Services > [🧩 Integrations](https://my.home-assistant.io/redirect/integrations) > [➕ Add Integration](https://my.home-assistant.io/redirect/config_flow_start?domain=xiaomi_miot) > 🔍 Search `Xiaomi Miot` Or click: [](https://my.home-assistant.io/redirect/config_flow_start?domain=xiaomi_miot) ### Add devices using Mi Account: Starting from the v0.4.4 version, the component has added support for selecting the connection device mode when integrated by account: - **Automatic**: The component will regularly update [the devices that support miot-spec in LAN](https://github.com/al-one/hass-xiaomi-miot/blob/master/custom_components/xiaomi_miot/core/miot_local_devices.py), and automatically use the local connection for the supported devices (recommended) - **Local**: All devices filtered by the integrated configuration will use local connection. If you check the devices that do not support miot in LAN, they will be unavailable - **Cloud**: All devices filtered by the integrated configuration will use cloud connection. It is recommended that miio, BLE, ZigBee devices use this mode **Note:** For **Local** mode, some devices require Home Assistant to be on the same subnet/VLAN. They will not respond to requests from a different subnet. A workaround is to NAT your Home Assistant IP to the device's subnet. ### Add device using host/token: Suitable for devices support miot-spec protocol in LAN ### Config Xiaomi Cloud: > Config Xiaomi cloud for the devices **integrated by host/token** ```yaml # configuration.yaml xiaomi_miot: username: xiaomi_username password: xiaomi_password # server_country: cn # Location of xiaomi cloud: cn(default), de, i2, ru, sg, tw, us # http_timeout: 15 # Timeout (seconds) for requesting the xiaomi apis ``` > [⚙️ Configuration](https://my.home-assistant.io/redirect/config) > Devices and Services > [🧩 Integrations](https://my.home-assistant.io/redirect/integrations) > Xiaomi Miot > Options > ☑️ Enable miot cloud ### Translations > Looking forward to your [contribution](https://github.com/al-one/hass-xiaomi-miot/edit/master/custom_components/xiaomi_miot/core/translation_languages.py). ```yaml # configuration.yaml xiaomi_miot: language: zh # Using the built-in dictionary, currently only `zh` is supported # https://github.com/al-one/hass-xiaomi-miot/blob/master/custom_components/xiaomi_miot/core/translation_languages.py translations: # Global dictionary idle: '空闲' busy: '工作中' # Dictionary for specifying fan modes fan.mode: straight wind: '直吹模式' natural wind: '自然风' # Dictionary for specifying the drying modes of the washer washer.drying_level: moist: '微湿' extra: '特干' ``` ### [Customize entity](https://www.home-assistant.io/docs/configuration/customizing-devices/#customizing-entities) ``` /* Detailed source-code truncated for AI context efficiency. */ ``` ### Filter entity attributes > Too many entity attributes will make your HA's database very large. If some entity attributes are useless to you, you can configure `exclude_state_attributes` to ignore them. ```yaml # configuration.yaml xiaomi_miot: exclude_state_attributes: - miot_type - stream_address - motion_video_latest ``` ### YAML configuration reloading This component has added support for configuration reloading (to avoid having to restart [HomeAssistant](https://www.home-assistant.io) instance after a YAML configuration change): > [🔨 Developer tools](https://my.home-assistant.io/redirect/developer_states) > [YAML Configuration](https://my.home-assistant.io/redirect/server_controls) > YAML configuration reloading > 🔍 Look for `Xiaomi Miot` (almost at the bottom of the list) ## [Supported Devices](https://github.com/al-one/hass-xiaomi-miot/issues/12) - 🔌 [outlet](https://home.miot-spec.com/s/plug) / [switch](https://home.miot-spec.com/s/switch) - 💡 [light](https://home.miot-spec.com/s/light) - ❄️ [air-conditioner](https://home.miot-spec.com/s/aircondition) / [air-conditioner-outlet](https://home.miot-spec.com/s/acpartner) / [ir-aircondition-control](https://home.miot-spec.com/s/miir.aircondition) - 🌀 [fan](https://home.miot-spec.com/s/fan) / [ceiling-fan](https://home.miot-spec.com/s/ven_fan) - 🛀 [bath-heater](https://home.miot-spec.com/s/bhf_light) / 🔥 [heater](https://home.miot-spec.com/s/heater) / [thermostat](https://home.miot-spec.com/s/airrtc) - 📷 [camera](https://home.miot-spec.com/s/camera) / [video-doorbell](https://home.miot-spec.com/s/cateye) [❓️](https://github.com/al-one/hass-xiaomi-miot/issues/100#issuecomment-903078604) - 📺 [television](https://home.miot-spec.com/s/tv) / 📽️ [projector](https://home.miot-spec.com/s/projector) / [tv-box](https://home.miot-spec.com/s/tvbox) - 🗣️ [intelligent-speaker](https://home.miot-spec.com/s/wifispeaker) [❓️](https://github.com/al-one/hass-xiaomi-miot/issues/100#issuecomment-885989099) - 🎮️ [ir-remote-control](https://home.miot-spec.com/s/chuangmi.remote) [❓️](https://github.com/al-one/hass-xiaomi-miot/commit/fbcc8063783e53b9480574536a034d338634f4e8#commitcomment-56563663) - 🔐 [lock](https://home.miot-spec.com/s/lock) / 🚪 [door](https://home.miot-spec.com/s/door) - 👕 [washer](https://home.miot-spec.com/s/washer) / [dryer](https://home.miot-spec.com/s/dry) / [fridge](https://home.miot-spec.com/s/fridge) - 🚰 [water-purifier](https://home.miot-spec.com/s/waterpuri) / [kettle](https://home.miot-spec.com/s/kettle) - ♻️ [air-purifier](https://home.miot-spec.com/s/airpurifier) / [air-fresh](https://home.miot-spec.com/s/airfresh) / [hood](https://home.miot-spec.com/s/hood) - 🌡 [temperature-humidity-sensor](https://home.miot-spec.com/s/sensor_ht) / [submersion-sensor](https://home.miot-spec.com/s/flood) / [smoke-sensor](https://home.miot-spec.com/s/sensor_smoke) - 🥘 [cooker](https://home.miot-spec.com/s/cooker) / [pressure-cooker](https://home.miot-spec.com/s/pre_cooker) / [electric-steamer](https://home.miot-spec.com/s/esteamer) - 🍲 [induction-cooker](https://home.miot-spec.com/s/ihcooker) / [oven](https://home.miot-spec.com/s/oven) / [microwave](https://home.miot-spec.com/s/microwave) - 🍗 [air-fryer](https://home.miot-spec.com/s/fryer) / [multifunction-cooking-pot](https://home.miot-spec.com/s/mfcp) - 🍵 [health-pot](https://home.miot-spec.com/s/health_pot) / ☕️ [coffee-machine](https://home.miot-spec.com/s/coffee) - 🍹 [juicer](https://home.miot-spec.com/s/juicer) / [fruit-vegetable-purifier](https://home.miot-spec.com/s/f_washer) - ♨️ [water-heater](https://home.miot-spec.com/s/waterheater) / [dishwasher](https://home.miot-spec.com/s/dishwasher) / [foot-bath](https://home.miot-spec.com/s/foot_bath) - 🦠 [steriliser](https://home.miot-spec.com/s/steriliser) / [towel-rack](https://home.miot-spec.com/s/.tow) - 🪟 [curtain](https://home.miot-spec.com/s/curtain) / [window-opener](https://home.miot-spec.com/s/wopener) / [airer](https://home.miot-spec.com/s/airer) - 🧹 [vacuum](https://home.miot-spec.com/s/vacuum) / [mopping-machine](https://home.miot-spec.com/s/.mop) - 💦 [humidifier](https://home.miot-spec.com/s/humidifier) / [dehumidifier](https://home.miot-spec.com/s/derh) / [diffuser](https://home.miot-spec.com/s/diffuser) - 🍃 [air-monitor](https://home.miot-spec.com/s/airmonitor) / 🪴 [plant-monitor](https://home.miot-spec.com/s/plantmonitor) - 🛏 [bed](https://home.miot-spec.com/s/bed) / [blanket](https://home.miot-spec.com/s/blanket) / 😴 [sleep-monitor](https://home.miot-spec.com/s/lunar) - 💺 [chair](https://home.miot-spec.com/s/chair) / [table](https://home.miot-spec.com/s/desk) - 💆 [massager](https://home.miot-spec.com/s/massage) / [magic-touch](https://home.miot-spec.com/s/magic_touch) - 🏃 [walking-pad](https://home.miot-spec.com/s/walkingpad) / [treadmill](https://home.miot-spec.com/s/treadmill) - 🚽 [toilet](https://home.miot-spec.com/s/toilet) / [cat-toilet](https://home.miot-spec.com/s/litter_box) / 🪥 [toothbrush](https://home.miot-spec.com/s/toothbrush) - 🐱 [pet-feeder](https://home.miot-spec.com/s/feeder) / ⛲ [pet-drinking-fountain](https://home.miot-spec.com/s/pet_waterer) / 🐟 [fish-tank](https://home.miot-spec.com/s/fishbowl) - 🦟 [mosquito-dispeller](https://home.miot-spec.com/s/mosq) / [germicidal-lamp](https://home.miot-spec.com/s/s_lamp) - 🚘 [rearview-mirror](https://home.miot-spec.com/s/rv_mirror) / [head-up-display](https://home.miot-spec.com/s/hud) - ⌚️ [watch](https://home.miot-spec.com/s/watch) / [bracelet](https://home.miot-spec.com/s/bracelet) - 🚶 [motion-sensor](https://home.miot-spec.com/s/motion) / 🧲 [magnet-sensor](https://home.miot-spec.com/s/magnet) [❓️](https://github.com/al-one/hass-xiaomi-miot/issues/100#issuecomment-909031222) - 📳 [vibration-sensor](https://home.miot-spec.com/s/vibration) - 🌐 [router](https://home.miot-spec.com/s/router) / 🖨 [printer](https://home.miot-spec.com/s/printer) ### Unsupported devices > This component uses the polling method to obtain the device state, so it cannot listen the events of some devices in real time. - Wireless Switch (like: [lumi.sensor_switch.v1](https://home.miot-spec.com/s/lumi.sensor_switch.v1) / [lumi.remote.b686opcn01](https://home.miot-spec.com/s/lumi.remote.b686opcn01)) - Motion Sensor (like: [lumi.sensor_motion.v1](https://home.miot-spec.com/s/lumi.sensor_motion.v1)) - Window and Door Sensor (like: [lumi.sensor_magnet.v1](https://home.miot-spec.com/s/lumi.sensor_magnet.v1)) ## Services > Since the HA support service response has been for some time, this component no longer triggers events starting from v0.7.18. #### [`xiaomi_miot.set_property`](https://my.home-assistant.io/redirect/developer_call_service/?service=xiaomi_miot.set_property) ```yaml service: xiaomi_miot.set_property data: entity_id: camera.isa_hlc7_xxxx field: camera_control.on value: true ``` #### [`xiaomi_miot.set_miot_property`](https://my.home-assistant.io/redirect/developer_call_service/?service=xiaomi_miot.set_miot_property) ```yaml service: xiaomi_miot.set_miot_property data: entity_id: camera.isa_hlc7_xxxx siid: 2 piid: 1 value: true ``` #### [`xiaomi_miot.get_properties`](https://my.home-assistant.io/redirect/developer_call_service/?service=xiaomi_miot.get_properties) ```yaml service: xiaomi_miot.get_properties data: entity_id: camera.isa_hlc7_1ab7 mapping: - siid: 2 piid: 1 - siid: 3 piid: 2 update_entity: true # Update to entity state attributes ``` #### [`xiaomi_miot.call_action`](https://my.home-assistant.io/redirect/developer_call_service/?service=xiaomi_miot.call_action) ```yaml service: xiaomi_miot.call_action data: entity_id: vacuum.dreame_p2259_entity_id siid: 4 # vacuum-extend aiid: 1 # start-clean params: - 18 # piid: 1 - work-mode - '{"selects":[[7,1,0,2,1]]}' # piid: 10 - clean-extend-data ``` #### [`xiaomi_miot.send_command`](https://my.home-assistant.io/redirect/developer_call_service/?service=xiaomi_miot.send_command) ```yaml service: xiaomi_miot.send_command data: entity_id: switch.your_entity_id method: set_power params: - on ``` #### [`xiaomi_miot.get_token`](https://my.home-assistant.io/redirect/developer_call_service/?service=xiaomi_miot.get_token) ```yaml service: xiaomi_miot.get_token data: name: Light # Keyword of device name in Mihome / IP / Model. ``` #### [`xiaomi_miot.intelligent_speaker`](https://my.home-assistant.io/redirect/developer_call_service/?service=xiaomi_miot.intelligent_speaker) ```yaml service: xiaomi_miot.intelligent_speaker data: entity_id: media_player.xiaoai_lx04_xxxx text: Turn on the light execute: true # Execute text directive. silent: true # Silent execution. ``` #### [`xiaomi_miot.xiaoai_wakeup`](https://my.home-assistant.io/redirect/developer_call_service/?service=xiaomi_miot.xiaoai_wakeup) ```yaml service: xiaomi_miot.xiaoai_wakeup data: entity_id: media_player.xiaoai_lx04_xxxx ``` #### [`xiaomi_miot.renew_devices`](https://my.home-assistant.io/redirect/developer_call_service/?service=xiaomi_miot.renew_devices) ```yaml service: xiaomi_miot.renew_devices data: username: 80001234 # Xiaomi Account ID / Email / Phone ``` #### [`xiaomi_miot.request_xiaomi_api`](https://my.home-assistant.io/redirect/developer_call_service/?service=xiaomi_miot.request_xiaomi_api) ```yaml service: xiaomi_miot.request_xiaomi_api data: entity_id: sensor.your_entity_id api: /v2/plugin/fetch_plugin data: latest_req: api_version: 10070 plugins: - model: brand.device.model ``` > [More services](https://github.com/al-one/hass-xiaomi-miot/blob/master/custom_components/xiaomi_miot/services.yaml) ## Debug ### Get Entity State Attributes > [🔨 Developer tools](https://my.home-assistant.io/redirect/developer_states) > [ℹ️ State](https://my.home-assistant.io/redirect/developer_states) > 🔍 Filter Entity ### [Get Debug Logs](https://www.home-assistant.io/integrations/logger) ```yaml # configuration.yaml logger: default: warning logs: custom_components.xiaomi_miot: debug ``` > [⚙️ Configuration](https://my.home-assistant.io/redirect/config) > [⚙️ System](https://my.home-assistant.io/redirect/system_dashboard) > [✍️ Logs](https://my.home-assistant.io/redirect/logs) ## Obtain miio token - Use HomeAssistant Service 1. Goto HomeAssistant service developer tool [](https://my.home-assistant.io/redirect/developer_services/) 2. Select [`xiaomi_miot.get_token`](https://my.home-assistant.io/redirect/developer_call_service/?service=xiaomi_miot.get_token), Enter the keyword of device name 3. Find the token from the HA notifications - Use MiHome mod by [@vevsvevs](https://github.com/custom-components/ble_monitor/issues/7#issuecomment-595874419) 1. Down apk from [СКАЧАТЬ ВЕРСИЮ 7.x.x](https://www.vevs.me/2017/11/mi-home.html) and install 2. Start Mihome APP > Profile > Experimental features 3. Check on `Write custom log files` and `Enable app's debug mode` 4. Find the token from `vevs/logs/misc/devices.txt` after restart app - [Xiaomi Cloud Tokens Extractor](https://github.com/PiotrMachowski/Xiaomi-cloud-tokens-extractor) 1. Download and run [token_extractor.exe](https://github.com/PiotrMachowski/Xiaomi-cloud-tokens-extractor/blob/master/token_extractor.exe) for Windows or install [for Python](https://github.com/PiotrMachowski/Xiaomi-cloud-tokens-extractor#other-platforms) 2. Enter username, password and your server region 3. Extracts tokens from your cloud account. Also reveals the bind_key for BT devices ## Thanks - [PyCharm](https://www.jetbrains.com/pycharm/) - [Dler](https://dler.pro/auth/register?affid=130833) (10% Discount coupon for new user: `CXVbfhHuSRsi`)