node-red-contrib-huemagic 4.0.4 → 4.2.0

package/README.md

@@ -142,7 +142,7 @@ If the "fetch" command has been used on the node, the bridge outputs the corresp
 
 #### Global status messages under `msg.updated` (optional)
 
-Unless deactivated, the node outputs an updated status message for each resource on the bridge. The status message under * msg.updated * follows the pattern of the respective resource and varies depending on the type of device that was last updated.
+Unless deactivated, the node outputs an updated status message for each resource on the bridge. The status message under `msg.updated` follows the pattern of the respective resource and varies depending on the type of device that was last updated.
 
 #### Last command under `msg.command` (optional)
 
@@ -172,7 +172,7 @@ To play or stop an animation, pass an object with the following content to the n
 |--|--|
 | payload (boolean) | `true`, starts the animation, `false`, stops the animation |
 
-### Own animations
+### Custom animations
 
 If you pass your own animation to the node, the preselected, pre-defined animation (if set) will be temporarily replaced by yours. Own HueMagic animations are a sequence of commands that have been combined in an array. Each array element forms a step - whereby a step can also consist of several frames (transition effects).
 
@@ -273,7 +273,7 @@ In addition to simply switching it on and off, there are also many other options
 | gradient (object {hex […]}) | An object with a supported color object (e.g. `hex`,` rgb`, ...) and several colors to set a gradient to supported lights |
 | mixColor (object) | A color to be mixed with the current light color. Can accept `color`, `hex`, `rgb` or `xyColor` objects and optionally `amount` (int) to indicate the mixing ratio in percent |
 | image (string) | Path of an image (local or on the web) to set the current color of the light to the average color of the image |
-| saturation (int) | percentage of the saturation of the current color (beta) |
+| saturation (int) | Percentage of the saturation of the current color (beta) |
 | colorTemp (int / string) | Value between 153 and 500 to set the color temperature of the light or the values `cold`, `normal`, `warm`, `hot` and `auto` - where `auto` is the color temperature based on the current time |
 | incrementColorTemp (int / boolean) | Value by how much the color temperature should be warmer or `true` to make the color temperature warmer in steps of 50 |
 | decrementColorTemp (int / boolean) | Value by how much the color temperature should be colder or `true` to make the color temperature colder in steps of 50 |
@@ -395,6 +395,7 @@ In contrast to the "Hue Light" node, you have much less status information avail
 | id (string) | Indicates the new ID of the group |
 | idV1 (string / boolean) | Indicates the old ID of the group |
 | name (string) | The currently set name of the group |
+| resources (object) | Contains all devices/resources behind the group
 | type (string) | The type of the group (always `group`) |
 
 #### Status changes under `msg.updated`
@@ -795,7 +796,29 @@ If the status of the node has changed via a certain command, the entire command
 
 # Changelog
 
-### v4.0.4 (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 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

package/huemagic/hue-bridge-config.html

@@ -25,6 +25,10 @@
             </button>
         </div>
 	</div>
+	<div class="form-row">
+		<label for="node-config-input-worker"><i class="fa fa-cogs"></i> <span>Worker</span></label>
+		<input type="text" id="node-config-input-worker" placeholder="10" style="width: calc(100% - 105px)">
+	</div>
 	<div class="form-row" style="margin-top: 30px">
         <div style="display: inline-flex; width: calc(100% - 105px)">
             <input type="checkbox" id="node-input-autoupdates" style="flex: 15px;">
@@ -47,6 +51,9 @@
 			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);
+			}},
 			autoupdates: { value: true },
 			disableupdates: { value: false }
 		},

package/huemagic/hue-bridge-config.js

@@ -9,6 +9,7 @@ module.exports = function(RED)
 	const diff = require("deep-object-diff").diff;
 	const axios = require('axios');
 	const https = require('https');
