node-red-contrib-knx-ultimate 2.2.5 → 2.2.6

package/CHANGELOG.md

@@ -6,8 +6,13 @@
 
 # CHANGELOG
 
+<b>Version 2.2.6</b> - October 2023<br/>
+- Fix: fixed HUE button sending a KNX telegram at startup. Fixed also other nodes.<br/>
+- HUE Nodes: added the option to inizialize at startup or not.<br/>
+</p>
 <b>Version 2.2.5</b> - October 2023<br/>
 - Fix: fixed some HUE nodes not able to register to the event notification service.<br/>
+- Restyle GUI of KNX Device node.<br/>
 </p>
 <b>Version 2.2.4</b> - October 2023<br/>
 - HUE Light: fixed some status hiccups and better handling of async hue bridge functions.<br/>

package/nodes/hue-config.js

@@ -58,7 +58,7 @@ module.exports = (RED) => {
     node.nodeClientsAwaitingInit = []; // Stores the nodes client to be initialized
     node.loglevel = config.loglevel !== undefined ? config.loglevel : "error"; // 18/02/2020 Loglevel default error
     node.sysLogger = null;
-    node.hueAllResources = null;
+    node.hueAllResources = undefined;
     try {
       node.sysLogger = loggerEngine.get({ loglevel: node.loglevel }); // New logger to adhere to the loglevel selected in the config-window
     } catch (error) {
@@ -129,6 +129,7 @@ module.exports = (RED) => {
                   text: "Ready :-)",
                 });
                 nodeClient.currentHUEDevice = oHUEDevice;
+                oHUEDevice.initializingAtStart = true; // Signalling first connection after restart.
                 nodeClient.handleSendHUE(oHUEDevice);
               }
             }
@@ -277,7 +278,8 @@ module.exports = (RED) => {
         if (node.nodeClients.filter((x) => x.id === _Node.id).length === 0) { // 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);
+          oHUEDevice.initializingAtStart = true; // Signalling first connection after restart.
+          _Node.handleSendHUE(oHUEDevice);
           node.nodeClients.push(_Node);
           // Add _Node to the clients array
           _Node.setNodeStatusHue({

package/nodes/knxUltimateHueBattery.html

@@ -11,6 +11,8 @@
             namebatterysensor: { value: "" },
             GAbatterysensor: { value: "" },
             dptbatterysensor: { value: "" },
+            readStatusAtStartup: { value: "no" },
+
 
             hueDevice: { value: "" }
         },
@@ -212,8 +214,13 @@
         <input type="text" id="node-input-namebatterysensor" style="width:200px;margin-left: 5px; text-align: left;">
     </div>
    
-       
-
+    <div class="form-row">
+        <label style="width:180px" for="node-input-readStatusAtStartup"><i class="fa fa-play-circle"></i> Read status at startup</label>
+        <select id="node-input-readStatusAtStartup">       
+        <option value="no">No</option>
+        <option value="yes">Yes, and emit KNX telegrams.</option>
+</select>
+    </div>
 <br/>
 <br/>
 <br/>
@@ -222,11 +229,12 @@
 </script>
 <script src="https://kit.fontawesome.com/11f26b4500.js" crossorigin="anonymous"></script>
 
-<script type="text/markdown" data-help-name="knxUltimateHueBattery"
-This node lets you get the battery level from your HUE device.  
-
-Here you can get the HUE battery level events, that represents a percentage 0-100% value, evetytime the battery level 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.
+<script type="text/markdown" data-help-name="knxUltimateHueBattery">
+This node lets you get the battery level from your HUE device. Here you can get the HUE battery level events, that represents a percentage 0-100% value, evetytime the
+battery level changes.  
+    
+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.
 
 **General**
 |Property|Description|
@@ -234,16 +242,17 @@ Start typing in the GA field, the name or group address of your KNX device, the
 | KNX GW | Select the KNX gateway to be used |
 | HUE Bridge | Select the HUE Bridge to be used |
 | Hue Sensor | HUE sensor to be used. The avaiable devices start showing up while you're typing.|
+| Read status at startup | Read the status at startup and emit the event to the KNX bus at startup/reconnection. (Default "no")|
 
 |Property|Description|
 |--|--|
 | Level | The battery level group address. The group address must be a percentage 0-100% (5.001) |
 
 
-<br/>
+<br />
 
 [Find it useful?](https://www.paypal.me/techtoday)
 
-<br/>
+<br />
 
-    </script>
+</script>

package/nodes/knxUltimateHueBattery.js

@@ -47,30 +47,34 @@ module.exports = function (RED) {
     node.handleSendHUE = (_event) => {
       try {
         if (_event.id === config.hueDevice) {
+
+          // IMPORTANT: exit if no event presen.
+          if (_event.initializingAtStart === true && (config.readStatusAtStartup === undefined || config.readStatusAtStartup === "no")) return;
+          if (!_event.hasOwnProperty("power_state") || _event.power_state.battery_level === undefined) return;
+
           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;
-            // 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,
-              });
-            }
-
-            // Setup the output msg
-            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.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,
             });
           }
+
+          // Setup the output msg
+          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,
+          });
+
         }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: `HUE->KNX error ${error.message} (${new Date().getDate()}, ${new Date().toLocaleTimeString()})` });

