node-red-contrib-knx-ultimate 2.1.40 → 2.1.42

package/.eslintrc.json

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

package/CHANGELOG.md

@@ -6,8 +6,19 @@
 
 # CHANGELOG
 
+<p>
+<b>Version 2.1.42</b> - August 2023<br/>
+- Fixed some issues in getting the hue device's names, when using some non LTS versions of node.js.<br/>
+</p>
+<p>
+<b>Version 2.1.41</b> - August 2023<br/>
+- NEW: HUE Light: you can now control ALL GROUPED LIGHT together.<br/>
+- HUE Light: fixed an issue with the "Link brightness to on/off switch" option, when a json color is selected at daylight or nighttime<br/>
+- HUE Light: New: now you can use both DPT 5.001 and 3.007 in the color temperature, at the same time.<br/>
+</p>
+<p>
 <b>Version 2.1.40</b> - August 2023<br/>
-- HUE Light: Buffix: color cycle continues to cycle color, even if a FALSE is sent from the group address.<br/>
+- HUE Light: Bugfix: color cycle continues to cycle color, even if a FALSE is sent from the group address.<br/>
 </p>
 <p>
 <b>Version 2.1.39</b> - August 2023<br/>

package/nodes/hue-config.html

@@ -18,7 +18,7 @@
             }
             $("#getinfocam").click(function () {
 
-                var myNotification = RED.notify("Please press the Link button on the HUE Bridge / Pre favore, premi il pulsante sul bridge HUE",
+                var myNotification = RED.notify("Please press the Link button on the HUE Bridge",
                     {
                         modal: true,
                         fixed: true,
@@ -69,13 +69,7 @@
                                 }
                             }]
                     });
-
-
-
-
             });
-
-
         },
         oneditsave: function () {
 
@@ -96,9 +90,7 @@
    
     <div class="form-row">
         <label for="node-config-input-host">
-            <i class="fa fa-server"></i>
-            <span data-i18n="hue-config.properties.host" </span>
-        </label>
+            <i class="fa fa-server"></i> IP</label>
         <input type="text" id="node-config-input-host" placeholder="Write here the HUE bridge's IP, then click CONNECT">
     </div>
     <div class="form-row">
@@ -127,11 +119,11 @@
 
         <div class="form-row">
             <label for="node-config-input-username"> Username</label>
-            <input type="password" id="node-config-input-username" placeholder="">
+            <input type="password" id="node-config-input-username" placeholder="" disabled>
         </div>
         <div class="form-row">
             <label for="node-config-input-clientkey"> Bridge Key</label>
-            <input type="password" id="node-config-input-clientkey" placeholder="">
+            <input type="password" id="node-config-input-clientkey" placeholder="" disabled>
         </div>
     </div>
     

package/nodes/hue-config.js

@@ -1,149 +1,243 @@
-
-const dptlib = require('./../KNXEngine/src/dptlib')
-const hueClass = require('./utils/hueEngine').classHUE
-const loggerEngine = require('./utils/sysLogger.js')
+/* eslint-disable max-len */
+const dptlib = require('../KNXEngine/src/dptlib');
+const HueClass = require('./utils/hueEngine').classHUE;
+const loggerEngine = require('./utils/sysLogger');
 // Helpers
 const sortBy = (field) => (a, b) => {
-  if (a[field] > b[field]) { return 1 } else { return -1 }
-}
+  if (a[field] > b[field]) { return 1; } return -1;
+};
 
-const onlyDptKeys = (kv) => {
-  return kv[0].startsWith('DPT')
-}
+const onlyDptKeys = (kv) => kv[0].startsWith('DPT');
 
-const extractBaseNo = (kv) => {
-  return {
-    subtypes: kv[1].subtypes,
-    base: parseInt(kv[1].id.replace('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]}`
+  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
+  const sRet = `${value} ${kv[1].name}`;
   return {
     value,
-    text: sRet
-  }
-}
+    text: sRet,
+  };
+};
 
 const toConcattedSubtypes = (acc, baseType) => {
-  const subtypes =
-    Object.entries(baseType.subtypes)
-      .sort(sortBy(0))
-      .map(convertSubtype(baseType))
+  const subtypes = Object.entries(baseType.subtypes)
+    .sort(sortBy(0))
+    .map(convertSubtype(baseType));
 
-  return acc.concat(subtypes)
-}
+  return acc.concat(subtypes);
+};
 
 module.exports = (RED) => {
-  'use strict'
+  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, []);
 
