node-red-contrib-knx-ultimate 3.0.2 → 3.0.4

package/CHANGELOG.md

@@ -6,15 +6,23 @@
 
 # CHANGELOG
 
-**Version 3.0.2** - Juli 2024<br/>
+**Version 3.0.4** - August 2024<br/>
+- Warning: Node-Red version **equals or major than 3.1.1** is needed to run this node.<br/>
+- NEW: KNX Auto Responder node: The node will respond to read request coming from the KNX BUS, with the current GA value.<br/>
+
+**Version 3.0.3** - July 2024<br/>
+- Warning: Node-Red version **equals or major than 3.1.1** is needed to run this node.<br/>
+- FIX: fix crash when no more KNX tunnels avaiable.<br/>
+
+**Version 3.0.2** - July 2024<br/>
 - Warning: Node-Red version **equals or major than 3.1.1** is needed to run this node.<br/>
 - HUE BRIDGE: added the message to DEPLOY the flow prior to proceed, when you're creating a new HUE CONFIG node.<br/>
 
-**Version 3.0.1** - Juli 2024<br/>
+**Version 3.0.1** - July 2024<br/>
 - Warning: Node-Red version **equals or major than 3.1.1** is needed to run this node.<br/>
 - FEATURE: Due to multiple users not well knowing the KNX Protocol, by default new nodes have "Auto" in the protocol field. The node will automatically detect and apply the correct protocol. This is the real AI.<br/>
 
-**Version 3.0.0** - Juli 2024<br/>
+**Version 3.0.0** - July 2024<br/>
 - Warning: Node-Red version **equals or major than 3.1.1** is needed to run this node.<br/>
 - FEATURE CAUTION: rewrote the KNX engine in Typescript. If you encounter problems, please open a gitub issue. You can revert by installing the older version 2.5.1 <br/>
 - FEATURE: KNX Ultimate node: you can now set the group address from a global, flow or $env variable, beside the standard 3-level format. <br/>

package/nodes/hue-config.js

