HomeKit


The HomeKit component allows you to forward entities from Home Assistant to Apple HomeKit, so they can be controlled from Apple’s Home app and Siri. Please make sure that you have read the considerations listed below to save you some trouble later.

It might be necessary to install an additional package: $ sudo apt-get install libavahi-compat-libdnssd-dev

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 steps again.

# Example configuration.yaml entry configuring HomeKit
homekit:
  filter:
    include_domains:
      - alarm_control_panel
      - light
      - media_player
  entity_config:
    alarm_control_panel.home:
      code: 1234
    media_player.living_room:
      feature_list:
        - feature: on_off
        - feature: play_pause
        - feature: play_stop
        - feature: toggle_mute
    switch.bedroom_outlet:
      type: outlet

Configuration Variables

homekit

(map)(Required)HomeKit configuration.

auto_start

(boolean)(Optional)Flag if the HomeKit Server should start automatically after the Home Assistant Core Setup is done. (Disable Auto Start)

Default value: true

port

(int)(Optional)Port for the HomeKit extension.

Default value: 51827

ip_address

(string)(Optional)The local network IP address. Only necessary if the default from Home Assistant does not work.

filter

(map)(Optional)Filters for entities to be included / excluded from HomeKit. (Configure Filter)

include_domains

(list)(Optional)Domains to be included.

include_entities

(list)(Optional)Entities to be included.

exclude_domains

(list)(Optional)Domains to be excluded.

exclude_entities

(list)(Optional)Entities to be excluded.

entity_config

(map)(Optional)Configuration for specific entities. All subordinate keys are the corresponding entity ids to the domains, e.g. alarm_control_panel.alarm.

<ENTITY_ID>

(map)(Optional)Additional options for specific entities.

name

(string)(Optional)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.

code

(string)(Optional)Code to arm / disarm an alarm or lock / unlock a lock. Only applicable for alarm_control_panel or lock entities.

Default value: <No code>

feature_list

(list)(Optional)Only for media_player entities. List of feature dictionaries to add for a given entity. Comparable to the platform schema.

feature

(string)(Required)Name of the feature to add to the entity representation. Valid features are on_off, play_pause, play_stop and toogle_mute. The media_player entity must support the feature to be valid.

type

(string)(Optional)Only for switch entities. Type of accessory to be created within HomeKit. Valid types are switch and outlet.

Default value: switch

If you use Z-Wave, or discovery: you’ll need to disable auto-start, see the section below for details on how to do this. You’ll then need to start the HomeKit component once Z-Wave is ready, or an appropriate delay to allow your entities to be discovered.

Setup

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

# Example for HomeKit setup
homekit:

After Home Assistant has started, the entities specified by the filter are exposed to HomeKit if they are supported. To add them:

  1. Open the Home Assistant frontend. A new card will display the pin code.
  2. Open the Home app.
  3. Choose Add Accessory, than select Don't Have a Code or Can't Scan? and enter the pin code.
  4. Confirm the you are adding an Uncertified Accessory by clicking on Add Anyway.
  5. Follow the setup be clicking on Next and lastly Done in the top right hand corner.
  6. The Home Assistant Bridge and the Accessories should now be listed in the Home app.

After the setup is completed you should be able to control your Home Assistant components through Home and Siri.

Considerations

Accessory ID

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.

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.)

A common situation might be if you decide to disable parts of the configuration for testing. Please make sure to disable auto start and turn off the Start HomeKit automation (if you have one).

Disable Auto Start

Depending on your individual setup, it might be necessary to disable Auto Start for all accessories to be available for HomeKit. Only those entities that are fully setup when the HomeKit component is started, can be added. To start HomeKit when auto_start: False, you can call the service homekit.start.

If you have Z-Wave entities you want exposed to HomeKit then you’ll need to disable auto start and then start it after the Z-Wave mesh is ready. This is because the Z-Wave entities won’t be fully set up until then. This can be automated using an automation:

# Example for Z-Wave
homekit:
  auto_start: False

