node-red-contrib-huemagic 4.0.0 → 4.0.4

package/huemagic/locales/en-US/hue-bridge.json

@@ -16,7 +16,7 @@
 			"connected": "connected",
 			"starting-tl": "starting TouchLink…",
 			"started-tl": "TouchLink started…",
-			"f-ressources": "fetching ressources…",
+			"f-resources": "fetching resources…",
 			"updating-settings": "updating settings…",
 			"settings-updated": "settings updated",
 			"input": "settings / fetch",

package/huemagic/locales/en-US/hue-buttons.html

@@ -3,7 +3,7 @@ The "Hue Buttons" node receives switching events from input devices connected to
 
 ### Setup
 
-Select the pre-configured Hue Bridge and hit the search button to find all the available switches/buttons. If you already know the ID of the switch, you can also enter it here manually. You can either assign a new name for the switch internally or keep the predefined name of the device. Optionally, you can also deactivate all automatic status messages for this node by clicking the setting "Skip events from node". The node will then no longer output any switching events. Alternatively, you can also choose whether the node's initialization message should not be suppressed when Node-RED is started. If you activate this setting, you will receive a status message for the currently selected switch after each deployment.
+Select the pre-configured Hue Bridge and hit the search button to find all the available switches/buttons. If you already know the ID of the switches/buttons, you can also enter it here manually. You can either assign a new name for the switches/buttons internally or keep the predefined name of the device. Optionally, you can also deactivate all automatic status messages for this node by clicking the setting "Skip events from node". The node will then no longer output any switching events. Alternatively, you can also choose whether the node's initialization message should not be suppressed when Node-RED is started. If you activate this setting, you will receive a status message for the currently selected switches/buttons after each deployment.
 
 If you do not select a switch/button and use the node configuration in this way, the node works in the so-called "universal mode". In this mode, the node receives and outputs all status messages of the same type.
 
@@ -34,8 +34,8 @@ As soon as a key has been pressed, the following status message is returned by t
 : name (string): The currently set name of the switch/button
 : type (string): The type of the switch/button (always `button`)
 : softwareVersion (string): The current firmware of the switch/button
-: battery (float): The current battery level of the switch/button
-: batteryState (string): The current status of the battery level. Can contain `normal`, `low` or `critical` as a value
+: battery (float | boolean): The current battery level of the switch/button, `false`, if there is no battery
+: batteryState (string | boolean): The current status of the battery level. Can contain `normal`, `low` or `critical` as a value, `false`, if there is no battery
 : model (object): Contains the model information of the switch/button under `id` , `manufacturer`, `name`, `type` and `certified`
 
 #### Status changes under `msg.updated`

package/huemagic/locales/en-US/hue-magic.html

@@ -22,11 +22,11 @@ Create an `array` with the respective animation steps in the form of an object a
 : delay (int): Number of milliseconds to wait until this step is carried out
 : animation (object): The object contains the action(s) to be carried out in this step. Identical parameters as for the "Hue Light" & "Hue Group" nodes
 
-### Example of your own animation
+### Example of a custom animation
 
 This example shows what a simple animation could look like. In the first step, the delay of 500 milliseconds is waited for. The color of the light is then slowly changed to red over a period of one second. As soon as the light has completely changed to red, the second step is carried out, which also has a delay of 500 milliseconds. Finally the color changes to blue.
 
-If you have set the animation to play indefinitely, this process is repeated indefinitely until you manually stop the animation or redeploy the node.
+If you have set the animation to loop, this process is repeated indefinitely until you manually stop the animation or redeploy the node.
 
 Pass the following object in `msg.payload` to play the example animation.
 

package/huemagic/locales/en-US/hue-motion.html

@@ -17,7 +17,7 @@ Outputs the current status of the sensor as soon as a `msg.payload` object with
 
 If necessary, the sensor can be turned on and off remotely. If the sensor has been turned off, it no longer registers any movements and accordingly no longer outputs them. To do this, pass an object with the following content:
 
