jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-28 19:57:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename Xiaomi Miio integration to Xioami Home (#39488)

Browse Source
This commit is contained in:
Manu 2025-06-16 22:52:22 +02:00 committed by GitHub
parent b8facb3d8b
commit 67613b62fd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 38 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
source/_integrations/xiaomi_miio.markdown
View File

@ -1,6 +1,6 @@
---
title: Xiaomi Miio
description: Instructions on how to integrate Xiaomi devices using the Xiaomi Miio integration within Home Assistant.
title: Xiaomi Home
description: Instructions on how to integrate Xiaomi devices using the Xiaomi Home integration within Home Assistant.
ha_category:
- Alarm
- Fan
@ -38,7 +38,7 @@ ha_platforms:
ha_integration_type: integration
---
The **Xiaomi Miio** {% term integration %} supports the following devices:
The **Xiaomi Home** {% term integration %} supports the following devices:
- [Xiaomi Gateway](#xiaomi-gateway)
- [Xiaomi device tracker (Xiaomi Mi WiFi Repeater 2)](#xiaomi-device-tracker-xiaomi-mi-wifi-repeater-2)
@ -51,7 +51,7 @@ The **Xiaomi Miio** {% term integration %} supports the following devices:
## Prerequisites
Most Xiaomi Miio devices support configuration using the Home Assistant UI,
Most Xiaomi Home devices support configuration using the Home Assistant UI,
except for the [Xiaomi device tracker](#xiaomi-device-tracker-xiaomi-mi-wifi-repeater-2)
and [Xiaomi IR Remote](#xiaomi-ir-remote). Please read the linked sections for those devices for more information.
@ -63,8 +63,8 @@ For more complex network setups (e.g. VLANs), reference the [following documenta
{% include integrations/config_flow.md %}
It is recommend to supply your Xiaomi cloud credentials during configuration
to automatically connect to your devices. You need to specify the cloud server
It is recommended to supply your Xiaomi Home credentials during configuration
to automatically connect to your devices. You need to specify the server region
you used in the Xiaomi Home App (where you initially setup the device). There are
6 servers: `cn`, `de`, `i2`, `ru`, `sg` and `us`; please see
[this page](https://www.openhab.org/addons/bindings/miio/#country-servers) for
@ -74,13 +74,13 @@ the server to use for each country.
The most common problems are:
- Xiaomi Miio devices do not communicate across subnets/VLANs due to the source address of the UDP packet not belonging to the subnet of the device itself, [more information and solutions](https://python-miio.readthedocs.io/en/latest/troubleshooting.html#discover-devices-across-subnets).
- Xiaomi Home devices do not communicate across subnets/VLANs due to the source address of the UDP packet not belonging to the subnet of the device itself, [more information and solutions](https://python-miio.readthedocs.io/en/latest/troubleshooting.html#discover-devices-across-subnets).
- Roborock vacuums need to be connected to the Xiaomi Home app, not the Roborock app, [more information](https://python-miio.readthedocs.io/en/latest/troubleshooting.html#roborock-vacuum-not-detected).
- Blocking the network access to the device is known to cause intermittent connection issues due to the device's internal software hanging and a watchdog restarting the internal software, [more information](https://python-miio.readthedocs.io/en/latest/troubleshooting.html#intermittent-connection-issues-timeouts-xiaomi-vacuum).
## Xiaomi Gateway
The `xiaomi_miio` gateway {% term integration %} allows you to control the gateway and its connected subdevices.
The Xiaomi Home {% term integration %} allows you to control the gateway and its connected subdevices.
### Supported Xiaomi gateway models
@ -94,7 +94,7 @@ The following list shows the Gateway name, the model number, the Zigbee ID, and
- **European version**
- Model: ZHWG11LM-763 / DGNWQ05LM
- Zigbee ID: lumi.gateway.mieu01
- Supported: Yes (cloud credentials needed)
- Supported: Yes (Xiaomi Home credentials needed)
- **Aqara hub**
- Model: ZHWG11LM
@ -121,7 +121,7 @@ The following list shows the Gateway name, the model number, the Zigbee ID, and
- Zigbee ID: lumi.acpartner.v3
- Supported: Yes
Some gateways (lumi.gateway.mieu01) do not support getting the connected subdevices locally. For those gateways, cloud credentials can be specified during the config flow and the "Use cloud to get connected subdevices" can be enabled in the options flow (after setting up the {% term integration %}, click Configuration in the sidebar, then click Integrations and then click Options on the already set up Xiaomi Miio Gateway {% term integration %}). The connected subdevices will then be retrieved from the Xiaomi Miio cloud (internet), control and status updates of those subdevices will then further take place over local network connection. A re-authentication flow may be triggered when no cloud credentials are provided yet and are needed for that particular gateway model.
Some gateways (lumi.gateway.mieu01) do not support getting the connected subdevices locally. For those gateways, Xiaomi Home credentials can be specified during the config flow and the "Use Xiaomi Home service to get connected subdevices" can be enabled in the options flow (after setting up the {% term integration %}, click Configuration in the sidebar, then click Integrations and then click Options on the already set up Xiaomi Home {% term integration %}). The connected subdevices will then be retrieved from Xiaomi Home (internet), control and status updates of those subdevices will then further take place over local network connection. A re-authentication flow may be triggered when no account credentials are provided yet and are needed for that particular gateway model.
### Gateway features
@ -242,7 +242,7 @@ The list shows the device name, the model number, and the Zigbee ID.
## Xiaomi device tracker (Xiaomi Mi WiFi Repeater 2)
The `xiaomi_miio` device tracker platform is observing your Xiaomi Mi WiFi Repeater 2 and reporting all associated WiFi clients.
The device tracker platform is observing your Xiaomi Mi WiFi Repeater 2 and reporting all associated WiFi clients.
Please follow the instructions on [Retrieving the Access Token](/integrations/xiaomi_miio/#retrieving-the-access-token) to get the API token.
@ -257,11 +257,11 @@ device_tracker:
{% configuration %}
host:
description: The IP address of your miio device.
description: The IP address of your Xiaomi device.
required: true
type: string
token:
description: The API token of your miio device.
description: The API token of your Xiaomi device.
required: true
type: string
{% endconfiguration %}
@ -1206,7 +1206,7 @@ Set the target humidity.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO humidifier entity. |
| `entity_id` | no | Only act on a specific Xiaomi humidifier entity. |
| `humidity` | no | Target humidity |
### Action `humidifier.set_mode`
@ -1215,8 +1215,8 @@ Set the humidifier operation mode.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO humidifier entity. |
| `mode` | no | The Xiaomi miIO operation mode |
| `entity_id` | no | Only act on a specific Xiaomi humidifier entity. |
| `mode` | no | The humidifier operation mode |
### Action `fan.set_percentage`
@ -1224,7 +1224,7 @@ Set the fan speed percentage.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| `entity_id` | no | Only act on a specific Xiaomi fan entity. |
| `percentage` | no | Fan speed. Percentage speed setting |
### Action `fan.set_preset_mode`
@ -1233,8 +1233,8 @@ Set the fan operation mode.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| `preset_mode` | no | The Xiaomi miIO operation mode |
| `entity_id` | no | Only act on a specific Xiaomi fan entity. |
| `preset_mode` | no | The fan operation mode |
### Action `xiaomi_miio.fan_reset_filter` (Air Purifier 2 only)
@ -1242,7 +1242,7 @@ Reset the filter lifetime and usage.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| `entity_id` | no | Only act on a specific Xiaomi fan entity. |
### Action `xiaomi_miio.fan_set_extra_features` (Air Purifier only)
@ -1250,7 +1250,7 @@ Set the extra features.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| `entity_id` | no | Only act on a specific Xiaomi fan entity. |
| `features` | no | Integer, known values are 0 and 1. |
## Xiaomi Air Quality Monitor
@ -1273,7 +1273,7 @@ Currently, the supported features are:
## Xiaomi IR Remote
The `xiaomi miio` remote platform allows you to send IR commands from your Xiaomi IR Remote (ChuangmiIr).
The remote platform allows you to send IR commands from your Xiaomi IR Remote (ChuangmiIr).
### Setup
@ -1830,7 +1830,7 @@ It seems to be the case that Numbers 1..15 are used to number the initial segmen
## Xiaomi Philips Light
The `xiaomi_miio` platform allows you to control the state of your Xiaomi Philips LED Ball Lamp, Xiaomi Philips Zhirui LED Bulb E14 Candle Lamp, Xiaomi Philips Zhirui Downlight, Xiaomi Philips LED Ceiling Lamp, Xiaomi Philips Eyecare Lamp 2, Xiaomi Philips Moonlight Bedside Lamp and Philips Zhirui Desk Lamp.
The Xiaomi Home light platform allows you to control the state of your Xiaomi Philips LED Ball Lamp, Xiaomi Philips Zhirui LED Bulb E14 Candle Lamp, Xiaomi Philips Zhirui Downlight, Xiaomi Philips LED Ceiling Lamp, Xiaomi Philips Eyecare Lamp 2, Xiaomi Philips Moonlight Bedside Lamp and Philips Zhirui Desk Lamp.
### Features
@ -1924,7 +1924,7 @@ Set one of the 4 available fixed scenes.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| `entity_id` | no | Only act on a specific Xiaomi light entity. |
| `scene` | no | Scene, between 1 and 4. |
### Action `xiaomi_miio.light_set_delayed_turn_off`
@ -1933,7 +1933,7 @@ Delayed turn off.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| `entity_id` | no | Only act on a specific Xiaomi light entity. |
| `time_period` | no | Time period for the delayed turn off. |
### Action `xiaomi_miio.light_reminder_on` (Eyecare Smart Lamp 2 only)
@ -1942,7 +1942,7 @@ Enable the eye fatigue reminder/notification.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| `entity_id` | no | Only act on a specific Xiaomi light entity. |
### Action `xiaomi_miio.light_reminder_off` (Eyecare Smart Lamp 2 only)
@ -1950,7 +1950,7 @@ Disable the eye fatigue reminder/notification.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| `entity_id` | no | Only act on a specific Xiaomi light entity. |
### Action `xiaomi_miio.light_night_light_mode_on` (Eyecare Smart Lamp 2 only)
@ -1958,7 +1958,7 @@ Turn the smart night light mode on.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| `entity_id` | no | Only act on a specific Xiaomi light entity. |
### Action `xiaomi_miio.light_night_light_mode_off` (Eyecare Smart Lamp 2 only)
@ -1966,7 +1966,7 @@ Turn the smart night light mode off.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| `entity_id` | no | Only act on a specific Xiaomi light entity. |
### Action `xiaomi_miio.light_eyecare_mode_on` (Eyecare Smart Lamp 2 only)
@ -1974,7 +1974,7 @@ Turn the eyecare mode on.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| `entity_id` | no | Only act on a specific Xiaomi light entity. |
### Action `xiaomi_miio.light_eyecare_mode_off` (Eyecare Smart Lamp 2 only)
@ -1982,11 +1982,11 @@ Turn the eyecare mode off.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| `entity_id` | no | Only act on a specific Xiaomi light entity. |
## Xiaomi Smart WiFi Socket and Smart Power Strip
The `xiaomi_miio` switch platform allows you to control the state of your Xiaomi Smart WiFi Socket aka Plug, Xiaomi Smart Power Strip and Xiaomi Chuangmi Plug V1.
The Xiaomi Home switch platform allows you to control the state of your Xiaomi Smart WiFi Socket aka Plug, Xiaomi Smart Power Strip and Xiaomi Chuangmi Plug V1.
### Features
@ -2038,7 +2038,7 @@ Turn the wifi LED on.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
| `entity_id` | no | Only act on a specific Xiaomi switch entity. |
### Action `xiaomi_miio.switch_set_wifi_led_off` (Power Strip only)
@ -2046,7 +2046,7 @@ Turn the wifi LED off.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
| `entity_id` | no | Only act on a specific Xiaomi switch entity. |
### Action `xiaomi_miio.switch_set_power_price` (Power Strip)
@ -2054,7 +2054,7 @@ Set the power price.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
| `entity_id` | no | Only act on a specific Xiaomi switch entity. |
| `price` | no | Power price, between 0 and 999. |
### Action `xiaomi_miio.switch_set_power_mode` (Power Strip V1 only)
@ -2063,12 +2063,12 @@ Set the power mode.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
| `entity_id` | no | Only act on a specific Xiaomi switch entity. |
| `mode` | no | Power mode, valid values are 'normal' and 'green' |
## Retrieving the Access Token
Not recommended, please specify the cloud credentials during the config flow for easier setup.
Not recommended, please specify the Xiaomi account credentials during the config flow for easier setup.
However when setting up a device manually the token can be retrieved in one of the following ways.
### Xiaomi Cloud Tokens Extractor
@ -2192,7 +2192,7 @@ This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuu
### Miio command line tool
Use of Miio should be done before the Vacuum is connected to Mi Home. If you already connected to the app you will need to delete it and then join the ad-hoc Wi-Fi network the Vacuum creates. If the vacuum is already paired it's likely this method will only return `???` as your token.
Use of Miio should be done before the Vacuum is connected to Xiaomi Home. If you already connected to the app you will need to delete it and then join the ad-hoc Wi-Fi network the Vacuum creates. If the vacuum is already paired it's likely this method will only return `???` as your token.
Discovering devices on the current network: