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

package/nodes/knxUltimateHueMotion.js

@@ -1,95 +1,107 @@
 module.exports = function (RED) {
   function knxUltimateHueMotion(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() + ')' })
-    }
+      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.GAmotion
-          knxMsgPayload.dpt = config.dptmotion
+          const knxMsgPayload = {};
+          knxMsgPayload.topic = config.GAmotion;
+          knxMsgPayload.dpt = config.dptmotion;
 
-          if (_event.hasOwnProperty('motion') && _event.motion.hasOwnProperty('motion')) {
-            knxMsgPayload.payload = _event.motion.motion
+          if (_event.hasOwnProperty("motion") && _event.motion.hasOwnProperty("motion")) {
+            knxMsgPayload.payload = _event.motion.motion_report.motion;
             // 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 })
-            node.status({ fill: 'green', shape: 'dot', text: 'HUE->KNX ' + JSON.stringify(knxMsgPayload.payload) + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
+            if (knxMsgPayload.topic !== "" && knxMsgPayload.topic !== undefined) {
+              node.server.writeQueueAdd({
+                grpaddr: knxMsgPayload.topic,
+                payload: knxMsgPayload.payload,
+                dpt: knxMsgPayload.dpt,
+                outputtype: "write",
+                nodecallerid: node.id,
+              });
+            }
+            node.status({
+              fill: "green",
+              shape: "dot",
+              text: `HUE->KNX ${JSON.stringify(knxMsgPayload.payload)} (${new Date().getDate()}, ${new Date().toLocaleTimeString()})`,
+            });
 
             // Setup the output msg
-            knxMsgPayload.name = node.name
-            knxMsgPayload.event = 'motion'
+            knxMsgPayload.name = node.name;
+            knxMsgPayload.event = "motion";
 
             // 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.addClient(node)
+      node.serverHue.removeClient(node);
+      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('knxUltimateHueMotion', knxUltimateHueMotion)
-}
+  RED.nodes.registerType("knxUltimateHueMotion", knxUltimateHueMotion);
+};

package/nodes/knxUltimateHueScene.html

@@ -260,7 +260,7 @@
 <script src="https://kit.fontawesome.com/11f26b4500.js" crossorigin="anonymous"></script>
 
 <script type="text/markdown" data-help-name="knxUltimateHueScene">
-<p> This node lets you recall a HUE scene, via KNX.<br/>
+This node lets you recall a HUE scene, via KNX.  
 
 Start typing in the GA field, the name or group address of your KNX device, the avaiable devices start showing up while you're typing.
 

package/nodes/knxUltimateHueScene.js

@@ -82,7 +82,7 @@ module.exports = function (RED) {
           // knxMsgPayload.dpt = config.dptmotion
 
           // if (_event.hasOwnProperty('motion') && _event.motion.hasOwnProperty('motion')) {
-          //   knxMsgPayload.payload = _event.motion.motion
+          //   knxMsgPayload.payload = _event.motion.motion_report.motion
           //   // 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 })
           //   node.status({ fill: 'green', shape: 'dot', text: 'HUE->KNX ' + JSON.stringify(knxMsgPayload.payload) + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })

package/nodes/knxUltimateHueTapDial.html

@@ -226,7 +226,7 @@
 <script src="https://kit.fontawesome.com/11f26b4500.js" crossorigin="anonymous"></script>
 
 <script type="text/markdown" data-help-name="knxUltimateHueTapDial">
-<p> This node lets you get the events from your HUE rotary device, for example the Tap Dial.<br/>
+This node lets you get the events from your HUE rotary device, for example the Tap Dial.  
 
 The Tap Dial device has 4 buttons and 1 rotary knob.  
 You can find the 4 buttons in the **Hue Button node**, not here!  

package/nodes/knxUltimateHueTapDial.js

@@ -147,7 +147,6 @@ module.exports = function (RED) {
       if (node.timerDimStop !== undefined) clearTimeout(node.timerDimStop);
       node.isTimerDimStopRunning = true;
       node.timerDimStop = setTimeout(() => {
-        console.log('Stop banana');
         // KNX Stop DIM
         knxMsgPayload.payload = { decr_incr: 0, data: 0 }; // Payload for the output msg
         // Send to KNX bus
@@ -158,7 +157,7 @@ module.exports = function (RED) {
         }
         if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) node.status({ fill: 'green', shape: 'dot', text: 'HUE->KNX Stop DIM' + ` (${new Date().getDate()}, ${new Date().toLocaleTimeString()})` });
         node.isTimerDimStopRunning = false;
-      }, 1500);
+      }, 500);
     };
 
     // On each deploy, unsubscribe+resubscribe

