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

package/nodes/knxUltimateHuedevice_software_update.js

@@ -0,0 +1,134 @@
+module.exports = function (RED) {
+  function knxUltimateHuedevice_software_update(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+    node.server = RED.nodes.getNode(config.server);
+    node.serverHue = RED.nodes.getNode(config.serverHue);
+    node.topic = node.name;
+    node.name = config.name === undefined ? 'Hue' : config.name;
+    node.dpt = '';
+    node.notifyreadrequest = true;
+    node.notifyreadrequestalsorespondtobus = 'false';
+    node.notifyreadrequestalsorespondtobusdefaultvalueifnotinitialized = '';
+    node.notifyresponse = false;
+    node.notifywrite = true;
+    node.initialread = true;
+    node.listenallga = true; // Don't remove
+    node.outputtype = 'write';
+    node.outputRBE = 'false'; // Apply or not RBE to the output (Messages coming from flow)
+    node.inputRBE = 'false'; // Apply or not RBE to the input (Messages coming from BUS)
+    node.currentPayload = ''; // Current value for the RBE input and for the .previouspayload msg
+    node.passthrough = 'no';
+    node.formatmultiplyvalue = 1;
+    node.formatnegativevalue = 'leave';
+    node.formatdecimalsvalue = 2;
+    node.hueDevice = config.hueDevice;
+    node.initializingAtStart = (config.readStatusAtStartup === undefined || config.readStatusAtStartup === "yes");
+    node.currentDeviceValue = false;
+
+    // Used to call the status update from the config node.
+    node.setNodeStatus = ({
+      fill, shape, text, payload,
+    }) => {
+
+    };
+    // Used to call the status update from the HUE config node.
+    node.setNodeStatusHue = ({
+      fill, shape, text, payload,
+    }) => {
+      if (payload === undefined) payload = '';
+      const dDate = new Date();
+      payload = typeof payload === 'object' ? JSON.stringify(payload) : payload.toString();
+      node.status({ fill, shape, text: `${text} ${payload} (${dDate.getDate()}, ${dDate.toLocaleTimeString()})` });
+    };
+
+    // This function is called by the knx-ultimate config node, to output a msg.payload.
+    node.handleSend = (msg) => {
+      // Respond to KNX read telegram, by sending the current value as response telegram.
+      if (msg.knx.event === "GroupValue_Read") {
+        switch (msg.knx.destination) {
+          case config.GAdevice_software_update:
+            // To the KNX bus wires
+            node.sendResponseToKNX(node.currentDeviceValue);
+            break;
+          default:
+            break;
+        }
+      }
+    };
+
+    node.handleSendHUE = (_event) => {
+      try {
+        // Event status: one of connected, disconnected, connectivity_issue, unidirectional_incoming
+        if (_event.id === config.hueDevice) {
+          if (!_event.hasOwnProperty("state") || _event.state === undefined) return;
+
+          const knxMsgPayload = {};
+          knxMsgPayload.topic = config.GAdevice_software_update;
+          knxMsgPayload.dpt = config.dptdevice_software_update;
+
+          knxMsgPayload.payload = (_event.state !== "no_update");
+          // Send to KNX bus
+          if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) {
+            node.server.writeQueueAdd({
+              grpaddr: knxMsgPayload.topic, payload: knxMsgPayload.payload, dpt: knxMsgPayload.dpt, outputtype: 'write', nodecallerid: node.id,
+            });
+          }
+          node.currentDeviceValue = knxMsgPayload.payload;
+          // Setup the output msg
+          knxMsgPayload.name = node.name;
+          knxMsgPayload.status = _event.state;
+          knxMsgPayload.event = 'device_software_update';
+          // Send payload
+          knxMsgPayload.rawEvent = _event;
+          node.send(knxMsgPayload);
+          node.setNodeStatusHue({
+            fill: 'blue', shape: 'ring', text: 'HUE->KNX', payload: knxMsgPayload.payload,
+          });
+        }
+      } catch (error) {
+        node.status({ fill: 'red', shape: 'dot', text: `HUE->KNX error ${error.message} (${new Date().getDate()}, ${new Date().toLocaleTimeString()})` });
+      }
+    };
+
+
+    node.sendResponseToKNX = (_level) => {
+      const knxMsgPayload = {};
+      knxMsgPayload.topic = config.GAdevice_software_update;
+      knxMsgPayload.dpt = config.dptdevice_software_update;
+
+      knxMsgPayload.payload = _level;
+      // Send to KNX bus
+      if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) {
+        node.server.writeQueueAdd({
+          grpaddr: knxMsgPayload.topic, payload: knxMsgPayload.payload, dpt: knxMsgPayload.dpt, outputtype: 'response', nodecallerid: node.id,
+        });
+      }
+    };
+
+    // On each deploy, unsubscribe+resubscribe
+    if (node.server) {
+      node.server.removeClient(node);
+      node.server.addClient(node);
+    }
+    if (node.serverHue) {
+      node.serverHue.removeClient(node);
+      node.serverHue.addClient(node);
+    }
+
+    node.on('input', (msg) => {
+
+    });
+
+    node.on('close', (done) => {
+      if (node.server) {
+        node.server.removeClient(node);
+      }
+      if (node.serverHue) {
+        node.serverHue.removeClient(node);
+      }
+      done();
+    });
+  }
+  RED.nodes.registerType('knxUltimateHuedevice_software_update', knxUltimateHuedevice_software_update);
+};

