Support air purifier device type in homekit

mouth4war · December 10, 2019, 2:25pm

Currently, HASS-homekit exposes air purifiers as fans in homekit while homekit now has air-purifier device type that is being used by homebridge plugins (https://github.com/clauzewitz/homebridge-xiaomi-purifier#readme).

Request is to support air-purifiers as a device class in homekit integration.

Benefits:
Full features: reports temperature, humidity, aqi
Additional features: control led, buzzer, mode

Mistic92 · March 23, 2020, 9:00pm

Would be nice to have it also for Google Assistant

damianpasek · September 23, 2020, 8:08pm

Any update on that issue?

renelou · October 16, 2020, 11:45pm

Interested on this feature as well, would like to have the correct AQI mappings in homekit.

zinogo · November 5, 2020, 5:34am

This feature will help to control air purifier that support homekit only.

SimplyGardner · October 27, 2021, 7:40pm

I’d love to see this too. It just currently just operating as a fan.

ak6i · September 5, 2022, 7:30am

I’d like to add my vote to this. I’m trying to migrate my devices from Homebridge to Homeassistant, and this is one of the things blocking me.

I added support for a few of my devices to Homebridge, so I’m hoping that I’ll have enough transferrable skills to make a stab at this. I’ll need to understand the device/entity structure that Homeassistant uses figure out how the Homekit component handles composite devices, brush up on my Python, and figure out how to deploy a test version to my Homeassistant box. How hard can it be?

ak6i · November 21, 2022, 5:44pm

I made some adjustments to the Homekit component that treat any fan device with an associated PM2.5 sensor as an air purifier. You can see it here: GitHub - ak6i/core at homekit_air_purifier

If you want to use this in your Home Assistant configuration, you can copy the homeassistant/components/homekit directory into your config/custom_components directory (easiest is to add the SMB add-on), and add a line to the manifest.json like:
"version" : "0.99.0",

Restart and the changes will appear. You may need to remove and re-add your Homekit bridge from the Home app on your Apple device to make things work completely.

mouth4war · November 21, 2022, 7:27pm

Nice! Do you intend to add it to official?

ak6i · November 26, 2022, 4:37pm

That’s the plan. I’ve got a PR open but it’ll need some work for me to get it into good enough shape (Python’s not my first language, new codebase, and other excuses).

In the meantime, do feel free to try it out and let me know any feedback you have!

ashot · December 4, 2022, 3:32pm

Tried it, doesn’t work as Air Purifier. Also, could not find anything air purifier related in your code.

Mathjkt · December 8, 2022, 2:56pm

Tried it with a Levoit 300s and I wasn’t able to make it work. I’m quite confident I installed your HomeKit component correctly.

ak6i · January 22, 2023, 8:32am

The code is there. Take a look at core/type_air_purifiers.py at ec27121d0a7fb9587d9dcc2c5e24b32c0b803823 · ak6i/core · GitHub for example.

I can’t guarantee that this code will work with all air purifiers because I have a limited set to test with. This should theoretically work with any device that exposes both a fan and a PM2.5 sensor to Home Assistant. You may also have to do the happy dance of removing and re-adding your Home Assistant to HomeKit, removing and re-adding your air purifier from Home Assistant, or some similar action.

someone_else · May 8, 2023, 6:10pm

How do I access homeassistant/components/homekit ??

With the SMB add-on one can only see config/custom-components. But how do I get to core/homeassistant/components/homekit/ ??

Thanx

mouth4war · June 27, 2023, 7:28pm

Would be great to see this make its way to HA core. Why don’t you submit it for review?

lilyball · January 8, 2024, 12:35am

I really want this too. I’m trying to migrate my Dyson fans from Homebridge to Home Assistant and the lack of Air Purifier support means I can’t group the fan and the thermostat together.

@ak6i I found your PR, but it looks like it’s been closed for inactivity. Do you have any plans to pick up the PR again?

github.com/home-assistant/core

Add support for air purifier devices in HomeKit

home-assistant:dev ← ak6i:homekit_air_purifier

opened 06:40PM - 21 Nov 22 UTC

ak6i

+485 -13

## Breaking change  ## Proposed change  Any fan and PM2.5 in the same device will be combined treated as an air purifier. Also, temperature and humidity sensors that are part of the same device will be combined into the air purifier device. type_air_purifiers.py heavily based on type_fans.py - I tried extending type_fans.py but this looked better to me. Since this is my first day working with the homeassistant codebase, I'm open to hearing how this PR can be improved on, and also to collaboration on improving it - especially if you have an air purifier and you know there are things that can be trivially added. It looks to me like the structure of homeassistant and lack of common standards across integrations like Tuya and Xiaomi means that some functionality (e.g. filter lifetime, display lighting, modes) will be hard to implement. ## Type of change  - [ ] Dependency upgrade - [ ] Bugfix (non-breaking change which fixes an issue) - [ ] New integration (thank you!) - [x] New feature (which adds functionality to an existing integration) - [ ] Deprecation (breaking change to happen in the future) - [ ] Breaking change (fix/feature causing existing functionality to break) - [ ] Code quality improvements to existing code or addition of tests ## Additional information  - This PR fixes or closes issue: fixes # - This PR is related to issue: - Link to documentation pull request: ## Checklist  - [x] The code change is tested and works locally. - [x] Local tests pass. **Your PR cannot be merged unless tests pass** - [x] There is no commented out code in this PR. - [x] I have followed the [development checklist][dev-checklist] - [x] 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][docs-repository] If the code communicates with devices, web services, or third-party tools: - [ ] The [manifest file][manifest-docs] 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`. - [ ] For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description. - [ ] Untested files have been added to `.coveragerc`.  To help with the load of incoming pull requests: - [ ] I have reviewed two other [open pull requests][prs] in this repository. [prs]: https://github.com/home-assistant/core/pulls?q=is%3Aopen+is%3Apr+-author%3A%40me+-draft%3Atrue+-label%3Awaiting-for-upstream+sort%3Acreated-desc+review%3Anone+-status%3Afailure  [dev-checklist]: https://developers.home-assistant.io/docs/en/development_checklist.html [manifest-docs]: https://developers.home-assistant.io/docs/en/creating_integration_manifest.html [quality-scale]: https://developers.home-assistant.io/docs/en/next/integration_quality_scale_index.html [docs-repository]: https://github.com/home-assistant/home-assistant.io

400HPMustang · January 10, 2024, 5:34pm

@ak6i it would be really great if you could pick this up again. This is the last device class I need and I can remove the Tradfri gateway. All of my Zigbee devices will be migrated to Sky Connect. I just can’t do it without the air purifiers importing correctly into HomeKit.

nicodeimos · April 11, 2024, 9:47am

Big up for this, I also need HomeKit bridge to be updated to support air purifiers. @ak6i can you please revive this?

ak6i · April 15, 2024, 1:44pm

Hi,

I don’t have much time on my hands right now, but you can copy the homekit directory from core/homeassistant/components at homekit_air_purifier · ak6i/core · GitHub into your custom_components directory and then you’ll get the changes. There aren’t many updates to the homekit component so you should be fairly safe.

The only reason the PR didn’t make it in is due to a lack of unit tests. If anyone wants to contribute them before I get the time to write them, you’d be very welcome to do so

nicodeimos · April 15, 2024, 1:53pm

God I wish I knew how to code those unit tests.

Does your file will get erased if it is not integrated in the official codebase, and I there is HomeKit bridge update?

Thanks! Anyone with the required knowledge to take over this by any chance? I’m happy to test and help if necessary!