node-red-contrib-knx-ultimate 3.2.16 → 3.3.0

package/CHANGELOG.md

@@ -6,6 +6,13 @@
 
 # CHANGELOG
 
+**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/>
+
+**Version 3.2.17** - October 2024<br/>
+- Hue devices: globally check for boundary limits, when calculating brightness and colorYX from an RGB or HEX KNX input.<br/>
+
 **Version 3.2.16** - October 2024<br/>
 - Hue devices: fixed an issue with the ETS CSV file, when a HUE device's GA isn't contained in the CSV.<br/>
 - Hue Light: fixed an issue in setting RGB to 255,255,255, caused by an out of boundary of the calculater brightness value.<br/>

package/README.md

@@ -77,7 +77,7 @@ Please subscribe to the [Youtube channel](https://www.youtube.com/playlist?list=
 | KNX Secure Tunnelling | ![](https://placehold.co/200x20/orange/white?text=UNDER+DEVELOPMENT) |
 | KNX Secure Routing | ![](https://placehold.co/200x20/red/white?text=NO) |
 | KNX 3rd PARTY IOT API client | ![](https://placehold.co/200x20/red/white?text=DELAYED) |
-| Matter | ![](https://placehold.co/200x20/blue/white?text=UNDER+BRAINSTORMING) |
+| Matter | ![](https://placehold.co/200x20/red/white?text=NO+TOO+IMMATURE) |
 
 <br/>
 

package/nodes/commonFunctions.js

@@ -6,7 +6,7 @@ const path = require("path");
 const yaml = require('js-yaml');
 const dptlib = require('knxultimate').dptlib;
 const customHTTP = require('./utils/http');
-
+const KNXClient = require('knxultimate').KNXClient;
 
 // DATAPONT MANIPULATION HELPERS
 // ####################
@@ -47,6 +47,7 @@ const toConcattedSubtypes = (acc, baseType) => {
 // ####################
 
 module.exports = (RED) => {
+
     RED.plugins.registerPlugin("commonFunctions", {
         type: "foo",
         onadd: function () {
@@ -308,17 +309,32 @@ module.exports = (RED) => {
         });
 
         // 14/08/2019 Endpoint for retrieving the ethernet interfaces
-        RED.httpAdmin.get("/KNUltimateGetLogFile", (req, res) => {
+        RED.httpAdmin.get("/knxUltimateDiscoverKNXGateways", RED.auth.needsPermission("knxUltimate-config.read"), async function (req, res) {
             try {
-                const log = fs.readFileSync('./KNXUltimateDebugLog.txt')
-                res.json(log.toString());
+                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.message);
+                res.json({ error: error.stack });
             }
-
         });
 
-
         // 12/08/2021 Endpoint for deleting the GA persistent file for the current gateway
         RED.httpAdmin.get("/deletePersistGAFile", RED.auth.needsPermission("knxUltimate-config.read"), (req, res) => {
             try {

package/nodes/knxUltimate-config.html

@@ -43,6 +43,31 @@
                 }
             });
 
+            // 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');
+            //         }
+            //     })
+            // });
+
+
             $("#node-config-input-KNXEthInterface").append($("<option></option>")
                 .attr("value", "Auto")
                 .text("Auto")
@@ -96,13 +121,7 @@
                 for (const [key, value] of Object.entries(node)) {
                     sRetDebugText += (`-> ${key}: ${value}\r`);
                 }
-                // Add log file
-                $.getJSON("KNUltimateGetLogFile", (data) => {
-                    sRetDebugText += "\r\r" + data;
-                    sRetDebugText = 'INSTRUCTIONS: COPY THE LINK BELOW AND PASTE IT INTO THE ADDRESS BAR OF YOUR BROWSER.\rhttps://github.com/Supergiovane/node-red-contrib-knx-ultimate/issues/new?assignees=Supergiovane&labels=&template=bug_report.md&title=KNXDebugText\r\r THEN PASTE THIS TEXT INTO THE ISSUE\'S BODY, USING THE <> BRACKETS.\r\r' + sRetDebugText;
-                    $("#debugText").val(sRetDebugText); // Store the config-node);
-                });
-
+                $("#debugText").val(sRetDebugText); // Store the config-node);
             });
             $("#getallgaused").click(function () {
                 sRetDebugText = "";
@@ -427,7 +446,7 @@
 |Property|Description|
 |--|--|
 | IP Port | The port. Default is 3671. |
-| IP Protocol | *Tunnel UDP* is for KNX/IP interfaces, *Multicast UDP* is for KNX/IP Routers. Leave **Auto** for auto detect. Default is "Auto". |
+| IP Protocol | *Tunnel UDP* is for KNX/IP interfaces, *Multicast UDP* is for KNX/IP Routers. Leave **Auto** for auto detect. CAUTION: **Auto** won't work with hostnames (for example myknx.home.com), but only with IP addresses. Default is "Auto". |
 | KNX Physical Address | The physical KNX address, example 1.1.200. Default is "15.15.22".|
 | Bind to local interface | The Node will use this local interface for communications. Leave "Auto" for automatic selection. If you have more than one lan connection, for example Ethernet and Wifi, it's strongly recommended to manually select the interface, otherwise not all UDP telegram will reach your computer, thus the Node may not work as expected. Default is "Auto". |
 | Automatically connect to KNX BUS at start | Auto connect to the bus at start. Default is "Yes". |
@@ -440,7 +459,7 @@
 | Echo sent message to all node with same Group Address | Send the msg input coming from the flow, to all nodes having the same group address. The nodes will receive the new msg as if it's coming from the KNX bus. This is useful in case of using the KNX emulation and in case the connection to the KNX bus is not established. **This option will be deprecated in the next version and defaulted to checked.** Default is checked. |
 | Suppress repeated (R-Flag) telegrams fom BUS | Ignore repeated KNX telegrams coming from the bus. Default is unchecked. |
 | Suppress ACK request in tunneling mode | Enable it if you have a very old KNX/IP gateway. It ignores the ACK procedure and accepts all telegrams. Default is unchecked.|
-| Delay between each telegram (in milliseconds) | KNX specs states, that the maximum telegram sending speed is 50 telegrams per second. A speed between 25 and 50ms should be fine, unless you're connecting to a remote KNX Gateway via a slow internet connection (in this case, you should increase the value by, for example, 200 to 500ms or more). |
+| Delay between each telegram (in milliseconds) | KNX specs states, that the maximum telegram sending speed is 50 telegrams per second. A speed between 25 and 50ms should be fine, unless you're connecting to a remote KNX Gateway via a slow internet connection (in this case, you should increase the value by, for example, 100 to 200ms). Don't exeed 200ms. |
 | Loglevel | Log level, in case you need to debug something with the dev. Default is "Error", |
 
 <br/>

package/nodes/knxUltimate-config.js

@@ -96,8 +96,9 @@ module.exports = (RED) => {
     node.allowLauch_initKNXConnection = true; // See the node.timerKNXUltimateCheckState function
     node.hostProtocol = config.hostProtocol === undefined ? "Auto" : config.hostProtocol; // 20/03/2022 Default
     node.knxConnection = null; // 20/03/2022 Default
-    node.delaybetweentelegrams = (config.delaybetweentelegrams === undefined || config.delaybetweentelegrams === null) ? 25 : Number(config.delaybetweentelegrams);
-    if (node.delaybetweentelegrams < 20) node.delaybetweentelegrams = 20; // Protection avoiding handleKNXQueue hangs
+    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
 
     // 05/12/2021 Set the protocol (this is undefined if coming from ild versions
     if (node.hostProtocol === "Auto") {
@@ -209,7 +210,7 @@ module.exports = (RED) => {
         node.exposedGAs = JSON.parse(fs.readFileSync(sFile, "utf8"));
       } catch (err) {
         node.exposedGAs = [];
-        if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error("unable to read peristent file " + sFile + " " + err.message);
+        if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.info("unable to read peristent file " + sFile + " " + err.message);
       }
     }
 
@@ -1165,16 +1166,25 @@ module.exports = (RED) => {
       // 26/12/2021 The KNXEngine is busy waiting for telegram's ACK. Strange.
       if (!node.knxConnection.clearToSend) {
         if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.warn(
-          "handleTelegramQueue: the KNXEngine is busy or is waiting for a telegram ACK with seqNumner " +
+          "sendKNXTelegramToKNXEngine: the KNXEngine is busy or is waiting for a telegram ACK with seqNumner " +
           node.knxConnection.getSeqNumber() +
-          ". Delay handling queue. Len: 3",
+          ". Delay handling queue.",
         );
       }
 
 
       // 19/01/2023 FORMATTING THE OUTPUT PAYLOAD (ROUND, ETC) BASED ON THE NODE CONFIG
       //* ********************************************************
-      _oKNXMessage.payload = payloadRounder.Manipulate(RED.nodes.getNode(_oKNXMessage.nodecallerid), _oKNXMessage.payload);
+      if (_oKNXMessage.outputtype === "read") {
+        try {
+          _oKNXMessage.payload = payloadRounder.Manipulate(RED.nodes.getNode(_oKNXMessage.nodecallerid), _oKNXMessage.payload);
+        } catch (error) {
+          if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error(
+            "sendKNXTelegramToKNXEngine: Sacripante Manipulate payload: " + error.message
+          );
+        }
+
+      }
       //* ********************************************************
 
       if (_oKNXMessage.outputtype === "response") {
@@ -1800,12 +1810,12 @@ module.exports = (RED) => {
     // 08/10/2021 Every xx seconds, i check if the connection is up and running
     if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.info("Autoconnection: " + (node.autoReconnect === false ? "no." : "yes") + " Node " + node.name);
     if (node.timerKNXUltimateCheckState !== null) clearInterval(node.timerKNXUltimateCheckState);
-    node.timerKNXUltimateCheckState = setInterval(() => {
+    node.timerKNXUltimateCheckState = setInterval(async () => {
       // If the node is disconnected, wait another cycle, then reconnects
       if (node.allowLauch_initKNXConnection && node.autoReconnect) {
         node.allowLauch_initKNXConnection = false;
         const t = setTimeout(() => {
-          // 21/03/2022 fixed possible memory leak. Previously was setTimeout without "let t = ".
+          // 21/03/2022 fixed possible memory leak. Previously was setTimeout without "const t = ".
           node.setAllClientsStatus("Auto reconnect in progress...", "grey", "");
         }, 100);
         if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.debug(
@@ -1814,7 +1824,7 @@ module.exports = (RED) => {
           ", node.autoReconnect:" +
           node.autoReconnect,
         );
-        node.initKNXConnection();
+        await node.initKNXConnection();
         return;
       }
       if (node.linkStatus === "disconnected" && node.autoReconnect) {
@@ -1828,7 +1838,7 @@ module.exports = (RED) => {
         );
         // node.initKNXConnection();
       }
-    }, 4000);
+    }, 5000);
 
     node.Disconnect = async (_sNodeStatus = "", _sColor = "grey") => {
       if (node.linkStatus === "disconnected") {

package/nodes/knxUltimateHueLight.js

@@ -432,9 +432,7 @@ module.exports = function (RED) {
                 gamut = node.currentHUEDevice.color.gamut;
               }
               const retXY = hueColorConverter.ColorConverter.calculateXYFromRGB(msg.payload.red, msg.payload.green, msg.payload.blue, gamut);
-              let bright = hueColorConverter.ColorConverter.getBrightnessFromRGBOrHex(msg.payload.red, msg.payload.green, msg.payload.blue);
-              bright = bright > 100 ? 100 : bright; // Otherwise it hangs and the light doesn't react anymore.
-              // state = bright > 0 ? { on: { on: true }, dimming: { brightness: bright }, color: { xy: retXY } } : { on: { on: false } }
+              const bright = hueColorConverter.ColorConverter.getBrightnessFromRGBOrHex(msg.payload.red, msg.payload.green, msg.payload.blue);
               state = { dimming: { brightness: bright }, color: { xy: retXY } };
               if (node.currentHUEDevice === undefined) {
                 // Grouped light

package/nodes/utils/colorManipulators/XYFromRGB_Supergiovane.js

@@ -53,6 +53,13 @@ module.exports = {
         }
         xy[0] = precision(xy[0]);
         xy[1] = precision(xy[1]);
+
+        // Check boundary (min 0, max 1)
+        xy[0] = xy[0] < 0 ? 0 : xy[0];
+        xy[0] = xy[0] > 1 ? 1 : xy[0];
+        xy[1] = xy[1] < 0 ? 0 : xy[1];
+        xy[1] = xy[1] > 1 ? 1 : xy[1];
+
         return { x: xy[0], y: xy[1] };
     },
 };

package/nodes/utils/colorManipulators/hueColorConverter.js

@@ -15,7 +15,13 @@ class ColorConverter {
 
     const Ylum = Rlin * 0.2126 + Glin * 0.7156 + Blin * 0.0722; // convert to Luminance Y
 
-    return Ylum ** 0.43 * 100; // Convert to lightness (0 to 100)
+    let ret = Ylum ** 0.43 * 100;// Convert to lightness (0 to 100)
+
+    // Boundary Check (min 0, max 100)
+    ret = ret < 0 ? 0 : ret;
+    ret = ret > 100 ? 100 : ret;
+
+    return ret;
   }
 
   static convert_1_255_ToPercentage(number) {

package/nodes/utils/hueEngine.js

@@ -2,11 +2,10 @@
 const { EventEmitter } = require("events");
 const EventSource = require("eventsource");
 const http = require("./http");
-// const pleaseWait = t => new Promise((resolve, reject) => setTimeout(resolve, t))
-const { RateLimiter } = require('limiter');
+const pleaseWait = t => new Promise((resolve, reject) => setTimeout(resolve, t))
 //const { forEach } = require("lodash");
 // Configura il rate limiter
-const limiter = new RateLimiter({ tokensPerInterval: 1, interval: 150 }); // HUE telegram interval
+//const limiter = new RateLimiter({ tokensPerInterval: 1, interval: 150 }); // HUE telegram interval
 
 class classHUE extends EventEmitter {
 
@@ -116,7 +115,7 @@ class classHUE extends EventEmitter {
             const ok = await this.hueApiV2.put(`/resource/light/${jRet._lightID}`, jRet._state);
           } catch (error) {
             if (this.sysLogger !== undefined && this.sysLogger !== null) {
-              this.sysLogger.error(`KNXUltimatehueEngine: classHUE: handleQueue: setLight light: ${error.message}.`);
+              this.sysLogger.error(`KNXUltimatehueEngine: classHUE: processQueueItem: setLight light: ${error.message}.`);
             }
           }
           break;
@@ -125,7 +124,7 @@ class classHUE extends EventEmitter {
             await this.hueApiV2.put(`/resource/grouped_light/${jRet._lightID}`, jRet._state);
           } catch (error) {
             if (this.sysLogger !== undefined && this.sysLogger !== null)
-              this.sysLogger.info(`KNXUltimatehueEngine: classHUE: handleQueue: setLight grouped_light: ${error.message}`);
+              this.sysLogger.info(`KNXUltimatehueEngine: classHUE: processQueueItem: setLight grouped_light: ${error.message}`);
           }
           break;
         case "setScene":
@@ -134,7 +133,7 @@ class classHUE extends EventEmitter {
             await this.hueApiV2.put(`/resource/scene/${sceneID}`, jRet._state);
           } catch (error) {
             if (this.sysLogger !== undefined && this.sysLogger !== null)
-              this.sysLogger.info(`KNXUltimatehueEngine: classHUE: handleQueue: setScene: ${error.message}`);
+              this.sysLogger.info(`KNXUltimatehueEngine: classHUE: processQueueItem: setScene: ${error.message}`);
           }
           break;
         case "stopScene":
@@ -147,14 +146,14 @@ class classHUE extends EventEmitter {
               this.writeHueQueueAdd(light.rid, jRet._state, "setLight");
             });
           } catch (error) {
-            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error(`KNXUltimatehueEngine: classHUE: handleQueue: stopScene: ${error.message}`);
+            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error(`KNXUltimatehueEngine: classHUE: processQueueItem: stopScene: ${error.message}`);
           }
           break;
         case "Ping":
           try {
             const jReturn = await this.hueApiV2.get('/resource/bridge');
           } catch (error) {
-            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error(`KNXUltimatehueEngine: classHUE: handleQueue: Ping: ${error.message}`);
+            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error(`KNXUltimatehueEngine: classHUE: processQueueItem: Ping: ${error.message}`);
             if (this.timerCheckConnected !== null) clearInterval(this.timerCheckConnected);
             this.commandQueue = [];
             this.emit("disconnected");
@@ -174,10 +173,6 @@ class classHUE extends EventEmitter {
   handleQueue = async () => {
     // Verifica se è possibile eseguire una nuova richiesta
     do {
-      try {
-        const remainingRequests = await limiter.removeTokens(1);
-      } catch (error) {
-      }
       if (this.commandQueue !== undefined && this.commandQueue.length > 0) {
         //if (remainingRequests >= 0) {
         // OK, i can send
@@ -191,6 +186,7 @@ class classHUE extends EventEmitter {
         //console.log("\x1b[41m HO DETTO SPETA. remainingRequests=" + remainingRequests + "\x1b[0m " + new Date().toTimeString(), this.commandQueue.length, "remainingRequests " + remainingRequests);
         //}
       }
+      await pleaseWait(150);
     } while (this.closePushEventStream === false);
     //console.log("\x1b[42m End processing commandQueue \x1b[0m " + new Date().toTimeString(), this.commandQueue.length);
   };

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "3.2.16",
+  "version": "3.3.0",
   "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,8 +11,7 @@
     "dns-sync": "0.2.1",
     "eventsource": "2.0.2",
     "js-yaml": "4.1.0",
-    "knxultimate": "3.0.4",
-    "limiter": "^2.1.0",
+    "knxultimate": "4.0.0-beta.4",
     "lodash": "4.17.21",
     "node-color-log": "12.0.1",
     "mkdirp": "3.0.1",