node-red-contrib-knx-ultimate 2.4.5-beta.2 → 2.4.5-beta.3

package/CHANGELOG.md

@@ -6,6 +6,10 @@
 
 # CHANGELOG
 
+**Version 2.4.5-beta.3 PUBLIC BETA** - Feb 2024<br/>
+- HUE: Fixed "read at startup" option, not working for some HUE nodes.<br/>
+- NEW: HUE: added node Zigbee Connectivity.<br/>
+
 **Version 2.4.5-beta.2 PUBLIC BETA** - Feb 2024<br/>
 - Fix the listing of ethernet interfaces in the gateway config window.<br/>
 

package/nodes/hue-config.js

@@ -123,13 +123,6 @@ module.exports = (RED) => {
         node.hueAllResources = await node.hueManager.hueApiV2.get("/resource");
         if (node.hueAllResources !== undefined) {
           node.hueAllRooms = node.hueAllResources.filter((a) => a.type === "room");
-
-          // Get zigbee_connectivituy
-          // const bridgeId = node.hueAllResources.filter((a) => a.bridge_id === config.bridgeid).owner.rid;
-          // const zigbee_ConnectivityID = node.hueAllResources.filter((a) => a.id === bridgeId).services.filter((a) => a.rtype === "zigbee_connectivity").rid;
-          // // connected, disconnected, connectivity_issue, unidirectional_incoming
-          // const oZigbeeConnectivityStatus = node.hueAllResources.filter((a) => a.id === zigbee_ConnectivityID).status;
-
           // Update all KNX State of the nodes with the new hue device values
           node.nodeClients.forEach((_node) => {
             if (_node.hueDevice !== undefined && node.hueAllResources !== undefined) {
@@ -139,10 +132,12 @@ module.exports = (RED) => {
                 _node.setNodeStatusHue({
                   fill: "green",
                   shape: "ring",
-                  text: "Ready :-)",
+                  text: "Ready",
                 });
                 _node.currentHUEDevice = cloneDeep(oHUEDevice); // Copy by Value and not by ref
-                if (_node.initializingAtStart === true) _node.handleSendHUE(oHUEDevice); // Pass by value
+                if (_node.initializingAtStart === true) {
+                  _node.handleSendHUE(oHUEDevice); // Pass by value
+                }
               }
             }
           });
@@ -307,6 +302,21 @@ module.exports = (RED) => {
                 id: resource.id,
               });
             }
