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-15 13:26:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up the documentation of Xiaomi Miio fans and humidifiers (#19077)

Browse Source
This commit is contained in:
Maciej Bieniek 2021-08-25 13:12:58 +02:00 committed by GitHub
parent 94d7bf171b
commit 2134d11680
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 291 additions and 237 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

528
source/_integrations/xiaomi_miio.markdown
View File

@ -208,6 +208,7 @@ Supported devices:
| Air Purifier Super 2 | zhimi.airpurifier.sa2 | |
| Air Purifier 3 (2019) | zhimi.airpurifier.ma4 | |
| Air Purifier 3H (2019) | zhimi.airpurifier.mb3 | |
| Air Fresh VA2 | zhimi.airfresh.va2 | |
| Air Humidifier | zhimi.humidifier.v1 | |
| Air Humidifier CA1 | zhimi.humidifier.ca1 | |
| Air Humidifier CA4 | zhimi.humidifier.ca4 | |
@ -215,7 +216,6 @@ Supported devices:
| Air Humidifier JSQ | deerma.humidifier.jsq | |
| Air Humidifier JSQ1 | deerma.humidifier.jsq1 | |
| Air Humidifier MJJSQ | deerma.humidifier.mjjsq| |
| Air Fresh VA2 | zhimi.airfresh.va2 | |
### Features
@ -224,7 +224,7 @@ Supported devices:
- Power (on, off)
- Operation modes (Auto, Silent, Favorite, Idle)
- Attributes
- Attributes (fan platform)
- `model`
- `mode`
- `sleep_time`
@ -238,33 +238,34 @@ Supported devices:
Number | Description
----------------------- | -----------------------
Favorite Level | Set the `favorite_level`
Favorite Level | Set the favorite level
- Sensor entities
Sensor | Description
----------------------- | -----------------------
`aqi` | The current `aqi` measured
`filter_life_remaining` | The remaining life of the filter
`humidity` | The current `humidity` measured
`motor_speed` | The current `motor_speed` measured in rpm
`purify_volume` | The volume of purified air in qubic meter
`temperature` | The current `temperature` measured
Filter Life Remaining | The remaining life of the filter
Filter Use | Filter usage time in hours
Humidity | The current humidity measured
Motor Speed | The current motor speed measured in rpm
PM2.5 | The current particulate matter 2.5 measured
Purify Volume | The volume of purified air in qubic meter
Temperature | The current temperature measured
- Switch entities
Switch | Description
----------------------- | -----------------------
Buzzer | Turn on/off `buzzer`
Child Lock | Turn on/off `child lock`
Learn Mode | Turn on/off `learn mode`
LED | Turn on/off `led`
Buzzer | Turn on/off the buzzer
Child Lock | Turn on/off the child lock
Learn Mode | Turn on/off the learn mode
LED | Turn on/off the LED
### Air Purifier Pro (zhimi.airpurifier.v6)
- Power (on, off)
- Operation modes (Auto, Silent, Favorite)
- Attributes
- Attributes (fan platform)
- `model`
- `mode`
- `sleep_time`
@ -278,35 +279,36 @@ LED | Turn on/off `led`
Number | Description
----------------------- | -----------------------
Favorite Level | Set the `favorite_level`
Volume | Set the `volume`
Favorite Level | Set the favorite level
Volume | Set the volume
- Sensor entities
Sensor | Description
----------------------- | -----------------------
`aqi` | The current `aqi` measured
`filter_life_remaining` | The remaining life of the filter
`humidity` | The current `humidity` measured
`illuminance` | The current `illuminance` measured
`motor_speed` | The current `motor_speed` measured in rpm
`motor2_speed` | The current `motor2_speed` measured in rpm
`purify_volume` | The volume of purified air in qubic meter
`temperature` | The current `temperature` measured
Filter Life Remaining | The remaining life of the filter
Filter Use | Filter usage time in hours
Humidity | The current humidity measured
Illuminance | The current illuminance measured
Motor Speed | The current motor speed measured in rpm
PM2.5 | The current particulate matter 2.5 measured
Purify Volume | The volume of purified air in qubic meter
Second Motor Speed | The current second motor speed measured in rpm
Temperature | The current temperature measured
- Switch entities
Switch | Description
----------------------- | -----------------------
Child Lock | Turn on/off `child lock`
Learn Mode | Turn on/off `learn mode`
LED | Turn on/off `led`
Child Lock | Turn on/off the child lock
Learn Mode | Turn on/off the learn mode
LED | Turn on/off the LED
### Air Purifier Pro V7 (zhimi.airpurifier.v7)
- Power (on, off)
- Operation modes (Auto, Silent, Favorite)
- Attributes
- Attributes (fan platform)
- `model`
- `mode`
- `extra_features`
@ -316,34 +318,35 @@ LED | Turn on/off `led`
Number | Description
----------------------- | -----------------------
Favorite Level | Set the `favorite_level`
Volume | Set the `volume`
Favorite Level | Set the favorite level
Volume | Set the volume
- Sensor entities
Sensor | Description
----------------------- | -----------------------
`aqi` | The current `aqi` measured
`filter_life_remaining` | The remaining life of the filter
`humidity` | The current `humidity` measured
`illuminance` | The current `illuminance` measured
`motor_speed` | The current `motor_speed` measured in rpm
`motor2_speed` | The current `motor2_speed` measured in rpm
`temperature` | The current `temperature` measured
Filter Life Remaining | The remaining life of the filter
Filter Use | Filter usage time in hours
Humidity | The current humidity measured
Illuminance | The current illuminance measured
Motor Speed | The current motor speed measured in rpm
PM2.5 | The current particulate matter 2.5 measured
Second Motor Speed | The current second motor speed measured in rpm
Temperature | The current temperature measured
- Switch entities
Switch | Description
----------------------- | -----------------------
Child Lock | Turn on/off `child lock`
Learn Mode | Turn on/off `learn mode`
LED | Turn on/off `led`
Child Lock | Turn on/off the child lock
Learn Mode | Turn on/off the learn mode
LED | Turn on/off the LED
### Air Purifier 2S (zhimi.airpurifier.mc1)
- Power (on, off)
- Operation modes (Auto, Silent, Favorite)
- Attributes
- Attributes (fan platform)
- `model`
- `mode`
- `extra_features`
@ -353,25 +356,27 @@ LED | Turn on/off `led`
Number | Description
----------------------- | -----------------------
Favorite Level | Set the `favorite_level`
Favorite Level | Set the favorite level
- Sensor entities
Sensor | Description
----------------------- | -----------------------
`aqi` | The current `aqi` measured
`filter_life_remaining` | The remaining life of the filter
`humidity` | The current `humidity` measured
`motor_speed` | The current `motor_speed` measured in rpm
`temperature` | The current `temperature` measured
Filter Life Remaining | The remaining life of the filter
Filter Use | Filter usage time in hours
Humidity | The current humidity measured
Motor Speed | The current motor speed measured in rpm
PM2.5 | The current particulate matter 2.5 measured
Temperature | The current temperature measured
- Switch entities
Switch | Description
----------------------- | -----------------------
Buzzer | Turn on/off `buzzer`
Child Lock | Turn on/off `child lock`
LED | Turn on/off `led`
Buzzer | Turn on/off the buzzer
Child Lock | Turn on/off the child lock
Learn Mode | Turn on/off the learn mode
LED | Turn on/off the LED
### Air Purifier 3/3H (2019) (zhimi.airpurifier.ma4/zhimi.airpurifier.mb3)
@ -379,7 +384,7 @@ This model uses newer MiOT communication protocol.
- Power (on, off)
- Operation modes (Auto, Silent, Favorite, Fan)
- Attributes
- Attributes (fan platform)
- `model`
- `mode`
- `use_time`
@ -387,52 +392,41 @@ This model uses newer MiOT communication protocol.
Number | Description
----------------------- | -----------------------
Fan Level | Set the `fan_level`
Favorite Level | Set the `favorite_level`
Fan Level | Set the fan level
Favorite Level | Set the favorite level
- Select entities
Select | Description
----------------------- | -----------------------
LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
- Sensor entities
Sensor | Description
----------------------- | -----------------------
`aqi` | The current `aqi` measured
`filter_life_remaining` | The remaining life of the filter
`humidity` | The current `humidity` measured
`motor_speed` | The current `motor_speed` measured in rpm
`purify_volume` | The volume of purified air in qubic meter
`temperature` | The current `temperature` measured
- Select entities
Select | Description
--- | ---
`led brightness` | Controls the brightness of the LEDs (bright, dim, off)
Filter Life Remaining | The remaining life of the filter
Filter Use | Filter usage time in hours
Humidity | The current humidity measured
Motor Speed | The current motor speed measured in rpm
PM2.5 | The current particulate matter 2.5 measured
Purify Volume | The volume of purified air in qubic meter
Temperature | The current temperature measured
- Switch entities
Switch | Description
----------------------- | -----------------------
Buzzer | Turn on/off `buzzer`
Child Lock | Turn on/off `child lock`
Buzzer | Turn on/off the buzzer
Child Lock | Turn on/off the child lock
### Air Purifier V3 (zhimi.airpurifier.v3)
- Power (on, off)
- Operation modes (Auto, Silent, Favorite, Idle, Medium, High, Strong)
- Attributes
- Attributes (fan platform)
- `model`
- `aqi`
- `mode`
- `illuminance`
- `filter_hours_used`
- `filter_life_remaining`
- `motor_speed`
- `average_aqi`
- `volume`
- `motor2_speed`
- `filter_rfid_product_id`
- `filter_rfid_tag`
- `filter_type`
- `purify_volume`
- `sleep_time`
- `sleep_mode_learn_count`
- `extra_features`
@ -442,12 +436,48 @@ Child Lock | Turn on/off `child lock`
Sensor | Description
----------------------- | -----------------------
`aqi` | The current `aqi` measured
`illuminance` | The current `illuminance` measured
`filter_life_remaining` | The remaining life of the filter
`motor_speed` | The current `motor_speed` measured in rpm
`motor2_speed` | The current `motor2_speed` measured in rpm
`purify_volume` | The volume of purified air in qubic meter
PM2.5 | The current particulate matter 2.5 measured
Illuminance | The current illuminance measured
Filter Life Remaining | The remaining life of the filter
Filter Use | Filter usage time in hours
Motor Speed | The current motor speed measured in rpm
Second Motor Speed | The current second motor speed measured in rpm
Purify Volume | The volume of purified air in qubic meter
- Switch entities
Switch | Description
----------------------- | -----------------------
Buzzer | Turn on/off the buzzer
Child Lock | Turn on/off the child lock
LED | Turn on/off the LED
### Air Fresh VA2
- Power (on, off)
- Operation modes (Auto, Silent, Interval, Low, Middle, Strong)
- Attributes (fan platform)
- `model`
- `mode`
- `use_time`
- `extra_features`
- Sensor entities
Sensor | Description
----------------------- | -----------------------
Carbon Dioxide | The current carbon dioxide measured in ppm
Filter Life Remaining | The remaining life of the filter
Filter Use | Filter usage time in hours
Humidity | The current humidity measured
Illuminance | The current illuminance measured
PM2.5 | The current particulate matter 2.5 measured
Temperature | The current temperature measured
- Select entities
Select | Description
----------------------- | -----------------------
LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
- Switch entities
@ -461,82 +491,137 @@ LED | Turn on/off `led`
- On, Off
- Operation modes (Silent, Medium, High, Strong)
- Buzzer (on, off)
- Child lock (on, off)
- LED (on, off), LED brightness (bright, dim, off)
- Target humidity (30, 40, 50, 60, 70, 80)
- Attributes (humidifier platform)
Attribute | Description
--- | ---
`humidity` | The current `target_humidity`
`max_humidity` | The maximum settable `target_humidity`
`min_humidity` | The minimum settable `target_humidity`
`available_modes` | A list with the operation modes available
`mode` | the current operation mode selected
Attribute | Description
----------------------- | -----------------------
`available_modes` | A list with the operation modes available
`humidity` | The current target humidity
`max_humidity` | The maximum settable target humidity
`min_humidity` | The minimum settable target humidity
`mode` | The current operation mode selected
- Binary sensor entities
Binary sensor | Description
----------------------- | -----------------------
Water Tank | Indicates whether the water tank is connected or not
- Select entities
Select | Description
----------------------- | -----------------------
LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
- Sensor entities
Sensor | Description
--- | ---
`humidity` | The current `humidity` measured
`temperature` | The current `temperature` measured
Sensor | Description
----------------------- | -----------------------
Humidity | The current humidity measured
Temperature | The current temperature measured
Water Level | The current water level percentage measured
- Switch entities
Switch | Description
----------------------- | -----------------------
Buzzer | Turn on/off the buzzer
Child Lock | Turn on/off the child lock
### Air Humidifier CA (zhimi.humidifier.ca1)
- On, Off
- Operation modes (Silent, Medium, High, Auto)
- Buzzer (on, off)
- Child lock (on, off)
- LED brightness (bright, dim, off)
- Target humidity (30, 40, 50, 60, 70, 80)
- Dry mode (on, off)
- Attributes (humidifier platform)
Attribute | Description
--- | ---
`humidity` | The current `target_humidity`
`max_humidity` | The maximum settable `target_humidity`
`min_humidity` | The minimum settable `target_humidity`
`available_modes` | A list with the operation modes available
`mode` | the current operation mode selected
Attribute | Description
----------------------- | -----------------------
`available_modes` | A list with the operation modes available
`humidity` | The current target humidity
`max_humidity` | The maximum settable target humidity
`min_humidity` | The minimum settable target humidity
`mode` | The current operation mode selected
- Binary sensor entities
Binary sensor | Description
----------------------- | -----------------------
Water Tank | Indicates whether the water tank is connected or not
- Select entities
Select | Description
----------------------- | ---
LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
- Sensor entities
Sensor | Description
--- | ---
`humidity` | The current `humidity` measured
`temperature` | The current `temperature` measured
----------------------- | -----------------------
Humidity | The current humidity measured
Temperature | The current temperature measured
Water Level | The current water level percentage measured
- Switch entities
Switch | Description
----------------------- | -----------------------
Buzzer | Turn on/off the buzzer
Child Lock | Turn on/off the child lock
Dry Mode | Turn on/off the dry mode
### Air Humidifier CA (zhimi.humidifier.ca4)
- On, Off
- Operation modes (Auto, Low, Medium, High)
- Buzzer (on, off)
- Child lock (on, off)
- LED brightness (off, dim, bright)
- Target humidity (30 - 80)
- Clean mode (on, off)
- Dry mode (on, off)
- Motor speed rpm (200 - 2000)
- Attributes (humidifier platform)
Attribute | Description
--- | ---
`humidity` | The current `target_humidity`
`max_humidity` | The maximum settable `target_humidity`
`min_humidity` | The minimum settable `target_humidity`
`available_modes` | A list with the operation modes available
`mode` | the current operation mode selected
Attribute | Description
----------------------- | -----------------------
`available_modes` | A list with the operation modes available
`humidity` | The current target humidity
`max_humidity` | The maximum settable target humidity
`min_humidity` | The minimum settable target humidity
`mode` | The current operation mode selected
- Binary sensor entities
Binary sensor | Description
----------------------- | -----------------------
Water Tank | Indicates whether the water tank is connected or not
- Number entities
Number | Description
----------------------- | -----------------------
Motor Speed | Set the motor speed
- Select entities
Select | Description
----------------------- | -----------------------
LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
- Sensor entities
Sensor | Description
--- | ---
`actual_speed` | The current `motor_speed` measured in (rpm)
`humidity` | The current `humidity` percentage measured
`temperature` | The current `temperature` measured in degrees Celius
`water_level` | The current `water_level` percentage measured
Sensor | Description
----------------------- | -----------------------
Actual Speed | The current motor speed measured in rpm
Humidity | The current humidity measured
Temperature | The current temperature measured
Water Level | The current water level percentage measured
- Switch entities
Switch | Description
----------------------- | -----------------------
Buzzer | Turn on/off the buzzer
Child Lock | Turn on/off the child lock
Clean Mode | Turn on/off the clean mode
Dry Mode | Turn on/off the dry mode
<div class='note'>
Clean mode and Motor speed can only be set when the device is turned on.
@ -546,97 +631,100 @@ Clean mode and Motor speed can only be set when the device is turned on.
- On, Off
- Operation modes (Silent, Medium, High, Auto)
- Buzzer (on, off)
- Child lock (on, off)
- LED (on, off), LED brightness (bright, dim, off)
- Target humidity (30, 40, 50, 60, 70, 80)
- Dry mode (on, off)
- Attributes (humidifier platform)
Attribute | Description
--- | ---
`humidity` | The current `target_humidity`
`max_humidity` | The maximum settable `target_humidity`
`min_humidity` | The minimum settable `target_humidity`
`available_modes` | A list with the operation modes available
`mode` | the current operation mode selected
Attribute | Description
----------------------- | -----------------------
`available_modes` | A list with the operation modes available
`humidity` | The current target humidity
`max_humidity` | The maximum settable target humidity
`min_humidity` | The minimum settable target humidity
`mode` | The current operation mode selected
- Sensor entities
- Binary sensor entities
Sensor | Description
--- | ---
`humidity` | The current `humidity` measured
`temperature` | The current `temperature` measured
Binary sensor | Description
----------------------- | -----------------------
Water Tank | Indicates whether the water tank is connected or not
### Air Humidifier JSQ/JSQ1/MJJSQ (deerma.humidifier.jsq/deerma.humidifier.jsq1/deerma.humidifier.mjjsq)
- Select entities
- On, Off
- Operation modes (low, medium, high, humidity)
- Buzzer (on, off)
- LED (on, off)
- Target humidity (30, 40, 50, 60, 70, 80)
- Sensor entities
- `humidity`
- `temperature`
Select | Description
----------------------- | -----------------------
LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
### Air Fresh VA2
- Power (on, off)
- Operation modes (Auto, Silent, Interval, Low, Middle, Strong)
- Attributes
- `model`
- `aqi`
- `average_aqi`
- `temperature`
- `humidity`
- `co2`
- `mode`
- `filter_life_remaining`
- `filter_hours_used`
- `use_time`
- `motor_speed`
- `extra_features`
- Sensor entities
Sensor | Description
----------------------- | -----------------------
`aqi` | The current `aqi` measured
`carbon_dioxide` | The current `carbon_dioxide` measured
`filter_life_remaining` | The remaining life of the filter
`humidity` | The current `humidity` measured
`illuminance` | The current `illuminance` measured
`temperature` | The current `temperature` measured
- Select entities
Select | Description
--- | ---
`led brightness` | Controls the brightness of the LEDs (bright, dim, off)
Humidity | The current humidity measured
Temperature | The current temperature measured
Water Level | The current water level percentage measured
- Switch entities
Switch | Description
----------------------- | -----------------------
Buzzer | Turn on/off `buzzer`
Child Lock | Turn on/off `child lock`
LED | Turn on/off `led`
Buzzer | Turn on/off the buzzer
Child Lock | Turn on/off the child lock
Dry Mode | Turn on/off the dry mode
### Air Humidifier JSQ/JSQ1/MJJSQ (deerma.humidifier.jsq/deerma.humidifier.jsq1/deerma.humidifier.mjjsq)
- On, Off
- Operation modes (low, medium, high, humidity)
- Target humidity (30, 40, 50, 60, 70, 80)
- Attributes (humidifier platform)
Attribute | Description
----------------------- | -----------------------
`available_modes` | A list with the operation modes available
`humidity` | The current target humidity
`max_humidity` | The maximum settable target humidity
`min_humidity` | The minimum settable target humidity
`mode` | The current operation mode selected
- Binary sensor entities
Binary sensor | Description
----------------------- | -----------------------
Water Tank | Indicates whether the water tank is connected or not
Water Tank Empty | Indicates whether the water tank is empty or not
- Sensor entities
Sensor | Description
----------------------- | -----------------------
Humidity | The current humidity measured
Temperature | The current temperature measured
- Switch entities
Switch | Description
----------------------- | -----------------------
Buzzer | Turn on/off the buzzer
LED | Turn on/off the LED
### Platform Services
<div class='note'>
For supported Air Humidifiers additional entities for will be generated automatically (if supported) and added to the entity registry based on the platforms:
<br></br>
The sensor platform does not supply additional services.
</div>
### Service `humidifier.set_humidity`
| Platform | Service(s) | Related auto generated device entities |
|-----------------|----------------------------|--------------------------------------------------------------|
| `humidifier` | `set_humidity`, `set_mode` | Main device entity |
| `switch` | `turn_on`, `turn_off` | `buzzer`, `child_lock`, `cleaning_mode`, `dry_mode` and `led`|
| `sensor` | _None_ | `actual_speed`, `humidity`, `temperature` and `water_level` |
| `number` | `set_value` | `motor_speed` |
| `select` | `select_option` | `led_brightness` |
| `binary_sensor` | _None_ | `water_tank_empty` and `water_tank_detached` |
Set the target humidity.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------|
| `entity_id` | no | Only act on a specific Xiaomi miIO humidifier entity. |
| `humidity` | no | Target humidity |
### Service `humidifier.set_mode`
Set the humidifier operation mode.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------|
| `entity_id` | no | Only act on a specific Xiaomi miIO humidifier entity. |
| `mode` | no | The Xiaomi miIO operation mode |
### Service `fan.set_percentage`
@ -656,31 +744,6 @@ Set the fan operation mode.
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| `preset_mode` | no | The Xiaomi miIO operation mode |
### Service `switch.turn_on` (Air Humidifiers only)
Turn the `buzzer`, `child_lock`, `cleaning_mode` or `dry_mode` on.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------|
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
### Service `switch.turn_off` (Air Humidifiers only)
Turn `buzzer`, `child_lock`, `clean_mode` or `dry_mode` on.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------|
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
### Service `select.select_option` (Air Humidifiers only)
Set the LED brightness. Supported values are 'Bright', 'Dim', 'Off'.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------|
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| `option` | no | Brightness option. Should be 'Bright', 'Dim' or 'Off' |
### Service `xiaomi_miio.fan_reset_filter` (Air Purifier 2 only)
Reset the filter lifetime and usage.
@ -698,15 +761,6 @@ Set the extra features.
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| `features` | no | Integer, known values are 0 and 1. |
### Service `number.set_value` (Air Humidifier CA4)
Set motor speed RPM.
| Service data attribute | Optional | Description |
|---------------------------|----------|----------------------------------------------------------|
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| `value` | no | Motor speed RPM. Allowed values are between 200 and 2000 |
### Troubleshooting `Unable to find device` error messages
Check if the device is in the same subnet as the Home Assistant instance. Otherwise, you should configure your router/firewall to put this device in the same VLAN as the Home Assistant instance.