HomeKey-ESP32

HomeKey functionality for the rest of us.

Overview

This project aims to provide the Apple HomeKey functionality with just an ESP32 and PN532 NFC Module. Sole purpose of the project is to provide the HomeKey functionality and other NFC functionalities such as MIfare Authentication or others are out of scope.

• It integrates with HomeAssistant's Tags which makes it easier to create automations based on a person(issuer) or device(endpoint).
• The internal state is published and controlled via MQTT through user-defined topics
• Any NFC Target that's not identified as homekey will skip the flow and publish the UID, ATQA and SAK on the same MQTT topic as HomeKey with the "homekey" field set to false
• Code is not ready for battery-powered applications
• Designed for a board with an ESP32 chip and 4MB Flash size

Goal of the project is to make it possible to add the homekey functionality to locks that don't support it or to anything for that matter :)

For more advanced functionality, you might also be interested in HAP-ESPHome which attempts to integrate HomeKit (and HomeKey) into ESPHome for ultimate automations.

Usage

Visit the wiki for documentation on the project

Disclaimer

Use this at your own risk, i'm not a cryptographic expert, just a hobbyist. Keep in mind that the HomeKey was implemented through reverse-engineering as indicated above so it might be lacking stuff from Apple's specification to which us private individuals do not have access.

While functional as it is now, the project should still be considered as a work in progress so expect breaking changes.

Contributing

All contributions to the repository are welcomed, if you think you can bring an improvement into the project, feel free to fork the repository and submit your pull requests.

If you have a suggestion or are in need of assistance, you can open an issue. Additionally, you can join the Discord server at https://discord.com/invite/VWpZ5YyUcm

Support

If you like the project, please consider giving it a start to show the appreciation and for others to know this repository is worth something.

Additionally, if you have the means and are willing to, you can donate using the Sponsor button.

Credits

• @kormax for reverse-engineering the Homekey NFC Protocol and publishing a PoC
• @kupa22 for the research on the HAP side of things for Homekey
• HomeSpan which is being used as the framework implementing the HomeKit accessory