+            if (_rtype === "zigbee_connectivity") {
+              const Room = node.hueAllRooms.find((room) => room.children.find((child) => child.rid === resource.owner.rid));
+              const linkedDevName = node.hueAllResources.find((dev) => dev.type === "device" && dev.services.find((serv) => serv.rid === resource.id)).metadata.name || "";
+              retArray.push({
+                name: `Zigbee Connectivity: ${linkedDevName}${Room !== undefined ? `, room ${Room.metadata.name}` : ""}`,
+                id: resource.id,
+              });
+              // Get zigbee_connectivituy
+              // const bridgeId = node.hueAllResources.filter((a) => a.bridge_id === config.bridgeid).owner.rid;
+              // const zigbee_ConnectivityID = node.hueAllResources.filter((a) => a.id === bridgeId).services.filter((a) => a.rtype === "zigbee_connectivity").rid;
+              // // connected, disconnected, connectivity_issue, unidirectional_incoming
+              // const oZigbeeConnectivityStatus = node.hueAllResources.filter((a) => a.id === zigbee_ConnectivityID).status;
+              //const zigbee = node.hueAllResources.filter((a) => a.services !== undefined).find((a) => a.services.rtype === "zigbee_connectivity");
+              //const devs = zigbee.filter((a) => a.rtype === "zigbee_connectivity");
+            }
           } catch (error) {
             retArray.push({
               name: `${_rtype}: ERROR ${error.message}`,

package/nodes/knxUltimateHueBattery.js

@@ -23,7 +23,7 @@ module.exports = function (RED) {
     node.formatnegativevalue = 'leave';
     node.formatdecimalsvalue = 2;
     node.hueDevice = config.hueDevice;
-    node.initializingAtStart = !((config.readStatusAtStartup === undefined || config.readStatusAtStartup === "yes"));
+    node.initializingAtStart = (config.readStatusAtStartup === undefined || config.readStatusAtStartup === "yes");
     node.currentDeviceValue = 0;
 
     // Used to call the status update from the config node.

package/nodes/knxUltimateHueLightSensor.js

@@ -23,7 +23,7 @@ module.exports = function (RED) {
     node.formatnegativevalue = 'leave';
     node.formatdecimalsvalue = 2;
     node.hueDevice = config.hueDevice;
-    node.initializingAtStart = !((config.readStatusAtStartup === undefined || config.readStatusAtStartup === "yes"));
+    node.initializingAtStart = (config.readStatusAtStartup === undefined || config.readStatusAtStartup === "yes");
     node.currentDeviceValue = 0;
 
     // Used to call the status update from the config node.

package/nodes/knxUltimateHueScene.html

@@ -42,7 +42,7 @@
             if (Number(this.selectedModeTabNumber) === 0) return this.name;
             if (Number(this.selectedModeTabNumber) === 1) return this.namesceneMulti;
         },
-        paletteLabel: "Hue Scene (Beta)",
+        paletteLabel: "Hue Scene",
         // button: {
         //     enabled: function() {
         //         // return whether or not the button is enabled, based on the current

package/nodes/knxUltimateHueTemperatureSensor.js

@@ -23,7 +23,7 @@ module.exports = function (RED) {
     node.formatnegativevalue = 'leave';
     node.formatdecimalsvalue = 2;
     node.hueDevice = config.hueDevice;
-    node.initializingAtStart = !((config.readStatusAtStartup === undefined || config.readStatusAtStartup === "yes"));
+    node.initializingAtStart = (config.readStatusAtStartup === undefined || config.readStatusAtStartup === "yes");
     node.currentDeviceValue = 0;
 
     // Used to call the status update from the config node.

package/nodes/knxUltimateHueZigbeeConnectivity.html

@@ -0,0 +1,267 @@
+<script type="text/javascript" src="resources/node-red-contrib-knx-ultimate/11f26b4500.js"></script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('knxUltimateHueZigbeeConnectivity', {
+        category: "KNX Ultimate",
+        color: '#C0C7E9',
+        defaults: {
+            //buttonState: {value: true},
+            server: { type: "knxUltimate-config", required: false },
+            serverHue: { type: "hue-config", required: true },
+            name: { value: "" },
+
+            namezigbeeconnectivity: { value: "" },
+            GAzigbeeconnectivity: { value: "" },
+            dptzigbeeconnectivity: { value: "" },
+            readStatusAtStartup: { value: "yes" },
+
+
+            hueDevice: { value: "" }
+        },
+        inputs: 0,
+        outputs: 1,
+        icon: "node-hue-icon.svg",
+        label: function () {
+            return (this.name);
+        },
+        paletteLabel: "Hue Zigbee Connectivity",
+        // button: {
+        //     enabled: function() {
+        //         // return whether or not the button is enabled, based on the current
+        //         // configuration of the node
+        //         return !this.changed
+        //     },
+        //     visible: function() {
+        //         // return whether or not the button is visible, based on the current
+        //         // configuration of the node
+        //         return this.hasButton
+        //     },
+        //     //toggle: "buttonState",
+        //     onclick: function() {}
+        // },
+        oneditprepare: function () {
+            var node = this;
+            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
+
+            // 19/02/2020 Used to get the server sooner als deploy.
+            $("#node-input-server").change(function () {
+                try {
+                    oNodeServer = RED.nodes.node($(this).val());
+                } catch (error) { }
+            });
+            // 19/02/2020 Used to get the server sooner als deploy.
+            $("#node-input-serverHue").change(function () {
+                try {
+                    oNodeServerHue = RED.nodes.node($(this).val());
+                } catch (error) { }
+            });
+
+            // 31/03/2020 Search Helper
+            function fullSearch(sourceText, searchString) {
+                // This searches for all words in a string
+                var aSearchWords = searchString.toLowerCase().split(" ");
+                var i = 0;
+                for (let index = 0; index < aSearchWords.length; index++) {
+                    if (sourceText.toLowerCase().indexOf(aSearchWords[index]) > -1) i += 1;
+                }
+                return i == aSearchWords.length;
+            }
+
+            // DPT 
+            // ########################
+            $.getJSON('knxUltimateDpts?serverId=' + $("#node-input-server").val(), (data) => {
+                data.forEach(dpt => {
+                    if (dpt.value.startsWith("1.")) {
+                        $("#node-input-dptzigbeeconnectivity").append($("<option></option>")
+                            .attr("value", dpt.value)
+                            .text(dpt.text))
+                    }
+                });
+                $("#node-input-dptzigbeeconnectivity").val(this.dptzigbeeconnectivity)
+            })
+
+            // Autocomplete suggestion with ETS csv File
+            $("#node-input-GAzigbeeconnectivity").autocomplete({
+                minLength: 1,
+                source: function (request, response) {
+                    //$.getJSON("csv", request, function( data, status, xhr ) {
+                    $.getJSON("knxUltimatecsv?nodeID=" + oNodeServer.id, (data) => {
+                        response($.map(data, function (value, key) {
+                            var sSearch = (value.ga + " (" + value.devicename + ") DPT" + value.dpt);
+                            if (fullSearch(sSearch, request.term + " 1.")) {
+                                return {
+                                    label: value.ga + " # " + value.devicename + " # " + value.dpt, // Label for Display
+                                    value: value.ga // Value
+                                }
+                            } else {
+                                return null;
+                            }
+                        }));
+                    });
+                }, select: function (event, ui) {
+                    // Sets Datapoint and device name automatically
+                    var sDevName = ui.item.label.split("#")[1].trim();
+                    try {
+                        sDevName = sDevName.substr(sDevName.indexOf(")") + 1).trim();
+                    } catch (error) {
+                    }
+                    $('#node-input-namezigbeeconnectivity').val(sDevName);
+                    var optVal = $("#node-input-dptzigbeeconnectivity option:contains('" + ui.item.label.split("#")[2].trim() + "')").attr('value');
+                    // Select the option value 
+                    $("#node-input-dptzigbeeconnectivity").val(optVal);
+                }
+            });
+            // ######################## 
+
+
+
+
+            // Autocomplete suggestion with HUE
+            $("#node-input-name").autocomplete({
+                minLength: 1,
+                source: function (request, response) {
+                    $.getJSON("KNXUltimateGetResourcesHUE?rtype=zigbee_connectivity&serverId=" + oNodeServerHue.id, (data) => {
+                        response($.map(data.devices, function (value, key) {
+                            //alert(JSON.stringify(value) + " "+ key)
+                            var sSearch = (value.name);
+                            if (fullSearch(sSearch, request.term)) {
+                                return {
+                                    hueDevice: value.id, // Label for Display
+                                    value: value.name // Value
+                                }
+                            } else {
+                                return null;
+                            }
+                        }));
+                    });
+                }, select: function (event, ui) {
+                    // Sets the fields
+                    $('#node-input-hueDevice').val(ui.item.hueDevice);
+                }
+            });
+
+
+            // ########################
+
+
+        },
+        oneditsave: function () {
+
+
+        },
+        oneditcancel: function () {
+
+        }
+    })
+
+</script>
+
+<script type="text/html" data-template-name="knxUltimateHueZigbeeConnectivity">
+
+
+<div class="form-row">
+    <b>HUE Zigbee Connectivity node</b>&nbsp&nbsp<span style="color:red"
+    &nbsp
+    &nbsp<i class="fa fa-youtube"></i></span>&nbsp<a target="_blank" href="https://youtu.be/jjEUI1J8bkA"><u>Youtube sample</u></a>
+    <br />
+    <br />
+    <p align="center">
+    <i class="fa-solid fa-tower-broadcast fa-beat fa-4x"></i>
+    </p>
+    <br />
+    <label for="node-input-server" >
+        <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAKnRFWHRDcmVhdGlvbiBUaW1lAEZyIDYgQXVnIDIwMTAgMjE6NTI6MTkgKzAxMDD84aS8AAAAB3RJTUUH3gYYCicNV+4WIQAAAAlwSFlzAAALEgAACxIB0t1+/AAAAARnQU1BAACxjwv8YQUAAACUSURBVHjaY2CgFZg5c+Z/ZEyWAZ8+f/6/ZsWs/xoamqMGkGrA6Wla/1+fVARjEBuGsSoGmY4eZSCNL59d/g8DIDbIAHR14OgFGQByKjIGKX5+6/T///8gGMQGiV1+/B0Fg70GIkD+RMYgxf/O5/7//2MSmAZhkBi6OrgB6Bg5DGB4ajr3f2xqsYYLSDE2THJUDg0AAAqyDVd4tp4YAAAAAElFTkSuQmCC"></img>
+        KNX GW
+    </label>
+    <input type="text" id="node-input-server" />
+</div>
+
+<div class="form-row">
+    <label for="node-input-serverHue">
+        <img src="data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAERlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAA6ABAAMAAAABAAEAAKACAAQAAAABAAAAEKADAAQAAAABAAAAEAAAAAA0VXHyAAABFUlEQVQ4EZWSsWoCQRCG1yiENEFEi6QSkjqWWoqFoBYJ+Br6JHkMn8Iibd4ihQpaJIhWNkry/ZtdGZY78Qa+m39nZ+dm9s4550awglNBluS/gVtAX6KgDclf68w2OThgfR9iT/jnoEv4TtByDThWTCDKW4SSZTf/zj9/eZbN+izTDuKGimu0vPF8B/YN8aC8LmcOj/AAn9CFTEs70Js/oGqy79C69bqJ5XbQI2kGO5N8QL9D08S8zBtBF5ZaVsznpCMoqJnVdjTpb1Db0fwIWmQV6BLXzFOYgA6/gDVfQN9bBWp2J2hdWDPoBV5FrKnAJutHikk/CHHR8i7x4iG7qQ720IYvu3GFbpHjx3pFrOFYkA354z/5bkK826phyAAAAABJRU5ErkJggg=="/>
+        HUE Bridge
+    </label>
+    <input type="text" id="node-input-serverHue" />
+</div>
+
+<br/>
+<p>
+<b>Philips HUE</b>
+</p>
+    
+<div class="form-row">
+    <label for="node-input-hueDevice" >
+        <i class="fa fa-play-circle"></i>&nbspHue Sensor</label>
+        <input type="text" id="node-input-name" placeholder="Enter your hue device name" />
+    <input type="hidden" id="node-input-hueDevice" />
+</div>
+
+<br/>
+
+<p>
+    <b>KNX</b>
+</p>
+
+    <div class="form-row">
+        <label for="node-input-namezigbeeconnectivity" style="width:100px;"><i class="fa fa-play-circle-o"></i> Status</span></label>
+
+        <label for="node-input-GAzigbeeconnectivity" style="width:20px;">GA</label>
+        <input type="text" id="node-input-GAzigbeeconnectivity" placeholder="Ex: 1/1/1" style="width:70px;margin-left: 5px; text-align: left;">
+    
+        <label for="node-input-dptzigbeeconnectivity" style="width:40px; margin-left: 0px; text-align: right;">DPT</label>
+        <select id="node-input-dptzigbeeconnectivity" style="width:140px;"></select>
+    
+        <label for="node-input-namezigbeeconnectivity" style="width:50px; margin-left: 0px; text-align: right;">Name</label>
+        <input type="text" id="node-input-namezigbeeconnectivity" style="width:200px;margin-left: 5px; text-align: left;">
+    </div>
+   
+    <div class="form-row">
+        <label style="width:180px" for="node-input-readStatusAtStartup"><i class="fa fa-play-circle"></i> Read status at startup</label>
+        <select id="node-input-readStatusAtStartup">       
+        <option value="no">No</option>
+        <option value="yes">Yes, and emit KNX telegrams.</option>
+</select>
+    </div>
+<br/>
+<br/>
+<br/>
+
+
+</script>
+
+<script type="text/markdown" data-help-name="knxUltimateHueZigbeeConnectivity">
+This node lets you get the zigbee connectivity status from your HUE device.   
+    
+Start typing the name or group address of your KNX device in the GA field, the avaiable devices start showing up while
+you're typing.
+
+**General**
+|Property|Description|
+|--|--|
+| KNX GW | Select the KNX gateway to be used |
+| HUE Bridge | Select the HUE Bridge to be used |
+| Hue Sensor | HUE sensor to be used. The avaiable devices start showing up while you're typing.|
+
+|Property|Description|
+|--|--|
+| Status | The zigbee connectivity status KNX group address. The status of this KNX group address, will change in *true* if connected, otherwise *false* |
+| Read status at startup | Read the status at startup and emit the event to the KNX bus at startup/reconnection. (Default "yes")|
+
+### Outputs
+
+1. Standard output
+: payload (boolean) : the standard output of the command.
+
+### Details
+
+`msg.payload` is used as the payload of the published message (trus/false).  
+`msg.status` contains the text representing the status. It can be: **connected, disconnected, connectivity_issue, unidirectional_incoming**.  
+
+<br />
+
+[Find it useful?](https://www.paypal.me/techtoday)
+
+<br />
+
+</script>

package/nodes/knxUltimateHueZigbeeConnectivity.js

@@ -0,0 +1,134 @@
+module.exports = function (RED) {
+  function knxUltimateHueZigbeeConnectivity(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+    node.server = RED.nodes.getNode(config.server);
+    node.serverHue = RED.nodes.getNode(config.serverHue);
+    node.topic = node.name;
+    node.name = config.name === undefined ? 'Hue' : config.name;
+    node.dpt = '';
+    node.notifyreadrequest = true;
+    node.notifyreadrequestalsorespondtobus = 'false';
+    node.notifyreadrequestalsorespondtobusdefaultvalueifnotinitialized = '';
+    node.notifyresponse = false;
+    node.notifywrite = true;
+    node.initialread = true;
+    node.listenallga = true; // Don't remove
+    node.outputtype = 'write';
+    node.outputRBE = false; // Apply or not RBE to the output (Messages coming from flow)
+    node.inputRBE = false; // Apply or not RBE to the input (Messages coming from BUS)
+    node.currentPayload = ''; // Current value for the RBE input and for the .previouspayload msg
+    node.passthrough = 'no';
+    node.formatmultiplyvalue = 1;
+    node.formatnegativevalue = 'leave';
+    node.formatdecimalsvalue = 2;
+    node.hueDevice = config.hueDevice;
+    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,
+    }) => {
+
+    };
+    // Used to call the status update from the HUE config node.
+    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()})` });
+    };
+
+    // 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.GAzigbeeconnectivity:
+            // To the KNX bus wires
+            node.sendResponseToKNX(node.currentDeviceValue);
+            break;
+          default:
+            break;
+        }
+      }
+    };
+
+    node.handleSendHUE = (_event) => {
+      try {
+        // Event status: one of connected, disconnected, connectivity_issue, unidirectional_incoming
+        if (_event.id === config.hueDevice) {
+          if (!_event.hasOwnProperty("status") || _event.status === undefined) return;
+
+          const knxMsgPayload = {};
+          knxMsgPayload.topic = config.GAzigbeeconnectivity;
+          knxMsgPayload.dpt = config.dptzigbeeconnectivity;
+
+          knxMsgPayload.payload = (_event.status === "connected");
+          // 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,
+            });
+          }
+          node.currentDeviceValue = knxMsgPayload.payload;
+          // Setup the output msg
+          knxMsgPayload.name = node.name;
+          knxMsgPayload.status = _event.status;
+          knxMsgPayload.event = 'zigbee_connectivity';
+          // Send payload
+          knxMsgPayload.rawEvent = _event;
+          node.send(knxMsgPayload);
+          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.GAzigbeeconnectivity;
+      knxMsgPayload.dpt = config.dptzigbeeconnectivity;
+
+      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);
+      node.server.addClient(node);
+    }
+    if (node.serverHue) {
+      node.serverHue.removeClient(node);
+      node.serverHue.addClient(node);
+    }
+
+    node.on('input', (msg) => {
+
+    });
+
+    node.on('close', (done) => {
+      if (node.server) {
+        node.server.removeClient(node);
+      }
+      if (node.serverHue) {
+        node.serverHue.removeClient(node);
+      }
+      done();
+    });
+  }
+  RED.nodes.registerType('knxUltimateHueZigbeeConnectivity', knxUltimateHueZigbeeConnectivity);
+};

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "2.4.5-beta.2",
+  "version": "2.4.5-beta.3",
   "description": "Control your KNX intallation via Node-Red! A bunch of KNX nodes, with integrated Philips HUE control and ETS group address importer. Easy to use and highly configurable.",
   "dependencies": {
     "binary-parser": "2.2.1",
@@ -43,7 +43,8 @@
       "knxUltimateHueLightSensor": "/nodes/knxUltimateHueLightSensor.js",
       "knxUltimateHueTemperatureSensor": "/nodes/knxUltimateHueTemperatureSensor.js",
       "knxUltimateHueScene": "/nodes/knxUltimateHueScene.js",
-      "knxUltimateHueBattery": "/nodes/knxUltimateHueBattery.js"
+      "knxUltimateHueBattery": "/nodes/knxUltimateHueBattery.js",
+      "knxUltimateHueZigbeeConnectivity": "/nodes/knxUltimateHueZigbeeConnectivity.js"
     }
   },
   "repository": {