-: payload (boolean): `true` turns the sensor on,` false` turns it off
+: payload (boolean): `true` turns the sensor on, `false` turns it off
 
 ### Status messages from the node
 

package/huemagic/locales/en-US/hue-temperature.html

@@ -30,7 +30,7 @@ As soon as the sensor has registered a temperature change, the following status
 : connectionStatus (string): The current connection status with the bridge in the form of a string. Can contain `connected`, `disconnected`, `connectivity_issue` or `unidirectional_incoming` as a value
 : celsius (float): Indicates the current ambient temperature in °C (degrees Celsius)
 : fahrenheit (float): Indicates the current ambient temperature in °F (degrees Fahrenheit)
-: temperatureIs (string): Describes the current temperature with the values ´very cold´, ´cold´, ´slightly cold´, ´comfortable´, ´slightly warm´, ´warm´, ´hot´ or ´very hot´
+: temperatureIs (string): Describes the current temperature with the values `very cold`, `cold`, `slightly cold`, `comfortable`, `slightly warm`, `warm`, `hot` or `very hot`
 : deviceValue (float): The original value of the temperature from the sensor
 : updated (string): Time of the last update of the resource by HueMagic (ISO 8601)
 

package/huemagic/utils/api.js

@@ -5,83 +5,77 @@ 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', ressource = 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
 			};
 