+	const fastq = require('fastq');
 
 	// READABLE RESOURCE MESSAGES
 	const { HueBridgeMessage,
@@ -32,6 +33,8 @@ module.exports = function(RED)
 		this.resourcesInGroups = {};
 		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;
@@ -42,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) {
@@ -301,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
 					{
@@ -435,24 +497,41 @@ module.exports = function(RED)
 		{
 			return new Promise(function(resolve, reject)
 			{
-				// GET SERVICE ID
-				if(version !== 1 && scope.resources[id] && scope.resources[id]["services"] && scope.resources[id]["services"][type])
+				if(!scope.patchQueue) { return false; }
+				scope.patchQueue.push({ type: type, id: id, patch: patch, version: version }, function (error, response)
 				{
-					const targetResource = Object.values(scope.resources[id]["services"][type])[0];
-					id = targetResource.id;
-				}
-
-				// ACTION!
-				API.request({ config: config, method: "PUT", resource: (version === 2) ? (type+"/"+id) : id, data: patch, version: version })
-				.then(function(response) {
-					resolve(response);
-				})
-				.catch(function(error) {
-					reject(error);
+					if(error)
+					{
+						reject(error);
+					}
+					else
+					{
+						resolve(response);
+					}
 				});
 			});
 		}
 
+		// PATCH RESOURCE (WORKER) / 7 PROCESSES IN PARALLEL
+		this.patchQueue = fastq(function({ type, id, patch, version }, callback)
+		{
+			// GET SERVICE ID
+			if(version !== 1 && scope.resources[id] && scope.resources[id]["services"] && scope.resources[id]["services"][type])
+			{
+				const targetResource = Object.values(scope.resources[id]["services"][type])[0];
+				id = targetResource.id;
+			}
+
+			// ACTION!
+			API.request({ config: config, method: "PUT", resource: (version === 2) ? (type+"/"+id) : id, data: patch, version: version })
+			.then(function(response) {
+				callback(null, response);
+			})
+			.catch(function(error) {
+				callback(error, null);
+			});
+		}, config.worker ? parseInt(config.worker) : 10);
+
 		// RE-FETCH RULE (RECEIVES NO UPDATES VIA SSE)
 		this.refetchRule = function(id)
 		{
@@ -546,8 +625,6 @@ module.exports = function(RED)
 			if((config.autoupdates && config.autoupdates == true) || typeof config.autoupdates == 'undefined')
 			{
 				if(scope.firmwareUpdateTimeout !== null) { clearTimeout(scope.firmwareUpdateTimeout); };
-
-				scope.log("Checking for Hue Bridge firmware updates…");
 				API.request({
 					config: config,
 					method: "PUT",
@@ -564,15 +641,15 @@ module.exports = function(RED)
 				{
 					if(scope.nodeActive == true)
 					{
-						scope.firmwareUpdateTimeout = setTimeout(function(){ scope.autoUpdateFirmware(); }, 60000 * 180);
+						scope.firmwareUpdateTimeout = setTimeout(function(){ scope.autoUpdateFirmware(); }, 60000 * 720);
 					}
 				})
 				.catch(function(error)
 				{
-					// NO UPDATES AVAILABLE // TRY AGAIN IN 3H
+					// NO UPDATES AVAILABLE // TRY AGAIN IN 12H
 					if(scope.nodeActive == true)
 					{
-						scope.firmwareUpdateTimeout = setTimeout(function(){ scope.autoUpdateFirmware(); }, 60000 * 180);
+						scope.firmwareUpdateTimeout = setTimeout(function(){ scope.autoUpdateFirmware(); }, 60000 * 720);
 					}
 				});
 			}
@@ -581,7 +658,7 @@ module.exports = function(RED)
 		//
 		// START THE MAGIC
 		this.start();
-
+		
 		//
 		// CLOSE NODE / REMOVE EVENT LISTENER
 		this.on('close', function()
@@ -597,6 +674,9 @@ module.exports = function(RED)
 
 			// REMOVE FIRMWARE UPDATE TIMEOUT
 			if(scope.firmwareUpdateTimeout !== null) { clearTimeout(scope.firmwareUpdateTimeout); }
+
+			// KILL QUEUE
+			scope.patchQueue.kill();
 		});
 	}
 

package/huemagic/hue-brightness.html

@@ -81,6 +81,19 @@
                 buttonIcon.removeClass("fa-pencil");
                 buttonIcon.addClass("fa-search");
             }
+            
+            function sortResourcesBy(prop, resources)
+            {
+                return resources.sort((a, b) => {
+                    if ( a[prop] < b[prop] ){
+                        return -1;
+                    }
+                    if ( a[prop] > b[prop] ){
+                        return 1;
+                    }
+                    return 0;
+                });
+            }
 
             function searchAndSelect()
             {
@@ -98,6 +111,7 @@
                 $.get('hue/resources', { bridge: bridgeConfig.bridge, key: bridgeConfig.key, type: "motion" })
                 .done( function(data) {
                     var allResources = JSON.parse(data);
+                    allResources = sortResourcesBy('name', allResources);
                     if(allResources.length <= 0)
                     {
                         notification.close();
@@ -194,4 +208,4 @@
             }
         }
     });
-</script>
+</script>

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;
@@ -114,6 +115,11 @@ 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.");
+				return false;
+			}
 
 			// GET CURRENT STATE
 			if( (typeof msg.payload != 'undefined' && typeof msg.payload.status != 'undefined') || (typeof msg.__user_inject_props__ != 'undefined' && msg.__user_inject_props__ == "status") )
@@ -152,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.html

@@ -81,6 +81,19 @@
                 buttonIcon.removeClass("fa-pencil");
                 buttonIcon.addClass("fa-search");
             }
