Copyright © 2016, 2017 Erik Baauw. All rights reserved.
Please see the WiKi for a detailed description of homebridge-hue.
To interact with HomeKit, you need Siri or a HomeKit app on an iPhone, Apple Watch, iPad, iPod Touch, or Apple TV (4th generation). I recommend to use the latest OS versions: iOS 10.3, watchOS 3.2, and tvOS 10.2.
Please note that Siri and even the iOS built-in Home app still provide only limited HomeKit support. To use the full features of homebridge-hue, you might want to check out some other HomeKit apps, like Elgato's Eve app (free) or Matthias Hochgatterer's Home app (paid).
For HomeKit automation, you need to setup an Apple TV (4th generation) or iPad as Home Hub.
You need a Philips Hue bridge to connect homebridge-hue to your lights, switches, and sensors. I recommend use the latest bridge firmware, with API v1.16.0 or v1.17.0.
You need a server to run homebridge. This can be anything running Node.js: from a Raspberri Pi, a NAS system, or an always-on PC running Linux, macOS, or Windows. See the homebridge Wiki for details. I use a Mac mini server, and, occasionally, a Raspberri Pi 3 model B.
I recommend to use wired Ethernet to connect the server running homebridge, the Hue bridge, and, if applicable, the AppleTV.
The homebridge-hue plugin obviously needs homebridge, which, in turn needs Node.js. I've followed these steps to set it up on my macOS server:
node, from its website. I'm using v6.10.3 LTS for macOS (x64), which includes the
/usr/local/binis in your
npm, and, later,
sudo npm update -g npm@latest. For me, this installs npm version 4.6.1;
/usr/local/lib/node_modules. Make sure to create a
~/.homebridge, as described;
sudo npm install -g homebridge-hue@latest;
~/.homebridge/config.jsonand add the
Hueplatform provided by homebridge-hue, see Configuration below;
config.jsonto include these, see Configuration below.
Once homebridge is up and running with the homebridge-hue plugin, you might want to daemonise it and start it automatically on login or system boot. See the homebridge Wiki for more info how to do that on MacOS or on a Raspberri Pi.
sudo npm -g update doesn't always seem to work. To update homebridge-hue, simply issue another
sudo npm install -g homebridge-hue@latest. Please check the release notes before updating homebridge-hue. Note that a change to the minor version typically indicates that you need to review/redo your HomeKit configuration. Due to changes in the mapping how Hue bridge resources are exposed, HomeKit might treat them as a new accessories, services, and/or characteristics, losing any assignment to HomeKit rooms, scenes, actions, and triggers. To revert to a previous version, specify the version when installing homebridge-hue, as in:
sudo npm install -g email@example.com.
config.json you need to specify homebridge-hue as a platform plugin. Furthermore you need to specify what you want to expose to HomeKit, see the examples below. See the WiKi for a complete reference of the
config.json settings used by homebridge-hue.
The example below is a typical configuration for a v2 (square) bridge, which already exposes the Philips lights to HomeKit. With this configuration, homebridge-hue exposes Hue motion sensors, Hue dimmer switches, Hue taps, and non-Philips lights, using the same Mired
ColorTemperature characteristic type as the Hue bridge.
The example below is a typical configuration for exposing a v1 (round) bridge, or a v2 (square) bridge where the native HomeKit feature isn't used. With this configuration, homebridge-hue exposes all sensor resources, except those created by the Hue app for Home & Away routines, and all lights, using the Kelvin
ColorTemperature characteristic type.
If you run into homebridge startup issues, please run homebridge with only the homebridge-hue plugin enabled in
config.sys. This way, you can determine whether the issue is related to the homebridge-hue plugin itself, or to the interaction of multiple homebridge plugins in your setup. Note that disabling the other plugins from your existing homebridge setup will remove their accessories from HomeKit. You will need to re-assign these accessories to any HomeKit room, groups, scenes, actions, and triggers after re-enabling their plugins. Alternatively, you can start a different instance of homebridge just for homebridge-hue, on a different system, as a different user, or from a different directory (specified by the
-U flag). Make sure to use a different homebridge
username, and (if running on the same system)
port in the
config.sys for each instance.
The homebridge-hue plugin outputs an info message for each HomeKit characteristic value it sets and for each HomeKit characteristic value change notification it receives. When homebridge is started with
-D, homebridge-hue outputs a debug message for each request it makes to the Hue bridge and for each Hue bridge state change it detects. Additionally, it issues a debug message for each bridge resource it detects. To capture these messages into a logfile, start homebridge as
homebridge -D > logfile 2>&1.
To aid troubleshooting, homebridge-hue dumps the full bridge state into a json file, when
Identify is selected on the bridge accessory. Bridge ID, mac address, ip address, and usernames are masked. The file is created in the current directory where homebridge is running, and is named after the bridge. Note that the Apple's Home app does not support
Identify, so you need another HomeKit app for that (see Caveats below).
If you need help, please open an issue on GitHub. Please attach a copy of your full
config.json (masking any sensitive info), the debug logfile, and the dump of the bridge state.
The homebridge-hue plugin is a hobby project of mine, provided as-is, with no warranty whatsoever. I've been running it successfully at my home for months, but your mileage might vary. Please report any issues on GitHub.
Homebridge is a great platform, but not really intended for consumers, as it requires command-line interaction.
HomeKit is still relatively new, and Apple's Home app provides only limited support. You might want to check out some other HomeKit apps, like Elgato's Eve app (free), Matthias Hochgatterer's Home app (paid), or, if you use
Xcode, Apple's HMCatalog example app.
The HomeKit terminology needs some getting used to. An accessory more or less corresponds to a physical device, accessible from your iOS device over WiFi or Bluetooth. A bridge (like homebridge) is an accesory that provides access to other, bridged, accessories. An accessory might provide multiple services. Each service corresponds to a virtual device (like a lightbulb, switch, motion sensor, ..., but also: a programmable switch button, accessory information, battery status). Siri interacts with services, not with accessories. A service contains one or more characteristics. A characteristic is like a service attribute, which might be read or written by HomeKit apps. You might want to checkout Apple's HomeKit Accessory Simulator, which is distributed a an additional tool for
HomeKit only supports 99 bridged accessories per HomeKit bridge (i.e. homebridge, not the Philips Hue bridge). When homebridge exposes more accessories, HomeKit refuses to pair with homebridge or it blocks homebridge if it was paired already. While homebridge-hue checks that it doesn't expose more than 99 accessories itself, it is unaware of any accessories exposed by other homebridge plugins. As a workaround to overcome this limit, you can run multiple instances of homebridge with different plugins and/or different homebridge-hue settings, using the
-U flag to specify a different directory with a different
config.json for each instance. Make sure to use a different homebridge
port for each instance.
Internally, HomeKit identifies accessories by UUID. For Zigbee devices (lights, Hue taps, Hue dimmer switches, Hue Motion sensors), homebridge-hue bases this UUID on the Zigbee mac address. For non-Zigbee resources, the UUID is based on the Hue bridge ID and resource path (e.g.
/sensors/1). By not using the resource name (e.g.
Daylight), homebridge-hue can deal with duplicate names. In addition, HomeKit will still recognise the accessory after the resource name has changed on the Hue bridge, remembering which HomeKit room, groups, scenes, actions, and triggers it belongs to. However, when a non-Zigbee Hue bridge resource is deleted and then re-created, resulting in a different resource path, HomeKit will treat it as a new accessory, and you will need to re-configure HomeKit.