node-red-contrib-knx-ultimate 2.2.1 → 2.2.3

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,22 @@
 ![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
+
+<b>Version 2.2.3</b> - October 2023<br/>
+- HUE Light: Again, rewrite of the DIM function to get rid of the dimming_delta.<br/>
+</p>
+<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/>

package/nodes/hue-config.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-param-reassign */
 /* eslint-disable no-inner-declarations */
 /* eslint-disable max-len */
 const dptlib = require("../KNXEngine/src/dptlib");
@@ -5,6 +6,12 @@ const HueClass = require("./utils/hueEngine").classHUE;
 const loggerEngine = require("./utils/sysLogger");
 const hueColorConverter = require("./utils/hueColorConverter");
 
+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]) {
@@ -85,67 +92,49 @@ module.exports = (RED) => {
         (async () => {
           try {
             await node.loadResourcesFromHUEBridge(); // Then, you can use node.getResources, that works locally and doesn't query the HUE Bridge.
-          } catch (error) { /* empty */ }
+          } catch (error) {
+            /* empty */
+          }
         })();
         if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.info("node.hueManager connected event");
       });
     };
 
     // Query the HUE Bridge to return the resources
-    node.loadResourcesFromHUEBridge = (_callerNode = undefined) => new Promise((resolve, reject) => {
+    node.loadResourcesFromHUEBridge = () => {
       (async () => {
-        // Reload all resources
+        // °°°°°° 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
-                    let oProperty = { id: oHUEDevice.id }
-                    oProperty[key] = value;
-                    nodeClient.handleSendHUE(oProperty);
-                  }
-                }
-              }
-            });
-          } else {
-            // Update only one node. The node is requesting an update because it has beeb edited 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];
+          node.nodeClients.forEach((nodeClient) => {
+            if (nodeClient.hueDevice !== undefined) {
+              const oHUEDevice = node.hueAllResources.filter((a) => a.id === nodeClient.hueDevice)[0];
               if (oHUEDevice !== undefined) {
-                _callerNode.currentHUEDevice = oHUEDevice;
-                for (const [key, value] of Object.entries(oHUEDevice)) {
-                  // Update KNX State
-                  let 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);
+                nodeClient.currentHUEDevice = oHUEDevice;
+                nodeClient.handleSendHUE(oHUEDevice);
+                // for (const [key, value] of Object.entries(oHUEDevice)) {
+                //   // Update KNX State
+                //   const oProperty = { id: oHUEDevice.id };
+                //   oProperty[key] = value;
+                //   nodeClient.handleSendHUE(oProperty);
+                // }
               }
             }
-          }
-          resolve(true);
+          });
         } catch (error) {
           if (this.sysLogger !== undefined && this.sysLogger !== null) {
             this.sysLogger.error(`KNXUltimatehueEngine: loadResourcesFromHUEBridge: ${error.message}`);
-            reject(error.message);
+            return (error.message);
           }
         }
+        return true;
       })();
-    });
+    };
+
     // Returns the cached devices (node.hueAllResources) by type.
