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-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Explain accessory mode for homekit (#15249)

Browse Source
This commit is contained in:
J. Nick Koston 2020-10-15 13:39:41 -05:00 committed by GitHub
parent b02a3d8333
commit 4c39298b60
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
source/_integrations/homekit.markdown
View File

@ -87,6 +87,11 @@ homekit:
description: The local network IP address. Only necessary if the default from Home Assistant does not work.
required: false
type: string
mode:
description: HomeKit can expose an entity via a bridge, or a single entity as an accessory which is needed for Television Media Players. ([Accessory mode](#accessory-mode))
required: false
type: string
default: '`bridge`'
safe_mode:
description: Only set this parameter if you encounter issues during pairing. ([Safe Mode](#safe-mode))
required: false
@ -297,6 +302,16 @@ If you create a HomeKit integration via the UI (i.e., **Configuration** >> **Int
It is recommended to only edit a HomeKit instance in the UI that was created in the UI, and likewise, only edit a HomeKit instance in YAML that was created in YAML.
### Accessory mode
When exposing a Television media player (a `media_player` with device class `tv`) to HomeKit, `mode` must be set to `accessory`, and the include filter should be setup to only include the `media_player` entity. This can be accomplished in the UI with the following steps.
1. Create a new bridge via the UI (i.e., **Configuration** >> **Integrations**)
2. Before pairing the bridge, access the options for the bridge.
3. Change the mode to `accessory`
4. Select the `media_player` entity with the `tv` device class.
5. Complete the options flow and pair as normal.
## Disable Auto Start
Depending on your setup, it might be necessary to disable `Auto Start` for all accessories to be available for `HomeKit`. Only those entities that are fully set up when the `HomeKit` integration is started, can be added. To start `HomeKit` when `auto_start: false`, you can call the service `homekit.start`.