This is a custom component for home assistant to integrate the Xiaomi Mi Air Purifier 2, Air Purifier 2S, Air Purifier Pro, Air Humidifier, Air Fresh and Pedestal Fan.

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

Credits: Thanks to Rytilahti for all the work.

This custom component is more or less the beta version of the official component. Furthermore, this custom component supports a number of additional devices which cannot be merged into the official component at the moment. The handling/values of the fan_speed property need to be refactored first because this and the official component don't align with some new architecture decisions.

Unsupported devices:

• Mijia Humidifer 4L (MJJSQ02LX): This device isn't smart / has no WiFi support.

• Power (on, off)
• Preset 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
  • model
  • temperature
  • humidity
  • aqi
  • mode
  • filter_hours_used
  • filter_life_remaining
  • favorite_level
  • child_lock
  • led
  • motor_speed
  • average_aqi
  • purify_volume
  • learn_mode
  • sleep_time
  • sleep_mode_learn_count
  • extra_features
  • turbo_mode_supported
  • auto_detect
  • use_time
  • button_pressed
  • buzzer
  • led_brightness
  • sleep_mode

• Power (on, off)
• Preset 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
  • model
  • temperature
  • humidity
  • aqi
  • mode
  • filter_hours_used
  • filter_life_remaining
  • favorite_level
  • child_lock
  • led
  • motor_speed
  • average_aqi
  • learn_mode
  • extra_features
  • turbo_mode_supported
  • buzzer
  • led_brightness

• Power (on, off)
• Preset modes (auto, silent, favorite)
• Child lock (on, off)
• LED (on, off)
• Favorite Level (0...16)
• Attributes
  • model
  • temperature
  • humidity
  • aqi
  • mode
  • filter_hours_used
  • filter_life_remaining
  • favorite_level
  • child_lock
  • led
  • motor_speed
  • average_aqi
  • purify_volume
  • learn_mode
  • sleep_time
  • sleep_mode_learn_count
  • extra_features
  • turbo_mode_supported
  • auto_detect
  • use_time
  • button_pressed
  • filter_rfid_product_id
  • filter_rfid_tag
  • filter_type
  • illuminance
  • motor2_speed
  • volume

• Power (on, off)
• Preset modes (auto, silent, favorite)
• Child lock (on, off)
• LED (on, off)
• Favorite Level (0...16)
• Attributes
  • model
  • temperature
  • humidity
  • aqi
  • mode
  • filter_hours_used
  • filter_life_remaining
  • favorite_level
  • child_lock
  • led
  • motor_speed
  • average_aqi
  • learn_mode
  • extra_features
  • turbo_mode_supported
  • button_pressed
  • filter_rfid_product_id
  • filter_rfid_tag
  • filter_type
  • illuminance
  • motor2_speed
  • volume

• Power (on, off)
• Preset modes (auto, silent, favorite)
• Buzzer (on, off)
• Child lock (on, off)
• LED (on, off)
• Favorite Level (0...16)
• Attributes
  • model
  • temperature
  • humidity
  • aqi
  • mode
  • filter_hours_used
  • filter_life_remaining
  • favorite_level
  • child_lock
  • led
  • motor_speed
  • average_aqi
  • learn_mode
  • extra_features
  • turbo_mode_supported
  • button_pressed
  • filter_rfid_product_id
  • filter_rfid_tag
  • filter_type
  • illuminance
  • buzzer

This model uses newer MiOT communication protocol.

• Power (on, off)
• Preset modes (auto, silent, favorite, fan)
• Buzzer (on, off)
• Child lock (on, off)
• LED (on, off)
• Favorite Level (0...16)
• Fan Level (1...3)
• Attributes
  • model
  • temperature
  • humidity
  • aqi
  • mode
  • filter_hours_used
  • filter_life_remaining
  • favorite_level
  • child_lock
  • led
  • motor_speed
  • average_aqi
  • purify_volume
  • use_time
  • buzzer
  • led_brightness
  • filter_rfid_product_id
  • filter_rfid_tag
  • filter_type
  • fan_level

• Power (on, off)
• Preset modes (auto, silent, favorite, idle, medium, high, strong)
• Child lock (on, off)
• LED (on, off)
• Attributes
  • model
  • aqi
  • mode
  • led
  • buzzer
  • child_lock
  • 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
  • learn_mode
  • sleep_time
  • sleep_mode_learn_count
  • extra_features
  • auto_detect
  • use_time
  • button_pressed

• On, Off
• Preset 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
  • model
  • temperature
  • humidity
  • mode
  • buzzer
  • child_lock
  • trans_level
  • target_humidity
  • led_brightness
  • button_pressed
  • use_time
  • hardware_version

