node-red-contrib-knx-ultimate 2.1.57 → 2.1.58

package/CHANGELOG.md

@@ -6,6 +6,10 @@
 
 # CHANGELOG
 <p>
+<b>Version 2.1.58</b> - October 2023<br/>
+- HUE Light: NEW color picker. Just click a button to automatically fill the node's "color" properties<br/>
+</p>
+<p>
 <b>Version 2.1.57</b> - October 2023<br/>
 - HUE Light: NEW Behaviour "KNX Brightness Status"<br/>
 - HUE Light: the light now remembers the last brightness value after switch off<br/>

package/nodes/hue-config.js

@@ -3,6 +3,8 @@
 const dptlib = require("../KNXEngine/src/dptlib");
 const HueClass = require("./utils/hueEngine").classHUE;
 const loggerEngine = require("./utils/sysLogger");
+const hueColorConverter = require("./utils/hueColorConverter");
+
 // Helpers
 const sortBy = (field) => (a, b) => {
   if (a[field] > b[field]) {
@@ -30,14 +32,12 @@ const convertSubtype = (baseType) => (kv) => {
 
 const toConcattedSubtypes = (acc, baseType) => {
   const subtypes = Object.entries(baseType.subtypes).sort(sortBy(0)).map(convertSubtype(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);
   });
 
@@ -53,6 +53,7 @@ module.exports = (RED) => {
     } catch (error) {
       /* empty */
     }
+
     node.name = config.name === undefined || config.name === "" ? node.host : config.name;
 
     // Init HUE Utility
@@ -83,38 +84,13 @@ module.exports = (RED) => {
       });
       // Initialize the http wrapper, to use the provided key.
       // This http wrapper is used to get the data from HUE brigde
-      try {
-        // Load all resources, to avoid too many call to the HUE bridge and speed up the showing of the device mnames, during typing in the config window
-        node.hueAllResources = await node.hueManager.hueApiV2.get("/resource");
-        node.hueAllRooms = await node.hueManager.hueApiV2.get("/resource/room");
-        node.hueAllDevices = await node.hueManager.hueApiV2.get("/resource/device");
-      } catch (error) {
-        if (this.sysLogger !== undefined && this.sysLogger !== null) {
-          this.sysLogger.error(`KNXUltimatehueEngine: classHUE: getting resources: ${error.message}`);
-        }
-      }
+      await node.refreshResources();
     };
 
     (async () => {
       await node.ConnectToHueBridge();
     })();
 
-    RED.httpAdmin.get("/KNXUltimateGetResourcesHUE", RED.auth.needsPermission("hue-config.read"), (req, res) => {
-      try {
-        // °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
-        const serverNode = RED.nodes.getNode(req.query.nodeID); // Retrieve node.id of the config node.
-        const jRet = serverNode.getResources(req.query.rtype);
-        res.json(jRet);
-        // °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
-      } catch (error) {
-        RED.log.error(`Errore KNXUltimateGetResourcesHUE non gestito ${error.message}`);
-        res.json({ devices: error.message });
-        (async () => {
-          await node.ConnectToHueBridge();
-        })();
-      }
-    });
-
     // Get all devices and join it with relative rooms, by adding the room name to the device name
     node.getResources = (_rtype) => {
       try {
@@ -123,7 +99,6 @@ module.exports = (RED) => {
           if (typeof s !== "string") return "";
           return s.charAt(0).toUpperCase() + s.slice(1);
         }
-
         const retArray = [];
         let allResources;
         if (_rtype === "light" || _rtype === "grouped_light") {
@@ -230,6 +205,40 @@ module.exports = (RED) => {
         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
+    node.getColorFromHueLight = (_lightId) => new Promise((resolve, reject) => {
+      (async () => {
+        try {
+          await node.refreshResources();
+          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.addClient = (_Node) => {
       // Check if node already exists
@@ -248,7 +257,7 @@ module.exports = (RED) => {
       // Remove the client node from the clients array
       try {
         node.nodeClients = node.nodeClients.filter((x) => x.id !== _Node.id);
-      } catch (error) { }
+      } catch (error) { /* empty */ }
     };
 
     node.on("close", (done) => {
@@ -271,6 +280,33 @@ module.exports = (RED) => {
         done();
       }
     });
+
+    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!");
+        }
+      })();
+    });
+
+    RED.httpAdmin.get("/KNXUltimateGetResourcesHUE", RED.auth.needsPermission("hue-config.read"), (req, res) => {
+      try {
+        // °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
+        const serverNode = RED.nodes.getNode(req.query.nodeID); // Retrieve node.id of the config node.
+        const jRet = serverNode.getResources(req.query.rtype);
+        res.json(jRet);
+        // °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
+      } catch (error) {
+        RED.log.error(`Errore KNXUltimateGetResourcesHUE non gestito ${error.message}`);
+        res.json({ devices: error.message });
+        (async () => {
+          await node.ConnectToHueBridge();
+        })();
+      }
+    });
   }
 
   // RED.nodes.registerType("hue-config", hue-config);

package/nodes/knxUltimateHueLight.html

@@ -96,6 +96,13 @@
             var oNodeServer = RED.nodes.node($("#node-input-server").val()); // Store the config-node
             var oNodeServerHue = RED.nodes.node($("#node-input-serverHue").val()); // Store the config-node
 
+            // var colorPicker = new iro.ColorPicker("#picker", {
+            //     // Set the size of the color picker
+            //     width: 320,
+            //     // Set the initial color to pure red
+            //     color: "#f00"
+            // });
+
             $("#tabs").tabs();
 
             // 19/02/2020 Used to get the server sooner als deploy.
@@ -268,6 +275,7 @@
                     } else {
                         $('#node-input-hueDevice').val(ui.item.hueDevice + "#light");
                     }
+                    $('#tabs').show();
                 }
             });
 
