node-red-contrib-huemagic 4.1.0 → 4.2.0

package/README.md

@@ -796,11 +796,21 @@ If the status of the node has changed via a certain command, the entire command
 
 # Changelog
 
-### v4.1.0 (latest)
+### v4.2.0 (latest)
+
+* 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

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,6 +34,7 @@ module.exports = function(RED)
 		this.lastStates = {};
 		this.events = new events.EventEmitter();
 		this.patchQueue = null;
+		this.timerWatchDog = null; // 31/01/2022 Supergiovane: watchdog for the connection with the bridge
 
 		// 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;
@@ -44,9 +45,35 @@ module.exports = function(RED)
 		// CREATE NODE
 		RED.nodes.createNode(scope, config);
 
+		this.startWatchdog = function() {
+				// 31/01/2022 Supergiovane: Check wether the bridge is connected.
+				if (this.timerWatchDog !== null) clearTimeout(this.timerWatchDog);
+				this.timerWatchDog = setTimeout(() => {
+				try {
+					API.request({ config: config, resource: "/config", version: 1 })
+					.then(function(bridgeInformation)
+					{
+						// The bridge is still connected
+						scope.startWatchdog();
+					})
+					.catch(function(error)
+					{
+						// Error connecting to the bridge
+						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()
 		{
+			this.startWatchdog(); // 31/01/2022 Supergiovane: starts the watchdog.
+
 			scope.log("Initializing the bridge ("+config.bridge+")…");
 			API.init({ config: config })
 			.then(function(bridge) {
@@ -303,96 +330,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 +658,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;
 			}
 

package/huemagic/hue-group.js

@@ -8,6 +8,7 @@ module.exports = function(RED)
 
 		const scope = this;
 		const bridge = RED.nodes.getNode(config.bridge);
+		const async = require('async');
 
 		// EXPORT CONFIG
 		this.exportedConfig = config;
@@ -112,7 +113,7 @@ module.exports = function(RED)
 			let currentState = bridge.get("group", tempGroupID, { colornames: config.colornamer ? true : false });
 			if(!currentState)
 			{
-				scope.error("The group 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 group 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;
 			}
 
@@ -158,18 +159,41 @@ module.exports = function(RED)
 					"bri": msg.payload.brightness ? Math.round((254/100)*msg.payload.brightness) : 254
 				};
 
-				bridge.patch("group", currentState.info.idV1 + "/action", patchObject, 1)
-				.then(function(status) {
-					// RESET COLORLOOP ANIMATION AFTER X SECONDS
-					setTimeout(function()
-					{
-						bridge.patch("group", currentState.info.idV1 + "/action", { "effect": "none" }, 1)
-						.then(function() { if(done) { done(); }});
-					}, parseInt(msg.payload.colorloop) * 1000);
-				})
-				.catch(function(errors) {
-					scope.error(errors);
-					scope.status({fill: "red", shape: "ring", text: "hue-group.node.error-input"});
+				// PATCH!
+				async.retry({
+					times: 3,
+					errorFilter: function(err) {
+						return (err.status == 503);
+					},
+					interval: function(retryCount) { return retryCount*2000; }
+				},
+				function(callback, results)
+				{
+					bridge.patch("group", currentState.info.idV1 + "/action", patchObject, 1)
+					.then(function(status) {
+						// RESET COLORLOOP ANIMATION AFTER X SECONDS
+						setTimeout(function()
+						{
+							bridge.patch("group", currentState.info.idV1 + "/action", { "effect": "none" }, 1)
+							.then(function() { if(done) { done(); }});
+						}, parseInt(msg.payload.colorloop) * 1000);
+						callback(null, true);
+					})
+					.catch(function(errors) {
+						callback(errors, null);
+					});
+				},
+				function(errors, success)
+				{
+					if(errors)
+					{
+						scope.error(errors);
+						scope.status({fill: "red", shape: "ring", text: "hue-group.node.error-input"});
+					}
+					else if(done)
+					{
+						done();
+					}
 				});
 
 				return false;
@@ -240,42 +264,65 @@ module.exports = function(RED)
 				// SET ALERT EFFECT
 				patchObject["alert"] = "lselect";
 
-				// 1. TURN ON THE LIGHT BULB
-				bridge.patch("group", currentState.info.idV1 + "/action", patchObject, 1)
-				.then(function(status) {
-					setTimeout(function()
+				// PATCH!
+				async.retry({
+					times: 3,
+					errorFilter: function(err) {
+						return (err.status == 503);
+					},
+					interval: function(retryCount) { return retryCount*2000; }
+				},
+				function(callback, results)
+				{
+					// 1. TURN ON THE LIGHT BULB
+					bridge.patch("group", currentState.info.idV1 + "/action", patchObject, 1)
+					.then(function(status)
 					{
-						const tempPreviousState = scope.context().get('groupPreviousState');
-						var tempPreviousStatePatch = {};
-
-						tempPreviousStatePatch.dimming = { brightness: tempPreviousState.payload.brightness };
-						if(tempPreviousState.payload.xyColor)
-						{
-							tempPreviousStatePatch.xy = [tempPreviousState.payload.xyColor.x, tempPreviousState.payload.xyColor.y];
-						}
-						else if(tempPreviousState.payload.colorTemp)
+						setTimeout(function()
 						{
-							tempPreviousStatePatch.ct = tempPreviousState.payload.colorTemp;
-						}
+							const tempPreviousState = scope.context().get('groupPreviousState');
+							var tempPreviousStatePatch = {};
 
-						bridge.patch("group", currentState.info.idV1 + "/action", tempPreviousStatePatch, 1)
-						.then(function(status)
-						{
-							return bridge.patch("group", currentState.info.idV1 + "/action", { on: false }, 1);
-						})
-						.then(function(status) {
-							if(done) { done(); }
-							if(tempPreviousState.payload.on === true)
+							tempPreviousStatePatch.dimming = { brightness: tempPreviousState.payload.brightness };
+							if(tempPreviousState.payload.xyColor)
 							{
-								bridge.patch("group", currentState.info.idV1, { on: true }, 1);
+								tempPreviousStatePatch.xy = [tempPreviousState.payload.xyColor.x, tempPreviousState.payload.xyColor.y];
 							}
-						});
-					}, parseInt(msg.payload.alert) * 1000);
-				})
-				.catch(function(errors) {
-					scope.error(errors);
-					scope.status({fill: "red", shape: "ring", text: "hue-group.node.error-input"});
-					if(done) { done(error); }
+							else if(tempPreviousState.payload.colorTemp)
+							{
+								tempPreviousStatePatch.ct = tempPreviousState.payload.colorTemp;
+							}
+
+							bridge.patch("group", currentState.info.idV1 + "/action", tempPreviousStatePatch, 1)
+							.then(function(status)
+							{
+								return bridge.patch("group", currentState.info.idV1 + "/action", { on: false }, 1);
+							})
+							.then(function(status) {
+								if(tempPreviousState.payload.on === true)
+								{
+									bridge.patch("group", currentState.info.idV1, { on: true }, 1);
+								}
+							});
+						}, parseInt(msg.payload.alert) * 1000);
+
+						callback(null, true);
+					})
+					.catch(function(errors) {
+						callback(errors, null);
+					});
+				},
+				function(errors, success)
+				{
+					if(errors)
+					{
+						scope.error(errors);
+						scope.status({fill: "red", shape: "ring", text: "hue-group.node.error-input"});
+					}
+					else if(done)
+					{
+						done();
+					}
 				});
 			}
 			// ANIMATION STARTED?
@@ -300,19 +347,44 @@ module.exports = function(RED)
 					tempPreviousStatePatch.ct = tempPreviousState.payload.colorTemp;
 				}
 
-				bridge.patch("light", currentState.info.lightIds[l], tempPreviousStatePatch).
-				then(function(status)
+				// PATCH!
+				async.retry({
+					times: 3,
+					errorFilter: function(err) {
+						return (err.status == 503);
+					},
+					interval: function(retryCount) { return retryCount*2000; }
+				},
+				function(callback, results)
 				{
-					if(tempPreviousState.payload.on === false)
+					bridge.patch("light", currentState.info.lightIds[l], tempPreviousStatePatch).
+					then(function(status)
 					{
-						bridge.patch("light", currentState.info.lightIds[l], { on: { on: false } })
+						if(tempPreviousState.payload.on === false)
+						{
+							bridge.patch("light", currentState.info.lightIds[l], { on: { on: false } })
+							.then(function() { callback(null, true); });
+						}
+						else
+						{
+							bridge.patch("light", currentState.info.lightIds[l], { on: { on: false } })
+							.then(function(status) {
+								callback(null, true);
+								return bridge.patch("light", currentState.info.lightIds[l], { on: { on: true } });
+							});
+						}
+					})
+					.catch(function(errors) { callback(errors, null); });
+				},
+				function(errors, success)
+				{
+					if(errors)
+					{
+						scope.error(errors);
 					}
-					else
+					else if(done)
 					{
-						bridge.patch("light", currentState.info.lightIds[l], { on: { on: false } })
-						.then(function(status) {
-							return bridge.patch("light", currentState.info.lightIds[l], { on: { on: true } })
-						});
+						done();
 					}
 				});
 			}
@@ -516,9 +588,30 @@ module.exports = function(RED)
 					}
 
 					// PATCH!
-					bridge.patch("group", currentState.info.idV1 + "/action", patchObject, 1)
-					.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("group", currentState.info.idV1 + "/action", patchObject, 1)
+						.then(function() { callback(null, true); })
+						.catch(function(errors) { callback(errors, null); });
+					},
+					function(errors, success)
+					{
+						if(errors)
+						{
+							scope.error(errors);
+						}
+						else if(done)
+						{
+							done();
+						}
+					});
 				}
 				else
 				{