• On, Off
• Preset 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
  • model
  • temperature
  • humidity
  • mode
  • buzzer
  • child_lock
  • trans_level
  • target_humidity
  • led_brightness
  • button_pressed
  • use_time
  • hardware_version
  • motor_speed
  • depth
  • dry

• On, Off
• Preset modes (auto, low, mid, high)
• Buzzer (on, off)
• Child lock (on, off)
• LED brightness (off, dim, bright)
• Target humidity (30 - 80)
• Dry mode (on, off)
• Clean mode (on, off)
• Motor speed rpm (200 - 2000)
• Attributes
  • model
  • temperature
  • humidity
  • mode
  • buzzer
  • child_lock
  • target_humidity
  • led_brightness
  • use_time
  • actual_speed
  • button_pressed
  • dry
  • fahrenheit
  • motor_speed
  • power_time
  • water_level
  • use_time
  • clean_mode

• On, Off
• Preset 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
  • speed
  • speed_list
  • model
  • temperature
  • humidity
  • mode
  • buzzer
  • child_lock
  • target_humidity
  • led_brightness
  • use_time
  • hardware_version
  • motor_speed
  • depth
  • dry
  • supported_features

• Power (on, off)
• Preset modes (Intelligent, Level1, Level2, Level3, Level4)
• Buzzer (on, off)
• Child lock (on, off)
• LED (on, off), LED brightness (high, low, off)
• Attributes
  • model
  • temperature
  • humidity
  • mode
  • buzzer
  • child_lock
  • led
  • led_brightness
  • no_water
  • lid_opened

• Power (on, off)
• Preset modes (auto, silent, interval, low, middle, strong)
• Buzzer (on, off)
• Child lock (on, off)
• LED (on, off), LED brightness (bright, dim, off)
• PTC (on, off) (zhimi.airfresh.va4 only)
• Attributes
  • model
  • aqi
  • average_aqi
  • temperature
  • humidity
  • co2
  • mode
  • led
  • led_brightness
  • buzzer
  • child_lock
  • filter_life_remaining
  • filter_hours_used
  • use_time
  • motor_speed
  • extra_features
  • ptc (zhimi.airfresh.va4 only)
  • ntc_temperature (zhimi.airfresh.va4 only)

This paragraph was moved to docs/dmaker-airfresh-t2017.md.

• Power (on, off)
• Preset modes (low, medium, high, humidity)
• Buzzer (on, off)
• LED (on, off)
• Target humidity (0...99)
• Wet protection (on, off) (deerma.humidifier.jsq1 only)
• Attributes
  • model
  • temperature
  • humidity
  • mode
  • buzzer
  • target_humidity
  • led
  • no_water
  • water_tank_detached
  • wet_protection (deerma.humidifier.jsq1 only)

• HVAC mode (dry, off)
• Preset modes (on, auto, dryCloth)
• Target humidity (40, 50, 60)
• Fan mode (sleep, low, medium, high, strong)
• Buzzer (on, off)
• Child lock (on, off)
• LED (on, off)
• Attributes
  • model
  • _current_temperature
  • humidity
  • mode
  • buzzer
  • child_lock
  • target_humidity
  • led
  • fan_speed
  • tank_full
  • compressor_status
  • defrost_status
  • fan_st
  • alarm

• Power (on, off)
• Preset modes (Level 1, Level 2, Level 3, Level 4)
• Speed percentage (0...100)
• Oscillate (on, off)
• Oscillation angle (30, 60, 90, 120, 140, 150)
• Natural mode (on, off)
• Rotate by 5 degrees (left, right)
• Child lock (on, off)
• LED brightness (bright, dim, off)
• Attributes
  • model
  • temperature (zhimi.fan.v2 and v3 only)
  • humidity (zhimi.fan.v2 and v3 only)
  • led_brightness
  • buzzer
  • child_lock
  • natural_level
  • oscillate
  • delay_off_countdown
  • speed
  • direct_speed
  • natural_speed
  • angle
  • use_time
  • ac_power
  • battery (zhimi.fan.v2 and v3 only)
  • battery_charge (zhimi.fan.v2 & v3 only)
  • button_pressed (zhimi.fan.v2 & v3 only)
  • led (zhimi.fan.v2 only)
  • battery_state (zhimi.fan.v2 only)

• Power (on, off)

• Operation modes (manual, sleep, strong, natural)

• Preset modes (Level 1, Level 2, Level 3, Level 4)

• Speed percentage (0...100)

• Oscillate (on, off)

• Buzzer (on, off)

• Delayed turn off (minutes)

• Attributes

  • model
  • mode
  • speed
  • buzzer
  • oscillate
  • delay_off_countdown
  • error_detected