-  RED.httpAdmin.get('/knxUltimateDpts', RED.auth.needsPermission('hue-config.read'), function (req, res) {
-    const dpts =
-      Object.entries(dptlib)
-        .filter(onlyDptKeys)
-        .map(extractBaseNo)
-        .sort(sortBy('base'))
-        .reduce(toConcattedSubtypes, [])
-
-    res.json(dpts)
-  })
+    res.json(dpts);
+  });
 
   function hueConfig(config) {
-    RED.nodes.createNode(this, config)
-    const node = this
-    node.host = config.host
-    node.nodeClients = [] // Stores the registered clients
-    node.loglevel = config.loglevel !== undefined ? config.loglevel : 'error' // 18/02/2020 Loglevel default error
-    node.sysLogger = null // 20/03/2022 Default
+    RED.nodes.createNode(this, config);
+    const node = this;
+    node.host = config.host;
+    node.nodeClients = []; // Stores the registered clients
+    node.loglevel = config.loglevel !== undefined ? config.loglevel : 'error'; // 18/02/2020 Loglevel default error
+    node.sysLogger = null;
     try {
-      node.sysLogger = loggerEngine.get({ loglevel: node.loglevel }) // 08/04/2021 new logger to adhere to the loglevel selected in the config-window
-    } catch (error) { }
-    node.name = (config.name === undefined || config.name === '') ? node.host : config.name // 12/08/2021
+      node.sysLogger = loggerEngine.get({ loglevel: node.loglevel }); // New logger to adhere to the loglevel selected in the config-window
+    } catch (error) { /* empty */ }
+    node.name = (config.name === undefined || config.name === '') ? node.host : config.name;
 
     // Init HUE Utility
-    node.hueManager = new hueClass(node.host, node.credentials.username, node.credentials.clientkey, config.bridgeid, node.sysLogger)
-
-    // Event clip V2
-    node.hueManager.on('event', _event => {
-      node.nodeClients.forEach(_oClient => {
-        const oClient = RED.nodes.getNode(_oClient.id)
-        try {
-          if (oClient.handleSendHUE !== undefined) oClient.handleSendHUE(_event)
-        } catch (error) {
-          if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error('Errore node.hueManager.on(event): ' + error.message)
-        }
-      })
-    })
+    node.hueManager = new HueClass(node.host, node.credentials.username, node.credentials.clientkey, config.bridgeid, node.sysLogger);
 
-    RED.httpAdmin.get('/KNXUltimateGetResourcesHUE', RED.auth.needsPermission('hue-config.read'), function (req, res) {
+    // Connect to Bridge and get the resources
+    node.ConnectToHueBridge = async () => {
+      await node.hueManager.Connect();
+      // Handle events
       try {
+        node.hueManager.removeAllListeners();
+      } catch (error) { /* empty */ }
+      node.hueManager.on('event', (_event) => {
+        node.nodeClients.forEach((_oClient) => {
+          const oClient = _oClient;
+          try {
+            if (oClient.handleSendHUE !== undefined) oClient.handleSendHUE(_event);
+          } catch (error) {
+            if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error(`Errore node.hueManager.on(event): ${error.message}`);
+          }
+        });
+      });
+      // Connected
+      node.hueManager.on('connected', () => {
+        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
+      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}`);
+      }
+    };
+
+    (async () => {
+      await node.ConnectToHueBridge();
+    })();
+
+    RED.httpAdmin.get('/KNXUltimateGetResourcesHUE', RED.auth.needsPermission('hue-config.read'), (req, res) => {
+      try {
+        // °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
+        const jRet = node.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 {
+        // Api V2
+
+        // Returns capitalized string
+        function capStr(s) {
+          if (typeof s !== 'string') return '';
+          return s.charAt(0).toUpperCase() + s.slice(1);
+        }
+
+        const retArray = [];
+        let allResources;
+        if (_rtype === 'light' || _rtype === 'grouped_light') {
+          allResources = node.hueAllResources.filter((a) => a.type === 'light' || a.type === 'grouped_light');
+        } else {
+          allResources = node.hueAllResources.filter((a) => a.type === _rtype);
+        }
+        for (let index = 0; index < allResources.length; index++) {
+          const resource = allResources[index];
+          // Get the owner
           try {
-            // °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
-            const _node = RED.nodes.getNode(req.query.nodeID)// Retrieve node.id of the config node.
-            const jRet = await node.hueManager.getResources(req.query.rtype, _node.host, _node.credentials.username)
-            res.json(jRet)
-            // °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
-          } catch (err) {
-            RED.log.error('Errore KNXUltimateGetResourcesHUE non gestito ' + err.message)
-            res.json({ error: err.message })
+            let resourceName = '';
+            let sRoom = '';
+            if (_rtype === 'light' || _rtype === 'grouped_light') {
+              // It's a service, having a owner
+              const owners = node.hueAllResources.filter((a) => a.id === resource.owner.rid);
+              for (let index = 0; index < owners.length; index++) {
+                const owner = owners[index];
+                if (owner.type === 'bridge_home') {
+                  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} + ` : ' + ';
+                }
+              }
+              sRoom = sRoom.slice(0, -(' + '.length));
+              resourceName = resourceName.slice(0, -(' and '.length));
+              resourceName += sRoom !== '' ? ` - Room: ${sRoom}` : '';
+              retArray.push({ name: `${capStr(resource.type)}: ${resourceName}`, id: resource.id, deviceObject: resource });
+            }
+            if (_rtype === 'scene') {
+              resourceName = resource.metadata.name || '**Name Not Found**';
+              // Get the linked zone
+              const zone = node.hueAllResources.find((res) => res.id === resource.group.rid);
+              resourceName += ` - ${capStr(resource.group.rtype)}: ${zone.metadata.name}`;
+              retArray.push({ name: `${capStr(_rtype)}: ${resourceName}`, id: resource.id });
+            }
+            if (_rtype === 'button') {
+              const linkedDevName = node.hueAllResources.find((dev) => dev.type === 'device' && dev.services.find((serv) => serv.rid === resource.id)).metadata.name || '';
+              const controlID = resource.metadata !== undefined ? (resource.metadata.control_id || '') : '';
+              retArray.push({ name: `${capStr(_rtype)}: ${linkedDevName}, button ${controlID}`, id: resource.id });
+            }
+            if (_rtype === '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}`, id: resource.id });
+            }
+            if (_rtype === 'relative_rotary') {
+              const linkedDevName = node.hueAllResources.find((dev) => dev.type === 'device' && dev.services.find((serv) => serv.rid === resource.id)).metadata.name || '';
+              retArray.push({ name: `Rotary: ${linkedDevName}`, id: resource.id });
+            }
+            if (_rtype === 'light_level') {
+              const Room = node.hueAllRooms.find((room) => room.children.find((child) => child.rid === resource.owner.rid));
+              const linkedDevName = node.hueAllResources.find((dev) => dev.type === 'device' && dev.services.find((serv) => serv.rid === resource.id)).metadata.name || '';
+              retArray.push({ name: `Light Level: ${linkedDevName}${Room !== undefined ? `, room ${Room.metadata.name}` : ''}`, id: resource.id });
+            }
+            if (_rtype === 'temperature') {
+              const Room = node.hueAllRooms.find((room) => room.children.find((child) => child.rid === resource.owner.rid));
+              const linkedDevName = node.hueAllResources.find((dev) => dev.type === 'device' && dev.services.find((serv) => serv.rid === resource.id)).metadata.name || '';
+              retArray.push({ name: `Temperature: ${linkedDevName}${Room !== undefined ? `, room ${Room.metadata.name}` : ''}`, id: resource.id });
+            }
+            if (_rtype === 'device_power') {
+              const Room = node.hueAllRooms.find((room) => room.children.find((child) => child.rid === resource.owner.rid));
+              const linkedDevName = node.hueAllResources.find((dev) => dev.type === 'device' && dev.services.find((serv) => serv.rid === resource.id)).metadata.name || '';
+              retArray.push({ name: `Battery: ${linkedDevName}${Room !== undefined ? `, room ${Room.metadata.name}` : ''}`, id: resource.id });
+            }
+          } catch (error) {
+            retArray.push({ name: `${_rtype}: ERROR ${error.message}`, id: resource.id });
           }
