node-red-contrib-knx-ultimate 3.3.2 → 3.3.3

package/CHANGELOG.md

@@ -6,6 +6,11 @@
 
 # CHANGELOG
 
+**Version 3.3.3** - November 2024<br/>
+- KNX Config Node: Automatic KNX Gateway discover in the gateway node config window.<br/>
+- KNX Engine: new: new telegram sequencer waiter, for more accurate timing in slow or sliggish computers.<br/>
+- KNX Engine: bunp 4.0.0-beta.7 .<br/>
+
 **Version 3.3.0** - November 2024<br/>
 - KNX Engine: explicitly set the local port of the unicast socket on 3671 and the local IP of the multicast to 0.0.0.0.<br/>
 - KNX Engine: many engine adaptation for the upcoming KNX-Secure implementation.<br/>

package/nodes/commonFunctions.js

@@ -310,29 +310,7 @@ module.exports = (RED) => {
 
         // 14/08/2019 Endpoint for retrieving the ethernet interfaces
         RED.httpAdmin.get("/knxUltimateDiscoverKNXGateways", RED.auth.needsPermission("knxUltimate-config.read"), async function (req, res) {
-            try {
-                async function search() {
-                    let jRet = [];
-                    try {
-                        const knxGateways = await KNXClient.discover();
-                        // For each discovered gateway, get all possible device descriptions (usually only one)
-                        // A description is a JSON object containing all details of the device and also what type of connection (Multicast, unicast, etc), it suppports
-                        for (let index = 0; index < knxGateways.length; index++) {
-                            const element = knxGateways[index];
-                            const [ip, port] = element.split(':')
-                            const descriptionsJSON = await KNXClient.getGatewayDescription(ip, port, 5000)
-                            for (let index = 0; index < descriptionsJSON.length; index++) {
-                                const element = descriptionsJSON[index];
-                                jRet.push({ ip: ip, port: port, name: element.deviceInfo.name, physAddr: element.deviceInfo.formattedAddress });
-                            }
-                        }
-                        res.json(jRet);
-                    } catch (error) { }
-                }
-                search();
-            } catch (error) {
-                res.json({ error: error.stack });
-            }
+            res.json(require("./utils/utils").aDiscoveredknxGateways);
         });
 
         // 12/08/2021 Endpoint for deleting the GA persistent file for the current gateway

package/nodes/knxUltimate-config.html

@@ -34,6 +34,32 @@
             } catch (error) { }
 
             var node = this;
+            // TIMER BLINK ####################################################
+            let blinkStatus = 2;
+            let timerBlinkBackground;
+            function blinkBackgroundArray(_arrayElementIDwithHashAtTheBeginning) {
+                if (timerBlinkBackground !== undefined) clearInterval(timerBlinkBackground);
+                timerBlinkBackground = setInterval(() => {
+                    for (let index = 0; index < _arrayElementIDwithHashAtTheBeginning.length; index++) {
+                        const _elementIDwithHashAtTheBeginning = _arrayElementIDwithHashAtTheBeginning[index];
+                        if (isEven(blinkStatus)) $(_elementIDwithHashAtTheBeginning).css("background-color", "lightgreen");
+                        if (!isEven(blinkStatus)) $(_elementIDwithHashAtTheBeginning).css("background-color", "");
+                    }
+                    blinkStatus += 1;
+                    if (blinkStatus >= 14) {
+                        clearInterval(timerBlinkBackground);
+                        blinkStatus = 2;
+                        for (let index = 0; index < _arrayElementIDwithHashAtTheBeginning.length; index++) {
+                            const _elementIDwithHashAtTheBeginning = _arrayElementIDwithHashAtTheBeginning[index];
+                            $(_elementIDwithHashAtTheBeginning).css("background-color", "");
+                        }
+                    }
+                }, 100);
+            }
+            function isEven(n) {
+                return (n % 2 == 0);
+            }
+            // ################################################################
 
             // 22/07/2021 Main tab
             $("#tabsMain").tabs({
@@ -44,28 +70,52 @@
             });
 
             // Autocomplete with KNX IP Interfaces
