thegnuu/node-red-contrib-huemagic

Philips Hue node to control lights, groups, motion sensors, temperature sensors and Lux sensors using Node-RED.

HueMagic - Philips Hue nodes for Node-RED

HueMagic provides several input and output nodes for Node-RED and is the most in-depth and easy to use solution to control Philips Hue lights, groups, scenes, taps, switches, motion sensors, temperature sensors and Lux sensors.

Features

• Easy and extended control
• Automatic discovery of Philips Hue bridges as well as devices, scenes & groups
• Automatic and powerful color conversions (supports HEX & RGB input / output)
• Events to detect external changes on all devices / groups
• Displays current state for all device types in the Node-RED UI
• Supports activating / deactivating of motion sensors
• Easy to use alarm and colorloop effects on light bulbs and whole groups
• Additive state settings on all nodes with multiple commands supported

Installation

HueMagic was written for Node.js 4+ and Node-RED v0.17.5+. It supports Philips Hue API version v1.19.0+. Please make sure, that you deactivate / remove other Philips Hue related NodeRED nodes before installing HueMagic!

npm install node-red-contrib-huemagic

Available Nodes

• Hue Lights
• Hue Groups
• Hue Scenes
• Hue Taps
• Hue Wireless Dimmer Switches
• Hue Motion Sensors
• Hue Temperature Sensors
• Hue Lux Sensors

Hue Lights

Use the Hue Light node to control the lights and receive light bulb events (you can find this node under the input category of your nodes palette).

Turn on / off (simple mode)

Changes the light on / off state based on the passed in msg values of:

Property	Type	Information
payload	boolean	Will turn on or turn off the light with its previous configuration (color and brightness)

Turn On / Off (extended mode)

Changes the light state, effect, color, brightness and other states based on the passed in msg.payload values of:

Property	Type	Information
on	boolean	Will turn on or turn off the light with its previous configuration (color and brightness)
brightness	int	Optionally configurable brightness of the light in percent (0-100)
rgb	array[int,int,int]	Optionally configurable RGB color value of the light bulb. You don't need to pass the RGB value if you already passed a HEX value
hex	string	Optionally configurable HEX color value of the light bulb. You don't need to pass the HEX value if you already passed a RGB value
transitionTime	int	Optionally configurable temporary value which eases transition of an effect (value in seconds, 0 for instant, 5 for five seconds)
colorloop	int	Optionally configurable color loop effect. Value in seconds (deactivates the effect to the previous state after x seconds)
colorTemp	int	Optionally configurable color temperature of the light from 153 to 500
saturation	int	Optionally configurable color saturation of the light in percent (from 0 to 100)

Special Alert Effect

Plays an alert effect based on the passed in msg.payload values of:

Property	Type	Information
alert	int (required)	Configurable amount of seconds to play the alert effect (max 30). When the alert effect is finished the light bulb will reset to the previous state.
rgb	array[int,int,int]	Optionally configurable RGB color value of the alert effect. You don't need to pass the RGB value if you already passed a HEX value
hex	string	Optionally configurable HEX color value of the alert effect. You don't need to pass the HEX value if you already passed a RGB value

Light Events

The event message that the light bulb sends contains the following data in the msg.payload object. Events will only be sent if the light bulb state is changed.

Property	Type	Information
on	boolean	True for on, false for off
brightness	int	Current brightness of the light bulb in percent
rgb	array[int,int,int]	Current RGB color value of the light bulb (if supported)
hex	string	Current HEX color value of the light bulb (if supported)
colorTemp	int	Current color temperature of the light bulb (if supported)
updated	string	ISO 8601 date string of the last light state update

Additional Light Bulb Information

The event message that the light bulb sends also contains the following data in the msg.info object.

Property	Type	Information
id	int	Numerical id of the light as registered on the bridge
uniqueId	string	Unique Id of the light (typically hardware id)
name	string	Name for the light
type	string	Type of light (e.g. Extended Color Light, Dimmable Light)
softwareVersion	float	Software version of the light
model	object	The model object of the light includes model specific information like the model.id, model.manufacturer, model.name, model.type, model.colorGamut and model.friendsOfHue

Universal Mode (optional)

Defines the light Id on the Hue Bridge manually if not configured in the node properties (deactivates light update events):

Property	Type	Information
msg.topic	int	Manual definition of the light bulb Id

Hue Groups

Use the Hue Group node to control whole groups containing lights and receive group events (you can find this node under the input category of your nodes palette).

Turn on / off (simple mode)

Changes the group on / off state based on the passed in msg values of:

Property	Type	Information
payload	boolean	Will turn on or turn off all lights inside the group with their previous configuration (color and brightness)

Turn On / Off (extended mode)

Changes the group state, effect, color, brightness and other states based on the passed in msg.payload values of:

