node-red-contrib-knx-ultimate 1.3.9 → 1.3.13

package/CHANGELOG.md

@@ -4,7 +4,17 @@
 
 <br/>
 <p>
-<b>Version 1.3.9</b> - December 2021<br/>
+<b>Version 1.3.13</b> - 25 December 2021<br/>
+- KNXEngine: when in tunneling and suppress ACK request is disabled, the error is raised only after 3° failed ACK reception instead of 1°.<br/>
+- KNXEngine: at disconnection, delete all pending ACK requests timer.<br/>
+- Warning: if you've suppressed the ACK requests, in some cases the node cannot detect the disconnection. In this case, please use the KNX Watchdog to detect the disconnecitons and reconnect.<br/>
+</p>
+<p>
+<b>Version 1.3.12</b> - December 2021<br/>
+- KNX-Ultimate DEVICE node: added the validation of Group Address while deploy, with support for modern addressing up to 31/7/255.<br/>
+</p>
+<p>
+<b>Version 1.3.10</b> - December 2021<br/>
 - FIX: fixed a stupid "Disconnected by Message length mismatch 8/16" error due to a dumb find/replace error in the code.<br/>
 - Added some more log to help resolving issues.<br/>
 </p>

package/KNXEngine/KNXClient.js

@@ -173,6 +173,7 @@ class KNXClient extends EventEmitter {
         this._channelID = null;
         this._connectionState = STATE.DISCONNECTED;
         this._tunnelReqTimer = new Map();
+        this._numFailedTelegramACK = 0; // 25/12/2021 Keep count of the failed tunnelig ACK telegrams
 
     }
     get channelID() {
@@ -544,6 +545,7 @@ class KNXClient extends EventEmitter {
         }
 
         this._connectionState = STATE.CONNECTING;
+        this._numFailedTelegramACK = 0; // 25/12/2021 Reset the failed ACK counter
 
         if (this._timer !== null) clearTimeout(this._timer);
 
@@ -652,9 +654,17 @@ class KNXClient extends EventEmitter {
         } catch (error) {
         }
 
+        // 25/12/2021 Stops all awaiting ACK timers
+        for (const [key, oTimer] of this._tunnelReqTimer.entries()) {
+            try {
+                clearTimeout(oTimer);
+            } catch (error) { }
+        }
+        this._tunnelReqTimer.clear();
         this._clientTunnelSeqNumber = 0;
         this._channelID = null;
         this._tunnelReqTimer = new Map();
+
         // 08/12/2021
         try {
             this._clientSocket.close();
@@ -685,12 +695,16 @@ class KNXClient extends EventEmitter {
     }
     _setTimerAndCallback(knxTunnelingRequest) {
         const timeoutErr = new errors.RequestTimeoutError(`RequestTimeoutError seqCounter:${knxTunnelingRequest.seqCounter}, DestAddr:${knxTunnelingRequest.cEMIMessage.dstAddress.toString() || "Non definito"},  AckRequested:${knxTunnelingRequest.cEMIMessage.control.ack}, timed out waiting telegram acknowledge by ${this._options.ipAddr || "No Peer host detected"}`);
-        //const key = this._keyFromCEMIMessage(knxTunnelingRequest.cEMIMessage);
         this._tunnelReqTimer.set(knxTunnelingRequest.seqCounter, setTimeout(() => {
             this._tunnelReqTimer.delete(knxTunnelingRequest.seqCounter);
-            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error("KNXClient: _setTimerAndCallback: " + (timeoutErr.message || "Undef error"));
             try {
-                this.emit(KNXClientEvents.error, timeoutErr);
+                this._numFailedTelegramACK += 1;
+                if (this._numFailedTelegramACK > 3) {
+                    this._numFailedTelegramACK = 0;
+                    this.emit(KNXClientEvents.error, timeoutErr);
+                } else {
+                    if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error("KNXClient: _setTimerAndCallback: " + (timeoutErr.message || "Undef error") + " " + this._numFailedTelegramACK + " of 3 times before emitting error.");
+                }
             } catch (error) {
             }
         }, KNXConstants.KNX_CONSTANTS.TUNNELING_REQUEST_TIMEOUT * 1000));
@@ -826,8 +840,11 @@ class KNXClient extends EventEmitter {
                 this._incSeqNumber(knxTunnelingAck.seqCounter);
 
                 if (this._tunnelReqTimer.has(knxTunnelingAck.seqCounter)) {
-                    if (this._tunnelReqTimer.get(knxTunnelingAck.seqCounter) !== null) clearTimeout(this._tunnelReqTimer.get(knxTunnelingAck.seqCounter));
-                    this._tunnelReqTimer.delete(knxTunnelingAck.seqCounter);
+                    if (this._tunnelReqTimer.get(knxTunnelingAck.seqCounter) !== null) {
+                        clearTimeout(this._tunnelReqTimer.get(knxTunnelingAck.seqCounter));
+                        this._tunnelReqTimer.delete(knxTunnelingAck.seqCounter);
+                    }
+                    this._numFailedTelegramACK = 0; // 25/12/2021 clear the current ACK failed telegram number
                     try {
                         if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.debug("Received KNX packet: TUNNELING: DELETED_TUNNELING_ACK FROM PENDING ACK's, ChannelID:" + this._channelID + " seqCounter:" + knxTunnelingAck.seqCounter + " Host:" + this._options.ipAddr + ":" + this._options.ipPort);
                     } catch (error) { }

package/KNXEngine/KnxLog.js

@@ -29,10 +29,7 @@ const determineLogLevel = options => {
 
 module.exports = {
   get: function (options) {
-    if (!logger) {
-      //console.log('BANANA new logger, level',determineLogLevel(options),(options && options.debug && 'debug') ||
-      //(options && options.loglevel) ||
-      //'error');
+    if ((!logger) || (logger && options)) {
       logger = require('log-driver')({
         levels: ['silent', 'error', 'warn', 'info', 'debug', 'trace'],
         level: determineLogLevel(options),
@@ -58,7 +55,7 @@ module.exports = {
           }
         }
       })
-    }
+    } 
     return (logger)
   },
   destroy: function () {

package/KNXEngine/protocol/KNXHeader.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KNXHeader = void 0;
 const KNXConstants = require("./KNXConstants");
+const sysLogger = require("./../KnxLog.js").get(); // 08/04/2021 new logger to adhere to the loglevel selected in the config-window            
+
 
 class KNXHeader {
     constructor(type, length) {
@@ -35,9 +37,9 @@ class KNXHeader {
         const length = buffer.readUInt16BE(offset);
         if (length !== buffer.length) {
             try {
-                console.log(`Received KNX packet: KNXHeader: createFromBuffer: Message length mismatch ${length}/${buffer.length} Data processed: ${buffer.toString("hex") || "??"}`);
+                if (sysLogger !== undefined && sysLogger !== null) sysLogger.error(`Received KNX packet: KNXHeader: createFromBuffer: Message length mismatch ${length}/${buffer.length} Data processed: ${buffer.toString("hex") || "??"}`);
             } catch (error) { }
-           // throw new Error(`Message length mismatch ${length}/${buffer.length} Data processed: ${buffer.toString("hex") || "??"}`);
+            // throw new Error(`Message length mismatch ${length}/${buffer.length} Data processed: ${buffer.toString("hex") || "??"}`);
         }
         return new KNXHeader(type, length - header_length);
     }

package/KNXEngine/protocol/KNXUtils.js

@@ -13,17 +13,36 @@ const splitIP = (ip, name = 'ip') => {
 };
 exports.splitIP = splitIP;
 const validateKNXAddress = (address, isGroup = false) => {
+    // 22/12/2021 Supergiovane: https://support.knx.org/hc/en-us/articles/115003188109-Group-Addresses
     if (typeof (address) === 'string') {
         const digits = address.split(/[./]/);
         if (digits.length < 2 || digits.length > 3) {
-            throw new Error(`Invalid address format: ${address}`);
+            throw new Error(`Invalid address format: ${address} Only 3 level addresses are allowed`);
         }
+        if ((digits.length === 3 && address === "0/0/0") || (digits.length === 1 && address === "0/0")) throw new Error(`Invalid address: ${address}`);
+
         let count = 0;
         let newAddress = 0;
         for (let i = digits.length - 1; i >= 0; i--, count++) {
             const digit = Number(digits[i]);
-            if (isNaN(digit) || (count > 1 && digit > 15) || (count === 0 && digit > 255)) {
-                throw new Error(`Invalid digit at pos ${i} inside address: ${address}`);
+            if (isGroup && digits.length === 3) {
+                // Validating Group Address
+                if (isNaN(digit) || (count === 2 && digit > 31) || (count === 1 && digit > 7) || (count === 0 && digit > 255)) {
+                    // 22/12/2021 Supergiovane disabled digits validation
+                    throw new Error(`Invalid 3 levels GA digit ${digit} inside address: ${address}`);
+                }
+            } else if (isGroup && digits.length === 2) {
+                // Validating Group Address
+                if (isNaN(digit) || (count === 1 && digit > 31) || (count === 0 && digit > 2047)) {
+                    // 22/12/2021 Supergiovane disabled digits validation
+                    throw new Error(`Invalid 2 levels GA digit ${digit} inside address: ${address}`);
+                }
+            } else {
+                // Validating KNX Device Address
+                if (isNaN(digit) || (count > 1 && digit > 15) || (count === 0 && digit > 255)) {
+                    // 22/12/2021 Supergiovane disabled digits validation
+                    throw new Error(`Invalid Individual Address digit ${digit} inside address: ${address}`);
+                }
             }
             if (count === 0) {
                 newAddress = digit;

package/nodes/knxUltimate-config.html

@@ -8,7 +8,7 @@
             physAddr: { value: "15.15.22", required: true },
             hostProtocol: { value: "Multicast", required: false }, // TunnelUDP/TunnelTCP/Multicast
             // enable this option to suppress the acknowledge flag with outgoing L_Data.req requests. LoxOne needs this
-            suppressACKRequest: { value: true },
+            suppressACKRequest: { value: false },
             csv: { value: "", required: false },
             KNXEthInterface: { value: "Auto" },
             KNXEthInterfaceManuallyInput: { value: "" },

package/nodes/knxUltimate-config.js

@@ -425,19 +425,6 @@ return msg;`, "helplink": "https://github.com/Supergiovane/node-red-contrib-knx-
         node.addClient = (_Node) => {
             // Check if node already exists
             if (node.nodeClients.filter(x => x.id === _Node.id).length === 0) {
-                // Check if the node has a valid topic and dpt
-                if (_Node.listenallga === false) {
-                    if (_Node.topic === undefined || _Node.dpt === undefined) {
-                        _Node.setNodeStatus({ fill: "red", shape: "dot", text: "Empty Group Addr. or datapoint.", payload: "", GA: "", dpt: "", devicename: "" })
-                        return;
-                    } else {
-                        // topic must be in format x/x/x
-                        if (_Node.topic.split("\/").length < 3) {
-                            _Node.setNodeStatus({ fill: "red", shape: "dot", text: "Wrong group address (topic: " + _Node.topic + ") format.", payload: "", GA: "", dpt: "", devicename: "" })
-                            return;
-                        }
-                    }
-                }
                 // Add _Node to the clients array
                 if (node.autoReconnect) {
                     _Node.setNodeStatus({ fill: "grey", shape: "ring", text: "Node initialized.", payload: "", GA: "", dpt: "", devicename: "" });

package/nodes/knxUltimate.js

@@ -1,5 +1,6 @@
 module.exports = function (RED) {
     const _ = require("lodash");
+    const KNXUtils = require("./../KNXEngine/protocol/KNXUtils");
 
     function knxUltimate(config) {
         RED.nodes.createNode(this, config)
@@ -57,15 +58,16 @@ module.exports = function (RED) {
         }
 
         // Check if the node has a valid topic and dpt
-        if (node.listenallga == false) {
-            if (typeof node.topic == "undefined" || typeof node.dpt == "undefined") {
+        if (node.listenallga === false) {
+            if (node.topic === undefined || node.dpt === undefined) {
                 node.setNodeStatus({ fill: "red", shape: "dot", text: "Empty Group Addr. or datapoint.", payload: "", GA: "", dpt: "", devicename: "" })
                 return;
             } else {
-
-                // topic must be in formar x/x/x
-                if (node.topic.split("\/").length < 3) {
-                    node.setNodeStatus({ fill: "red", shape: "dot", text: "Wrong group address format.", payload: "", GA: node.topic, dpt: "", devicename: "" })
+                // Validate the Address
+                try {
+                    KNXUtils.validateKNXAddress(node.topic, true)
+                } catch (error) {
+                    node.setNodeStatus({ fill: "red", shape: "dot", text: error.message, payload: "", GA: node.topic, dpt: "", devicename: "" })
                     return;
                 }
             }

package/nodes/locales/de/knxUltimate-config.json

@@ -23,8 +23,8 @@
             "show_date_status": "Tag und Uhrzeit des letzten Updates im Status anzeigen",
             "show_device_status": "Gerätenamen im Status anzeigen (\"Alle Gruppenadressen abhören\" erforderlich)",
             "show_datapoint_status": "Datenpunkt im Status anzeigen",
-            "suppress_ack": "ACK-Anfrage unterdrücken",
-            "suppress_ack_help": "Diese Option unterstützt die Kompatibilität mit der alten Firmware des IP-Interface SWG1 148-1AB22 von Siemens",
+            "suppress_ack": "ACK-Anfrage unterdrücken in Tunnel Modus",
+            "suppress_ack_help": "Diese Option unterstützt die Kompatibilität mit der alten Firmware des alten IP-Interfaces.Achtung: Der Knoten kann die Trennung vom Gateway möglicherweise nicht bemerken. Verwenden Sie in diesem Fall den Watchdog im Ethernet+KNX-Twisted-Pair Modus.",
             "ignoreTelegramsWithRepeatedFlag": "Wiederholt (R-Flag) telegramme vom BUS unterdrücken",
             "log_level": "Loglevel",
             "nodes_list_title": "Liste aller KNX-Ultimate Nodes in allen Flows",

package/nodes/locales/en-US/knxUltimate-config.json

@@ -23,8 +23,8 @@
             "show_date_status": "Show last update day and time in status",
             "show_device_status": "Show device name in status (require \"Listen all Group Address\" )",
             "show_datapoint_status": "Show datapoint in status",
-            "suppress_ack": "Suppress ACK request",
-            "suppress_ack_help": "The option above helps old KNX/IP Interfaces compatibility",
+            "suppress_ack": "Suppress ACK request in tunneling mode",
+            "suppress_ack_help": "The option above helps old KNX/IP Interfaces compatibility. Warning: the node may not notice the disconnection from the gateway. In this case, use the watchdog in Ethernet+KNX twisted pair mode.",
             "ignoreTelegramsWithRepeatedFlag": "Suppress repeated (R-Flag) telegrams fom BUS",
             "log_level": "Loglevel",
             "nodes_list_title": "List of your nodes in all flows",

package/nodes/locales/it/knxUltimate-config.json

@@ -23,8 +23,8 @@
             "show_date_status": "Visualizza data e ora ultimo aggiornamento, nello stato",
             "show_device_status": "Visualizza il nome del dispositivo nello stato (richiede \"Modalità universale\" )",
             "show_datapoint_status": "Visualizza il DPT nello stato",
-            "suppress_ack": "Sopprimi richieste ACK",
-            "suppress_ack_help": "L'opzione ACK sopra aiuta la compatibilità con vecchie interfacce",
+            "suppress_ack": "Sopprimi richieste ACK in modalità tunnel",
+            "suppress_ack_help": "L'opzione ACK sopra aiuta la compatibilità con vecchie interfacce. Attenzione: il nodo potrebbe non accorgersi della disconnessione al gateway. In questo caso, usare il watchdog in modalità Ethernet+KNX twisted pair.",
             "ignoreTelegramsWithRepeatedFlag": "Sopprimi telegrammi dal BUS ripetuti (Flag R)",
             "log_level": "Livello log",
             "nodes_list_title": "Elenco nodi in tutti i flows",

package/nodes/locales/zh-CN/knxUltimate-config.json

@@ -23,8 +23,8 @@
             "show_date_status": "在状态中显示上次更新日期和时间",
             "show_device_status": "在状态中显示设备的名称 (需要 \"监听所有组地址\" )",
             "show_datapoint_status": "在状态中显示数据类型",
-            "suppress_ack": "抑制 ACK 请求",
-            "suppress_ack_help": "上面的选项有助于旧的 KNX/IP 接口兼容性",
+            "suppress_ack": "抑制 ACK 请求 in tunneling mode",
+            "suppress_ack_help": "上面的选项有助于旧的 KNX/IP 接口兼容性 Warning: the node may not notice the disconnection from the gateway. In this case, use the watchdog in Ethernet+KNX twisted pair mode.",
             "ignoreTelegramsWithRepeatedFlag": "抑制重复的 (R-Flag) 来自总线的电报",
             "log_level": "日志等级",
             "nodes_list_title": "所有流中的节点列表",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-knx-ultimate",
-  "version": "1.3.9",
+  "version": "1.3.13",
   "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.",
   "dependencies": {
     "fs": "0.0.1-security",