jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-28 19:57:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update HomeKit docs for air purifiers (#38417)

Browse Source
This commit is contained in:
Maarten Staa 2025-04-11 07:39:51 +02:00 committed by GitHub
parent 1ae640718d
commit ed066a8b1c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
source/_integrations/homekit.markdown
View File

@ -58,6 +58,9 @@ homekit:
binary_sensor.living_room_motion:
linked_battery_sensor: sensor.living_room_motion_battery
low_battery_threshold: 31
fan.air_purifier:
type: air_purifier
linked_filter_life_level_sensor: sensor.air_purifier_filter_life_level
light.kitchen_table:
name: Kitchen Table Light
lock.front_door:
@ -163,10 +166,22 @@ homekit:
description: The `entity_id` of a `binary_sensor` or `event` entity to use as the doorbell sensor of a `lock` or `camera` accessory to enable doorbell notifications.
required: false
type: string
linked_filter_change_indication_binary_sensor:
description: The `entity_id` of a `binary_sensor` entity to use as the indicator that the filter of the air purifier accessory needs to be changed.
required: false
type: string
linked_filter_life_level_sensor:
description: The `entity_id` of a `sensor` entity to use as the filter life level of the air purifier accessory.
required: false
type: string
linked_humidity_sensor:
description: The `entity_id` of a `sensor` entity to use as the humidity sensor of the humidifier/dehumidifier accessory.
required: false
type: string
linked_pm25_sensor:
description: The `entity_id` of a `sensor` entity to use as the PM2.5 sensor of the air purifier accessory. When set, the `fan` accessory will default its `type` to `air_purifier`.
required: false
type: string
linked_motion_sensor:
description: The `entity_id` of a `binary_sensor` or `event` entity to use as the motion sensor of the camera accessory to enable motion notifications.
required: false
@ -175,6 +190,10 @@ homekit:
description: The `entity_id` of a `binary_sensor` entity to use as the obstruction sensor of the garage door (cover) accessory to enable obstruction state tracking.
required: false
type: string
linked_temperature_sensor:
description: The `entity_id` of a `sensor` entity to use as the temperature sensor of the air purifier accessory.
required: false
type: string
low_battery_threshold:
description: Minimum battery level before the accessory starts reporting a low battery.
required: false
@ -195,7 +214,7 @@ homekit:
required: true
type: string
type:
description: Only for `switch` entities. Type of accessory to be created within HomeKit. Valid types are `faucet`, `outlet`, `shower`, `sprinkler`, `switch` and `valve`.
description: Only for `switch` and `fan` entities. Type of accessory to be created within HomeKit. Valid types for `switch` entities are `faucet`, `outlet`, `shower`, `sprinkler`, `switch` and `valve`. Valid types for `fan` entities are `fan` and `air_purifier`.
required: false
type: string
default: '`switch`'
@ -417,8 +436,8 @@ The following integrations are currently supported:
| cover | WindowCovering | All covers that support `open_cover` and `close_cover` through value mapping. (`open` -> `>=50`; `close` -> `<50`) |
| cover | WindowCovering | All covers that support `open_cover`, `stop_cover` and `close_cover` through value mapping. (`open` -> `>70`; `close` -> `<30`; `stop` -> every value in between) |
| device_tracker / person | Sensor | Support for `occupancy` device class. |
| fan | Fan | Support for `on / off`, `direction` and `oscillating`. |
| fan | Fan | All fans that support `speed` and `speed_list` through value mapping: `speed_list` is assumed to contain values in ascending order. The numeric ranges of HomeKit map to a corresponding entry of `speed_list`. The first entry of `speed_list` should be equivalent to `off` to match HomeKit's concept of fan speeds. (Example: `speed_list` = [`off`, `low`, `high`]; `off` -> `<= 33`; `low` -> between `33` and `66`; `high` -> `> 66`) |
| fan | Fan / AirPurifier | Support for `on / off`, `direction` and `oscillating`. Represented as a fan by default but can be changed by using `type` within `entity_config`. Defaults to an air purifier when there's a linked PM2.5 sensor. |
| fan | Fan / AirPurifier | All fans that support `speed` and `speed_list` through value mapping: `speed_list` is assumed to contain values in ascending order. The numeric ranges of HomeKit map to a corresponding entry of `speed_list`. The first entry of `speed_list` should be equivalent to `off` to match HomeKit's concept of fan speeds. (Example: `speed_list` = [`off`, `low`, `high`]; `off` -> `<= 33`; `low` -> between `33` and `66`; `high` -> `> 66`). The same applies for fans represented as air purifiers (see above). |
| humidifier | HumidifierDehumidifier | Humidifier and Dehumidifier devices. |
| light | Light | Support for `on / off`, `brightness` and `rgb_color`. |
| lock | DoorLock | Support for `lock / unlock`. A doorbell event / sensor can be linked with `linked_doorbell_sensor`. |