apple/HomeKitADK

C

2,618

57 commits

updated Jul 6, 2022

See the code

README

HomeKit Accessory Development Kit (ADK)

The HomeKit ADK is used by silicon vendors and accessory manufacturers to build HomeKit compatible devices.

The HomeKit ADK implements key components of the HomeKit Accessory Protocol (HAP), which embodies the core principles Apple brings to smart home technology: security, privacy, and reliability.

The HomeKit Open Source ADK is an open-source version of the HomeKit Accessory Development Kit. It can be used by any developer to prototype non-commercial smart home accessories. For commercial accessories, accessory developers must continue to use the commercial version of the HomeKit ADK available through the MFi Program.

Go to the Apple Developer Site if you like to learn more about developing HomeKit-enabled accessories and apps.

Getting Started

Please go through Getting Started Guide before using HomeKit ADK.

Documentation

ADK documentation is available as markdown files in Documentation directory. However, a more user friendly HTML documentation can be generated from the markdown files by running the following command:

make docs

The command above will prompt to open the generated HTML webpage. After the command has finished, the webpage ./Documentation/api_docs/html/index.html can also be opened in a browser.

apple/HomeKitADK

C

2,618

57 commits

updated Jul 6, 2022

See the code

README

HomeKit Accessory Development Kit (ADK)

The HomeKit ADK is used by silicon vendors and accessory manufacturers to build HomeKit compatible devices.

The HomeKit ADK implements key components of the HomeKit Accessory Protocol (HAP), which embodies the core principles Apple brings to smart home technology: security, privacy, and reliability.

The HomeKit Open Source ADK is an open-source version of the HomeKit Accessory Development Kit. It can be used by any developer to prototype non-commercial smart home accessories. For commercial accessories, accessory developers must continue to use the commercial version of the HomeKit ADK available through the MFi Program.

Go to the Apple Developer Site if you like to learn more about developing HomeKit-enabled accessories and apps.

Getting Started

Please go through Getting Started Guide before using HomeKit ADK.

Documentation

ADK documentation is available as markdown files in Documentation directory. However, a more user friendly HTML documentation can be generated from the markdown files by running the following command:

make docs

The command above will prompt to open the generated HTML webpage. After the command has finished, the webpage ./Documentation/api_docs/html/index.html can also be opened in a browser.

Project health

Overall

4.9/10

Maintained

0/10

Code review

9/10
OpenSSF Scorecard

Significant stargazers

(top 24 of 29)

Samuel Cochran

381 followers · starred Feb 2020

Andrey Okonetchnikov

1,089 followers · starred Dec 2019

Zeyi (Rice) Fan

688 followers · starred Dec 2019

Jon Rohan

1,196 followers · starred Dec 2019