node-red-contrib-huemagic 4.0.3 → 4.0.4

package/README.md

@@ -12,7 +12,6 @@ HueMagic provides several input and output nodes for Node-RED and is the most in
 * Output and input of multiple color code definitions *(HEX, RGB & human readable color names)*
 * Automatic color temperature & brightness setting based on the current time
 * Event-based status messages for all devices connected to the Hue Bridge
-* Virtual pressing of the Hue Bridge button (Link Button)
 * Pairing of new devices without app enforcement (TouchLink)
 * Automatic firmware updates to the Hue Bridge and connected devices
 * Activating / deactivating of sensors & rules on the Hue Bridge
@@ -796,7 +795,12 @@ If the status of the node has changed via a certain command, the entire command
 
 # Changelog
 
-### v4.0.3 (latest)
+### v4.0.4 (latest)
+
+* 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.
 

package/huemagic/hue-bridge-config.js

@@ -36,21 +36,24 @@ module.exports = function(RED)
 		// 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;
 
+		// FIRMWARE UPDATE TIMEOUT
+		this.firmwareUpdateTimeout = null;
+
 		// CREATE NODE
 		RED.nodes.createNode(scope, config);
 
 		// INITIALIZE
 		this.start = function()
 		{
-			scope.log("Initializing the bridge…");
-			API.init({ ip: config.bridge, key: config.key })
+			scope.log("Initializing the bridge ("+config.bridge+")…");
+			API.init({ config: config })
 			.then(function(bridge) {
 				scope.log("Connected to bridge");
 				return scope.getAllResources();
 			})
 			.then(function(allResources)
 			{
-				scope.log("Process resources…");
+				scope.log("Processing bridge resources…");
 				return API.processResources(allResources);
 			})
 			.then(function(allResources)
@@ -84,7 +87,7 @@ module.exports = function(RED)
 		{
 			return new Promise(function(resolve, reject)
 			{
-				API.request({ resource: "/config", version: 1 })
+				API.request({ config: config, resource: "/config", version: 1 })
 				.then(function(bridgeInformation)
 				{
 					// PREPARE TO MATCH V2 RESOURCES
@@ -123,7 +126,7 @@ module.exports = function(RED)
 					allResources.push(bridgeInformation);
 
 					// CONTINUE WITH ALL RESOURCES
-					return API.request({ resource: "all" });
+					return API.request({ config: config, resource: "all" });
 				})
 				.then(function(v2Resources)
 				{
@@ -131,7 +134,7 @@ module.exports = function(RED)
 					allResources = allResources.concat(v2Resources);
 
 					// GET RULES (LEGACY API)
-					return API.request({ resource: "/rules", version: 1 });
+					return API.request({ config: config, resource: "/rules", version: 1 });
 				})
 				.then(function(rules)
 				{
@@ -193,7 +196,7 @@ module.exports = function(RED)
 		this.refreshStatesSSE = function()
 		{
 			scope.log("Subscribing to bridge events…");
-			API.subscribe(function(updates)
+			API.subscribe(config, function(updates)
 			{
 				const currentDateTime = dayjs().format();
 
@@ -266,8 +269,8 @@ module.exports = function(RED)
 		this.pushUpdatedState = function(resource, updatedType, suppressMessage = false)
 		{
 			const msg = { id: resource.id, type: resource.type, updatedType: updatedType, services: resource["services"] ? Object.keys(resource["services"]) : [], suppressMessage: suppressMessage };
-			this.events.emit(resource.id, msg);
-			this.events.emit("globalResourceUpdates", msg);
+			this.events.emit(config.id + "_" + resource.id, msg);
+			this.events.emit(config.id + "_" + "globalResourceUpdates", msg);
 
 			// RESOURCE CONTAINS SERVICES? -> SERVICE IN GROUP? -> EMIT CHANGES TO GROUPS ALSO
 			if(this.resources["_groupsOf"][resource.id])
@@ -277,8 +280,8 @@ module.exports = function(RED)
 					const groupID = this.resources["_groupsOf"][resource.id][g];
 					const groupMessage = { id: groupID, type: "group", updatedType: updatedType, services: [], suppressMessage: suppressMessage };
 
-					this.events.emit(groupID, groupMessage);
-					this.events.emit("globalResourceUpdates", groupMessage);
+					this.events.emit(config.id + "_" + groupID, groupMessage);
+					this.events.emit(config.id + "_" + "globalResourceUpdates", groupMessage);
 				}
 			}
 		}
@@ -440,7 +443,7 @@ module.exports = function(RED)
 				}
 
 				// ACTION!
-				API.request({ method: "PUT", resource: (version === 2) ? (type+"/"+id) : id, data: patch, version: version })
+				API.request({ config: config, method: "PUT", resource: (version === 2) ? (type+"/"+id) : id, data: patch, version: version })
 				.then(function(response) {
 					resolve(response);
 				})
@@ -455,7 +458,7 @@ module.exports = function(RED)
 		{
 			return new Promise(function(resolve, reject)
 			{
-				API.request({ resource: "/rules/" + id, version: 1 })
+				API.request({ config: config, resource: "/rules/" + id, version: 1 })
 				.then(function(rule)
 				{
 					// "RENAME" OWNER
@@ -508,7 +511,7 @@ module.exports = function(RED)
 			if(!id)
 			{
 				// UNIVERSAL MODE
-				this.events.on("globalResourceUpdates", function(info)
+				this.events.on(config.id + "_" + "globalResourceUpdates", function(info)
 				{
 					if(type === "bridge")
 					{
@@ -527,7 +530,7 @@ module.exports = function(RED)
 			else
 			{
 				// SPECIFIC RESOURCE MODE
-				this.events.on(id, function(info)
+				this.events.on(config.id + "_" + id, function(info)
 				{
 					if(type === "bridge" || messageWhitelist[type].includes(info.updatedType))
 					{
@@ -542,8 +545,11 @@ 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",
 					resource: "/config",
 					version: 1,
@@ -558,7 +564,7 @@ module.exports = function(RED)
 				{
 					if(scope.nodeActive == true)
 					{
-						setTimeout(function(){ scope.autoUpdateFirmware(); }, 60000 * 5);
+						scope.firmwareUpdateTimeout = setTimeout(function(){ scope.autoUpdateFirmware(); }, 60000 * 180);
 					}
 				})
 				.catch(function(error)
@@ -566,7 +572,7 @@ module.exports = function(RED)
 					// NO UPDATES AVAILABLE // TRY AGAIN IN 3H
 					if(scope.nodeActive == true)
 					{
-						setTimeout(function(){ scope.autoUpdateFirmware(); }, 60000 * 180);
+						scope.firmwareUpdateTimeout = setTimeout(function(){ scope.autoUpdateFirmware(); }, 60000 * 180);
 					}
 				});
 			}
@@ -584,10 +590,13 @@ module.exports = function(RED)
 
 			// UNSUBSCRIBE FROM BRIDGE EVENTS
 			scope.log("Unsubscribing from bridge events…");
-			API.unsubscribe();
+			API.unsubscribe(config);
 
 			// UNSUBSCRIBE FROM "READY" EVENTS
 			scope.events.removeAllListeners();
+
+			// REMOVE FIRMWARE UPDATE TIMEOUT
+			if(scope.firmwareUpdateTimeout !== null) { clearTimeout(scope.firmwareUpdateTimeout); }
 		});
 	}
 
@@ -631,7 +640,7 @@ module.exports = function(RED)
 	    }
 	    else
 	    {
-			API.init({ ip: req.query.ip })
+			API.init({ config: { bridge: req.query.ip, key: "huemagic" } })
 			.then(function(bridge) {
 				res.end(bridge.name);
 			})
@@ -659,7 +668,7 @@ module.exports = function(RED)
 					"Content-Type": "application/json; charset=utf-8"
 				},
 				"data": {
-					"devicetype": "huemagic_" + Math.floor((Math.random() * 100) + 1)
+					"devicetype": "HueMagic for Node-RED (" + Math.floor((Math.random() * 100) + 1) + ")"
 				}
 			})
 			.then(function(response)
@@ -689,10 +698,7 @@ module.exports = function(RED)
 		// GET ALL RULES
 		if(targetType == "rule")
 		{
-			API.init({ ip: req.query.bridge, key: req.query.key })
-			.then(function(bridge) {
-				return API.request({ resource: "/rules", version: 1 });
-			})
+			API.request({ config: { bridge: req.query.bridge, key: req.query.key }, resource: "/rules", version: 1 })
 			.then(function(rules)
 			{
 				let targetRules = {};
@@ -720,10 +726,7 @@ module.exports = function(RED)
 		// GET ALL OTHER RESOURCES
 		else
 		{
-			API.init({ ip: req.query.bridge, key: req.query.key })
-			.then(function(bridge) {
-				return API.request({ resource: "all" });
-			})
+			API.request({ config: { bridge: req.query.bridge, key: req.query.key }, resource: "all" })
 			.then(function(allResources)
 			{
 				return API.processResources(allResources);

package/huemagic/utils/api.js

@@ -5,68 +5,62 @@ const EventSource = require('eventsource');
 
 function API()
 {
-	// STORAGE
-	this.bridge = null;
-	this.ipAddress = null;
-	this.accessKey = null;
-	this.events = null;
+	// EVENTS
+	this.events = {};
 
 	//
 	// INITIALIZE
-	this.init = function({ ip, key = 'default' })
+	this.init = function({ config = null })
 	{
 		const scope = this;
 
-		// FORCE RELOAD?
-		const forceReload = (this.ipAddress != ip.toString().trim());
-
-		// STORE ACCESS INFORMATION
-		this.ipAddress = ip.toString().trim();
-		this.accessKey = key.toString().trim();
-
 		// GET BRIDGE
 		return new Promise(function(resolve, reject)
 		{
-			if(scope.bridge !== null && forceReload === false)
+			if(!config)
 			{
-				resolve(scope.bridge);
+				reject("Bridge is not configured!");
+				return false;
 			}
-			else
+
+			// GET BRIDGE INFORMATION
+			axios({
+				"method": "GET",
+				"url": "https://" + config.bridge + "/api/config",
+				"headers": { "Content-Type": "application/json; charset=utf-8" },
+				"httpsAgent": new https.Agent({ rejectUnauthorized: false }),
+			})
+			.then(function(response)
 			{
-				// GET BRIDGE INFORMATION
-				axios({
-					"method": "GET",
-					"url": "https://" + ip + "/api/config",
-					"headers": { "Content-Type": "application/json; charset=utf-8" },
-					"httpsAgent": new https.Agent({ rejectUnauthorized: false }),
-				})
-				.then(function(response)
-				{
-					scope.bridge = response.data;
-					resolve(scope.bridge);
-				})
-				.catch(function(error)
-				{
-					reject(error);
-				});
-			}
+				resolve(response.data);
+			})
+			.catch(function(error)
+			{
+				reject(error);
+			});
 		});
 	}
 
 	//
 	// MAKE A REQUEST
-	this.request = function({ method = 'GET', resource = null, data = null, version = 2 })
+	this.request = function({ config = null, method = 'GET', resource = null, data = null, version = 2 })
 	{
 		const scope = this;
 		return new Promise(function(resolve, reject)
 		{
+			if(!config)
+			{
+				reject("Bridge is not configured!");
+				return false;
+			}
+
 			// BUILD REQUEST OBJECT
 			var request = {
 				"method": method,
-				"url": "https://" + scope.ipAddress,
+				"url": "https://" + config.bridge,
 				"headers": {
 					"Content-Type": "application/json; charset=utf-8",
-					"hue-application-key": scope.accessKey
+					"hue-application-key": config.key
 				},
 				"httpsAgent": new https.Agent({ rejectUnauthorized: false }), // Node is somehow not able to parse the official Philips Hue PEM
 			};
@@ -81,7 +75,7 @@ function API()
 				}
 				else if(version === 1)
 				{
-					request['url'] += "/api/" + scope.accessKey + resource;
+					request['url'] += "/api/" + config.key + resource;
 				}
 			}
 
@@ -119,23 +113,23 @@ function API()
 
 	//
 	// SUBSCRIBE TO BRIDGE EVENTS
-	this.subscribe = function(callback)
+	this.subscribe = function(config, callback)
 	{
 		const scope = this;
 		return new Promise(function(resolve, reject)
 		{
-			if(scope.events === null)
+			if(!scope.events[config.id])
 			{
-				var sseURL = "https://" + scope.ipAddress + "/eventstream/clip/v2";
+				var sseURL = "https://" + config.bridge + "/eventstream/clip/v2";
 
 				// INITIALIZE EVENT SOURCE
-				scope.events = new EventSource(sseURL, {
-					headers: { 'hue-application-key': scope.accessKey },
+				scope.events[config.id] = new EventSource(sseURL, {
+					headers: { 'hue-application-key': config.key },
 					https: { rejectUnauthorized: false },
 				});
 
 				// PIPE MESSAGE TO TARGET FUNCTION
-				scope.events.onmessage = function(event)
+				scope.events[config.id].onmessage = function(event)
 				{
 					if(event && event.type === 'message' && event.data)
 					{
@@ -152,33 +146,33 @@ function API()
 				};
 
 				// CONNECTED?
-				scope.events.onopen = function()
+				scope.events[config.id].onopen = function()
 				{
 					resolve(true);
 				}
 
 				// ERROR? -> RETRY?
-				scope.events.onerror = function(error)
+				scope.events[config.id].onerror = function(error)
 				{
 					console.log("HueMagic:", "Connection to bridge lost. Trying to reconnect again in 30 seconds…", err);
-					setTimeout(function(){ scope.subscribe(callback); }, 30000);
+					setTimeout(function(){ scope.subscribe(config, callback); }, 30000);
 					resolve(true);
 				}
 			}
 			else
 			{
-				scope.unsubscribe();
-				scope.subscribe(callback);
+				scope.unsubscribe(config);
+				scope.subscribe(config, callback);
 			}
 		});
 	}
 
 	//
 	// UNSUBSCRIBE
-	this.unsubscribe = function()
+	this.unsubscribe = function(config)
 	{
-		if(this.events !== null) { this.events.close(); }
-		this.events = null;
+		if(this.events[config.id] !== null) { this.events[config.id].close(); }
+		this.events[config.id] = null;
 	}
 
 	//

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-huemagic",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "Philips Hue node to control bridges, lights, groups, scenes, rules, taps, switches, buttons, motion sensors, temperature sensors and Lux sensors using Node-RED.",
   "author": "foddy",
   "homepage": "https://github.com/Foddy/node-red-contrib-huemagic",