node-red-contrib-huemagic 2.8.2 → 4.0.0

package/huemagic/hue-bridge.js

@@ -6,23 +6,25 @@ module.exports = function(RED)
 	{
 		RED.nodes.createNode(this, config);
 
-		var scope = this;
-		let bridge = RED.nodes.getNode(config.bridge);
-		let { HueBridgeMessage, HueBrightnessMessage, HueGroupMessage, HueLightMessage, HueMotionMessage, HueRulesMessage, HueSwitchMessage, HueTapMessage, HueTemperatureMessage } = require('../utils/messages');
+		const scope = this;
+		const bridge = RED.nodes.getNode(config.bridge);
 
-		// PREVENT DEVICE MESSAGES IN FIRST 5 SECONDS
-		this.deviceUpdates = false;
-		setTimeout(function(){ scope.deviceUpdates = true; }, 5000);
+		// IS CONNECTED?
+		this.connected = false;
+
+		// GET BRIDGE INFORMATION INITIALLY
+		this.lastBridgeInformation = null;
+
+		// SAVE LAST COMMAND
+		this.lastCommand = null;
+
+		// NODE UI STATUS TIMEOUT
+		this.timeout = null;
 
 		//
 		// ACTIVE STATE
 		this.nodeActive = true;
 
-		//
-		// BRIDGE INFORMATION
-		this.bridgeInformation = {};
-
-
 		//
 		// CHECK CONFIG
 		if(bridge == null)
@@ -33,479 +35,270 @@ module.exports = function(RED)
 
 		//
 		// UPDATE STATE
-		this.status({fill: "grey", shape: "dot", text: "hue-bridge.node.connecting"});
+		scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.connecting"});
 
-		//
-		// GET INFORMATION
-		this.getBridgeInformation = function()
+		this.setInitialState = function()
 		{
-			bridge.client.bridge.get()
-			.then(bridgeInformation => {
-				var hueBridge = new HueBridgeMessage(bridgeInformation, config);
-				scope.send(hueBridge.msg);
-				scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.connected" });
-
-				// SAVE BRIDGE INFORMATION
-				scope.bridgeInformation = hueBridge.msg.payload;
-			})
-			.catch(error => {
-				scope.error(error);
-				if(scope.nodeActive == true)
-				{
-					setTimeout(function(){ scope.getBridgeInformation(); }, 3000);
-				}
-			});
+			scope.status({fill: "green", shape: "dot", text: "hue-bridge.node.connected"});
 		}
 
-		//
-		// INITIAL START
-		this.getBridgeInformation();
 
 		//
-		// AUTO UPDATES?
-		this.autoUpdateHueBridge = function()
+		// GET BRIDGE INFORMATION
+		this.getBridgeInformation = async function(forceReload = false)
 		{
-			if(config.autoupdates == true)
+			return new Promise(function(resolve, reject)
 			{
-				bridge.client.softwareUpdate.check()
-				.then(() => {
-					return bridge.client.softwareUpdate.get();
-				})
-				.then(softwareUpdate => {
-					return bridge.client.softwareUpdate.install();
-				})
-				.then(() => {
-					// UPDATING // CHECK STATUS IN 5 MINUTES
-					if(scope.nodeActive == true)
+				if(forceReload === true)
+				{
+					// REFRESH INFORMATION
+					bridge.getBridgeInformation(true)
+					.then(function(updated)
 					{
-						setTimeout(function(){ scope.getBridgeInformation(); }, 60000 * 5);
-					}
-				})
-				.catch(error => {
-					// NO UPDATES AVAILABLE // TRY AGAIN IN 3H
-					if(scope.nodeActive == true)
+						return scope.getBridgeInformation();
+					})
+					.then(function(bridgeInformation)
 					{
-						setTimeout(function(){ scope.autoUpdateHueBridge(); }, 60000 * 180);
-					}
-				});
-			}
-		}
-
-		this.autoUpdateHueBridge();
-
-		//
-		// DEVICE UPDATES
-		if(!config.skipglobalevents)
-		{
-			bridge.events.on('globalDeviceUpdates', function(message)
-			{
-				if(scope.deviceUpdates == false) { return; }
-
-				let type = message.type;
-				let payload = message.payload;
-				var detType = type;
-
-				// CONSTRUCT MESSAGE
-				var message = {};
-				message.updated = {};
-
-				// ADD PAYLOAD
-				if(type == "light")
-				{
-					let hueLight = new HueLightMessage(payload, {colornamer: true});
-					message.updated = hueLight.msg;
-				}
-				else if(type == "group")
-				{
-					let hueGroup = new HueGroupMessage(payload, {colornamer: true});
-					message.updated = hueGroup.msg;
+						resolve(bridgeInformation);
+					});
 				}
-				else if(type == "rule")
+				else if(scope.lastBridgeInformation !== null)
 				{
-					let hueRules = new HueRulesMessage(payload);
-					message.updated = hueRules.msg;
+					let bridgeInformationCopy = Object.assign({}, scope.lastBridgeInformation);
+					resolve(bridgeInformationCopy);
 				}
-				else if(type == "sensor")
+				else
 				{
-					// DETERMINE TYPE
-					if(payload.type == "ZLLPresence")
-					{
-						let hueMotion = new HueMotionMessage(payload);
-						message.updated = hueMotion.msg;
-
-						detType = "motion";
-					}
-					else if(payload.type == "ZLLLightLevel")
-					{
-						let hueBrightness = new HueBrightnessMessage(payload);
-						message.updated = hueBrightness.msg;
-
-						detType = "brightness";
-					}
-					else if(payload.type == "ZLLTemperature")
-					{
-						let hueTemperature = new HueTemperatureMessage(payload);
-						message.updated = hueTemperature.msg;
-
-						detType = "temperature";
-					}
-					else if(payload.type == "ZLLSwitch")
-					{
-						let hueSwitch = new HueSwitchMessage(payload);
-						message.updated = hueSwitch.msg;
-
-						detType = "switch";
-					}
-					else if(payload.type == "ZGPSwitch")
-					{
-						let hueTap = new HueTapMessage(sensor);
-						message.updated = hueTap.msg;
+					let bridgeInformation = bridge.get("bridge", "bridge", { autoupdate: ((bridge.config.autoupdates && bridge.config.autoupdates == true) || typeof bridge.config.autoupdates == 'undefined') });
+					scope.lastBridgeInformation = Object.assign({}, bridgeInformation);
 
-						detType = "tap";
-					}
+					resolve(bridgeInformation);
 				}
-
-				// ADD TYPE
-				message.updated.type = detType;
-
-				// ADD BRIDGE INFORMATION
-				message.info = scope.bridgeInformation;
-
-				// SEND MESSAGE
-				scope.send(message);
 			});
 		}
 
-
 		//
-		// COMMANDS
-		this.on('input', function(msg, send, done)
+		// SUBSCRIBE TO UPDATES FROM THE BRIDGE
+		bridge.subscribe("bridge", "globalRessourceUpdates", async function(info)
 		{
-			// Node-RED < 1.0
-			send = send || function() { scope.send.apply(scope,arguments); }
+			let currentState = bridge.get(info.updatedType, info.id);
 
-			var commandSent = false;
-
-			// STARTING TOUCHLINK
-			if(typeof msg.payload.touchLink != 'undefined')
-			{
-				scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.starting-tl" });
-				bridge.client.bridge.touchlink()
-				.then(() => {
-					scope.status({fill: "blue", shape: "ring", text: "hue-bridge.node.started-tl" });
-					if(done) { done(); }
-					setTimeout(function(){ scope.getBridgeInformation(); }, 30000);
-				})
-				.catch(error => {
-					scope.error(error);
-					if(done) { done(error); }
-					setTimeout(function(){ scope.getBridgeInformation(); }, 2000);
-				});
-
-				// COMMAND SENT
-				commandSent = true;
-			}
-
-			// GET DEVICES
-			if(typeof msg.payload.fetch != 'undefined')
+			// RESSOURCE FOUND?
+			if(currentState !== false)
 			{
-				if(msg.payload.fetch == "users")
+				// UPDATE COUNTER
+				if(info.suppressMessage === false)
 				{
-					scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.f-users" });
-					bridge.client.users.getAll()
-					.then(users => {
-						setTimeout(function(){ scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.connected" }); }, 2000);
+					scope.status({fill: "blue", shape: "dot", text: "hue-bridge.node.connected"});
 
-						var message = {};
-						message.users = users;
-						message.info = scope.bridgeInformation;
-
-						send(message);
-						if(done) { done(); }
-					})
-					.catch(error => {
-						scope.error(error);
-						if(done) { done(error); }
-						setTimeout(function(){ scope.getBridgeInformation(); }, 2000);
-					});
+					if(scope.timeout !== null) { clearTimeout(scope.timeout); }
+					scope.timeout = setTimeout(function() {
+						scope.setInitialState();
+					}, 1000);
 				}
-				else if(msg.payload.fetch == "lights")
-				{
-					scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.f-lights" });
-					bridge.client.lights.getAll()
-					.then(lights => {
-						setTimeout(function(){ scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.connected" }); }, 2000);
-
-						var message = {};
-						message.lights = lights;
-						message.info = scope.bridgeInformation;
 
-						send(message);
-						if(done) { done(); }
-					})
-					.catch(error => {
-						scope.error(error);
-						if(done) { done(error); }
-						setTimeout(function(){ scope.getBridgeInformation(); }, 2000);
-					});
-				}
-				else if(msg.payload.fetch == "groups")
+				// SEND MESSAGE
+				if(!config.skipglobalevents && (config.initevents || info.suppressMessage == false))
 				{
-					scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.f-groups" });
-					bridge.client.groups.getAll()
-					.then(groups => {
-						setTimeout(function(){ scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.connected" }); }, 2000);
-
-						var message = {};
-						message.groups = groups;
-						message.info = scope.bridgeInformation;
+					scope.getBridgeInformation()
+					.then(function(info)
+					{
+						// ADD DEVICE UPDATE TO RESPONSE
+						info.updated = currentState;
 
-						send(message);
-						if(done) { done(); }
-					})
-					.catch(error => {
-						scope.error(error);
-						if(done) { done(error); }
-						setTimeout(function(){ scope.getBridgeInformation(); }, 2000);
-					});
-				}
-				else if(msg.payload.fetch == "sensors")
-				{
-					scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.f-sensors" });
-					bridge.client.sensors.getAll()
-					.then(sensors => {
-						setTimeout(function(){ scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.connected" }); }, 2000);
+						// SET LAST COMMAND
+						if(scope.lastCommand !== null)
+						{
+							info.command = scope.lastCommand;
+						}
 
-						var message = {};
-						message.sensors = sensors;
-						message.info = scope.bridgeInformation;
+						// SEND MESSAGE
+						scope.send(info);
 
-						send(message);
-						if(done) { done(); }
-					})
-					.catch(error => {
-						scope.error(error);
-						if(done) { done(error); }
-						setTimeout(function(){ scope.getBridgeInformation(); }, 2000);
+						// RESET LAST COMMAND
+						scope.lastCommand = null;
 					});
 				}
-				else if(msg.payload.fetch == "scenes")
-				{
-					scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.f-scenes" });
-					bridge.client.scenes.getAll()
-					.then(scenes => {
-						setTimeout(function(){ scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.connected" }); }, 2000);
+			}
 
-						var message = {};
-						message.scenes = scenes;
-						message.info = scope.bridgeInformation;
+			// CONNECTED?
+			if(scope.connected == false)
+			{
+				scope.connected = true;
+				scope.setInitialState();
+			}
+		});
 
-						send(message);
-						if(done) { done(); }
-					})
-					.catch(error => {
-						scope.error(error);
-						if(done) { done(error); }
-						setTimeout(function(){ scope.getBridgeInformation(); }, 2000);
-					});
-				}
-				else if(msg.payload.fetch == "rules")
-				{
-					scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.f-rules" });
-					bridge.client.rules.getAll()
-					.then(rules => {
-						setTimeout(function(){ scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.connected" }); }, 2000);
+		//
+		// ON COMMAND
+		this.on('input', function(msg, send, done)
+		{
+			// REDEFINE SEND AND DONE IF NOT AVAILABLE
+			send = send || function() { scope.send.apply(scope,arguments); }
+			done = done || function() { scope.done.apply(scope,arguments); }
 
-						var message = {};
-						message.rules = rules;
-						message.info = scope.bridgeInformation;
+			// SET LAST COMMAND
+			scope.lastCommand = msg;
 
-						send(message);
-						if(done) { done(); }
-					})
-					.catch(error => {
-						scope.error(error);
-						if(done) { done(error); }
-						setTimeout(function(){ scope.getBridgeInformation(); }, 2000);
-					});
-				}
-				else if(msg.payload.fetch == "schedules")
+			// GET BRIDGE INFORMATION
+			scope.getBridgeInformation()
+			.then(function(bridgeInformation)
+			{
+				// START TOUCHLINK
+				if(typeof msg.payload != 'undefined' && typeof msg.payload.touchLink != 'undefined')
 				{
-					scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.f-schedules" });
-					bridge.client.schedules.getAll()
-					.then(schedules => {
-						setTimeout(function(){ scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.connected" }); }, 2000);
-
-						var message = {};
-						message.schedules = schedules;
-						message.info = scope.bridgeInformation;
+					// SET STATUS
+					scope.status({fill: "yellow", shape: "dot", text: "hue-bridge.node.starting-tl" });
 
-						send(message);
+					// ENABLE TOUCHLINK
+					bridge.patch("bridge", "/config", { touchlink: true }, 1)
+					.then(function(status)
+					{
+						// SET STATUS
+						scope.status({fill: "blue", shape: "ring", text: "hue-bridge.node.started-tl" });
 						if(done) { done(); }
-					})
-					.catch(error => {
-						scope.error(error);
-						if(done) { done(error); }
-						setTimeout(function(){ scope.getBridgeInformation(); }, 2000);
-					});
-				}
-				else if(msg.payload.fetch == "resourceLinks")
-				{
-					scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.f-rlinks" });
-					bridge.client.resourceLinks.getAll()
-					.then(resourceLinks => {
-						setTimeout(function(){ scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.connected" }); }, 2000);
-
-						var message = {};
-						message.resourceLinks = resourceLinks;
-						message.info = scope.bridgeInformation;
 
-						send(message);
-						if(done) { done(); }
+						// RESET STATUS AFTER 30 SECONDS
+						setTimeout(function()
+						{
+							scope.setInitialState();
+							scope.getBridgeInformation(true);
+						}, 30000);
 					})
-					.catch(error => {
+					.catch(function(error)
+					{
 						scope.error(error);
 						if(done) { done(error); }
-						setTimeout(function(){ scope.getBridgeInformation(); }, 2000);
 					});
 				}
-				else if(msg.payload.fetch == "timeZones")
+				// FETCH RESSOURCES
+				else if(typeof msg.payload != 'undefined' && typeof msg.payload.fetch != 'undefined')
 				{
-					scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.f-timezones" });
-					bridge.client.timeZones.getAll()
-					.then(timeZones => {
-						setTimeout(function(){ scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.connected" }); }, 2000);
+					let fetchTypes = [];
+					if(typeof msg.payload.fetch == 'string') { fetchTypes.push(msg.payload.fetch); }
+					else if(typeof msg.payload.fetch == 'object') { fetchTypes = msg.payload.fetch; }
+					else { return false; }
 
-						var message = {};
-						message.timeZones = timeZones;
-						message.info = scope.bridgeInformation;
+					scope.status({fill: "blue", shape: "dot", text: "hue-bridge.node.f-ressources" });
 
-						send(message);
-						if(done) { done(); }
-					})
-					.catch(error => {
-						scope.error(error);
-						if(done) { done(error); }
-						setTimeout(function(){ scope.getBridgeInformation(); }, 2000);
+					// FETCH
+					bridgeInformation.results = {};
+					fetchTypes.forEach(function(fetch)
+					{
+						bridgeInformation.results[fetch] = bridge.get(fetch);
 					});
-				}
-				else if(msg.payload.fetch == "internetServices")
-				{
-					scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.f-internet" });
-					bridge.client.internetServices.get()
-					.then(internetServices => {
-						setTimeout(function(){ scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.connected" }); }, 2000);
 
-						var message = {};
-						message.internetServices = internetServices;
-						message.info = scope.bridgeInformation;
+					// SEND RESULTS
+					if(scope.lastCommand !== null)
+					{
+						bridgeInformation.command = scope.lastCommand;
+					}
 
-						send(message);
-						if(done) { done(); }
-					})
-					.catch(error => {
-						scope.error(error);
-						if(done) { done(error); }
-						setTimeout(function(){ scope.getBridgeInformation(); }, 2000);
-					});
-				}
-				else if(msg.payload.fetch == "portal")
-				{
-					scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.f-portal" });
-					bridge.client.portal.get()
-					.then(portal => {
-						setTimeout(function(){ scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.connected" }); }, 2000);
+					send(bridgeInformation);
 
-						var message = {};
-						message.portal = portal;
-						message.info = scope.bridgeInformation;
+					// RESET LAST COMMAND
+					scope.lastCommand = null;
+					if(done) { done(); }
 
-						send(message);
-						if(done) { done(); }
-					})
-					.catch(error => {
-						scope.error(error);
-						if(done) { done(error); }
-						setTimeout(function(){ scope.getBridgeInformation(); }, 2000);
-					});
+					// RESET STATUS
+					setTimeout(function(){ scope.setInitialState(); }, 2000);
 				}
+				// UPDATE SETTINGS
+				else if(typeof msg.payload != 'undefined' && typeof msg.payload.settings != 'undefined')
+				{
+					let patchObject = {};
 
-				commandSent = true;
-			}
-
-			// UPDATING SETTINGS
-			if(typeof msg.payload.settings != 'undefined')
-			{
-				scope.status({fill: "grey", shape: "dot", text: "hue-bridge.node.updating-settings" });
-				bridge.client.bridge.get()
-				.then(bridgeConfig => {
 					if(typeof msg.payload.settings.name != 'undefined')
 					{
-						bridgeConfig.name = msg.payload.settings.name;
+						patchObject.name = msg.payload.settings.name;
 					}
 					if(typeof msg.payload.settings.zigbeeChannel != 'undefined')
 					{
-						bridgeConfig.zigbeeChannel = msg.payload.settings.zigbeeChannel;
+						patchObject.zigbeechannel = msg.payload.settings.zigbeeChannel;
 					}
 					if(typeof msg.payload.settings.ipAddress != 'undefined')
 					{
-						bridgeConfig.ipAddress = msg.payload.settings.ipAddress;
+						patchObject.ipaddress = msg.payload.settings.ipAddress;
 					}
 					if(typeof msg.payload.settings.dhcpEnabled != 'undefined')
 					{
-						bridgeConfig.dhcpEnabled = msg.payload.settings.dhcpEnabled;
+						patchObject.dhcp = msg.payload.settings.dhcpEnabled;
 					}
 					if(typeof msg.payload.settings.netmask != 'undefined')
 					{
-						bridgeConfig.netmask = msg.payload.settings.netmask;
+						patchObject.netmask = msg.payload.settings.netmask;
 					}
 					if(typeof msg.payload.settings.gateway != 'undefined')
 					{
-						bridgeConfig.gateway = msg.payload.settings.gateway;
+						patchObject.gateway = msg.payload.settings.gateway;
 					}
 					if(typeof msg.payload.settings.proxyPort != 'undefined')
 					{
-						bridgeConfig.proxyPort = msg.payload.settings.proxyPort;
+						patchObject.proxyport = msg.payload.settings.proxyPort;
 					}
 					if(typeof msg.payload.settings.proxyAddress != 'undefined')
 					{
-						bridgeConfig.proxyAddress = msg.payload.settings.proxyAddress;
+						patchObject.proxyaddress = msg.payload.settings.proxyAddress;
 					}
 					if(typeof msg.payload.settings.timeZone != 'undefined')
 					{
-						bridgeConfig.timeZone = msg.payload.settings.timeZone;
+						patchObject.timezone = msg.payload.settings.timeZone;
 					}
-					return bridge.client.bridge.save(bridgeConfig);
-				})
-				.then(bridgeInformation => {
-					scope.status({fill: "green", shape: "dot", text: "hue-bridge.node.settings-updated" });
-					if(done) { done(); }
-					setTimeout(function(){ scope.getBridgeInformation(); }, 2000);
-				})
-				.catch(error => {
-					scope.error(error);
-					if(done) { done(error); }
-					setTimeout(function(){ scope.getBridgeInformation(); }, 2000);
-				});
-
-				// COMMAND SENT
-				commandSent = true;
-			}
 
-			// GET INFORMATION // FALLBACK
-			if(commandSent == false)
-			{
-				scope.getBridgeInformation();
-			}
-		});
+					// PATCH BRIDGE!
+					if(Object.values(patchObject).length > 0)
+					{
+						// SET UPDATING STATUS
+						scope.status({fill: "yellow", shape: "dot", text: "hue-bridge.node.updating-settings" });
+
+						// PATCH BRIDGE
+						bridge.patch("bridge", "/config", patchObject, 1)
+						.then(function(patched)
+						{
+							// GET RELOADED BRIDGE INFORMATION
+							return scope.getBridgeInformation(true);
+						})
+						.then(function(bridgeInformation)
+						{
+							scope.status({fill: "blue", shape: "dot", text: "hue-bridge.node.settings-updated" });
+
+							// SET LAST COMMAND
+							if(scope.lastCommand !== null)
+							{
+								bridgeInformation.command = scope.lastCommand;
+							}
+
+							scope.send(bridgeInformation);
+
+							// RESET LAST COMMAND
+							scope.lastCommand = null;
+
+							if(done) { done(); }
+							setTimeout(function(){ scope.setInitialState(); }, 3000);
+						})
+						.catch(function(error) {
+							scope.error(error);
+							if(done) { done(error); }
+						});
+					}
+				}
+				// GIVE BACK CURRENT STATE
+				else
+				{
+					// SEND MESSAGE
+					if(scope.lastCommand !== null)
+					{
+						bridgeInformation.command = scope.lastCommand;
+					}
 
-		//
-		// CLOSE NODE
-		this.on('close', function()
-		{
-			scope.nodeActive = false;
+					scope.send(bridgeInformation);
+
+					// RESET LAST COMMAND
+					scope.lastCommand = null;
+				}
+			});
 		});
 	}
 
 	RED.nodes.registerType("hue-bridge-node", HueBridgeNode);
-}
+}