node-red-contrib-knx-ultimate 2.4.5-beta.0 → 2.4.5-beta.2

package/CHANGELOG.md

@@ -6,6 +6,17 @@
 
 # CHANGELOG
 
+**Version 2.4.5-beta.2 PUBLIC BETA** - Feb 2024<br/>
+- Fix the listing of ethernet interfaces in the gateway config window.<br/>
+
+**Version 2.4.5-beta.1 PUBLIC BETA** - Feb 2024<br/>
+- WARNING: this version uses the Node-Red plugin system; the  Node-Red version must be **equals or major than 3.1.1**<br/>
+- HUE: Optimized color translation between xyBri and RGB.<br/>
+- NEW: HUE Light node: added the HSV controls.<br/>
+- HUE Light node: stopping the dim sequence, now clears also the HUE bridge queue commands, to allow stopping the dimmer quickly.<br/>
+- HUE Light node: smoother dimming.<br/>
+- PLEASE TRY THIS VERSION AND GIVE ME ANY FEEDBACK ABOUT ISSUES YOU FIND. THANKS.<br/>
+
 **Version 2.4.5-beta.0** - Jan 2024<br/>
 - WARNING: this version uses the Node-Red plugin system; the  Node-Red version must be **equals or major than 3.1.1**<br/>
 - NEW: Added KNX Datapoint 275.100<br/>

package/KNXEngine/CHANGELOG.md

@@ -7,7 +7,7 @@
 # CHANGELOG
 
 <p>
-<b>Version 1.0.46</b> - January 2024<br/>
+<b>Version 1.0.47</b> - January 2024<br/>
 - NEW: added DPT 275.100.<br/>
 </p>
 <p>

package/KNXEngine/README.md

