node-red-contrib-knx-ultimate 3.0.0-beta2 → 3.0.0-beta3

package/CHANGELOG.md

@@ -6,6 +6,11 @@
 
 # CHANGELOG
 
+**Version 3.0.0-beta3** - Juni 2024<br/>
+- Warning: Node-Red version **equals or major than 3.1.1** is needed to run this node.<br/>
+- Chore: "betterized" the description for some captions in the KNX Device node. </br>
+- NEW: KNX Viewer node: added an output PIN (third) you can use to monitor the KNX BUS congestion.</br>
+
 **Version 3.0.0-beta2** - Juni 2024<br/>
 - Warning: Node-Red version **equals or major than 3.1.1** is needed to run this node.<br/>
 - NEW: Hue Node Software Update Status for the HUE devices. <br/>

package/nodes/knxUltimate.html

@@ -498,7 +498,7 @@
             <div class="form-row" style="padding:10px">
                 <div class="form-row">
                     <dt>
-                        <i class="fa fa-arrow-right"></i> CONTROL (payload to KNX bus)
+                        <i class="fa fa-arrow-right"></i> SEND msg to KNX BUS
                     </dt>
                 </div>
                 <div class="form-row">
@@ -524,7 +524,7 @@
                 <br />
                 <div class="form-row">
                     <dt>
-                        |<i class="fa fa-arrow-right"></i> STATUS (payload from KNX BUS)
+                        |<i class="fa fa-arrow-right"></i> RECEIVE msg from KNX BUS
                     </dt>
                 </div>
                 <div class="form-row" id="divNode-input-initialread">
@@ -685,10 +685,10 @@
 **Advanced options**
 |Property|Description|
 |--|--|
-||**CONTROL (payload to KNX bus)**|
+||**SEND msg to KNX BUS**|
 | Telegram type | *write* to send write telegram (usually, you want that), otherwise you can choose the telegram's type to react to. |
 | RBE filter (in the CONTROL section) | *Report by change* filter. If set, only the msg input (from the Flow) having different values each time, will be sent to the KNX bus. If you intend to send everytime the same value, turn it off. |
-||**STATUS (payload from KNX BUS)**|
+||**RECEIVE msg from KNX BUS**|
 | Read status on start | Read group address status, every time Node-Red starts and at every reconnection to the KNX Gateway. The node stores all group address values to a file, so you can choose wether to read from file or from the KNX bus. |
 | RBE filter (in the STATUS section)| *Report by change* filter. If set, only the msg output (to KNX bus) having different values each time, will be sent to the msg output's flow. If you intend to send everytime the same value, leave it off. |
 | React to write telegrams | The node will react (will send a msg to the flow) each time it receives a *write* telegram from the KNX bus. Usually, you want that. |

package/nodes/knxUltimateViewer.html

@@ -10,14 +10,17 @@
             name: { value: "KNXViewer", required: false }
         },
         inputs: 0,
