Add Smartmi Air Purifier to Integrations

tiff · October 7, 2021, 9:18pm

I want to use the purifer-card.js lovelace custom component, however I am not sure which HACS integration to use for the Smartmi Air Purifier P1:

Smartmi is a Xiaomi company, but nowhere in the Xiaomi Miio integration do I see my Smartmi Air Purifier and in fact, Smartmi has its own standalone app which does not integrate with the Mi Home/Xiaomi MiiO apps at all, at least not on iOS.

I search for Smartmi directly in the Integrations section in the configuration tab in Home Assistant. Nada.

So I go searching for one in HACS and I get several options for Xiaomi integrations which make little sense to me as to which one I need, there are just too many to sort through or scan quickly to see what I need.

Maybe through the Aqara Gateway? Not sure.

Don’t really need much handholding with this just need some help being pointed in the right direction. New to HA and just tinkering with things.

gabrielvisser · October 7, 2021, 10:01pm

I’ve been looking for the same thing

tiff · October 7, 2021, 10:30pm

It’s really strange because the purifier card has the capability to add a Smartmi card to Lovelace UI but it’s worthless if I can’t even find the purifier in integrations/HACS in the first place.

shad0wca7 · October 13, 2021, 11:55pm

I’ve added it though adding it on HomeKit on my phone then deleting it and adding it in HomeAssistant - it’s not perfect though as I don’t get all of the controls when it’s exposed through HomeAssistant and the air quality readings don’t seem to update automatically?

Haningback · November 2, 2021, 7:03pm

Yeah, it’s annoying that xiaomi has so many small “sub” brands …

noreg · November 26, 2021, 7:24pm

Also interested in this. Any luck getting readings and controlling this from HA?

ballakers · November 30, 2021, 6:03pm

I added it via homekit controller too intially but when I did a while back it only had the AQI sensor and not even a switch for the fan. Has that changed? Was going to try it again soon but figured I’d ask anyways.

noreg · December 1, 2021, 8:31am

Don’t think it has changed… Was able to connect to Homekit Controller and initially got AQI readings, but they didn’t correspond with actual readings. Also no option to control the device.

If it had talked with the official MiHome app, I guess one could configure it with the Miio integration. But this is not the case. Talked with SmartMi support and they said it was not possible to add the P1 to MiHome due to hardware issues.

redphx · June 18, 2022, 1:33pm

I have a Smartmi Air Circulator Fan 2. I was able to control it using localtuya. You’ll need to extract the localKey though.

ryanmsnyder · July 17, 2022, 12:45am

I’ve also successfully added the Smartmi Airpurifier P1 to HA via the HomeKit Controller integration. However, still no fan control. When I go to the device in Devices, I see two sensors in the Sensors section - Air Quality and PM2.5 Density. It also created a Diagnostics section that appears to be useless (unless I’m misunderstanding what the ‘PRESS’ button does)

shad0wca7 · July 17, 2022, 1:38am

Do your values update correctly though? Mine only do upon a HomeAssistant restart and then never again…

ryanmsnyder · July 17, 2022, 5:11pm

Thanks to @redphx’s comment, I attempted to get it into HA via LocalTuya and was able to get it integrated🎉.

After much trial and error, I got all of the Tuya IDs of the device mapped out to HA entities (except for one, which I don’t think is useful anyway). Let me know if anyone is interested in getting this setup in HA and I’ll provide the mappings.

My favorite features that I now have access to are being able to turn off the annoyingly loud sound when interacting with the device and being able to automate the screen brightness! It’s the small things. Having access to the filter lifespan and filter use will also open up a really useful notification automation when it’s time to replace the filter.

All updates are instantaneous between HA and the Smartmi Air Purifier P1. I like having it in HomeKit for easily controlling the fan speed via the UI and to quickly see air quality but this opens up a lot of advanced automations for me in node red (HomeKit may send a notification when it’s time to change the filter but I’m not sure - just got the purifier yesterday).

ryanmsnyder · July 17, 2022, 5:32pm

shad0wca7 · July 17, 2022, 5:56pm

Yes please do share the mappings! That will be extremely useful

dshafik · July 21, 2022, 3:13am

Would love to know how you did this; I haven’t setup localtuya before and don’t know how to pull the localKey. I’m fine using the cloud device lookup but can this be added to Tuya Cloud even?

redphx · July 22, 2022, 3:31am

Congrats. Make sure you don’t upgrade its firmware, because Smartmi might block this in future update (happened to Roborock).

ryanmsnyder · July 23, 2022, 7:44pm

How to Integrate Smartmi P1 into Home Assistant via LocalTuya

Quick notes before embarking on this journey:

The Tuya integration is not necessary (I’m not using it). However, this process involves setting up a Tuya cloud developer account. Though according to the LocalTuya GitHub:

Cloud API calls are performed only at startup, and when a local_key update is needed.

I’ve used this integration for a week now and have setup advanced automations in node red and it’s worked extremely well. Communication between HA and the P1 are instantaneous.
It also allows access to various settings and features that you would only be able to access/change through the Tuya/Smartmi app (for example, you can’t turn off the sound or adjust the display brightness in HomeKit).

1. Add Smartmi P1 to HomeKit

