node-red-contrib-knx-ultimate 2.0.15 → 2.0.16

package/CHANGELOG.md

@@ -6,6 +6,11 @@
 
 # CHANGELOG
 
+<p>
+<b>Version 2.0.16</b> - June 2023<br/>
+- HUE: CAUTION POSSIBLE BREAKING CHANGES TO THE HUE NODES. PLEASE BE AWARE THAT HUE NODES ARE STILL IN BETA<br/>
+- Fixed issues with dimming in the hue button and hue tap dial nodes.<br/>
+</p>
 <p>
 <b>Version 2.0.15</b> - June 2023<br/>
 - HUE: CAUTION POSSIBLE BREAKING CHANGES TO THE HUE NODES. PLEASE BE AWARE THAT HUE NODES ARE STILL IN BETA<br/>

package/nodes/knxUltimateHueButton.html

@@ -8,7 +8,7 @@
             serverHue: { type: "hue-config", required: true },
             name: { value: "" },
 
-            namerepeat: { value: "" },
+            nameDim: { value: "" },
             GArepeat: { value: "" },
             dptrepeat: { value: "3.007" },
 
@@ -73,7 +73,7 @@
                 return i == aSearchWords.length;
             }
 
-            // DPT repeat
+            // DPT Dim
             // ########################
             $.getJSON('knxUltimateDpts', (data) => {
                 data.forEach(dpt => {
@@ -112,7 +112,7 @@
                         sDevName = sDevName.substr(sDevName.indexOf(")") + 1).trim();
                     } catch (error) {
                     }
-                    $('#node-input-namerepeat').val(sDevName);
+                    $('#node-input-nameDim').val(sDevName);
                     var optVal = $("#node-input-dptrepeat option:contains('" + ui.item.label.split("#")[2].trim() + "')").attr('value');
                     // Select the option value 
                     $("#node-input-dptrepeat").val(optVal);
@@ -382,8 +382,8 @@
         <label for="node-input-dptrepeat" style="width:40px; margin-left: 0px; text-align: right;">DPT</label>
         <select id="node-input-dptrepeat" style="width:140px;"></select>
        
-        <label for="node-input-namerepeat" style="width:50px; margin-left: 0px; text-align: right;">Name</label>
-        <input type="text" id="node-input-namerepeat" style="width:200px;margin-left: 5px; text-align: left;">
+        <label for="node-input-nameDim" style="width:50px; margin-left: 0px; text-align: right;">Name</label>
+        <input type="text" id="node-input-nameDim" style="width:200px;margin-left: 5px; text-align: left;">
     </div>
     <br/>
     <br/>
@@ -433,7 +433,7 @@ This allows the internal logic to be aware of external devices, like wall switch
 |--|--|
 | Switch | As soon as you quickly press and release your HUE button, this event fires |
 | 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 |
-| Repeat | This event is used either to send DIM (increase/decrease) or true/false commands to the KNX 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 |
 
 ### Outputs

package/nodes/knxUltimateHueButton.js

@@ -24,8 +24,8 @@ module.exports = function (RED) {
     node.formatmultiplyvalue = 1
     node.formatnegativevalue = 'leave'
     node.formatdecimalsvalue = 2
-    node.toggleGArepeat = false // up or down if repeat field is set to DIM
-    node.toggleGAshort_release = false
+    node.short_releaseValue = false
+    node.isTimerDimStopRunning = false
 
     // Used to call the status update from the config node.
     node.setNodeStatus = ({ fill, shape, text, payload }) => {
@@ -39,7 +39,7 @@ module.exports = function (RED) {
         switch (msg.knx.destination) {
           case config.GAshort_releaseStatus:
             msg.payload = dptlib.fromBuffer(msg.knx.rawValue, dptlib.resolve(config.dptshort_release))
-            node.toggleGAshort_release = msg.payload
+            node.short_releaseValue = msg.payload
             setTimeout(() => {
               node.status({ fill: 'blue', shape: 'dot', text: 'Updated Switch ' + msg.knx.destination + ' ' + JSON.stringify(msg.payload) + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
             }, 500)
@@ -63,61 +63,84 @@ module.exports = function (RED) {
       try {
         if (_event.id === config.hueDevice) {
           const knxMsgPayload = {}
+          let flowMsgPayload = true
           // Handling events with toggles
+          // KNX Dimming reminder tips
+          // { decr_incr: 1, data: 1 } : Start increasing until { decr_incr: 0, data: 0 } is received.
+          // { decr_incr: 0, data: 1 } : Start decreasing until { decr_incr: 0, data: 0 } is received.
           switch (_event.button.last_event) {
             case 'initial_press':
               if (node.initial_pressValue === undefined) node.initial_pressValue = false
-              config.toggleValues ? node.initial_pressValue = !node.initial_pressValue : node.initial_pressValue = true
-              knxMsgPayload.payload = node.initial_pressValue
+              node.initial_pressValue = config.toggleValues ? !node.initial_pressValue : true
+              flowMsgPayload = node.initial_pressValue
               break
             case 'long_release':
-               if (node.long_releaseValue === undefined) node.long_releaseValue = false
-              config.toggleValues ? node.long_releaseValue = !node.long_releaseValue : node.long_releaseValue = true
-              knxMsgPayload.payload = node.long_releaseValue
+              flowMsgPayload = node.long_pressValue
               break
             case 'double_short_release':
               if (node.double_short_releaseValue === undefined) node.double_short_releaseValue = false
-              config.toggleValues ? node.double_short_releaseValue = !node.double_short_releaseValue : node.double_short_releaseValue = true
-              knxMsgPayload.payload = node.double_short_releaseValue
+              node.double_short_releaseValue = config.toggleValues ? !node.double_short_releaseValue : true
+              flowMsgPayload = node.double_short_releaseValue
               break
             case 'long_press':
               if (node.long_pressValue === undefined) node.long_pressValue = false
-              config.toggleValues ? node.long_pressValue = !node.long_pressValue : node.long_pressValue = true
-              knxMsgPayload.payload = node.long_pressValue
+              node.long_pressValue = config.toggleValues ? !node.long_pressValue : true
+              flowMsgPayload = node.long_pressValue
               break
             case 'short_release':
+              node.short_releaseValue = config.toggleValues ? !node.short_releaseValue : true
+              flowMsgPayload = node.short_releaseValue
               knxMsgPayload.topic = config.GAshort_release
               knxMsgPayload.dpt = config.dptshort_release
-              config.toggleValues ? (node.toggleGAshort_release = !node.toggleGAshort_release) : node.toggleGAshort_release = true
-              knxMsgPayload.payload = node.toggleGAshort_release
-              node.status({ fill: 'green', shape: 'dot', text: 'HUE->KNX ' + _event.button.last_event + ' ' + JSON.stringify(knxMsgPayload.payload) + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
+              knxMsgPayload.payload = node.short_releaseValue
               // 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 })
+              if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) node.status({ fill: 'green', shape: 'dot', text: 'HUE->KNX ' + _event.button.last_event + ' ' + JSON.stringify(knxMsgPayload.payload) + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
               break
             case 'repeat':
-              knxMsgPayload.topic = config.GArepeat
-              knxMsgPayload.dpt = config.dptrepeat
-              if (!config.toggleValues) node.toggleGArepeat = true
-              knxMsgPayload.payload = node.toggleGArepeat ? { decr_incr: 1, data: 3 } : { decr_incr: 0, data: 3 }
-              node.status({ fill: 'green', shape: 'dot', text: 'HUE->KNX ' + _event.button.last_event + ' ' + JSON.stringify(knxMsgPayload.payload) + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
-              // 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 })
+              flowMsgPayload = true
+              if (node.isTimerDimStopRunning === false) {
+                // Set KNX Dim up/down start
+                knxMsgPayload.topic = config.GArepeat
+                knxMsgPayload.dpt = config.dptrepeat
+                knxMsgPayload.payload = node.long_pressValue ? { decr_incr: 1, data: 3 } : { decr_incr: 0, data: 3 }
+                // 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 })
+                if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) node.status({ fill: 'green', shape: 'dot', text: 'HUE->KNX start Dim' + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
+              }
+              node.startDimStopper(knxMsgPayload)
               break
             default:
               break
           }
 
           // Setup the output msg
-          knxMsgPayload.name = node.name
-          knxMsgPayload.event = _event.button.last_event
-          knxMsgPayload.rawEvent = _event
-          node.send(knxMsgPayload)
+          const flowMsg = {}
+          flowMsg.name = node.name
+          flowMsg.event = _event.button.last_event
+          flowMsg.rawEvent = _event
+          flowMsg.payload = flowMsgPayload
+          node.send(flowMsg)
         }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: 'HUE->KNX error ' + error.message + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
       }
     }
 
+    // Timer to stop the dimming sequence
+    node.startDimStopper = function (knxMsgPayload) {
+      if (node.timerDimStop !== undefined) clearInterval(node.timerDimStop)
+      node.isTimerDimStopRunning = true
+      node.timerDimStop = setTimeout(() => {
+        // KNX Stop DIM
+        knxMsgPayload.payload = { decr_incr: 0, data: 0 } // Payload for the output msg
+        // 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 })
+        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
+      }, 700);
+    }
+
     // On each deploy, unsubscribe+resubscribe
     if (node.server) {
       node.server.removeClient(node)

package/nodes/knxUltimateHueLight.js

@@ -69,9 +69,16 @@ module.exports = function (RED) {
             node.serverHue.hueManager.setLightState(config.hueDevice, state)
             break
           case config.GALightDIM:
+            // { decr_incr: 1, data: 1 } : Start increasing until { decr_incr: 0, data: 0 } is received.
+            // { decr_incr: 0, data: 1 } : Start decreasing until { decr_incr: 0, data: 0 } is received.
             msg.payload = dptlib.fromBuffer(msg.knx.rawValue, dptlib.resolve(config.dptLightDIM))
-            state = msg.payload.decr_incr === 1 ? { dimming_delta: { action: 'up', brightness_delta: 20 } } : { dimming_delta: { action: 'down', brightness_delta: 20 } }
-            node.serverHue.hueManager.setLightState(config.hueDevice, state)
+            if (msg.payload.data > 0) {
+              let dimDirection = 'down'
+              dimDirection = msg.payload.decr_incr === 1 ? 'up' : 'down'
+              node.startDim(dimDirection)
+            } else {
+              node.startDim('stop')
+            }
             break
           case config.GALightBrightness:
             msg.payload = dptlib.fromBuffer(msg.knx.rawValue, dptlib.resolve(config.dptLightBrightness))
@@ -94,6 +101,31 @@ module.exports = function (RED) {
         node.status({ fill: 'red', shape: 'dot', text: 'KNX->HUE error ' + error.message + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
       }
     }
+    // Start dimming
+    node.timerDim = undefined
+    node.dimDirection = {}
+    node.timeoutDim = 0
+    node.startDim = function (_direction) {
+      clearInterval(node.timerDim)
+      if (_direction === "stop") return
+      switch (_direction) {
+        case 'up':
+          node.dimDirection = { dimming_delta: { action: 'up', brightness_delta: 5 } }
+          break
+        case 'down':
+          node.dimDirection = { dimming_delta: { action: 'down', brightness_delta: 5 } }
+          break
+        default:
+          break
+      }
+      node.timerDim = setInterval(() => {
+        node.timeoutDim += 1
+        if (node.timeoutDim > 100) { node.timeoutDim = 0; clearInterval(node.timerDim) }
+        node.serverHue.hueManager.setLightState(config.hueDevice, node.dimDirection)
+      }, 50);
+    }
+
+
 
     node.handleSendHUE = _event => {
       try {

package/nodes/knxUltimateHueTapDial.js

@@ -39,6 +39,7 @@ module.exports = function (RED) {
     node.formatnegativevalue = 'leave'
     node.formatdecimalsvalue = 2
     node.brightnessState = 0
+    node.isTimerDimStopRunning = false
 
     // Read the state of the light and store it in the holding object
     try {
@@ -63,9 +64,16 @@ module.exports = function (RED) {
           const knxMsgPayload = {}
           knxMsgPayload.topic = config.GArepeat
           knxMsgPayload.dpt = config.dptrepeat
+
           if (_event.relative_rotary.last_event.rotation.direction === 'clock_wise') {
             if (knxMsgPayload.dpt.startsWith('3.007')) {
-              knxMsgPayload.payload = { decr_incr: 1, data: 3 }
+              if (node.isTimerDimStopRunning === false) {
+                // Set KNX Dim up/down start
+                knxMsgPayload.payload = { decr_incr: 1, data: 3 }  // 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 })
+                if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) node.status({ fill: 'green', shape: 'dot', text: 'HUE->KNX start Dim' + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
+              }
+              node.startDimStopper(knxMsgPayload)
             } else if (knxMsgPayload.dpt.startsWith('5.001')) {
               //0 – maximum: 32767
               node.brightnessState < 100 ? node.brightnessState += 20 : node.brightnessState = 100
@@ -73,17 +81,19 @@ module.exports = function (RED) {
             }
           } else if (_event.relative_rotary.last_event.rotation.direction === 'counter_clock_wise') {
             if (knxMsgPayload.dpt.startsWith('3.007')) {
-              knxMsgPayload.payload = { decr_incr: 0, data: 3 }
+              if (node.isTimerDimStopRunning === false) {
+                // Set KNX Dim up/down start
+                knxMsgPayload.payload = { decr_incr: 0, data: 3 }  // 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 })
+                if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) node.status({ fill: 'green', shape: 'dot', text: 'HUE->KNX start Dim' + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
+              }
+              node.startDimStopper(knxMsgPayload)
             } else if (knxMsgPayload.dpt.startsWith('5.001')) {
               node.brightnessState > 0 ? node.brightnessState -= 20 : node.brightnessState = 0
               knxMsgPayload.payload = node.brightnessState
             }
           }
 
-          // 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() + ')' })
-
           // Setup the output msg
           knxMsgPayload.name = node.name
           knxMsgPayload.event = 'rotation ' + _event.relative_rotary.last_event.rotation.direction
@@ -95,6 +105,20 @@ module.exports = function (RED) {
       }
     }
 
+    // Timer to stop the dimming sequence
+    node.startDimStopper = function (knxMsgPayload) {
+      if (node.timerDimStop !== undefined) clearInterval(node.timerDimStop)
+      node.isTimerDimStopRunning = true
+      node.timerDimStop = setTimeout(() => {
+        // KNX Stop DIM
+        knxMsgPayload.payload = { decr_incr: 0, data: 0 } // Payload for the output msg
+        // 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 })
+        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
+      }, 500);
+    }
+
     // On each deploy, unsubscribe+resubscribe
     if (node.server) {
       node.server.removeClient(node)

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=14.0.0"
   },
-  "version": "2.0.15",
+  "version": "2.0.16",
   "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": {
     "mkdirp": "1.0.4",