node-red-contrib-knx-ultimate 3.2.9 → 3.2.11

package/CHANGELOG.md

@@ -6,6 +6,14 @@
 
 # CHANGELOG
 
+**Version 3.2.11** - October 2024<br/>
+- Fixed help texts in various nodes.<br/>
+- When you open a node, the node red's site bar goest into the help panel. Then, it goes into the info panel once closed.<br/>
+- Gather debug infos + log to be pasted into a new gitHub Issue. See the "Utility" TAB of the KNX Gateway config node. See DISCUSSIONS on gitHub.<br/>
+
+**Version 3.2.10** - October 2024<br/>
+- Fixed a race condition happening whenever FULL DEPLOY is pressed in the node-red interface, preventing the HUE bridge node to gracefully disconnect from the HUE Bridge.<br/>
+
 **Version 3.2.9** - October 2024<br/>
 - Maintenance release: added some log to better identify problems.<br/>
 

package/KNXUltimateDebugLog.txt

@@ -0,0 +1,49 @@
+START LOG FILE --------------------------------------------
+-> 10/5/2024, 12:14:53 PM [knxUltimate <08b25df88e6668d3>] [info] Close: node id 08b25df88e6668d3 with topic 5/6/7 has been removed from the server. 
+-> 10/5/2024, 12:14:53 PM [knxUltimate <Universal KNX>] [info] Close: node id 94644e7ae5ca6002 with topic  has been removed from the server. 
+-> 10/5/2024, 12:14:53 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Disconnect: already not connected:disconnected, node.autoReconnect:true 
+-> 10/5/2024, 12:14:53 PM [knxUltimate-config <KNX Gateway senza csv>] [info] KNXClient socket closed. 
+-> 10/5/2024, 12:16:37 PM [knxUltimate-config <KNX Gateway senza csv>] NEW LOG SESSION --------------------------------------------
+-> 10/5/2024, 12:16:37 PM [knxUltimate-config <KNX Gateway senza csv>] [info] payload cache set to /Users/massimosaccani/.node-red/knxultimatestorage/knxpersistvalues 
+-> 10/5/2024, 12:16:37 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Autoconnection: yes Node KNX Gateway senza csv 
+-> 10/5/2024, 12:16:37 PM [knxUltimate <08b25df88e6668d3>] NEW LOG SESSION --------------------------------------------
+-> 10/5/2024, 12:16:37 PM [knxUltimate <Universal KNX>] NEW LOG SESSION --------------------------------------------
+-> 10/5/2024, 12:16:40 PM [knxUltimate <08b25df88e6668d3>] [info] Close: node id 08b25df88e6668d3 with topic 5/6/7 has been removed from the server. 
+-> 10/5/2024, 12:16:40 PM [knxUltimate <Universal KNX>] [info] Close: node id 94644e7ae5ca6002 with topic  has been removed from the server. 
+-> 10/5/2024, 12:16:40 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Disconnect: already not connected:disconnected, node.autoReconnect:true 
+-> 10/5/2024, 12:16:40 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Disconnect: already not connected:disconnected, node.autoReconnect:true 
+-> 10/5/2024, 12:16:44 PM [knxUltimate-config <KNX Gateway senza csv>] NEW LOG SESSION --------------------------------------------
+-> 10/5/2024, 12:16:44 PM [knxUltimate-config <KNX Gateway senza csv>] [info] payload cache set to /Users/massimosaccani/.node-red/knxultimatestorage/knxpersistvalues 
+-> 10/5/2024, 12:16:44 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Autoconnection: yes Node KNX Gateway senza csv 
+-> 10/5/2024, 12:16:44 PM [knxUltimate <08b25df88e6668d3>] NEW LOG SESSION --------------------------------------------
+-> 10/5/2024, 12:16:44 PM [knxUltimate <Universal KNX>] NEW LOG SESSION --------------------------------------------
+-> 10/5/2024, 12:16:48 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Auto Reconect by timerKNXUltimateCheckState in progress. node.LinkStatus: disconnected, node.autoReconnect:true 
+-> 10/5/2024, 12:16:48 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Bind KNX Bus to interface (Auto). Node KNX Gateway senza csv 
+-> 10/5/2024, 12:16:48 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Disconnect: already not connected:disconnected, node.autoReconnect:true 
+-> 10/5/2024, 12:16:48 PM [knxUltimate-config <KNX Gateway senza csv>] [info] perform websocket connection on KNX Gateway senza csv 
+-> 10/5/2024, 12:16:48 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Connecting... KNX Gateway senza csv 
+-> 10/5/2024, 12:16:48 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Connecting to224.0.23.12 
+-> 10/5/2024, 12:16:48 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Connected to %o {"physAddr":"15.15.22","connectionKeepAliveTimeout":60,"ipAddr":"224.0.23.12","ipPort":3671,"hostProtocol":"Multicast","isSecureKNXEnabled":false,"suppress_ack_ldatareq":false,"loglevel":"info","localEchoInTunneling":true,"localIPAddress":"192.168.1.198","interface":"","jKNXSecureKeyring":null,"KNXQueueSendIntervalMilliseconds":25} 
+-> 10/5/2024, 12:16:49 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Loaded saved GA values 142 
+-> 10/5/2024, 12:16:49 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Do DoInitialReadFromKNXBusOrFile 
+-> 10/5/2024, 12:16:53 PM [knxUltimate <08b25df88e6668d3>] [info] Close: node id 08b25df88e6668d3 with topic 5/6/7 has been removed from the server. 
+-> 10/5/2024, 12:16:53 PM [knxUltimate <Universal KNX>] [info] Close: node id 94644e7ae5ca6002 with topic  has been removed from the server. 
+-> 10/5/2024, 12:16:53 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Disconnect: already not connected:disconnected, node.autoReconnect:true 
+-> 10/5/2024, 12:16:54 PM [knxUltimate-config <KNX Gateway senza csv>] NEW LOG SESSION --------------------------------------------
+-> 10/5/2024, 12:16:54 PM [knxUltimate-config <KNX Gateway senza csv>] [info] payload cache set to /Users/massimosaccani/.node-red/knxultimatestorage/knxpersistvalues 
+-> 10/5/2024, 12:16:54 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Autoconnection: yes Node KNX Gateway senza csv 
+-> 10/5/2024, 12:16:54 PM [knxUltimate <08b25df88e6668d3>] NEW LOG SESSION --------------------------------------------
+-> 10/5/2024, 12:16:54 PM [knxUltimate <Universal KNX>] NEW LOG SESSION --------------------------------------------
+-> 10/5/2024, 12:16:58 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Auto Reconect by timerKNXUltimateCheckState in progress. node.LinkStatus: disconnected, node.autoReconnect:true 
+-> 10/5/2024, 12:16:58 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Bind KNX Bus to interface (Auto). Node KNX Gateway senza csv 
+-> 10/5/2024, 12:16:58 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Disconnect: already not connected:disconnected, node.autoReconnect:true 
+-> 10/5/2024, 12:16:58 PM [knxUltimate-config <KNX Gateway senza csv>] [info] perform websocket connection on KNX Gateway senza csv 
+-> 10/5/2024, 12:16:58 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Connecting... KNX Gateway senza csv 
+-> 10/5/2024, 12:16:58 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Connecting to224.0.23.12 
+-> 10/5/2024, 12:16:58 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Connected to %o {"physAddr":"15.15.22","connectionKeepAliveTimeout":60,"ipAddr":"224.0.23.12","ipPort":3671,"hostProtocol":"Multicast","isSecureKNXEnabled":false,"suppress_ack_ldatareq":false,"loglevel":"info","localEchoInTunneling":true,"localIPAddress":"192.168.1.198","interface":"","jKNXSecureKeyring":null,"KNXQueueSendIntervalMilliseconds":25} 
+-> 10/5/2024, 12:16:59 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Loaded saved GA values 142 
+-> 10/5/2024, 12:16:59 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Do DoInitialReadFromKNXBusOrFile 
+-> 10/5/2024, 12:22:23 PM [knxUltimate <08b25df88e6668d3>] [info] Close: node id 08b25df88e6668d3 with topic 5/6/7 has been removed from the server. 
+-> 10/5/2024, 12:22:23 PM [knxUltimate <Universal KNX>] [info] Close: node id 94644e7ae5ca6002 with topic  has been removed from the server. 
+-> 10/5/2024, 12:22:23 PM [knxUltimate-config <KNX Gateway senza csv>] [info] Disconnect: already not connected:disconnected, node.autoReconnect:true 
+-> 10/5/2024, 12:22:23 PM [knxUltimate-config <KNX Gateway senza csv>] [info] KNXClient socket closed. 

