Skip to content

dzerik/xiaomi_airpurifier_ng

Repository files navigation

Xiaomi Air Purifier NG

hacs_badge HA Version License Version

README на русском

Custom Home Assistant integration for Xiaomi devices: air purifiers, humidifiers, fans, air fresh systems and dehumidifiers.

Devices are polled locally over WiFi via the miIO protocol — no cloud or internet required.

Fork of syssi/xiaomi_airpurifier with reworked architecture, UI-based configuration and support for current Home Assistant versions.

Note: For new installations, consider using Xiaomi Miot Auto — a more universal integration that supports virtually all Xiaomi devices via the MIoT protocol, including Wi-Fi, BLE and ZigBee. This integration (Xiaomi Air Purifier NG) is maintained for users who prefer a lightweight, fully local solution without cloud or Xiaomi account, or who need stable support for legacy miIO devices. The project is in maintenance mode — bug fixes and community contributions are welcome, but no major new features are planned.


Supported Devices

Air Purifier (fan platform)

Name Model
Air Purifier zhimi.airpurifier.v1
Air Purifier 2 zhimi.airpurifier.v2
Air Purifier V3 zhimi.airpurifier.v3
Air Purifier V5 zhimi.airpurifier.v5
Air Purifier Pro zhimi.airpurifier.v6
Air Purifier Pro V7 zhimi.airpurifier.v7
Air Purifier 2 mini zhimi.airpurifier.m1
Air Purifier mini zhimi.airpurifier.m2
Air Purifier MA1 zhimi.airpurifier.ma1
Air Purifier MA2 zhimi.airpurifier.ma2
Air Purifier Super zhimi.airpurifier.sa1
Air Purifier Super 2 zhimi.airpurifier.sa2
Air Purifier 2S zhimi.airpurifier.mc1
Air Purifier 2H zhimi.airpurifier.mc2
Air Purifier 3 zhimi.airpurifier.ma4
Air Purifier 3H zhimi.airpurifier.mb3
Air Purifier 3H (alt) zhimi.airpurifier.mb3a
Air Purifier ZA1 zhimi.airpurifier.za1
Air Purifier Pro H zhimi.airpurifier.va1
Air Purifier 4 zhimi.airpurifier.vb2
Air Purifier 3C zhimi.airpurifier.mb4
Air Purifier 3C (rev) zhimi.airp.mb4a
Air Purifier 3C (rev2) zhimi.airp.mb5
Air Purifier Pro H (MIoT) zhimi.airp.va2
Air Purifier 4 Pro zhimi.airp.vb4
Air Purifier 4 Lite zhimi.airpurifier.rma1
Air Purifier 4 Lite (alt) zhimi.airp.rmb1
Air Dog X3 airdog.airpurifier.x3
Air Dog X5 airdog.airpurifier.x5
Air Dog X7SM airdog.airpurifier.x7sm

Air Humidifier (humidifier platform)

Name Model
Air Humidifier zhimi.humidifier.v1
Air Humidifier CA1 zhimi.humidifier.ca1
Smartmi Humidifier Evaporator 2 zhimi.humidifier.ca4
Smartmi Evaporative Humidifier zhimi.humidifier.cb1
Smartmi Evaporative Humidifier (Korea) zhimi.humidifier.cb2
Mijia Smart Sterilization Humidifier S deerma.humidifier.mjjsq
Mijia Intelligent Sterilization Humidifier deerma.humidifier.jsq
Mijia Intelligent Sterilization Humidifier SCK0A45 deerma.humidifier.jsq1
Mijia Smart Humidifier 2 EU deerma.humidifier.jsq2w
Mijia Humidifier 4L deerma.humidifier.jsq3
Mijia Intelligent Sterilization Humidifier 2 deerma.humidifier.jsq5
Mijia Smart Sterilization Humidifier S EU deerma.humidifier.jsqs
Zero Fog Humidifier shuii.humidifier.jsq001

Air Fresh (fan platform)

Name Model
Mi Fresh Air Ventilator A1 dmaker.airfresh.a1
Smartmi Fresh Air System zhimi.airfresh.va2
Smartmi Fresh Air System PTC zhimi.airfresh.va4
Mi Fresh Air Ventilator T2017 dmaker.airfresh.t2017

Standing Fan (fan platform)

