node-red-contrib-knx-ultimate 3.3.38 → 3.3.40

package/CHANGELOG.md

@@ -6,6 +6,13 @@
 
 # CHANGELOG
 
+**Version 3.3.40** - August 2025<br/>
+- KNX Peristent value files are now saved every 5 seconds, other than at the node disconnection.<br/>
+- Fixed an issue preventing the AutoResponder node to start, if the imported ETS file contains malformed structure.<br/>
+
+**Version 3.3.39** - July 2025<br/>
+- Added other snippets to the KNX Device function tab.<br/>
+
 **Version 3.3.38** - May 2025<br/>
 - FIX: fixed possible issue having tabulator chars in the group address names.<br/>
 - KNX Engine: better handling of disconnections telegrams.<br/>

package/nodes/knxUltimate-config.js

@@ -68,7 +68,6 @@ module.exports = (RED) => {
     node.KNXEthInterfaceManuallyInput = typeof config.KNXEthInterfaceManuallyInput === "undefined" ? "" : config.KNXEthInterfaceManuallyInput; // If you manually set the interface name, it will be wrote here
     node.timerDoInitialRead = null; // 17/02/2020 Timer (timeout) to do initial read of all nodes requesting initial read, after all nodes have been registered to the sercer
     node.stopETSImportIfNoDatapoint = typeof config.stopETSImportIfNoDatapoint === "undefined" ? "stop" : config.stopETSImportIfNoDatapoint; // 09/01/2020 Stop, Import Fake or Skip the import if a group address has unset datapoint
-    node.csv = readCSV(config.csv); // Array from ETS CSV Group Addresses {ga:group address, dpt: datapoint, devicename: full device name with main and subgroups}
     node.localEchoInTunneling = typeof config.localEchoInTunneling !== "undefined" ? config.localEchoInTunneling : true;
     node.userDir = path.join(RED.settings.userDir, "knxultimatestorage"); // 04/04/2021 Supergiovane: Storage for service files
     node.exposedGAs = [];
@@ -79,6 +78,8 @@ module.exports = (RED) => {
     try {
       node.sysLogger = new loggerClass({ loglevel: node.loglevel, setPrefix: node.type + " <" + (node.name || node.id || '') + ">" });
     } catch (error) { console.log(error.stack) }
+    node.csv = readCSV(config.csv); // Array from ETS CSV Group Addresses {ga:group address, dpt: datapoint, devicename: full device name with main and subgroups}
+
     // 12/11/2021 Connect at start delay
     node.autoReconnect = true; // 20/03/2022 Default
     if (config.autoReconnect === "no" || config.autoReconnect === false) {
@@ -99,6 +100,7 @@ module.exports = (RED) => {
     node.delaybetweentelegrams = (config.delaybetweentelegrams === undefined || config.delaybetweentelegrams === null || config.delaybetweentelegrams === '') ? 25 : Number(config.delaybetweentelegrams);
     if (node.delaybetweentelegrams < 25) node.delaybetweentelegrams = 25; // Protection avoiding handleKNXQueue hangs
     if (node.delaybetweentelegrams > 100) node.delaybetweentelegrams = 100; // Protection avoiding handleKNXQueue hangs
+    node.timerSaveExposedGAs = null; // Timer to save the exposed GA every once in a while
 
     // 05/12/2021 Set the protocol (this is undefined if coming from ild versions
     if (node.hostProtocol === "Auto") {
@@ -194,7 +196,7 @@ module.exports = (RED) => {
       node.sysLogger?.info("payload cache set to " + path.join(node.userDir, "knxpersistvalues"));
     }
 
-    function saveExposedGAs() {
+    async function saveExposedGAs() {
       const sFile = path.join(node.userDir, "knxpersistvalues", "knxpersist" + node.id + ".json");
       try {
         if (node.exposedGAs.length > 0) {
@@ -277,10 +279,16 @@ module.exports = (RED) => {
     // 17/02/2020 Do initial read (called by node.timerDoInitialRead timer)
     function DoInitialReadFromKNXBusOrFile() {
       if (node.linkStatus !== "connected") return; // 29/08/2019 If not connected, exit
+      node.sysLogger?.info("Do DoInitialReadFromKNXBusOrFile");
       loadExposedGAs(); // 04/04/2021 load the current values of GA payload
+      node.sysLogger?.info("Loaded persist GA values", node.exposedGAs?.length);
+
+      if (node.timerSaveExposedGAs !== null) clearInterval(node.timerSaveExposedGAs);
+      node.timerSaveExposedGAs = setInterval(async () => {
+        await saveExposedGAs();
+      }, 5000);
+      node.sysLogger?.info("Started timerSaveExposedGAs with array lenght ", node.exposedGAs?.length);
 
-      node.sysLogger?.info("Loaded saved GA values", node.exposedGAs?.length);
-      node.sysLogger?.info("Do DoInitialReadFromKNXBusOrFile");
       try {
         const readHistory = [];
 
@@ -1592,87 +1600,92 @@ module.exports = (RED) => {
         let sSecondGroupName = "";
         let sFather = "";
         for (let index = 0; index < fileGA.length; index++) {
-          let element = fileGA[index];
-          element = element.replace(/\"/g, ""); // Rimuovo le virgolette
-          element = element.replace(/\#/g, ""); // Rimuovo evetuali #
-
-          if (element !== "") {
-            // Main and secondary group names
-            if ((element.split("\t")[1].match(/-/g) || []).length == 2) {
-              // Found main group family name (Example Light Actuators)
-              sFirstGroupName = element.split("\t")[0] || "";
-              sSecondGroupName = "";
-            }
-            if ((element.split("\t")[1].match(/-/g) || []).length == 1) {
-              // Found second group family name (Example First Floor light)
-              sSecondGroupName = element.split("\t")[0] || "";
-            }
-            if (sFirstGroupName !== "" && sSecondGroupName !== "") {
-              sFather = "(" + sFirstGroupName + "->" + sSecondGroupName + ") ";
-            }
+          try {
+            let element = fileGA[index];
+            element = element.replace(/\"/g, ""); // Rimuovo le virgolette
+            element = element.replace(/\#/g, ""); // Rimuovo evetuali #
+
+            if (element !== "") {
+              // Main and secondary group names
+              if ((element.split("\t")[1].match(/-/g) || []).length == 2) {
+                // Found main group family name (Example Light Actuators)
+                sFirstGroupName = element.split("\t")[0] || "";
+                sSecondGroupName = "";
+              }
+              if ((element.split("\t")[1].match(/-/g) || []).length == 1) {
+                // Found second group family name (Example First Floor light)
+                sSecondGroupName = element.split("\t")[0] || "";
+              }
+              if (sFirstGroupName !== "" && sSecondGroupName !== "") {
+                sFather = "(" + sFirstGroupName + "->" + sSecondGroupName + ") ";
+              }
 
-            if (element.split("\t")[1].search("-") == -1 && element.split("\t")[1].search("/") !== -1) {
-              // Ho trovato una riga contenente un GA valido, cioè con 2 "/"
-              if (element.split("\t")[5] == "") {
-                if (node.stopETSImportIfNoDatapoint === "stop") {
-                  node.error(
-                    "KNXUltimate-config: ABORT IMPORT OF ETS CSV FILE. To skip the invalid datapoint and continue import, change the related setting, located in the config node in the ETS import section.",
-                  );
-                  return;
-                }
-                if (node.stopETSImportIfNoDatapoint === "fake") {
-                  // 02/03/2020 Whould you like to continue without datapoint? Good. Here a totally fake datapoint
-                  node.warn(
-                    "KNXUltimate-config: WARNING IMPORT OF ETS CSV FILE. Datapoint not set. You choosed to continue import with a fake datapoint 1.001. -> " +
-                    element.split("\t")[0] +
-                    " " +
-                    element.split("\t")[1],
-                  );
+              if (element.split("\t")[1].search("-") == -1 && element.split("\t")[1].search("/") !== -1) {
+                // Ho trovato una riga contenente un GA valido, cioè con 2 "/"
+                if (element.split("\t")[5] == "") {
+                  if (node.stopETSImportIfNoDatapoint === "stop") {
+                    node.error(
+                      "KNXUltimate-config: ABORT IMPORT OF ETS CSV FILE. To skip the invalid datapoint and continue import, change the related setting, located in the config node in the ETS import section.",
+                    );
+                    return;
+                  }
+                  if (node.stopETSImportIfNoDatapoint === "fake") {
+                    // 02/03/2020 Whould you like to continue without datapoint? Good. Here a totally fake datapoint
+                    node.warn(
+                      "KNXUltimate-config: WARNING IMPORT OF ETS CSV FILE. Datapoint not set. You choosed to continue import with a fake datapoint 1.001. -> " +
+                      element.split("\t")[0] +
+                      " " +
+                      element.split("\t")[1],
+                    );
+                    ajsonOutput.push({
+                      ga: element.split("\t")[1],
+                      dpt: "1.001",
+                      devicename: sFather + element.split("\t")[0] + " (DPT NOT SET IN ETS - FAKE DPT USED)",
+                    });
+                  } else {
+                    // 31/03/2020 Skip import
+                    node.warn(
+                      "KNXUltimate-config: WARNING IMPORT OF ETS CSV FILE. Datapoint not set. You choosed to skip -> " +
+                      element.split("\t")[0] +
+                      " " +
+                      element.split("\t")[1],
+                    );
+                  }
+                } else {
+                  const DPTa = element.split("\t")[5].split("-")[1];
+                  let DPTb = element.split("\t")[5].split("-")[2];
+                  if (typeof DPTb === "undefined") {
+                    node.warn(
+                      "KNXUltimate-config: WARNING: Datapoint not fully set (there is only the main type). I applied a default .001, but please check if i'ts ok ->" +
+                      element.split("\t")[0] +
+                      " " +
+                      element.split("\t")[1] +
+                      " Datapoint: " +
+                      element.split("\t")[5],
+                    );
+                    DPTb = "001"; // default
+                  }
+                  // Trailing zeroes
+                  if (DPTb.length == 1) {
+                    DPTb = "00" + DPTb;
+                  } else if (DPTb.length == 2) {
+                    DPTb = "0" + DPTb;
+                  }
+                  if (DPTb.length == 3) {
+                    DPTb = "" + DPTb; // stupid, but for readability
+                  }
                   ajsonOutput.push({
                     ga: element.split("\t")[1],
-                    dpt: "1.001",
-                    devicename: sFather + element.split("\t")[0] + " (DPT NOT SET IN ETS - FAKE DPT USED)",
+                    dpt: DPTa + "." + DPTb,
+                    devicename: sFather + element.split("\t")[0],
                   });
-                } else {
-                  // 31/03/2020 Skip import
-                  node.warn(
-                    "KNXUltimate-config: WARNING IMPORT OF ETS CSV FILE. Datapoint not set. You choosed to skip -> " +
-                    element.split("\t")[0] +
-                    " " +
-                    element.split("\t")[1],
-                  );
-                }
-              } else {
-                const DPTa = element.split("\t")[5].split("-")[1];
-                let DPTb = element.split("\t")[5].split("-")[2];
-                if (typeof DPTb === "undefined") {
-                  node.warn(
-                    "KNXUltimate-config: WARNING: Datapoint not fully set (there is only the main type). I applied a default .001, but please check if i'ts ok ->" +
-                    element.split("\t")[0] +
-                    " " +
-                    element.split("\t")[1] +
-                    " Datapoint: " +
-                    element.split("\t")[5],
-                  );
-                  DPTb = "001"; // default
-                }
-                // Trailing zeroes
-                if (DPTb.length == 1) {
-                  DPTb = "00" + DPTb;
-                } else if (DPTb.length == 2) {
-                  DPTb = "0" + DPTb;
                 }
-                if (DPTb.length == 3) {
-                  DPTb = "" + DPTb; // stupid, but for readability
-                }
-                ajsonOutput.push({
-                  ga: element.split("\t")[1],
-                  dpt: DPTa + "." + DPTb,
-                  devicename: sFather + element.split("\t")[0],
-                });
               }
             }
+          } catch (error) {
+            node.sysLogger?.error("readCSV " + " ROW:" + fileGA[index] + " Error:" + error.stack);
           }
+
         }
 
         return ajsonOutput;
@@ -1840,6 +1853,7 @@ module.exports = (RED) => {
     }, 10000);
 
     node.Disconnect = async (_sNodeStatus = "", _sColor = "grey") => {
+      if (node.timerSaveExposedGAs !== null) clearInterval(node.timerSaveExposedGAs);
       if (node.linkStatus === "disconnected") {
         node.sysLogger?.debug("Disconnect: already not connected:" + node.linkStatus + ", node.autoReconnect:" + node.autoReconnect);
         return;
@@ -1854,7 +1868,7 @@ module.exports = (RED) => {
         );
       }
       node.setAllClientsStatus("Disconnected", _sColor, _sNodeStatus);
-      saveExposedGAs(); // 04/04/2021 save the current values of GA payload
+      await saveExposedGAs(); // 04/04/2021 save the current values of GA payload
       node.sysLogger?.debug("Disconnected, node.autoReconnect:" + node.autoReconnect);
     };
 

package/nodes/knxUltimate.html

@@ -128,6 +128,15 @@
             $("#snippetThree").on("click", function (event) {
                 node.receiveMsgFromKNXCodeEditor.session.setValue(KNXFunctionSnippetThree);
             });
+            $("#snippetFour").on("click", function (event) {
+                node.sendMsgToKNXCodeEditor.session.setValue(KNXFunctionSnippetFour);
+            });
+            $("#snippetFive").on("click", function (event) {
+                node.sendMsgToKNXCodeEditor.session.setValue(KNXFunctionSnippetFive);
+            });
+            $("#snippetSix").on("click", function (event) {
+                node.sendMsgToKNXCodeEditor.session.setValue(KNXFunctionSnippetSix);
+            });
 
             function checkUI() {
 
@@ -746,6 +755,9 @@
                 </div>
                 <i class="fa fa-code"></i> Select a snippet to be inserted<br />
                 <button type="button" id="snippetOne" class="red-ui-button">Status GA check</button>
+                <button type="button" id="snippetFour" class="red-ui-button">Toggle value</button>
+                <button type="button" id="snippetFive" class="red-ui-button">Send false after 5 secs</button>
+                <button type="button" id="snippetSix" class="red-ui-button">Send 20% to another GA</button>
                 <hr>
                 <div class="form-row">
                     <dt>
@@ -839,7 +851,7 @@ If enabled, "f(x)" indication will be added to node's name.
 | getGAValue (string GA, optional string DPT) | Get the specified GA's value, for example **'1/0/1'**, or also **'1/0/1 Bed table light'** (All text after a blank space will be ignored by the function. This is useful if you want to add the GA name as a reminder. With the ETS file imported, you can also copy and paste the GA and GA Name directly from the **Search GA** field.). **DPT** is optional if you've imported the ETS file, otherwise you must specify it, for example '1.001'. |
 | setGAValue (string GA, any value, optional string DPT) | Set the specified GA's value. The GA con be wrote for example **'1/0/1'**, or also **'1/0/1 Bed table light'** (All text after a blank space will be ignored by the function. This is useful if you want to add the GA name as a reminder. With the ETS file imported, you can also copy and paste the GA and GA Name directly from the **Search GA** field.). The **value** is mandatory, can be a boolean or number or string, **DPT** is optional if you've imported the ETS file, otherwise you must specify it, for example '1.001'. |
 | self (any value) | Set the currend node's value and sends the value to the KNX BUS as well. For example, *self(false)*. Caution using **self** function in the *From KNX BUS to node's OUTPUT PIN* code, because the code will be executed everytime a KNX telegram is received, so you coud have recurrency loops. |
-| toggle (nothing) | Toggle the currend node's value and sends the value to the KNX BUS as well. For example, *toggle()*. Caution using **toggle** function in the *From KNX BUS to node's OUTPUT PIN* code, because the code will be executed everytime a KNX telegram is received, so you coud have recurrency loops. |
+| toggle () | Toggle the currend node's value and sends the value to the KNX BUS as well. For example, *toggle()*. Caution using **toggle** function in the *From KNX BUS to node's OUTPUT PIN* code, because the code will be executed everytime a KNX telegram is received, so you coud have recurrency loops. |
 | node (object) | The node object. |
 | RED (Node-Red object) | The Node-Red's RED object. |
 | return (msg) | Mandatory `return msg;`, if you want to emit the message. Otherwise, using `return;` will not emit any message. |

package/nodes/knxUltimate.js

@@ -121,7 +121,7 @@ module.exports = function (RED) {
     node.inputmessage = {}; // Stores the input message to be passed through
     node.timerTTLInputMessage = null; // The stored node.inputmessage has a ttl.
     try {
-      node.sysLogger = new loggerClass({ loglevel: node.serverKNX.loglevel, setPrefix: node.type + " <" + (node.name || node.id || '') + ">" });
+      node.sysLogger = new loggerClass({ loglevel: node.serverKNX.loglevel || 'error', setPrefix: node.type + " <" + (node.name || node.id || '') + ">" });
     } catch (error) { console.log(error.stack) }
     node.sendMsgToKNXCode = config.sendMsgToKNXCode || undefined;
     node.receiveMsgFromKNXCode = config.receiveMsgFromKNXCode || undefined;

package/nodes/knxUltimateAutoResponder.js

@@ -35,7 +35,7 @@ module.exports = function (RED) {
   function knxUltimateAutoResponder(config) {
     RED.nodes.createNode(this, config)
     const node = this
-    node.serverKNX = RED.nodes.getNode(config.server) || undefined
+    node.serverKNX = RED.nodes.getNode(config.server)
     node.topic = node.name
     node.name = config.name === undefined ? 'Auto responder' : config.name
     node.outputtopic = node.name
@@ -50,6 +50,9 @@ module.exports = function (RED) {
     node.inputRBE = 'false' // Apply or not RBE to the input (Messages coming from BUS)
     node.exposedGAs = [];
     node.commandText = []; // Raw list Respond To
+    node.timerSaveExposedGAs = null;
+    if (node.serverKNX === null) { node.status({ fill: 'red', shape: 'dot', text: '[NO GATEWAY SELECTED]' }); return; }
+
     try {
       node.sysLogger = new loggerClass({ loglevel: node.serverKNX.loglevel, setPrefix: node.type + " <" + (node.name || node.id || '') + ">" });
     } catch (error) { console.log(error.stack) }
@@ -66,7 +69,7 @@ module.exports = function (RED) {
       // }
     }
 
-    node.saveExposedGAs = () => {
+    node.saveExposedGAs = async () => {
       const sFile = path.join(node.serverKNX.userDir, "knxpersistvalues", "knxpersist" + node.id + ".json");
       try {
         if (node.exposedGAs.length > 0) {
@@ -77,6 +80,7 @@ module.exports = function (RED) {
         if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error("knxUltimateAutoResponder: unable to write peristent values to the file " + sFile + " " + err.message);
       }
     }
+
     node.loadExposedGAs = () => {
       const sFile = path.join(node.serverKNX.userDir, "knxpersistvalues", "knxpersist" + node.id + ".json");
       try {
@@ -94,10 +98,14 @@ module.exports = function (RED) {
       node.exposedGAs.forEach(element => {
         element.enabled = false;
       })
+      if (node.timerSaveExposedGAs !== null) clearInterval(node.timerSaveExposedGAs);
+      node.sysLogger?.info("Started timerSaveExposedGAs with array lenght ", node.exposedGAs?.length);
+      node.timerSaveExposedGAs = setInterval(async () => {
+        await node.saveExposedGAs();
+      }, 5000);
     } catch (error) {
     }
 
-
     // Add the ETS CSV file list to exposedGAs
     if (node.serverKNX.csv === undefined || node.serverKNX.csv === '' || node.serverKNX.csv.length === 0) {
       node.status({ fill: 'grey', shape: 'ring', text: 'No ETS file imported', payload: '', dpt: '', devicename: '' });
@@ -219,6 +227,7 @@ module.exports = function (RED) {
 
     node.on('close', function (done) {
       try {
+        if (node.timerSaveExposedGAs !== null) clearInterval(node.timerSaveExposedGAs);
         node.saveExposedGAs();
       } catch (error) {
       }

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=20.18.1"
   },
-  "version": "3.3.38",
+  "version": "3.3.40",
   "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",

package/resources/KNXFunctionCodeSnippets.js

@@ -41,4 +41,25 @@ return msg`;
 const KNXFunctionSnippetThree = `// @ts-nocheck
 // The current msg contains the internal temperature in the "msg.payload" property, but we want to emit the external temperature as well.
 msg.externalTemperature = getGAValue('0/0/10 Garden temperature sensor'); // In case the ETS file is missing, you must specify the dpt as well: getGAValue('0/0/10','9.001')
+return msg;`;
+
+const KNXFunctionSnippetFour = `// @ts-nocheck
+// After 5000 milliseconds, toggle.
+setTimeout(function() {
+    toggle();
+}, 5000);
+return msg;`;
+
+const KNXFunctionSnippetFive = `// @ts-nocheck
+// After 5000 milliseconds, send false.
+setTimeout(function () {
+    self(false);
+}, 5000);
+return msg;`;
+
+const KNXFunctionSnippetSix = `// @ts-nocheck
+// Send 20% to the GA 1/0/1 having DPT 5.001
+if (msg.payload === true){
+    setGAValue('1/0/1',20,'5.001') 
+}
 return msg;`;