HAP-ESPHome

HomeKit support for ESPHome-based ESP32 devices

1. Introduction

This project aims to bring HomeKit support to ESP32 devices flashed with an ESPHome configuration that will enable you to directly control the device from the Apple Home app without anything else inbetween.

Components can be imported like any other external compoents as follows:

external_components:
  source: github://rednblkx/HAP-ESPHome@main
  refresh: 0s

See Components for documentation.

Important

Some components like Bluetooth for example, take up a lot of space in RAM and will result in error during compiling, something like section '.iram0.text' will not fit in region 'iram0_0_seg' will be present in the log.

Supported entity types

Type	Attributes	Notes
Light	On/Off, Brightness, RGB, Color Temperature
Lock	Lock/Unlock	Homekey can be enabled but only the `pn532_spi` component is supported to be used with it
Switch	On/Off
Sensor	Temperature, Humidity, Illuminance, Air Quality, CO2, CO, PM10, PM2.5	`device_class` property has to be declared with the sensor type as per HASS docs

2. Essentials

The underlying esp-homekit-sdk library and the components were designed to be used with ESP-IDF 5.

See below required configuration which needs to be present at all times.

esp32:
  board: <insert board id>
  framework:
    type: esp-idf
    version: 5.2.1
    platform_version: 6.7.0
    sdkconfig_options:
      CONFIG_COMPILER_OPTIMIZATION_SIZE: y
      CONFIG_LWIP_MAX_SOCKETS: "16"
      CONFIG_MBEDTLS_HKDF_C: y

3. Components

Project is divided into two different components, homekit_base which handles the bridge logic and homekit that handles the actual accessory logic (lights, switches, etc.).

This repository also includes the pn532 and pn532_spi components which are just slightly modified versions of the official ones from the ESPHome repository to suit HomeKey needs with no extra options added to them nor deleted, however, it's not guaranteed to be kept up to date with upstream changes.

3.1. `homekit_base`

Note

The homekit_base component does not have to included in the configuration unless you are interested in one of the properties listed below as it is automatically loaded by the homekit component

3.1.1. Configuration variables:

port (Optional, int): The port HomeKit should listen to
meta (Optional): Bridge information
- name (Optional, string): Name of the bridge accessory
- model (Optional, string): Model name for the bridge accessory
- manufacturer (Optional, string): Manufacturer name for the bridge accessory
- serial_number (Optional, string): Serial number for the bridge accessory
- fw_rev (Optional, string): Firmware revision for the bridge accessory
setup_code (Optional, string): The HomeKit setup code in the format XXX-XX-XXX - Default: 159-35-728
setup_id (Optional, string): The Setup ID that can be used to generate a pairing QR Code - Default: ES32

Configuration Example:

homekit_base:
  meta:
    name: "PRIMO"
    manufacturer: "AMICI&CO"
    model: "IMPERIUM"
    serial_number: "16161616"
    fw_rev: "0.16.2"
  setup_code: '159-35-728'
  setup_id: "ES32"

3.1.2. Factory reset

homekit_base can also be used as a platform component for the button component to reset the HomeKit pairings, see example below:

button:
- platform: homekit_base
  factory_reset:
    name: "Reset HomeKit pairings"

This will function like any regular button in ESPHome and therefore will be visible in the Web Interface and HASS.

3.2. `homekit`

This is what handles the accessory logic like syncing states between HomeKit and ESPHome and basic information (name, attributes, etc.).

Tip

For configuration examples, you can see the .yaml files in this repository, like lights-c3.yaml

3.2.1. Configuration variables:

light (Optional): Array of Light entities
- id (Required, Light) - Id of the light entity
- meta (Optional): Accessory information
  - name (Optional, string): Name of the accessory, defaults to name of the entity
  - model (Optional, string): Model name for the accessory
  - manufacturer (Optional, string): Manufacturer name for the accessory
  - serial_number (Optional, string): Serial number for the accessory, defaults to internal object id
  - fw_rev (Optional, string): Firmware revision for the accessory