package/nodes/knxUltimateHueButton.html

@@ -19,6 +19,7 @@
             nameshort_releaseStatus: { value: "" },
             GAshort_releaseStatus: { value: "" },
             dptshort_releaseStatus: { value: "1.001" },
+            readStatusAtStartup: { value: "no" },
 
             toggleValues: { value: true },
             hueDevice: { value: "" }
@@ -396,7 +397,13 @@
             Toggle values
         </label>
     </div>
-       
+    <div class="form-row">
+        <label style="width:180px" for="node-input-readStatusAtStartup"><i class="fa fa-play-circle"></i> Read status at startup</label>
+        <select id="node-input-readStatusAtStartup">       
+        <option value="no">No</option>
+        <option value="yes">Yes, and emit KNX telegrams.</option>
+</select>
+    </div>
         
 
 <br/>
@@ -432,6 +439,7 @@ This allows the internal logic to be aware of external devices, like wall switch
 | Switch Status | To allow internal logic to take care of the external KNX devices, for example an external wall switch, you should set this group address |
 | Dim | This event is used either to send DIM (increase/decrease) or true/false commands to the KNX group address |
 | Toggle values | Enable or disable toggling values. If enabled, all values toggles, otherwise, all values are sent as *true* or *increase dim*, to the selected KNX group address |
+| Read status at startup | Read the status at startup and emit the event to the KNX bus at startup/reconnection. (Default "no") |
 
 ### Outputs
 

package/nodes/knxUltimateHueButton.js

