Add Xiaomi Air Purifier 3C #47924

abrilevskiy · 2021-03-14T23:45:49Z

Breaking change

Proposed change

Add Xiaomi Air Purifier 3C support.
Add fan percentage support and split the attributes in different sensor entities.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example entry for `configuration.yaml`:

# Example configuration.yaml

Additional information

This PR fixes or closes issue: fixes Xiaomi Mi Air Purifier 3C (zhimi.airpurifier.mb4) is not available in Xiaomi Miio Device integration #47105
This PR is related to issue: Xiaomi Mi Air Purifier 3C (zhimi.airpurifier.mb4) is not available in Xiaomi Miio Device integration #47105
Link to documentation pull request:

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

homeassistant · 2021-03-14T23:45:50Z

Hi @abrilevskiy,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

probot-home-assistant · 2021-03-14T23:47:26Z

Hey there @rytilahti, @syssi, @starkillerOG, mind taking a look at this pull request as its been labeled with an integration (xiaomi_miio) you are listed as a codeowner for? Thanks!
_{^{(message by CodeOwnersMention)}}

starkillerOG · 2021-03-15T11:30:37Z

Looks good to me, not sure why the tests fail

…into abrilevskiy-xiaomi-mb4

abrilevskiy · 2021-03-15T16:36:32Z

@starkillerOG , all tests are finally gets passed now.

starkillerOG

LGTM

notherealmarco · 2021-03-15T18:30:40Z

I'm testing the integration by running it as a custom component. I'm not able to change the speed of the 3C's fan in manual mode, and I can't see the attributes (like air quality ecc.).

abrilevskiy · 2021-03-15T18:35:43Z

@notherealmarco, I also can not change the speed, but as far as I understand - it is a separate issue. Please let me know otherwise.
I did testing by modification of original Home-Assistant python files and with enabled debug I see the following:

2021-03-15 19:31:16 DEBUG (MainThread) [homeassistant.components.xiaomi_miio.fan] Got new state: <AirPurifierMB4Status aqi=None buzzer=False child_lock=False favorite_rpm=850 filter_hours_used=484 filter_life_remaining=86 is_on=True led_brightness_level=3 mode=OperationMode.Silent motor_speed=392 power=on>
2021-03-15 19:31:46 DEBUG (MainThread) [homeassistant.components.xiaomi_miio.fan] Got new state: <AirPurifierMB4Status aqi=None buzzer=False child_lock=False favorite_rpm=850 filter_hours_used=484 filter_life_remaining=86 is_on=True led_brightness_level=3 mode=OperationMode.Silent motor_speed=392 power=on>
2021-03-15 19:32:16 DEBUG (MainThread) [homeassistant.components.xiaomi_miio.fan] Got new state: <AirPurifierMB4Status aqi=None buzzer=False child_lock=False favorite_rpm=850 filter_hours_used=484 filter_life_remaining=86 is_on=True led_brightness_level=3 mode=OperationMode.Silent motor_speed=388 power=on>

aqi=None - is due to filtering "1"

Could you please check python-miio version (miiocli --version)?

notherealmarco · 2021-03-15T18:46:23Z

I'm running version 0.5.5 (as declared in the manifest.json)

Don't know if this can help, but when it loads the fan entity, it throws an exception, here's the stacktrace:

2021-03-15 19:27:28 INFO (MainThread) [homeassistant.helpers.entity_registry] Registered new fan.xiaomi_miio entity: fan.zhimi_airpurifier_mb4
2021-03-15 19:27:35 ERROR (MainThread) [homeassistant.components.websocket_api.http.connection] [547491654096] The speed_list [] does not contain any valid speeds.
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/components/fan/__init__.py", line 583, in percentage_to_speed
    return percentage_to_ordered_list_item(speed_list, percentage)
  File "/usr/src/homeassistant/homeassistant/util/percentage.py", line 45, in percentage_to_ordered_list_item
    raise ValueError("The ordered list is empty")
