node-red-contrib-huemagic 4.0.2 → 4.1.0

package/huemagic/hue-scene.html

@@ -67,6 +67,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 searchAndSelectScenes()
             {
@@ -81,10 +94,11 @@
                 var notification = RED.notify(scope._("hue-rules.config.searching"), { type: "compact", modal: true, fixed: true });
 
                 // GET THE SCENES
-                $.get('hue/ressources', { bridge: bridgeConfig.bridge, key: bridgeConfig.key, type: "scene" })
+                $.get('hue/resources', { bridge: bridgeConfig.bridge, key: bridgeConfig.key, type: "scene" })
                 .done( function(data) {
-                    var allRessources = JSON.parse(data);
-                    if(allRessources.length <= 0)
+                    var allResources = JSON.parse(data);
+                    allResources = sortResourcesBy('name', allResources);
+                    if(allResources.length <= 0)
                     {
                         notification.close();
                         RED.notify(scope._("hue-scene.config.none-found"), { type: "error" });
@@ -92,9 +106,9 @@
                     }
 
                     // SET OPTIONS
-                    allRessources.forEach(function(ressource)
+                    allResources.forEach(function(resource)
                     {
-                        sceneOptions[ressource.id] = { value: ressource.id, label: ressource.name + " ("+ressource.group+")" };
+                        sceneOptions[resource.id] = { value: resource.id, label: resource.name + " ("+resource.group+")" };
                     });
 
                     // SELECT CURRENT VALUE
@@ -167,4 +181,4 @@
             }
         }
     });
-</script>
+</script>

package/huemagic/hue-scene.js

