Update HomeKit documentation (#5544)

* Address device limit and switch type caching

* ✏️ Corrected typo
This commit is contained in:
Matt Schmitt 2018-06-24 07:26:13 -04:00 committed by Franck Nijhof
parent 9a8df4e118
commit 41055bf484

View File

@ -34,6 +34,10 @@ homekit:
entity_config: entity_config:
alarm_control_panel.home: alarm_control_panel.home:
code: 1234 code: 1234
light.kitchen_table:
name: Kitchen Table Light
lock.front_door:
code: 1234
media_player.living_room: media_player.living_room:
feature_list: feature_list:
- feature: on_off - feature: on_off
@ -114,10 +118,10 @@ homekit:
required: true required: true
type: string type: string
type: type:
description: Only for `switch` entities. Type of accessory to be created within HomeKit. Valid types are `switch` and `outlet`. description: Only for `switch` entities. Type of accessory to be created within HomeKit. Valid types are `switch` and `outlet`. HomeKit will cache the type on the first run so a device must be removed and then re-added for any change to take effect.
required: false required: false
type: string type: string
default: switch default: '`switch`'
{% endconfiguration %} {% endconfiguration %}
<p class='note'> <p class='note'>
@ -151,6 +155,10 @@ After the setup is completed you should be able to control your Home Assistant c
Currently this component uses the `entity_id` to generate a unique `accessory id (aid)` for `HomeKit`. The `aid` is used to identify a device and save all configurations made for it. This however means that if you decide to change an `entity_id` all configurations for this accessory made in the `Home` app will be lost. Currently this component uses the `entity_id` to generate a unique `accessory id (aid)` for `HomeKit`. The `aid` is used to identify a device and save all configurations made for it. This however means that if you decide to change an `entity_id` all configurations for this accessory made in the `Home` app will be lost.
### {% linkable_title Device Limit %}
The HomeKit guidelines only allow a maximum of 100 unique accessories (`aid`) per bridge. Be mindful of this when configuring the filter(s).
### {% linkable_title Persistence Storage %} ### {% linkable_title Persistence Storage %}
Unfortunately `HomeKit` doesn't support any kind of persistent storage - only the configuration for accessories that are added to the `Home Assistant Bridge` are kept. To avoid problems it is recommended to use an automation to always start `HomeKit` with at least the same entities setup. If for some reason some entities are not setup, their config will be deleted. (State unknown or similar will not cause any issues.) Unfortunately `HomeKit` doesn't support any kind of persistent storage - only the configuration for accessories that are added to the `Home Assistant Bridge` are kept. To avoid problems it is recommended to use an automation to always start `HomeKit` with at least the same entities setup. If for some reason some entities are not setup, their config will be deleted. (State unknown or similar will not cause any issues.)