|
| 1 | +--- |
| 2 | +layout: page |
| 3 | +title: "HomeKit" |
| 4 | +description: "Instructions how to setup the HomeKit component in Home Assistant." |
| 5 | +date: 2018-02-20 17:30 |
| 6 | +sidebar: true |
| 7 | +comments: false |
| 8 | +sharing: true |
| 9 | +footer: true |
| 10 | +ha_category: Voice |
| 11 | +ha_release: 0.64 |
| 12 | +logo: apple-homekit.png |
| 13 | +--- |
| 14 | + |
| 15 | +The `HomeKit` component allows you to forward entities from Home Assistant to Apple `HomeKit`, so they could be controlled from Apple `Home` app and `Siri`. |
| 16 | + |
| 17 | +{% configuration %} |
| 18 | + homekit: |
| 19 | + description: HomeKit configuration. |
| 20 | + required: true |
| 21 | + type: map |
| 22 | + keys: |
| 23 | + pincode: |
| 24 | + description: Pin code 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. |
| 25 | + required: false |
| 26 | + type: string |
| 27 | + default: '"123-45-678"' |
| 28 | + port: |
| 29 | + description: Port for the HomeKit extension. |
| 30 | + required: false |
| 31 | + type: int |
| 32 | + default: 51826 |
| 33 | +{% endconfiguration %} |
| 34 | + |
| 35 | +## {% linkable_title Setup %} |
| 36 | + |
| 37 | +To enable the `HomeKit` component in Home Assistant, add the following to your configuration file: |
| 38 | + |
| 39 | +```yaml |
| 40 | +# Example for HomeKit setup |
| 41 | +homekit: |
| 42 | + pincode: '123-45-678' |
| 43 | +``` |
| 44 | +
|
| 45 | +<p class='note'>It is not recommended to choose '123-45-678' as your pin code!</p> |
| 46 | +
|
| 47 | +After Home Assistant has started, all supported entities (see the [list](#supported-components) below which components are already integrated) will be exposed to `HomeKit`. To add them: |
| 48 | +1. Open the `Home` App. |
| 49 | +2. Choose `Add Accessory` and then `Don't Have a Code or Can't Scan?`. |
| 50 | +3. The `Home Assistant` Bridge should be listed there. Select it and follow the instructions to complete setup. |
| 51 | + |
| 52 | +After the setup is completed you should be able to control your Home Assistant components through `Home` and `Siri`. |
| 53 | + |
| 54 | +## {% linkable_title Supported Components %} |
| 55 | + |
| 56 | +The following components are currently supported: |
| 57 | + |
| 58 | +| Component | Type Name | Description | |
| 59 | +| --------- | --------- | ----------- | |
| 60 | +| cover | Window | All covers that support `set_cover_position`. | |
| 61 | +| sensor | TemperatureSensor | All sensors that have `Celsius` as their `unit_of_measurement`. | |
| 62 | + |
| 63 | +<p class='note'>Currently only devices that are setup when Home Assistant is starting can be exposed to `HomeKit`. This means that especially `Z-Wave` components are currently not supported, since they will be setup afterwards. We are working on a solution for this problem.</p> |
0 commit comments