• Stars
    star
    2,685
  • Rank 17,005 (Top 0.4 %)
  • Language
    TypeScript
  • License
    Apache License 2.0
  • Created about 10 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Node.js implementation of the HomeKit Accessory Protocol (HAP)

HAP-NodeJS

Coverage Status

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 2014, 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.

More Repositories

1

homebridge

HomeKit support for the impatient.
TypeScript
22,843
star
2

homebridge-config-ui-x

The Homebridge UI. Monitor, configure and backup Homebridge from a browser.
TypeScript
2,614
star
3

docker-homebridge

Homebridge Docker. HomeKit support for the impatient using Docker on x86_64, Raspberry Pi (armhf) and ARM64. Includes ffmpeg + libfdk-aac.
Shell
2,577
star
4

homebridge-raspbian-image

Official Homebridge Raspberry Pi Image based on Raspberry Pi OS Lite.
Shell
1,004
star
5

homebridge-syno-spk

Homebridge Package for Synology DSM 7.
Shell
606
star
6

verified

Plugins Verified by Homebridge
TypeScript
348
star
7

homebridge-plugin-template

A template you can use to create your own Homebridge plugins.
TypeScript
279
star
8

ffmpeg-for-homebridge

Static FFmpeg binaries for Homebridge with support for audio (libfdk-aac) and hardware-accelerated decoding and encoding (h264_qsv, h264_v4l2m2m, videotoolbox).
Shell
108
star
9

ciao

RFC 6762 and RFC 6763 compliant mdns service discovery library written in Typescript
TypeScript
77
star
10

homebridge-examples

Collection of homebridge plugin examples
TypeScript
77
star
11

plugin-ui-utils

Create fully customisable configuration user interfaces for Homebridge plugins.
TypeScript
29
star
12

homebridge-apt-pkg

Debian / Ubuntu package and repo for Homebridge
Shell
21
star
13

camera-utils

Utilities to simplify homebridge camera plugin development
TypeScript
18
star
14

homebridge.io

The https://homebridge.io website.
HTML
10
star
15

homebridge.github.io

Homebridge Plugin Development Documentation Website.
SCSS
10
star
16

HAP-NodeJS-examples

Collection of examples to get started using HAP-NodeJS as a library.
TypeScript
9
star
17

.github

Global workflow files and community health files for the Homebridge organization.
8
star
18

documentation

Placeholder repository for the Homebridge plugin development docs.
JavaScript
7
star
19

homebridge-macos-pkg

Work in progress. Homebridge macOS Installer.
Shell
7
star
20

branding

Homebridge branding guidelines, naming conventions, logo usage rules, and logo files.
7
star
21

hap-client

A client for an insecure HAP-NodeJS instance
TypeScript
6
star
22

mdns-diagnostics

Test tool to display HAP instances on your network
JavaScript
4
star
23

homebridge-plugin-camera-template

A template you can use to create your own Homebridge camera plugins.
TypeScript
2
star
24

plugin-repo

Bundles for Verified Homebridge Plugins
TypeScript
2
star