Nebulous Pumpkin Moons

    hap-nodejs
    TypeScript icon, indicating that this package has built-in type declarations

    0.11.0-beta.3 • Public • Published

    HAP-NodeJS

    HAP-NodeJS is an implementation of the HomeKit Accessory Server as specified in the HomeKit Accessory Protocol (HAP), which is defined by Apple as part of the HomeKit Framework.

    HAP-NodeJS is intended to be used as a library to easily create your own HomeKit Accessory on a Raspberry Pi, Intel Edison, or any other platform that can run Node.js :)
    If you are searching for a pluggable HomeKit bridge with over a thousand community driven plugins to bring HomeKit support to devices which do not support HomeKit out of the box, you may want to look at the homebridge project (which also uses HAP-NodeJS internally).

    The implementation tries to follow the HAP specification as close as it can, but may differ in some cases. HAP-NodeJS is not an Apple certified HAP implementation, as this is only available to members of the MFi program.

    Getting started

    You may start by having a look at our Wiki, especially have a look at the Important HomeKit Terminology used in this project.

    There is also a pretty detailed guide on how to start developing with HAP-NodeJS. Or you may just have a look at our examples repository (or some of the old accessory examples).

    The documentation (WIP) can be found here.

    See the FAQ on how to enable debug output for HAP-NodeJS.

    If you wish to do a contribution please read through our CONTRIBUTING guide.

    Projects based on HAP-NodeJS

    • Homebridge - HomeKit support for the impatient - Pluggable HomeKit Bridge.
      Plugins available for e.g. Pilight, Telldus TDtool, Savant, Netatmo, Open Pixel Control, HomeWizard, Fritz!Box, LG WebOS TV, Home Assistant, HomeMatic and many more.
    • OpenHAB-HomeKit-Bridge - OpenHAB HomeKit Bridge bridges openHAB items to Apples HomeKit Accessory Protocol.
    • homekit2mqtt - HomeKit to MQTT bridge.
    • pimatic-hap - Pimatic homekit bridge.
    • node-red-contrib-homekit - Node-RED nodes to simulate Apple HomeKit devices.
    • ioBroker.homekit - connect ioBroker to HomeKit.
    • AccessoryServer - HomeKit integration for IR/RF/IP-devices

    Notes

    Special thanks to Alex Skalozub, who reverse-engineeredthe server side HAP. You can find his research here. (Sadly, on Nov 4, Apple sent the DMCA request to Github to remove the research.)

    There is a video demo running this project on Intel Edison.

    If you are interested in HAP over BTLE, you might want to check this.

    Install

    npm i hap-nodejs@0.11.0-beta.3

    Version

    0.11.0-beta.3

    License

    Apache-2.0

    Unpacked Size

    2.44 MB

    Total Files

    277

    Last publish

    Collaborators

    • oznu
    • northernman
    • supereg
    • khaost
    • ebaauw
    • donavanbecker
    • dustin.greif
    • nfarina
    • pdlove