@@ -353,6 +353,7 @@ module.exports = (RED) => {
               });
             }
           } catch (error) {
+            console.log("KNXHue-config: getResources error ", error.trace);
             retArray.push({
               name: `${_rtype}: ERROR ${error.message}`,
               id: resource.id,

package/nodes/knxUltimate-config.html

@@ -14,7 +14,7 @@
             csv: { value: "", required: false },
             KNXEthInterface: { value: "Auto" },
             KNXEthInterfaceManuallyInput: { value: "" },
-            stopETSImportIfNoDatapoint: { value: "stop" },
+            stopETSImportIfNoDatapoint: { value: "fake" },
             loglevel: { value: "error" },
             name: { value: "KNX Gateway" },
             localEchoInTunneling: { value: true },

package/nodes/knxUltimateAutoResponder.html

@@ -0,0 +1,112 @@
+<script type="text/javascript" src="resources/node-red-contrib-knx-ultimate/htmlUtils.js"></script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('knxUltimateAutoResponder', {
+        category: "KNX Ultimate",
+        color: '#C7E9C0',
+        defaults: {
+            //buttonState: {value: true},
+            server: { type: "knxUltimate-config", required: true },
+            name: { value: "Auto responder", required: false },
+            commandText: { value: '1/1/0:true\n2/2/x:Source Radio 1\n3/0/x:100\n', required: false }
+        },
+        inputs: 0,
+        outputs: 0,
+        icon: "node-knx-icon.svg",
+        label: function () {
+            return (this.name + ' (BETA)' || "Auto Responder (BETA)");
+        },
+        paletteLabel: "Auto Responder (BETA)",
+        // 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;
+            node.editor = RED.editor.createEditor({
+                id: 'node-input-editorcommandText',
+                mode: 'ace/mode/text',
+                value: node.commandText
+            });
+
+        },
+        oneditsave: function () {
+            var node = this;
+            node.commandText = node.editor.getValue();
+            node.editor.destroy();
+            delete node.editor;
+
+        },
+        oneditcancel: function () {
+            var node = this;
+            node.editor.destroy();
+            delete node.editor;
+        }
+    })
+
+</script>
+
+<script type="text/html" data-template-name="knxUltimateAutoResponder">
+
+
+<div class="form-row">
+    <b>Auto Responder</b>
+    <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>
+        Gateway
+    </label>
+    <input type="text" id="node-input-server" />
+</div>
+
+<div class="form-row">
+    <label for="node-input-name" >
+        <i class="fa fa-tag"></i> Name
+    </label>
+    <input  type="text" id="node-input-name" data-i18n="[placeholder]knxUltimateAutoResponder.node-input-name" />
+</div>
+
+<div class="form-row">
+    <label style="width:300px;" for="node-input-commandText"><i class="fa fa-tasks"></i> Respond to</label>
+    <div style="height: 250px; min-height:150px;" class="node-text-editor" id="node-input-editorcommandText"></div>
+</div>
+
+</script>
+
+<script type="text/markdown" data-help-name="knxUltimateAutoResponder">
+<p>This node will respond to read requests from the KNX BUS. If the group address to be read has no value yet, the node will respond with a default value.
+    
+[<i class="fa fa-code"></i> Here you'll find some samples](https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/-SamplesHome)
+
+**Configuration**
+|Property|Description|
+|--|--|
+| Gateway | Select the KNX gateway to be used |
+| Respond to | The node will respond to group addresses specified in this list. The format is **GA:default value**. See below for further infos. |
+
+<br/>
+
+**Accepted formats in the 'Respond to' list**
+You can use the *x* wildchard to specify all values from 0 to 257  
+You must specify a default value to be sent to the KNX BUS, if the group address hasn't yet any value.  
+**For example**  
+```` 1/1/0:true````  will send a telegram having the GA's 1/1/0 value. If the 1/1/0 hasn't yet a value, the node will respond with **true**  
+```` 2/1/x:false````  will send a telegram having the GA's 2/1/0..257 value If the GA hasn't yet a value, the node will respond with **false**  
+  
+Please take care not to do any error, because there's yet no checks on the text's list.
+<br/>
+
+[DONATE HERE, THANK YOU!](https://www.paypal.me/techtoday)
+    
+    </script>

package/nodes/knxUltimateAutoResponder.js

@@ -0,0 +1,172 @@
+module.exports = function (RED) {
+  // msg is:
+  //  // Build final input message object
+  //  return {
+  //     topic: _outputtopic
+  //     , payload: jsValue
+  //     , devicename: (typeof _devicename !== 'undefined') ? _devicename : ""
+  //     , payloadmeasureunit: sPayloadmeasureunit
+  //     , payloadsubtypevalue: sPayloadsubtypevalue
+  //     , knx:
+  //     {
+  //         event: _event
+  //         , dpt: sInputDpt
+  //         //, details: dpt
+  //         , dptdesc: sDptdesc
+  //         , source: _srcGA
+  //         , destination: _destGA
+  //         , rawValue: _Rawvalue
+  //     }
+  // };
+
+  // The node.exposedGAs is and array of:
+  // {
+  //     address,
+  //     dpt,
+  //     payload
+  // }
+
+  function knxUltimateAutoResponder(config) {
+    RED.nodes.createNode(this, config)
+    const node = this
+    node.server = RED.nodes.getNode(config.server)
+    node.topic = node.name
+    node.name = config.name === undefined ? 'Auto responder' : config.name
+    node.outputtopic = node.name
+    node.dpt = ''
+    node.notifyreadrequest = true
+    node.notifyresponse = true
+    node.notifywrite = true
+    node.initialread = false
+    node.listenallga = true
+    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.exposedGAs = [];
+    node.commandText = []; // Raw list Respond To
+    node.decodedRespondToList = [];
+
+    // Used to call the status update from the config node.
+    node.setNodeStatus = ({ fill, shape, text, payload, GA, dpt, devicename }) => {
+      // try {
+      //   if (node.server == null) { node.status({ fill: 'red', shape: 'dot', text: '[NO GATEWAY SELECTED]' }); return }
+      //   GA = GA === undefined ? '' : GA
+      //   payload = payload === undefined ? '' : payload
+      //   payload = typeof payload === 'object' ? JSON.stringify(payload) : payload
+      //   const dDate = new Date()
+      //   node.status({ fill, shape, text: GA + ' ' + payload + ' ' + text + ' (' + dDate.getDate() + ', ' + dDate.toLocaleTimeString() + ')' })
+      // } catch (error) {
+      // }
+    }
+
+    if (node.server.csv === undefined || node.server.csv === '' || node.server.csv.length === 0) {
+      node.setNodeStatus({ fill: 'red', shape: '', text: 'No ETS file imported', payload: '', dpt: '', devicename: '' });
+      return;
+    }
+
+    node.server.csv.forEach(element => {
+      node.exposedGAs.push({ address: element.ga, dpt: element.dpt, devicename: element.devicename, payload: undefined })
+    })
+
+    // Fill the filter list
+    try {
+      node.commandText = config.commandText.split('\n');
+      if (node.commandText === undefined || node.commandText.length === 0) {
+        node.setNodeStatus({ fill: 'red', shape: '', text: 'Respond to list must be filled', payload: '', dpt: '', devicename: '' });
+        return;
+      }
+    } catch (error) {
+      return;
+    }
+
+    // Decode the commandText list be exploding the format 2/x, 2/2/x
+    for (let index = 0; index < node.commandText.length; index++) {
+      const element = node.commandText[index];
+      let defaultVal = element.split(':')[1];
+      if (element.split(':')[0].includes('x')) {
+        for (let index = 0; index < 257; index++) {
+          let decAdd = element.split(':')[0].replace(/x/g, index)
+          node.decodedRespondToList.push({ address: decAdd, default: defaultVal })
+        }
+      } else {
+        node.decodedRespondToList.push({ address: element.split(':')[0], default: defaultVal })
+      }
+    }
+
+
+    // This function is called by the knx-ultimate config node, to output a msg.payload.
+    node.handleSend = msg => {
+
+      if (msg.knx !== undefined && msg.knx.event !== undefined && msg.knx.event !== "GroupValue_Read") {
+
+        // Save the value
+        try {
+          var oGa = node.exposedGAs.find(ga => ga.address === msg.knx.destination)
+        } catch (error) {
+          console.log(error)
+        }
+        if (oGa === undefined) {
+          node.exposedGAs.push({ address: msg.knx.destination, devicename: undefined, dpt: msg.knx.dpt, payload: msg.payload })
+        } else {
+          oGa.dpt = msg.knx.dpt
+          oGa.payload = msg.payload
+        }
+      } else {
+
+        // Send the response to the bus
+        var defaultValue; // Default value if no payload in the exposedGA list
+        var bFound = false;
+        // Can i handle the incoming message?
+        for (let index = 0; index < node.decodedRespondToList.length; index++) {
+          const element = node.decodedRespondToList[index];
+          if (msg.knx.destination === element.address) {
+            defaultValue = element.default;
+            bFound = true;
+            break;
+          }
+        }
+        if (!bFound) return;
+
+        try {
+          let retVal;
+          let oFoundGA = node.exposedGAs.find(ga => ga.address === msg.knx.destination);
+          if (oFoundGA === undefined) return;
+          if (oFoundGA.payload === undefined) {
+            if (defaultValue === 'true') defaultValue = true;
+            if (defaultValue === 'false') defaultValue = false;
+            retVal = defaultValue;
+          } else {
+            retVal = oFoundGA.payload;
+          }
+          if (retVal !== undefined) {
+            const dDate = new Date()
+            node.status({ fill: 'blue', shape: 'dot', text: 'Respond ' + oFoundGA.address + ' => ' + retVal + ' (' + dDate.getDate() + ', ' + dDate.toLocaleTimeString() + ')' })
+            node.server.writeQueueAdd({ grpaddr: oFoundGA.address, payload: retVal, dpt: oFoundGA.dpt || '', outputtype: 'response', nodecallerid: node.id });
+          }
+        } catch (error) {
+          console.log(error)
+        }
+      }
+    }
+
+    node.on('input', function (msg) {
+
+    })
+
+    node.on('close', function (done) {
+      if (node.timerExposedGAs !== null) clearTimeout(node.timerExposedGAs)
+      node.exposedGAs = []
+      if (node.server) {
+        node.server.removeClient(node)
+      }
+      done()
+    })
+
+    // On each deploy, unsubscribe+resubscribe
+    if (node.server) {
+      node.server.removeClient(node)
+      node.server.addClient(node)
+    }
+  }
+  RED.nodes.registerType('knxUltimateAutoResponder', knxUltimateAutoResponder)
+}

package/nodes/knxUltimateHueLight.html

@@ -1529,6 +1529,7 @@ For controlling the "V" (brightness) of the HSV, please use the standard control
 
 | Property                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Read status at startup | Read the HUE light status at node-red's startup or node-red's full deploy, and send that status to the KNX BUS |
 | 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/>**None:** the light will retain its last status. In case you've enable the night lighting, after the night time ends, the lamp will resume the color/temperature/brightness state set at day time.  |
 | 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.|

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "3.0.2",
+  "version": "3.0.4",
   "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",
@@ -11,7 +11,7 @@
     "dns-sync": "0.2.1",
     "eventsource": "2.0.2",
     "js-yaml": "4.1.0",
-    "knxultimate": ">=2.3.3",
+    "knxultimate": ">=2.3.5",
     "lodash": "4.17.21",
     "log-driver": "1.2.7",
     "mkdirp": "3.0.1",
@@ -36,6 +36,7 @@
       "knxUltimateAlerter": "/nodes/knxUltimateAlerter.js",
       "knxUltimateLoadControl": "/nodes/knxUltimateLoadControl.js",
       "knxUltimateViewer": "/nodes/knxUltimateViewer.js",
+      "knxUltimateAutoResponder": "/nodes/knxUltimateAutoResponder.js",
       "hueConfig": "/nodes/hue-config.js",
       "knxUltimateHueLight": "/nodes/knxUltimateHueLight.js",
       "knxUltimateHueButton": "/nodes/knxUltimateHueButton.js",