Add support for Xiaomi Air purifier 3C #899

arturdobo · 2021-01-01T17:31:12Z

This PR adds support for Air purifier 3C (zhimi.airpurifier.mb4) which according to specification provides only a subset of i.e. mb3 functionalities.

pawelnguyen · 2021-01-20T12:20:56Z

I bought a 3C and just found out it doesn't work with home assistant. LMK if I can help and test this on a real device.

Looking at the code - feature set seems correct, I can confirm that this model doesn't provide temperature/humidity.

Thanks for working on this!

rytilahti

Looks straightforward to me, thanks for the PR!

A couple of minor issues should be changed and then this is ready to be merged.

miio/airpurifier_miot.py

syssi · 2021-01-20T15:35:42Z

Cool! Let's merge this PR as soon the minor issues are fixed.

jagub2 · 2021-01-27T22:12:53Z

Howdy, I tried to use these changes, but I'm struggling to get it working.

 ~/python-miio/miio   add-mb4-support ± python3 cli.py airpurifiermb4 --ip x --token y info
Model: zhimi.airpurifier.mb4
Hardware version: esp32
Firmware version: 2.0.8
 ~/python-miio/miio   add-mb4-support ± python3 cli.py airpurifiermb4 --ip x --token y status
Traceback (most recent call last):
  File "/home/jagub2/python-miio/miio/cli.py", line 51, in <module>
    create_cli()
  File "/home/jagub2/python-miio/miio/cli.py", line 47, in create_cli
    return cli(auto_envvar_prefix="MIIO")
  File "/home/jagub2/python-miio/miio/../miio/click_common.py", line 59, in __call__
    return self.main(*args, **kwargs)
  File "/usr/lib/python3.9/site-packages/click/core.py", line 782, in main
    rv = self.invoke(ctx)
  File "/usr/lib/python3.9/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/lib/python3.9/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/lib/python3.9/site-packages/click/core.py", line 1066, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/lib/python3.9/site-packages/click/core.py", line 610, in invoke
    return callback(*args, **kwargs)
  File "/home/jagub2/python-miio/miio/../miio/click_common.py", line 285, in wrap
    result_msg = result_msg_fmt.format(**kwargs)
AttributeError: 'AirPurifierMB4Status' object has no attribute 'favorite_rpm'
 ✘  ~/python-miio/miio   add-mb4-support ± python3 cli.py airpurifiermb4 --ip x --token y set_favorite_rpm 300
Setting favorite motor speed '300' rpm
[{'did': 'favorite_rpm', 'siid': 9, 'piid': 3, 'code': 0}]
 ~/python-miio/miio   add-mb4-support ± python3 cli.py airpurifiermb4 --ip x --token y status
Traceback (most recent call last):
  File "/home/jagub2/python-miio/miio/cli.py", line 51, in <module>
    create_cli()
  File "/home/jagub2/python-miio/miio/cli.py", line 47, in create_cli
    return cli(auto_envvar_prefix="MIIO")
  File "/home/jagub2/python-miio/miio/../miio/click_common.py", line 59, in __call__
    return self.main(*args, **kwargs)
  File "/usr/lib/python3.9/site-packages/click/core.py", line 782, in main
    rv = self.invoke(ctx)
  File "/usr/lib/python3.9/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/lib/python3.9/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/lib/python3.9/site-packages/click/core.py", line 1066, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/lib/python3.9/site-packages/click/core.py", line 610, in invoke
    return callback(*args, **kwargs)
  File "/home/jagub2/python-miio/miio/../miio/click_common.py", line 285, in wrap
    result_msg = result_msg_fmt.format(**kwargs)
AttributeError: 'AirPurifierMB4Status' object has no attribute 'favorite_rpm'

set_favorite_rpm makes it beep but it still fails on status command. All other set_ commands work, too besides set_led_brightness_level, for that one I get:

Traceback (most recent call last):
  File "/home/jagub2/python-miio/miio/cli.py", line 49, in <module>
    create_cli()
  File "/home/jagub2/python-miio/miio/cli.py", line 45, in create_cli
    return cli(auto_envvar_prefix="MIIO")
  File "/home/jagub2/python-miio/miio/click_common.py", line 59, in __call__
    return self.main(*args, **kwargs)
  File "/usr/lib/python3.9/site-packages/click/core.py", line 782, in main
    rv = self.invoke(ctx)
  File "/usr/lib/python3.9/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/lib/python3.9/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/lib/python3.9/site-packages/click/core.py", line 1066, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/lib/python3.9/site-packages/click/core.py", line 610, in invoke
    return callback(*args, **kwargs)
  File "/home/jagub2/python-miio/miio/click_common.py", line 277, in wrap
    msg = msg_fmt.format(**kwargs)
KeyError: 'brightness'

When I hardcode favorite_rpm in default_output in AirPurifierMB4's __init__, status command starts working:

Power: on
AQI: 4 μg/m³
Mode: OperationMode.Favorite
LED brightness level: 3
Buzzer: False
Child lock: True
Filter life remaining: 99 %
Filter hours used: 29
Motor speed: 300 rpm
Favorite RPM: 300 rpm

I checked out that project and exported PYTHONPATH to use this module without installing.

Am I doing something wrong? Am I missing something? Thanks in advance.

arturdobo · 2021-01-27T22:20:32Z

@jagub2 I'm going to apply the suggestions above tomorrow, so I'll check what's wrong then. I tested it using HA but maybe omitted something on the CLI 🤔 Thanks for letting me know

arturdobo · 2021-01-28T20:39:12Z

@jagub2 could you pull changes, install and check everything is ok now?

jagub2 · 2021-01-28T21:17:46Z

@arturdobo I confirm, everything works great now. Thank you!

mbatorowicz · 2021-02-07T17:39:49Z

Hello, I also have the 3C version. Can you please explain step by step what I have to do to make it work with HA. I mean the modification of a component. I have the token out.

rytilahti

Just a couple of minor issues to be fixed, then this is ready to go! 👍 Please also update the supported devices listing in README!

miio/airpurifier_miot.py

Co-authored-by: Teemu R. <[email protected]>

arturdobo · 2021-02-07T19:52:25Z

@rytilahti all suggestions have been applied. Regarding README how to add information about the new air purifier? As a new entry in the list or somehow different? I see there is a generic entry Xiaomi Mi Air Purifier, but no idea how many models it covers

rytilahti · 2021-02-07T19:58:39Z

@arturdobo Maybe just adding (3C, ..) to the end of the entry, I think we want to have a yaml-based registry of supported devices & their model information at some point, but until then it's manual updates to the readme :(

arturdobo · 2021-02-07T20:09:15Z

@mbatorowicz I'm definitively not a python developer so I did it a hacky way at the beginning of development by replacing the class in the python-miio lib. But once this PR is merged you should be able to just update the library version and test.

@rytilahti I added a whole list of air purifiers I use and I'm sure python-miio supports them.

rytilahti · 2021-02-07T20:24:08Z

LGTM, let's get it merged. Thanks again! 🎉

@rytilahti I added a whole list of air purifiers I use and I'm sure python-miio supports them.

Great! Oh, you have multiple purifiers? Could you create a separate PR to add a list of model identifiers to the docstrings of the respective implementation classes?

arturdobo · 2021-02-07T20:35:29Z

Yeah! One air purifier per room, but I wanted to replace the old 2 model with 3C model so temporarily I have one more than needed 😄

Sure, I'll add those models to appropriate docstrings

gh0st125 · 2021-02-12T12:42:25Z

I am still not able to integrate my Air Purifier 3C into Home Assistant. The Entity always states "not available"

This is what i have in my configuration.yaml:

`fan:

platform: xiaomi_miio
host: !secret xiaomi_ip
token: !secret xiaomi_token
name: "Luftreiniger"`

what am I missing?

arturdobo · 2021-02-12T13:07:15Z

@gh0st125 is it your only change in HA? If yes, it won't work like that. More details here

gh0st125 · 2021-02-12T13:16:33Z

yeah, these are the only changes so far.

Feel free to provide a pull request for this custom component as first step to support your device. I'm trying to refactor the component to be merged as official HA component again some day.

@arturdobo So I have to do a pull request? How do I do that? Sorry, I'm not really familiar with this kind of integrations...

arturdobo · 2021-02-12T13:24:40Z

