home-assistant.github.io/source/_components/fan.xiaomi_miio.markdown

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_version	ha_iot_class
page	Xiaomi Air Purifier 2	Instructions how to integrate your Xiaomi Air Purifier 2 within Home Assistant.	2017-10-13 12:35	true	false	true	true	xiaomi.png	Fan	0.57	Local Polling

The xiaomi_miio fan platform allows you to control the Xiaomi Air Purifier 2, Air Purifier 2S and Air Purifier Pro.

Currently, the supported features are

• On, Off
• Operation modes (auto, silent, favorite, idle)
• Buzzer (on, off)
• Child lock (on, off)
• LED (on, off), LED brightness (bright, dim, off)
• Favorite Level (0...16)
• Attributes
  • power
  • aqi
  • average_aqi
  • humidity
  • temperature
  • mode
  • favorite_level
  • led
  • led_brightness
  • buzzer
  • child_lock
  • purify_volume
  • filter_life_remaining
  • filter_hours_used
  • motor_speed

{% linkable_title Setup %}

Please follow the instructions on Retrieving the Access Token to get the API token to use in the configuration.yaml file.

To add a Xiaomi Air Purifier to your installation, add the following to your configuration.yaml file:

fan:
  - platform: xiaomi_miio
    name: Xiaomi Air Purifier 2
    host: 192.168.130.66
    token: YOUR_TOKEN

Configuration variables:

• host (Required): The IP of your plug.
• token (Required): The API token of your plug.
• name (Optional): The name of your plug.

{% linkable_title Platform Services %}

Service fan/xiaomi_miio_set_buzzer_on

Turn the buzzer on.

Service data attribute	Optional	Description
entity_id	yes	Only act on a specfici air purifier. Else targets all.

Service fan/xiaomi_miio_set_buzzer_off

Turn the buzzer off.

Service data attribute	Optional	Description
entity_id	yes	Only act on a specfici air purifier. Else targets all.

Service fan/xiaomi_miio_set_led_on

Turn the led on.

Service data attribute	Optional	Description
entity_id	yes	Only act on a specfici air purifier. Else targets all.

Service fan/xiaomi_miio_set_led_off

Turn the led off.

Service data attribute	Optional	Description
entity_id	yes	Only act on a specfici air purifier. Else targets all.

Service fan/xiaomi_miio_set_child_lock_on

Turn the child lock on.

Service data attribute	Optional	Description
entity_id	yes	Only act on a specfici air purifier. Else targets all.

Service fan/xiaomi_miio_set_child_lock_off

Turn the child lock off.

Service data attribute	Optional	Description
entity_id	yes	Only act on a specfici air purifier. Else targets all.

Service fan/xiaomi_miio_set_led_brightness

Set the led brightness. Supported values are 0 (Bright), 1 (Dim), 2 (Off).

Service data attribute	Optional	Description
entity_id	yes	Only act on a specfici air purifier. Else targets all.
brightness	no	Brightness, between 0 and 2.

Service fan/xiaomi_miio_set_favorite_level

Set the favorite level of the operation mode "favorite".

Service data attribute	Optional	Description
entity_id	yes	Only act on a specfici air purifier. Else targets all.
level	no	Level, between 0 and 16.