node-red-contrib-knx-ultimate 3.3.4 → 3.3.6

package/CHANGELOG.md

@@ -6,6 +6,12 @@
 
 # CHANGELOG
 
+**Version 3.3.6** - December 2024<br/>
+- KNX Alerter Node: read status after deploy even of a single node.<br/>
+
+**Version 3.3.5** - December 2024<br/>
+- KNX Alerter Node: now the node works even if no ETS file has been imported.<br/>
+
 **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/>

package/nodes/knxUltimateAlerter.html

@@ -17,6 +17,11 @@
         },
         inputs: 1,
         outputs: 3,
+        outputLabels: function (index) {
+            if (index === 0) return "Emits a message for each alerted device, at selectable intervals.";
+            if (index === 1) return "Emits a unique message containing all alerted devices.";
+            if (index === 2) return "Emits a message containing only the last alerted device.";
+        },
         icon: "node-alerter-icon.svg",
         label: function () {
             return (this.outputRBE == true ? "|rbe| " : "") + (this.name || this.topic || "KNX Alerter") + (this.inputRBE == true ? " |rbe|" : "")
@@ -235,4 +240,61 @@
     <p><span data-i18n="knxUltimateAlerter.other.add"></p>
 </div>
 
-</script>
+</script>
+
+
+<script type="text/markdown" data-help-name="knxUltimateAlerter">
+With the Alerter node you can signal to a display or to the node-red-contrib-tts-ultimate node (audio feedback) if the selected devices are alerted, i.e. they have payload **true**.
+The node issues messages at specified intervals (one message at a time) containing the details of each alerted device. For example, the node can tell you how many and which windows are open. <br/>
+The node receives the values of the devices directly from the KNX BUS. Furthermore, you can send personalized messages to the node, not linked to KNX devices. <br/>
+The example page explains how to use the node. <br/>
+
+- **Gateway**
+
+> KNX gateway selected. It is also possible not to select any gateway; in this case, only incoming messages to the node will be considered.
+
+
+- **Name**
+
+> Node name.
+
+- **Alerting cycle start type**
+
+> Here you can select the event that will skip the start of sending messages from alerted devices.
+
+- **Interval between each MSG (in seconds)**
+
+> Interval between each outgoing message from the node.
+
+## DEVICES TO MONITOR
+
+Here you can add devices to monitor. <br/>
+Enter the device name or its group address. <br/>
+
+- **Read value of each device on connection/reconnect**
+
+> On connection/reconnection, the node will send a 'read' request each device belonging to the list.
+
+- **ADD button**
+
+> Add a row to the list.
+
+- **Device's rows**
+
+> The first field is the group address (but you can also enter any text, which you can use with inbound messages, see the example page), the second is the device name **(MAX 14 CHARS)**, the third is the long device name.
+
+- **DELETE button**
+
+> Removes a device from the list.
+    
+<p> 
+    <a href="https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/Alerter-Configuration" target="_blank"><i class="fa fa-info-circle"></i>&nbsp Config help</a><br/> 
+    <a href="https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/SampleAlerter" target="_blank"><i class="fa fa-code"></i>&nbsp Samples</a>.       
+</p>
+
+<p>
+    <a href="https://www.paypal.com/donate/?hosted_button_id=S8SKPUBSPK758" target="_blank">
+        <img src='https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/CodiceQR.png' width='30%'>
+    </a>
+</p>
+    </script>

package/nodes/knxUltimateAlerter.js

@@ -16,7 +16,7 @@ module.exports = function (RED) {
     node.notifyreadrequest = false;
     node.notifyresponse = true;
     node.notifywrite = true; // Dont' remove this.
-    node.initialread = false;
+    node.initialread = 0;
     node.outputtype = 'write';
     node.outputRBE = 'false';
     node.inputRBE = 'false';
@@ -30,9 +30,9 @@ module.exports = function (RED) {
     node.timerinterval = (config.timerinterval === undefined || config.timerinterval == '') ? '2' : config.timerinterval;
 
     if (config.initialreadGAInRules === undefined) {
-      node.initialread = true;
+      node.initialread = 1;
     } else {
-      node.initialread = config.initialreadGAInRules !== '0';
+      node.initialread = Number(config.initialreadGAInRules);
     }
 
     // Used to call the status update from the config node.
@@ -69,11 +69,6 @@ module.exports = function (RED) {
 
     // This function is called by the knx-ultimate config node, to output a msg.payload.
     node.handleSend = msg => {
-      try {
-        if (!msg.knx.dpt.startsWith('1.')) return;
-      } catch (error) {
-        return;
-      }
       let bFound = false; // 24/04/2021 true if the cycle below found a match, otherwise false
 
       // Update the node.rules with the values taken from the file, if any, otherwise leave the default value
@@ -156,6 +151,8 @@ module.exports = function (RED) {
     // 24/04/2021 perform a read on all GA in the rule list. Called both from node.on("input") and knxUltimate-config
     node.initialReadAllDevicesInRules = () => {
       if (node.serverKNX) {
+        node.setLocalStatus({ fill: 'grey', shape: 'ring', text: 'Reasy', payload: '', GA: '', dpt: '', devicename: '' });
+
         let grpaddr = '';
         for (let i = 0; i < node.rules.length; i++) {
           // rule is { topic: rowRuleTopic, devicename: rowRuleDeviceName, longdevicename: rowRuleLongDeviceName}
@@ -165,7 +162,9 @@ module.exports = function (RED) {
           try {
             // Check if it's a group address
             // const ret = Address.KNXAddress.createFromString(grpaddr, Address.KNXAddress.TYPE_GROUP)
-            node.setLocalStatus({ fill: 'grey', shape: 'dot', text: 'Read', payload: '', GA: grpaddr, dpt: '', devicename: rule.devicename });
+            setTimeout(() => {
+              node.setLocalStatus({ fill: 'blue', shape: 'dot', text: 'Read', payload: '', GA: grpaddr, dpt: '', devicename: rule.devicename });
+            }, 500);
             node.serverKNX.sendKNXTelegramToKNXEngine({ grpaddr, payload: '', dpt: '', outputtype: 'read', nodecallerid: node.id });
           } catch (error) {
             node.setLocalStatus({ fill: 'grey', shape: 'dot', text: 'Not a KNX GA ' + error.message, payload: '', GA: grpaddr, dpt: '', devicename: rule.devicename });
@@ -276,6 +275,7 @@ module.exports = function (RED) {
       node.serverKNX.removeClient(node);
       if (node.topic !== '' || node.topicSave !== '') {
         node.serverKNX.addClient(node);
+        node.initialReadAllDevicesInRules();
       }
     }
   }

package/package.json

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

package/nodes/locales/en-US/knxUltimateAlerter.html

@@ -1,14 +0,0 @@
-<script type="text/html" data-help-name="knxUltimateAlerter">
-    <h1>KNX Ultimate - Alerter</h1>
-    
-    <p> 
-        <a href="https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/Alerter-Configuration" target="_blank"><i class="fa fa-info-circle"></i>&nbsp Config help</a><br/> 
-        <a href="https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/SampleAlerter" target="_blank"><i class="fa fa-code"></i>&nbsp Samples</a>.       
-    </p>
-    
-    <p>
-        <a href="https://www.paypal.com/donate/?hosted_button_id=S8SKPUBSPK758" target="_blank">
-            <img src='https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/CodiceQR.png' width='30%'>
-        </a>
-    </p>
-</script>