-    node.getResources = (_rtype) => {
+    node.getResources = function getResources(_rtype) {
       try {
         if (node.hueAllResources === undefined) return;
         // Returns capitalized string
@@ -175,14 +164,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,
@@ -207,7 +196,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}`,
@@ -260,23 +249,17 @@ module.exports = (RED) => {
     };
 
     // Query HUE Bridge and get the updated color.
-    node.getColorFromHueLight = (_lightId) => new Promise((resolve, reject) => {
-      (async () => {
-        try {
-          // await node.loadResourcesFromHUEBridge();
-          const oLight = node.hueAllResources.filter((a) => a.id === _lightId)[0];
-          const ret = hueColorConverter.ColorConverter.xyBriToRgb(
-            oLight.color.xy.x,
-            oLight.color.xy.y,
-            oLight.dimming.brightness,
-          );
-          resolve(JSON.stringify(ret));
-        } catch (error) {
-          if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error(`KNXUltimateHue: hueEngine: getColorFromHueLight: error ${error.message}`);
-          reject(error.message);
-        }
-      })();
-    });
+    node.getColorFromHueLight = (_lightId) => {
+      try {
+        // await node.loadResourcesFromHUEBridge();
+        const oLight = node.hueAllResources.filter((a) => a.id === _lightId)[0];
+        const ret = hueColorConverter.ColorConverter.xyBriToRgb(oLight.color.xy.x, oLight.color.xy.y, oLight.dimming.brightness);
+        return JSON.stringify(ret);
+      } catch (error) {
+        if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error(`KNXUltimateHue: hueEngine: getColorFromHueLight: error ${error.message}`);
+        return {};
+      }
+    };
 
     node.addClient = (_Node) => {
       // Check if node already exists
@@ -288,6 +271,12 @@ module.exports = (RED) => {
           text: "Hue initialized.",
         });
         node.nodeClients.push(_Node);
+        // Update the node hue device, as soon as a node register itself to hue-config nodeClients
+        if (node.hueAllResources !== null) { // At first start, due to the async method for retrieving hueAllResources, hueAllResources is still null. The first start is handled in node.hueManager.on("connected")
+          const oHUEDevice = node.hueAllResources.filter((a) => a.id === _Node.hueDevice)[0];
+          _Node.currentHUEDevice = oHUEDevice;
+          if (oHUEDevice !== undefined) _Node.handleSendHUE(oHUEDevice);
+        }
       }
     };
 
@@ -295,7 +284,9 @@ module.exports = (RED) => {
       // Remove the client node from the clients array
       try {
         node.nodeClients = node.nodeClients.filter((x) => x.id !== _Node.id);
-      } catch (error) { /* empty */ }
+      } catch (error) {
+        /* empty */
+      }
     };
 
     node.on("close", (done) => {
@@ -320,14 +311,12 @@ module.exports = (RED) => {
     });
 
     RED.httpAdmin.get("/knxUltimateGetHueColor", RED.auth.needsPermission("hue-config.read"), (req, res) => {
-      (async () => {
-        try {
-          const rgbColor = await node.getColorFromHueLight(req.query.id);
-          res.json(rgbColor);
-        } catch (error) {
-          res.json("Select the device first!");
-        }
-      })();
+      try {
+        const rgbColor = node.getColorFromHueLight(req.query.id);
+        res.json(rgbColor);
+      } catch (error) {
+        res.json("Select the device first!");
+      }
     });
 
     RED.httpAdmin.get("/KNXUltimateGetResourcesHUE", RED.auth.needsPermission("hue-config.read"), (req, res) => {

package/nodes/knxUltimate-config.js

@@ -940,14 +940,16 @@ return msg;`,
           }
           // 12/11/2021 Starts the telegram out queue handler
           if (node.timerSendTelegramFromQueue !== null) clearInterval(node.timerSendTelegramFromQueue);
-          node.timerSendTelegramFromQueue = setInterval(handleTelegramQueue, config.delaybetweentelegrams === undefined || Number(config.delaybetweentelegrams) < 20 ? 20 : Number(config.delaybetweentelegrams),
-          ); // 02/01/2020 Start the timer that handles the queue of telegrams
+          node.timerSendTelegramFromQueue = setInterval(handleTelegramQueue, config.delaybetweentelegrams === undefined || Number(config.delaybetweentelegrams) < 20 ? 20 : Number(config.delaybetweentelegrams)); // 02/01/2020 Start the timer that handles the queue of telegrams
           node.linkStatus = "connected";
 
           // Start the timer to do initial read.
           if (node.timerDoInitialRead !== null) clearTimeout(node.timerDoInitialRead);
-          node.timerDoInitialRead = setTimeout(DoInitialReadFromKNXBusOrFile, 6000); // 17/02/2020 Do initial read of all nodes requesting initial read
-          node.timerCallConnectToHueBridgeOfAllHUEServers = setTimeout(callConnectToHueBridgeOfAllHUEServers, 10000); // connects all hue-config nodes to the HUE Bridge.
+          node.timerDoInitialRead = setTimeout(() => {
+            DoInitialReadFromKNXBusOrFile();
+            callConnectToHueBridgeOfAllHUEServers();
+          }, 6000); // 17/02/2020 Do initial read of all nodes requesting initial read
+          //node.timerCallConnectToHueBridgeOfAllHUEServers = setTimeout(callConnectToHueBridgeOfAllHUEServers, 6000); // connects all hue-config nodes to the HUE Bridge.
           const t = setTimeout(() => {
             // 21/03/2022 fixed possible memory leak. Previously was setTimeout without "let t = ".
             node.setAllClientsStatus("Connected.", "green", "On duty.");

package/nodes/knxUltimateHueBattery.js

@@ -1,107 +1,108 @@
 module.exports = function (RED) {
   function knxUltimateHueBattery(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 = false
-    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
+    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 = false;
+    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;
 
     // Used to call the status update from the config node.
-    node.setNodeStatus = ({ fill, shape, text, payload }) => {
+    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) return
-      const dDate = new Date()
-      payload = typeof payload === 'object' ? JSON.stringify(payload) : payload.toString()
-      node.status({ fill, shape, text: text + ' ' + payload + ' (' + dDate.getDate() + ', ' + dDate.toLocaleTimeString() + ')' })
-    }
+    node.setNodeStatusHue = ({
+      fill, shape, text, payload,
+    }) => {
+      if (payload === undefined) return;
+      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 => {
-    }
+    node.handleSend = (msg) => {
+    };
 
-    node.handleSendHUE = _event => {
+    node.handleSendHUE = (_event) => {
       try {
         if (_event.id === config.hueDevice) {
-          const knxMsgPayload = {}
-          knxMsgPayload.topic = config.GAbatterysensor
-          knxMsgPayload.dpt = config.dptbatterysensor
+          const knxMsgPayload = {};
+          knxMsgPayload.topic = config.GAbatterysensor;
+          knxMsgPayload.dpt = config.dptbatterysensor;
 
           if (_event.hasOwnProperty('power_state') && _event.power_state.hasOwnProperty('battery_level')) {
-            knxMsgPayload.payload = _event.power_state.battery_level
+            knxMsgPayload.payload = _event.power_state.battery_level;
             // 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 })
-            
+            if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) {
+              node.server.writeQueueAdd({
+                grpaddr: knxMsgPayload.topic, payload: knxMsgPayload.payload, dpt: knxMsgPayload.dpt, outputtype: 'write', nodecallerid: node.id,
+              });
+            }
+
             // Setup the output msg
-            knxMsgPayload.name = node.name
-            knxMsgPayload.event = 'power_state'
+            knxMsgPayload.name = node.name;
+            knxMsgPayload.event = 'power_state';
 
             // Send payload
-            knxMsgPayload.rawEvent = _event
-            node.send(knxMsgPayload)
-            node.setNodeStatusHue({ fill: 'blue', shape: 'ring', text: 'HUE->KNX', payload: knxMsgPayload.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.status({ fill: 'red', shape: 'dot', text: `HUE->KNX error ${error.message} (${new Date().getDate()}, ${new Date().toLocaleTimeString()})` });
       }
-    }
+    };
 
     // On each deploy, unsubscribe+resubscribe
     if (node.server) {
-      node.server.removeClient(node)
-      node.server.addClient(node)
+      node.server.removeClient(node);
+      node.server.addClient(node);
     }
     if (node.serverHue) {
-      node.serverHue.removeClient(node)
+      node.serverHue.removeClient(node);
       // I must get the object, to store read the battery status
       // I queue the state request, by passing the callback to call whenever the HUE bridge send me the light status async
       if (node.serverHue !== null && node.serverHue.hueManager !== null) {
-        (async () => {
-          try {
-            node.serverHue.addClient(node)
-            await node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, null, 'getBattery', (jLight) => {
-              node.handleSendHUE(jLight)
-            })
-          } catch (err) {
-            RED.log.error('Errore knxUltimateHueBattery subscribe: ' + err.message)
-          }
-        })()
+        node.serverHue.addClient(node);
       }
     }
 
-    node.on('input', function (msg) {
+    node.on('input', (msg) => {
 
-    })
+    });
 
-    node.on('close', function (done) {
+    node.on('close', (done) => {
       if (node.server) {
-        node.server.removeClient(node)
+        node.server.removeClient(node);
       }
       if (node.serverHue) {
-        node.serverHue.removeClient(node)
+        node.serverHue.removeClient(node);
       }
-      done()
-    })
+      done();
+    });
   }
-  RED.nodes.registerType('knxUltimateHueBattery', knxUltimateHueBattery)
-}
+  RED.nodes.registerType('knxUltimateHueBattery', knxUltimateHueBattery);
+};