package/nodes/knxUltimateLoadControl.html

@@ -1,3 +1,5 @@
+<script type="text/javascript" src="resources/node-red-contrib-knx-ultimate/htmlUtils.js"></script>
+
 <script type="text/javascript">
     RED.nodes.registerType('knxUltimateLoadControl', {
         category: "KNX Ultimate",
@@ -79,16 +81,7 @@
                 } catch (error) { }
             });
 
-            // 31/03/2020 Search Helper
-            function fullSearch(sourceText, searchString) {
-                // This searches for all words in a string
-                var aSearchWords = searchString.toLowerCase().split(" ");
-                var i = 0;
-                for (let index = 0; index < aSearchWords.length; index++) {
-                    if (sourceText.toLowerCase().indexOf(aSearchWords[index]) > -1) i += 1;
-                }
-                return i == aSearchWords.length;
-            }
+
 
             $.getJSON("knxUltimateDpts?serverId=" + $("#node-input-server").val(), (data) => {
                 data.forEach(dpt => {
@@ -119,7 +112,7 @@
                         $.getJSON("knxUltimatecsv?nodeID=" + oNodeServer.id, (data) => {
                             response($.map(data, function (value, key) {
                                 var sSearch = (value.ga + " (" + value.devicename + ") DPT" + value.dpt);
-                                if (fullSearch(sSearch, request.term)) {
+                                if (htmlUtilsfullCSVSearch(sSearch, request.term)) {
                                     return {
                                         label: value.ga + " # " + value.devicename + " # " + value.dpt, // Label for Display
                                         value: value.ga // Value

package/nodes/knxUltimateLoadControl.js

@@ -1,7 +1,7 @@
 
 module.exports = function (RED) {
   function knxUltimateLoadControl(config) {
-    // const Address = require('./../KNXEngine/src/protocol/KNXAddress')
+    // const Address = require('knxultimate')
 
     RED.nodes.createNode(this, config)
     const node = this

package/nodes/knxUltimateLogger.html

@@ -1,3 +1,5 @@
+<script type="text/javascript" src="resources/node-red-contrib-knx-ultimate/htmlUtils.js"></script>
+
 <script type="text/javascript">
     RED.nodes.registerType('knxUltimateLogger', {
         category: "KNX Ultimate",
@@ -11,7 +13,7 @@
             maxRowsInETSXML: { value: 0, required: true, validate: RED.validators.number() },
             autoStartTimerTelegramCounter: { value: false },
             intervalTelegramCount: { value: 60, required: false, validate: RED.validators.number() }
-            
+
         },
         inputs: 1,
         outputs: 2,

package/nodes/knxUltimateSceneController.html

@@ -1,3 +1,5 @@
+<script type="text/javascript" src="resources/node-red-contrib-knx-ultimate/htmlUtils.js"></script>
+
 <script type="text/javascript">
     RED.nodes.registerType('knxUltimateSceneController', {
         category: "KNX Ultimate",
@@ -50,16 +52,7 @@
                 } catch (error) { }
             });
 
-            // 31/03/2020 Search Helper
-            function fullSearch(sourceText, searchString) {
-                // This searches for all words in a string
-                var aSearchWords = searchString.toLowerCase().split(" ");
-                var i = 0;
-                for (let index = 0; index < aSearchWords.length; index++) {
-                    if (sourceText.toLowerCase().indexOf(aSearchWords[index]) > -1) i += 1;
-                }
-                return i == aSearchWords.length;
-            }
+
 
             // DPT of Scene Recall
             // ########################
@@ -74,13 +67,13 @@
 
             // Autocomplete suggestion with ETS csv File
             $("#node-input-topic").autocomplete({
-                minLength: 1,
+                minLength: 0,
                 source: function (request, response) {
                     //$.getJSON("csv", request, function( data, status, xhr ) {
                     $.getJSON("knxUltimatecsv?nodeID=" + oNodeServer.id, (data) => {
                         response($.map(data, function (value, key) {
                             var sSearch = (value.ga + " (" + value.devicename + ") DPT" + value.dpt);
-                            if (fullSearch(sSearch, request.term)) {
+                            if (htmlUtilsfullCSVSearch(sSearch, request.term)) {
                                 return {
                                     label: value.ga + " # " + value.devicename + " # " + value.dpt, // Label for Display
                                     value: value.ga // Value
@@ -103,6 +96,8 @@
                     $("#node-input-dpt").val(optVal);
                     $("#node-input-dpt").trigger("change");
                 }
+            }).focus(function () {
+                $(this).autocomplete('search', $(this).val() + 'exactmatch');
             });
 
             // 19/03/2020 Adjust trigger value accordingly
@@ -196,12 +191,12 @@
 
             // Autocomplete suggestion with ETS csv File
             $("#node-input-topicSave").autocomplete({
-                minLength: 1,
+                minLength: 0,
                 source: function (request, response) {
                     $.getJSON("knxUltimatecsv?nodeID=" + oNodeServer.id, (data) => {
                         response($.map(data, function (value, key) {
                             var sSearch = (value.ga + " (" + value.devicename + ") DPT" + value.dpt);
-                            if (fullSearch(sSearch, request.term)) {
+                            if (htmlUtilsfullCSVSearch(sSearch, request.term)) {
                                 return {
                                     label: value.ga + " # " + value.devicename + " # " + value.dpt, // Label for Display
                                     value: value.ga // Value
@@ -224,6 +219,8 @@
                     $("#node-input-dptSave").val(optVal);
                     $("#node-input-dptSave").trigger("change");
                 }
+            }).focus(function () {
+                $(this).autocomplete('search', $(this).val() + 'exactmatch');
             });
 
             // 02/04/2020 Adjust trigger value accordingly
@@ -340,7 +337,7 @@
                             $.getJSON("knxUltimatecsv?nodeID=" + oNodeServer.id, (data) => {
                                 response($.map(data, function (value, key) {
                                     var sSearch = (value.ga + " (" + value.devicename + ") DPT" + value.dpt);
-                                    if (fullSearch(sSearch, request.term)) {
+                                    if (htmlUtilsfullCSVSearch(sSearch, request.term)) {
                                         return {
                                             label: value.ga + " # " + value.devicename + " # " + value.dpt, // Label for Display
                                             value: value.ga // Value
@@ -361,6 +358,8 @@
                             var optVal = $(".rowRuleDPT option:contains('" + ui.item.label.split("#")[2].trim() + "')").attr('value');
                             oDPTField.val(optVal);
                         }
+                    }).focus(function () {
+                        $(this).autocomplete('search', $(this).val() + 'exactmatch');
                     });
 
                     oTopicField.val(rule.topic);

package/nodes/knxUltimateViewer.html

@@ -1,3 +1,5 @@
+<script type="text/javascript" src="resources/node-red-contrib-knx-ultimate/htmlUtils.js"></script>
+
 <script type="text/javascript">
     RED.nodes.registerType('knxUltimateViewer', {
         category: "KNX Ultimate",

package/nodes/knxUltimateViewer.js

@@ -1,4 +1,4 @@
-const KNXAddress = require('./../KNXEngine/src/protocol/KNXAddress').KNXAddress;
+const KNXAddress = require('knxultimate').KNXAddress;
 
 module.exports = function (RED) {
   function knxUltimateViewer(config) {

package/nodes/knxUltimateWatchDog.html

@@ -1,3 +1,5 @@
+<script type="text/javascript" src="resources/node-red-contrib-knx-ultimate/htmlUtils.js"></script>
+
 <script type="text/javascript">
     RED.nodes.registerType('knxUltimateWatchDog', {
         category: "KNX Ultimate",
@@ -16,7 +18,7 @@
         outputLabels: ["Output"],
         icon: "node-watchdog-icon.svg",
         label: function () {
-            return ((this.name || "KNX Watchdog") + " " + (this.checkLevel == "Ethernet" ? "Gateway IP": this.topic));
+            return ((this.name || "KNX Watchdog") + " " + (this.checkLevel == "Ethernet" ? "Gateway IP" : this.topic));
         },
         paletteLabel: "KNX WatchDog",
         oneditprepare: function () {

package/nodes/utils/payloadManipulation.js

@@ -2,7 +2,7 @@
   * @param {object} [_oNode]
   * @param {any} [jsValue]
   */
-exports.Manipulate = function roundPayload (_oNode, jsValue) {
+exports.Manipulate = function roundPayload(_oNode, jsValue) {
   // 19/01/2023 FORMATTING THE OUTPUT PAYLOAD BASED ON SINGLE NODE SETUP
   //* ********************************************************
   // Formatting the msg output value
@@ -38,3 +38,51 @@ exports.Manipulate = function roundPayload (_oNode, jsValue) {
   }
   //* ********************************************************
 }
+
+// KNXULtimate nodes
+module.exports.KNXULtimateChangeConfigByInputMSG = function KNXULtimateChangeConfigByInputMSG(msg, node, config) {
+
+  if (!msg.setConfig.hasOwnProperty('setGroupAddress') || !msg.setConfig.hasOwnProperty('setDPT')) {
+    node.setNodeStatus({
+      fill: 'red', shape: 'ring', text: `setGroupAddress and setDPT are mandatory`, payload: '', GA: '', dpt: '', devicename: '',
+    });
+    return;
+  }
+
+  // Set DPT
+  node.dpt = msg.setConfig.setDPT;
+  config.dpt = msg.setConfig.setDPT;
+
+  // SET GORUP ADDRESS
+  node.topic = msg.setConfig.setGroupAddress;
+  config.topic = msg.setConfig.setGroupAddress
+  node.outputtopic = (config.outputtopic === undefined || config.outputtopic === '') ? msg.setConfig.setGroupAddress : config.outputtopic; // 07/02/2020 Importante, per retrocompatibilità
+  config.outputtopic = node.outputtopic;
+
+  // Read from the ETS file, the missing props
+  if (node.server.csv !== undefined && node.server.csv !== null) {
+    // Read it from ETS File
+    const found = node.server.csv.find(item => item.ga === msg.setConfig.setGroupAddress);
+    if (found !== undefined) {
+      if (msg.setConfig.setDPT === 'auto') {
+        node.dpt = found.dpt; // SET THE DPT
+        config.dpt = found.dpt;
+      }
+      node.name = found.devicename;
+      config.name = found.devicename;
+    }
+  }
+  // If DPT is still "auto", something has going wrong
+  if (node.dpt === 'auto') {
+    // Unable to retrieve the datapoint
+    node.setNodeStatus({
+      fill: 'red', shape: 'ring', text: `Unable to retrieve the datapoint from the ETS file`, payload: '', GA: '', dpt: '', devicename: '',
+    });
+    if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error(`knxUltimate: setConfig: Node.id: ${node.id} error: Unable to retrieve the datapoint from the ETS file`);
+  } else {
+    node.setNodeStatus({
+      fill: 'blue', shape: 'ring', text: `Config changed. Current GA: ${node.topic} DPT: ${node.dpt}`, payload: '', GA: '', dpt: '', devicename: node.name,
+    });
+  }
+
+};

package/nodes/utils/utils.js

@@ -53,5 +53,9 @@ module.exports.fetchFromObject = function fetchFromObject(
   if (typeof _msg[_payloadPropName] === "object") return undefined;
   return _msg[_payloadPropName];
 };
+
+
 const DEFAULTTRANSLATIONINPUT =
   "on:true\noff:false\nactive:true\ninactive:false\nopen:true\nclosed:false\nclose:false\n1:true\n0:false\ntrue:true\nfalse:false\nhome:true\nnot_home:false\nnormal:false\nviolated:true";
+
+

package/package.json

@@ -3,13 +3,15 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "2.5.1",
+  "version": "3.0.0-beta2",
   "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",
     "crypto-js": "4.2.0",
     "dns-sync": "0.2.1",
     "eventsource": "2.0.2",
+    "js-yaml": "4.1.0",
+    "knxultimate": ">=2.3.3",
     "lodash": "4.17.21",
     "log-driver": "1.2.7",
     "mkdirp": "3.0.1",
@@ -17,8 +19,7 @@
     "path": "0.12.7",
     "ping": "0.4.4",
     "simple-get": "4.0.1",
-    "xml2js": "0.6.0",
-    "js-yaml": "4.1.0"
+    "xml2js": "0.6.0"
   },
   "node-red": {
     "version": ">=3.1.1",
@@ -46,7 +47,8 @@
       "knxUltimateHueBattery": "/nodes/knxUltimateHueBattery.js",
       "knxUltimateHueZigbeeConnectivity": "/nodes/knxUltimateHueZigbeeConnectivity.js",
       "knxUltimateContactSensor": "/nodes/knxUltimateHueContactSensor.js",
-      "knxUltimateHATranslator": "/nodes/knxUltimateHATranslator.js"
+      "knxUltimateHATranslator": "/nodes/knxUltimateHATranslator.js",
+      "knxUltimateHuedevice_software_update": "/nodes/knxUltimateHuedevice_software_update.js"
     }
   },
   "repository": {

package/resources/htmlUtils.js

@@ -0,0 +1,27 @@
+// 31/03/2020 Search Helper
+function htmlUtilsfullCSVSearch(sourceText, searchString) {
+    let aSearchWords = [];
+    if (searchString.toLowerCase().includes('exactmatch')) {
+        // Find only the strict exact match of group address. For example, if the string is 0/0/2exactmatch, i return only the item in the csv having
+        // group address 0/0/2 (and not also, for example 0/0/20)
+        // I can have also an exact string like '0/0/1exactmatch 1.000', (GA or any text, plus the datapoint) and i must take it into consideration
+        let aSearchStrings = searchString.split(' ');
+        for (let index = 0; index < aSearchStrings.length; index++) {
+            const element = aSearchStrings[index];
+            if (element.includes('exactmatch')) {
+                aSearchWords.push(element.replace('exactmatch', ' ')); // The last ' ' allow to return the exact match
+            } else {
+                aSearchWords.push(element); // The last ' ' allow to return the exact match
+            }
+        }
+    } else {
+        aSearchWords = searchString.toLowerCase().split(" ");
+    }
+
+    // This searches for all words in a string
+    let i = 0;
+    for (let index = 0; index < aSearchWords.length; index++) {
+        if (sourceText.toLowerCase().indexOf(aSearchWords[index]) > -1) i += 1;
+    }
+    return i == aSearchWords.length;
+}