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

package/CHANGELOG.md

@@ -5,9 +5,13 @@
 <br/>
 
 # CHANGELOG
-
 <p>
-<b>Version 2.1.55</b> - October 2023<br/>
+<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/>
+</p>
+<p>
+<b>Version 2.1.56</b> - October 2023<br/>
 - HUE Scene: removed non existant scene 0.<br/>
 </p>
 <p>

package/KNXEngine/CHANGELOG.md

@@ -6,6 +6,10 @@
 
 # CHANGELOG
 
+<p>
+<b>Version 1.0.43</b> - October 2023<br/>
+- Added help description for DPT 3.001 DIMMING stop telegram.<br/>
+</p>
 <p>
 <b>Version 1.0.42</b> - July 2023<br/>
 - Quick fix for MDT and Wienzler interfaces.<br/>

package/KNXEngine/package.json

@@ -1,7 +1,7 @@
 {
   "name": "knxultimate",
   "description": "KNX IP protocol implementation for Node. This is the ENGINE of Node-Red KNX-Ultimate node.",
-  "version": "1.0.42",
+  "version": "1.0.43",
   "engines": {
     "node": ">=14"
   },

package/KNXEngine/src/dptlib/dpt3.js

@@ -44,6 +44,7 @@ exports.basetype = {
 // The parameter "data" can be any integer value from 0 to 7
 // The parameter decr_incr:1 increases the light
 // The parameter decr_incr:0 decreases the light
+// The parameter data:0 stops the dimming
 msg.payload={decr_incr: 1, data: 5};
 return msg;`,
   helplink: 'https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/-Sample---Dimming'

package/nodes/hue-config.js

@@ -118,8 +118,6 @@ module.exports = (RED) => {
     // 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 "";

package/nodes/knxUltimateHueLight.html

@@ -56,7 +56,7 @@
             GALightColorCycle: { value: "" },
             dptLightColorCycle: { value: "" },
 
-            enableDayNightLighting: { value: false },
+            enableDayNightLighting: { value: "no" },
             colorAtSwitchOnDayTime: { value: '{"red":255, "green":255, "blue":255}' },
             colorAtSwitchOnNightTime: { value: '{"red":23, "green":4, "blue":0}' },
             invertDayNight: { value: false },
@@ -65,7 +65,8 @@
             GADaylightSensor: { value: "" },
             dptDaylightSensor: { value: "" },
 
-            linkBrightnessToSwitchStatus: { value: "yes" },
+            specifySwitchOnBrightness: { value: "yes" },
+            updateKNXBrightnessStatusOnHUEOnOff: { value: "onhueoff" },
 
             hueDevice: { value: "" }
         },
@@ -212,13 +213,13 @@
 
 
             // Show/Hide and enable/disable day/night Lighting behaviour
-            if (this.enableDayNightLighting === true) {
+            if (this.enableDayNightLighting === "yes") {
                 $("#DivEnableDayNightLighting").show()
             } else {
                 $("#DivEnableDayNightLighting").hide()
             }
             $("#node-input-enableDayNightLighting").on('change', function () {
-                if ($("#node-input-enableDayNightLighting").is(":checked")) {
+                if ($("#node-input-enableDayNightLighting").val() === 'yes') {
                     $("#DivEnableDayNightLighting").show()
                 } else {
                     $("#DivEnableDayNightLighting").hide()
@@ -226,16 +227,16 @@
             })
 
             // Show/Hide the div of the color at swich on
-            if (this.linkBrightnessToSwitchStatus === 'yes') {
+            if (this.specifySwitchOnBrightness === 'yes') {
                 $("#divcolorAtSwitchOnNightTime").show()
             } else {
                 $("#divcolorAtSwitchOnNightTime").hide()
                 $("#node-input-colorAtSwitchOnDayTime").val('')
             }
-            $("#node-input-linkBrightnessToSwitchStatus").on('change', function () {
-                if ($("#node-input-linkBrightnessToSwitchStatus").val() === 'yes') {
+            $("#node-input-specifySwitchOnBrightness").on('change', function () {
+                if ($("#node-input-specifySwitchOnBrightness").val() === 'yes') {
                     $("#divcolorAtSwitchOnNightTime").show()
-                    if ($("#node-input-colorAtSwitchOnDayTime").val() === '') $("#node-input-colorAtSwitchOnDayTime").val('{ "red": 255, "green": 255, "blue": 255 }') 
+                    if ($("#node-input-colorAtSwitchOnDayTime").val() === '') $("#node-input-colorAtSwitchOnDayTime").val('{ "red": 255, "green": 255, "blue": 255 }')
                 } else {
                     $("#divcolorAtSwitchOnNightTime").hide()
                     $("#node-input-colorAtSwitchOnDayTime").val('')
@@ -534,10 +535,19 @@
     <div id="tabs-6">
         <p> 
             <div class="form-row">
-                <label for="node-input-linkBrightnessToSwitchStatus" style="width:260px;">
+                <label for="node-input-updateKNXBrightnessStatusOnHUEOnOff" style="width:260px;">
+                    <i class="fa fa-tag"></i> KNX Brightness Status
+                </label>
+                <select id="node-input-updateKNXBrightnessStatusOnHUEOnOff">
+                    <option value="onhueoff">When HUE light is Off, send 0% (Default KNX behaviour)</option>
+                    <option value="no">Leave as is (default HUE behaviour)</option>
+                </select>
+            </div>
+            <div class="form-row">
+                <label for="node-input-specifySwitchOnBrightness" style="width:260px;">
                     <i class="fa fa-tag"></i> Specify switch on brightness
                 </label>
-                <select id="node-input-linkBrightnessToSwitchStatus">
+                <select id="node-input-specifySwitchOnBrightness">
                     <option value="yes">Yes</option>
                     <option value="no">No</option>
                 </select>
@@ -551,16 +561,18 @@
                         placeholder='Leave blank or, for example, {"red":255, "green":255, "blue":255}' style="width:260px">
                 </div>
                 <div class="form-row">
-                    <label style="width:170px" for="node-input-enableDayNightLighting">
+                    <label for="node-input-enableDayNightLighting" style="width:260px;">
                         <i class="fa fa-clone"></i> Night Lighting
                     </label>
-                    <input type="checkbox" id="node-input-enableDayNightLighting"
-                        style="display:inline-block; width:auto; vertical-align:top;" />
+                    <select id="node-input-enableDayNightLighting">
+                        <option value="yes">Yes</option>
+                        <option value="no">No</option>
+                    </select>
                 </div>
                 <div id="DivEnableDayNightLighting">
                     <div class="form-row">
                         <label for="node-input-colorAtSwitchOnNightTime" style="width:260px">
-                            <i class="fa fa-moon-o"></i> Switch On - color/brightness at Night
+                            <i class="fa fa-moon-o"></i> Switch On color/brigh. at Night
                         </label>
                         <input type="text" id="node-input-colorAtSwitchOnNightTime"
                             placeholder='Example {"red":100, "green":0, "blue":50}' style="width:260px">
@@ -593,7 +605,8 @@
                 </div>
             </div>          
         </p>
-    </div>    
+    </div>  
+  
 <br/>
 </script>
 
@@ -657,9 +670,10 @@ Start typing in the GA field, the name or group address of your KNX device, the
 <br/>
 
 **Behaviour**
-
+  
 |Property|Description|
 |--|--|
+| KNX Brightness Status | Updates the KNX brightness group address whenever the HUE lamp is switched ON/OFF. The options are `When HUE light is Off, send 0% (Default KNX behaviour)` and `Leave as is (default HUE behaviour)` |
 | Specify switch on brightness | It enables the brightness value to follow the on/off status of the light. If you change the HUE brightness value to 0% (from the HUE App), an "off" telegram is also sent to the KNX bus; if you set it other than 0%, an "on" telegram is also sent to the KNX bus. This is valid also vice-versa: if you change the brightness via KNX bus, the HUE on/off value is also sent to the lamp. If you set it to **No**, the previous HUE light brightness value is retained. Default value is **Yes**. |
 | Switch On - color/brightness | You can choose the color/brightness of your light, at switch on. Set it as JSON object, for example **{ "red": 255, "green": 255, "blue": 255 }** |
 | Night Lighting | It allows to set a particular light color/brightness at nighttime. If **checked**, a further set of option shows up and the light changes the behaviour based on these options, everytime you switch the light *on*. |

package/nodes/knxUltimateHueLight.js

@@ -44,82 +44,64 @@ module.exports = function (RED) {
       node.status({ fill, shape, text: `${text} ${payload} (${dDate.getDate()}, ${dDate.toLocaleTimeString()})` });
     };
 
+    node.setNodeStatusHue({
+      fill: "grey",
+      shape: "ring",
+      text: "Connecting to the Bridge...",
+      payload: ""
+    });
+
     // This function is called by the hue-config.js
     node.handleSend = (msg) => {
+      if (node.currentHUEDevice === undefined) {
+        node.setNodeStatusHue({
+          fill: "red",
+          shape: "ring",
+          text: "Rejected KNX message. I'm connecting to the Bridge...",
+          payload: ""
+        });
+        return;
+      }
       let state = {};
       try {
         switch (msg.knx.destination) {
           case config.GALightSwitch:
             msg.payload = dptlib.fromBuffer(msg.knx.rawValue, dptlib.resolve(config.dptLightSwitch));
             if (msg.payload === true) {
-              if (node.DayTime) {
-                // Day Time
-                if (config.colorAtSwitchOnDayTime !== undefined && config.colorAtSwitchOnDayTime.toString().trim() !== "") {
-                  // The user selected specific color/brightness at switch on.
-                  let jColorChoosen = { red: 255, green: 255, blue: 255 };
-                  jColorChoosen = JSON.parse(config.colorAtSwitchOnDayTime || '{ "red": 255, "green": 255, "blue": 255 }');
-                  let gamut = null;
-                  if (
-                    node.currentHUEDevice !== undefined
-                    && node.currentHUEDevice.hasOwnProperty("color")
-                    && node.currentHUEDevice.color.hasOwnProperty("gamut_type")
-                  ) {
-                    gamut = node.currentHUEDevice.color.gamut_type;
-                  }
-                  const dretXY = hueColorConverter.ColorConverter.rgbToXy(jColorChoosen.red, jColorChoosen.green, jColorChoosen.blue, gamut);
-                  const dbright = hueColorConverter.ColorConverter.getBrightnessFromRGB(jColorChoosen.red, jColorChoosen.green, jColorChoosen.blue);
-                  node.currentHUEDevice.dimming.brightness = dbright;
-                  node.updateKNXBrightnessState(node.currentHUEDevice.dimming.brightness);
-                  if (config.linkBrightnessToSwitchStatus === undefined || config.linkBrightnessToSwitchStatus === "yes") {
-                    state = dbright > 0 ? { on: { on: true }, dimming: { brightness: dbright }, color: { xy: dretXY } } : { on: { on: false } };
-                  } else {
-                    state = dbright > 0 ? { on: { on: true }, color: { xy: dretXY } } : { on: { on: false } };
-                  }
-                } else if (config.linkBrightnessToSwitchStatus === undefined || config.linkBrightnessToSwitchStatus === "yes") {
-                  try {
-                    node.currentHUEDevice.dimming.brightness = 100;
-                    node.updateKNXBrightnessState(node.currentHUEDevice.dimming.brightness);
-                  } catch (error) { /* empty */ }
-                  state = { on: { on: true }, dimming: { brightness: node.currentHUEDevice.dimming.brightness } };
-                } else {
-                  try {
-                    state = { on: { on: true }, dimming: { brightness: node.currentHUEDevice.dimming.brightness } };
-                  } catch (error) {
-                    state = { on: { on: true } };
-                  }
+              // The user selected specific color/brightness at switch on.
+              let jColorChoosen = null;
+              if (node.DayTime === true && (config.specifySwitchOnBrightness === undefined || config.specifySwitchOnBrightness === "yes")) {
+                try {
+                  jColorChoosen = JSON.parse(config.colorAtSwitchOnDayTime);
+                } catch (error) {
+                  jColorChoosen = { red: 255, green: 255, blue: 255 };
                 }
-              } else {
-                // Night Time
-                if (config.enableDayNightLighting === true) {
-                  let jColorChoosen = { red: 23, green: 4, blue: 0 };
-                  jColorChoosen = JSON.parse(config.colorAtSwitchOnNightTime || '{ "red": 23, "green": 4, "blue": 0 }');
-                  let gamut = null;
-                  if (
-                    node.currentHUEDevice !== undefined
-                    && node.currentHUEDevice.hasOwnProperty("color")
-                    && node.currentHUEDevice.color.hasOwnProperty("gamut_type")
-                  ) {
-                    gamut = node.currentHUEDevice.color.gamut_type;
-                  }
-                  const dretXY = hueColorConverter.ColorConverter.rgbToXy(jColorChoosen.red, jColorChoosen.green, jColorChoosen.blue, gamut);
-                  const dbright = hueColorConverter.ColorConverter.getBrightnessFromRGB(jColorChoosen.red, jColorChoosen.green, jColorChoosen.blue);
-                  if (config.linkBrightnessToSwitchStatus === undefined || config.linkBrightnessToSwitchStatus === "yes") {
-                    node.currentHUEDevice.dimming.brightness = dbright;
-                    node.updateKNXBrightnessState(node.currentHUEDevice.dimming.brightness);
-                    state = dbright > 0 ? { on: { on: true }, dimming: { brightness: dbright }, color: { xy: dretXY } } : { on: { on: false } };
-                  } else {
-                    state = dbright > 0 ? { on: { on: true }, color: { xy: dretXY } } : { on: { on: false } };
-                  }
+              } else if (node.DayTime === false && config.enableDayNightLighting === "yes") {
+                try {
+                  jColorChoosen = JSON.parse(config.colorAtSwitchOnNightTime);
+                } catch (error) {
+                  jColorChoosen = { red: 10, green: 10, blue: 10 };
                 }
               }
-            } else if (config.linkBrightnessToSwitchStatus === undefined || config.linkBrightnessToSwitchStatus === "yes") {
-              try {
-                node.currentHUEDevice.dimming.brightness = 0;
+              if (jColorChoosen !== null) {
+                let gamut = null;
+                if (
+                  node.currentHUEDevice !== undefined
+                  && node.currentHUEDevice.hasOwnProperty("color")
+                  && node.currentHUEDevice.color.hasOwnProperty("gamut_type")
+                ) {
+                  gamut = node.currentHUEDevice.color.gamut_type;
+                }
+                const dretXY = hueColorConverter.ColorConverter.rgbToXy(jColorChoosen.red, jColorChoosen.green, jColorChoosen.blue, gamut);
+                const dbright = hueColorConverter.ColorConverter.getBrightnessFromRGB(jColorChoosen.red, jColorChoosen.green, jColorChoosen.blue);
+                node.currentHUEDevice.dimming.brightness = dbright;
                 node.updateKNXBrightnessState(node.currentHUEDevice.dimming.brightness);
-                state = { on: { on: false }, dimming: { brightness: node.currentHUEDevice.dimming.brightness }, dynamics: { duration: 2000 } };
-              } catch (error) { /* empty */ }
+                state = dbright > 0 ? { on: { on: true }, dimming: { brightness: dbright }, color: { xy: dretXY } } : { on: { on: false } };
+              } else {
+                state = { on: { on: true }, dimming: node.currentHUEDevice.dimming };
+              }
             } else {
-              state = { on: { on: false }, dynamics: { duration: 2000 } };
+              state = { on: { on: false } };
             }
             node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state, node.isGrouped_light === false ? "setLight" : "setGroupedLight");
             node.setNodeStatusHue({
@@ -136,23 +118,20 @@ module.exports = function (RED) {
             if (msg.payload.data > 0) {
               const dimDirection = msg.payload.decr_incr === 1 ? "up" : "down";
               // First, switch on the light if off
-              if (node.currentHUEDevice !== undefined && node.currentHUEDevice.on.on === false && dimDirection === "up") {
-                if (config.linkBrightnessToSwitchStatus === undefined || config.linkBrightnessToSwitchStatus === "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"
-                  );
-                }
+              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);
             } else {
@@ -166,7 +145,7 @@ module.exports = function (RED) {
             });
             break;
           case config.GADaylightSensor:
-            if (config.enableDayNightLighting === true) {
+            if (config.enableDayNightLighting === "yes") {
               node.DayTime = Boolean(dptlib.fromBuffer(msg.knx.rawValue, dptlib.resolve(config.dptDaylightSensor)));
               if (config.invertDayNight !== undefined && config.invertDayNight === true) node.DayTime = !node.DayTime;
               node.setNodeStatusHue({
@@ -281,7 +260,7 @@ module.exports = function (RED) {
                 // state = msg.payload === true ? { on: { on: true } } : { on: { on: false } }
                 state = msg.payload === true
                   ? { on: { on: true }, dimming: { brightness: 100 }, dynamics: { duration: 0 } }
-                  : { on: { on: false }, dynamics: { duration: 0 } };
+                  : { on: { on: false }, dimming: { brightness: 0 }, dynamics: { duration: 0 } };
                 node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state, node.isGrouped_light === false ? "setLight" : "setGroupedLight");
               }, 1000);
             } else {
@@ -429,19 +408,26 @@ module.exports = function (RED) {
     node.handleSendHUE = (_event) => {
       try {
         if (_event.id === config.hueDevice) {
+          if (node.currentHUEDevice === undefined) {
+            node.setNodeStatusHue({
+              fill: "red",
+              shape: "ring",
+              text: "Rejected HUE message. I'm connecting to the Bridge...",
+              payload: ""
+            });
+            return;
+          }
           if (_event.hasOwnProperty("on")) {
             node.updateKNXLightState(_event.on.on);
-            if (config.linkBrightnessToSwitchStatus === undefined || config.linkBrightnessToSwitchStatus === "yes") {
-              // In case of switch off, set the dim to zero
-              if (_event.on.on === false) {
-                node.updateKNXBrightnessState(0);
-              } else {
-                // Restore the previous brightness value
-                try {
-                  node.updateKNXBrightnessState(node.currentHUEDevice.dimming.brightness);
-                } catch (error) {
-                  /* empty */
-                }
+            // In case of switch off, set the dim to zero
+            if (_event.on.on === false && (config.updateKNXBrightnessStatusOnHUEOnOff === undefined || config.updateKNXBrightnessStatusOnHUEOnOff === 'onhueoff')) {
+              node.updateKNXBrightnessState(0);
+            } else {
+              // Sends the previous brightness value
+              try {
+                node.updateKNXBrightnessState(node.currentHUEDevice.dimming.brightness);
+              } catch (error) {
+                /* empty */
               }
             }
             if (node.currentHUEDevice !== undefined) node.currentHUEDevice.on = _event.on; // Update the internal object representing the current light
@@ -453,15 +439,15 @@ module.exports = function (RED) {
             return;
           }
           if (_event.hasOwnProperty("dimming")) {
-            // Every once time, the light transmit the brightness value of 0.39.
+            // Every once on a time, the light transmit the brightness value of 0.39.
             // To avoid wrongly turn light state on, exit
-            if (_event.dimming.brightness === undefined) return;
             if (_event.dimming.brightness < 1) _event.dimming.brightness = 0;
+            if (node.currentHUEDevice.hasOwnProperty('on') && node.currentHUEDevice.on.on === false && _event.dimming.brightness === 0) return;
+            // if (config.specifySwitchOnBrightness === undefined || config.specifySwitchOnBrightness === "yes") {
+            if (node.currentHUEDevice.on.on === false) node.updateKNXLightState(_event.dimming.brightness > 0);
+            // }
             node.updateKNXBrightnessState(_event.dimming.brightness);
             if (node.currentHUEDevice !== undefined) node.currentHUEDevice.dimming = _event.dimming; // Update the internal object representing the current light
-            if (config.linkBrightnessToSwitchStatus === undefined || config.linkBrightnessToSwitchStatus === "yes") {
-              node.updateKNXLightState(_event.dimming.brightness > 0);
-            }
             // If the brightness reaches zero, the hue lamp "on" property must be set to zero as well
             if (_event.dimming.brightness === 0) {
               node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, { on: { on: false } }, node.isGrouped_light === false ? "setLight" : "setGroupedLight");
@@ -478,7 +464,7 @@ module.exports = function (RED) {
         node.status({
           fill: "red",
           shape: "dot",
-          text: `HUE->KNX error ${knxMsgPayload.topic} ${error.message} (${new Date().getDate()}, ${new Date().toLocaleTimeString()})`,
+          text: 'HUE->KNX error ' + node.id + ' ' + error.message
         });
       }
     };

package/nodes/knxUltimateHueScene.html

@@ -185,8 +185,8 @@
    &nbsp<i class="fa fa-youtube"></i></span>&nbsp<a target="_blank" href="https://youtu.be/jjEUI1J8bkA"><u>Youtube sample</u></a>
     <br />
     <br />
-    <p align="center">
-       <i class="fa fa-star-and-crescent fa-bounce fa-8x"></i>
+    <p align="center">       
+        <i class="fa fa-tv fa-fade fa-8x"></i>
     </p>
     <br />
     <label for="node-input-server" >

package/package.json

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