@@ -293,8 +301,26 @@
                 });
             });
 
-            // ########################
 
+            $("#getHueColorButton").on("click", function () {
+                // Get the HUE capabilities to enable/disable UI parts
+                $("#getHueColorButton").text("Wait...")
+                $.getJSON("knxUltimateGetHueColor?id=" + $('#node-input-hueDevice').val().split('#')[0], (data) => {
+                    $('#node-input-colorAtSwitchOnDayTime').val(data.toString());
+                    $("#getHueColorButton").text("Get current")
+                });
+            });
+            $("#getColorAtSwitchOnNightTime").on("click", function () {
+                // Get the HUE capabilities to enable/disable UI parts
+                $("#getColorAtSwitchOnNightTime").text("Wait...")
+                $.getJSON("knxUltimateGetHueColor?id=" + $('#node-input-hueDevice').val().split('#')[0], (data) => {
+                    $('#node-input-colorAtSwitchOnNightTime').val(data.toString());
+                    $("#getColorAtSwitchOnNightTime").text("Get current")
+                });
+            });
+
+            // ########################
+            if (this.hueDevice !== "") $('#tabs').show();
 
         },
         oneditsave: function () {
@@ -308,6 +334,7 @@
 
 </script>
 <script src="https://kit.fontawesome.com/11f26b4500.js" crossorigin="anonymous"></script>
+<!-- <script src="https://cdn.jsdelivr.net/npm/@jaames/iro@5"></script> -->
 
 <script type="text/html" data-template-name="knxUltimateHueLight">
 
@@ -337,7 +364,6 @@
     <input type="text" id="node-input-serverHue" />
 </div>
 
-
 <br/>
 <p>
 <b>Philips HUE</b>
@@ -353,7 +379,7 @@
 <br/>
 
 
-<div id="tabs">
+<div id="tabs" style="width:680px" hidden>
     <ul>
         <li><a href="#tabs-1">Switching</a></li>
         <li><a href="#tabs-2">Dim/Brightness</a></li>
@@ -559,6 +585,7 @@
                     </label>
                     <input type="text" id="node-input-colorAtSwitchOnDayTime"
                         placeholder='Leave blank or, for example, {"red":255, "green":255, "blue":255}' style="width:260px">
+                        <button id="getHueColorButton" type="button" class="red-ui-button">Get current</button>
                 </div>
                 <div class="form-row">
                     <label for="node-input-enableDayNightLighting" style="width:260px;">
@@ -576,6 +603,7 @@
                         </label>
                         <input type="text" id="node-input-colorAtSwitchOnNightTime"
                             placeholder='Example {"red":100, "green":0, "blue":50}' style="width:260px">
+                            <button id="getColorAtSwitchOnNightTime" type="button" class="red-ui-button">Get current</button>
                     </div>
                     <div class="form-row">
                         <label for="node-input-nameDaylightSensor" style="width:110px;"><i class="fa fa-clock-o"></i>

package/nodes/knxUltimateHueLight.js

@@ -119,18 +119,6 @@ module.exports = function (RED) {
               const dimDirection = msg.payload.decr_incr === 1 ? "up" : "down";
               // First, switch on the light if off
               if (node.currentHUEDevice.hasOwnProperty('on') !== undefined && node.currentHUEDevice.on.on === false && dimDirection === "up") {
-                // if (config.specifySwitchOnBrightness === undefined || config.specifySwitchOnBrightness === "yes") {
-                //   // Starts from minimum of 5
-                //   node.serverHue.hueManager.writeHueQueueAdd(
-                //     config.hueDevice,
-                //     { on: { on: true }, dimming: { brightness: 5 } },
-                //     node.isGrouped_light === false ? "setLight" : "setGroupedLight"
-                //   );
-                // } else {
-                // Read the last HUE brightness status and starts from there
-                //const lastDimVal = node.currentHUEDevice !== undefined ? node.currentHUEDevice.dimming.brightness : 5;
-                //node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, { on: { on: true }, dimming: { brightness: lastDimVal } }, node.isGrouped_light === false ? "setLight" : "setGroupedLight");
-                // }
                 node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, { on: { on: true } }, node.isGrouped_light === false ? "setLight" : "setGroupedLight");
               }
               node.startDimStopper(dimDirection);

package/nodes/utils/hueEngine.js

@@ -171,7 +171,7 @@ class classHUE extends EventEmitter {
       }
     }
     // The Hue bridge allows about 10 telegram per second, so i need to make a queue manager
-    this.timerwriteQueueAdd = setTimeout(this.handleQueue, 100);
+    this.timerwriteQueueAdd = setTimeout(this.handleQueue, 200);
   };
 
   writeHueQueueAdd = async (_lightID, _state, _operation, _callback) => {

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "2.1.57",
+  "version": "2.1.58",
   "description": "Control your KNX intallation via Node-Red! Single Node KNX IN/OUT with optional ETS group address importer. Easy to use and highly configurable. With integrated Philips HUE devices handling.",
   "dependencies": {
     "binary-parser": "2.2.1",