From 8ae05d0f581f9424e2409fdd57a53be2ac3eaa8c Mon Sep 17 00:00:00 2001 From: Matt Schmitt Date: Sun, 6 May 2018 00:39:47 -0400 Subject: [PATCH 1/5] Initial commit --- source/_components/homekit.markdown | 45 +++++++++++++++++++++++++---- 1 file changed, 40 insertions(+), 5 deletions(-) diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index 7ab434c8902b..8700c05beceb 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -23,6 +23,26 @@ The `HomeKit` component allows you to forward entities from Home Assistant to Ap If you are upgrading Home Assistant from `0.65.x` and have used the HomeKit component, some accessories may not respond or may behave unusually. To fix these problems, you will need to remove the Home Assistant Bridge from your Home, stop Home Assistant and delete the `.homekit.state` file in your configuration folder and follow the Homekit [setup](#setup) steps again.

+```yaml +# Example configuration.yaml entry configuring HomeKit +homekit: + auto_start: true + port: 51827 + ip_address: 192.168.0.100 + filter: + include_domains: + - alarm_control_panel + - light + entity_config: + alarm_control_panel.home: + code: 1234 + light.kitchen_light: + name: Custom name for HomeKit + manufacturer: Acme Inc. + model: A19 Bulb + serial_number: 012345 +``` + {% configuration %} homekit: description: HomeKit configuration. @@ -44,7 +64,7 @@ The `HomeKit` component allows you to forward entities from Home Assistant to Ap required: false type: string filter: - description: Filter entities to available in the `Home` app. ([Configure Filter](#configure-filter)) + description: Filters for entities to include/exclude from HomeKit. ([Configure Filter](#configure-filter)) required: false type: map keys: @@ -69,16 +89,31 @@ The `HomeKit` component allows you to forward entities from Home Assistant to Ap required: false type: map keys: - alarm_control_panel: - description: Additional options for `alarm_control_panel` entities. + '``': + description: Entity specific configuration for HomeKit. required: false type: map keys: + name: + description: Name of entity to show in HomeKit. + required: false + type: string + manufacturer: + description: Manufacturer of entity to show in HomeKit. + required: false + type: string + model: + description: Model of entity to show in HomeKit. + required: false + type: string + serial_number: + description: Serial number of entity to show in HomeKit. + required: false + type: string code: - description: Code to arm or disarm the alarm in the frontend. + description: Code to arm or disarm the alarm in the frontend. Only applicable for `alarm_control_panel` entities. required: false type: string - default: '' {% endconfiguration %}

From ee8c849f4f009fa36fd8b4b028f718456696f8bb Mon Sep 17 00:00:00 2001 From: Matt Schmitt Date: Thu, 10 May 2018 19:22:02 -0400 Subject: [PATCH 2/5] Removed manufacturer, model, and serial number customize --- source/_components/homekit.markdown | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index 8700c05beceb..75028dfed304 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -38,9 +38,6 @@ homekit: code: 1234 light.kitchen_light: name: Custom name for HomeKit - manufacturer: Acme Inc. - model: A19 Bulb - serial_number: 012345 ``` {% configuration %} @@ -98,18 +95,6 @@ homekit: description: Name of entity to show in HomeKit. required: false type: string - manufacturer: - description: Manufacturer of entity to show in HomeKit. - required: false - type: string - model: - description: Model of entity to show in HomeKit. - required: false - type: string - serial_number: - description: Serial number of entity to show in HomeKit. - required: false - type: string code: description: Code to arm or disarm the alarm in the frontend. Only applicable for `alarm_control_panel` entities. required: false From 08a21d1e94de0a89c00b58ac78e9001ab7a63f63 Mon Sep 17 00:00:00 2001 From: Matt Schmitt Date: Fri, 11 May 2018 08:02:52 -0400 Subject: [PATCH 3/5] Small change to explain caching behavior --- source/_components/homekit.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index 75028dfed304..fc358bd590f6 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -92,7 +92,7 @@ homekit: type: map keys: name: - description: Name of entity to show in HomeKit. + description: Name of entity to show in HomeKit. HomeKit will cache the name on the first run so a device must be removed and then re-added for any change to take effect. required: false type: string code: From 6979e53d51aaf760b6662ffd525ff6fce249bc7b Mon Sep 17 00:00:00 2001 From: cdce8p <30130371+cdce8p@users.noreply.github.com> Date: Fri, 11 May 2018 17:08:22 +0200 Subject: [PATCH 4/5] Small changes --- source/_components/homekit.markdown | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index fc358bd590f6..23a576a41a21 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -23,12 +23,10 @@ The `HomeKit` component allows you to forward entities from Home Assistant to Ap If you are upgrading Home Assistant from `0.65.x` and have used the HomeKit component, some accessories may not respond or may behave unusually. To fix these problems, you will need to remove the Home Assistant Bridge from your Home, stop Home Assistant and delete the `.homekit.state` file in your configuration folder and follow the Homekit [setup](#setup) steps again.

+{% raw %} ```yaml # Example configuration.yaml entry configuring HomeKit homekit: - auto_start: true - port: 51827 - ip_address: 192.168.0.100 filter: include_domains: - alarm_control_panel @@ -37,8 +35,9 @@ homekit: alarm_control_panel.home: code: 1234 light.kitchen_light: - name: Custom name for HomeKit + name: "Custom name for HomeKit" ``` +{% endraw %} {% configuration %} homekit: @@ -61,7 +60,7 @@ homekit: required: false type: string filter: - description: Filters for entities to include/exclude from HomeKit. ([Configure Filter](#configure-filter)) + description: Filters for entities to be included / excluded from HomeKit. ([Configure Filter](#configure-filter)) required: false type: map keys: From 2e1200318536e545783051e7fb240b90ed623763 Mon Sep 17 00:00:00 2001 From: cdce8p <30130371+cdce8p@users.noreply.github.com> Date: Fri, 11 May 2018 17:47:29 +0200 Subject: [PATCH 5/5] Revert changes that should go into current --- source/_components/homekit.markdown | 25 +++++-------------------- 1 file changed, 5 insertions(+), 20 deletions(-) diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index 23a576a41a21..2b48b4a488fe 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -23,22 +23,6 @@ The `HomeKit` component allows you to forward entities from Home Assistant to Ap If you are upgrading Home Assistant from `0.65.x` and have used the HomeKit component, some accessories may not respond or may behave unusually. To fix these problems, you will need to remove the Home Assistant Bridge from your Home, stop Home Assistant and delete the `.homekit.state` file in your configuration folder and follow the Homekit [setup](#setup) steps again.

-{% raw %} -```yaml -# Example configuration.yaml entry configuring HomeKit -homekit: - filter: - include_domains: - - alarm_control_panel - - light - entity_config: - alarm_control_panel.home: - code: 1234 - light.kitchen_light: - name: "Custom name for HomeKit" -``` -{% endraw %} - {% configuration %} homekit: description: HomeKit configuration. @@ -60,7 +44,7 @@ homekit: required: false type: string filter: - description: Filters for entities to be included / excluded from HomeKit. ([Configure Filter](#configure-filter)) + description: Filter entities to available in the `Home` app. ([Configure Filter](#configure-filter)) required: false type: map keys: @@ -85,8 +69,8 @@ homekit: required: false type: map keys: - '``': - description: Entity specific configuration for HomeKit. + alarm_control_panel: + description: Additional options for `alarm_control_panel` entities. required: false type: map keys: @@ -95,9 +79,10 @@ homekit: required: false type: string code: - description: Code to arm or disarm the alarm in the frontend. Only applicable for `alarm_control_panel` entities. + description: Code to arm or disarm the alarm in the frontend. required: false type: string + default: '' {% endconfiguration %}