ValueError: The ordered list is empty

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/components/websocket_api/commands.py", line 141, in handle_call_service
    await hass.services.async_call(
  File "/usr/src/homeassistant/homeassistant/core.py", line 1488, in async_call
    task.result()
  File "/usr/src/homeassistant/homeassistant/core.py", line 1523, in _execute_service
    await handler.job.target(service_call)
  File "/usr/src/homeassistant/homeassistant/helpers/entity_component.py", line 204, in handle_service
    await self.hass.helpers.service.entity_service_call(
  File "/usr/src/homeassistant/homeassistant/helpers/service.py", line 642, in entity_service_call
    future.result()  # pop exception if have
  File "/usr/src/homeassistant/homeassistant/helpers/entity.py", line 681, in async_request_call
    await coro
  File "/usr/src/homeassistant/homeassistant/helpers/service.py", line 679, in _handle_entity_call
    await result
  File "/usr/src/homeassistant/homeassistant/components/fan/__init__.py", line 275, in async_set_percentage
    await self.async_set_speed(self.percentage_to_speed(percentage))
  File "/usr/src/homeassistant/homeassistant/components/fan/__init__.py", line 585, in percentage_to_speed
    raise NoValidSpeedsError(
homeassistant.components.fan.NoValidSpeedsError: The speed_list [] does not contain any valid speeds.
2021-03-15 19:27:35 INFO (MainThread) [homeassistant.components.automation.error_counting_automation] Error Counting Automation: Running automation actions
2021-03-15 19:27:35 INFO (MainThread) [homeassistant.components.automation.error_counting_automation] Error Counting Automation: Executing step call service
2021-03-15 19:27:36 ERROR (MainThread) [homeassistant.components.websocket_api.http.connection] [547491654096] The speed_list [] does not contain any valid speeds.
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/components/fan/__init__.py", line 583, in percentage_to_speed
    return percentage_to_ordered_list_item(speed_list, percentage)
  File "/usr/src/homeassistant/homeassistant/util/percentage.py", line 45, in percentage_to_ordered_list_item
    raise ValueError("The ordered list is empty")
ValueError: The ordered list is empty

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/components/websocket_api/commands.py", line 141, in handle_call_service
    await hass.services.async_call(
  File "/usr/src/homeassistant/homeassistant/core.py", line 1488, in async_call
    task.result()
  File "/usr/src/homeassistant/homeassistant/core.py", line 1523, in _execute_service
    await handler.job.target(service_call)
  File "/usr/src/homeassistant/homeassistant/helpers/entity_component.py", line 204, in handle_service
    await self.hass.helpers.service.entity_service_call(
  File "/usr/src/homeassistant/homeassistant/helpers/service.py", line 642, in entity_service_call
    future.result()  # pop exception if have
  File "/usr/src/homeassistant/homeassistant/helpers/entity.py", line 681, in async_request_call
    await coro
  File "/usr/src/homeassistant/homeassistant/helpers/service.py", line 679, in _handle_entity_call
    await result
  File "/usr/src/homeassistant/homeassistant/components/fan/__init__.py", line 275, in async_set_percentage
    await self.async_set_speed(self.percentage_to_speed(percentage))
  File "/usr/src/homeassistant/homeassistant/components/fan/__init__.py", line 585, in percentage_to_speed
    raise NoValidSpeedsError(
homeassistant.components.fan.NoValidSpeedsError: The speed_list [] does not contain any valid speeds.

abrilevskiy · 2021-03-15T18:59:57Z

I see the same exception when try to change Fan speed, but other functionality works:

notherealmarco · 2021-03-15T19:05:01Z

@abrilevskiy that's what I have:

And this is the configuration (I also triend setting it up from the UI):

fan:
  - platform: xiaomi_miio
    name: map_fan
    host: 192.168.188.74
    token: <my_beautiful_token>
    model: zhimi.airpurifier.mb4

Sould I try running the component by replacing the HA files instead of running it as a custom component?

abrilevskiy · 2021-03-15T20:02:54Z

Config file should not be used - wizard is implemented in latest release.
If wizard would not help - could you please try replacing the original files and let me know the results please.

notherealmarco · 2021-03-17T10:00:42Z

@abrilevskiy

Tried both, but the result is the same. The fan entity still doesn't have all the attributes

abrilevskiy · 2021-03-17T11:54:18Z

@notherealmarco , Could you please provide logs?
The attributes will be empty in case if regular AirPurifierMiot class is used to communicate with device, but in fan.py it is an implicit condition:

    if model == MODEL_AIRPURIFIER_3C:
        air_purifier = AirPurifierMB4(host, token)

notherealmarco · 2021-03-18T15:52:11Z

@abrilevskiy

These are the logs, I have set the logging level to debug (homeassistant.components.xiaomi_miio: debug)

2021-03-18 16:45:19 INFO (MainThread) [homeassistant.components.fan] Setting up fan.xiaomi_miio
2021-03-18 16:45:21 DEBUG (MainThread) [homeassistant.components.xiaomi_miio.fan] Initializing with host 192.168.188.74 (token f024a...)
...
2021-03-18 16:45:23 DEBUG (MainThread) [homeassistant.components.xiaomi_miio.fan] Got new state: <AirPurifierMB4Status aqi=None buzzer=False child_lock=False favorite_rpm=750 filter_hours_used=118 filter_life_remaining=97 is_on=True led_brightness_level=8 mode=OperationMode.Favorite motor_speed=748 power=on>
...
2021-03-18 16:45:28 DEBUG (MainThread) [homeassistant.components.xiaomi_miio.fan] Got new state: <AirPurifierMB4Status aqi=None buzzer=False child_lock=False favorite_rpm=750 filter_hours_used=118 filter_life_remaining=97 is_on=True led_brightness_level=8 mode=OperationMode.Favorite motor_speed=752 power=on>

Seems to be using the right class. The attributer are there in the logs, but not on the entity in HA.

I also tried miiocli (in the same container), and it shows well all the attributes.

MartinHjelmare

The AVAILABLE_ATTRIBUTES_AIRFRESH attributes also seem to contain some measurements that should be sensor entities and not fan attributes, eg temperature, aqi, average_aqi, co2, humidity. It would be good to move them too.

homeassistant/components/xiaomi_miio/fan.py

MartinHjelmare · 2021-04-15T12:01:27Z

homeassistant/components/xiaomi_miio/fan.py

    ATTR_TEMPERATURE: "temperature",
    ATTR_HUMIDITY: "humidity",


Temperature and humidity should also be separate sensor entities. Please move these as well.

This Air Purifier model (3C) does not have neither temperature nor humidity

@MartinHjelmare this comment seems unrelated to the pull request, which simply aims to add support for the 3C model.

The temperature and humidity values are already listed as attributes in the original home-assistant repo: https://github.com/home-assistant/core/blob/dev/homeassistant/components/xiaomi_miio/fan.py#L167

Could you open a separate issue to aim to improve this by splitting out the mentioned attributes as sensor entities?

The current code is already scoped beyond adding support for the 3C model, which you can see if you read the sensor platform additions. If we only want that scope, we'll need to slim that part down.

homeassistant/components/xiaomi_miio/fan.py

andrey-skat · 2021-05-20T10:08:50Z

@abrilevskiy do you need help with this PR?

KalleKalee · 2021-05-21T11:57:34Z

Any help needed?

malfroid · 2021-05-23T12:19:21Z

Can I help out with this? What remains to be done to approve this PR?

I am waiting for this integration to control my 3C model. The PR has been open for more than 2 months now.

MartinHjelmare · 2021-05-23T15:24:14Z

The comments need to be addressed.

notherealmarco · 2021-05-25T18:22:56Z

Can I help out with this? What remains to be done to approve this PR?

I am waiting for this integration to control my 3C model. The PR has been open for more than 2 months now.

I'm sorry, I'm preparing 4 exams for the university and i have no time right now to finish addressing the issues. I will continue in July, when the exam session will be over

…n.py Co-authored-by: Kasper Malfroid <kasper@malfroid.be>

MartinHjelmare · 2021-06-23T07:45:18Z

Other PRs have overtaken this PR and this PR is no longer correct. We have moved the humidifiers to a new humidifier platform in #51884. And in #51791 we have implemented percentage based fan control.

I suggest we close this PR and take a new look at adding any remaining missing device support after the other work is merged.

andrey-skat · 2021-06-23T09:24:49Z

@MartinHjelmare Is humidifier platform will be correct for this device? This device is purifier and not humidifier, it has only fan control and pm2.5 sensor.

MartinHjelmare · 2021-06-23T09:32:50Z

No this new device should still be a fan and a sensor entity. Currently though this PR has other changes that are in conflict with the ongoing restructuring work. So at minimum we'll need to rebase here when that work is done.

mouth4war · 2021-06-26T21:55:05Z

@MartinHjelmare FWIW, this PR seems to have a better implementation of fan speed percentage than the already merged #51791. This PR uses the motor speed instead of the 'fan' preset and associated 3 speed presets, so it enables finer control of fan speed.

@notherealmarco can you confirm that your implementation enables more points (300-1200rpm mapped to 0-100%) in your testing?

jbouwh · 2021-06-28T09:22:34Z

@MartinHjelmare FWIW, this PR seems to have a better implementation of fan speed percentage than the already merged #51791. This PR uses the motor speed instead of the 'fan' preset and associated 3 speed presets, so it enables finer control of fan speed.

@notherealmarco can you confirm that your implementation enables more points (300-1200rpm mapped to 0-100%) in your testing?
#51791 uses the build in modes, not motor speeds.
For Humidifiers the fan platform wil not be used anymore in future. We will be adding a motor_speed controller using the number integration to support humidifies, but that can be expanded for airpurifiers if needed.

See #52173.

P.S. Of course motor speed could be in the Fan platform instead of the build in modes, but that would not be compatible with what the uses sees on the indicators on the device. I would prefer to use the build in modes only and a additional motor_speed controller.

mouth4war · 2021-06-30T17:47:06Z

I see your rationale makes sense but how many people even look at their air purifiers anymore. The
mode icon is tiny and you need to go up to the purifier to squint at it. Most of display space shows AQI. If using favorite speed, the purifier will show a heart icon for favorite mode so it will indicate custom speed in use. It won't show the exact speed though.

The idea is to automate the fan speed and the finer control is more useful. Using the service approach means homeassistant will not display or change service-set fan speed in UI. I think this is a bigger issue that users already face (with existing favorite levels).

Mapping favorite speeds to fan speed percentage will make home assistant more consistent (fan speed set via service in automation will match HASS UI fan speed slider and further integrations like Homekit also).

I think we should prioritize this as defining your own custom handling of fan speed is one of the key benefits of using HASS to control air purifiers. You can use automations to override factory handling of fan speeds in response to AQI and just 3 steps doesn't make this happen. So users will have to use the service and deal with broken fan speeds in UI and beyond, again.

TpHa1 · 2021-08-09T16:38:22Z

newbie. how to add 3c to HA step by step please.
thank you

randarth · 2021-08-18T08:06:51Z

This PR seems to have been abandoned. Maybe somebody can take over and finish it?

bieniu · 2021-08-18T08:43:42Z

Hi, I can help but I don't have this model at home so... please contact me on Discord (Bieniu#4759) or Messenger (Maciej Bieniek).

r4ian · 2021-08-30T13:39:06Z

@syssi @starkillerOG @rytilahti

Could some of you please check this case? Not trying to push you, just wondering if anyone is working on it or it is forgotten.

Maybe @arturdobo or @abrilevskiy can help if there is no capacity for development (found you guys in related issues/PRs, sorry for tagging if you can't help here)

I have this model if you need help testing.

bieniu · 2021-08-30T13:56:59Z

@r4ian You can test this draft https://github.com/home-assistant/core/compare/dev...bieniu:xiaomi-miio-zhimi.airpurifier.mb4?expand=1

starkillerOG · 2021-08-30T20:44:42Z

@r4ian I would love to help, but I don't own a xiaomi air purifier, so it is hard for me to develop and test code for it.
So unless someone arranges one for me, I will not be of much help, sorry.

Xiaomi Air Purifier 3C support is added

7ba7a5b

homeassistant added the cla-needed label Mar 14, 2021

probot-home-assistant bot added the integration: xiaomi_miio label Mar 14, 2021

project-bot bot added this to Needs review in Dev Mar 14, 2021

probot-home-assistant bot assigned rytilahti and syssi Mar 14, 2021

homeassistant added cla-signed and removed cla-needed labels Mar 14, 2021

abrilevskiy added 3 commits March 15, 2021 02:57

Sorting issues are fixed

7adfcb3

Typo is fixed

ebae15d

Typo #2 is fixed

c673901

abrilevskiy added 3 commits March 15, 2021 16:10

Xiaomi Air Purifier 3C support is added

96751fe

Merge branch 'abrilevskiy-xiaomi-mb4' of github.com:abrilevskiy/core …

1e49910

…into abrilevskiy-xiaomi-mb4

MODEL_AIRPURIFIER_3C is added to const.py

baccb7c

starkillerOG approved these changes Mar 15, 2021

View reviewed changes

abrilevskiy added 2 commits March 17, 2021 00:02

Merge branch 'dev' into abrilevskiy-xiaomi-mb4

f545f7c

Unused imports were removed

ce04292

notherealmarco approved these changes Apr 15, 2021

View reviewed changes

MartinHjelmare requested changes Apr 15, 2021

View reviewed changes

Dev automation moved this from Needs review to Review in progress Apr 15, 2021

MartinHjelmare changed the title ~~Xiaomi Air Purifier 3C support is added (incl. fan percentage support and splits the attributes in different sensor entities)~~ Add Xiaomi Air Purifier 3C Apr 15, 2021

This comment has been minimized.

Sign in to view

Update percentage calculation homeassistant/components/xiaomi_miio/fa…

e457e7c

…n.py Co-authored-by: Kasper Malfroid <kasper@malfroid.be>

MartinHjelmare marked this pull request as draft June 23, 2021 07:45

MartinHjelmare mentioned this pull request Jun 28, 2021

Add Xiaomi_miio controls for humidifier - controls for motor speeds #52173

Merged

21 tasks

starkillerOG mentioned this pull request Jul 2, 2021

Can't find Purifier or Humidifier in Xiamo_miio home-assistant/home-assistant.io#18330

Closed

bieniu mentioned this pull request Aug 31, 2021

Add support for Xiaomi Miio Air Purifier 3C #55484

Merged

22 tasks

MartinHjelmare closed this in #55484 Aug 31, 2021

Dev automation moved this from Review in progress to Cancelled Aug 31, 2021

github-actions bot locked and limited conversation to collaborators Sep 1, 2021

Add Xiaomi Air Purifier 3C #47924

Add Xiaomi Air Purifier 3C #47924

Conversation

abrilevskiy commented Mar 14, 2021 • edited by MartinHjelmare

Breaking change

Proposed change

Type of change

Example entry for configuration.yaml:

Additional information

Checklist

homeassistant commented Mar 14, 2021

probot-home-assistant bot commented Mar 14, 2021

starkillerOG commented Mar 15, 2021

abrilevskiy commented Mar 15, 2021

starkillerOG left a comment

Choose a reason for hiding this comment

notherealmarco commented Mar 15, 2021

abrilevskiy commented Mar 15, 2021 • edited

notherealmarco commented Mar 15, 2021 • edited

abrilevskiy commented Mar 15, 2021

notherealmarco commented Mar 15, 2021 • edited

abrilevskiy commented Mar 15, 2021

notherealmarco commented Mar 17, 2021 • edited

abrilevskiy commented Mar 17, 2021

notherealmarco commented Mar 18, 2021 • edited

MartinHjelmare left a comment

Choose a reason for hiding this comment

MartinHjelmare Apr 15, 2021

Choose a reason for hiding this comment

forast3r May 14, 2021

Choose a reason for hiding this comment

malfroid May 23, 2021

Choose a reason for hiding this comment

MartinHjelmare May 23, 2021

Choose a reason for hiding this comment

This comment has been minimized.

andrey-skat commented May 20, 2021

KalleKalee commented May 21, 2021

malfroid commented May 23, 2021

MartinHjelmare commented May 23, 2021

notherealmarco commented May 25, 2021

MartinHjelmare commented Jun 23, 2021

andrey-skat commented Jun 23, 2021

MartinHjelmare commented Jun 23, 2021

mouth4war commented Jun 26, 2021 • edited

jbouwh commented Jun 28, 2021 • edited

mouth4war commented Jun 30, 2021 • edited

TpHa1 commented Aug 9, 2021

randarth commented Aug 18, 2021

bieniu commented Aug 18, 2021

r4ian commented Aug 30, 2021 • edited

bieniu commented Aug 30, 2021

starkillerOG commented Aug 30, 2021

abrilevskiy commented Mar 14, 2021 •

edited by MartinHjelmare

Example entry for `configuration.yaml`:

abrilevskiy commented Mar 15, 2021 •

edited

notherealmarco commented Mar 15, 2021 •

edited

notherealmarco commented Mar 15, 2021 •

edited

notherealmarco commented Mar 17, 2021 •

edited

notherealmarco commented Mar 18, 2021 •

edited

mouth4war commented Jun 26, 2021 •

edited

jbouwh commented Jun 28, 2021 •

edited

mouth4war commented Jun 30, 2021 •

edited

r4ian commented Aug 30, 2021 •

edited