Once @rytilahti releases a new version of python-miio the device can be added to HA. The way new Xiaomi devices were added so far is not allowed anymore and the new devices need to be added the new way meaning a device needs to be split into multiple entities, one per measurement (i.e. humidity, air quality, etc). Any PR that adds devices (or even features to already added devices) the old way are immediately closed in HA 😉

gh0st125 · 2021-02-12T13:27:25Z

ahh okay thanks, so I have to wait for a new release. That's fine for me, it's not something that I have to have right now :D Thanks for the clarification!

arturdobo · 2021-02-12T13:29:34Z

I'll try to prepare some PR in HA and see how it will work 😉

calas80 · 2021-02-17T21:26:08Z

I have to wait for a new release. Thanks

starkillerOG · 2021-02-21T19:09:04Z

@arturdobo I am currently working on implementing Config Flow for all Miio platforms.
Switches are done, Vacuums almost done (only needs to be merged).
Lights are up next, but I could also do the fan platform (Air Purifier and Humidifier) first if you like.

Probably you will want to wait untill the Config Flow is done before implementing this new device, but of course it is up to you.

arturdobo · 2021-02-21T19:14:57Z

it'd be great if you could.

starkillerOG · 2021-02-21T20:16:06Z

@arturdobo just made the PR: home-assistant/core#46866

abrilevskiy · 2021-03-02T00:54:11Z

Could you please clarify - can zhimi.airpurifier.mb4 be added to HomeAssistant? I tried with the latest Dev without success

starkillerOG · 2021-03-02T10:35:25Z

@abrilevskiy the config flow PR is merged, but the zhimi.airpurifier.mb4 has not been implemented.
However now that the config flow PR is merged, someone could proceed with making a PR for the zhimi.airpurifier.mb4.

arturdobo · 2021-03-06T20:19:19Z

@rytilahti could you please release the new python-miio version? It'd allow adding new devices to HA then

jddipqd · 2021-04-12T14:04:15Z

Is 3C supported now?
I'm running 0.5.5.2 but still can't get it to work.

miiocli airpurifier --ip xxx --token xxx info

Model: zhimi.airpurifier.mb4
Hardware version: esp32
Firmware version: 2.0.8

miiocli airpurifier --ip xxx --token xxx status

Error: {'code': -5000, 'message': 'method not found'}

The same command is working for 2H.

rytilahti · 2021-04-12T14:43:56Z

I think it should be supported as per this PR? Feel free to open a separate issue if that's not the case.

arturdobo · 2021-04-12T14:57:50Z

The argument you provide is wrong, airpurifiermb4 should be instead

jddipqd · 2021-04-12T18:30:21Z

Thank you, it's working with airpurifiermb4.

arturdobo mentioned this pull request Jan 1, 2021

Support for Xiaomi Air purifier 3C #888

Closed

arturdobo changed the title ~~Add mb4 support~~ Add support for Xiaomi Air purifier 3C Jan 1, 2021

arturdobo mentioned this pull request Jan 1, 2021

Add Mi Air Purifier 3C (zhimi.airpurifier.mb4) support syssi/xiaomi_airpurifier#117

Open

arturdobo mentioned this pull request Jan 9, 2021

Add Qingping Air Monitor Lite support (cgllc.airm.cgdn1) #900

Merged

rytilahti requested changes Jan 20, 2021

View reviewed changes

miio/airpurifier_miot.py Outdated Show resolved Hide resolved

miio/airpurifier_miot.py Outdated Show resolved Hide resolved

rytilahti requested changes Feb 7, 2021

View reviewed changes

miio/airpurifier_miot.py Outdated Show resolved Hide resolved

miio/airpurifier_miot.py Outdated Show resolved Hide resolved

miio/airpurifier_miot.py Outdated Show resolved Hide resolved

arturdobo and others added 9 commits February 7, 2021 20:46

split into two models

58b03d4

Add test for mb4

f928335

Fixed missing import

652989a

fix favorite level and brightness setting

bbf205a

fixed favorite level in test

505cd0c

applied status review remarks

8ebedeb

Removed unnecessary constructor

7969f8c

Co-authored-by: Teemu R. <[email protected]>

Improved comment

67e92bb

Co-authored-by: Teemu R. <[email protected]>