@@ -76,6 +76,11 @@ module.exports = function (RED) {
     node.handleSendHUE = (_event) => {
       try {
         if (_event.id === config.hueDevice) {
+
+          // IMPORTANT: exit if no button last_event present.
+          if (_event.initializingAtStart === true && (config.readStatusAtStartup === undefined || config.readStatusAtStartup === "no")) return;
+          if (!_event.hasOwnProperty("button") || _event.button.last_event === undefined) return;
+
           const knxMsgPayload = {};
           let flowMsgPayload = true;
           // Handling events with toggles

package/nodes/knxUltimateHueLight.html

@@ -90,6 +90,7 @@
       dimSpeed: { value: 5000, required: false },
       minDimLevelLight: { value: 10, required: false },
       maxDimLevelLight: { value: 100, required: false },
+      readStatusAtStartup: { value: "yes" },
 
       hueDevice: { value: "" },
     },
@@ -765,7 +766,14 @@
       <div id="tabs-6">
         <p>
           <div class="form-row">
-              <label for="node-input-updateKNXBrightnessStatusOnHUEOnOff" style="width:260px;">
+            <label style="width:260px;" for="node-input-readStatusAtStartup"><i class="fa fa-play-circle"></i> Read status at startup</label>
+            <select id="node-input-readStatusAtStartup">       
+            <option value="no">No</option>
+            <option value="yes">Yes, and emit KNX telegrams.</option>
+            </select>
+        </div>
+          <div class="form-row">
+              <label style="width:260px;" for="node-input-updateKNXBrightnessStatusOnHUEOnOff">
                   <i class="fa fa-tag"></i> KNX Brightness Status
               </label>
               <select id="node-input-updateKNXBrightnessStatusOnHUEOnOff">
@@ -935,6 +943,7 @@
   | Dim Speed (ms)                            | The dimming speed, in Milliseconds. This applies to the **light** and also to the **tunable white** dimming datapoints. It' calculated from 0% to 100%.                                                                                                                                                                                                                                                                                                                                              |
   | Min Dim brightness                        | Tha Minimum brightness that the lamp can reach. For example, if you are dimming the light down, the light will stop dimming at the specified brightness %.                                                                                                                                                                                                                                                                                                                                           |
   | Max Dim brightness                        | Tha Maximum brightness that the lamp can reach. For example, if you are dimming the light up, the light will stop dimming at the specified brightness %.                                                                                                                                                                                                                                                                                                                                             |
+  | Read status at startup | Read the status at startup and emit the event to the KNX bus at startup/reconnection. (Default "no")|
 
   ### Note
 

package/nodes/knxUltimateHueLight.js

@@ -35,6 +35,8 @@ module.exports = function (RED) {
     node.DayTime = true;
     node.isGrouped_light = config.hueDevice.split("#")[1] === "grouped_light";
     node.hueDevice = config.hueDevice.split("#")[0];
+    node.readStatusAtStartup = config.readStatusAtStartup;
+    if (config.readStatusAtStartup === undefined) node.readStatusAtStartup = "yes";
 
     // Used to call the status update from the config node.
     node.setNodeStatus = ({
@@ -419,6 +421,9 @@ module.exports = function (RED) {
             });
             return;
           }
+          // IMPORTANT: exit if no button last_event present.
+          if (_event.initializingAtStart === true && node.readStatusAtStartup === "no") return;
+
           if (_event.hasOwnProperty("on")) {
             node.updateKNXLightState(_event.on.on);
             // In case of switch off, set the dim to zero

package/nodes/knxUltimateHueLightSensor.html

@@ -11,6 +11,7 @@
             namelightsensor: { value: "" },
             GAlightsensor: { value: "" },
             dptlightsensor: { value: "" },
+            readStatusAtStartup: { value: "no" },
 
             hueDevice: { value: "" }
         },
@@ -211,7 +212,13 @@
         <input type="text" id="node-input-namelightsensor" style="width:200px;margin-left: 5px; text-align: left;">
     </div>
    
-
+    <div class="form-row">
+        <label style="width:180px" for="node-input-readStatusAtStartup"><i class="fa fa-play-circle"></i> Read status at startup</label>
+        <select id="node-input-readStatusAtStartup">       
+        <option value="no">No</option>
+        <option value="yes">Yes, and emit KNX telegrams.</option>
+</select>
+    </div>
         
 
 <br/>
@@ -234,6 +241,7 @@ Start typing in the GA field, the name or group address of your KNX device, the
 | KNX GW | Select the KNX gateway to be used |
 | HUE Bridge | Select the HUE Bridge to be used |
 | Hue Sensor | HUE sensor to be used. The avaiable buttons start showing up while you're typing.|
+| Read status at startup | Read the status at startup and emit the event to the KNX bus at startup/reconnection. (Default "no")|
 
 |Property|Description|
 |--|--|

package/nodes/knxUltimateHueLightSensor.js

@@ -43,6 +43,11 @@ module.exports = function (RED) {
     node.handleSendHUE = _event => {
       try {
         if (_event.id === config.hueDevice) {
+
+          // IMPORTANT: exit if no event presen.
+          if (_event.initializingAtStart === true && (config.readStatusAtStartup === undefined || config.readStatusAtStartup === "no")) return;
+          if (!_event.hasOwnProperty('light') || _event.light.light_level === undefined) return;
+
           const knxMsgPayload = {};
           knxMsgPayload.topic = config.GAlightsensor;
           knxMsgPayload.dpt = config.dptlightsensor;

package/nodes/knxUltimateHueMotion.html

@@ -11,6 +11,7 @@
             namemotion: { value: "" },
             GAmotion: { value: "" },
             dptmotion: { value: "" },
+            readStatusAtStartup: { value: "no" },
 
             hueDevice: { value: "" }
         },
@@ -211,6 +212,14 @@
         <input type="text" id="node-input-namemotion" style="width:200px;margin-left: 5px; text-align: left;">
     </div>
    
+    <div class="form-row">
+        <label style="width:180px" for="node-input-readStatusAtStartup"><i class="fa fa-play-circle"></i> Read status at startup</label>
+        <select id="node-input-readStatusAtStartup">       
+        <option value="no">No</option>
+        <option value="yes">Yes, and emit KNX telegrams.</option>
+</select>
+    </div>
+
 <br/>
 <br/>
 <br/>
@@ -235,7 +244,8 @@ Start typing in the GA field, the name or group address of your KNX device, the
 |Property|Description|
 |--|--|
 | Motion | As soon as someone moves in the motion device's range, a *true* KNX value is sent to this group address, otherwise *false* is sent. |
-
+| Read status at startup | Read the status at startup and emit the event to the KNX bus at startup/reconnection. (Default "no")|
+    
 ### Outputs
 
 1. Standard output

package/nodes/knxUltimateHueMotion.js

@@ -40,6 +40,12 @@ module.exports = function (RED) {
     node.handleSendHUE = (_event) => {
       try {
         if (_event.id === config.hueDevice) {
+
+          // IMPORTANT: exit if no event presen.
+          if (_event.initializingAtStart === true && (config.readStatusAtStartup === undefined || config.readStatusAtStartup === "no")) return;
+          if (!_event.hasOwnProperty("motion") || _event.motion.motion === undefined) return;
+
+
           const knxMsgPayload = {};
           knxMsgPayload.topic = config.GAmotion;
           knxMsgPayload.dpt = config.dptmotion;

package/nodes/knxUltimateHueScene.html

@@ -12,6 +12,7 @@
             GAscene: { value: "" },
             dptscene: { value: "" },
             valscene: { value: 0 }, // the scene number or true/false
+            readStatusAtStartup: { value: "no" },
 
             hueDevice: { value: "" },
             hueSceneRecallType: { value: "active" }
@@ -251,6 +252,14 @@
     <select id="node-input-valscene" style="width:180px;margin-left: 5px; text-align: left;"></select>
 </div>
 
+<div class="form-row">
+    <label style="width:180px" for="node-input-readStatusAtStartup"><i class="fa fa-play-circle"></i> Read status at startup</label>
+    <select id="node-input-readStatusAtStartup">       
+    <option value="no">No</option>
+    <option value="yes">Yes, and emit KNX telegrams.</option>
+</select>
+</div>
+
 <br/>
 <br/>
 <br/>
@@ -276,6 +285,7 @@ Start typing in the GA field, the name or group address of your KNX device, the
 |--|--|
 | Recall | Choose your group address to be used for recalling the HUE scene. In case of Datapoint 1.x, send *true* to that group address to recall the scene, *false* to switch off all lights belonging to the scene. |
 | # | Select the KNX scene number. Visible only with datapoint 18.001. |
+| Read status at startup | Read the status at startup and emit the event to the KNX bus at startup/reconnection. (Default "no")|
 
 <br/>
 

package/nodes/knxUltimateHueScene.js

@@ -78,6 +78,10 @@ module.exports = function (RED) {
     node.handleSendHUE = _event => {
       try {
         if (_event.id === config.hueDevice) {
+
+          // IMPORTANT: exit if no event presen.
+          if (_event.initializingAtStart === true && (config.readStatusAtStartup === undefined || config.readStatusAtStartup === "no")) return;
+
           // const knxMsgPayload = {}
           // knxMsgPayload.topic = config.GAmotion
           // knxMsgPayload.dpt = config.dptmotion

package/nodes/knxUltimateHueTapDial.html

@@ -11,6 +11,7 @@
             namerepeat: { value: "" },
             GArepeat: { value: "" },
             dptrepeat: { value: "" },
+            readStatusAtStartup: { value: "no" },
 
             hueDevice: { value: "" }
         },
@@ -214,7 +215,13 @@
     </div>
     
     
-
+    <div class="form-row">
+        <label style="width:180px" for="node-input-readStatusAtStartup"><i class="fa fa-play-circle"></i> Read status at startup</label>
+        <select id="node-input-readStatusAtStartup">       
+        <option value="no">No</option>
+        <option value="yes">Yes, and emit KNX telegrams.</option>
+</select>
+    </div>
         
 
 <br/>
@@ -245,6 +252,7 @@ or a random color (Datapoint 232.600) to the selected group address.
 |Property|Description|
 |--|--|
 | Rotate | This command is used either to send DIM (increase/decrease), aboslute brightness, or a random color, depending on the selected datapoint. If the random color (datapoint 232.600) is selected, **clockwise rotation** changes random colors and **counterclockwise rotation** set the light to **white** |
+| Read status at startup | Read the status at startup and emit the event to the KNX bus at startup/reconnection. (Default "no")|
 
 ### Outputs
 

package/nodes/knxUltimateHueTapDial.js

@@ -49,6 +49,17 @@ module.exports = function (RED) {
     node.handleSendHUE = (_event) => {
       try {
         if (_event.id === config.hueDevice) {
+
+          // IMPORTANT: exit if no event presen.
+          if (_event.initializingAtStart === true && (config.readStatusAtStartup === undefined || config.readStatusAtStartup === "no")) return;
+          if (!_event.hasOwnProperty("relative_rotary")
+            || !_event.relative_rotary.hasOwnProperty("last_event")
+            || _event.relative_rotary.last_event === undefined
+            || !_event.relative_rotary.last_event.hasOwnProperty("rotation")
+            || !_event.relative_rotary.last_event.rotation.direction === undefined
+            || _event.relative_rotary.last_event.action === undefined) return;
+
+
           const knxMsgPayload = {};
           knxMsgPayload.topic = config.GArepeat;
           knxMsgPayload.dpt = config.dptrepeat;

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "2.2.5",
+  "version": "2.2.6",
   "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",