-			// HAS RESSOURCE? -> APPEND
-			if(ressource !== null)
+			// HAS RESOURCE? -> APPEND
+			if(resource !== null)
 			{
 				if(version === 2)
 				{
-					ressource = (ressource !== "all") ? "/"+ressource : "";
-					request['url'] += "/clip/v2/resource" + ressource;
+					resource = (resource !== "all") ? "/"+resource : "";
+					request['url'] += "/clip/v2/resource" + resource;
 				}
 				else if(version === 1)
 				{
-					request['url'] += "/api/" + scope.accessKey + ressource;
+					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,71 +146,71 @@ 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;
 	}
 
 	//
-	// GET FULL/ROOT RESSOURCE
-	this.fullRessource = function(ressource, allRessources = {})
+	// GET FULL/ROOT RESOURCE
+	this.fullResource = function(resource, allResources = {})
 	{
 		const scope = this;
-		var fullRessource = Object.assign({}, ressource);
+		var fullResource = Object.assign({}, resource);
 
-		if(ressource["owner"])
+		if(resource["owner"])
 		{
-			fullRessource = scope.fullRessource(allRessources[fullRessource["owner"]["rid"]], allRessources);
+			fullResource = scope.fullResource(allResources[fullResource["owner"]["rid"]], allResources);
 		}
-		else if(ressource["type"] === "device" || ressource["type"] === "room" || ressource["type"] === "zone" || ressource["type"] === "bridge_home")
+		else if(resource["type"] === "device" || resource["type"] === "room" || resource["type"] === "zone" || resource["type"] === "bridge_home")
 		{
 			// RESOLVE SERVICES
 			var allServices = {};
 
-			for (var i = ressource["services"].length - 1; i >= 0; i--)
+			for (var i = resource["services"].length - 1; i >= 0; i--)
 			{
-				const targetService = ressource["services"][i];
+				const targetService = resource["services"][i];
 				const targetType = targetService["rtype"];
 				const targetID = targetService["rid"];
 
 				if(!allServices[targetType]) { allServices[targetType] = {}; }
-				allServices[targetType][targetID] = Object.assign({}, allRessources[targetID]);
+				allServices[targetType][targetID] = Object.assign({}, allResources[targetID]);
 			}
 
 			// REPLACE SERVICES
-			fullRessource["services"] = allServices;
+			fullResource["services"] = allServices;
 		}
 
-		return fullRessource;
+		return fullResource;
 	}
 
 	//
-	// PROCESS RESSOURCES
-	this.processRessources = function(ressources)
+	// PROCESS RESOURCES
+	this.processResources = function(resources)
 	{
 		const scope = this;
 
@@ -226,62 +220,62 @@ function API()
 		// ACTION!
 		return new Promise(function(resolve, reject)
 		{
-			let ressourceList = {};
-			let processedRessources = {
+			let resourceList = {};
+			let processedResources = {
 				_groupsOf: {}
 			};
 
-			// CREATE ID BASED OBJECT OF ALL RESSOURCES
-			ressources.forEach(function(ressource, index)
+			// CREATE ID BASED OBJECT OF ALL RESOURCES
+			resources.forEach(function(resource, index)
 			{
 				// IS BUTTON? -> REMOVE PREVIOUS STATE
-				if(ressource.type === "button")
+				if(resource.type === "button")
 				{
-					delete ressource["button"];
+					delete resource["button"];
 				}
 
-				ressourceList[ressource.id] = ressource;
+				resourceList[resource.id] = resource;
 			});
 
-			// GET FULL RESSOURCES OF EACH OBJECT
-			ressources.forEach(function(ressource, index)
+			// GET FULL RESOURCES OF EACH OBJECT
+			resources.forEach(function(resource, index)
 			{
-				// GET FULL RESSOURCE
-				let fullRessource = scope.fullRessource(ressource, ressourceList);
+				// GET FULL RESOURCE
+				let fullResource = scope.fullResource(resource, resourceList);
 
 				// ADD CURRENT DATE/TIME
-				fullRessource["updated"] = currentDateTime;
+				fullResource["updated"] = currentDateTime;
 
-				// ALL ALL TYPES BEHIND RESSOURCE
-				fullRessource["types"] = [ fullRessource["type"] ];
+				// ALL ALL TYPES BEHIND RESOURCE
+				fullResource["types"] = [ fullResource["type"] ];
 
-				// RESSOURCE HAS SERVICES?
-				if(fullRessource["services"])
+				// RESOURCE HAS SERVICES?
+				if(fullResource["services"])
 				{
-					let additionalServiceTypes = Object.keys(fullRessource["services"]);
+					let additionalServiceTypes = Object.keys(fullResource["services"]);
 
 					// SET ADDITIONAL TYPES BEHIND RECCOURCE
-					fullRessource["types"] = fullRessource["types"].concat(additionalServiceTypes);
+					fullResource["types"] = fullResource["types"].concat(additionalServiceTypes);
 				}
 
 				// RESOURCE HAS GROUPED SERVICES?
-				if(fullRessource["grouped_services"])
+				if(fullResource["grouped_services"])
 				{
-					for (var g = fullRessource["grouped_services"].length - 1; g >= 0; g--)
+					for (var g = fullResource["grouped_services"].length - 1; g >= 0; g--)
 					{
-						const groupedService = fullRessource["grouped_services"][g];
+						const groupedService = fullResource["grouped_services"][g];
 						const groupedServiceID = groupedService["rid"];
 
-						if(!processedRessources["_groupsOf"][groupedServiceID]) { processedRessources["_groupsOf"][groupedServiceID] = []; }
-						processedRessources["_groupsOf"][groupedServiceID].push(fullRessource.id);
+						if(!processedResources["_groupsOf"][groupedServiceID]) { processedResources["_groupsOf"][groupedServiceID] = []; }
+						processedResources["_groupsOf"][groupedServiceID].push(fullResource.id);
 					}
 				}
 
-				// GIVE FULL RESSOURCE BACK TO COLLECTION
-				processedRessources[fullRessource.id] = fullRessource;
+				// GIVE FULL RESOURCE BACK TO COLLECTION
+				processedResources[fullResource.id] = fullResource;
 			});
 
-			resolve(processedRessources);
+			resolve(processedResources);
 		});
 	}
 }