node-red-contrib-knx-ultimate 3.2.0 → 3.2.1

package/CHANGELOG.md

@@ -6,9 +6,15 @@
 
 # CHANGELOG
 
+
+**Version 3.2.1-beta.0** - September 2024<br/>
+- Rewrote the logger engine and fixed some issues in the KNXUltimate package.<br/>
+- KNX engine: implemented a new "limiter" package for better calculate the maximum numbers of telegrams accepted by the KNX BUS.<br/>
+
 **Version 3.2.0** - September 2024<br/>
 - Major Version.<br/>
-- HUE engine: implemented a new "limiter" package for better calculate the maximum numbers of telegrams accepted by HUE Bridge.<br/>
+- HUE engine: implemented a new "limiter" package for better calculate the maximum numbers of telegrams accepted by the HUE Bridge.<br/>
+
 
 **Version 3.1.9** - September 2024<br/>
 - HUE Bridge: you can now register to a bridge with your own credentials.<br/>

package/nodes/commonFunctions.js

@@ -46,7 +46,6 @@ const toConcattedSubtypes = (acc, baseType) => {
 };
 // ####################
 
-
 module.exports = (RED) => {
     RED.plugins.registerPlugin("commonFunctions", {
         type: "foo",

package/nodes/hue-config.js

@@ -6,26 +6,32 @@
 /* eslint-disable max-len */
 const cloneDeep = require("lodash/cloneDeep");
 const HueClass = require("./utils/hueEngine").classHUE;
-const loggerEngine = require("./utils/sysLogger");
 const hueColorConverter = require("./utils/colorManipulators/hueColorConverter");
 
 
+// 10/09/2024 Setup the color logger
+loggerSetup = (options) => {
+  let clog = require("node-color-log").createNamedLogger(options.setPrefix);
+  clog.setLevel(options.loglevel);
+  clog.setDate(() => (new Date()).toLocaleString());
+  return clog;
+}
+
+
 module.exports = (RED) => {
   function hueConfig(config) {
     RED.nodes.createNode(this, config);
     const node = this;
     node.host = config.host;
     node.nodeClients = []; // Stores the registered clients
-    node.loglevel = config.loglevel !== undefined ? config.loglevel : "error"; // 18/02/2020 Loglevel default error
+    node.loglevel = config.loglevel !== undefined ? config.loglevel : "error"; // loglevel doesn'e exists yet
     node.sysLogger = null;
     node.hueAllResources = undefined;
     node.timerHUEConfigCheckState = null; // Timer that check the connection to the hue bridge every xx seconds
     node.linkStatus = "disconnected";
     try {
-      node.sysLogger = loggerEngine.set({ loglevel: node.loglevel }); // New logger to adhere to the loglevel selected in the config-window
-    } catch (error) {
-      /* empty */
-    }
+      node.sysLogger = loggerSetup({ loglevel: node.loglevel, setPrefix: "hue-config.js" });
+    } catch (error) { console.log(error.stack) }
     node.name = config.name === undefined || config.name === "" ? node.host : config.name;
 
     // Connect to Bridge and get the resources

package/nodes/knxUltimate-config copy.html

@@ -0,0 +1,456 @@
+<script type="text/javascript" src="resources/node-red-contrib-knx-ultimate/htmlUtils.js"></script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('knxUltimate-config', {
+        category: 'config',
+        defaults: {
+            host: { value: "224.0.23.12", required: true },
+            port: { value: 3671, required: true, validate: RED.validators.number() },
+            // the KNX physical address we'd like to use
+            physAddr: { value: "15.15.22", required: true },
+            hostProtocol: { value: "Auto", required: false }, // TunnelUDP/TunnelTCP/Multicast
+            // enable this option to suppress the acknowledge flag with outgoing L_Data.req requests. LoxOne needs this
+            suppressACKRequest: { value: false },
+            csv: { value: "", required: false },
+            KNXEthInterface: { value: "Auto" },
+            KNXEthInterfaceManuallyInput: { value: "" },
+            stopETSImportIfNoDatapoint: { value: "fake" },
+            loglevel: { value: "error" },
+            name: { value: "KNX Gateway" },
+            localEchoInTunneling: { value: true },
+            delaybetweentelegrams: { value: 50, required: false },
+            delaybetweentelegramsfurtherdelayREAD: { value: 1, required: false },
+            ignoreTelegramsWithRepeatedFlag: { value: false, required: false },
+            keyringFileXML: { value: "" },
+            knxSecureSelected: { value: false },
+            autoReconnect: { value: "yes" }
+        },
+        credentials: {
+            keyringFilePassword: { type: "password" }
+        },
+        oneditprepare: function () {
+            var node = this;
+
+            // 22/07/2021 Main tab
+            $("#tabsMain").tabs({
+                active: node.knxSecureSelected ? 1 : 0,
+                activate: function (event, ui) {
+                    node.knxSecureSelected = $(ui.newTab).index() === 1;
+                }
+            });
+
+            $("#node-config-input-KNXEthInterface").append($("<option></option>")
+                .attr("value", "Auto")
+                .text("Auto")
+            );
+            $("#node-config-input-KNXEthInterface").append($("<option></option>")
+                .attr("value", "Manual")
+                .text("Manually enter interface's name")
+            );
+
+            $.getJSON('knxUltimateETHInterfaces', (data) => {
+                data.sort().forEach(iFace => {
+                    $("#node-config-input-KNXEthInterface").append($("<option></option>")
+                        .attr("value", iFace.name)
+                        .text(iFace.name + " (" + iFace.address + ")")
+                    )
+                });
+                $("#node-config-input-KNXEthInterface").val(typeof node.KNXEthInterface === "undefined" ? "Auto" : node.KNXEthInterface)
+                if (node.KNXEthInterface === "Manual") {
+                    // Show input
+                    $("#divKNXEthInterfaceManuallyInput").show();
+                } else {
+                    $("#divKNXEthInterfaceManuallyInput").hide()
+                }
+
+                $("#node-config-input-KNXEthInterface").on('change', function () {
+                    if ($("#node-config-input-KNXEthInterface").val() === "Manual") {
+                        // Show input
+                        $("#divKNXEthInterfaceManuallyInput").show();
+                    } else {
+                        // Hide input
+                        $("#divKNXEthInterfaceManuallyInput").hide()
+                    }
+                });
+            });
+
+
+            // 14/08/2021 Elimino il file delle persistenze di questo nodo
+            $.getJSON("deletePersistGAFile?serverId=" + node.id, (data) => { });
+
+            // 06/07/2023 Tabs
+            // *****************************
+            $("#tabs").tabs();
+            // *****************************
+
+
+
+            var sRetDebugText = "";
+            $("#getinfocam").click(function () {
+                sRetDebugText = "";
+                $("#divDebugText").show();
+                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);
+            });
+            $("#getallgaused").click(function () {
+                sRetDebugText = "";
+                $("#divDebugText").show();
+                let aFound = [];
+                RED.nodes.eachNode(function (node) {
+                    if (!aFound.includes(node.topic)) {
+                        aFound.push(node.topic);
+                        sRetDebugText += node.topic + "\r"
+                    }
+                });
+                sRetDebugText = 'Copy these group addresses in your routing table list of your KNX/IP router.\r' + sRetDebugText;
+                $("#debugText").val(sRetDebugText); // Store the config-node);
+            });
+
+
+
+        },
+        oneditsave: function () {
+            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() != "")) {
+                var checkResult = node._("knxUltimate-config.ets.deploywithETS");
+                var myNotification = RED.notify(checkResult,
+                    {
+                        modal: true,
+                        fixed: true,
+                        type: 'info',
+                        buttons: [
+                            {
+                                text: "OK",
+                                click: function (e) {
+                                    myNotification.close();
+                                }
+                            }]
+                    })
+            }
+        },
+        label: function () {
+            return typeof this.name === undefined ? (this.host + ":" + this.port) : this.name + " " + (this.host + ":" + this.port);
+        }
+    });
+</script>
+<style>
+    .ui-tabs {
+        background: transparent;
+        border: none;
+    }
+
+    .ui-tabs .ui-widget-header {
+        background: transparent;
+        border: none;
+        border-bottom: 1px solid #c0c0c0;
+        -moz-border-radius: 0px;
+        -webkit-border-radius: 0px;
+        border-radius: 0px;
+    }
+
+    .ui-tabs .ui-tabs-nav .ui-state-default {
+        background: transparent;
+        border: none;
+    }
+
+    .ui-tabs .ui-tabs-nav .ui-state-active {
+        background: transparent no-repeat bottom center;
+        border: none;
+    }
+
+    .ui-tabs .ui-tabs-nav .ui-state-default a {
+        color: #878787;
+        outline: none;
+    }
+
+    .ui-tabs .ui-tabs-nav .ui-state-active a {
+        color: #377e00;
+        border-bottom: 1px solid#377e00;
+        outline: none;
+    }
+</style>
+
+
+<script type="text/html" data-template-name="knxUltimate-config">
+    <div class="form-row">
+       <b><span data-i18n="knxUltimate-config.properties.title"></span></b>&nbsp&nbsp<span style="color:red" data-i18n="[html]knxUltimate-config.properties.helplink"></span>
+        <br/><br/>       
+    </div>
+   
+        <div class="form-row">
+            <label for="node-config-input-name" style="width: 200px" >
+                <i class="fa fa-tag"></i> Name </label>
+            <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">
+        </div>
+    
+    <!-- KNX Secure / Unsecure tabbed selector-->
+    <!-- <div id="tabsMain" style="display: none;"> -->
+   <!--  <div id="tabsMain">
+        <ul>
+          <li><a href="#unsecureKNX"><i class="fa fa-circle-o"></i>&nbsp;<span data-i18n="knxUltimate-config.properties.unsecureKNX"></span></a></li>
+          <li><a href="#SecureKNX"><i class="fa fa-shield"></i>&nbsp;<span data-i18n="knxUltimate-config.properties.secureKNX"></span></a></li>
+        </ul>
+        <div id="unsecureKNX" style="margin: 5px 5px 5px 5px;">
+            <p>
+            </p>
+         </div>
+        <div id="SecureKNX" style="margin: 5px 5px 5px 5px;" >
+            <p>
+                <p>WARNING: KNX SECURE IS STILL UNDER DEVELOPMENT</p>
+                <div class="form-row">
+                    <i class="fa fa-youtube"></i>
+                    <a href="https://youtu.be/OpR7ZQTlMRU" target="_blank">
+                        <span data-i18n="knxUltimate-config.ets.youtubeKeyring"></span>
+                    </a>
+                </div>
+                <div class="form-row">
+                    Keyring file
+                    <textarea rows="5" id="node-config-input-keyringFileXML" style="width:100%" data-i18n="[placeholder]knxUltimate-config.ets.keyring"></textarea>
+                </div>
+                <div class="form-row">
+                    <label for="node-config-input-keyringFilePassword"><i class="fa fa-shield"></i> Password</label>
+                    <input type="password" id="node-config-input-keyringFilePassword" style="width:200px;">               
+                </div>
+            </p>   
+        </div>
+      </div> -->
+    
+      <br/>
+
+<div id="tabs">
+    <ul>
+        <li><a href="#tabs-1"><i class="fa fa-list-ol"></i> Configuration</a></li>
+        <li><a href="#tabs-2"><i class="fa fa-braille"></i> Advanced</a></li>
+        <li><a href="#tabs-3"><i class="fa fa-code"></i> ETS file import</a></li>
+        <li><a href="#tabs-4"><i class="fa fa-key"></i> Utility</a></li>
+    </ul>
+    <div id="tabs-1">
+        <p>
+
+            <div class="form-row">
+                <label for="node-config-input-port" style="width: 200px">
+                   IP Port
+                </label>
+                <input type="text" id="node-config-input-port" style="width: 100px">
+            </div>
+            <div class="form-row">
+                <label for="node-config-input-hostProtocol" style="width: 200px">
+                   IP Protocol
+                </label>
+                <select id="node-config-input-hostProtocol" >
+                    <option value="Auto" >Auto</option>
+                    <option value="TunnelUDP" >Tunnel UDP (KNX/IP Interface)</option>
+                    <option value="Multicast" >Multicast (KNX/IP Router)</option>
+                    <!-- <option value="TunnelTCP" >Tunnel TCP</option> -->
+                </select>   
+            </div>
+            <div class="form-row">
+                <label for="node-config-input-physAddr" style="width: 200px">
+                    <i class="fa fa-microchip"></i>
+                    <span data-i18n="knxUltimate-config.advanced.knx_phy_addr"></span>
+                </label>
+                <input type="text" id="node-config-input-physAddr" style="width:100px">
+            </div>
+
+            <div class="form-row">
+                <label for="node-config-input-KNXEthInterface" style="width: 200px">
+                    <i class="fa fa-wifi"></i>
+                    <span data-i18n="knxUltimate-config.properties.bind_local_int"></span>
+                </label>
+                <select id="node-config-input-KNXEthInterface"></select>
+            </div>
+            <div class="form-row" id="divKNXEthInterfaceManuallyInput" style="display: none;">
+                <label for="node-config-input-KNXEthInterfaceManuallyInput">Interface name:</label>
+                <input type="text" id="node-config-input-KNXEthInterfaceManuallyInput"
+                    placeholder="Interface name, ex: eth0 or ens1 or Ethernet 1 and so on...">
+            </div>
+            <div class="form-row">
+                <label for="node-config-input-autoReconnect" style="width: 200px">
+                    <i class="fa fa-plug"></i>
+                    <span data-i18n="knxUltimate-config.properties.autoReconnect"></span>
+                </label>
+                <select id="node-config-input-autoReconnect">
+                    <option value="yes" data-i18n="knxUltimate-config.properties.autoReconnect_yes"></option>
+                    <option value="no" data-i18n="knxUltimate-config.properties.autoReconnect_no"></option>
+                </select>
+            </div>
+        </p>
+    </div>
+    <div id="tabs-2">
+        <p>
+            <div class="form-row">
+                <input type="checkbox" id="node-config-input-localEchoInTunneling"
+                    style="display:inline-block; width:auto; vertical-align:top;">
+                <label style="width:85%" for="node-config-input-localEchoInTunneling">
+                    <i class="fa fa-bullhorn"></i>
+                    <span data-i18n="knxUltimate-config.advanced.localEchoInTunneling"></span>
+                </label>
+            </div>
+
+            <div class="form-row">
+                <input type="checkbox" id="node-config-input-ignoreTelegramsWithRepeatedFlag"
+                    style="display:inline-block; width:auto; vertical-align:top;">
+                <label style="width:85%" for="node-config-input-ignoreTelegramsWithRepeatedFlag">
+                    <i class="fa fa-ban"></i>
+                    <span data-i18n="knxUltimate-config.advanced.ignoreTelegramsWithRepeatedFlag"></span>
+                </label>
+            </div>
+
+            <div class="form-row">
+                <input type="checkbox" id="node-config-input-suppressACKRequest"
+                    style="display:inline-block; width:auto; vertical-align:top;">
+                <label style="width:85%" for="node-config-input-suppressACKRequest">
+                    <i class="fa fa-ban"></i>
+                    <span data-i18n="knxUltimate-config.advanced.suppress_ack"></span>
+                </label>
+            </div>
+
+            <div class="form-row">
+                <label for="node-config-input-delaybetweentelegrams" style="width:auto">
+                    <i class="fa fa-hourglass-start"></i>
+                    <span data-i18n="knxUltimate-config.advanced.delaybetweentelegrams"></span>
+                </label>
+                <input type="number" id="node-config-input-delaybetweentelegrams" style="width:20%">
+                <span data-i18n="knxUltimate-config.advanced.delaybetweentelegramsfurtherdelayREAD"></span><input type="number"
+                    id="node-config-input-delaybetweentelegramsfurtherdelayREAD" style="width:15%">X
+            </div>
+
+            <div class="form-row">
+                <label for="node-config-input-loglevel">
+                    <i class="fa fa-question-circle"></i>
+                    <span data-i18n="knxUltimate-config.advanced.log_level"></span>
+                </label>
+                <select id="node-config-input-loglevel" style="width:40%;">
+                    <option value="silent" data-i18n="knxUltimate-config.advanced.select_silent"></option>
+                    <option value="error" data-i18n="knxUltimate-config.advanced.select_error"></option>
+                    <option value="warn" data-i18n="knxUltimate-config.advanced.select_warning"></option>
+                    <option value="info" data-i18n="knxUltimate-config.advanced.select_info"></option>
+                    <option value="debug" data-i18n="knxUltimate-config.advanced.select_debug"></option>
+                    <option value="trace" data-i18n="knxUltimate-config.advanced.select_trace"></option>
+                </select>
+                <!-- <div class="form-tips" style="margin-top: 11px;background-color:#FFEEEE;text-align:center">
+                                <b><span data-i18n="knxUltimate-config.properties.restart_hint"></span></b>
+                            </div> -->
+            </div>
+        </p>
+    </div>
+    <div id="tabs-3">
+        <p>
+            <div id="etsCSVListBox">
+                <h3><span data-i18n="knxUltimate-config.properties.ets_import"></span></h3>
+                <div>
+                    <div class="form-row">
+                        <span data-i18n="knxUltimate-config.ets.description"></span>
+                    </div>
+                    <div class="form-row">
+                        <span style="color:red" data-i18n="[html]knxUltimate-config.ets.instruction"></span>
+                    </div>
+                    <div class="form-row">
+                        <span style="color:red" data-i18n="[html]knxUltimate-config.ets.youtube"></span>
+                    </div>
+                    <div class="form-row">
+                        <label for="node-config-input-stopETSImportIfNoDatapoint" style="width:250px">
+                            <i class="fa fa-question-circle"></i>
+                            <span data-i18n="knxUltimate-config.ets.help_ga"></span>
+                        </label>
+                        <select id="node-config-input-stopETSImportIfNoDatapoint" style="width:210px">
+                            <option value="stop" data-i18n="knxUltimate-config.ets.import_select_stop"></option>
+                            <option value="fake" data-i18n="knxUltimate-config.ets.import_select_fake"></option>
+                            <option value="skip" data-i18n="knxUltimate-config.ets.import_select_skip"></option>
+                        </select>
+                    </div>
+                    <div class="form-row">
+                        <label style="width:auto" for="node-config-input-csv">
+                            <i class="fa fa-th-list"></i> ETS group address list
+                        </label>
+                    </div>
+                    <div class="form-row">
+                        <textarea rows="20" id="node-config-input-csv" style="width:100%"
+                            data-i18n="[placeholder]knxUltimate-config.ets.ga_list_help"></textarea>
+                    </div>
+                </div>
+            </div>                       
+        </p>
+    </div>
+
+    <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>
+                <input type="button" id="getinfocam" class="ui-button ui-corner-all ui-widget"
+                    style="background-color:#AEE1FF;width:150px" value="Read">
+            </div>
+            <div class="form-row">
+                <label style="width:300px"><i class="fa fa-sign-in"></i> Get all used GA for KNX routing filter</label>
+                <input type="button" id="getallgaused" class="ui-button ui-corner-all ui-widget"
+                    style="background-color:#AEE1FF;width:150px" value="Read">
+            </div>
+            <div class="form-row" id="divDebugText" style="display: none;">                
+                <textarea rows="10" id="debugText" style="width:100%"></textarea>
+            </div>
+        </p>
+    </div>
+</div>
+  
+</script>
+<script type="text/markdown" data-help-name="knxUltimate-config">
+<p>This node connects to your KNX/IP Gateway.</p>
+
+**General**
+|Property|Description|
+|--|--|
+| Name | Node name. |
+| IP/Hostname | ETH/KNX Router multicast address or Interface unicast IP address. If you have an KNX/IP interface, use the interface's IP address, for example 1982.168.1.22, otherwise, if you have a KNX/IP router, put the multicast address 224.0.23.12. You can also type an **Hostname** instead of an IP. |
+
+<br/>
+
+**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 |
+
+<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. |
+
+<br/>
+
+**ETS file import**
+|Property|Description|
+|--|--|
+| If Group Address has no Datapoint | If a group address doesn't have a datapoint, it allow to choose wether to stop import, import quth a fake datapoint of 1.001 or to skip import of that group address | 
+| ETS group address list | Use this section to import your ETS CSV or ESF file. You can either **paste the CSV or ESF file content** or **set the file path**, for example *./pi/homecsv.csv*. Please refer to the help links for further infos. |
+
+<br/>
+
+**Utility**
+|Property|Description|
+|--|--|
+| Gather debug info for troubleshoot | Please click the button and add it to the gitHub issue you want to open, it will help me a lot to helping you. |
+| Get all used GA for KNX routing filter | Press READ to retrieve a plain text list of all group address belonging to this gateway, that has been used in the flows. You can use this list to populate your KNX/IP router filter table. |
+
+<br/>
+
+[![Donate via PayPal](https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/CodiceQR.png)](https://www.paypal.com/donate/?hosted_button_id=S8SKPUBSPK758)
+        
+</script>