-            // let aKNXInterfaces = [];
-            // $.getJSON("knxUltimateDiscoverKNXGateways?" + { _: new Date().getTime() }, (data) => {
-            //     for (let index = 0; index < data.length; index++) {
-            //         const element = data[index];
-            //         aKNXInterfaces.push({
-            //             name: value.ip + " # " + value.name + " " + value.physAddr,
-            //             value: value.ip,
-            //         });
-            //     }
-            //     alert("IK")
-            //     alert(aKNXInterfaces[0].name)
-            //     $("#node-config-input-host").autocomplete({
-            //         minLength: 0,
-            //         source: aKNXInterfaces,
-            //         select: function (event, ui) {
-            //             $("#node-config-input-host").val(ui.item.value);
-            //         },
-            //         focus: function (event, ui) {
-            //             $(this).autocomplete('search', $(this).val() + 'exactmatch');
-            //         }
-            //     })
-            // });
+            let aKNXInterfaces = [];
+            $.getJSON("knxUltimateDiscoverKNXGateways?" + { _: new Date().getTime() }, (data) => {
+                for (let index = 0; index < data.length; index++) {
+                    const element = data[index];
+                    const [ip, port, name, address] = element.split(':');
+                    // Aggiungi l'elemento con descrizione e valore
+                    aKNXInterfaces.push({
+                        label: `${name} -> ${ip}:${port} phys addr:${address}`, // Testo visibile nella lista
+                        value: element                     // Valore selezionato
+                    });
+                }
+                $("#interfaces-count").text(`${aKNXInterfaces.length} interfaces found.`);
+                // Configura l'autocompletamento per il campo di input
+                $("#node-config-input-host").autocomplete({
+                    minLength: 0, // Mostra suggerimenti subito
+                    source: aKNXInterfaces, // Dati per il completamento
+                    select: function (event, ui) {
+                        // Quando l'utente seleziona un elemento, aggiorna il valore del campo
+                        const [ip, port, name, address] = ui.item.value.split(':');
+                        $("#node-config-input-host").val(ip);
+                        $("#node-config-input-port").val(port);
+                        $("#node-config-input-name").val(name);
+                        $("#node-config-input-physAddr").val(address.split(".")[0] + '.' + address.split(".")[1] + '.' + Math.floor(Math.random() * 256));
+                        blinkBackgroundArray(["#node-config-input-host", "#node-config-input-port", "#node-config-input-name", "#node-config-input-physAddr"]);
+                        return false; // Evita il comportamento predefinito del browser
+                    },
+                    focus: function (event, ui) {
+                        // Mantieni il valore corrente durante il focus, ma non cambiare il valore effettivo
+                        $("#node-config-input-host").val(ui.item.value.split(":"[0]));
+                        return false; // Evita di aggiornare il campo con il valore selezionato
+                    }
+                }).on("focus", function () {
+                    // Apri l'autocomplete quando il campo riceve il focus
+                    $(this).autocomplete("search", "");
+                }).on("click", function () {
+                    // Apri l'autocomplete quando il campo riceve il focus
+                    $(this).autocomplete("search", "");
+                }).autocomplete("instance")._renderItem = function (ul, item) {
+                    // Personalizza l'aspetto degli elementi della lista
+                    const [ip, port, name, address] = item.value.split(':');
+                    const color = (ip === "224.0.23.12") ? "gray" : "green"; // Condizione
+                    return $("<li>")
+                        .append(`<div style="color: ${color};"><b>${ip}:${port}</b> -> ${name} - Address:${address}</div>`) // Mostra la descrizione completa
+                        .appendTo(ul);
+                }
+            });
 
 
             $("#node-config-input-KNXEthInterface").append($("<option></option>")
@@ -220,9 +270,9 @@
             <input type="text" id="node-config-input-name" style="width: 200px">
         </div>
         <div class="form-row">
-            <label for="node-config-input-host" style="width: 200px">
-                <i class="fa fa-server"></i> IP/Hostname</label>
-            <input type="text" id="node-config-input-host" style="width: 200px">
+            <label for="node-config-input-host" style="width: 200px"><i class="fa fa-server"></i> IP/Hostname</label>
+                <input type="text" id="node-config-input-host" style="width: 200px"><br/>
+                <span id="interfaces-count" style="font-size: 12px; color:#377e00 ; margin-top: 2px;"></span>
         </div>
     
     <!-- KNX Secure / Unsecure tabbed selector-->

package/nodes/knxUltimate-config.js

@@ -13,7 +13,7 @@ const dptlib = require('knxultimate').dptlib;
 const loggerClass = require('./utils/sysLogger')
 // const { Server } = require('http')
 const payloadRounder = require("./utils/payloadManipulation");
-
+const utils = require('./utils/utils');
 
 // DATAPONT MANIPULATION HELPERS
 // ####################
@@ -119,6 +119,9 @@ module.exports = (RED) => {
       if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.info("IP Protocol AUTO SET to " + node.hostProtocol + ", based on IP " + node.host);
     }
 
+    // Gather infos about all interfaces on the lan and provides a static variable utils.aDiscoveredknxGateways
+    utils.DiscoverKNXGateways()
+
     node.setAllClientsStatus = (_status, _color, _text) => {
       node.nodeClients.forEach((oClient) => {
         try {
@@ -525,7 +528,8 @@ module.exports = (RED) => {
         isSecureKNXEnabled: node.knxSecureSelected,
         jKNXSecureKeyring: node.jKNXSecureKeyring,
         localIPAddress: "", // Riempito da KNXEngine
-        KNXQueueSendIntervalMilliseconds: Number(node.delaybetweentelegrams)
+        KNXQueueSendIntervalMilliseconds: Number(node.delaybetweentelegrams),
+        connectionKeepAliveTimeout: 30 // Every 30 seconds, send a connectionstatus_request
       };
       // 11/07/2022 Test if the IP is a valid one or is a DNS Name
       switch (net.isIP(node.host)) {
@@ -647,11 +651,7 @@ module.exports = (RED) => {
           node.Disconnect("Disconnected by error " + (err.message === undefined ? err : err.message), "red");
           if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error("Disconnected by: " + (err.message === undefined ? err : err.message));
         });
-        // Call discoverCB when a knx gateway has been discovered.
-        // node.knxConnection.on(knx.KNXClientEvents.discover, info => {
-        //     const [ip, port] = info.split(":");
-        //     discoverCB(ip, port);
-        // });
+
         node.knxConnection.on(knx.KNXClientEvents.disconnected, (info) => {
           if (node.linkStatus !== "disconnected") {
             node.linkStatus = "disconnected";
@@ -1838,7 +1838,7 @@ module.exports = (RED) => {
         );
         // node.initKNXConnection();
       }
-    }, 5000);
+    }, 30000);
 
     node.Disconnect = async (_sNodeStatus = "", _sColor = "grey") => {
       if (node.linkStatus === "disconnected") {

package/nodes/utils/hueEngine.js

@@ -2,7 +2,7 @@
 const { EventEmitter } = require("events");
 const EventSource = require("eventsource");
 const http = require("./http");
-const pleaseWait = t => new Promise((resolve, reject) => setTimeout(resolve, t))
+const { setTimeout: pleaseWait } = require('timers/promises');
 //const { forEach } = require("lodash");
 // Configura il rate limiter
 //const limiter = new RateLimiter({ tokensPerInterval: 1, interval: 150 }); // HUE telegram interval

package/nodes/utils/utils.js

@@ -58,4 +58,31 @@ module.exports.fetchFromObject = function fetchFromObject(
 const DEFAULTTRANSLATIONINPUT =
   "on:true\noff:false\nactive:true\ninactive:false\nopen:true\nclosed:false\nclose:false\n1:true\n0:false\ntrue:true\nfalse:false\nhome:true\nnot_home:false\nnormal:false\nviolated:true";
 
+// 14/08/2019 Endpoint for retrieving the ethernet interfaces
 
+module.exports.DiscoverKNXGateways = async function DiscoverKNXGateways() {
+  if (bDiscoverKNXGatewaysRunning) return;
+  bDiscoverKNXGatewaysRunning = true;
+  const KNXClient = require('knxultimate');
+  try {
+    if (this.aDiscoveredknxGateways === undefined) {
+      this.aDiscoveredknxGateways = await KNXClient.KNXClient.discover(2000);
+      this.aDiscoveredknxGateways.push('224.0.23.12:3671:Multicast Address:15.15.199')
+      bDiscoverKNXGatewaysRunning = false;
+      return this.aDiscoveredknxGateways;
+    } else {
+      bDiscoverKNXGatewaysRunning = false;
+      return this.aDiscoveredknxGateways;
+    }
+  } catch (error) { bDiscoverKNXGatewaysRunning = false; this.aDiscoveredknxGateways = []; return this.aDiscoveredknxGateways; }
+}
+let bDiscoverKNXGatewaysRunning = false;
+module.exports.aDiscoveredknxGateways;
+
+module.exports.getDiscoveredknxGateways = function () {
+  return module.exports.aDiscoveredknxGateways;
+};
+
+module.exports.setDiscoveredknxGateways = function (value) {
+  module.exports.aDiscoveredknxGateways = value;
+};

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "3.3.2",
+  "version": "3.3.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",
@@ -11,7 +11,7 @@
     "dns-sync": "0.2.1",
     "eventsource": "2.0.2",
     "js-yaml": "4.1.0",
-    "knxultimate": "4.0.0-beta.6",
+    "knxultimate": "4.1.0-beta.1",
     "lodash": "4.17.21",
     "node-color-log": "12.0.1",
     "mkdirp": "3.0.1",