-        outputs: 2,
+        outputs: 3,
         outputLabels: function (i) {
             switch (i) {
                 case 0:
-                    return "Formatted Payload";
+                    return "Dashboard Group Addresses";
                     break;
                 case 1:
-                    return "Simple Array";
+                    return "Simple Array Json for data recording";
+                    break;
+                case 2:
+                    return "Dashboard Telegrams queue";
                     break;
                 default:
                     break;
@@ -85,10 +88,10 @@
 </script>
 
 <script type="text/markdown" data-help-name="knxUltimateViewer">
-View all group addresses and their values in a Dashboard widget.  
+View all group addresses and their values in a Dashboard widget, as well as JSON Oblect output and KNX transmission queue congestion.  
+
+For all output pins marked as "Dashboard.. ", the node works in conjunction with the Node-Red dashboard UI Template node.
 
-This node works in conjunction with the Node-Red dashboard UI Template node.
-View all group addresses and their values in a Dashboard widget.
 
 **General**
 |Property|Description|
@@ -98,12 +101,28 @@ View all group addresses and their values in a Dashboard widget.
 |
 <br/>
 
-### Outputs
+### Outputs PINS
 
-1. Standard output
-: payload (json) : formatted payload. Connect it directly with the Template UI node.
-2. Array of objects
+1. Dashboard Group Addresses
+: payload (html) : Connect it directly with the Template UI node. It creates a table with all Group Addresses and their values.
+2. Simple Array JSON for data recording
 : payload (array) : An array containing all the GA. You can use the array to do your own format and reordering.
+2. Dashboard telegrams queue
+: payload (html) : Connect it directly with the Template UI node. It creates a table with the KNX transmission queue for monitoring BUS congestion.
+
+<br/>
+<br/>
+
+## SAMPLE
+
+<img src="https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/wiki/viewer2.png" width="90%"><br/>
+
+In this example, you can see how the Viewer works.<br/>
+Just put a Viewer node in your flow and attach a Template UI node behind it.<br/>
+The **template** node (Dashboard's Template UI) contains the default text:<br/>
+The Output is something as follows:<br/>
+
+<img src="https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/wiki/viewer1.png" width="90%"><br/>
 
 <br/>
 

package/nodes/knxUltimateViewer.js

@@ -1,4 +1,5 @@
 const KNXAddress = require('knxultimate').KNXAddress;
+const _ = require("lodash");
 
 module.exports = function (RED) {
   function knxUltimateViewer(config) {
@@ -24,7 +25,7 @@ module.exports = function (RED) {
     node.formatmultiplyvalue = 1;
     node.formatnegativevalue = 'leave';
     node.formatdecimalsvalue = 2;
-
+    node.timerPIN3 = null;
     node.exposedGAs = [];
 
     // Used to call the status update from the config node.
@@ -59,11 +60,24 @@ module.exports = function (RED) {
         oGa.payloadmeasureunit = (msg.payloadmeasureunit !== 'unknown' ? ' ' + msg.payloadmeasureunit : '');
       }
       // Output the payload
-      node.createPayload();
+      let PIN1 = node.createPayloadPIN1();
+      let PIN2 = node.createPayloadPIN2();
+      let PIN3 = node.createPayloadPIN3();
+      node.send([PIN1, PIN2, PIN3]);
     };
 
-    node.createPayload = () => {
-      const sHead = `<table>
+    node.createPayloadPIN1 = () => {
+
+      const aSorted = node.exposedGAs.sort((a, b) => {
+        if (a.addressRAW !== undefined && b.addressRAW !== undefined) {
+          return a.addressRAW > b.addressRAW ? 1 : -1;
+        } else {
+          return a.addressRAW !== undefined ? 1 : -1;
+        }
+      });
+      let sPayload = '';
+
+      const sHead = `<div class="main"><table><caption>Current received KNX Group address values</caption>
             <thead>
               <tr>
                 <th> GA </th>
@@ -74,17 +88,14 @@ module.exports = function (RED) {
               </tr>
             </thead>
             <tbody>`;
-      const sFooter = `</tbody>
-            </table>`;
-      let sPayload = '';
+      const sFooter = `</tbody><tfoot>
+            <tr>
+              <th scope="row">Count</th>
+              <td>` + aSorted.length + `</td>
+            </tr>
+          </tfoot>
+          </table></div>`;
 
-      const aSorted = node.exposedGAs.sort((a, b) => {
-        if (a.addressRAW !== undefined && b.addressRAW !== undefined) {
-          return a.addressRAW > b.addressRAW ? 1 : -1;
-        } else {
-          return a.addressRAW !== undefined ? 1 : -1;
-        }
-      });
       try {
         for (let index = 0; index < aSorted.length; index++) {
           const element = aSorted[index];
@@ -114,15 +125,87 @@ module.exports = function (RED) {
       } catch (error) {
 
       }
+      return { topic: node.name, payload: sHead + sPayload + sFooter };
+    };
+    node.createPayloadPIN2 = () => {
+      return { topic: node.name, payload: node.exposedGAs }
+    };
+    node.createPayloadPIN3 = () => {
+
+      // Object containing the telegram in the queue
+      // node.writeQueueAdd({
+      //   grpaddr: _oClient.topic,
+      //   payload: "",
+      //   dpt: "",
+      //   outputtype: "read",
+      //   nodecallerid: _oClient.id,
+      // });
+      const aItems = _.clone(node.server.telegramsQueue);
+      let sPayload = '';
 
-      node.send([{ topic: node.name, payload: sHead + sPayload + sFooter }, { topic: node.name, payload: node.exposedGAs }]);
+      const sHead = `<div class="main"><table><caption>Queue of outgoing telegrams to the KNX BUS. The more the count,</br>the more congested is the KNX BUS.</caption>
+            <thead>
+              <tr>
+                <th> GA </th>
+                <th> Value </th>
+                <th> DPT </th>
+                <th> Output Type </th>
+                <th> Caller Node (id) </th>
+              </tr>
+            </thead>
+            <tbody>`;
+      const sFooter = `</tbody><tfoot>
+              <tr>
+                <th scope="row">Count</th>
+                <td>` + aItems.length + `</td>
+              </tr>
+            </tfoot>
+            </table></div>`;
+
+      try {
+        for (let index = 0; index < aItems.length; index++) {
+          const element = aItems[index];
+          sPayload += '<tr><td>' + element.grpaddr + '</td>';
+          if (typeof element.payload === 'boolean' && element.payload === true) {
+            sPayload += '<td><b><font color=green>True</font></b></td>';
+          } else if (typeof element.payload === 'boolean' && element.payload === false) {
+            sPayload += '<td><font color=red>False</font></td>';
+          } else if (typeof element.payload === 'object' && !isNaN(Date.parse(element.payload))) {
+            // The payload is a datetime
+            sPayload += '<td>' + element.payload.toLocaleString() + '</td>';
+          } else if (typeof element.payload === 'object') {
+            // Is maybe a JSON?
+            try {
+              // sPayload += '<td>' + JSON.stringify(element.payload) + '</td>'
+              sPayload += '<td><i>' + element.rawPayload + '</i></td>';
+            } catch (error) {
+              sPayload += '<td>' + element.payload + '</td>';
+            }
+          } else {
+            sPayload += '<td>' + element.payload + element.payloadmeasureunit + '</td>';
+          }
+          sPayload += '<td>' + element.dpt + '</td>';
+          sPayload += '<td>' + element.outputtype + '</td>';
+          sPayload += '<td><font style="font-size: smaller;">' + element.nodecallerid + '</font></td></tr>';
+        }
+      } catch (error) {
+
+      }
+      return { topic: node.name, payload: sHead + sPayload + sFooter };
     };
 
+    // if (timerPIN3 !== null) clearInterval(timerPIN3);
+    // timerPIN3 = setInterval(() => {
+    //   let PIN3 = node.createPayloadPIN3();
+    //   node.send([null, null, PIN3]);
+    // }, 200);
+
     node.on('input', function (msg) {
 
     });
 
     node.on('close', function (done) {
+      if (timerPIN3 !== null) clearInterval(timerPIN3);
       if (node.server) {
         node.server.removeClient(node);
       }

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

@@ -36,8 +36,8 @@
             "Advancedoptions": "Advanced options",
             "Formatting": "Format INPUT (datagram coming from the KNX BUS)",
             "Operations": "NUMERIC VALUES (operations are performed in order)",
-            "OUTPUT": "CONTROL (payload to KNX bus)",
-            "INPUT": "STATUS (payload from KNX BUS)",
+            "OUTPUT": "SEND msg to KNX bus",
+            "INPUT": "RECEIVE msg from KNX BUS",
             "NUMERICVALUES": "NUMERIC VALUES (operations are performed in order)",
             "noETSWarning": "You haven't imported the ETS csv file. <br/> The node will work as blind transmitter/receiver. <a href=\"https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/2.-Node-Configuration\" target='_blank'>Click here for help about that</a>.",
             "notify-DPT3007": "You selected a relative DIM. Please <a target='_blank' href='https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/-Sample---Dimming'>click here to view this sample</a> and learn how to handle such payload.",

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "3.0.0-beta2",
+  "version": "3.0.0-beta3",
   "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",