You can install this custom component via HACS. Search for for 'Xiaomi Mi Air Purifier and Xiaomi Mi Air Humidifier Integration' at the integration page of HACS. Alternatively, you can install it manually by copying the custom_compon ent folder to your Home Assistant configuration folder.

As next step you have to setup the custom component at your configuration.yaml. This custom component doesn't provide a config-flow right now. A restart of Home Assistant is required afterwards.

# configuration.yaml

fan:
  - platform: xiaomi_miio_airpurifier
    name: Xiaomi Air Purifier 2
    host: 192.168.130.71
    token: b7c4a758c251955d2c24b1d9e41ce47d
    model: zhimi.airpurifier.m1

  - platform: xiaomi_miio_airpurifier
    name: Xiaomi Air Purifier Pro
    host: 192.168.130.73
    token: 70924d6fa4b2d745185fa4660703a5c0
    model: zhimi.airpurifier.v6

  - platform: xiaomi_miio_airpurifier
    name: Xiaomi Air Humidifier
    host: 192.168.130.72
    token: 2b00042f7481c7b056c4b410d28f33cf
    model: zhimi.humidifier.v1

  - platform: xiaomi_miio_airpurifier
    name: Xiaomi Air Fresh
    host: 192.168.130.74
    token: 91d89cf53c4090f4c653174f6737102f
    model: zhimi.airfresh.va2

  - platform: xiaomi_miio_airpurifier
    name: Xiaomi Smart Fan
    host: 192.168.130.75
    token: b7c4a758c251955d2c24b1d9e41ce4ff

climate:
  - platform: xiaomi_miio_airpurifier
    name: Xiaomi Air Dehumidifier
    host: 192.168.130.76
    token: 86c4c41dc7af0e0520e170c8a1f92f62

Configuration variables:

• host (Required): The IP of your light.
• token (Required): The API token of your light.
• name (Optional): The name of your light.
• model (Optional): The model of your device. This setting can be used to bypass the device model detection and is recommended if your device isn't always available.

If your entity has another name the value xiaomi_air_purifier and xiaomi_air_humidifier must be updated.

# configuration.yaml

sensor:
  - platform: template
    sensors:
      airpurifier_aqi:
        friendly_name: Air Purifier Air Quality Index
        value_template: '{{ states.fan.xiaomi_air_purifier.attributes.aqi }}'
        icon_template: mdi:weather-windy
      airpurifier_temperature:
        friendly_name: Air Purifier Temperature
        value_template: '{{ states.fan.xiaomi_air_purifier.attributes.temperature }}'
        unit_of_measurement: '°C'
      airpurifier_humidity:
        friendly_name: Air Purifier Humidity
        value_template: '{{ states.fan.xiaomi_air_purifier.attributes.humidity }}'
        unit_of_measurement: '%'
        icon_template: mdi:water-percent

      airhumidifier_temperature:
        friendly_name: Air Humidifier Temperature
        value_template: '{{ states.fan.xiaomi_air_humidifier.attributes.temperature }}'
        unit_of_measurement: '°C'
      airhumidifier_humidity:
        friendly_name: Air Humidifier Humidity
        value_template: '{{ states.fan.xiaomi_air_humidifier.attributes.humidity }}'
        unit_of_measurement: '%'
        icon_template: mdi:water-percent

switch:
  - platform: template
    switches:
      xiaomi_airpurifier_child_lock:
        friendly_name: "Child lock"
        value_template: "{{ is_state_attr('fan.xiaomi_air_purifier', 'child_lock', True) }}"
        turn_on:
          service: xiaomi_miio_airpurifier.fan_set_child_lock_on
          data:
            entity_id: fan.xiaomi_air_purifier
        turn_off:
          service: xiaomi_miio_airpurifier.fan_set_child_lock_off
          data:
            entity_id: fan.xiaomi_air_purifier
        icon_template: "mdi:lock-outline"

      xiaomi_airpurifier_buzzer:
        friendly_name: "Buzzer"
        value_template: "{{ is_state_attr('fan.xiaomi_air_purifier', 'buzzer', True) }}"
        turn_on:
          service: xiaomi_miio_airpurifier.fan_set_buzzer_on
          data:
            entity_id: fan.xiaomi_air_purifier
        turn_off:
          service: xiaomi_miio_airpurifier.fan_set_buzzer_off
          data:
            entity_id: fan.xiaomi_air_purifier
        icon_template: "mdi:volume-off"

      xiaomi_airpurifier_led:
        friendly_name: "LED"
        value_template: "{{ is_state_attr('fan.xiaomi_air_purifier', 'led', True) }}"
        turn_on:
          service: xiaomi_miio_airpurifier.fan_set_led_on
          data:
            entity_id: fan.xiaomi_air_purifier
        turn_off:
          service: xiaomi_miio_airpurifier.fan_set_led_off
          data:
            entity_id: fan.xiaomi_air_purifier
        icon_template: "mdi:lightbulb-outline"

