node-red-contrib-knx-ultimate 2.2.24 → 2.2.25

package/CHANGELOG.md

@@ -6,6 +6,13 @@
 
 # CHANGELOG
 
+**Version 2.2.25** - November 2023<br/>
+- HUE Light: fixed settings of some behaviour options.<br/>
+- You can now query the HUE Light node stati, via a "read" telegram sent to the KNX stati group address. ("Status" is Latin, not English, so the plural is "stati" and not "statuses" nor "status"). Other HUE nodes will follow asap.<br/>
+- Fixed some little bugs.<br/>
+- Fixed an issue where in some circumstances, the HUE Light turn off by itself.<br/>
+- WARNING: the new HUE Light options are to be considered **BETA (= in testing with user feedback)**.<br/>
+
 **Version 2.2.24** - November 2023<br/>
 - HUE Light: added DPT 9.002 for direct kelvin selection, with HUE range (2000K-6535K). There is another DPT 7.600 with the KNX scale (0K-6553K) avaiable.<br/>
 - NEW: HUE Light: now you can choose the "switch on" behaviour between color and temperature (in Kelvin) + brightness.<br/>

package/nodes/hue-config.js

@@ -111,29 +111,30 @@ module.exports = (RED) => {
       });
       // Connected
       node.hueManager.on("connected", () => {
-        node.linkStatus = "connected";
-        // Start the timer to do initial read.
-        if (node.timerDoInitialRead !== null) clearTimeout(node.timerDoInitialRead);
-        node.timerDoInitialRead = setTimeout(() => {
-          (async () => {
-            try {
-              await node.loadResourcesFromHUEBridge();
-            } catch (error) {
-              node.linkStatus = "disconnected";
-              node.nodeClients.forEach((_oClient) => {
-                setTimeout(() => {
-                  _oClient.setNodeStatusHue({
-                    fill: "red",
-                    shape: "ring",
-                    text: "HUE",
-                    payload: error.message,
-                  });
-                }, 1000);
-              });
-            }
-            node.startWatchdogTimer();
-          })();
-        }, 6000); // 17/02/2020 Do initial read of all nodes requesting initial read
+        if (node.linkStatus === "disconnected") {
+          node.linkStatus = "connected";
+          // Start the timer to do initial read.
+          if (node.timerDoInitialRead !== null) clearTimeout(node.timerDoInitialRead);
+          node.timerDoInitialRead = setTimeout(() => {
+            (async () => {
+              try {
+                await node.loadResourcesFromHUEBridge();
+              } catch (error) {
+                node.linkStatus = "disconnected";
+                node.nodeClients.forEach((_oClient) => {
+                  setTimeout(() => {
+                    _oClient.setNodeStatusHue({
+                      fill: "red",
+                      shape: "ring",
+                      text: "HUE",
+                      payload: error.message,
+                    });
+                  }, 1000);
+                });
+              }
+            })();
+          }, 6000); // 17/02/2020 Do initial read of all nodes requesting initial read
+        }
       });
 
       node.hueManager.on("disconnected", () => {
@@ -204,6 +205,25 @@ module.exports = (RED) => {
       //})();
     };
 
+    node.getFirstLightInGroup = function getFirstLightInGroup(_groupID) {
+      if (node.hueAllResources === undefined) return;
+      // Find the group
+      const group = node.hueAllResources.filter((a) => a.id === _groupID)[0];
+      if (group === null || group === undefined) return;
+      const owner = node.hueAllResources.filter((a) => a.id === group.owner.rid)[0];
+      if (owner.children !== undefined && owner.children.length > 0) {
+        const firstLightId = owner.children.find((a) => a.rtype === "light").rid;
+        if (firstLightId !== undefined && firstLightId !== null) {
+          const firstLight = node.hueAllResources.find((a) => a.id === firstLightId);
+          if (firstLight !== null && firstLight !== undefined) {
+            return firstLight;
+          } else {
+            return;
+          }
+        }
+      }
+    };
+
     // Returns the cached devices (node.hueAllResources) by type.
     node.getResources = function getResources(_rtype) {
       try {
@@ -425,6 +445,7 @@ module.exports = (RED) => {
         if (serverNode === null) {
           RED.log.error(`Warn KNXUltimateGetResourcesHUE serverNode is null`);
           res.json({ devices: `serverNode not set` });
+          return;
         }
         const jRet = serverNode.getResources(req.query.rtype);
         if (jRet !== undefined) {

package/nodes/knxUltimate-config.js

@@ -1244,7 +1244,7 @@ return msg;`,
                   devicename: msg.devicename,
                 });
                 input.handleSend(msg);
-              } else if (input.topic == _dest) {
+              } else if (input.topic === _dest) {
                 // 04/02/2020 Watchdog implementation
                 if (input.hasOwnProperty("isWatchDog")) {
                   // Is a watchdog node
@@ -1333,7 +1333,7 @@ return msg;`,
                   devicename: msg.devicename,
                 });
                 input.handleSend(msg);
-              } else if (input.topic == _dest) {
+              } else if (input.topic === _dest) {
                 // 04/02/2020 Watchdog implementation
                 if (input.hasOwnProperty("isWatchDog")) {
                   // Is a watchdog node

package/nodes/knxUltimateHueLight.html

@@ -105,6 +105,27 @@
       var oNodeServer = RED.nodes.node($("#node-input-server").val()); // Store the config-node
       var oNodeServerHue = RED.nodes.node($("#node-input-serverHue").val()); // Store the config-node
 
+      // TIMER BLINK ####################################################
+      let blinkStatus = 2;
+      let timerBlinkBackground;
+      function blinkBackground(_elementIDwithHashAtTheBeginning) {
+        if (timerBlinkBackground !== undefined) clearInterval(timerBlinkBackground);
+        timerBlinkBackground = setInterval(() => {
+          if (isEven(blinkStatus)) $(_elementIDwithHashAtTheBeginning).css("background-color", "lightgreen");
+          if (!isEven(blinkStatus)) $(_elementIDwithHashAtTheBeginning).css("background-color", "");
+          blinkStatus += 1;
+          if (blinkStatus >= 14) {
+            clearInterval(timerBlinkBackground);
+            blinkStatus = 2;
+            $(_elementIDwithHashAtTheBeginning).css("background-color", "");
+          }
+        }, 100);
+      }
+      function isEven(n) {
+        return (n % 2 == 0);
+      }
+      // ################################################################
+
       $("#tabs").tabs(); // Tabs gestione KNX
 
       // 19/02/2020 Used to get the server sooner als deploy.
@@ -259,6 +280,7 @@
         if ($("#node-input-specifySwitchOnBrightness").val() === "yes") {
           $("#divColorsAtSwitchOn").show();
           $("#divTemperatureAtSwitchOn").hide();
+          blinkBackground("#colorPickerDay");
         } else if ($("#node-input-specifySwitchOnBrightness").val() === "temperature") {
           $("#divColorsAtSwitchOn").hide();
           $("#divTemperatureAtSwitchOn").show();
@@ -290,6 +312,8 @@
           $("#divCCSBoxAtNightLighting").css({ border: "1px solid dimgrey", "border-radius": "12px", padding: "5px" }); // Add little box to better understand the property page
           $("#divColorsAtSwitchOnNightTime").show();
           $("#divTemperatureAtSwitchOnNightTime").hide();
+          blinkBackground("#colorPickerNight")
+          $("#getColorAtSwitchOnDayTimeButton").text("Get again");
         } else if ($("#node-input-enableDayNightLighting").val() === "temperature") {
           $("#divEnableDayNightLighting").show();
           $("#divCCSBoxAtNightLighting").css({ border: "1px solid dimgrey", "border-radius": "12px", padding: "5px" }); // Add little box to better understand the property page
@@ -385,10 +409,7 @@
         $.getJSON(sQuery + "?id=" + $("#node-input-hueDevice").val().split("#")[0], (data) => {
           $("#node-input-colorAtSwitchOnDayTime").val(data);
           $("#colorPickerDay").val(data);
-          $("#colorPickerDay").css("background-color", "lightgreen");
-          setTimeout(() => {
-            $("#colorPickerDay").css("background-color", "");
-          }, 500);
+          blinkBackground("#colorPickerDay")
           $("#getColorAtSwitchOnDayTimeButton").text("Get again");
         });
       });
@@ -402,10 +423,7 @@
         $.getJSON(sQuery + "?id=" + $("#node-input-hueDevice").val().split("#")[0], (data) => {
           $("#node-input-colorAtSwitchOnNightTime").val(data);
           $("#colorPickerNight").val(data);
-          $("#colorPickerNight").css("background-color", "lightgreen");
-          setTimeout(() => {
-            $("#colorPickerNight").css("background-color", "");
-          }, 500);
+          blinkBackground("#colorPickerNight")
           $("#getColorAtSwitchOnNightTimeButton").text("Get again");
         });
       });
@@ -924,7 +942,7 @@
         <i class="fa fa-tag"></i> KNX Brightness Status
       </label>
       <select id="node-input-updateKNXBrightnessStatusOnHUEOnOff">
-        <option value="onhueoff">When HUE light is Off, send 0% (Default KNX behaviour)</option>
+        <option value="onhueoff">When HUE light is Off send 0%. When HUE On, restore previous value (Default KNX behaviour)</option>
         <option value="no">Leave as is (default HUE behaviour)</option>
       </select>
     </div>
@@ -1103,9 +1121,9 @@ Start typing in the GA field, the name or group address of your KNX device, the
 
 | Property                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| KNX Brightness Status                     | Updates the KNX brightness group address status, whenever the HUE lamp is switched ON/OFF. The options are **When HUE light is Off, send 0% (Default KNX behaviour)** and **Leave as is (default HUE behaviour)**                                                                                                                                                                                                                                                                                                |
-| Switch on behaviour                       | It sets the behaviour of your lights when switched on. You can choose from differents behaviours.<br/>**Select color:** the light will be switched on with the color of your choice.<br/>**Select temperature and brightness:** the light will be switched on with the temperature (Kelvin) and brightness (0-100) of your choice.<br>**Last status:** the light will be switched on in the last status. |
-| Night Lighting                            | It allows to set a particular light color/brightness at nighttime. If **checked**, a further set of option shows up and the light changes the behaviour based on these options, everytime you switch the light _on_.                                                                                                                                                                                                                                                                                 |
+| KNX Brightness Status                     | Updates the KNX brightness group address status, whenever the HUE lamp is switched ON/OFF. The options are **When HUE light is Off send 0%. When HUE On, restore previous value (Default KNX behaviour)** and **Leave as is (default HUE behaviour)**. If you have KNX dimmer with brightness status, like MDT, the suggested option is ***When HUE light is Off send 0%. When HUE On, restore previous value (Default KNX behaviour)*** |
+| Switch on behaviour                       | It sets the behaviour of your lights when switched on. You can choose from differents behaviours.<br/>**Select color:** the light will be switched on with the color of your choice. To change color, just CLICK on the color selector (under the *Select color* control).<br/>**Select temperature and brightness:** the light will be switched on with the temperature (Kelvin) and brightness (0-100) of your choice.<br>**Last status:** the light will be switched on in the last status. |
+| Night Lighting                            | It allows to set a particular light color/brightness at nighttime. The options are the same as the daytime. You could select either a temperature/brightness or color. A cozy temperature of 2700 Kelvin, with a brightness of 10% or 20%, is a good choice for  bathroom's night light.|
 | Day/Night                                 | Select the group address used to set the day/night behaviour. The group address value is _true_ if daytime, _false_ if nighttime.                                                                                                                                                                                                                                                                                                                                                                    |
 | Invert day/night values                   | Invert the values of _Day/Night_ group address. Default value is **unchecked**.                                                                                                                                                                                                                                                                                                                                                                                                                      |
 | Dim Speed (ms)                            | The dimming speed, in Milliseconds. This applies to the **light** and also to the **tunable white** dimming datapoints. It' calculated from 0% to 100%.                                                                                                                                                                                                                                                                                                                                              |

package/nodes/knxUltimateHueLight.js

@@ -15,7 +15,7 @@ module.exports = function (RED) {
     node.name = config.name === undefined ? "Hue" : config.name;
     node.outputtopic = node.name;
     node.dpt = "";
-    node.notifyreadrequest = false;
+    node.notifyreadrequest = true;
     node.notifyreadrequestalsorespondtobus = "false";
     node.notifyreadrequestalsorespondtobusdefaultvalueifnotinitialized = "";
     node.notifyresponse = false;
@@ -335,6 +335,36 @@ module.exports = function (RED) {
           default:
             break;
         }
+
+        // I must respond to query requests (read request) sent from the KNX BUS
+
+        if (msg.knx.event === "GroupValue_Read" && node.currentHUEDevice !== undefined) {
+          let ret;
+          switch (msg.knx.destination) {
+            case config.GALightState:
+              ret = node.currentHUEDevice.on.on;
+              if (ret !== undefined) node.updateKNXLightState(ret, "response");
+              break;
+            case config.GALightColorState:
+              ret = node.currentHUEDevice.color.xy;
+              if (ret !== undefined) node.updateKNXLightColorState(node.currentHUEDevice.color, "response");
+              break;
+            case config.GALightHSVState:
+              ret = node.currentHUEDevice.color_temperature.mirek;
+              if (ret !== undefined) node.updateKNXLightHSVState(ret, "response");
+              break;
+            case config.GALightBrightnessState:
+              ret = node.currentHUEDevice.dimming.brightness;
+              if (ret !== undefined) node.updateKNXBrightnessState(ret, "response");
+              break;
+            case config.GALightKelvinState:
+              ret = node.currentHUEDevice.color_temperature.mirek;
+              if (ret !== undefined) node.updateKNXLightKelvinState(ret, "response");
+              break;
+            default:
+              break;
+          }
+        }
       } catch (error) {
         node.status({
           fill: "red",
@@ -464,6 +494,22 @@ module.exports = function (RED) {
           // Output the msg to the flow
           node.send(_event);
 
+          // As grouped_light doesn't contain all requested properties, i find the first light in the group, and use this below in the code
+          // If the event type is grouped light, and there are missing properties, i infer these missing properties from the first light in the group!
+          if ((_event.hasOwnProperty("color") || _event.hasOwnProperty("dimming")) && _event.type === 'grouped_light') {
+            try {
+              const firstLightInGroup = node.serverHue.getFirstLightInGroup(_event.id);
+              if (firstLightInGroup !== null && firstLightInGroup !== undefined) {
+                if (_event.color === undefined || Object.keys(_event.color).length === 0) {
+                  _event.color = firstLightInGroup.color;
+                }
+                if (_event.color_temperature === undefined || Object.keys(_event.color_temperature).length === 0) {
+                  _event.color_temperature = firstLightInGroup.color_temperature;
+                }
+              }
+            } catch (error) { }
+          }
+
           if (_event.hasOwnProperty("on")) {
             node.updateKNXLightState(_event.on.on);
             // In case of switch off, set the dim to zero
@@ -472,17 +518,16 @@ module.exports = function (RED) {
               && (config.updateKNXBrightnessStatusOnHUEOnOff === undefined || config.updateKNXBrightnessStatusOnHUEOnOff === "onhueoff")
             ) {
               node.updateKNXBrightnessState(0);
-              node.currentHUEDevice.dimming.brightness = 0;
+              //node.currentHUEDevice.dimming.brightness = 0;
             }
             node.currentHUEDevice.on.on = _event.on.on;
           }
+
           if (_event.hasOwnProperty("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;
-            }
+            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
@@ -521,7 +566,7 @@ module.exports = function (RED) {
     };
 
     // Leave the name after "function", to avoid <anonymous function> in the stack trace, in caso of errors.
-    node.updateKNXBrightnessState = function updateKNXBrightnessState(_value) {
+    node.updateKNXBrightnessState = function updateKNXBrightnessState(_value, _outputtype = "write") {
       if (config.GALightBrightnessState !== undefined && config.GALightBrightnessState !== "") {
         const knxMsgPayload = {};
         knxMsgPayload.topic = config.GALightBrightnessState;
@@ -529,13 +574,15 @@ module.exports = function (RED) {
         knxMsgPayload.payload = _value;
         // Send to KNX bus
         if (knxMsgPayload.topic !== "" && knxMsgPayload.topic !== undefined) {
-          node.server.writeQueueAdd({
-            grpaddr: knxMsgPayload.topic,
-            payload: knxMsgPayload.payload,
-            dpt: knxMsgPayload.dpt,
-            outputtype: "write",
-            nodecallerid: node.id,
-          });
+          if (node.server !== null && node.server !== undefined) {
+            node.server.writeQueueAdd({
+              grpaddr: knxMsgPayload.topic,
+              payload: knxMsgPayload.payload,
+              dpt: knxMsgPayload.dpt,
+              outputtype: _outputtype,
+              nodecallerid: node.id,
+            });
+          }
         }
         node.setNodeStatusHue({
           fill: "blue",
@@ -546,7 +593,7 @@ module.exports = function (RED) {
       }
     };
 
-    node.updateKNXLightState = function updateKNXBrightnessState(_value) {
+    node.updateKNXLightState = function updateKNXLightState(_value, _outputtype = "write") {
       try {
         const knxMsgPayload = {};
         knxMsgPayload.topic = config.GALightState;
@@ -557,13 +604,15 @@ module.exports = function (RED) {
           // Check not to have already sent the value
           // Send to KNX bus
           if (knxMsgPayload.topic !== "" && knxMsgPayload.topic !== undefined) {
-            node.server.writeQueueAdd({
-              grpaddr: knxMsgPayload.topic,
-              payload: knxMsgPayload.payload,
-              dpt: knxMsgPayload.dpt,
-              outputtype: "write",
-              nodecallerid: node.id,
-            });
+            if (node.server !== null && node.server !== undefined) {
+              node.server.writeQueueAdd({
+                grpaddr: knxMsgPayload.topic,
+                payload: knxMsgPayload.payload,
+                dpt: knxMsgPayload.dpt,
+                outputtype: _outputtype,
+                nodecallerid: node.id,
+              });
+            }
           }
           node.setNodeStatusHue({
             fill: "blue",
@@ -577,7 +626,7 @@ module.exports = function (RED) {
       }
     };
 
-    node.updateKNXLightHSVState = function updateKNXLightState(_value) {
+    node.updateKNXLightHSVState = function updateKNXLightHSVState(_value, _outputtype = "write") {
       if (config.GALightHSVState !== undefined && config.GALightHSVState !== "") {
         const knxMsgPayload = {};
         knxMsgPayload.topic = config.GALightHSVState;
@@ -588,13 +637,15 @@ module.exports = function (RED) {
         }
         // Send to KNX bus
         if (knxMsgPayload.topic !== "" && knxMsgPayload.topic !== undefined) {
-          node.server.writeQueueAdd({
-            grpaddr: knxMsgPayload.topic,
-            payload: knxMsgPayload.payload,
-            dpt: knxMsgPayload.dpt,
-            outputtype: "write",
-            nodecallerid: node.id,
-          });
+          if (node.server !== null && node.server !== undefined) {
+            node.server.writeQueueAdd({
+              grpaddr: knxMsgPayload.topic,
+              payload: knxMsgPayload.payload,
+              dpt: knxMsgPayload.dpt,
+              outputtype: _outputtype,
+              nodecallerid: node.id,
+            });
+          }
         }
         node.setNodeStatusHue({
           fill: "blue",
@@ -605,7 +656,7 @@ module.exports = function (RED) {
       }
     };
 
-    node.updateKNXLightColorState = function updateKNXLightColorState(_value) {
+    node.updateKNXLightColorState = function updateKNXLightColorState(_value, _outputtype = "write") {
       if (config.GALightColorState !== undefined && config.GALightColorState !== "") {
         const knxMsgPayload = {};
         knxMsgPayload.topic = config.GALightColorState;
@@ -615,15 +666,18 @@ module.exports = function (RED) {
           _value.xy.y,
           node.currentHUEDevice !== undefined ? node.currentHUEDevice.dimming.brightness : 100,
         );
+        knxMsgPayload.payload = { red: knxMsgPayload.payload.r, green: knxMsgPayload.payload.g, blue: knxMsgPayload.payload.b };
         // Send to KNX bus
         if (knxMsgPayload.topic !== "" && knxMsgPayload.topic !== undefined) {
-          node.server.writeQueueAdd({
-            grpaddr: knxMsgPayload.topic,
-            payload: knxMsgPayload.payload,
-            dpt: knxMsgPayload.dpt,
-            outputtype: "write",
-            nodecallerid: node.id,
-          });
+          if (node.server !== null && node.server !== undefined) {
+            node.server.writeQueueAdd({
+              grpaddr: knxMsgPayload.topic,
+              payload: knxMsgPayload.payload,
+              dpt: knxMsgPayload.dpt,
+              outputtype: _outputtype,
+              nodecallerid: node.id,
+            });
+          }
         }
         node.setNodeStatusHue({
           fill: "blue",
@@ -634,7 +688,7 @@ module.exports = function (RED) {
       }
     };
 
-    node.updateKNXLightKelvinState = function updateKNXLightKelvinState(_value) {
+    node.updateKNXLightKelvinState = function updateKNXLightKelvinState(_value, _outputtype = "write") {
       if (config.GALightKelvinState !== undefined && config.GALightKelvinState !== "") {
         const knxMsgPayload = {};
         knxMsgPayload.topic = config.GALightKelvinState;
@@ -646,13 +700,15 @@ module.exports = function (RED) {
         }
         // Send to KNX bus
         if (knxMsgPayload.topic !== "" && knxMsgPayload.topic !== undefined) {
-          node.server.writeQueueAdd({
-            grpaddr: knxMsgPayload.topic,
-            payload: knxMsgPayload.payload,
-            dpt: knxMsgPayload.dpt,
-            outputtype: "write",
-            nodecallerid: node.id,
-          });
+          if (node.server !== null && node.server !== undefined) {
+            node.server.writeQueueAdd({
+              grpaddr: knxMsgPayload.topic,
+              payload: knxMsgPayload.payload,
+              dpt: knxMsgPayload.dpt,
+              outputtype: _outputtype,
+              nodecallerid: node.id,
+            });
+          }
 
           node.setNodeStatusHue({
             fill: "blue",

package/nodes/utils/hueEngine.js

@@ -104,7 +104,7 @@ class classHUE extends EventEmitter {
       try {
         this.Connect();
       } catch (error) { }
-    }, 300000);
+    }, 10 * (60 * 1000)); // 10 minutes
   };
 
   // Handle the send queue

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "2.2.24",
+  "version": "2.2.25",
   "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",
@@ -19,6 +19,7 @@
     "simple-get": "4.0.1",
     "xml2js": "0.6.0"
   },
+  
   "node-red": {
     "version": ">=2.0.0",
     "nodes": {