This isn’t necessary if your only goal is to get the device in Home Assistant. I use the Home app as my front end (I like the UI) and HA as my backend (all automations are in node red) so I like being able to see and control all of my devices manually through the Home app.

2. Connect the Smartmi P1 to the Tuya Smart app

Download the Tuya Smart app on your phone
If I remember correctly, when you open the app for the first time, it will ask for permission to allow the app to access devices in the Home app. Make sure you allow it.
If you already added the device to HomeKit, in the Tuya app you’ll want to select Me > HomeKit Information.
You should see a device called Air Purifier which is your P1. Select “Bind”. The device is now connected in Tuya.

3. Obtain Tuya local key, client id, client secret, and device id

Watch this tutorial on getting your device’s local key and device id
After you’ve done that, you can easily get your client id and client secret. Go to Cloud > Development

Select the project you created in the tutorial. I called mine home assistant

Pasted image 202207231220541854×808 79.6 KB
You’ll find the client id and client secret here.

Pasted image 202207231227481336×1112 119 KB

4. Install LocalTuya in Home Assistant

Install LocalTuya via HACS in Home Assistant (LocalTuya GitHub Installation)
Restart HA
In HA, go to the Integrations page
Select “Add Integration” and search for LocalTuya and add it
You should now see LocalTuya as an integration (you won’t have any devices/entities yet if this is your first device using LocalTuya)

5. Configure LocalTuya and Add P1

On the integration, select CONFIGURE
Fill in the form using the screenshot below as reference

Pasted image 20220717020601836×1590 69.9 KB
Add a new device

Pasted image 20220717015800854×670 29.4 KB
Fill in the form using the screenshot below as reference. Enter the IP address of your P1, which will likely be different than mine.

Pasted image 20220717020954822×1372 65 KB
Select fan as the platform

Pasted image 20220717021053826×474 19.8 KB
Now we start mapping Tuya’s internal ID’s to different entities in Home Assistant. I won’t include a screenshot for every ID/entity but I’ll provide the necessary information for each one, which will include:
- the Tuya ID followed by what I named it (i.e. 1: Fan means that the Tuya ID is 1 and I named it “Fan”)
- entity type in HA (sensor, switch, etc)
- other relevant details specific to the entity

1: Fan

Here’s how I setup ID 1, which is the switch that will turn the fan on/off. I called it Fan but you can also call it Air Purifier or whatever else you want. Select SUBMIT when complete.

Pasted image 202207170211291220×1958 140 KB
Another window will pop up where you will select the next HA entity type that you’ll be mapping. In this case, the next entity we’ll setup is the PM2.5 Density, which we want to be a sensor in HA. Select “sensor” and unselect “Do not add any more entities”. You’ll want to uncheck this box each time you see this screen until we’re finished.

Pasted image 202207231257541174×874 58.6 KB

2: PM2.5 Density

entity type: sensor
unit of measurement: µg/m³
device class: pm25

3: Mode

entity type: select
list of options (tuya asks for semicolon separated list):
- auto;sleep;strong;manual
  
  Pasted image 202207171002021204×980 48.1 KB

19: Timer Remaining

entity type: sensor
unit of measurement: minutes
description: how many minutes are left in the current timer that is set (see ID 103)

101: Sound

entity type: switch
description: turns on/off beeping sounds when interacting with the air purifier settings

102: PM10 Density

entity type: sensor
unit of measurement: µg/m³
device class: pm10

Pasted image 202207170959331216×1144 47.4 KB

103: Timer

entity type: select
valid entries (tuya asks for semicolon separated list):
- 0_hour;1_hour;2_hour;4_hour;8_hour
user friendly options (tuya asks for semicolon separated list):
- off;1 hour;2 hours;4 hours;8 hours

104: Filter Lifespan

entity type: sensor
description: current filter life remaining in percent

105: Filter Use

entity type: sensor (or number)
unit of measurement: hours
description: number of hours the current filter has been in use. In the Tuya app, this corresponds to “Filter useh” under “Setting”. This can be set as a number that can be adjusted (it’s also editable in the Tuya app). However, this number should automatically reset to 0 after following the “Resetting the Filter instructions in the manual”. For that reason, I’ve left it as a sensor.

You can now check the box “Do not add any more entities”. Note that I couldn’t figure out what Tuya ID 22 was. I set it as a sensor for awhile but it’s value never changed from 0 so I ended up removing it.

6. Done!

It should looks something like this:

image2242×1996 384 KB

Let me know if you have any questions.

ryanmsnyder · July 23, 2022, 7:46pm

Good point. I upgraded the firmware before integrating it. I won’t be upgrading it anymore though.

shirasp · July 24, 2022, 7:56pm

This was wonderful, thank you so much!!

1 question though, how do you add data points later? For example, I noticed that you have Fan Speed and Screen Brightness, I didn’t see an option for the fan speed, and I missed the screen brightness. Is there a way to go back and add those data points or do I need to delete the device and reconfigure the entire setup?

RosemaryJayne · July 27, 2022, 1:00am

When you click “Configure” you can select “Edit a device”.

Some further data points:
108: Colour
109: Manual Fan speed Setting (seems to be a 0-100 setting)
110: Screen Brightness

And for anyone else like myself who was seeing it already “Binded” (bound), in the Tuya app, remove it from the SmartMi app and then try again.