package/nodes/knxUltimateHueTemperatureSensor.html

@@ -220,8 +220,8 @@
 </script>
 <script src="https://kit.fontawesome.com/11f26b4500.js" crossorigin="anonymous"></script>
 
-<script type="text/markdown" data-help-name="knxUltimateHueTemperatureSensor">
-<p> This node lets you get the events from your HUE temperature device.<br/>
+<script type="text/markdown" data-help-name="knxUltimateHueTemperatureSensor"
+This node lets you get the events from your HUE temperature device.  
 
 Here you can get the HUE temperature events, that represents a celsius value, evetytime the ambient temp changes.<br/>
 Start typing in the GA field, the name or group address of your KNX device, the avaiable devices start showing up while you're typing.

package/nodes/knxUltimateLoadControl.html

@@ -376,7 +376,7 @@ The node turns off one device (or multiple devices) at a time, based on the orde
 
 Here you can add devices to turn off in case of overload. <br/>
 Choose the device to turn off. Enter the device name or its group address. <br/>
-Enter any group address that indicates the consumption of the device chosen in the first line. ** This is an optional parameter **. If the device is consuming more than a certain number of Watts, it means that it is in use. If it consumes less, the device will be considered "not in use" and both this and the next will be turned off at once.<br/>
+Enter any group address that indicates the consumption of the device chosen in the first line. **This is an optional parameter**. If the device is consuming more than a certain number of Watts, it means that it is in use. If it consumes less, the device will be considered "not in use" and both this and the next will be turned off at once.<br/>
 If *Automatic recovery* is enabled, the device is automatically reactivated when the "reset delay" expires.
 
 ### Inputs

package/nodes/knxUltimateViewer.html

@@ -80,4 +80,32 @@
 
 
 
