node-red-contrib-huemagic 4.1.0 → 4.2.0

package/huemagic/hue-light.js

@@ -8,6 +8,7 @@ module.exports = function(RED)
 
 		const scope = this;
 		const bridge = RED.nodes.getNode(config.bridge);
+		const async = require('async');
 
 		// SAVE FUTURE PATCH
 		this.futurePatchState = {};
@@ -125,7 +126,7 @@ module.exports = function(RED)
 			let currentState = bridge.get("light", tempLightID, { colornames: config.colornamer ? true : false });
 			if(!currentState)
 			{
-				scope.error("The light 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 light 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;
 			}
 
@@ -171,18 +172,43 @@ module.exports = function(RED)
 					"bri": msg.payload.brightness ? Math.round((254/100)*msg.payload.brightness) : currentState.brightnessLevel
 				};
 
-				bridge.patch("light", currentState.info.idV1 + "/state", patchObject, 1)
-				.then(function(status) {
-					// RESET COLORLOOP ANIMATION AFTER X SECONDS
-					setTimeout(function()
-					{
-						bridge.patch("light", currentState.info.idV1 + "/state", { "effect": "none" }, 1);
-						if(done) { done(); }
-					}, parseInt(msg.payload.colorloop) * 1000);
-				})
-				.catch(function(errors) {
-					scope.error(errors);
-					scope.status({fill: "red", shape: "ring", text: "hue-light.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("light", currentState.info.idV1 + "/state", patchObject, 1)
+					.then(function(status)
+					{
+						// RESET COLORLOOP ANIMATION AFTER X SECONDS
+						setTimeout(function()
+						{
+							bridge.patch("light", currentState.info.idV1 + "/state", { "effect": "none" }, 1);
+						}, 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-light.node.error-input"});
+					}
+					else if(done)
+					{
+						done();
+					}
 				});
 
 				return false;
@@ -261,48 +287,72 @@ module.exports = function(RED)
 					scope.status({fill: "grey", shape: "ring", text: "hue-light.node.command"});
 				}
 
-				// 1. TURN ON THE LIGHT BULB
-				bridge.patch("light", tempLightID, patchObject)
-				.then(function(status) {
-					// 2. APPLY ALERT EFFECT
-					const alertEffect = { alert: { action: "breathe" }};
-					return bridge.patch("light", tempLightID, alertEffect);
-				})
-				.then(function(status) {
-					// 3. RESET PREVIOUS STATE (AFTER X SECONDS)
-					setTimeout(function()
-					{
-						const tempPreviousState = scope.context().get('lightPreviousState');
-						var tempPreviousStatePatch = {};
-
-						tempPreviousStatePatch.dimming = { brightness: tempPreviousState.payload.brightness };
-						if(tempPreviousState.payload.xyColor)
-						{
-							tempPreviousStatePatch.color = { xy: tempPreviousState.payload.xyColor };
-						}
-						else if(tempPreviousState.payload.colorTemp)
-						{
-							tempPreviousStatePatch.color_temperature = { mirek: tempPreviousState.payload.colorTemp };
-						}
 
-						bridge.patch("light", tempLightID, tempPreviousStatePatch).
-						then(function(status)
+				// APPLY THE EFFECT
+				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("light", tempLightID, patchObject)
+					.then(function(status) {
+						// 2. APPLY ALERT EFFECT
+						const alertEffect = { alert: { action: "breathe" }};
+						return bridge.patch("light", tempLightID, alertEffect);
+					})
+					.then(function(status) {
+						// 3. RESET PREVIOUS STATE (AFTER X SECONDS)
+						setTimeout(function()
 						{
-							return bridge.patch("light", tempLightID, { on: { on: false } })
-							.then(function() { if(done) { done(); }});
-						})
-						.then(function(status) {
-							if(tempPreviousState.payload.on === true)
+							const tempPreviousState = scope.context().get('lightPreviousState');
+							var tempPreviousStatePatch = {};
+
+							tempPreviousStatePatch.dimming = { brightness: tempPreviousState.payload.brightness };
+							if(tempPreviousState.payload.xyColor)
 							{
-								bridge.patch("light", tempLightID, { on: { on: true } })
-								.then(function() { if(done) { done(); }});
+								tempPreviousStatePatch.color = { xy: tempPreviousState.payload.xyColor };
+							}
+							else if(tempPreviousState.payload.colorTemp)
+							{
+								tempPreviousStatePatch.color_temperature = { mirek: tempPreviousState.payload.colorTemp };
 							}
-						});
-					}, parseInt(msg.payload.alert) * 1000);
-				})
-				.catch(function(errors) {
-					scope.error(errors);
-					scope.status({fill: "red", shape: "ring", text: "hue-light.node.error-input"});
+
+							bridge.patch("light", tempLightID, tempPreviousStatePatch).
+							then(function(status)
+							{
+								return bridge.patch("light", tempLightID, { on: { on: false } })
+								.then(function() { if(done) { done(); }});
+							})
+							.then(function(status) {
+								if(tempPreviousState.payload.on === true)
+								{
+									bridge.patch("light", tempLightID, { on: { on: true } })
+									.then(function() { if(done) { done(); }});
+								}
+							});
+						}, 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-light.node.error-input"});
+					}
+					else if(done)
+					{
+						done();
+					}
 				});
 			}
 			// ANIMATION STARTED?
@@ -327,21 +377,44 @@ module.exports = function(RED)
 					tempPreviousStatePatch.color_temperature = { mirek: tempPreviousState.payload.colorTemp };
 				}
 
-				bridge.patch("light", tempLightID, 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", tempLightID, tempPreviousStatePatch)
+					.then(function(status)
 					{
-						bridge.patch("light", tempLightID, { on: { on: false } })
-						.then(function() { if(done) { done(); }});
+						if(tempPreviousState.payload.on === false)
+						{
+							bridge.patch("light", tempLightID, { on: { on: false } })
+							.then(function() { callback(null, true); });
+						}
+						else
+						{
+							bridge.patch("light", tempLightID, { on: { on: false } })
+							.then(function(status) {
+								callback(null, true);
+								return bridge.patch("light", tempLightID, { on: { on: true } });
+							});
+						}
+					})
+					.catch(function(errors) { callback(errors, null); });
+				},
+				function(errors, success)
+				{
+					if(errors)
+					{
+						scope.error(errors);
 					}
-					else
+					else if(done)
 					{
-						bridge.patch("light", tempLightID, { on: { on: false } })
-						.then(function(status) {
-							if(done) { done(); }
-							return bridge.patch("light", tempLightID, { on: { on: true } })
-						});
+						done();
 					}
 				});
 			}