Name Model
Pedestal Fan V2 zhimi.fan.v2
Pedestal Fan V3 zhimi.fan.v3
Pedestal Fan SA1 zhimi.fan.sa1
Pedestal Fan ZA1 zhimi.fan.za1
Pedestal Fan ZA3 zhimi.fan.za3
Pedestal Fan ZA4 zhimi.fan.za4
Pedestal Fan P5 dmaker.fan.p5
Pedestal Fan P8 dmaker.fan.p8
Pedestal Fan P9 dmaker.fan.p9
Pedestal Fan P10 dmaker.fan.p10
Mijia Pedestal Fan P11 dmaker.fan.p11
Smart Standing Fan Pro EU dmaker.fan.p15
Pedestal Fan P18 dmaker.fan.p18
Smart Standing Fan 2 Pro dmaker.fan.p33
Rosou SS4 Ventilator leshow.fan.ss4
Pedestal Fan 1C dmaker.fan.1c

Air Dehumidifier (climate platform)

Name Model
New Widetech Internet Dehumidifier nwt.derh.wdh318efw1

Installation via HACS

  1. Open HACS in Home Assistant.
  2. Go to Integrations.
  3. Click the menu (three dots) -> Custom repositories.
  4. Add repository: https://github.com/dzerik/xiaomi_airpurifier_ng, category — Integration.
  5. Find Xiaomi Air Purifier NG and click Download.
  6. Restart Home Assistant.

Manual Installation

  1. Copy the custom_components/xiaomi_miio_airpurifier_ng folder into your Home Assistant config/custom_components/ directory.
  2. Restart Home Assistant.

Configuration

The integration is configured via the UI — no YAML configuration is needed.

  1. Go to Settings -> Devices & Services.
  2. Click + Add Integration.
  3. Search for Xiaomi Air Purifier NG.
  4. Enter the parameters:
Parameter Description
Host Device IP address on the local network
Token 32-character device token
Model Device model (e.g. zhimi.airpurifier.ma4)

After setup, the polling interval can be changed via Options (default: 30 seconds).


Platforms and Entities

The integration automatically creates entities based on the capabilities of each device model.

Platform Description
fan Air purifiers, air fresh, standing fans — on/off, speed, modes
humidifier Humidifiers — on/off, target humidity, modes
climate Dehumidifier — on/off, target humidity, HVAC mode
sensor Temperature, humidity, AQI, CO2, motor speed, filter status, etc.
switch Buzzer, LED, child lock, dry mode, oscillation, etc.
number Favorite level, fan level, target humidity, oscillation angle, etc.
select LED brightness, display orientation, PTC level, operation mode
binary_sensor Water level, AC power, battery charging, PTC heater status
button Reset filter counter

How to Get the Device Token

The token is required for local communication. You can obtain it in several ways:


Debugging

To diagnose issues, enable debug logging in configuration.yaml:

logger:
  default: warning
  logs:
    custom_components.xiaomi_miio_airpurifier_ng: debug
    miio: debug

Breaking Changes in 3.0.0

Humidifiers moved to humidifier platform

Humidifiers are no longer registered as fan entities. Entity IDs have changed:

  • fan.xiaomi_* -> humidifier.xiaomi_*
  • Service fan.set_preset_mode replaced with humidifier.set_mode
  • New service humidifier.set_humidity for setting target humidity
  • Automations using fan.turn_on / fan.turn_off for humidifiers must be updated to humidifier.turn_on / humidifier.turn_off

All custom services removed

37 custom services like xiaomi_miio_airpurifier_ng.fan_set_* have been removed. Device control is now done via standard entity platforms: switch, number, select, button.

Humidifier binary sensor entity IDs changed

  • binary_sensor.*_water_tank -> binary_sensor.*_water_level_low
  • binary_sensor.*_water_shortage -> binary_sensor.*_water_tank_removed

Requirements

  • Home Assistant 2024.8.0 or newer
  • Python 3.11+
  • python-miio >= 0.5.12, < 1.0.0

License

Apache License 2.0. See LICENSE for details.


Credits: Rytilahti for the python-miio library, syssi for the original integration.

About

Custom Home Assistant integration for Xiaomi devices: air purifiers, humidifiers, fans, air fresh systems and dehumidifiers. Local WiFi polling via miIO protocol.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages