Added doc for homekit #4720

cdce8p · 2018-02-20T21:34:10Z

Description:
Added initial documentation for new HomeKit Component.

Pull request in home-assistant (if applicable): home-assistant/core#12488

Checklist:

Branch: Fixes, changes and adjustments should be created against current. New documentation for platforms/components and features should go to next.
The documentation follow the standards.

arsaboo · 2018-02-20T21:43:12Z

source/_components/homekit.markdown

+---
+layout: page
+title: "Homekit"
+description: "Instructions how to setup the homekit component in Home Assistant."


It should be HomeKit throughout the docs. That is how Apple calls it :)

arsaboo · 2018-02-20T21:45:25Z

source/_components/homekit.markdown

+
+| Issue | Solution |
+| ----- | -------- |
+| Z-Wave components are not available in `HomeKit`. | (See note unter [supported components](#supported-components)) |


typo unter

arsaboo · 2018-02-20T21:47:11Z

source/_components/homekit.markdown

+3. The `Home Assistant` Bridge should be listed their. Select it and follow the instructions to complete the setup.
+
+After the setup is complete you should be able to control your Home Assistant Components through `HomeKit`.
+* If you do have problems with the setup, you might find answers in our [forum](https://community.home-assistant.io/).


Not sure if we need this here. Unless we create a separate thread for HomeKit.

arsaboo · 2018-02-20T21:47:53Z

source/_components/homekit.markdown

+
+## {% linkable_title Supported Components %}
+
+Currently supported are the following components:


The following components are currently supported:

cdce8p · 2018-02-20T21:56:11Z

@arsaboo Fixed your comments

c727 · 2018-02-20T22:10:37Z

source/_components/homekit.markdown

+    type: map
+    keys:
+      pincode:
+        description: Pincode required during setup of HomeKit Home Assistant accessory. The Format needs to be 'XXX-XX-XXX' where X is a number between 1 and 9.


Pin code, format

c727 · 2018-02-20T22:12:22Z

source/_components/homekit.markdown

+
+## {% linkable_title Setup %}
+
+To enable the `HomeKit` component in Home Assistant, add the following to your configurations file:


configuration

c727 · 2018-02-20T22:13:32Z

source/_components/homekit.markdown

+  pincode: '123-45-678'
+```
+
+<p class='note'>It is not recommended to choose '123-45-678' as your pincode! The Pincode must be of the format 'XXX-XX-XXX' where X is a number between 1 and 9.</p>


pin code, 2x . the 2nd part is already written above

c727 · 2018-02-20T22:14:04Z

source/_components/homekit.markdown

+
+<p class='note'>It is not recommended to choose '123-45-678' as your pincode! The Pincode must be of the format 'XXX-XX-XXX' where X is a number between 1 and 9.</p>
+
+After Home Assistant has started, all supported entities (see the [list](#supported-components) belove which entities are already) will be ready to be added to `HomeKit`. To add them:


below, already integrated?

"will exposed to ..."

c727 · 2018-02-20T22:16:23Z

source/_components/homekit.markdown

+<p class='note'>It is not recommended to choose '123-45-678' as your pincode! The Pincode must be of the format 'XXX-XX-XXX' where X is a number between 1 and 9.</p>
+
+After Home Assistant has started, all supported entities (see the [list](#supported-components) belove which entities are already) will be ready to be added to `HomeKit`. To add them:
+1. Open the `HomeKit` App.


the name of the app is Home not homekit

c727 · 2018-02-20T22:16:51Z

source/_components/homekit.markdown

+
+After Home Assistant has started, all supported entities (see the [list](#supported-components) belove which entities are already) will be ready to be added to `HomeKit`. To add them:
+1. Open the `HomeKit` App.
+2. Choose `Add Accessory` and then `Don't Have a Code or Can't Scan?`.


sentence style for capitalization?

Don't Have a Code or Can't Scan? that's how it's written in the app.

so keep it as it's in the app :)

c727 · 2018-02-20T22:17:22Z

source/_components/homekit.markdown

+After Home Assistant has started, all supported entities (see the [list](#supported-components) belove which entities are already) will be ready to be added to `HomeKit`. To add them:
+1. Open the `HomeKit` App.
+2. Choose `Add Accessory` and then `Don't Have a Code or Can't Scan?`.
+3. The `Home Assistant` Bridge should be listed their. Select it and follow the instructions to complete the setup.


there, complete setup

c727 · 2018-02-20T22:17:46Z

source/_components/homekit.markdown

+2. Choose `Add Accessory` and then `Don't Have a Code or Can't Scan?`.
+3. The `Home Assistant` Bridge should be listed their. Select it and follow the instructions to complete the setup.
+
+After the setup is complete you should be able to control your Home Assistant Components through `HomeKit`.


components through Home

c727 · 2018-02-20T22:18:57Z

source/_components/homekit.markdown

+
+| Issue | Solution |
+| ----- | -------- |
+| Z-Wave components are not available in `HomeKit`. | (See note under [supported components](#supported-components)) |


c727 · 2018-02-20T22:27:19Z

source/_components/homekit.markdown

+comments: false
+sharing: true
+footer: true
+ha_category: HomeKit


category should be voice cause of siri.maybe also other

Voice would work.

c727 · 2018-02-20T22:27:48Z

source/_components/homekit.markdown

+ha_category: HomeKit
+ha_release: 0.64
+ha_iot_class:  "Local Polling"
+logo: home-assistant.png


add the correct logo please

I'm not sure if we are allowed to. As far as I know Apple limits the use of it to its certified partners.

I think the Homekit logo is OK ( https://www.ehome-news.de/wp-content/uploads/2014/09/homekit.jpg ), we use tons of other logos and it's not the "works with HomeKit"-logo for certified hardware

It might sound silly, but I'm not comfortable with uploading it myself, since I don't have the rights for the image. Feel free to upload it and we can add it, otherwise I would leave it at the default logo.

c727 · 2018-02-20T22:28:53Z

source/_components/homekit.markdown

+logo: home-assistant.png
+---
+
+The `HomeKit` component allows you to forward entities from Home Assistant to `HomeKit`, so they could be controlled from their as well.


to Apple Home app and Siri

from there

cdce8p · 2018-02-20T22:58:56Z

source/_components/homekit.markdown

+footer: true
+ha_category: HomeKit
+ha_release: 0.64
+ha_iot_class:  "Local Polling"


Is Local Polling the right class? HomeKit doesn't communicate with devices directly and it only works if Home Assistant and your Apple device are in the same local network.

Or just remove the iot class?

remove this key, it's not required

c727 · 2018-02-21T00:27:24Z

requires the image from this PR: #4722

cdce8p · 2018-02-21T03:07:48Z

source/_components/homekit.markdown

+
+<p class='note'>It is not recommended to choose '123-45-678' as your pin code!</p>
+
+After Home Assistant has started, all supported entities (see the [list](#supported-components) below which types are already integrated) will be exposed to `HomeKit`. To add them:


This should be compoments Instead of types. Types are just a way to organize the different adaptaions of a component.

you are right, thanks. OK to merge after this?

cdce8p · 2018-02-21T03:19:48Z

@c727 Should be good now. Thanks for helping making this much better!

ctripodi · 2018-03-02T17:58:53Z

Hi, I configured homekit a few minutes ago. The IOS homekit app do not see my MQTT covers. However, I could see the Temp sensors.
My configuration file have this line:
homekit:
pincode: secret!
cover:
- platform: mqtt
sensor:
- platform: mqtt

How Can I include the covers? Thanks.

cdce8p · 2018-03-02T21:26:47Z

@ctripodi Without more information, it's difficult to say why it isn't working. Add the moment the biggest issue is, that Home Assistant only searches for devices once (at startup). If a device is not registered when the event HOMEASSISTANT_START is send, the device will not be included. That is the issue with Z-Wave which is described in the doc. I'm not sure how MQTT handles it though.

Another reason might be that your cover doesn't support the set_cover_position function, which is a requirement for the current limitation.

A workaround for the time being could be to use a template cover: https://home-assistant.io/components/cover.template/ which controls your MQTT Cover.

I plan to work on those limitations this weekend, so they hopefully will be include in 0.65. If you still need more help, please open a new issue here: https://github.com/home-assistant/home-assistant/issues and include your log. Set the default logging to info and for the HomeKit component to debug: https://home-assistant.io/components/logger/

ctripodi · 2018-03-02T21:42:21Z

Thanks

Added doc for homekit

b08dfcf

arsaboo requested changes Feb 20, 2018

View reviewed changes

Fixed typos

4725103

cdce8p mentioned this pull request Feb 20, 2018

Add support for HomeKit home-assistant/core#12488

Merged

6 tasks

arsaboo previously approved these changes Feb 20, 2018

View reviewed changes

c727 reviewed Feb 20, 2018

View reviewed changes

cdce8p commented Feb 20, 2018

View reviewed changes

Fixed typos 2

3fb9799

cdce8p dismissed arsaboo’s stale review via 3fb9799 February 20, 2018 23:02

Removed iot_class

95f9ef9

c727 mentioned this pull request Feb 21, 2018

Add apple-homekit.png #4722

Merged

Add logo, some cleanup

1635761

c727 previously approved these changes Feb 21, 2018

View reviewed changes

Update homekit.markdown

893c2c3

c727 dismissed their stale review via 893c2c3 February 21, 2018 00:25

c727 previously approved these changes Feb 21, 2018

View reviewed changes

cdce8p commented Feb 21, 2018

View reviewed changes

Changed types to components

b6eb125

cdce8p dismissed c727’s stale review via b6eb125 February 21, 2018 03:18

c727 approved these changes Feb 21, 2018

View reviewed changes

c727 merged commit 12221b5 into home-assistant:next Feb 21, 2018

cdce8p deleted the next-homekit branch February 21, 2018 03:45


		## {% linkable_title Supported Components %}

		Currently supported are the following components:


		## {% linkable_title Setup %}

		To enable the `HomeKit` component in Home Assistant, add the following to your configurations file:


		<p class='note'>It is not recommended to choose '123-45-678' as your pincode! The Pincode must be of the format 'XXX-XX-XXX' where X is a number between 1 and 9.</p>

		After Home Assistant has started, all supported entities (see the [list](#supported-components) belove which entities are already) will be ready to be added to `HomeKit`. To add them:

Uh oh!

Added doc for homekit #4720

Added doc for homekit #4720

Uh oh!

Conversation

cdce8p commented Feb 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cdce8p commented Feb 20, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

c727 Feb 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

c727 Feb 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

c727 commented Feb 21, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cdce8p commented Feb 21, 2018

Uh oh!

ctripodi commented Mar 2, 2018

Uh oh!

cdce8p commented Mar 2, 2018

Uh oh!

ctripodi commented Mar 2, 2018

Uh oh!

Uh oh!

cdce8p commented Feb 20, 2018 •

edited

Loading

c727 Feb 20, 2018 •

edited

Loading

c727 Feb 20, 2018 •

edited

Loading