KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #dsh #dsh-plugin #ai-agent #claude-code #codex #typescript #ai-agents #mcp #cli #rust #deepseek-harness

esp-homekit

★ 1,165 Open GitHub ↗

Apple HomeKit accessory server library for ESP-OPEN-RTOS

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# esp-homekit
Apple HomeKit accessory server library for
[ESP-OPEN-RTOS](https://github.com/SuperHouse/esp-open-rtos).

See [esp-homekit-demo](https://github.com/maximkulkin/esp-homekit-demo) for examples.

## Building for ESP-IDF 4.x

In ESP-IDF >= 4.0 there is a SPI flash write protection that checks if area written
to is inside writable parition. Haven't figured out yet how esp-homekit can modify
parition table automatically, so for the time being you need to disable that check in
menuconfig: go to Component config -> SPI Flash driver -> Write to dangerous flash
regions and set it to "Allowed".

## Building for ESP-IDF >= 5.0

You need to add a custom partition of type data and subtype "homekit"
and at least 4KB (0x1000) in size for HomeKit data storage. Put this into
partitions.csv file in your project:

```
# ESP-IDF Partition Table
# Name,   Type, SubType, Offset,  Size, Flags
nvs,      data, nvs,     0x9000,  0x5000,
phy_init, data, phy,     0xe000,  0x1000,
homekit,  data, homekit, 0xf000,  0x1000,
factory,  app,  factory, 0x10000, 1M,
```

Enable custom partitions in project configuration (sdkconfig):

```
CONFIG_PARTITION_TABLE_CUSTOM=y
CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions.csv"
```

## QR code pairing

You can use a QR code to pair with accessories. To enable that feature, you need to
configure accessory to use static password and set some setup ID:

```c
homekit_server_config_t config = {
    .accessories = accessories,
    .password = "123-45-678",
    .setupId="1QJ8",
};
```

The last piece of information you need is accessory category code. You can find it in
mDNS announcement in accessory logs
```
mDNS announcement: Name=Sample LED-1692md=MyLEDpv=1.0id=16:92:CE:D4:EE:7Ac#=1s#=1ff=0sf=1ci=5 Port=5556 TTL=4500
```
(notice "**ci=5**" <- this is accessory category code)

Or just find value of category enum you set in main accessory:
```c
  HOMEKIT_ACCESSORY(.id=1, .category=homekit_accessory_category_lightbulb, .services=(homekit_service_t*[]){
```
(notice "**homekit_accessory_category_lightbulb**" <- this is accessory category code)

Then you need to generate QR code using supplied script:
```
tools/gen_qrcode 5 123-45-678 1QJ8 qrcode.png
```

![QR code example](https://raw.githubusercontent.com/maximkulkin/esp-homekit/master/qrcode-example.png)

esp-homekit

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README