@@ -613,16 +686,42 @@ module.exports = function(RED)
 				}
 
 				// SET DOMINANT COLORS FROM IMAGE
-				if(typeof msg.payload != 'undefined' && typeof msg.payload.image != 'undefined' && typeof currentState.payload.xyColor != 'undefined')
+				if(typeof msg.payload != 'undefined' && typeof msg.payload.image != 'undefined' && (typeof currentState.payload.xyColor != 'undefined' || typeof currentState.payload.gradient != 'undefined'))
 				{
-					var colors = await colorUtils.getColors(msg.payload.image);
+					let colors = await colorUtils.getColors(msg.payload.image);
 					if(colors.length > 0)
 					{
-						var colorsHEX = colors.map(color => color.hex());
-						let rgbFromHex = colorUtils.hexRgb(colorsHEX[0]);
-						patchObject["color"] = {
-							xy: colorUtils.rgbToXy(rgbFromHex[0], rgbFromHex[1], rgbFromHex[2], currentState.info.model.colorGamut)
-						};
+						let colorsHEX = colors.map(color => color.hex());
+
+						// SET MULTIPLE COLORS ON SUPPORTED LIGHTS
+						if(typeof currentState.payload.gradient != 'undefined')
+						{
+							let XYColorSet = [];
+
+							for (var i = 0; i < currentState.payload.gradient.totalColors; i++)
+							{
+								if(typeof colorsHEX[i] != 'undefined')
+								{
+									let rgbFromHex = colorUtils.hexRgb(colorsHEX[i]);
+									XYColorSet.push({
+										color: { xy: colorUtils.rgbToXy(rgbFromHex[0], rgbFromHex[1], rgbFromHex[2], currentState.info.model.colorGamut) }
+									});
+								}
+							}
+
+							if(XYColorSet.length > 0)
+							{
+								patchObject["gradient"] = { points: XYColorSet };
+							}
+						}
+						// SET SINGLE COLOR
+						else
+						{
+							let rgbFromHex = colorUtils.hexRgb(colorsHEX[0]);
+							patchObject["color"] = {
+								xy: colorUtils.rgbToXy(rgbFromHex[0], rgbFromHex[1], rgbFromHex[2], currentState.info.model.colorGamut)
+							};
+						}
 					}
 				}
 