Property	Type	Information
on	boolean	True to turn on all the lights inside the group, false to turn them off
brightness	int	Optionally configurable brightness of the lights in percent (0-100)
rgb	array[int,int,int]	Optionally configurable RGB color value of all lights inside the group. You don't need to pass the RGB value if you already passed a HEX value
hex	string	Optionally configurable HEX color value of all lights inside the group. You don't need to pass the HEX value if you already passed a RGB value
transitionTime	int	Optionally configurable temporary value which eases transition of an effect (value in seconds, 0 for instant, 5 for five seconds)
colorloop	int	Optionally configurable color loop effect. Value in seconds (deactivates the effect to the previous state after x seconds)
colorTemp	int	Optionally configurable color temperature of the group lights from 153 to 500
saturation	int	Optionally configurable color saturation of the group in percent (from 0 to 100)

Special Alert Effect

Plays an alert effect based on the passed in msg.payload values of:

Property	Type	Information
alert	int (required)	Configurable amount of seconds to play the alert effect (max 30). When the alert effect is finished you have to manually reset the lights to their previous state.
rgb	array[int,int,int]	Optionally configurable RGB color value of the alert effect. You don't need to pass the RGB value if you already passed a HEX value
hex	string	Optionally configurable HEX color value of the alert effect. You don't need to pass the HEX value if you already passed a RGB value

Group Events

The event message that the group sends contains the following data in the msg.payload object. Events will only be sent if the group state is changed.

Property	Type	Information
on	boolean	True for on, false for off
allOn	boolean	True if all lights in the group are on, false if not
anyOn	boolean	True if any lights in the group are on, false if none are on
brightness	int	Current brightness of all lights in the whole group in percent
rgb	array[int,int,int]	Current RGB color value of all lights in the group (if supported)
hex	string	Current HEX color value of all lights in the group (if supported)
colorTemp	int	Current color temperature of all lights in the group (if supported)
updated	string	ISO 8601 date string of the last group state update

Additional Group Information

The event message that the group sends also contains the following data in the msg.info object.

Property	Type	Information
id	int	Group Id, generated automatically by the bridge
lightIds	array	An array of light ids associated with the group
name	string	Name for the group
type	string	Type of group (e.g. LightGroup, Luminaire, LightSource, Room)
model	object	Huejay (the API behind HueMagic) maintains a list of Philips Hue supported luminaire models. The Group model attribute returns optionally a GroupModel object. This object contains more information about the model like the model.id, model.manufacturer, model.name, model.type, model.colorGamut and model.friendsOfHue

Universal Mode (optional)

Defines the group Id on the Hue Bridge manually if not configured in the node properties (deactivates group update events):

Property	Type	Information
msg.topic	int	Manual definition of the group Id

Hue Scenes

Use the Hue Scene node to recall / activate preconfigured scenes on the bridge and receive scene information (you can find this node under the input category of your nodes palette).

Recall / Activate Scene

Any passed in value on the scene node activates the preconfigured scene. Please note that recalling animated scenes may not work properly due to some restrictions.

Scene Events

The event message that the scene node sends contains the following data in the msg.payload object. Events will only be sent if a scene receives any command.

Property	Type	Information
id	string	The unique scene id
name	string	The scene name
lightIds	array[int…]	Array of associated light ids in the scene
owner	string	User who created the scene
appData	object	Object consisting of appData.version and appData.data properties
lastUpdated	string	ISO 8601 date string when scene was last updated
version	float	Version number of the scene

Hue Tap

Use the Hue Tap node to receive button events (you can find this node under the output category of your nodes palette).

Button Events

The event message that the Hue Tap device sends contains the following data in the msg.payload object. Events will only sent on deploy (once) and if a button is pressed.

Property	Type	Information
button	int	Pressed button number from 1-4
updated	string	ISO 8601 date string of the last button event

Additional Hue Tap Information

The event message that the Hue Tap device sends also contains the following data in the msg.info object.

Property	Type	Information
id	int	Numerical id of the sensor as registered on the bridge
uniqueId	string	Unique Id of the sensor (typically hardware id)
name	string	Name for the sensor
type	string	Sensor type (e.g. Daylight, CLIPTemperature, ZGPSwitch)
model	object	The model object of the sensor includes model specific information like the model.id, model.manufacturer, model.name and model.type

Hue Switch

Use the Hue Switch node to receive button events (you can find this node under the output category of your nodes palette).

Button Events

The event message that the Hue Wireless Dimmer Switch sends contains the following data in the msg.payload object. Events will only sent on deploy (once) and if a button is pressed.

Property	Type	Information
button	int	Pressed button id (more information under 1.2 ZLL Switch)
name	string	Human readable pressed button name (On, Dim Up, Dim Down, Off)
action	string	Human readable pressed button action (pressed, holded, short released, long released)
updated	string	ISO 8601 date string of the last button event

Additional Hue Switch Information

The event message that the Hue Wireless Dimmer Switch device sends also contains the following data in the msg.info object.

Property	Type	Information
id	int	Numerical id of the sensor as registered on the bridge
uniqueId	string	Unique Id of the sensor (typically hardware id)
name	string	Name for the sensor
type	string	Sensor type (e.g. Daylight, CLIPTemperature, ZGPSwitch)
battery	int	Current battery level of the Hue Switch in percent
model	object	The model object of the sensor includes model specific information like the model.id, model.manufacturer, model.name and model.type

Hue Motion Sensor

