Support for Xiaomi Air Purifier 3 (zhimi.airpurifier.ma4)

[inviicta]

Hi,
I got my purifier and I tried to setup python-miio library and write something easy to start.
And I got error:

raise DeviceError(error)
miio.exceptions.DeviceError: {'code': -5001, 'message': 'command error'}

So i assume it is not supported device.
Any plans to add it to the device list?

[rytilahti]

It uses different API that is not currently implemented, see #543 for details.

[petrkotek]

Same issue for Xiaomi Air Purifier 3/3H (zhimi.airpurifier.mb3).

I started experimenting with it & managed to get some features working:

export AIR_IP=192.168.0.xx
export TOKEN=77xxxxxxxxxxxxxxxxxxff
$ python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN status
Power: False
Temperature: 26.200001 °C
Humidity: 43 %
Favorite level: 7
Filter hours used: 12
Filter RFID product id: 0:0:31:31
Filter RFID tag: 80:66:6a:da:38:bd:4

$ python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN on
Powering on
[{'did': 'MYDID', 'siid': 2, 'piid': 2, 'code': 0}]

$ python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN set_favorite_level 14
Setting favorite level to 14
[{'did': 'MYDID', 'siid': 10, 'piid': 10, 'code': 0}]

$ python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN status
Power: True
Temperature: 26.200001 °C
Humidity: 44 %
Favorite level: 14
Filter hours used: 12
Filter RFID product id: 0:0:31:31
Filter RFID tag: 80:66:6a:da:38:bd:4

$ python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN set_mode auto
Setting mode to '0'
[{'did': 'MYDID', 'siid': 2, 'piid': 5, 'code': 0}]

$ python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN set_mode favorite
Setting mode to '2'
[{'did': 'MYDID', 'siid': 2, 'piid': 5, 'code': 0}]

$ python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN set_mode silent
Setting mode to '1'
[{'did': 'MYDID', 'siid': 2, 'piid': 5, 'code': 0}]

Code is here:
https://github.com/rytilahti/python-miio/compare/master...petrkotek:air-purifier-3h-support?expand=1

I'm hoping to productionize it upcoming days and open a PR.

In the meantime, would you be maybe able to give it a go with your purifier and tell me if it works for you too?

Note: my firmware version as per Mi Home app is 2.0.5.0006. I'm getting a prompt to upgrade to 1.3.1.0009 -- yes, looks like a downgrade rather than upgrade; not going to risk it at this stage.

[inviicta]

Hi, sure. I will try to do it in the evening. I will let you know. :)

My purifier got an update lately and currently has version: 2.0.7.0021.

[inviicta]

Hi!

I had a lot of troubles to get your code working, but finally it is. :)

% python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN status
Power: True
Temperature: 23.6 °C
Humidity: 61 %
Favorite level: 14
Filter hours used: 162
Filter RFID product id: 0:0:30:33
Filter RFID tag: 80:64:d1:ba:37:b2:4

% python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN off
Powering off
[{'did': 'MYDID', 'siid': 2, 'piid': 2, 'code': 0}]

% python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN on 
Powering on
[{'did': 'MYDID', 'siid': 2, 'piid': 2, 'code': 0}]

% python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN set_mode silent
Setting mode to '1'
[{'did': 'MYDID', 'siid': 2, 'piid': 5, 'code': 0}]

% python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN set_mode auto  
Setting mode to '0'
[{'did': 'MYDID', 'siid': 2, 'piid': 5, 'code': 0}]

Is it possible to get the value of the currect pollution?

[petrkotek]

Awesome! Sure, I'll add more properties in next two days or so.

Btw, Did you have to change some code or did you have troubles with git or Python environment in general?

[inviicta]

Just human issue between laptop and chair :D

I have edited your code inside airpurifier_miot.py:

class AirPurifierMiot(Device):
    """Main class representing the air purifier miot."""

    @command(
        default_output=format_output(
            "",
            "Power: {result.power}\n"
            "AQI: {result.aqi} μg/m³\n"
            "Average AQI: {result.average_aqi} μg/m³\n"
            "Temperature: {result.temperature} °C\n" "Humidity: {result.humidity} %\n"

And here:

    def status(self) -> AirPurifierMiotStatus:
        """Retrieve properties."""

        properties = [
            {"did": "power", "siid": 2, "piid": 2},
            {"did": "favorite_level", "siid": 10, "piid": 10},
            {"did": "aqi", "siid": 13, "piid": 8},
            {"did": "average_aqi", "siid": 13, "piid": 2},
            {"did": "humidity", "siid": 3, "piid": 7},
            {"did": "temperature", "siid": 3, "piid": 8},

And now it is showing also in status command value of AQI. I need to check proper PIID and SIID, but it looks like it is working just fine. :)

% python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN status
Power: True
AQI: 0 μg/m³
Average AQI: 6 μg/m³
Temperature: 23.6 °C
Humidity: 62 %
Favorite level: 14
Filter hours used: 163
Filter RFID product id: 0:0:30:33
Filter RFID tag: 80:64:d1:ba:37:b2:4

Good job! :)

[djmalin]

inviicta hello pleace add your code here, i have this same zhimi.airpurifier.ma4, what do you add in the config file?

[petrkotek]

@djmalin which config file are you referring to?

Note that currently, only my branch (https://github.com/petrkotek/python-miio/tree/air-purifier-3h-support) has partial (very limited) support for it. Over the next several days, I'd like to finalise it and hopefully get it reviewed. Once that's done and merged, I'll be looking into how to get that support into Home Assistant. Is Home Assistant config (or other home automation platform) the config you were referring to?

[djmalin]

this is very good news for me, I am holding my thumb to make it happen

[petrkotek]

I got all the important things working locally (controlling mode, led, led_brightness, favourite_level fan_level, child_lock, buzzer; reading aqi, humidity, temperature, filter info etc.).

See #585 for details.

[petrkotek]

"Preparation PR" has been merged (#592). The next PR will finally include the support for this Air Purifier 3.

No promises, however, I think it could be merged in a week or two.

[adamtmitchell]

Note: my firmware version as per Mi Home app is 2.0.5.0006. I'm getting a prompt to upgrade to 1.3.1.0009 -- yes, looks like a downgrade rather than upgrade; not going to risk it at this stage.

Not really the right place for this i know, but did you ever go through with this "update"?