@@ -718,9 +817,30 @@ module.exports = function(RED)
 					}
 
 					// PATCH!
-					bridge.patch("light", tempLightID, 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", tempLightID, 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-motion.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;
@@ -110,7 +111,7 @@ module.exports = function(RED)
 			let currentState = bridge.get("motion", 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;
 			}
 
@@ -151,9 +152,30 @@ module.exports = function(RED)
 				}
 
 				// PATCH!
-				bridge.patch("motion", 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("motion", tempSensorID, patchObject)
+					.then(function() { if(done) { 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-rules.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;
@@ -100,7 +101,7 @@ module.exports = function(RED)
 			let currentState = bridge.get("rule", "rule_" + tempRuleID);
 			if(!currentState)
 			{
-				scope.error("The rule 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 rule 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;
 			}
 
@@ -111,12 +112,30 @@ module.exports = function(RED)
 				patchObject["status"] = (msg.payload == true) ? 'enabled' : 'disabled';
 
 				// PATCH!
-				bridge.patch("rules", "/rules/"+tempRuleID, patchObject, 1)
-				.then(function(response) { bridge.refetchRule(tempRuleID); })
-				.catch(function(errors) { scope.error(errors);  });
-
-				// DONE?
-				if(done) { done(); }
+				async.retry({
+					times: 3,
+					errorFilter: function(err) {
+						return (err.status == 503);
+					},
+					interval: function(retryCount) { return retryCount*2000; }
+				},
+				function(callback, results)
+				{
+					bridge.patch("rules", "/rules/"+tempRuleID, patchObject, 1)
+					.then(function(response) { bridge.refetchRule(tempRuleID); 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-scene.js

@@ -8,6 +8,7 @@ module.exports = function(RED)
 
 		const scope = this;
 		const bridge = RED.nodes.getNode(config.bridge);
+		const async = require('async');
 
 		// GET TARGET WIRED GROUPS
 		this.targetGroups = {};
@@ -72,9 +73,32 @@ module.exports = function(RED)
 
 					if(targetGroup)
 					{
-						bridge.patch("group", targetGroup.info.idV1 + "/action", { "scene": targetSceneID }, 1)
-						.catch(function(errors) {
-							scope.error(errors);
+						// PATCH!
+						async.retry({
+							times: 3,
+							errorFilter: function(err) {
+								return (err.status == 503);
+							},
+							interval: function(retryCount) { return retryCount*2000; }
+						},
+						function(callback, results)
+						{
+							bridge.patch("group", targetGroup.info.idV1 + "/action", { "scene": targetSceneID }, 1)
+							.then(function() { callback(null, true); })
+							.catch(function(errors) {
+								callback(errors, null);
+							});
+						},
+						function(errors, success)
+						{
+							if(errors)
+							{
+								scope.error(errors);
+							}
+							else if(done)
+							{
+								done();
+							}
 						});
 					}
 				}
@@ -87,27 +111,49 @@ module.exports = function(RED)
 			else
 			{
 				// RECALL SCENE
-				patchObject["recall"] = { status: "active" };
+				patchObject["recall"] = { action: "active" };
 
 				// CHANGE NODE UI STATE
 				scope.status({fill: "grey", shape: "ring", text: "hue-scene.node.command"});
 
 				// PATCH!
-				bridge.patch("scene", sceneDef, patchObject)
-				.then(function()
+				async.retry({
+					times: 3,
+					errorFilter: function(err) {
+						return (err.status == 503);
+					},
+					interval: function(retryCount) { return retryCount*2000; }
+				},
+				function(callback, results)
 				{
-					scope.status({fill: "blue", shape: "dot", text: "hue-scene.node.recalled"});
-					if(done) { done(); }
-
-					// RESET STATUS AFTER 1 SECOND
-					setTimeout(function() {
-						scope.status({});
-					}, 1000);
-				})
-				.catch(function(errors) { scope.error(errors);  });
+					bridge.patch("scene", sceneDef, patchObject)
+					.then(function()
+					{
+						scope.status({fill: "blue", shape: "dot", text: "hue-scene.node.recalled"});
+
+						// RESET STATUS AFTER 1 SECOND
+						setTimeout(function() {
+							scope.status({});
+						}, 1000);
+
+						callback(null, true);
+					})
+					.catch(function(errors) { callback(errors, null); });
+				},
+				function(errors, success)
+				{
+					if(errors)
+					{
+						scope.error(errors);
+					}
+					else if(done)
+					{
+						done();
+					}
+				});
 			}
 		});
 	}
 
 	RED.nodes.registerType("hue-scene", HueScene);
-}
+}

package/huemagic/hue-temperature.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;
@@ -118,7 +119,7 @@ module.exports = function(RED)
 			let currentState = bridge.get("temperature", 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;
 			}
 
@@ -159,9 +160,30 @@ module.exports = function(RED)
 				}
 
 				// PATCH!
-				bridge.patch("temperature", 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("temperature", 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/locales/de/hue-bridge-config.html

@@ -15,7 +15,7 @@ Geben Sie den Hue Bridge API-Schlüssel manuell ein oder drücken Sie den Button
 
 ### Worker
 
-Der "Worker"-Wert bestimmt die Anzahl der parallelen Befehle, die HueMagic an die Bridge gleichzeitig schicken darf. Laut offizieller Dokumentation der Philips Hue Bridge, sollten nicht mehr als 10 Befehle pro Sekunde abgeschickt werden, da sonst die Gefahr besteht, dass die Bridge die Anfragen nicht so schnell verarbeiten kann und Fehler auswirft.
+Der „Worker“-Wert bestimmt die Anzahl der parallelen Befehle, die HueMagic an die Bridge gleichzeitig schicken darf. Laut offizieller Dokumentation der Philips Hue Bridge, sollten nicht mehr als 10 Befehle pro Sekunde abgeschickt werden, da sonst die Gefahr besteht, dass die Bridge die Anfragen nicht so schnell verarbeiten kann und Fehler auswirft.
 
 Wenn mehr Befehle gleichzeitig abgeschickt werden als der hier gesetzte Wert, wird HueMagic die Befehle nacheinander ausführen, sobald der Durchsatz wieder möglich ist.
 

package/huemagic/utils/api.js

@@ -90,14 +90,7 @@ function API()
 			{
 				if(version === 2)
 				{
-					if(response.data.errors.length > 0)
-					{
-						reject(response.data.errors);
-					}
-					else
-					{
-						resolve(response.data.data);
-					}
+					resolve(response.data.data);
 				}
 				else if(version === 1)
 				{
@@ -106,7 +99,7 @@ function API()
 			})
 			.catch(function(error)
 			{
-				reject(error);
+				reject({ status: error.response.status, errors: error.response.data.errors ? error.response.data.errors : error.response.data});
 			});
 		});
 	}
@@ -154,7 +147,7 @@ function API()
 				// ERROR? -> RETRY?
 				scope.events[config.id].onerror = function(error)
 				{
-					console.log("HueMagic:", "Connection to bridge lost. Trying to reconnect again in 30 seconds…", err);
+					console.log("HueMagic:", "Connection to bridge lost. Trying to reconnect again in 30 seconds…", error);
 					setTimeout(function(){ scope.subscribe(config, callback); }, 30000);
 					resolve(true);
 				}