node-red-contrib-knx-ultimate 2.2.3 → 2.2.4

package/CHANGELOG.md

@@ -6,6 +6,9 @@
 
 # CHANGELOG
 
+<b>Version 2.2.4</b> - October 2023<br/>
+- HUE Light: fixed some status hiccups and better handling of async hue bridge functions.<br/>
+</p>
 <b>Version 2.2.3</b> - October 2023<br/>
 - HUE Light: Again, rewrite of the DIM function to get rid of the dimming_delta.<br/>
 </p>

package/nodes/hue-config.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-lonely-if */
 /* eslint-disable no-param-reassign */
 /* eslint-disable no-inner-declarations */
 /* eslint-disable max-len */
@@ -54,6 +55,7 @@ module.exports = (RED) => {
     const node = this;
     node.host = config.host;
     node.nodeClients = []; // Stores the registered clients
+    node.nodeClientsAwaitingInit = []; // Stores the nodes client to be initialized
     node.loglevel = config.loglevel !== undefined ? config.loglevel : "error"; // 18/02/2020 Loglevel default error
     node.sysLogger = null;
     node.hueAllResources = null;
@@ -108,18 +110,20 @@ module.exports = (RED) => {
           node.hueAllResources = await node.hueManager.hueApiV2.get("/resource");
           node.hueAllRooms = node.hueAllResources.filter((a) => a.type === "room");
           // Update all KNX State of the nodes with the new hue device values
+          if (node.nodeClientsAwaitingInit !== undefined) {
+            // Because the whole process is async, if the function await node.hueManager.hueApiV2.get("/resource") has not jet been called or is late, 
+            // the node/nodes belonging to this server, has been previously added to the nodeClientsAwaitingInit list.
+            node.nodeClientsAwaitingInit.forEach((nodeClient) => {
+              node.nodeClients.push(nodeClient);
+            });
+            node.nodeClientsAwaitingInit = [];
+          }
           node.nodeClients.forEach((nodeClient) => {
             if (nodeClient.hueDevice !== undefined) {
               const oHUEDevice = node.hueAllResources.filter((a) => a.id === nodeClient.hueDevice)[0];
               if (oHUEDevice !== undefined) {
                 nodeClient.currentHUEDevice = oHUEDevice;
                 nodeClient.handleSendHUE(oHUEDevice);
-                // for (const [key, value] of Object.entries(oHUEDevice)) {
-                //   // Update KNX State
-                //   const oProperty = { id: oHUEDevice.id };
-                //   oProperty[key] = value;
-                //   nodeClient.handleSendHUE(oProperty);
-                // }
               }
             }
           });
@@ -262,20 +266,29 @@ module.exports = (RED) => {
     };
 
     node.addClient = (_Node) => {
-      // Check if node already exists
-      if (node.nodeClients.filter((x) => x.id === _Node.id).length === 0) {
-        // Add _Node to the clients array
-        _Node.setNodeStatusHue({
-          fill: "grey",
-          shape: "ring",
-          text: "Hue initialized.",
-        });
-        node.nodeClients.push(_Node);
-        // Update the node hue device, as soon as a node register itself to hue-config nodeClients
-        if (node.hueAllResources !== null) { // At first start, due to the async method for retrieving hueAllResources, hueAllResources is still null. The first start is handled in node.hueManager.on("connected")
+      // Update the node hue device, as soon as a node register itself to hue-config nodeClients
+      if (node.hueAllResources !== null) {
+        if (node.nodeClients.filter((x) => x.id === _Node.id).length === 0) { // At first start, due to the async method for retrieving hueAllResources, hueAllResources is still null. The first start is handled in node.hueManager.on("connected")
           const oHUEDevice = node.hueAllResources.filter((a) => a.id === _Node.hueDevice)[0];
           _Node.currentHUEDevice = oHUEDevice;
           if (oHUEDevice !== undefined) _Node.handleSendHUE(oHUEDevice);
+          node.nodeClients.push(_Node);
+          // Add _Node to the clients array
+          _Node.setNodeStatusHue({
+            fill: "green",
+            shape: "ring",
+            text: "Ready",
+          });
+        }
+      } else {
+        if (node.nodeClientsAwaitingInit.filter((x) => x.id === _Node.id).length === 0) {
+          // Put the node in the waiting list
+          node.nodeClientsAwaitingInit.push(_Node);
+          _Node.setNodeStatusHue({
+            fill: "grey",
+            shape: "dot",
+            text: "Awaiting HUE Resources",
+          });
         }
       }
     };

package/nodes/knxUltimateHueBattery.js

@@ -33,7 +33,7 @@ module.exports = function (RED) {
     node.setNodeStatusHue = ({
       fill, shape, text, payload,
     }) => {
-      if (payload === undefined) return;
+      if (payload === undefined) payload = '';
       const dDate = new Date();
       payload = typeof payload === 'object' ? JSON.stringify(payload) : payload.toString();
       node.status({ fill, shape, text: `${text} ${payload} (${dDate.getDate()}, ${dDate.toLocaleTimeString()})` });

package/nodes/knxUltimateHueButton.js

@@ -37,7 +37,7 @@ module.exports = function (RED) {
     node.setNodeStatusHue = ({
       fill, shape, text, payload,
     }) => {
-      if (payload === undefined) return;
+      if (payload === undefined) payload = '';
       const dDate = new Date();
       payload = typeof payload === 'object' ? JSON.stringify(payload) : payload.toString();
       node.status({ fill, shape, text: `${text} ${payload} (${dDate.getDate()}, ${dDate.toLocaleTimeString()})` });

package/nodes/knxUltimateHueLight.html

@@ -1,4 +1,24 @@
 <script type="text/javascript">
+  RED.events.on('nodes:add', function (node) {
+    if (node.type === 'uibuilder') {
+      // Keep a list of uib nodes in the editor
+      // may be different to the deployed list
+      editorInstances[node.id] = node.url
+      // -- IF uibuilderInstances <> editorInstances THEN there are undeployed instances. --
+    }
+  })
+  RED.events.on('nodes:change', function (node) {
+    if (node.type === 'uibuilder') {
+      mylog('nodes:change:', node)
+      editorInstances[node.id] = node.url
+    }
+  })
+  RED.events.on('nodes:remove', function (node) {
+    if (node.type === 'uibuilder') {
+      mylog('>> nodes:remove >>', node)
+      delete editorInstances[node.id]
+    }
+  })
   RED.nodes.registerType("knxUltimateHueLight", {
     category: "KNX Ultimate",
     color: "#C0C7E9",
@@ -486,15 +506,15 @@
           $("#getColorAtSwitchOnNightTimeButton").text("Get current");
         });
       });
-      
+
       // Fill options for minDimLevel and maxDimLevel
       for (let index = 0; index <= 90; index++) {
-        if (index === 0){
+        if (index === 0) {
           $("#node-input-minDimLevelLight").append($("<option>").val(index).text(index.toString() + "% (Switch Off)"));
-        }else{
+        } else {
           $("#node-input-minDimLevelLight").append($("<option>").val(index).text(index.toString() + "%"));
         }
-        
+
       }
       $("#node-input-minDimLevelLight").val(node.minDimLevelLight);
       for (let index = 100; index >= 10; index--) {

package/nodes/knxUltimateHueLight.js

@@ -41,22 +41,13 @@ module.exports = function (RED) {
       fill, shape, text, payload,
     }) => { };
     // Used to call the status update from the HUE config node.
-    node.setNodeStatusHue = ({
-      fill, shape, text, payload,
-    }) => {
-      if (payload === undefined) return;
+    node.setNodeStatusHue = ({ fill, shape, text, payload }) => {
+      if (payload === undefined) payload = '';
       const dDate = new Date();
       payload = typeof payload === "object" ? JSON.stringify(payload) : payload.toString();
       node.status({ fill, shape, text: `${text} ${payload} (${dDate.getDate()}, ${dDate.toLocaleTimeString()})` });
     };
 
-    node.setNodeStatusHue({
-      fill: "grey",
-      shape: "ring",
-      text: "Connecting to the Bridge...",
-      payload: "",
-    });
-
     function getRandomIntInclusive(min, max) {
       min = Math.ceil(min);
       max = Math.floor(max);
@@ -67,9 +58,9 @@ module.exports = function (RED) {
     node.handleSend = (msg) => {
       if (node.currentHUEDevice === undefined) {
         node.setNodeStatusHue({
-          fill: "red",
+          fill: "grey",
           shape: "ring",
-          text: "Rejected KNX message. I'm connecting to the Bridge...",
+          text: "Currently not ready.",
           payload: "",
         });
         return;
@@ -448,26 +439,32 @@ module.exports = function (RED) {
             node.currentHUEDevice.on.on = _event.on.on;
           }
           if (_event.hasOwnProperty("color")) {
-            node.updateKNXLightColorState(_event.color);
-            node.currentHUEDevice.color = _event.color;
+            if (_event.type !== 'grouped_light') {
+              // In grouped lights, there is group color, but each light has it's own color.
+              node.updateKNXLightColorState(_event.color);
+              node.currentHUEDevice.color = _event.color;
+            }
           }
           if (_event.hasOwnProperty("dimming") && _event.dimming.brightness !== undefined) {
             // Every once on a time, the light transmit the brightness value of 0.39.
             // To avoid wrongly turn light state on, exit
             if (_event.dimming.brightness < 1) _event.dimming.brightness = 0;
-            if (node.currentHUEDevice.hasOwnProperty("on") && node.currentHUEDevice.on.on === false && _event.dimming.brightness === 0) return;
-            if (node.currentHUEDevice.on.on === false) node.updateKNXLightState(_event.dimming.brightness > 0);
-            node.updateKNXBrightnessState(_event.dimming.brightness);
-            // If the brightness reaches zero, the hue lamp "on" property must be set to zero as well
-            if (_event.dimming.brightness === 0) {
-              node.serverHue.hueManager.writeHueQueueAdd(
-                node.hueDevice,
-                { on: { on: false } },
-                node.isGrouped_light === false ? "setLight" : "setGroupedLight",
-              );
-              node.currentHUEDevice.on.on = false;
+            if (node.currentHUEDevice.hasOwnProperty("on") && node.currentHUEDevice.on.on === false && _event.dimming.brightness === 0) {
+              // Do nothing, because the light is off and the dimming also is 0
+            } else {
+              if (node.currentHUEDevice.on.on === false) node.updateKNXLightState(_event.dimming.brightness > 0);
+              node.updateKNXBrightnessState(_event.dimming.brightness);
+              // If the brightness reaches zero, the hue lamp "on" property must be set to zero as well
+              if (_event.dimming.brightness === 0) {
+                node.serverHue.hueManager.writeHueQueueAdd(
+                  node.hueDevice,
+                  { on: { on: false } },
+                  node.isGrouped_light === false ? "setLight" : "setGroupedLight",
+                );
+                node.currentHUEDevice.on.on = false;
+              }
+              node.currentHUEDevice.dimming.brightness = _event.dimming.brightness;
             }
-            node.currentHUEDevice.dimming.brightness = _event.dimming.brightness;
           }
           if (_event.hasOwnProperty("color_temperature") && _event.color_temperature.mirek !== undefined) {
             node.updateKNXLightHSVState(_event.color_temperature.mirek);
@@ -615,6 +612,8 @@ module.exports = function (RED) {
       }
     };
 
+
+
     // On each deploy, unsubscribe+resubscribe
     if (node.server) {
       node.server.removeClient(node);

package/nodes/knxUltimateHueLightSensor.js

@@ -29,7 +29,7 @@ module.exports = function (RED) {
     };
     // Used to call the status update from the HUE config node.
     node.setNodeStatusHue = ({ fill, shape, text, payload }) => {
-      if (payload === undefined) return;
+      if (payload === undefined) payload = '';
       const dDate = new Date();
       payload = typeof payload === 'object' ? JSON.stringify(payload) : payload.toString();
       node.status({ fill, shape, text: text + ' ' + payload + ' (' + dDate.getDate() + ', ' + dDate.toLocaleTimeString() + ')' });

package/nodes/knxUltimateHueMotion.js

@@ -24,17 +24,17 @@ module.exports = function (RED) {
     node.formatdecimalsvalue = 2;
 
     // Used to call the status update from the config node.
-    node.setNodeStatus = ({ fill, shape, text, payload }) => {};
+    node.setNodeStatus = ({ fill, shape, text, payload }) => { };
     // Used to call the status update from the HUE config node.
     node.setNodeStatusHue = ({ fill, shape, text, payload }) => {
-      if (payload === undefined) return;
+      if (payload === undefined) payload = '';
       const dDate = new Date();
       payload = typeof payload === "object" ? JSON.stringify(payload) : payload.toString();
       node.status({ fill, shape, text: `${text} ${payload} (${dDate.getDate()}, ${dDate.toLocaleTimeString()})` });
     };
 
     // This function is called by the knx-ultimate config node, to output a msg.payload.
-    node.handleSend = (msg) => {};
+    node.handleSend = (msg) => { };
 
     node.handleSendHUE = (_event) => {
       try {
@@ -91,7 +91,7 @@ module.exports = function (RED) {
       node.serverHue.addClient(node);
     }
 
-    node.on("input", (msg) => {});
+    node.on("input", (msg) => { });
 
     node.on("close", (done) => {
       if (node.server) {

package/nodes/knxUltimateHueScene.js

@@ -31,7 +31,7 @@ module.exports = function (RED) {
     };
     // Used to call the status update from the HUE config node.
     node.setNodeStatusHue = ({ fill, shape, text, payload }) => {
-      if (payload === undefined) return;
+      if (payload === undefined) payload = '';
       const dDate = new Date();
       payload = typeof payload === 'object' ? JSON.stringify(payload) : payload.toString();
       node.status({ fill, shape, text: text + ' ' + payload + ' (' + dDate.getDate() + ', ' + dDate.toLocaleTimeString() + ')' });

package/nodes/knxUltimateHueTapDial.js

@@ -35,7 +35,7 @@ module.exports = function (RED) {
     node.setNodeStatusHue = ({
       fill, shape, text, payload,
     }) => {
-      if (payload === undefined) return;
+      if (payload === undefined) payload = '';
       const dDate = new Date();
       payload = typeof payload === 'object' ? JSON.stringify(payload) : payload.toString();
       node.status({ fill, shape, text: `${text} ${payload} (${dDate.getDate()}, ${dDate.toLocaleTimeString()})` });

package/nodes/knxUltimateHueTemperatureSensor.js

@@ -33,7 +33,7 @@ module.exports = function (RED) {
     node.setNodeStatusHue = ({
       fill, shape, text, payload,
     }) => {
-      if (payload === undefined) return;
+      if (payload === undefined) payload = '';
       const dDate = new Date();
       payload = typeof payload === 'object' ? JSON.stringify(payload) : payload.toString();
       node.status({ fill, shape, text: `${text} ${payload} (${dDate.getDate()}, ${dDate.toLocaleTimeString()})` });

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "2.2.3",
+  "version": "2.2.4",
   "description": "Control your KNX intallation via Node-Red! Single Node KNX IN/OUT with optional ETS group address importer. Easy to use and highly configurable. With integrated Philips HUE devices control.",
   "dependencies": {
     "binary-parser": "2.2.1",