@@ -60,7 +60,7 @@ module.exports = function(RED)
 			// RECALL ON GROUP? -> USE API v1
 			if(copyOfTargetGroups.length > 0)
 			{
-				let targetSceneID = bridge.ressources[sceneDef].id_v1.replace("/scenes/", "");
+				let targetSceneID = bridge.resources[sceneDef].id_v1.replace("/scenes/", "");
 
 				// SEND STATUS
 				scope.status({fill: "blue", shape: "dot", text: "hue-scene.node.recalled-on-group"})

package/huemagic/hue-temperature.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()
             {
@@ -95,10 +108,11 @@
                 var notification = RED.notify(scope._("hue-temperature.config.searching"), { type: "compact", modal: true, fixed: true });
 
                 // GET THE SENSORS
-                $.get('hue/ressources', { bridge: bridgeConfig.bridge, key: bridgeConfig.key, type: "temperature" })
+                $.get('hue/resources', { bridge: bridgeConfig.bridge, key: bridgeConfig.key, type: "temperature" })
                 .done( function(data) {
-                    var allRessources = JSON.parse(data);
-                    if(allRessources.length <= 0)
+                    var allResources = JSON.parse(data);
+                    allResources = sortResourcesBy('name', allResources);
+                    if(allResources.length <= 0)
                     {
                         notification.close();
                         RED.notify(scope._("hue-temperature.config.none-found"), { type: "error" });
@@ -106,15 +120,15 @@
                     }
 
                     // SET OPTIONS
-                    allRessources.forEach(function(ressource)
+                    allResources.forEach(function(resource)
                     {
-                        if(ressource.model)
+                        if(resource.model)
                         {
-                            options[ressource.id] = { value: ressource.id, label: ressource.name + " ("+ressource.model+")" };
+                            options[resource.id] = { value: resource.id, label: resource.name + " ("+resource.model+")" };
                         }
                         else
                         {
-                            options[ressource.id] = { value: ressource.id, label: ressource.name };
+                            options[resource.id] = { value: resource.id, label: resource.name };
                         }
                     });
 
@@ -194,4 +208,4 @@
             }
         }
     });
-</script>
+</script>

package/huemagic/hue-temperature.js

@@ -40,7 +40,7 @@ module.exports = function(RED)
 		{
 			let currentState = bridge.get("temperature", info.id);
 
-			// RESSOURCE FOUND?
+			// RESOURCE FOUND?
 			if(currentState !== false)
 			{
 				// SEND MESSAGE
@@ -102,14 +102,25 @@ module.exports = function(RED)
 			done = done || function() { scope.done.apply(scope,arguments); }
 
 			// SAVE LAST COMMAND
-			scope.lastCommand = msg;
+			scope.lastCommand = RED.util.cloneMessage(msg);
 
 			// CREATE PATCH
 			let patchObject = {};
 
 			// DEFINE SENSOR ID & CURRENT STATE
-			const tempSensorID = (typeof msg.topic != 'undefined' && msg.topic.length > 0) ? msg.topic : config.sensorid;
+			const tempSensorID = (!config.sensorid && typeof msg.topic != 'undefined' && bridge.validResourceID.test(msg.topic) === true) ? msg.topic : config.sensorid;
+			if(!tempSensorID)
+			{
+				scope.error("Please submit a valid sensor ID.");
+				return false;
+			}
+
 			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..");
+				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") )
@@ -131,10 +142,10 @@ module.exports = function(RED)
 			}
 
 			// TURN ON / OFF
-			if((msg.payload === true || msg.payload === false) && (msg.payload !== currentState.payload.active))
+			if((msg.payload === true || msg.payload === false) && (msg.payload != currentState.payload.active))
 			{
 				// PREPARE PATCH
-				patchObject.enabled = msg.payload;
+				patchObject["enabled"] = (msg.payload == true);
 			}
 
 			//

package/huemagic/locales/de/hue-bridge-config.html

@@ -13,6 +13,14 @@ Geben Sie die Hue Bridge-IP-Adresse manuell ein oder drücken Sie den Button, um
 
 Geben Sie den Hue Bridge API-Schlüssel manuell ein oder drücken Sie den Button, um einen neuen Schlüssel zu erstellen. Wenn Sie einen neuen Schlüssel erstellen möchten, müssen Sie innerhalb des Zeitfensters von 20 Sekunden den physischen Button der Bridge betätigen, um den Prozess abzuschließen.
 
+### 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.
+
+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.
+
+Setzen Sie hier einen Wert unter 10 (z. B. 4 bis 7), wenn Sie auch außerhalb von HueMagic Befehle an die Bridge senden, um den von Philips Hue empfohlenen Durchsatz an Befehlen / Sekunde einzuhalten.
+
 ### Automatische Firmware-Updates
 
 HueMagic prüft periodisch nach verfügbaren Philips Hue Firmware Updates und installiert sie automatisch, wenn sie verfügbar sind. Sie können dieses Verhalten deaktivieren, indem Sie die entsprechende Checkbox anklicken.

package/huemagic/locales/de/hue-bridge.json

@@ -16,7 +16,7 @@
 			"connected": "verbunden",
 			"starting-tl": "starte TouchLink…",
 			"started-tl": "TouchLink gestartet",
-			"f-ressources": "hole Ressouren…",
+			"f-resources": "hole Ressouren…",
 			"updating-settings": "aktualisiere Einstellungen…",
 			"settings-updated": "Einstellungen aktualisiert",
 			"input": "Einstellungen / Abrufen",

package/huemagic/locales/de/hue-group.html

@@ -53,6 +53,7 @@ Anders als beim „Hue Licht“-Node, stehen Ihnen hier viel weniger Statusinfor
 : id (string) : Gibt die neue ID der Gruppe an
 : idV1 (string | boolean) : Gibt die alte ID der Gruppe an
 : name (string) : Der aktuell eingestellte Name des Gruppe
+: resources (object) : Enthält alle Geräte/Ressourcen hinter der Gruppe
 : type (string) : Der Typ des Gruppe (immer `group`)
 
 #### Zustandsänderungen unter `msg.updated`

package/huemagic/locales/en-US/hue-bridge-config.html

@@ -13,6 +13,14 @@ Enter the Hue Bridge IP address manually or press the button to call up all loca
 
 Enter the Hue Bridge API key manually or press the button to create a new key. If you want to create a new key, you have to press the physical button of the bridge within the time window of 20 seconds to complete the process.
 
+### Worker
+
+The "Worker" value determines the number of parallel commands that HueMagic is allowed to send to the bridge at the same time. According to the official documentation of the Philips Hue bridge, no more than 10 commands should be sent per second, otherwise there is a risk that the bridge will not be able to process the requests as quickly and will throw errors.
+
+If more commands are sent at the same time than the value set here, HueMagic will execute the commands in sequence as soon as throughput is possible again.
+
+Set this to a value below 10 (e.g. 4 to 7) if you also send commands to the bridge outside of HueMagic in order to comply with the Philips Hue recommended throughput of commands/second.
+
 ### Automatic firmware updates
 
 HueMagic periodically checks for available Philips Hue firmware updates and automatically installs them when they are available. You can deactivate this behavior by clicking the corresponding checkbox.

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

@@ -79,7 +79,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)
 

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.
 

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

@@ -53,6 +53,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`

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

@@ -38,7 +38,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

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

@@ -13,7 +13,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).
 
@@ -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)