OpenHAB HomeKit Bridge

OpenHAB HomeKit Bridge bridges openHAB items to Apple´s HomeKit Accessory Protocol. It is based on hap-nodejs.

Watch the demo video here.

Prerequisites

• openHAB server running with at least one Switch item configured
• node.js 0.12.x, 4.0.x or 4.1.x
• an iOS device running iOS 8 or 9
• an iOS app for modifying the HomeKit database (like elgato eve)
• this repository

Install the OpenHAB HomeKit Bridge:

• On non OS X systems install the avahi library:

  sudo apt-get install libavahi-compat-libdnssd-dev

• Install the node module dependencies:

  npm install

• Create a custom sitemap which lists all items you want to control with HomeKit:

  sitemap demo label="HomeKit" {
    # On/Off Item (lights, outlets)
    Switch item=DemoSwitch label="Toggle Switch"
  
    # Dimmer items (On/Off, Brightness)
    Slider item=DimmedLight label="Dimmed Light" switchSupport
  
    # RGB light items (On/Off, Brightness, Hue, Saturation)
    Colorpicker item=RGBLight icon="slider"
  
    # Rollershutter/Blinds
    Switch item=Shutter_GF_Living
  
    # Temperature sensor
    Text item=Temperature_GF_Living
  

}

##### Run OpenHAB HomeKit Bridge
This connects to OpenHAB at 192.168.0.99 on port 8080 and loads all items from a sitemap named 'demo.sitemap':

`npm start -- --server 192.1.0.99:8080 --sitemap demo`

###### Command line options:

<dl>
<dt>-s, --server</dt>
<dd>The network address and port of the OpenHAB server as ip:port. Defaults to 127.0.0.1:8080</dd>
<dt>-p, --pincode</dt>
<dd>The pincode used for the bridge accessory. Defaults to 031-45-154.</dd>
<dt>-m, --sitemap</dt>
<dd>The name of the sitemap to load all items from. Items must not be nested in frames or groups. Defaults to 'homekit'.</dd>
</dl>

To access the bridge from an iOS device (9.0+) use Apples [HomeKit Catalog 2.0](https://developer.apple.com/library/ios/samplecode/HomeKitCatalog/Introduction/Intro.html) demo application or a vendor app like elgato´s eve (see _Prerequisites_). Use the predefined pin code _031-45-154_ to add the bridge as an accessory.

##### Running Tests

To execute unit tests run

`npm test`

##### Backlog/ToDo
* Add more robust websocket listener for state changes in OpenHAB -> see [Issue 5](https://github.com/htreu/OpenHAB-HomeKit-Bridge/issues/5)
* Implement Rollershutter -> see [Issue 7](https://github.com/htreu/OpenHAB-HomeKit-Bridge/issues/7)