-        })()
-      } catch (err) {
-        RED.log.error('Errore KNXUltimateGetResourcesHUE bsonto ' + err.message)
-        res.json({ error: err.message })
+        }
+        return { devices: retArray };
+      } catch (error) {
+        if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error(`KNXUltimateHue: hueEngine: classHUE: getDevices: error ${error.message}`);
+        return ({ devices: error.message });
       }
-    })
+    };
 
     node.addClient = (_Node) => {
       // Check if node already exists
-      if (node.nodeClients.filter(x => x.id === _Node.id).length === 0) {
+      if (node.nodeClients.filter((x) => x.id === _Node.id).length === 0) {
         // Add _Node to the clients array
-        _Node.setNodeStatusHue({ fill: 'grey', shape: 'ring', text: 'Hue initialized.' })
-        // 01/06/2023 Add node to the array
-        const jNode = {}
-        jNode.id = _Node.id
-        jNode.topic = _Node.topic
-        node.nodeClients.push(jNode)
+        _Node.setNodeStatusHue({ fill: 'grey', shape: 'ring', text: 'Hue initialized.' });
+        node.nodeClients.push(_Node);
       }
-    }
+    };
 
     node.removeClient = (_Node) => {
       // Remove the client node from the clients array
       try {
-        node.nodeClients = node.nodeClients.filter(x => x.id !== _Node.id)
+        node.nodeClients = node.nodeClients.filter((x) => x.id !== _Node.id);
       } catch (error) { }
-    }
+    };
 
-    node.on('close', function (done) {
+    node.on('close', (done) => {
       try {
-        if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger = null; loggerEngine.destroy()
-        node.nodeClients = []
+        if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger = null; loggerEngine.destroy();
+        node.nodeClients = [];
         node.hueManager.removeAllListeners();
         (async () => {
           try {
-            await node.hueManager.close()
-            node.hueManager = null
-            delete node.hueManager
-          } catch (error) {
-          }
-          done()
-        })()
+            await node.hueManager.close();
+            node.hueManager = null;
+            delete node.hueManager;
+          } catch (error) { /* empty */ }
+          done();
+        })();
       } catch (error) {
-        done()
-        console.log(error.message)
+        done();
       }
-    })
+    });
   }
 
   // RED.nodes.registerType("hue-config", hue-config);
   RED.nodes.registerType('hue-config', hueConfig, {
     credentials: {
       username: { type: 'password' },
-      clientkey: { type: 'password' }
-    }
-  })
-}
+      clientkey: { type: 'password' },
+    },
+  });
+};