+</script>
+
+<script type="text/markdown" data-help-name="knxUltimateViewer">
+View all group addresses and their values in a Dashboard widget.  
+
+This node works in conjunction with the Node-Red dashboard UI Template node.
+View all group addresses and their values in a Dashboard widget.
+
+**General**
+|Property|Description|
+|--|--|
+| KNX Gateway | The Gateway you wish to connect to. |
+| Name | The node name |
+|
+<br/>
+
+### Outputs
+
+1. Standard output
+: payload (json) : formatted payload. Connect it directly with the Template UI node.
+2. Array of objects
+: payload (array) : An array containing all the GA. You can use the array to do your own format and reordering.
+
+<br/>
+
+[Find it useful?](https://www.paypal.me/techtoday)
+
+<br/>
 </script>

package/nodes/utils/hueEngine.js

@@ -1,7 +1,7 @@
 /* eslint-disable max-len */
 const { EventEmitter } = require('events');
 const EventSource = require('eventsource');
-const http = require('./http.js');
+const http = require('./http');
 
 class classHUE extends EventEmitter {
   constructor(_hueBridgeIP, _username, _clientkey, _bridgeid, _sysLogger) {
@@ -89,6 +89,7 @@ class classHUE extends EventEmitter {
     if (this.commandQueue.length > 0) {
       // const jRet = { ...this.commandQueue.shift() } //Clone the object by value
       const jRet = this.commandQueue.shift();
+      // jRet is ({ _lightID, _state, _operation });;
       switch (jRet._operation) {
         case 'setLight':
           // It can be a light or a grouped light
@@ -105,23 +106,6 @@ class classHUE extends EventEmitter {
             if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.info(`KNXUltimatehueEngine: classHUE: handleQueue: setLight grouped_light: ${error.message}`);
           }
           break;
-        case 'getLight':
-          try {
-            const jReturn = await this.hueApiV2.get(`/resource/light/${jRet._lightID}`);
-            jRet._callback(jReturn[0]); // Need to call the callback, because the event is absolutely async
-          } catch (error) {
-            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.info(`KNXUltimatehueEngine: classHUE: handleQueue: getLight light: ${error.message}`);
-          }
-          break;
-        case 'getGroupedLight':
-          try {
-            const jReturn = await this.hueApiV2.get(`/resource/grouped_light/${jRet._lightID}`);
-            // Need to call the callback, because the event is absolutely async
-            jRet._callback(jReturn[0]);
-          } catch (error) {
-            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.info(`KNXUltimatehueEngine: classHUE: handleQueue: getLight grouped_light: ${error.message}`);
-          }
-          break;
         case 'setScene':
           try {
             const sceneID = jRet._lightID;
@@ -146,14 +130,13 @@ class classHUE extends EventEmitter {
         case 'getBattery':
           try {
             const jReturn = await this.hueApiV2.get(`/resource/device_power/${jRet._lightID}`);
-            jRet._callback(jReturn[0]); // Need to call the callback, because the event is absolutely async
           } catch (error) {
             if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error(`KNXUltimatehueEngine: classHUE: handleQueue: getBattery: ${error.message}`);
           }
+          break;
         case 'getLightLevel':
           try {
             const jReturn = await this.hueApiV2.get(`/resource/light_level/${jRet._lightID}`);
-            jRet._callback(jReturn[0]); // Need to call the callback, because the event is absolutely async
           } catch (error) {
             if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error(`KNXUltimatehueEngine: classHUE: handleQueue: getLightLevel: ${error.message}`);
           }
@@ -161,7 +144,6 @@ class classHUE extends EventEmitter {
         case 'getTemperature':
           try {
             const jReturn = await this.hueApiV2.get(`/resource/temperature/${jRet._lightID}`);
-            jRet._callback(jReturn[0]); // Need to call the callback, because the event is absolutely async
           } catch (error) {
             if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error(`KNXUltimatehueEngine: classHUE: handleQueue: getTemperature: ${error.message}`);
           }
@@ -174,11 +156,9 @@ class classHUE extends EventEmitter {
     this.timerwriteQueueAdd = setTimeout(this.handleQueue, 200);
   };
 
-  writeHueQueueAdd = async (_lightID, _state, _operation, _callback) => {
+  writeHueQueueAdd = async (_lightID, _state, _operation) => {
     // Add the new item
-    this.commandQueue.push({
-      _lightID, _state, _operation, _callback,
-    });
+    this.commandQueue.push({ _lightID, _state, _operation });
   };
   // ######################################
 

package/package.json

@@ -3,12 +3,12 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "2.1.63",
-  "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.",
+  "version": "2.2.2",
+  "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 control.",
   "dependencies": {
     "binary-parser": "2.2.1",
     "color-convert": "2.0.1",
-    "crypto-js": "4.1.1",
+    "crypto-js": "4.2.0",
     "dns-sync": "0.2.1",
     "eventsource": "2.0.2",
     "lodash": "4.17.21",
@@ -52,8 +52,6 @@
     "KNX",
     "ETS",
     "eib",
-    "eibd",
-    "knxd",
     "konnex",
     "IOT",
     "hue"
@@ -69,5 +67,28 @@
   },
   "scripts": {
     "test": "standard"
+  },
+  "Prettier": {
+    "arrowParens": "always",
+    "bracketSameLine": true,
+    "bracketSpacing": false,
+    "semi": true,
+    "singleQuote": true,
+    "jsxSingleQuote": false,
+    "quoteProps": "as-needed",
+    "trailingComma": "all",
+    "singleAttributePerLine": false,
+    "htmlWhitespaceSensitivity": "css",
+    "vueIndentScriptAndStyle": false,
+    "proseWrap": "preserve",
+    "insertPragma": false,
+    "printWidth": 80,
+    "requirePragma": false,
+    "tabWidth": 2,
+    "useTabs": true,
+    "embeddedLanguageFormatting": "auto",
+    "[html]": {
+      "editor.defaultFormatter": "vscode.html-language-features"
+    }
   }
 }