Air purifier 3/3H support (remastered) #634

foxel · 2020-02-20T07:42:39Z

Rebased copy of #585 - original description below:

Add support for basic operations for new Xiaomi Air Purifier 3/3H (zhimi-airpurifier-mb3 and zhimi-airpurifier-ma4 (#577)).

In order to support that, also implement MiotDevice class with basic support for MIoT protocol which the AirPurifierMiot extends to retrieve & set properties.

Mapping is based on #543 (comment) - thanks, it helped a lot!

Note

I have not added any tests yet. I'd appreciate first round of a review before I do so.
I have not tried the template/generative approach. Thought it would be better just to get it working. I can attempt to do that separately later.

Disclaimer: this is my first contribution to this project & I don't have Python experience.

ToDo:

extract Filter Type detection to a separate class
add test coverage

Manually tested operations:

info (see output below)
status (see output below)
off
on
set_buzzer <true|false>
set_child_lock <true|false>
set_fan_level <1-3>
set_favorite_level <0-14>
set_led <true|false>
set_led_brightness <off|dim|bright>
set_mode <auto|fan|favorite|silent>

Example output of info:

$ python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN info
Model: zhimi.airpurifier.mb3
Hardware version: esp32
Firmware version: 2.0.5
Network: {'localIp': '192.168.0.22', 'mask': '255.255.255.0', 'gw': '192.168.0.1'}
AP: {'ssid': 'coolwifi', 'bssid': '20:E5:2A:3C:BC:82', 'rssi': -59, 'primary': 8}

Example output of status:

$ python miio/cli.py airpurifiermiot --ip $AIR_IP --token $TOKEN status
Power: on
AQI: 3 μg/m³
Average AQI: 6 μg/m³
Humidity: 58 %
Temperature: 25.799999 °C
Mode: OperationMode.Favorite
LED: True
LED brightness: LedBrightness.Dim
Buzzer: False
Child lock: False
Favorite level: 14
Filter life remaining: 98 %
Filter hours used: 59
Use time: 212700 s
Purify volume: 8606 m³
Motor speed: 2148 rpm
Filter RFID product id: 0:0:31:31
Filter RFID tag: 80:66:6a:da:38:bd:4
Filter type: FilterType.Regular

Closes #577

…t that, also implement MiotDevice class with basic support for MIoT protocol.

…eparate util class

…ng to an actual device

# Conflicts: # miio/ceil_cli.py # miio/device.py # miio/philips_eyecare_cli.py # miio/plug_cli.py # miio/tests/dummies.py # miio/tests/test_airconditioningcompanion.py # miio/tests/test_wifirepeater.py # miio/vacuum.py # miio/vacuum_cli.py

…_favorite_rpm"

… out if no button was pressed since purifier started up

coveralls · 2020-02-20T07:43:55Z

Coverage increased (+0.2%) to 74.225% when pulling a400d56 on foxel:air-purifier-3h-support into efd4370 on rytilahti:master.

lucidyan · 2020-02-24T03:41:20Z

@foxel Do you experience same behavior with 3/3H?
#585 (comment)

foxel · 2020-02-24T04:05:28Z

@lucidyan with Purifier 3 I got it working with no issues. I have it running with my HA installation for more than a week now.
I didn't try set_favorite_rpm though, will check

lucidyan · 2020-02-24T04:22:28Z

@foxel I edit comment a little, because figured out how to make alarm works. I think it's interesting and will be very glad if you try it with 3* model.

Also is it a good idea to add a handler in get_params method to ignore records with such nonzero error codes to avoid such errors in the future?

I see already hardcoded solutions for similar problems:

python-miio/miio/miioprotocol.py

Line 194 in 9a7c6c4

if "code" in error and error["code"] == -30001:

pmasknguyen · 2020-02-28T15:57:24Z

after upgrade to new version Home Assistant 0.106.1 the air purify 3h not recognize like before, thank for help

foxel · 2020-02-29T09:45:07Z

@pmasknguyen mine works well. I've checked 106. there were no changes in xiami-miio fan

pmasknguyen · 2020-02-29T10:11:49Z

thank you I double checked and it works

foxel · 2020-02-29T18:26:34Z

@lucidyan I've looked more closely thru the code and that miot specs and added some handling of possibly unavailable features, plus added buzzer volume.

Please make some tests on your rare device

foxel · 2020-03-01T15:58:26Z

Hi, @rytilahti

What's the plan for this one?

lucidyan · 2020-03-01T18:02:22Z

@foxel Thanks a lot!

I watch through your code and find one inaccuracy:
31b0248#diff-7f2ec049fa93db605930bf4492455753R347-R348

Also in my zhimi.airpurifier.va1 device API motor-favorite is not writeable (WTF xiaomi), so method won't work. And number of favorite levels is 9 instead of 14. So the question: how we will handle such API differences for all zoo of purifiers in the future?

syssi

Good job!

rytilahti

Sorry, I have been busy and that's why it has taken so long to do a review. Generally speaking it looks good to me, I just left a couple of comments behind.

rytilahti · 2020-03-02T19:22:33Z

miio/version.py

@@ -1,2 +1,2 @@
 # flake8: noqa
-__version__ = "0.4.8"
+__version__ = "0.5.0"


Please do not bump the version in feature PRs.

Will keep in mind. I need this to make HA install this fork correctly

Ok, could you please remove this and update the README to contain information about miot support & the new devices? I think we can merge and prepare a new release then 🎉

miio/miot_device.py

miio/airpurifier_miot.py

miio/miot_device.py

foxel · 2020-03-11T16:28:36Z

@rytilahti please take another look

foxel · 2020-03-14T00:43:37Z

@rytilahti anything else? Can we proceed with this PR?

rytilahti · 2020-03-14T14:18:37Z

Oh, sorry, I was waiting for updating the README file to contain the newly supported devices. If you could do that, I will do the merge and start preparations for a new release.

foxel · 2020-03-14T14:35:30Z

@rytilahti I don't see a place for it in README, it's pretty general and states support for purifiers in common...

rytilahti · 2020-03-15T17:31:49Z

Ah, okay, I suppose that's fine as it is then. Let's get this merged now! Thanks @petrkotek and @foxel! 🎉

Petr Kotek and others added 8 commits February 20, 2020 13:45

Add basic support for Xiaomi Mi Air Purifier 3/3H. In order to suppor…

7e6c577

…t that, also implement MiotDevice class with basic support for MIoT protocol.

Extract functionality for determining Xiaomi air filter type into a s…

49101c3

…eparate util class

Rename airfilter.py to airfilter_util.py to indicate it's not referri…

12a213f

…ng to an actual device

Tests for miot purifier

be5878a

# Conflicts: # miio/ceil_cli.py # miio/device.py # miio/philips_eyecare_cli.py # miio/plug_cli.py # miio/tests/dummies.py # miio/tests/test_airconditioningcompanion.py # miio/tests/test_wifirepeater.py # miio/vacuum.py # miio/vacuum_cli.py

MIoT Air Purifier: add support for fine-tuning favourite mode by "set…

0c39c4c

…_favorite_rpm"

MIoT Air Purifier: improve comments

05bf1bc

airpurifier_miot: don't try to retrieve "button_pressed" as it errors…

f41c4e7

… out if no button was pressed since purifier started up

Version

14d6588

Fix MIOT purifier tests

6feed42

foxel force-pushed the air-purifier-3h-support branch from a0ea50a to 6feed42 Compare February 20, 2020 07:51

foxel marked this pull request as ready for review February 20, 2020 09:42

foxel mentioned this pull request Feb 29, 2020

Add support for Mi AirPurifier 3 home-assistant/core#31729

Merged

20 tasks

Added buzzer_volumw and handling missing features for miot

31b0248

foxel force-pushed the air-purifier-3h-support branch from b9eb3ea to 31b0248 Compare February 29, 2020 18:34

Fixed volume setter to be same as in non-miot purifier

981cb23

syssi approved these changes Mar 1, 2020

View reviewed changes

Fixed incorrect comment body

d18a7e9

rytilahti reviewed Mar 2, 2020

View reviewed changes

Valcob mentioned this pull request Mar 4, 2020

[XIAOMI_MIIO:INTEGRATION] Xiaomi Air Purifier 3 / 3H (xiaomi.airpurifier.ma4) throws command error home-assistant/core#32476

Closed

rytilahti mentioned this pull request Mar 9, 2020

Initial support for xiaomi gateway devices #470

Merged

Review comments fixed

becd8a0

foxel force-pushed the air-purifier-3h-support branch from a400d56 to becd8a0 Compare March 11, 2020 17:16

Expanded documentation

d549082

rytilahti merged commit 5f8aa72 into rytilahti:master Mar 15, 2020

rytilahti mentioned this pull request Mar 15, 2020

Add basic support for Xiaomi Mi Air Purifier 3/3H #585

Closed

2 tasks

rezmus mentioned this pull request Mar 29, 2020

Add support for Xiaomi Air Purifier Pro H please #648

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Air purifier 3/3H support (remastered) #634

Air purifier 3/3H support (remastered) #634

foxel commented Feb 20, 2020 •

edited by rytilahti

Loading

coveralls commented Feb 20, 2020 •

edited

Loading

lucidyan commented Feb 24, 2020

foxel commented Feb 24, 2020

lucidyan commented Feb 24, 2020

pmasknguyen commented Feb 28, 2020

foxel commented Feb 29, 2020

pmasknguyen commented Feb 29, 2020

foxel commented Feb 29, 2020 •

edited

Loading

foxel commented Mar 1, 2020

lucidyan commented Mar 1, 2020

syssi left a comment

rytilahti left a comment

rytilahti Mar 2, 2020

foxel Mar 11, 2020

rytilahti Mar 11, 2020

foxel Mar 11, 2020

foxel commented Mar 11, 2020

foxel commented Mar 14, 2020

rytilahti commented Mar 14, 2020

foxel commented Mar 14, 2020

rytilahti commented Mar 15, 2020

Air purifier 3/3H support (remastered) #634

Air purifier 3/3H support (remastered) #634

Conversation

foxel commented Feb 20, 2020 • edited by rytilahti Loading

Rebased copy of #585 - original description below:

coveralls commented Feb 20, 2020 • edited Loading

lucidyan commented Feb 24, 2020

foxel commented Feb 24, 2020

lucidyan commented Feb 24, 2020

pmasknguyen commented Feb 28, 2020

foxel commented Feb 29, 2020

pmasknguyen commented Feb 29, 2020

foxel commented Feb 29, 2020 • edited Loading

foxel commented Mar 1, 2020

lucidyan commented Mar 1, 2020

syssi left a comment

Choose a reason for hiding this comment

rytilahti left a comment

Choose a reason for hiding this comment

rytilahti Mar 2, 2020

Choose a reason for hiding this comment

foxel Mar 11, 2020

Choose a reason for hiding this comment

rytilahti Mar 11, 2020

Choose a reason for hiding this comment

foxel Mar 11, 2020

Choose a reason for hiding this comment

foxel commented Mar 11, 2020

foxel commented Mar 14, 2020

rytilahti commented Mar 14, 2020

foxel commented Mar 14, 2020

rytilahti commented Mar 15, 2020

foxel commented Feb 20, 2020 •

edited by rytilahti

Loading

coveralls commented Feb 20, 2020 •

edited

Loading

foxel commented Feb 29, 2020 •

edited

Loading