@@ -161,16 +161,24 @@ knxUltimateClient.on(knx.KNXClient.KNXClientEvents.indication, function (_datagr
     let _dst = _datagram.cEMIMessage.dstAddress.toString()
     // Get the RAW Value
     let _Rawvalue = _datagram.cEMIMessage.npdu.dataValue;
-    
+
     // Decode the telegram. 
     if (_dst === "0/1/1") {
-        // We know that 0/1/1 is a boolean DPT 1.001
+        // We know, for example, that 0/1/1 is a boolean DPT 1.001
         dpt = dptlib.resolve("1.001");
         jsValue = dptlib.fromBuffer(_Rawvalue, dpt)
     } else if (_dst === "0/1/2") {
-        // We know that 0/1/2 is a boolean DPT 232.600 Color RGB
+        // We know , for example, that 0/1/2 is a DPT 232.600 Color RGB
         dpt = dptlib.resolve("232.600");
         jsValue = dptlib.fromBuffer(_Rawvalue, dpt)
+    } else {
+        // All others... assume they are boolean
+        dpt = dptlib.resolve("1.001");
+        jsValue = dptlib.fromBuffer(_Rawvalue, dpt)
+        if (jsValue === null) {
+            // Opppsss, it's null. It means that the datapoint isn't 1.001
+            // Raise whatever error you want.
+        }
     }
     console.log("src: " + _src + " dest: " + _dst, " event: " + _evt, " value: " + jsValue);
 
@@ -184,6 +192,10 @@ knxUltimateClient.on(knx.KNXClient.KNXClientEvents.connected, info => {
 });
 
 // Connect
+try {
+    knxUltimateClient.removeAllListeners();
+} catch (error) {
+}
 knxUltimateClient.Connect();
 ```
 
@@ -280,8 +292,18 @@ let knxUltimateClientProperties = {
     KNXEthInterface: "Auto", // Bind to the first avaiable local interfavce. "Manual" if you wish to specify the interface (for example eth1); in this case, set the property interface to the interface name (interface:"eth1")
 };
 
+var knxUltimateClient;
+
+// If you're reinstantiating a new knxUltimateClient object, you must remove all listeners.
+// If this is the first time you instantiate tne knxUltimateClient object, this part of code throws an error into the try...catch.
+try {
+    if (knxUltimateClient !== null) knxUltimateClient.removeAllListeners();
+} catch (error) {
+    // New connection, do nothing.
+}
+
 // Let's go
-var knxUltimateClient = new knx.KNXClient(knxUltimateClientProperties);
+knxUltimateClient = new knx.KNXClient(knxUltimateClientProperties);
 
 // Setting handlers
 // ######################################
@@ -368,6 +390,15 @@ function handleBusEvents(_datagram, _echoed) {
         // We know that 0/1/2 is a boolean DPT 232.600 Color RGB
         dpt = dptlib.resolve("232.600");
         jsValue = dptlib.fromBuffer(_Rawvalue, dpt)
+    } else {
+        // All others... assume they are boolean
+        dpt = dptlib.resolve("1.001");
+        jsValue = dptlib.fromBuffer(_Rawvalue, dpt)
+        if (jsValue === null) {
+            // Is null, try if it's a numerical value
+            dpt = dptlib.resolve("5.001");
+            jsValue = dptlib.fromBuffer(_Rawvalue, dpt)
+        }
     }
     console.log("src: " + _src + " dest: " + _dst, " event: " + _evt, " value: " + jsValue);
 
@@ -390,7 +421,6 @@ Loading, decrypting and validating Keyring file has been done.<br/>
 I'm working on the first secure handshake now.<br/>
 
 ```javascript
-
 const knx = require("./index.js");
 const KNXsecureKeyring = require("./src/KNXsecureKeyring.js");
 const dptlib = require('./src/dptlib');

package/KNXEngine/package.json

@@ -1,7 +1,7 @@
 {
   "name": "knxultimate",
   "description": "KNX IP protocol implementation for Node. This is the ENGINE of Node-Red KNX-Ultimate node.",
-  "version": "1.0.46",
+  "version": "1.0.47",
   "engines": {
     "node": ">=14"
   },

package/KNXEngine/sample.js

@@ -84,9 +84,18 @@ let knxUltimateClientProperties = {
     KNXEthInterface: "Auto", // Bind to the first avaiable local interfavce. "Manual" if you wish to specify the interface (for example eth1); in this case, set the property interface to the interface name (interface:"eth1")
 };
 
+var knxUltimateClient;
+
+// If you're reinstantiating a new knxUltimateClient object, you must remove all listeners.
+// If this is the first time you instantiate tne knxUltimateClient object, this part of code throws an error into the try...catch.
+try {
+    if (knxUltimateClient !== null) knxUltimateClient.removeAllListeners();
+} catch (error) {
+    // New connection, do nothing.
+}
 
 // Let's go
-var knxUltimateClient = new knx.KNXClient(knxUltimateClientProperties);
+knxUltimateClient = new knx.KNXClient(knxUltimateClientProperties);
 
 // Setting handlers
 // ######################################

package/KNXEngine/simpleSample.js

@@ -40,11 +40,11 @@ knxUltimateClient.on(knx.KNXClient.KNXClientEvents.indication, function (_datagr
 
     // Decode the telegram. 
     if (_dst === "0/1/1") {
-        // We know that 0/1/1 is a boolean DPT 1.001
+        // We know, for example, that 0/1/1 is a boolean DPT 1.001
         dpt = dptlib.resolve("1.001");
         jsValue = dptlib.fromBuffer(_Rawvalue, dpt)
     } else if (_dst === "0/1/2") {
-        // We know that 0/1/2 is a boolean DPT 232.600 Color RGB
+        // We know , for example, that 0/1/2 is a DPT 232.600 Color RGB
         dpt = dptlib.resolve("232.600");
         jsValue = dptlib.fromBuffer(_Rawvalue, dpt)
     } else {
@@ -52,9 +52,8 @@ knxUltimateClient.on(knx.KNXClient.KNXClientEvents.indication, function (_datagr
         dpt = dptlib.resolve("1.001");
         jsValue = dptlib.fromBuffer(_Rawvalue, dpt)
         if (jsValue === null) {
-            // Is null, try if it's a numerical value
-            dpt = dptlib.resolve("5.001");
-            jsValue = dptlib.fromBuffer(_Rawvalue, dpt)
+            // Opppsss, it's null. It means that the datapoint isn't 1.001
+            // Raise whatever error you want.
         }
     }
     console.log("src: " + _src + " dest: " + _dst, " event: " + _evt, " value: " + jsValue);
@@ -69,5 +68,9 @@ knxUltimateClient.on(knx.KNXClient.KNXClientEvents.connected, info => {
 });
 
 // Connect
+try {
+    knxUltimateClient.removeAllListeners();
+} catch (error) {
+}
 knxUltimateClient.Connect();
 

package/nodes/commonFunctions.js

@@ -53,7 +53,7 @@ module.exports = (RED) => {
         type: "foo",
         onadd: function () {
             RED.events.on("registry:plugin-added", function (id) {
-                console.log(`my-test-plugin: plugin-added event "${id}"`)
+                //console.log(`my-test-plugin: plugin-added event "${id}"`)
                 commonFunctions();
             });
         }
@@ -237,9 +237,9 @@ module.exports = (RED) => {
 
         // 14/08/2019 Endpoint for retrieving the ethernet interfaces
         RED.httpAdmin.get("/knxUltimateETHInterfaces", (req, res) => {
+            const jListInterfaces = [];
             try {
                 const oiFaces = oOS.networkInterfaces();
-                const jListInterfaces = [];
                 Object.keys(oiFaces).forEach((ifname) => {
                     // Interface with single IP
                     if (Object.keys(oiFaces[ifname]).length === 1) {

package/nodes/hue-config.js

@@ -1,55 +1,13 @@
+/* eslint-disable camelcase */
 /* eslint-disable no-underscore-dangle */
 /* eslint-disable no-lonely-if */
 /* eslint-disable no-param-reassign */
 /* eslint-disable no-inner-declarations */
 /* eslint-disable max-len */
-const dptlib = require("../KNXEngine/src/dptlib");
+const cloneDeep = require("lodash/cloneDeep");
 const HueClass = require("./utils/hueEngine").classHUE;
 const loggerEngine = require("./utils/sysLogger");
-const hueColorConverter = require("./utils/hueColorConverter");
-const cloneDeep = require("lodash/cloneDeep");
-
-function getRandomIntInclusive(min, max) {
-  min = Math.ceil(min);
-  max = Math.floor(max);
-  return Math.floor(Math.random() * (max - min + 1) + min); // The maximum is inclusive and the minimum is inclusive
-}
-
-// Helpers
-const sortBy = (field) => (a, b) => {
-  if (a[field] > b[field]) {
-    return 1;
-  }
-  return -1;
-};
-
-const onlyDptKeys = (kv) => kv[0].startsWith("DPT");
-
-const extractBaseNo = (kv) => ({
-  subtypes: kv[1].subtypes,
-  base: parseInt(kv[1].id.replace("DPT", "")),
-});
-
-const convertSubtype = (baseType) => (kv) => {
-  const value = `${baseType.base}.${kv[0]}`;
-  // let sRet = value + " " + kv[1].name + (kv[1].unit === undefined ? "" : " (" + kv[1].unit + ")");
-  const sRet = `${value} ${kv[1].name}`;
-  return {
-    value,
-    text: sRet,
-  };
-};
-
-const toConcattedSubtypes = (acc, baseType) => {
-  const subtypes = Object.entries(baseType.subtypes).sort(sortBy(0)).map(convertSubtype(baseType));
-  return acc.concat(subtypes);
-};
-
-function getRandomInt(min, max) {
-  min = Math.ceil(min);
-  max = Math.floor(max);
-  return Math.floor(Math.random() * (max - min) + min); // The maximum is exclusive and the minimum is inclusive
-}
+const hueColorConverter = require("./utils/colorManipulators/hueColorConverter");
 
 module.exports = (RED) => {
   function hueConfig(config) {
@@ -69,33 +27,20 @@ module.exports = (RED) => {
     }
     node.name = config.name === undefined || config.name === "" ? node.host : config.name;
 
-    // Call the connect function of all hue-config nodes.
-    // function callinitHUEConnectionOfAllHUEServers() {
-    //   RED.nodes.eachNode((_node) => {
-    //     if (_node.type === 'hue-config') {
-    //       try {
-    //         RED.nodes.getNode(_node.id).initHUEConnection();
-    //       } catch (error) {
-    //         if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error("callinitHUEConnectionOfAllHUEServers: Node " + _node.name + " " + error.message);
-    //       }
-    //     }
-    //   });
-    // }
-
     // Connect to Bridge and get the resources
     node.initHUEConnection = async () => {
       try {
         if (node.hueManager !== undefined) node.hueManager.close();
-      } catch (error) { }
+      } catch (error) { /* empty */ }
       try {
         if (node.hueManager !== undefined) node.hueManager.removeAllListeners();
-      } catch (error) { }
+      } catch (error) { /* empty */ }
       // Handle events
       try {
         try {
           // Init HUE Utility
           node.hueManager = new HueClass(node.host, node.credentials.username, node.credentials.clientkey, config.bridgeid, node.sysLogger);
-        } catch (error) { }
+        } catch (error) { /* empty */ }
         node.hueManager.Connect();
       } catch (error) {
         if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error(`Errore hue-config: node.initHUEConnection: ${error.message}`);
@@ -176,26 +121,15 @@ module.exports = (RED) => {
       // °°°°°° Load ALL resources
       try {
         node.hueAllResources = await node.hueManager.hueApiV2.get("/resource");
-
-        // // DEBUG
-        // try {
-        //   const fs = require('fs');
-        //   const { resolve } = require('path');
-        //   const content = JSON.stringify(node.hueAllResources);
-        //   try {
-        //     fs.writeFileSync('resources.json', content);
-        //     RED.log.info("******************************* FILE WROTE IN resources.json " + resolve("resources.json"))
-        //     // file written successfully
-        //   } catch (error) {
-        //     RED.log.error("********************************************* const content = JSON.stringify(node.hueAllResources)2222: " + error.message)
-        //   }
-        // } catch (error) {
-        //   RED.log.error("********************************************* const content = JSON.stringify(node.hueAllResources): " + error.message)
-        // }
-
-
         if (node.hueAllResources !== undefined) {
           node.hueAllRooms = node.hueAllResources.filter((a) => a.type === "room");
+
+          // Get zigbee_connectivituy
+          // const bridgeId = node.hueAllResources.filter((a) => a.bridge_id === config.bridgeid).owner.rid;
+          // const zigbee_ConnectivityID = node.hueAllResources.filter((a) => a.id === bridgeId).services.filter((a) => a.rtype === "zigbee_connectivity").rid;
+          // // connected, disconnected, connectivity_issue, unidirectional_incoming
+          // const oZigbeeConnectivityStatus = node.hueAllResources.filter((a) => a.id === zigbee_ConnectivityID).status;
+
           // Update all KNX State of the nodes with the new hue device values
           node.nodeClients.forEach((_node) => {
             if (_node.hueDevice !== undefined && node.hueAllResources !== undefined) {