package/nodes/commonFunctions.js

@@ -66,11 +66,16 @@ module.exports = (RED) => {
             try {
                 const serverId = RED.nodes.getNode(req.query.serverId); // Retrieve node.id of the config node.
                 if (serverId.hueAllResources === null || serverId.hueAllResources === undefined) {
-                    res.json({ ready: false });
+                    (async function main() {
+                        await serverId.loadResourcesFromHUEBridge();
+                        res.json({ ready: false });
+                    }()).catch();
                 } else {
                     res.json({ ready: true });
                 }
             } catch (error) {
+                RED.log.error(`Errore RED.httpAdmin.get('/knxultimateCheckHueConnected' ${error.message}`);
+
                 res.json({ ready: false });
             }
         });
@@ -302,6 +307,18 @@ module.exports = (RED) => {
             res.json(jListInterfaces);
         });
 
+        // 14/08/2019 Endpoint for retrieving the ethernet interfaces
+        RED.httpAdmin.get("/KNUltimateGetLogFile", (req, res) => {
+            try {
+                const log = fs.readFileSync('./KNXUltimateDebugLog.txt')
+                res.json(log.toString());
+            } catch (error) {
+                res.json(error.message);
+            }
+
+        });
+
+
         // 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/hue-config.html

@@ -14,6 +14,11 @@
             clientkey: { type: "password" }
         },
         oneditprepare: function () {
+            // Go to the help panel
+            try {
+                RED.sidebar.show("help");
+            } catch (error) { }
+
 
             var node = this;
 
@@ -144,6 +149,11 @@
             })
         },
         oneditsave: function () {
+            // Return to the info tab
+            try {
+                RED.sidebar.show("info");
+            } catch (error) { }
+
 
         },
         label: function () {

package/nodes/hue-config.js

@@ -477,18 +477,17 @@ module.exports = (RED) => {
     node.on("close", (done) => {
       try {
         if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger = null;
-        loggerEngine.destroy();
         node.nodeClients = [];
-        node.hueManager.removeAllListeners();
+        if (node.hueManager !== undefined && node.hueManager !== null) node.hueManager.removeAllListeners();
         (async () => {
           try {
             await node.hueManager.close();
             node.hueManager = null;
             delete node.hueManager;
+            done();
           } catch (error) {
-            /* empty */
+            done();
           }
-          done();
         })();
       } catch (error) {
         done();

package/nodes/knxUltimate-config copy.html

@@ -29,6 +29,11 @@
             keyringFilePassword: { type: "password" }
         },
         oneditprepare: function () {
+            // Go to the help panel
+            try {
+                RED.sidebar.show("help");
+            } catch (error) { }
+
             var node = this;
 
             // 22/07/2021 Main tab
@@ -113,6 +118,11 @@
 
         },
         oneditsave: function () {
+            // Return to the info tab
+            try {
+                RED.sidebar.show("info");
+            } catch (error) { }
+
             var node = this;
             // Check if the csv file contains errors
             if (($("#node-config-input-csv").val() != 'undefined' && $("#node-config-input-csv").val() != "") || ($("#node-config-input-keyring").val() != 'undefined' && $("#node-config-input-keyring").val() != "")) {

package/nodes/knxUltimate-config.html

@@ -28,6 +28,11 @@
             keyringFilePassword: { type: "password" }
         },
         oneditprepare: function () {
+            // Go to the help panel
+            try {
+                RED.sidebar.show("help");
+            } catch (error) { }
+
             var node = this;
 
             // 22/07/2021 Main tab
@@ -91,8 +96,13 @@
                 for (const [key, value] of Object.entries(node)) {
                     sRetDebugText += (`-> ${key}: ${value}\r`);
                 }
-                sRetDebugText = 'Open a new github issue and paste this text into it. https://github.com/Supergiovane/node-red-contrib-knx-ultimate/issues/new?assignees=Supergiovane&labels=&template=bug_report.md&title=KNXDebugText\r\r' + sRetDebugText;
-                $("#debugText").val(sRetDebugText); // Store the config-node);
+                // 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);
+                });
+
             });
             $("#getallgaused").click(function () {
                 sRetDebugText = "";
@@ -112,6 +122,11 @@
 
         },
         oneditsave: function () {
+            // Return to the info tab
+            try {
+                RED.sidebar.show("info");
+            } catch (error) { }
+
             var node = this;
             // Check if the csv file contains errors
             if (($("#node-config-input-csv").val() != 'undefined' && $("#node-config-input-csv").val() != "") || ($("#node-config-input-keyring").val() != 'undefined' && $("#node-config-input-keyring").val() != "")) {
@@ -380,7 +395,7 @@
     <div id="tabs-4">
         <p>
             <div class="form-row">
-                <label style="width:300px"><i class="fa fa-sign-in"></i> Gather debug info for troubleshoot</label>
+                <label style="width:300px"><i class="fa fa-sign-in"></i> Gather debug and log for troubleshoot</label>
                 <input type="button" id="getinfocam" class="ui-button ui-corner-all ui-widget"
                     style="background-color:#AEE1FF;width:150px" value="Read">
             </div>
@@ -411,22 +426,22 @@
 **Configuration**
 |Property|Description|
 |--|--|
-| IP Port | The port. |
-| IP Protocol | *Tunnel UDP* is for KNX/IP interfaces, *Multicast UDP* is for KNX/IP Routers. Leave **Auto** for auto detect. |
-| 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. |
-| Automatically connect to KNX BUS at start | Auto connect to the bus at start. You want to leave it enabled. |
-| KNX Physical Address | The physical KNX address, example 1.1.200 |
+| 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". |
+| 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". |
 
 <br/>
 
 **Advanced**
 |Property|Description|
 |--|--|
-| Suppress repeated (R-Flag) telegrams fom BUS | Ignore repeated KNX telegrams coming from the bus. |
-| Suppress ACK request in tunneling mode | Enable it if you have a very old KNX/IP gateway. You want to leave it disabled. |
-| Delay between each telegram (in milliseconds) | Leave it 50ms, unless you're connecting to a remote KNX Gateway via a slow internet connection. |
-| and further multiply delay only between -read- telegrams | Multiply the delay for read requests to the KNX bus. Again, for slow KNX Gateways. |
-| Loglevel | Log level, in case you need to debug something with the dev. |
+| 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). |
+| Loglevel | Log level, in case you need to debug something with the dev. Default is "Error", |
 
 <br/>