node-red-contrib-huemagic 4.0.2 → 4.1.0

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
@@ -25,7 +24,7 @@ HueMagic provides several input and output nodes for Node-RED and is the most in
 * Extensively documented in English & German
 
 ### Installation
-HueMagic was written for **Node.js 14+** and **Node-RED v2.1+**. It supports the square-shaped Hue Bridge with the **FW 1948086000+** or higher. You can install HueMagic directly via the [Node-RED Palette Manager](https://nodered.org/docs/user-guide/editor/palette/manager) or manually using [yarn / npm](https://nodered.org/docs/user-guide/runtime/adding-nodes).
+HueMagic was written for **Node.js 14+** and **Node-RED v2.1+**. It supports the square-shaped Hue Bridge with the **firmware 1948086000+** or higher. You can install HueMagic directly via the [Node-RED Palette Manager](https://nodered.org/docs/user-guide/editor/palette/manager) or manually using [npm / yarn](https://nodered.org/docs/user-guide/runtime/adding-nodes).
 
 `npm install node-red-contrib-huemagic`
 
@@ -46,9 +45,9 @@ _Please make sure that you deactivate other Hue-related nodes in Node-RED and me
 
 ### Examples
 
-HueMagic provides a large selection of full featured sample flows for all nodes. You can find these examples in the "[examples](https://github.com/Foddy/node-red-contrib-huemagic/tree/master/examples)" folder on GitHub or directly in Node-RED. To import a full featured example into your Node-RED interface, click on the Node-RED menu icon, then select "Import" and navigate to "Examples" in the sidebar of the popup. Then select the HueMagic folder and your desired node to import a sample flow.
+HueMagic provides a large selection of full featured sample flows for all nodes. You can find these examples in the [examples folder on GitHub](https://github.com/Foddy/node-red-contrib-huemagic/tree/master/examples) or directly in Node-RED. To import a full featured example into your Node-RED interface, click on the Node-RED menu icon, then select "Import" and navigate to "Examples" in the sidebar of the popup. Then select the HueMagic folder and your desired node to import a sample flow.
 
-<img alt="Instructions to import examples in Node-RED" src="https://user-images.githubusercontent.com/5302050/148696808-f730ad36-8d0b-4b5b-99b2-1917831f8916.gif" width="100%">
+<a href="https://github.com/Foddy/node-red-contrib-huemagic/tree/master/examples"><img alt="Instructions to import examples in Node-RED" src="https://user-images.githubusercontent.com/5302050/148696808-f730ad36-8d0b-4b5b-99b2-1917831f8916.gif" width="100%"></a>
 
 ## Hue Bridge
 The "Hue Bridge" node is a universal node that can output all settings of the bridge and status messages from other nodes.
@@ -143,7 +142,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)
 
@@ -173,7 +172,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).
 
@@ -186,11 +185,11 @@ Create an `array` with the respective animation steps in the form of an object a
 
 If you have created your own animation that you would like to share with others, add it at `/huemagic/animations/XXX-youranimationname.json` and create a pull request. Take a look at [this directory](https://github.com/Foddy/node-red-contrib-huemagic/tree/master/huemagic/animations) for structure help.
 
-### 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.
 
@@ -274,7 +273,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 |
@@ -396,6 +395,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`
@@ -454,7 +454,7 @@ The "Hue Buttons" node receives switching events from input devices connected to
 
 ### Node-RED Setup Instructions
 
-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.
 
@@ -532,7 +532,7 @@ If necessary, the sensor can be turned on and off remotely. If the sensor has be
 
 |Property|Description|
 |--|--|
-| 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
 
@@ -615,7 +615,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) |
 
@@ -796,9 +796,26 @@ If the status of the node has changed via a certain command, the entire command
 
 # Changelog
 
-### v4.0.2 (latest)
+### v4.1.0 (latest)
 
-> **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.
+* New queue worker throttles the number of parallel requests to the bridge to avoid 503 API limit errors (can be configured in the Bridge configuration)
+* Resources are now alphabetically sorted in the node´s configuration inetrface ([#282](https://github.com/Foddy/node-red-contrib-huemagic/pull/282)) (thx)
+* "Hue Bridghtness" node was optimized to output more accurate "dark" and "dayLight" values
+* Several optimizations in the documentation of some nodes
+
+### v4.0.5
+
+* The "Hue Group" node now contains the "resources" information with all linked resources behind the group/zone
+* Fixed an issue that caused Node-RED to restart if a command was sent before a node was initialized
+
+### v4.0.4
+
+* 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.
 
 * HueMagic speaks now directly with the bridge without any submodules *(huejay dependency removed)*
 * Migrated to the newest CLIP/v2 API version from the Philips Hue bridge

package/examples/Hue Bridge.json

@@ -122,7 +122,7 @@
         "id": "a1d6fdeca2c9c014",
         "type": "comment",
         "z": "bf04a073.be4428",
-        "name": "Fetch specific bridge ressources",
+        "name": "Fetch specific bridge resources",
         "info": "",
         "x": 150,
         "y": 420,

package/huemagic/hue-bridge-config.html

@@ -25,6 +25,10 @@
             </button>
         </div>
 	</div>
+	<div class="form-row">
+		<label for="node-config-input-worker"><i class="fa fa-cogs"></i> <span>Worker</span></label>
+		<input type="text" id="node-config-input-worker" placeholder="10" style="width: calc(100% - 105px)">
+	</div>
 	<div class="form-row" style="margin-top: 30px">
         <div style="display: inline-flex; width: calc(100% - 105px)">
             <input type="checkbox" id="node-input-autoupdates" style="flex: 15px;">
@@ -47,6 +51,9 @@
 			name: { value:"Hue Bridge", required: true },
 			bridge: { value:"", required: true },
 			key: { value:"", required: true },
+			worker: { value: 10, required: true, validate:function(v) {
+				return (!isNaN(v) && v > 0)
+			}},
 			autoupdates: { value: true },
 			disableupdates: { value: false }
 		},
@@ -91,8 +98,8 @@
 				// GET THE SENSORS
 				$.get('hue/bridges')
 				.done( function(data) {
-				    var allRessources = JSON.parse(data);
-				    if(allRessources.length <= 0)
+				    var allResources = JSON.parse(data);
+				    if(allResources.length <= 0)
 				    {
 				        notification.close();
 				        RED.notify(scope._("hue-bridge-config.config.none-found"), { type: "error" });
@@ -100,9 +107,9 @@
 				    }
 
 				    // SET OPTIONS
-				    allRessources.forEach(function(ressource)
+				    allResources.forEach(function(resource)
 				    {
-				        options[ressource.ip] = { value: ressource.ip, label: ressource.ip };
+				        options[resource.ip] = { value: resource.ip, label: resource.ip };
 				    });
 
 				    // SELECT CURRENT VALUE