-
-
Notifications
You must be signed in to change notification settings - Fork 622
Expand file tree
/
Copy pathindex.html
More file actions
46 lines (46 loc) · 9.92 KB
/
index.html
File metadata and controls
46 lines (46 loc) · 9.92 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>hap-nodejs</title><meta name="description" content="Documentation for hap-nodejs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><script async src="assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">hap-nodejs</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>hap-nodejs</h1></div><div class="tsd-panel tsd-typography"><p align="center">
<a href="https://homebridge.io"><img src="https://raw.githubusercontent.com/homebridge/branding/latest/logos/homebridge-color-round-stylized.png" height="140"></a>
</p>
<span align="center">
<h1 id="hap-nodejs" class="tsd-anchor-link">HAP-NodeJS<a href="#hap-nodejs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p><a href="https://www.npmjs.com/package/@homebridge/hap-nodejs"><img title="npm version" src="https://badgen.net/npm/v/@homebridge/hap-nodejs" ></a>
<a href="https://www.npmjs.com/package/@homebridge/hap-nodejs/v/beta"><img title="npm version beta" src="https://badgen.net/npm/v/@homebridge/hap-nodejs/beta" ></a>
<a href="https://www.npmjs.com/package/@homebridge/hap-nodejs/v/alpha"><img title="npm version alpha" src="https://badgen.net/npm/v/@homebridge/hap-nodejs/alpha" ></a><br>
<a href="https://www.npmjs.com/package/@homebridge/hap-nodejs"><img title="npm downloads" src="https://badgen.net/npm/dt/@homebridge/hap-nodejs" ></a>
<a href="https://github.com/homebridge/HAP-NodeJS/actions/workflows/build.yml"><img title="Node Build" src="https://github.com/homebridge/HAP-NodeJS/actions/workflows/build.yml/badge.svg" ></a>
<a href='https://coveralls.io/github/homebridge/HAP-NodeJS'><img src='https://coveralls.io/repos/github/homebridge/HAP-NodeJS/badge.svg' alt='Coverage Status' /></a></p>
</span>
<p>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.</p>
<p>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 :)<br>
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
<a href="https://github.com/homebridge/homebridge">homebridge</a> project (which also uses HAP-NodeJS internally).</p>
<p>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.</p>
<h2 id="getting-started" class="tsd-anchor-link">Getting started<a href="#getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>You may start by having a look at our <a href="https://github.com/homebridge/HAP-NodeJS/wiki">Wiki</a>, especially have a look at the
<a href="https://github.com/homebridge/HAP-NodeJS/wiki/HomeKit-Terminology">Important HomeKit Terminology</a> used in this project.</p>
<p>There is also a pretty detailed guide on <a href="https://github.com/homebridge/HAP-NodeJS/wiki/Using-HAP-NodeJS-as-a-library">how to start developing with HAP-NodeJS</a>.
Or you may just have a look at our <a href="https://github.com/homebridge/HAP-NodeJS-examples">examples</a> repository
(or some of the old <a href="https://github.com/homebridge/HAP-NodeJS/tree/latest/src/accessories">accessory examples</a>).</p>
<p>The documentation (WIP) can be found <a href="https://developers.homebridge.io/HAP-NodeJS/modules.html">here</a>.</p>
<p>See the FAQ on how to enable <a href="https://github.com/homebridge/HAP-NodeJS/wiki/FAQ#debug-mode">debug output</a> for HAP-NodeJS.</p>
<h2 id="projects-based-on-hap-nodejs" class="tsd-anchor-link">Projects based on HAP-NodeJS<a href="#projects-based-on-hap-nodejs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
<li><a href="https://github.com/homebridge/homebridge">Homebridge</a> - HomeKit support for the impatient - Pluggable HomeKit Bridge.<br>
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.</li>
<li><a href="https://github.com/htreu/OpenHAB-HomeKit-Bridge">OpenHAB-HomeKit-Bridge</a> - OpenHAB HomeKit Bridge bridges openHAB items to
Apples HomeKit Accessory Protocol.</li>
<li><a href="https://github.com/hobbyquaker/homekit2mqtt">homekit2mqtt</a> - HomeKit to MQTT bridge.</li>
<li><a href="https://github.com/michbeck100/pimatic-hap">pimatic-hap</a> - Pimatic homekit bridge.</li>
<li><a href="https://github.com/NRCHKB/node-red-contrib-homekit-bridged">node-red-contrib-homekit</a> - Node-RED nodes to simulate Apple HomeKit devices.</li>
<li><a href="https://github.com/ioBroker/ioBroker.homekit2">ioBroker.homekit</a> - connect ioBroker to HomeKit.</li>
<li><a href="https://github.com/Appyx/AccessoryServer">AccessoryServer</a> - HomeKit integration for IR/RF/IP-devices</li>
</ul>
<h2 id="notes" class="tsd-anchor-link">Notes<a href="#notes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Special thanks to <a href="https://twitter.com/pieceofsummer">Alex Skalozub</a>, who reverse-engineered the server side HAP.
<s>You can find his research <a href="https://gist.github.com/pieceofsummer/13272bf76ac1d6b58a30">here</a>.</s>
(Sadly, on Nov 4 2014, Apple sent the <a href="https://github.com/github/dmca/blob/master/2014/2014-11-04-Apple.md">DMCA</a> request to GitHub to remove the research.)</p>
<p><a href="https://www.instagram.com/p/t4cPlcDksQ/">There</a> is a video demo running this project on Intel Edison.</p>
<p>If you are interested in HAP over BTLE, you might want to check <a href="https://gist.github.com/KhaosT/6ff09ba71d306d4c1079">this</a>.</p>
<!-- links -->
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#hap-nodejs"><span>HAP-<wbr/>Node<wbr/>JS</span></a><ul><li><a href="#getting-started"><span>Getting started</span></a></li><li><a href="#projects-based-on-hap-nodejs"><span>Projects based on <wbr/>HAP-<wbr/>Node<wbr/>JS</span></a></li><li><a href="#notes"><span>Notes</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">hap-nodejs</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>