input_select:
  airpurifier_mode:
    name: Operation mode
    options:
     - Low
     - Medium
     - High
     - Humidity

automation:
  - alias: Select operation mode by input select
    trigger:
      entity_id: input_select.airpurifier_mode
      platform: state
    action:
      service: fan.set_speed
      data_template:
        entity_id: fan.xiaomi_air_purifier
        speed: '{{ states.input_select.airpurifier_mode.state }}'

  - alias: Monitor operation mode and update input select
    trigger:
      platform: state
      entity_id: fan.xiaomi_air_purifier
    action:
      service: input_select.select_option
      entity_id: input_select.airpurifier_mode
      data_template:
        option: '{{ states.fan.xiaomi_air_purifier.attributes.speed }}'

sensor:
  - platform: template
    sensors:
      airpurifier_favorite_level:
        friendly_name: Favorite level
        value_template: '{{ states.fan.xiaomi_air_purifier.attributes.favorite_level }}'

input_number:
  airpurifier_favorite_level:
    name: Favorite Level
    initial: 1
    min: 0
    max: 16
    step: 1

automation:
  - alias: Select favorite level by slider
    trigger:
      platform: state
      entity_id: input_number.airpurifier_favorite_level
    action:
      - service: xiaomi_miio_airpurifier.fan_set_favorite_level
        data_template:
          entity_id: fan.xiaomi_air_purifier
          level: '{{ states.input_number.airpurifier_favorite_level.state|int }}'

  - alias: Monitor favorite level and update slider
    trigger:
      platform: state
      entity_id: sensor.airpurifier_favorite_level
    action:
      service: input_number.set_value
      entity_id: input_number.airpurifier_favorite_level
      data_template:
        value: '{{ states.fan.xiaomi_air_purifier.attributes.favorite_level }}'

The following example can be used to setup a input_numer entity to control the target humidity of an Air Humidifier. Make sure to replace all occurrences of fan.xiaomi_air_humidifier with the entity_id of your device.

sensor:
  - platform: template
    sensors:
      airhumidifier_target_humidity:
        friendly_name: Target humidity
        value_template: '{{ states.fan.xiaomi_air_humidifier.attributes.target_humidity }}'
        unit_of_measurement: '%'
        icon_template: mdi:water-percent

input_number:
  airhumidifier_target_humidity:
    name: Target humidity
    min: 1
    max: 99
    step: 1

automation:
  - alias: Select target humidity by slider
    trigger:
      platform: state
      entity_id: input_number.airhumidifier_target_humidity
    action:
      - service: xiaomi_miio_airpurifier.fan_set_target_humidity
        data_template:
          entity_id: fan.xiaomi_air_humidifier
          humidity: '{{ states.input_number.airhumidifier_target_humidity.state|int }}'

  - alias: Monitor target humidity and update slider
    trigger:
      platform: state
      entity_id: sensor.airhumidifier_target_humidity
    action:
      service: input_number.set_value
      entity_id: input_number.airhumidifier_target_humidity
      data_template:
        value: '{{ states.fan.xiaomi_air_humidifier.attributes.target_humidity }}'

If the custom component doesn't work out of the box for your device please update your configuration to increase the log level:

logger:
  default: warn
  logs:
    custom_components.xiaomi_miio_airpurifier: debug
    miio: debug

Set the fan operation/preset mode.

Set the fan speed percentage.

Turn the buzzer on.

Turn the buzzer off.

Turn the led on.

Turn the led off.

Turn the child lock on.

Turn the child lock off.

Set the scheduled turn off time. Supported values are 0, 60, 120, 180, 240, 300, 360, 420, 480 minutes. When 0 is passed, delay_off is disabled.

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

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

Turn the auto detect on.

Turn the auto detect off.

Turn the learn mode on.

Turn the learn mode off.

Set the sound volume.

Reset the filter lifetime and usage.

Set the extra features.

Set the target humidity.

Turn the dry mode on.

Turn the dry mode off.

Oscillates the fan.

Rotates the fan 5 degrees to the left/right.

Set the oscillation angle. Supported values are 30, 60, 90 and 120 degrees.

Turn the natural mode on.

Turn the natural mode off.

Set motor speed RPM.

Turn the clean mode on.

Turn the clean mode off.

Set the level when on fan mode.

Turn the ptc on.

Turn the ptc off.

Set the favorite speed.

Set the ptc level.

Set the display orientation.

Turn the display on.

Turn the display off.

Turn the wet protection on.

Turn the wet protection off.