node-red-contrib-huemagic 4.1.0 → 4.2.2

package/CHANGELOG.md

@@ -1,8 +1,83 @@
-[![Hue Magic Logo](https://gistcdn.githack.com/Foddy/062045775c28f5993ad646aba80e678c/raw/27e90d22bde68d9c92aed520c0c0c2cb8a22b7fd/huemagicv3x.svg)](https://flows.nodered.org/node/node-red-contrib-huemagic)
+[![Hue Magic Logo](https://gist.githubusercontent.com/Foddy/9b647b910d03a31cee40f97c3988dd1c/raw/7ee635bd958ad04d7ba53c6c40ec401f879bffc2/huemagic-logo.svg)](https://flows.nodered.org/node/node-red-contrib-huemagic)
 
 # Changelog
 
-### v3.0.0 (latest)
+### v4.2.2 (latest)
+
+* HueMagic can now be installed again on older Node-RED versions without official support
+* Fixed an issue for Hue Group nodes not getting/updating their current status ([#342](https://github.com/Foddy/node-red-contrib-huemagic/issues/342)) (thx @bmdevx)
+* Fixed an error with non-functioning node configurations
+
+### v4.2.1
+
+* Commands are now re-executed up to three times if they fail due to a bridge timeout
+* The "image" option on the "Hue Light" node will now set the corresponding gradient colors on supported resources
+* Better handling of broken connections to the bridge ([#309](https://github.com/Foddy/node-red-contrib-huemagic/pull/309)) (thx)
+* Fixed an error with the "Hue Scenes" node on newer bridge firmwares ([#335](https://github.com/Foddy/node-red-contrib-huemagic/issues/335)) ([#339](https://github.com/Foddy/node-red-contrib-huemagic/pull/339)) (thx)
+* Fixed an uncaught exception on newer bridge firmwares ([#302](https://github.com/Foddy/node-red-contrib-huemagic/issues/302)) ([#309](https://github.com/Foddy/node-red-contrib-huemagic/pull/309)) (thx)
+* Updated dependencies to the latest versions
+* Fixed some typos here and there
+
+### v4.1.0
+
+* New queue worker throttles the number of parallel requests to the bridge to avoid 503 API limit errors (can be configured in the Bridge configuration)
+* Resources are now alphabetically sorted in the node´s configuration interface ([#282](https://github.com/Foddy/node-red-contrib-huemagic/pull/282)) (thx)
+* "Hue Brightness" node was optimized to output more accurate "dark" and "dayLight" values
+* Several optimizations in the documentation of some nodes
+
+### v4.0.5
+
+* The "Hue Group" node now contains the "resources" information with all linked resources behind the group/zone
+* Fixed an issue that caused Node-RED to restart if a command was sent before a node was initialized
+
+### v4.0.4
+
+* Fixed an issue with the bridge config node checking for updates too frequently ([#246](https://github.com/Foddy/node-red-contrib-huemagic/issues/246#issuecomment-1009376442))
+* Fixed an issue with multiple bridges configured
+
+### v4.0.3
+
+> **Attention!** HueMagic v4+ has been almost completely rewritten under the hood and requires at least the (square-shaped) Philips Hue Bridge firmware 1948086000+ from November 1st, 2021 ([Upgrade instructions](https://www.lighting.philips.com/content/B2C/en_US/microsites/meethue/marketing-catalog/huewireless_ca/support/security-advisory/general/where-and-how-can-i-update-my-hue-system-with-the-latest-software.html)) and Node-RED v1+ ([Upgrade instructions](https://nodered.org/docs/getting-started/local#upgrading-node-red)). If you are upgrading from a previous HueMagic version to the v4, you will have to reconfigure (not completely rebuild) all nodes by clicking them and selecting the appropriate device from the list. This also applies to nodes / functions that are operated in universal mode, as the numeric identifiers of the latest Philips Hue API version have been replaced in UUIDs. The nodes "Hue Switch", "Hue Button" & "Hue Tap" have been replaced in v4 by the universal and uniform node "Hue Buttons", which works with all button / switch devices that are connected to the Hue Bridge (please note here also the new API in the documentation). The request and return objects of the individual nodes are largely compatible with older HueMagic versions - with the exception of the nodes "Hue Bridge", "Hue Buttons", "Hue Scene" & "Hue Group". These need to be adjusted in the v4. Make sure that you meet the minimum technical requirements and have a quiet minute for the migration before upgrading to the v4.
+
+* HueMagic speaks now directly with the bridge without any submodules *(huejay dependency removed)*
+* Migrated to the newest CLIP/v2 API version from the Philips Hue bridge
+* Nodes are now updated via push notifications (SSE) from the bridge instead of periodic polling
+* Instant "current status" queries on each node with no loading time
+* "Hue Buttons" node supports all new Philips Hue buttons/switches (e.g. Dimmer Switch v2, Hue Wall Switch…)
+* All nodes provide additional property information in the output (check docs)
+* New universal node "Hue Buttons" replaces the following nodes: "Hue Switch", "Hue Button", "Hue Tap"
+* New "updated" object for all nodes, which only contains the properties that have been updated since the last state
+* New configuration option to suppress first message after node initialization (for all nodes)
+* New gradient color setting for compatible light sources (in "Hue Light" node)
+* New inject button for almost all nodes, which triggers the current status of a node
+* New "universal mode" support for the "Hue Rule" node
+* New SVG-version of each node icon for higher quality rendering in the Node-RED UI
+* New and full featured examples for each node right inside Node-RED
+* New color mix feature in "Hue Light" nodes with the ability to mix the current light color with another
+* New automatic brightness support based on the current time for "Hue Light" & "Hue Group" nodes
+* New "Superhero", "Neon City" & "Christmas" (for next year, sorry) animations in "Hue Magic" node
+* The custom alert effect on "Hue Light" & "Hue Group" nodes can now also be configured in brightness
+* All nodes will now also forward the last command that has been applied ([#249](https://github.com/Foddy/node-red-contrib-huemagic/issues/249))
+* "Hue Temperature" & "Hue Brightness" nodes can now also be activated & deactivated
+* "Hue Light" & "Hue Group" nodes can now also receive XY color settings
+* "Hue Light" & "Hue Group" can now also receive a named color temperature setting
+* "Hue Light" & "Hue Group" nodes can now receive future brightness states in "turned off" mode ([#244](https://github.com/Foddy/node-red-contrib-huemagic/issues/244))
+* Automatic light temperature setting outputs now values from 153 (coldest) to 500 (warmest)
+* Automatic color correction based on the light´s capabilities for more accurate color settings
+* Optimized node editor configuration UI to better match the current Node-RED´s UI
+* The option for "automatic firmware updates" on the bridge moved to the bridge configuration node
+* "Hue Group" node does no longer contain the "msg.info.model" & "msg.info.class" property
+* Fixed timeout connection issues to the bridge
+* Fixed an issue with non stopping custom animations ([#222](https://github.com/Foddy/node-red-contrib-huemagic/issues/222)), ([#224](https://github.com/Foddy/node-red-contrib-huemagic/issues/224)) & ([#226](https://github.com/Foddy/node-red-contrib-huemagic/pull/226)) (thx)
+* Node-RED will no longer crash if there is no active connection to the bridge ([#237](https://github.com/Foddy/node-red-contrib-huemagic/issues/237))
+* Fixed an issue that prevented the light / group from not reporting its own status when queried & node events were deactivated ([#248](https://github.com/Foddy/node-red-contrib-huemagic/issues/248))
+* Fixed an issue with nodes in universal mode ([#245](https://github.com/Foddy/node-red-contrib-huemagic/issues/245))
+* A possible attack target has been fixed ([#217](https://github.com/Foddy/node-red-contrib-huemagic/issues/217))
+* Moved away from "moment.js" to "Day.js" for date/time formatting inside the nodes
+* Updated README and help section on each node
+* Updated dependencies to the latest version
+
+### v3.0.0
 * Hue Motion, Hue Brightness, Hue Tap, Hue Switch & Hue Button nodes can now receive a status request
 * New "Universal Mode" for the Hue Motion, Hue Brightness, Hue Tap, Hue Switch & Hue Button nodes
 * The "colorTemp" property for Hue Light & Hue Group nodes can now also be set to "cold", "normal", "warm" or "auto"

package/README.md

@@ -796,11 +796,27 @@ If the status of the node has changed via a certain command, the entire command
 
 # Changelog
 
-### v4.1.0 (latest)
+### v4.2.2 (latest)
+
+* HueMagic can now be installed again on older Node-RED versions without official support
+* Fixed an issue for Hue Group nodes not getting/updating their current status ([#342](https://github.com/Foddy/node-red-contrib-huemagic/issues/342)) (thx @bmdevx)
+* Fixed an error with non-functioning node configurations
+
+### v4.2.1
+
+* Commands are now re-executed up to three times if they fail due to a bridge timeout
+* The "image" option on the "Hue Light" node will now set the corresponding gradient colors on supported resources
+* Better handling of broken connections to the bridge ([#309](https://github.com/Foddy/node-red-contrib-huemagic/pull/309)) (thx)
+* Fixed an error with the "Hue Scenes" node on newer bridge firmwares ([#335](https://github.com/Foddy/node-red-contrib-huemagic/issues/335)) ([#339](https://github.com/Foddy/node-red-contrib-huemagic/pull/339)) (thx)
+* Fixed an uncaught exception on newer bridge firmwares ([#302](https://github.com/Foddy/node-red-contrib-huemagic/issues/302)) ([#309](https://github.com/Foddy/node-red-contrib-huemagic/pull/309)) (thx)
+* Updated dependencies to the latest versions
+* Fixed some typos here and there
+
+### v4.1.0
 
 * New queue worker throttles the number of parallel requests to the bridge to avoid 503 API limit errors (can be configured in the Bridge configuration)
-* Resources are now alphabetically sorted in the node´s configuration inetrface ([#282](https://github.com/Foddy/node-red-contrib-huemagic/pull/282)) (thx)
-* "Hue Bridghtness" node was optimized to output more accurate "dark" and "dayLight" values
+* Resources are now alphabetically sorted in the node´s configuration interface ([#282](https://github.com/Foddy/node-red-contrib-huemagic/pull/282)) (thx)
+* "Hue Brightness" node was optimized to output more accurate "dark" and "dayLight" values
 * Several optimizations in the documentation of some nodes
 
 ### v4.0.5
@@ -868,17 +884,8 @@ If the status of the node has changed via a certain command, the entire command
 * Fixed an error with future states and the HTTP request node ([#200](https://github.com/Foddy/node-red-contrib-huemagic/pull/200))
 * Other optimizations, dependency updates and clean up
 
-### v2.8.6
-* Optimized random color mode for Hue Magic, Hue Light & Hue Group nodes ([#190](https://github.com/Foddy/node-red-contrib-huemagic/pull/190))
-* New Hue Button node ([#191](https://github.com/Foddy/node-red-contrib-huemagic/pull/191))
-* Updated README and Hue Button node docs (+ localized in German)
-
-### v2.8.2
-* Fixed an issue with Hue Light & Hue Group nodes on extended mode ([#179](https://github.com/Foddy/node-red-contrib-huemagic/issues/179))
-* Dependency updates
-
 ### Previous versions
-A complete overview of the updates can be viewed in the [changelog](https://github.com/Foddy/node-red-contrib-huemagic/blob/master/CHANGELOG.md)…
+The full changelog [changelog](https://github.com/Foddy/node-red-contrib-huemagic/blob/master/CHANGELOG.md) can be viewed here…
 
 
 ***

package/huemagic/hue-bridge-config.html

@@ -51,8 +51,8 @@
 			name: { value:"Hue Bridge", required: true },
 			bridge: { value:"", required: true },
 			key: { value:"", required: true },
-			worker: { value: 10, required: true, validate:function(v) {
-				return (!isNaN(v) && v > 0)
+			worker: { value: 10, required: true, validate: function(v) {
+				return (!isNaN(v) && v > 0);
 			}},
 			autoupdates: { value: true },
 			disableupdates: { value: false }

package/huemagic/hue-bridge-config.js

@@ -34,9 +34,10 @@ module.exports = function(RED)
 		this.lastStates = {};
 		this.events = new events.EventEmitter();
 		this.patchQueue = null;
+		this.timerWatchDog = null;
 
 		// RESOURCE ID PATTERN
-		this.validResourceID = /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/gi;
+		this.validResourceID = /[a-zA-Z0-9]/gi;
 
 		// FIRMWARE UPDATE TIMEOUT
 		this.firmwareUpdateTimeout = null;
@@ -44,6 +45,31 @@ module.exports = function(RED)
 		// CREATE NODE
 		RED.nodes.createNode(scope, config);
 
+		// PERIODICALLY CHECK WETHER BRIDGE IS CONNECTED
+		this.startWatchdog = function()
+		{
+			if (this.timerWatchDog !== null) clearTimeout(this.timerWatchDog);
+			this.timerWatchDog = setTimeout(function()
+			{
+				try
+				{
+					API.request({ config: config, resource: "/config", version: 1 })
+					.then(function(bridgeInformation)
+					{
+						scope.startWatchdog();
+					})
+					.catch(function(error)
+					{
+						scope.log("Error requesting info from the bridge. Reconnect in some secs. " + error.message);
+						scope.start();
+					});		
+				} catch (error) {
+					scope.log("Lost connection with the bridge. Reconnect in some secs. " + error.message);
+					scope.start();
+				}
+			}, 10000);
+		}
+
 		// INITIALIZE
 		this.start = function()
 		{
@@ -74,6 +100,9 @@ module.exports = function(RED)
 
 				// START LOOKING FOR FIRMWARE-UPDATES
 				scope.autoUpdateFirmware();
+
+				// START WATCHDOG
+				scope.startWatchdog();
 				return true;
 			})
 			.catch(function(error)
@@ -303,96 +332,129 @@ module.exports = function(RED)
 
 					if(type == "bridge")
 					{
-						const message = new HueBridgeMessage(targetResource, options);
-
-						// GET CURRENT STATE MESSAGE
-						let currentState = message.msg;
-						return currentState;
+						try {
+							const message = new HueBridgeMessage(targetResource, options);
+
+							// GET CURRENT STATE MESSAGE
+							let currentState = message.msg;
+							return currentState;	
+						} catch (error) {
+							return false;
+						}
+						
 					}
 					else if(type == "light")
 					{
-						const message = new HueLightMessage(targetResource, options);
-
-						// GET & SAVE LAST STATE AND DIFFERENCES
-						let currentState = message.msg;
-						scope.lastStates[type+targetResource.id] = Object.assign({}, currentState);
-						currentState.updated = (lastState === false) ? {} : diff(lastState, currentState);
-						currentState.lastState = lastState;
-
-						return currentState;
+						try {
+							const message = new HueLightMessage(targetResource, options);
+
+							// GET & SAVE LAST STATE AND DIFFERENCES
+							let currentState = message.msg;
+							scope.lastStates[type+targetResource.id] = Object.assign({}, currentState);
+							currentState.updated = (lastState === false) ? {} : diff(lastState, currentState);
+							currentState.lastState = lastState;
+
+							return currentState;
+						} catch (error) {
+							return false;
+						}
 					}
 					else if(type == "group")
 					{
-						// GET MESSAGE
-						const message = new HueGroupMessage(targetResource, { resources: scope.resources, ...options});
-
-						// GET & SAVE LAST STATE AND DIFFERENCES
-						let currentState = message.msg;
-						scope.lastStates[type+targetResource.id] = Object.assign({}, currentState);
-						currentState.updated = (lastState === false) ? {} : diff(lastState, currentState);
-						currentState.lastState = lastState;
-
-						return currentState;
+						try {
+							// GET MESSAGE
+							const message = new HueGroupMessage(targetResource, { resources: scope.resources, ...options});
+
+							// GET & SAVE LAST STATE AND DIFFERENCES
+							let currentState = message.msg;
+							scope.lastStates[type+targetResource.id] = Object.assign({}, currentState);
+							currentState.updated = (lastState === false) ? {} : diff(lastState, currentState);
+							currentState.lastState = lastState;
+
+							return currentState;
+						} catch (error) {
+							return false;
+						}
 					}
 					else if(type == "button")
 					{
-						const message = new HueButtonsMessage(targetResource, options);
-
-						// GET & SAVE LAST STATE AND DIFFERENCES
-						let currentState = message.msg;
-						scope.lastStates[type+targetResource.id] = Object.assign({}, currentState);
-						currentState.updated = (lastState === false) ? {} : diff(lastState, currentState);
-						currentState.lastState = lastState;
-
-						return currentState;
+						try {
+							const message = new HueButtonsMessage(targetResource, options);
+
+							// GET & SAVE LAST STATE AND DIFFERENCES
+							let currentState = message.msg;
+							scope.lastStates[type+targetResource.id] = Object.assign({}, currentState);
+							currentState.updated = (lastState === false) ? {} : diff(lastState, currentState);
+							currentState.lastState = lastState;
+
+							return currentState;
+						} catch (error) {
+							return false;
+						}
 					}
 					else if(type == "motion")
 					{
-						const message = new HueMotionMessage(targetResource, options);
-
-						// GET & SAVE LAST STATE AND DIFFERENCES
-						let currentState = message.msg;
-						scope.lastStates[type+targetResource.id] = Object.assign({}, currentState);
-						currentState.updated = (lastState === false) ? {} : diff(lastState, currentState);
-						currentState.lastState = lastState;
-
-						return currentState;
+						try {
+							const message = new HueMotionMessage(targetResource, options);
+
+							// GET & SAVE LAST STATE AND DIFFERENCES
+							let currentState = message.msg;
+							scope.lastStates[type+targetResource.id] = Object.assign({}, currentState);
+							currentState.updated = (lastState === false) ? {} : diff(lastState, currentState);
+							currentState.lastState = lastState;
+
+							return currentState;
+						} catch (error) {
+							return false;
+						}
 					}
 					else if(type == "temperature")
 					{
-						const message = new HueTemperatureMessage(targetResource, options);
-
-						// GET & SAVE LAST STATE AND DIFFERENCES
-						let currentState = message.msg;
-						scope.lastStates[type+targetResource.id] = Object.assign({}, currentState);
-						currentState.updated = (lastState === false) ? {} : diff(lastState, currentState);
-						currentState.lastState = lastState;
-
-						return currentState;
+						try {
+							const message = new HueTemperatureMessage(targetResource, options);
+
+							// GET & SAVE LAST STATE AND DIFFERENCES
+							let currentState = message.msg;
+							scope.lastStates[type+targetResource.id] = Object.assign({}, currentState);
+							currentState.updated = (lastState === false) ? {} : diff(lastState, currentState);
+							currentState.lastState = lastState;
+
+							return currentState;
+						} catch (error) {
+							return false;
+						}
 					}
 					else if(type == "light_level")
 					{
-						const message = new HueBrightnessMessage(targetResource, options);
-
-						// GET & SAVE LAST STATE AND DIFFERENCES
-						let currentState = message.msg;
-						scope.lastStates[type+targetResource.id] = Object.assign({}, currentState);
-						currentState.updated = (lastState === false) ? {} : diff(lastState, currentState);
-						currentState.lastState = lastState;
-
-						return currentState;
+						try {
+							const message = new HueBrightnessMessage(targetResource, options);
+
+							// GET & SAVE LAST STATE AND DIFFERENCES
+							let currentState = message.msg;
+							scope.lastStates[type+targetResource.id] = Object.assign({}, currentState);
+							currentState.updated = (lastState === false) ? {} : diff(lastState, currentState);
+							currentState.lastState = lastState;
+
+							return currentState;
+						} catch (error) {
+							return false;
+						}
 					}
 					else if(type == "rule")
 					{
-						const message = new HueRulesMessage(targetResource, options);
-
-						// GET & SAVE LAST STATE AND DIFFERENCES
-						let currentState = message.msg;
-						scope.lastStates[type+targetResource.id] = Object.assign({}, currentState);
-						currentState.updated = (lastState === false) ? {} : diff(lastState, currentState);
-						currentState.lastState = lastState;
-
-						return currentState;
+						try {
+							const message = new HueRulesMessage(targetResource, options);
+
+							// GET & SAVE LAST STATE AND DIFFERENCES
+							let currentState = message.msg;
+							scope.lastStates[type+targetResource.id] = Object.assign({}, currentState);
+							currentState.updated = (lastState === false) ? {} : diff(lastState, currentState);
+							currentState.lastState = lastState;
+
+							return currentState;
+						} catch (error) {
+							return false;
+						}
 					}
 					else
 					{
@@ -598,7 +660,7 @@ module.exports = function(RED)
 		//
 		// START THE MAGIC
 		this.start();
-
+		
 		//
 		// CLOSE NODE / REMOVE EVENT LISTENER
 		this.on('close', function()

package/huemagic/hue-brightness.js

@@ -8,6 +8,7 @@ module.exports = function(RED)
 
 		const scope = this;
 		const bridge = RED.nodes.getNode(config.bridge);
+		const async = require('async');
 
 		// SAVE LAST COMMAND
 		this.lastCommand = null;
@@ -116,7 +117,7 @@ module.exports = function(RED)
 			let currentState = bridge.get("light_level", tempSensorID);
 			if(!currentState)
 			{
-				scope.error("The sensor in not yet available. Please wait until HueMagic has established a connection with the bridge or check whether the resource ID in the configuration is valid..");
+				scope.error("The sensor in not yet available. Please wait until HueMagic has established a connection with the bridge or check whether the resource ID in the configuration is valid.");
 				return false;
 			}
 
@@ -157,9 +158,30 @@ module.exports = function(RED)
 				}
 
 				// PATCH!
-				bridge.patch("light_level", tempSensorID, patchObject)
-				.then(function() { if(done) { done(); }})
-				.catch(function(errors) { scope.error(errors); });
+				async.retry({
+					times: 3,
+					errorFilter: function(err) {
+						return (err.status == 503);
+					},
+					interval: function(retryCount) { return retryCount*2000; }
+				},
+				function(callback, results)
+				{
+					bridge.patch("light_level", tempSensorID, patchObject)
+					.then(function() { callback(null, true); })
+					.catch(function(errors) { callback(errors, null); });
+				},
+				function(errors, success)
+				{
+					if(errors)
+					{
+						scope.error(errors);
+					}
+					else if(done)
+					{
+						done();
+					}
+				});
 			}
 			else
 			{

package/huemagic/hue-buttons.js

@@ -134,7 +134,7 @@ module.exports = function(RED)
 			let currentState = bridge.get("button", tempSensorID);
 			if(!currentState)
 			{
-				scope.error("The button/switch in not yet available. Please wait until HueMagic has established a connection with the bridge or check whether the resource ID in the configuration is valid..");
+				scope.error("The button/switch in not yet available. Please wait until HueMagic has established a connection with the bridge or check whether the resource ID in the configuration is valid.");
 				return false;
 			}