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

package/CHANGELOG.md

@@ -6,6 +6,21 @@
 
 # CHANGELOG
 
+**Version 2.2.27** - November 2023<br/>
+This is an interim version, to quick fix some issues. Please report any issue with HUE Nodes, on gitHub.<br/>
+- HUE Light: the UI now changes, to adapt to lamp type.<br/>
+- HUE Light: "Get current" color button, now works for grouped light as well, by reading the first light belongin to the group.<br/>
+- WARNING: the new HUE Light options are to be considered **BETA (= in testing with user feedback)**.<br/>
+
+**Version 2.2.26** - November 2023<br/>
+This is an interim version, to quick fix some issues. Please report any issue with HUE Nodes, on gitHub.<br/>
+- HUE Light: fixed some spurious node status errors.<br/>
+- HUE Light: now the brightness status is ever transmitted over the KNX bus, whenever the light is switched on.<br/>
+- HUE Battery: the node can respond to KNX read request, by sending the stored value as response to the KNX bus.<br/>
+- HUE light level: the node can respond to KNX read request, by sending the stored value as response to the KNX bus.<br/>
+- HUE temperature sensor: the node can respond to KNX read request, by sending the stored value as response to the KNX bus.<br/>
+- WARNING: the new HUE Light options are to be considered **BETA (= in testing with user feedback)**.<br/>
+
 **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/>

package/nodes/hue-config.html