Removed unnecessary constructor

e944d9c

Co-authored-by: Teemu R. <[email protected]>

fixed linting

d366851

updated readme

ece38be

rytilahti approved these changes Feb 7, 2021

View reviewed changes

rytilahti added the miot label Feb 7, 2021

rytilahti added the new device label Feb 7, 2021

rytilahti merged commit 91ecc98 into rytilahti:master Feb 7, 2021

arturdobo mentioned this pull request Mar 6, 2021

Improve airpurifier doc strings by adding raw responses #961

Merged

rytilahti mentioned this pull request Mar 13, 2021

Prepare 0.5.5 #971

Merged

Repository owner locked as resolved and limited conversation to collaborators Apr 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Xiaomi Air purifier 3C #899

Add support for Xiaomi Air purifier 3C #899

arturdobo commented Jan 1, 2021

pawelnguyen commented Jan 20, 2021

rytilahti left a comment

syssi commented Jan 20, 2021

jagub2 commented Jan 27, 2021

arturdobo commented Jan 27, 2021

arturdobo commented Jan 28, 2021

jagub2 commented Jan 28, 2021

mbatorowicz commented Feb 7, 2021 •

edited

Loading

rytilahti left a comment

arturdobo commented Feb 7, 2021

rytilahti commented Feb 7, 2021

arturdobo commented Feb 7, 2021

rytilahti commented Feb 7, 2021

arturdobo commented Feb 7, 2021

gh0st125 commented Feb 12, 2021 •

edited

Loading

arturdobo commented Feb 12, 2021

gh0st125 commented Feb 12, 2021 •

edited

Loading

arturdobo commented Feb 12, 2021 •

edited

Loading

gh0st125 commented Feb 12, 2021

arturdobo commented Feb 12, 2021

calas80 commented Feb 17, 2021

starkillerOG commented Feb 21, 2021

arturdobo commented Feb 21, 2021

starkillerOG commented Feb 21, 2021

abrilevskiy commented Mar 2, 2021

starkillerOG commented Mar 2, 2021

arturdobo commented Mar 6, 2021 •

edited

Loading

jddipqd commented Apr 12, 2021

rytilahti commented Apr 12, 2021

arturdobo commented Apr 12, 2021

jddipqd commented Apr 12, 2021

Add support for Xiaomi Air purifier 3C #899

Add support for Xiaomi Air purifier 3C #899

Conversation

arturdobo commented Jan 1, 2021

pawelnguyen commented Jan 20, 2021

rytilahti left a comment

Choose a reason for hiding this comment

syssi commented Jan 20, 2021

jagub2 commented Jan 27, 2021

arturdobo commented Jan 27, 2021

arturdobo commented Jan 28, 2021

jagub2 commented Jan 28, 2021

mbatorowicz commented Feb 7, 2021 • edited Loading

rytilahti left a comment

Choose a reason for hiding this comment

arturdobo commented Feb 7, 2021

rytilahti commented Feb 7, 2021

arturdobo commented Feb 7, 2021

rytilahti commented Feb 7, 2021

arturdobo commented Feb 7, 2021

gh0st125 commented Feb 12, 2021 • edited Loading

arturdobo commented Feb 12, 2021

gh0st125 commented Feb 12, 2021 • edited Loading

arturdobo commented Feb 12, 2021 • edited Loading

gh0st125 commented Feb 12, 2021

arturdobo commented Feb 12, 2021

calas80 commented Feb 17, 2021

starkillerOG commented Feb 21, 2021

arturdobo commented Feb 21, 2021

starkillerOG commented Feb 21, 2021

abrilevskiy commented Mar 2, 2021

starkillerOG commented Mar 2, 2021

arturdobo commented Mar 6, 2021 • edited Loading

jddipqd commented Apr 12, 2021

rytilahti commented Apr 12, 2021

arturdobo commented Apr 12, 2021

jddipqd commented Apr 12, 2021

mbatorowicz commented Feb 7, 2021 •

edited

Loading

gh0st125 commented Feb 12, 2021 •

edited

Loading

gh0st125 commented Feb 12, 2021 •

edited

Loading

arturdobo commented Feb 12, 2021 •

edited

Loading

arturdobo commented Mar 6, 2021 •

edited

Loading