Example:
```
homekit:
  light:
    - id: desk_light
      meta:
        name: "RGB Light"
        manufacturer: "AMICI&CO"
        model: "IGNIS"
        serial_number: "42424242"
        fw_rev: "0.16.2"
```
lock (Optional): Array of Lock Entities
- id (Required, Lock) - Id of the lock entity
- meta (Optional): Accessory information
  - name (Optional, string): Name of the accessory, defaults to name of the entity
  - model (Optional, string): Model name for the accessory
  - manufacturer (Optional, string): Manufacturer name for the accessory
  - serial_number (Optional, string): Serial number for the accessory, defaults to internal object id
  - fw_rev (Optional, string): Firmware revision for the accessory
- nfc_id (Optional, PN532): Id of the pn532_spi component, used for the HomeKey functionality
- on_hk_success (Optional, Action): Action to be executed when Homekey is successfully authenticated
- on_hk_fail (Optional, Action): Action to be executed when Homekey fails to authenticate
- hk_hw_finish(Optional, string): Color of the Homekey card from the predefined BLACK, SILVER, GOLD and TAN, defaults to BLACK
Example:
```
homekit:
  lock:
    - id: this_lock
      meta:
        manufacturer: "AMICI&CO"
        model: "IMPEDIO"
        serial_number: "42424242"
        fw_rev: "0.16.2"
      nfc_id: nfc_spi_module
      on_hk_success:
        lambda: |-
          ESP_LOGI("HEREHERE", "IssuerID: %s", x.c_str());
          ESP_LOGI("HEREHERE", "EndpointID: %s", y.c_str());
          id(test_light).toggle().perform();
      on_hk_fail:
        lambda: |-
          ESP_LOGI("GSDGSGS", "IT FAILED :(");
      hk_hw_finish: "SILVER"
```
sensor
- id (Required, Sensor): Id of the sensor entity
- meta (Optional): Accessory information
  - name (Optional, string): Name of the accessory, defaults to name of the entity
  - model (Optional, string): Model name for the accessory
  - manufacturer (Optional, string): Manufacturer name for the accessory
  - serial_number (Optional, string): Serial number for the accessory, defaults to internal object id
  - fw_rev (Optional, string): Firmware revision for the accessory
Example:
```
homekit:
  sensor:
    - id: my_sensor
      meta:
        manufacturer: "AMICI&CO"
        model: "VARIO"
        serial_number: "42424242"
        fw_rev: "0.16.2"
```
switch
- id (Required, Switch): Id of the switch entity
- meta (Optional): Accessory information
  - name (Optional, string): Name of the accessory, defaults to name of the entity
  - model (Optional, string): Model name for the accessory
  - manufacturer (Optional, string): Manufacturer name for the accessory
  - serial_number (Optional, string): Serial number for the accessory, defaults to internal object id
  - fw_rev (Optional, string): Firmware revision for the accessory
Example:
```
  switch:
    - id: some_switch
      meta:
        manufacturer: "AMICI&CO"
        model: "TRANSMUTO"
        serial_number: "42424242"
        fw_rev: "0.16.2"
```

4. HomeKey

If you notice an error in the logs that says Can't decode message length., you can safely ignore it. The project is using a "hijacked" version of the official pn532 component and the message is part of the normal operation of it since it's meant to be used with "regular" NFC Tags.

4.1 Disclaimer

The functionality of Homekey is entirely based on reverse engineering since HomeKit specs stopped being available to hobbyists and therefore the entire functionality or parts of it might or might not break in the future and/or lack official features or any internal implementations.

4.2 Setup

Important

Only PN532 over SPI(pn532_spi component) is supported at the moment due to required modifications that haven't been ported to other protocols or chips

Note

For quick reactions and to avoid issues, don't raise the update_interval over 500ms

spi:
  clk_pin: 4
  miso_pin: 5
  mosi_pin: 6

pn532_spi:
  id: nfc_spi_module
  cs_pin: 7
  update_interval: 100ms

homekit:
  lock:
    - id: <insert lock id>
      nfc_id: nfc_spi_module

Support & Contributing

If you wish to contribute with a feature or a fix, a PR will be most welcomed

The best way to support the work that i do is to ⭐ the repository but you can also buy me a ☕ if you wish by sponsoring me on GitHub.

You can also choose to join the Discord server where you will find a helpful and lovely community.

Credits

@kormax - Homekey NFC protocol research, ECP and PoC

@kupa22 - Documenting the HAP part for the Homekey

License

This repository consists of multiple licenses since it contains some components(pn532 and pn532_spi) originally from the ESPHome repository, please consult the LICENSE file in each folder in the components folder.

marcelo-lara/HAP-ESPHome