Configuration

This page provides an overview of the config.json parameters used by homebridge-hue.

key	default	description
host	[]	The hostname or IP address of the Hue bridge. When set, discovery of bridges is disabled. To specify multiple hostnames and/or IP addresses use an array, e.g. "host": ["192.168.1.10", "192.168.1.11"].
users	{}	A dictionary containing a key/value-pair per Hue bridge, where the key holds the bridge ID and the value holds the bridge username, effectively a security token to access the bridge. When connecting to a new bridge, homebridge-hue will create the username, and prompt you to edit config.json.
sensors	false	Flag whether to expose Hue bridge sensors to HomeKit.
excludeSensorTypes	[]	An array of sensor types to ignore. The sensor type is the (case sensitive) type attribute of the bridge sensor object, or "CLIP" as a shortcut for all CLIP sensors. For example, to expose only the Hue motion sensors, Hue taps, and Hue dimmer switches, specify: "excludeSensorTypes": [ "CLIP", "Geofence", "Daylight"].
lowBattery	25	The battery level threshold for StatusLowBattery.
lights	false	Flag whether to expose Hue bridge lights to HomeKit.
philipsLights	false	Flag whether to include Philips lights when lights are exposed. To expose all lights, set lights as well as philipsLights; to expose only non-Philips lights, only set lights.
ct	false	Flag whether to expose color temperature using the Mirek Color Temperature characteristic the v2 (square) Hue bridge uses.
groups	false	Flag whether to expose Hue bridge groups to HomeKit.
group0	false	Flag whether to include group 0 (all lights) when groups are exposed.
rooms	false	Flag whether to include Room groups when groups are exposed.
schedules	false	lag whether to expose Hue bridge schedules to HomeKit.
rules	false	Flag whether to expose Hue bridge rules to HomeKit.
heartrate	5	The interval in seconds to poll the Hue bridge. Must be between 1 and 30. I've been using a 2-second heartrate with no issues on my v2 (square) bridge. Note that this can be changed dynamically per bridge, through the Heartbeat service.
waitTimeUpdate	50	The time in milliseconds to wait for a change from HomeKit to another characteristic for the same light or group, before updating the Hue bridge. Must be between 20 and 500. You might want to increase this when homebridge-hue reports hue bridge error 201: parameter, xy, is not modifiable. Device is set to off. on activating a HomeKit scene that turns a light on at a specific colour, colour temperature, and/or brightness.
timeout	5	The timeout in seconds to wait for a response from a Hue bridge (or the Meethue portal or UPnP discovery). Must be between 5 and 30. You might want to increase this if homebridge-hue reports ESOCKETTIMEDOUT errors.
parallelRequests	10 3	The number of ansynchronous requests homebridge-hue sends in parallel to a Hue bridge. Must be between 1 and 30. You might want to decrease this if homebridge-hue reports ECONNRESET errors. The default is 10 for a v2 bridge and 3 for a v1 bridge.
waitTimeResend	300	The time in milliseconds to wait before resending a request after an ECONNRESET error. Must be between 100 and 1000.