![](\"https://raw.githubusercontent.com/homebridge/branding/latest/logos/homebridge-color-round-stylized.png\")
\n\n \n
![](\"https://github.com/homebridge/HAP-NodeJS/actions/workflows/build.yml/badge.svg\" "\\"Node"){kind=icon}
\n 
\n\n\n\nHAP-NodeJS is an implementation of the HomeKit Accessory Server as specified in the HomeKit Accessory Protocol (HAP),\nwhich is defined by Apple as part of the HomeKit Framework.\n\nHAP-NodeJS is intended to be used as a library to easily create your own HomeKit Accessory on a Raspberry Pi,\nIntel Edison, or any other platform that can run Node.js :) \nIf you are searching for a pluggable HomeKit bridge with over a thousand community driven plugins to bring HomeKit\nsupport to devices which do not support HomeKit out of the box, you may want to look at the \n[homebridge][project-homebridge] project (which also uses HAP-NodeJS internally).\n\nThe implementation tries to follow the HAP specification as close as it can, but may differ in some cases.\nHAP-NodeJS is not an Apple certified HAP implementation, as this is only available to members of the MFi program.\n\n## Getting started\n\nYou may start by having a look at our [Wiki][wiki], especially have a look at the \n[Important HomeKit Terminology][hk-terminology] used in this project.\n\nThere is also a pretty detailed guide on [how to start developing with HAP-NodeJS][dev-guide].\nOr you may just have a look at our [examples][examples-repo] repository\n(or some of the old [accessory examples][example-accessories]).\n\nThe documentation (WIP) can be found [here](https://developers.homebridge.io/HAP-NodeJS/modules.html).\n\nSee the FAQ on how to enable [debug output][faq-debug] for HAP-NodeJS.\n\n## Projects based on HAP-NodeJS\n\n- [Homebridge][project-homebridge] - HomeKit support for the impatient - Pluggable HomeKit Bridge. \n Plugins available for e.g. Pilight, Telldus TDtool, Savant, Netatmo, Open Pixel Control, HomeWizard, Fritz!Box, \n LG WebOS TV, Home Assistant, HomeMatic and many more.\n- [OpenHAB-HomeKit-Bridge][project-openhab-homekit-bridge] - OpenHAB HomeKit Bridge bridges openHAB items to \n Apples HomeKit Accessory Protocol.\n- [homekit2mqtt][project-homekit2mqtt] - HomeKit to MQTT bridge.\n- [pimatic-hap][project-pimatic-hap] - Pimatic homekit bridge.\n- [node-red-contrib-homekit][project-node-red-contrib-homekit] - Node-RED nodes to simulate Apple HomeKit devices.\n- [ioBroker.homekit][project-ioBroker-homekit] - connect ioBroker to HomeKit.\n- [AccessoryServer][project-accessoryserver] - HomeKit integration for IR/RF/IP-devices\n\n## Notes\n\nSpecial thanks to [Alex Skalozub][link-alex-skalozub], who reverse-engineered the server side HAP.\n~~You can find his research [here][link-homekit-research].~~\n(Sadly, on Nov 4 2014, Apple sent the [DMCA][link-apple-dmca] request to GitHub to remove the research.)\n\n[There](https://www.instagram.com/p/t4cPlcDksQ/) is a video demo running this project on Intel Edison.\n\nIf you are interested in HAP over BTLE, you might want to check [this][link-hap-over-btle].\n\n\n\n[wiki]: https://github.com/homebridge/HAP-NodeJS/wiki\n[hk-terminology]: https://github.com/homebridge/HAP-NodeJS/wiki/HomeKit-Terminology\n[dev-guide]: https://github.com/homebridge/HAP-NodeJS/wiki/Using-HAP-NodeJS-as-a-library\n[faq-debug]: https://github.com/homebridge/HAP-NodeJS/wiki/FAQ#debug-mode\n\n[examples-repo]: https://github.com/homebridge/HAP-NodeJS-examples\n[example-accessories]: https://github.com/homebridge/HAP-NodeJS/tree/latest/src/accessories\n\n[project-homebridge]: https://github.com/homebridge/homebridge\n[project-openhab-homekit-bridge]: https://github.com/htreu/OpenHAB-HomeKit-Bridge\n[project-homekit2mqtt]: https://github.com/hobbyquaker/homekit2mqtt\n[project-pimatic-hap]: https://github.com/michbeck100/pimatic-hap\n[project-node-red-contrib-homekit]: https://github.com/NRCHKB/node-red-contrib-homekit-bridged\n[project-ioBroker-homekit]: https://github.com/ioBroker/ioBroker.homekit2\n[project-accessoryserver]: https://github.com/Appyx/AccessoryServer\n\n[link-alex-skalozub]: https://twitter.com/pieceofsummer\n[link-homekit-research]: https://gist.github.com/pieceofsummer/13272bf76ac1d6b58a30\n[link-apple-dmca]: https://github.com/github/dmca/blob/master/2014/2014-11-04-Apple.md\n[link-hap-over-btle]: https://gist.github.com/KhaosT/6ff09ba71d306d4c1079\n","readmeFilename":"README.md"}