automation:
  - alias: 'Start HomeKit'
    trigger:
      - platform: event
        event_type: zwave.network_ready
      - platform: event
        event_type: zwave.network_complete
    action:
      - service: homekit.start

For a general delay where your component doesn’t generate an event, you can also do:

# Example using a delay after start of Home Assistant
homekit:
  auto_start: False

automation:
  - alias: 'Start HomeKit'
    trigger:
      - platform: homeassistant
        event: start
    action:
      - delay: 00:05  # Waits 5 minutes
      - service: homekit.start

Configure Filter

By default no entity will be excluded. To limit which entities are being exposed to HomeKit, you can use the filter parameter. Keep in mind only supported components can be added.

# Example filter to include specified domains and exclude specified entities
homekit:
  filter:
    include_domains:
      - alarm_control_panel
      - light
    exclude_entities:
      - light.kitchen_light

Filters are applied as follows:

  1. No includes or excludes - pass all entities
  2. Includes, no excludes - only include specified entities
  3. Excludes, no includes - only exclude specified entities
  4. Both includes and excludes:
    • Include domain specified
      • if domain is included, and entity not excluded, pass
      • if domain is not included, and entity not included, fail
    • Exclude domain specified
      • if domain is excluded, and entity not included, fail
      • if domain is not excluded, and entity not excluded, pass
      • if both include and exclude domains specified, the exclude domains are ignored
    • Neither include or exclude domain specified
      • if entity is included, pass (as #2 above)
      • if entity include and exclude, the entity exclude is ignored

Supported Components

The following components are currently supported:

Component Type Name Description
alarm_control_panel SecuritySystem All security systems.
automation / input_boolean / remote / script Switch All represented as switches.
binary_sensor Sensor Support for co2, door, garage_door, gas, moisture, motion, occupancy, opening, smoke and window device classes. Defaults to the occupancy device class for everything else.
climate Thermostat All climate devices.
cover GarageDoorOpener All covers that support open and close and have garage as their device_class.
cover WindowCovering All covers that support set_cover_position.
cover WindowCovering All covers that support open_cover and close_cover through value mapping. (open -> >=50; close -> <50)
cover WindowCovering All covers that support open_cover, stop_cover and close_cover through value mapping. (open -> >70; close -> <30; stop -> every value in between)
device_tracker Sensor Support for occupancy device class.
fan Fan Support for on / off, direction and oscillating.
light Light Support for on / off, brightness and rgb_color.
lock DoorLock Support for lock / unlock.
media_player MediaPlayer Represented as a series of switches which control on / off, play / pause, play / stop, or mute depending on supported_features of entity and the mode list specified in entity_config.
sensor TemperatureSensor All sensors that have Celsius or Fahrenheit as their unit_of_measurement or temperature as their device_class.
sensor HumiditySensor All sensors that have % as their unit_of_measurement and humidity as their device_class.
sensor AirQualitySensor All sensors that have pm25 as part of their entity_id or pm25 as their device_class
sensor CarbonDioxideSensor All sensors that have co2 as part of their entity_id or co2 as their device_class
sensor LightSensor All sensors that have lm or lx as their unit_of_measurement or illuminance as their device_class
switch Switch Represented as a switch by default but can be changed by using type within entity_config.

Error reporting

If you encounter any issues or bug and want to report them on GitHub, please follow these steps to make it easier for others to help and get your issue solved.

  1. Enable debugging mode:
    logger:
      default: warning
      logs:
        homeassistant.components.homekit: debug
        pyhap: debug
    
  2. Reproduce the bug / problem you have encountered.
  3. Stop Home Assistant and copy the log from the log file. That is necessary since some errors only get logged, when Home Assistant is being shutdown.
  4. Follow this link: home-assistant/issues/new and open a new issue.
  5. Fill out all fields and especially include the following information:
    • The configuration entries for homekit and the component that is causing the issue.
    • The log / traceback you have generated before.
    • Screenshots of the failing entity in the states panel.