node-red-contrib-knx-ultimate 2.1.63 → 2.2.2

package/.eslintrc.json

@@ -1,14 +1,14 @@
 {
-    "env": {
-        "browser": true,
-        "commonjs": true,
-        "es2021": true
-    },
-    "extends": "airbnb-base",
-    "parserOptions": {
-        "ecmaVersion": "latest"
-    },
-    "rules": {
-        "quotes": "off"
-    }
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "es2021": true
+  },
+  "extends": "airbnb-base",
+  "parserOptions": {
+    "ecmaVersion": "latest"
+  },
+  "rules": {
+    "quotes": "off"
+  }
 }

package/CHANGELOG.md

@@ -1,10 +1,26 @@
 ![Sample Node](img/logo.png)
 
-[![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square)](https://www.paypal.me/techtoday) 
+[![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square)](https://www.paypal.me/techtoday)
 
 <br/>
 
 # CHANGELOG
+
+<p>
+<b>Version 2.2.2</b> - October 2023<br/>
+- NEW: HUE Motion: support HUE Camera motion events via the HUE Motion node.<br/>
+- HUE Light: some tweaking to the GUI.<br/> 
+- HUE Grouped Light: Fixed relative dimming function.<br/> 
+- KNK Alerter node: <a href="https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/SampleAlerter">fixed the wiki sample page</a>.<br/> 
+- KNX Viewer: added the help pane in Node-Red.<br/> 
+</p>
+<p>
+<b>Version 2.2.1</b> - October 2023<br/>
+- Massive rewrite of the DIM function, for brightness and for color temperature.<br/>
+- NEW: HUE Light: Added dimming speed, minimum dim value and maximum dim value.<br/>
+- NEW: HUE Light: Read of the lamp status at node-red start and after deploy of a new node.<br/>
+- Security fix: patched a vulnerability in crypto.js.<br/>
+</p>
 <p>
 <b>Version 2.1.63</b> - October 2023<br/>
 - HUE Light: optimized the GUI in select color TAB.<br/>

package/KNXEngine/package.json

@@ -44,7 +44,7 @@
     "log-driver": "1.2.7",
     "lodash": "4.17.21",
     "path": "0.12.7",
-    "crypto-js": "4.1.1",
+    "crypto-js": "4.2.0",
     "xml2js": "0.6.0"
   },
   "devDependencies": {}

package/nodes/hue-config.html

@@ -129,8 +129,8 @@
     
     
 </script>
-<script type="text/markdown" data-help-name="hue-config">
-<p> This node registers to the Hue Bridge.<br/>
+<script type="text/markdown" data-help-name="hue-config"
+This node registers to the Hue Bridge.  
 
 Just set the Bridge's IP and click **CONNECT** button.
 

package/nodes/hue-config.js

@@ -35,12 +35,13 @@ const toConcattedSubtypes = (acc, baseType) => {
   return acc.concat(subtypes);
 };
 
-module.exports = (RED) => {
-  RED.httpAdmin.get("/knxUltimateDpts", RED.auth.needsPermission("hue-config.read"), (req, res) => {
-    const dpts = Object.entries(dptlib).filter(onlyDptKeys).map(extractBaseNo).sort(sortBy("base")).reduce(toConcattedSubtypes, []);
-    res.json(dpts);
-  });
+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
+}
 
+module.exports = (RED) => {
   function hueConfig(config) {
     RED.nodes.createNode(this, config);
     const node = this;
@@ -48,6 +49,7 @@ module.exports = (RED) => {
     node.nodeClients = []; // Stores the registered clients
     node.loglevel = config.loglevel !== undefined ? config.loglevel : "error"; // 18/02/2020 Loglevel default error
     node.sysLogger = null;
+    node.hueAllResources = null;
     try {
       node.sysLogger = loggerEngine.get({ loglevel: node.loglevel }); // New logger to adhere to the loglevel selected in the config-window
     } catch (error) {
@@ -80,20 +82,72 @@ module.exports = (RED) => {
       });
       // Connected
       node.hueManager.on("connected", () => {
+        (async () => {
+          try {
+            await node.loadResourcesFromHUEBridge(); // Then, you can use node.getResources, that works locally and doesn't query the HUE Bridge.
+          } catch (error) { /* empty */ }
+        })();
         if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.info("node.hueManager connected event");
       });
-      // Initialize the http wrapper, to use the provided key.
-      // This http wrapper is used to get the data from HUE brigde
-      await node.refreshResources();
     };
 
-    (async () => {
-      await node.ConnectToHueBridge();
-    })();
-
-    // Get all devices and join it with relative rooms, by adding the room name to the device name
+    // Query the HUE Bridge to return the resources
+    node.loadResourcesFromHUEBridge = (_callerNode = undefined) => new Promise((resolve, reject) => {
+      (async () => {
+        // °°°°°° Load ALL resources
+        try {
+          if (_callerNode === undefined) {
+            node.hueAllResources = await node.hueManager.hueApiV2.get("/resource");
+            node.hueAllRooms = node.hueAllResources.filter((a) => a.type === "room");
+            // Update all KNX State of the nodes with the new hue device values
+            node.nodeClients.forEach((nodeClient) => {
+              if (nodeClient.hueDevice !== undefined) {
+                const oHUEDevice = node.hueAllResources.filter((a) => a.id === nodeClient.hueDevice)[0];
+                if (oHUEDevice !== undefined) {
+                  nodeClient.currentHUEDevice = oHUEDevice;
+                  for (const [key, value] of Object.entries(oHUEDevice)) {
+                    // Update KNX State
+                    const oProperty = { id: oHUEDevice.id };
+                    oProperty[key] = value;
+                    nodeClient.handleSendHUE(oProperty);
+                  }
+                }
+              }
+            });
+          } else {
+            // °°°°°° Read ONE resource and update only one node. The node is requesting an update because it has been edited in Node-Red's window by the user
+            try {
+              // Please KEEP THE AWAIT, otherwise al posto dell'oggetto, a Promisse will be returned.
+              const oHUEDevice = await node.hueAllResources.filter((a) => a.id === _callerNode.hueDevice)[0];
+              if (oHUEDevice !== undefined) {
+                _callerNode.currentHUEDevice = oHUEDevice;
+                for (const [key, value] of Object.entries(oHUEDevice)) {
+                  // Update KNX State
+                  const oProperty = { id: oHUEDevice.id };
+                  oProperty[key] = value;
+                  _callerNode.handleSendHUE(oProperty);
+                }
+              }
+            } catch (error) {
+              if (this.sysLogger !== undefined && this.sysLogger !== null) {
+                this.sysLogger.error(`KNXUltimatehueEngine: loadResourcesFromHUEBridge, from a single node that has been edited: ${error.message}`);
+                reject(error.message);
+              }
+            }
+          }
+          resolve(true);
+        } catch (error) {
+          if (this.sysLogger !== undefined && this.sysLogger !== null) {
+            this.sysLogger.error(`KNXUltimatehueEngine: loadResourcesFromHUEBridge: ${error.message}`);
+            reject(error.message);
+          }
+        }
+      })();
+    });
+    // Returns the cached devices (node.hueAllResources) by type.
     node.getResources = (_rtype) => {
       try {
+        if (node.hueAllResources === undefined) return;
         // Returns capitalized string
         function capStr(s) {
           if (typeof s !== "string") return "";
@@ -121,14 +175,14 @@ module.exports = (RED) => {
                   resourceName += "ALL GROUPS and ";
                 } else {
                   resourceName += `${owner.metadata.name} and `;
-                  //const room = node.hueAllRooms.find((child) => child.children.find((a) => a.rid === owner.id));
-                  //sRoom += room !== undefined ? `${room.metadata.name} + ` : " + ";
-                  sType += capStr(owner.type) + ' + ';
+                  // const room = node.hueAllRooms.find((child) => child.children.find((a) => a.rid === owner.id));
+                  // sRoom += room !== undefined ? `${room.metadata.name} + ` : " + ";
+                  sType += `${capStr(owner.type)} + `;
                 }
               }
               sType = sType.slice(0, -" + ".length);
               resourceName = resourceName.slice(0, -" and ".length);
-              resourceName += sType !== "" ? ' (' + sType + ')' : "";
+              resourceName += sType !== "" ? ` (${sType})` : "";
               retArray.push({
                 name: `${capStr(resource.type)}: ${resourceName}`,
                 id: resource.id,
@@ -153,7 +207,7 @@ module.exports = (RED) => {
                 id: resource.id,
               });
             }
-            if (_rtype === "motion") {
+            if (_rtype === "motion" || _rtype === "camera_motion") {
               const linkedDevName = node.hueAllResources.find((dev) => dev.type === "device" && dev.services.find((serv) => serv.rid === resource.id)).metadata.name || "";
               retArray.push({
                 name: `${capStr(_rtype)}: ${linkedDevName}`,
@@ -200,32 +254,16 @@ module.exports = (RED) => {
         }
         return { devices: retArray };
       } catch (error) {
-        if (node.sysLogger !== undefined && node.sysLogger !== null)
-          node.sysLogger.error(`KNXUltimateHue: hueEngine: classHUE: getDevices: error ${error.message}`);
+        if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error(`KNXUltimateHue: hueEngine: classHUE: getResources: error ${error.message}`);
         return { devices: error.message };
       }
     };
-    node.refreshResources = () => new Promise((resolve, reject) => {
-      (async () => {
-        // Reload all resources
-        try {
-          node.hueAllResources = await node.hueManager.hueApiV2.get("/resource");
-          node.hueAllRooms = node.hueAllResources.filter((a) => a.type === "room");
-          resolve(true);
-        } catch (error) {
-          if (this.sysLogger !== undefined && this.sysLogger !== null) {
-            this.sysLogger.error(`KNXUltimatehueEngine: getting resources: ${error.message}`);
-            reject(error.message);
-          }
-        }
-      })();
-    });
 
-    // Get all devices and join it with relative rooms, by adding the room name to the device name
+    // Query HUE Bridge and get the updated color.
     node.getColorFromHueLight = (_lightId) => new Promise((resolve, reject) => {
       (async () => {
         try {
-          await node.refreshResources();
+          // await node.loadResourcesFromHUEBridge();
           const oLight = node.hueAllResources.filter((a) => a.id === _lightId)[0];
           const ret = hueColorConverter.ColorConverter.xyBriToRgb(
             oLight.color.xy.x,
@@ -307,9 +345,13 @@ module.exports = (RED) => {
         })();
       }
     });
-  }
 
-  // RED.nodes.registerType("hue-config", hue-config);
+    RED.httpAdmin.get("/knxUltimateDpts", RED.auth.needsPermission("hue-config.read"), (req, res) => {
+      const dpts = Object.entries(dptlib).filter(onlyDptKeys).map(extractBaseNo).sort(sortBy("base"))
+        .reduce(toConcattedSubtypes, []);
+      res.json(dpts);
+    });
+  }
   RED.nodes.registerType("hue-config", hueConfig, {
     credentials: {
       username: { type: "password" },