@@ -18,7 +18,7 @@
             }
             $("#getinfocam").click(function () {
 
-                var myNotification = RED.notify("Please press the Link button on the HUE Bridge",
+                var myNotification = RED.notify("Please press the Link button on the HUE Bridge. Once pressed, click OK.",
                     {
                         modal: true,
                         fixed: true,
@@ -125,17 +125,15 @@
             <label for="node-config-input-clientkey"> Bridge Key</label>
             <input type="password" id="node-config-input-clientkey" placeholder="" disabled>
         </div>
+        <div class="form-row">
+            <label for="node-config-input-debug"> Bridge Key</label>
+            <input rows="20" style="width:100%" type="textarea" id="node-config-input-debug" placeholder="" disabled>
+        </div>
     </div>
     
     
 </script>
-<script type="text/markdown" data-help-name="hue-config"
-This node registers to the Hue Bridge.  
-
-Just set the Bridge's IP and click **CONNECT** button.
-
-[Find it useful?](https://www.paypal.me/techtoday)
-
-<br/>
+<script type="text/markdown" data-help-name="hue-config" This node registers to the Hue Bridge. Just set the Bridge's IP
+    and click **CONNECT** button. [Find it useful?](https://www.paypal.me/techtoday) <br />
 
 </script>

package/nodes/hue-config.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-underscore-dangle */
 /* eslint-disable no-lonely-if */
 /* eslint-disable no-param-reassign */
 /* eslint-disable no-inner-declarations */
@@ -170,10 +171,28 @@ module.exports = (RED) => {
     // Query the HUE Bridge to return the resources
     node.loadResourcesFromHUEBridge = async () => {
       if (node.linkStatus === "disconnected") return;
-      //(async () => {
+      // (async () => {
       // °°°°°° Load ALL resources
       try {
         node.hueAllResources = await node.hueManager.hueApiV2.get("/resource");
+
+        // // DEBUG
+        // try {
+        //   const fs = require('fs');
+        //   const { resolve } = require('path');
+        //   const content = JSON.stringify(node.hueAllResources);
+        //   try {
+        //     fs.writeFileSync('resources.json', content);
+        //     RED.log.info("******************************* FILE WROTE IN resources.json " + resolve("resources.json"))
+        //     // file written successfully
+        //   } catch (error) {
+        //     RED.log.error("********************************************* const content = JSON.stringify(node.hueAllResources)2222: " + error.message)
+        //   }
+        // } catch (error) {
+        //   RED.log.error("********************************************* const content = JSON.stringify(node.hueAllResources): " + error.message)
+        // }
+
+
         if (node.hueAllResources !== undefined) {
           node.hueAllRooms = node.hueAllResources.filter((a) => a.type === "room");
           // Update all KNX State of the nodes with the new hue device values
@@ -206,22 +225,21 @@ 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;
+      if (node.hueAllResources === undefined || node.hueAllResources === null) return;
+      try {
+        const group = node.hueAllResources.filter((a) => a.id === _groupID)[0];
+        const owner = node.hueAllResources.filter((a) => a.id === group.owner.rid)[0];
+        if (owner.children !== undefined) {
+          const dev = node.hueAllResources.filter((a) => a.id === owner.children[0].rid)[0];
+          if (dev.type === "device" && dev.services !== undefined) {
+            const lightID = dev.services.filter((a) => a.rtype === 'light')[0].rid;
+            const oLight = node.hueAllResources.filter((a) => a.id === lightID)[0];
+            return oLight;
+          } else if (dev.type === "light") {
+            return dev;
           }
         }
-      }
+      } catch (error) { }
     };
 
     // Returns the cached devices (node.hueAllResources) by type.
@@ -423,18 +441,64 @@ module.exports = (RED) => {
 
     RED.httpAdmin.get("/knxUltimateGetHueColor", RED.auth.needsPermission("hue-config.read"), (req, res) => {
       try {
-        const hexColor = node.getColorFromHueLight(req.query.id);
-        res.json(hexColor);
+        // find wether the light is a light or is grouped_light
+        let hexColor;
+        const _oDevice = node.hueAllResources.filter((a) => a.id === req.query.id)[0];
+        if (_oDevice.type === "light") {
+          hexColor = node.getColorFromHueLight(req.query.id);
+        } else {
+          // grouped_light, get the first light in the group
+          const oLight = node.getFirstLightInGroup(_oDevice.id);
+          hexColor = node.getColorFromHueLight(oLight.id);
+        }
+        res.json(hexColor !== undefined ? hexColor : "Select the device first!");
       } catch (error) {
         res.json("Select the device first!");
       }
     });
     RED.httpAdmin.get("/knxUltimateGetKelvinColor", RED.auth.needsPermission("hue-config.read"), (req, res) => {
       try {
-        const jKelvin = node.getKelvinFromHueLight(req.query.id);
-        res.json(jKelvin);
+        // find wether the light is a light or is grouped_light
+        let kelvinValue;
+        const _oDevice = node.hueAllResources.filter((a) => a.id === req.query.id)[0];
+        if (_oDevice.type === "light") {
+          kelvinValue = node.getKelvinFromHueLight(req.query.id);
+        } else {
+          // grouped_light, get the first light in the group
+          const oLight = node.getFirstLightInGroup(_oDevice.id);
+          kelvinValue = node.getKelvinFromHueLight(oLight.id);
+        }
+        res.json(kelvinValue !== undefined ? kelvinValue : "Select the device first!");
       } catch (error) {
         res.json("Select the device first!");
+      };
+    });
+
+    RED.httpAdmin.get("/knxUltimateGetLightObject", RED.auth.needsPermission("hue-config.read"), (req, res) => {
+      try {
+        const _lightId = req.query.id;
+        const oLight = node.hueAllResources.filter((a) => a.id === _lightId)[0];
+        // Infer some useful info, so the HTML part cann avoid to query the server
+        // Kelvin
+        try {
+          if (oLight.color_temperature !== undefined && oLight.color_temperature.mirek !== undefined) {
+            oLight.calculatedKelvin = hueColorConverter.ColorConverter.mirekToKelvin(oLight.color_temperature.mirek);
+          }
+        } catch (error) {
+          oLight.calculatedKelvin = undefined;
+        }
+        // HEX value from XYBri
+        try {
+          const retRGB = hueColorConverter.ColorConverter.xyBriToRgb(oLight.color.xy.x, oLight.color.xy.y, oLight.dimming.brightness);
+          const ret = "#" + hueColorConverter.ColorConverter.rgbHex(retRGB.r, retRGB.g, retRGB.b).toString();
+          oLight.calculatedHEXColor = ret;
+        } catch (error) {
+          oLight.calculatedHEXColor = undefined;
+        }
+        res.json(oLight);
+      } catch (error) {
+        if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error(`KNXUltimateHue: hueEngine: knxUltimateGetLightObject: error ${error.message}`);
+        res.json({});
       }
     });
 
@@ -443,7 +507,7 @@ module.exports = (RED) => {
         // °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
         const serverNode = RED.nodes.getNode(req.query.nodeID); // Retrieve node.id of the config node.
         if (serverNode === null) {
-          RED.log.error(`Warn KNXUltimateGetResourcesHUE serverNode is null`);
+          RED.log.warn(`Warn KNXUltimateGetResourcesHUE serverNode is null`);
           res.json({ devices: `serverNode not set` });
           return;
         }
@@ -457,12 +521,22 @@ module.exports = (RED) => {
       } catch (error) {
         //RED.log.error(`Errore KNXUltimateGetResourcesHUE non gestito ${error.message}`);
         res.json({ devices: error.message });
+        RED.log.error(`Err KNXUltimateGetResourcesHUE: ${error.message}`);
         // (async () => {
         //   await node.initHUEConnection();
         // })();
       }
     });
 
+    RED.httpAdmin.get("/knxUltimateGetFirstLightInGroup", RED.auth.needsPermission("hue-config.read"), (req, res) => {
+      try {
+        res.json(node.getFirstLightInGroup(req.query.id));
+      } catch (error) {
+        if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error(`KNXUltimateHue: hueEngine: knxUltimateGetFirstLightInGroup: error ${error.message}`);
+        res.json({});
+      }
+    });
+
     RED.httpAdmin.get("/knxUltimateDpts", RED.auth.needsPermission("hue-config.read"), (req, res) => {
       try {
         const dpts = Object.entries(dptlib).filter(onlyDptKeys).map(extractBaseNo).sort(sortBy("base")).reduce(toConcattedSubtypes, []);

package/nodes/knxUltimate-config.html

@@ -21,7 +21,7 @@
             ignoreTelegramsWithRepeatedFlag: { value: false, required: false },
             keyringFileXML: { value: "" },
             knxSecureSelected: { value: false },
-            autoReconnect: { value: true }
+            autoReconnect: { value: "yes" }
         },
         credentials: {
             keyringFilePassword: { type: "password" }

package/nodes/knxUltimateHueBattery.html

@@ -13,13 +13,13 @@
             namebatterysensor: { value: "" },
             GAbatterysensor: { value: "" },
             dptbatterysensor: { value: "" },
-            readStatusAtStartup: { value: "no" },
+            readStatusAtStartup: { value: "yes" },
 
 
             hueDevice: { value: "" }
         },
         inputs: 0,
-        outputs: 0,
+        outputs: 1,
         icon: "node-hue-icon.svg",
         label: function () {
             return (this.name);

package/nodes/knxUltimateHueBattery.js

@@ -7,7 +7,7 @@ module.exports = function (RED) {
     node.topic = node.name;
     node.name = config.name === undefined ? 'Hue' : config.name;
     node.dpt = '';
-    node.notifyreadrequest = false;
+    node.notifyreadrequest = true;
     node.notifyreadrequestalsorespondtobus = 'false';
     node.notifyreadrequestalsorespondtobusdefaultvalueifnotinitialized = '';
     node.notifyresponse = false;
@@ -23,7 +23,9 @@ module.exports = function (RED) {
     node.formatnegativevalue = 'leave';
     node.formatdecimalsvalue = 2;
     node.hueDevice = config.hueDevice;
-    node.initializingAtStart = !((config.readStatusAtStartup === undefined || config.readStatusAtStartup === "no"));
+    node.initializingAtStart = !((config.readStatusAtStartup === undefined || config.readStatusAtStartup === "yes"));
+    node.currentDeviceValue = 0;
+
     // Used to call the status update from the config node.
     node.setNodeStatus = ({
       fill, shape, text, payload,
@@ -42,13 +44,22 @@ module.exports = function (RED) {
 
     // This function is called by the knx-ultimate config node, to output a msg.payload.
     node.handleSend = (msg) => {
+      // Respond to KNX read telegram, by sending the current value as response telegram.
+      if (msg.knx.event === "GroupValue_Read") {
+        switch (msg.knx.destination) {
+          case config.GAbatterysensor:
+            // To the KNX bus wires
+            node.sendResponseToKNX(node.currentDeviceValue);
+            break;
+          default:
+            break;
+        }
+      }
     };
 
     node.handleSendHUE = (_event) => {
       try {
         if (_event.id === config.hueDevice) {
-
-          // IMPORTANT: exit if no event presen.
           if (!_event.hasOwnProperty("power_state") || _event.power_state.battery_level === undefined) return;
 
           const knxMsgPayload = {};
@@ -62,6 +73,7 @@ module.exports = function (RED) {
               grpaddr: knxMsgPayload.topic, payload: knxMsgPayload.payload, dpt: knxMsgPayload.dpt, outputtype: 'write', nodecallerid: node.id,
             });
           }
+          node.currentDeviceValue = knxMsgPayload.payload;
 
           // Setup the output msg
           knxMsgPayload.name = node.name;
@@ -73,13 +85,27 @@ module.exports = function (RED) {
           node.setNodeStatusHue({
             fill: 'blue', shape: 'ring', text: 'HUE->KNX', payload: knxMsgPayload.payload,
           });
-
         }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: `HUE->KNX error ${error.message} (${new Date().getDate()}, ${new Date().toLocaleTimeString()})` });
       }
     };
 
+
+    node.sendResponseToKNX = (_level) => {
+      const knxMsgPayload = {};
+      knxMsgPayload.topic = config.GAbatterysensor;
+      knxMsgPayload.dpt = config.dptbatterysensor;
+
+      knxMsgPayload.payload = _level;
+      // Send to KNX bus
+      if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) {
+        node.server.writeQueueAdd({
+          grpaddr: knxMsgPayload.topic, payload: knxMsgPayload.payload, dpt: knxMsgPayload.dpt, outputtype: 'response', nodecallerid: node.id,
+        });
+      }
+    };
+
     // On each deploy, unsubscribe+resubscribe
     if (node.server) {
       node.server.removeClient(node);

package/nodes/knxUltimateHueButton.js

@@ -194,8 +194,6 @@ module.exports = function (RED) {
         node.server.writeQueueAdd({
           grpaddr: knxMsgPayload.topic, payload: knxMsgPayload.payload, dpt: knxMsgPayload.dpt, outputtype: 'write', nodecallerid: node.id,
         });
-      }
-      if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) {
         node.setNodeStatusHue({
           fill: 'grey', shape: 'ring', text: 'HUE->KNX STOP DIM', payload: knxMsgPayload.payload,
         });