# rednblkx/HomeKey-ESP32

ESP32 HomeKit Lock with support for Apple Home Key (reverse-engineered)

Repository: https://github.com/rednblkx/HomeKey-ESP32
Canonical: https://ross.abutalabs.com/products/homekey-esp32
Homepage: https://rednblkx.github.io/HomeKey-ESP32/
Language: C++
License: MIT
License Family: permissive
Topics: arduino, home-automation, homekit, apple, ecp, enhanced-contactless-polling, home-key, nfc, apple-home-key, home-assistant
Last push: 2026-08-31T11:39:26+00:00

## Health v2 (maintenance only)
Score: 79/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 100, release rhythm 57, longevity 71
- inputs: {"age_days": 997, "days_push": 2, "days_rel": 208, "gap_med": 37.0, "n_releases_24m": 7}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1069, forks 93 (observed 2026-09-01T02:14:06.300140+00:00)

## What it is
Firmware for ESP32 boards that implements Apple HomeKit lock functionality with support for Apple Home Key, enabling NFC-based door unlocking via iPhone or Apple Watch. It works with common NFC reader modules (PN532, PN7160, ST25R3916) and integrates with Home Assistant via MQTT.

## Use cases
- unlock a door by tapping an iPhone or Apple Watch with NFC
- build a DIY Apple Home Key smart lock without buying a proprietary lock
- add an ESP32-based HomeKit lock to Home Assistant
- flash prebuilt firmware onto an ESP32 with an NFC reader module
- integrate NFC door access with MQTT and home automation automations
- use Ethernet instead of Wi-Fi for a smart lock reader

## When to choose
- you want Apple Home Key support on your own hardware without buying a compatible commercial smart lock
- you already own an ESP32 and a supported NFC module (PN532, PN7160, ST25R3916)
- you use Home Assistant or an MQTT-based smart home setup
- you want prebuilt firmware so no compilation is required

## When to avoid
- you need encrypted flash storage for key material, which this project does not provide
- you want the newer Apple Aliro standard rather than HomeKit Home Key
- you need a turnkey commercial product rather than a DIY build requiring wiring and flashing
- your board is not an ESP32 variant supported by the firmware

## Facets
- artifact type: application
- maturity: active
- function: embedded, security, http-server
- domain: iot, embedded-systems, security, hardware
- platform: embedded, iot
- tags: apple-home-key, homekit, nfc-reader, esp32-firmware, smart-lock, pn532, reverse-engineered, home-assistant, diy-hardware, nfc, home-automation, mqtt

## Member repositories
- rednblkx/HomeKey-ESP32 (main) score 79

## Provenance
- Observed fields: from GitHub, fetched 2026-09-01T02:14:06.300140+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T06:55:11.462748+00:00, confidence not recorded.
  - readme: https://github.com/rednblkx/HomeKey-ESP32 (fetched 2026-09-01T02:14:06.300140+00:00, sha 4266d9150fc0)
  - homepage: https://rednblkx.github.io/HomeKey-ESP32/ (fetched 2026-08-29T12:57:01.130465+00:00, sha e83fa6f39f89)
- Data as of 2026-08-30T08:39:29.467469+00:00.