Use the Hue Motion node to control the motion sensor and receive motion events (you can find this node under the output category of your nodes palette).

Activate / Deactivate Sensor

Activates or deactivates the motion sensor based on the passed in msg values of:

Property	Type	Information
payload	boolean	True to activate the motion sensor, false to deactivate

Motion Events

The event message that the motion sensor sends contains the following data in the msg.payload object. Events will only be sent if a motion is detected, if a motion stops or if the motion sensor receives the Activate / Deactivate command.

Property	Type	Information
active	boolean	Current sensor state
motion	boolean	Indicates if a motion is detected or not
updated	string	ISO 8601 date string of the last detected motion

Additional Motion Sensor Information

The event message that the motion sensor sends also contains the following data in the msg.info object.

Property	Type	Information
id	int	Numerical id of the sensor as registered on the bridge
uniqueId	string	Unique Id of the sensor (typically hardware id)
name	string	Name for the sensor
type	string	Sensor type (e.g. Daylight, CLIPTemperature, ZGPSwitch)
softwareVersion	float	Software version of the sensor
battery	int	Current battery level of the temperature sensor in percent
model	object	The model object of the sensor includes model specific information like the model.id, model.manufacturer, model.name and model.type

Hue Temperature Sensor

Use the Hue Temperature node to receive current (room) temperature in Celsius and Fahrenheit (you can find this node under the output category of your nodes palette).

Temperature Events

The event message that the temperature sensor sends contains the following data in the msg.payload object. Events will only sent on deploy (once) and if the temperature changes.

Property	Type	Information
celsius	float	Temperature in Celsius
fahrenheit	float	Temperature in Fahrenheit
updated	string	ISO 8601 date string of the last temperature change

Additional Temperature Sensor Information

The event message that the temperature sensor sends also contains the following data in the msg.info object.

Property	Type	Information
id	int	Numerical id of the sensor as registered on the bridge
uniqueId	string	Unique Id of the sensor (typically hardware id)
name	string	Name for the sensor
type	string	Sensor type (e.g. Daylight, CLIPTemperature, ZGPSwitch)
softwareVersion	float	Software version of the sensor
battery	int	Current battery level of the temperature sensor in percent
model	object	The model object of the sensor includes model specific information like the model.id, model.manufacturer, model.name and model.type

Hue Lux Sensor

Use the Hue Brightness node to receive the current light level in Lux and daylight / darkness (you can find this node under the output category of your nodes palette).

Light Level Events

The event message that the light sensor sends contains the following data in the msg.payload object. Events will only be sent on deploy (once) and if the light level changes.

Property	Type	Information
lightlevel	int	Light level measured in Lux
dark	boolean	True if it's dark
daylight	boolean	True if daylight recognized
updated	string	ISO 8601 date string of the last light level update

Additional Lux Sensor Information

The event message that the lux sensor sends also contains the following data in the msg.info object.

Property	Type	Information
id	int	Numerical id of the sensor as registered on the bridge
uniqueId	string	Unique Id of the sensor (typically hardware id)
name	string	Name for the sensor
type	string	Sensor type (e.g. Daylight, CLIPTemperature, ZGPSwitch)
softwareVersion	float	Software version of the sensor
battery	int	Current battery level of the temperature sensor in percent
model	object	The model object of the sensor includes model specific information like the model.id, model.manufacturer, model.name and model.type

Changelog

v1.3.4 (latest)

• Improved status messages for transition commands
• Dependency updates

v1.3.2

• Fixed incorrect msg.topic handlings
• Small improvements

v1.3.1

• New "saturation" setting in Hue Light and Hue Group nodes
• Improved input algorithm for Hue Lights and Groups nodes
• Added range validation for the "brightness" setting
• Setting the brightness level to "0" percent now turns off the lamp / group
• Fixed an error where nodes are losing their Id
• Fixed an error with the Hue Switch / Hue Tap node
• Typo corrections in README and several node's information

v1.2.3

• Fixed an error on the Hue Switch and Hue Tap nodes
• Fixed an error with the "Universal Mode" on several nodes

v1.2.1

• Support of Hue Taps and Wireless Dimmer Switches (new nodes available)
• Improved connection handling with automatic reconnection
• New option to configure color temperature on lights and groups (28277f4)
• Dependency updates

v1.1.9

• Improved alert function with configurable amount of seconds
• Several fixes and optimizations

v1.1.8

• New "universal mode" for Hue Light and Hue Group nodes

v1.1.7

• Replacing "superagent" dependency with "request" due to security vulnerabilities
• Several small fixes and optimizations for hue bridge node

v1.1.3

• Several fixes for the Hue Light and Hue Group nodes

v1.1.2

• Fixed block-scoped declarations for Node.js below version 6.x

v1.1.0

• Support of Hue Scenes (new scene node)!
• Removed "id, "lightIds" and "battery" parameter in msg.payload of sensors / lights / groups
• Added msg.info object on all node events with extended device information

v1.0.3

• Typo corrections and small improvements

v1.0.0

• Initial release

---

HueMagic is sponsored by BrowserStack for cross browser compatibility testing on real browsers.

Released under the Apache License 2.0.