+            
+            function sortResourcesBy(prop, resources)
+            {
+                return resources.sort((a, b) => {
+                    if ( a[prop] < b[prop] ){
+                        return -1;
+                    }
+                    if ( a[prop] > b[prop] ){
+                        return 1;
+                    }
+                    return 0;
+                });
+            }
 
             function searchAndSelect()
             {
@@ -98,6 +111,7 @@
                 $.get('hue/resources', { bridge: bridgeConfig.bridge, key: bridgeConfig.key, type: "button" })
                 .done( function(data) {
                     var allResources = JSON.parse(data);
+                    allResources = sortResourcesBy('name', allResources);
                     if(allResources.length <= 0)
                     {
                         notification.close();

package/huemagic/hue-buttons.js

@@ -132,6 +132,11 @@ 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.");
+				return false;
+			}
 
 			// GET CURRENT STATE
 			if( (typeof msg.payload != 'undefined' && typeof msg.payload.status != 'undefined') || (typeof msg.__user_inject_props__ != 'undefined' && msg.__user_inject_props__ == "status") )

package/huemagic/hue-group.html

@@ -81,6 +81,19 @@
                 buttonIcon.removeClass("fa-pencil");
                 buttonIcon.addClass("fa-search");
             }
+            
+            function sortResourcesBy(prop, resources)
+            {
+                return resources.sort((a, b) => {
+                    if ( a[prop] < b[prop] ){
+                        return -1;
+                    }
+                    if ( a[prop] > b[prop] ){
+                        return 1;
+                    }
+                    return 0;
+                });
+            }
 
             function searchAndSelect()
             {
@@ -98,6 +111,7 @@
                 $.get('hue/resources', { bridge: bridgeConfig.bridge, key: bridgeConfig.key, type: "group" })
                 .done( function(data) {
                     var allResources = JSON.parse(data);
+                    allResources = sortResourcesBy('name', allResources);
                     if(allResources.length <= 0)
                     {
                         notification.close();
@@ -205,4 +219,4 @@
             }
         }
     });
-</script>
+</script>