node-red-contrib-knx-ultimate 2.1.11 → 2.1.12

package/CHANGELOG.md

@@ -6,6 +6,10 @@
 
 # CHANGELOG
 
+<p>
+<b>Version 2.1.12</b> - June 2023<br/>
+- Hue Light node: added tunable white.<br/>
+</p>
 <p>
 <b>Version 2.1.11</b> - June 2023<br/>
 - KNX Global Context node: added the optional datastore to choose from.<br/>

package/nodes/knxUltimateHueLight.html

@@ -331,23 +331,30 @@
 
 
 
-            // DPT dptLightTunableWhite and dptLightTunableWhiteState
+            // DPT dptLightTunableWhite 
             // ########################
             $.getJSON('knxUltimateDpts', (data) => {
                 data.forEach(dpt => {
-                    if (dpt.value === "3.007" || dpt.value === "5.001") {
+                    if (dpt.value === "3.007") {
                         $("#node-input-dptLightHSV").append($("<option></option>")
                             .attr("value", dpt.value)
-                            .text(dpt.text))
+                            .text(dpt.text))                       
+                    }
+                });
+
+                $("#node-input-dptLightHSV").val(this.dptLightHSV)
+            })
+
+            // DPT  dptLightTunableWhiteState
+            $.getJSON('knxUltimateDpts', (data) => {
+                data.forEach(dpt => {
+                    if (dpt.value === "5.001") {
                         $("#node-input-dptLightHSVState").append($("<option></option>")
                             .attr("value", dpt.value)
                             .text(dpt.text))
                     }
                 });
-
-                $("#node-input-dptLightHSV").val(this.dptLightHSV)
                 $("#node-input-dptLightHSVState").val(this.dptLightHSVState)
-
             })
 
             // Autocomplete suggestion with ETS csv File
@@ -356,7 +363,7 @@
                 source: function (request, response) {
                     $.getJSON("knxUltimatecsv?nodeID=" + oNodeServer.id, (data) => {
                         response($.map(data, function (value, key) {
-                            if (value.dpt === "3.007" || value.dpt === "5.001") {
+                            if (value.dpt === "3.007") {
                                 var sSearch = (value.ga + " (" + value.devicename + ") DPT" + value.dpt);
                                 if (fullSearch(sSearch, request.term)) {
                                     return {
@@ -389,7 +396,7 @@
                 source: function (request, response) {
                     $.getJSON("knxUltimatecsv?nodeID=" + oNodeServer.id, (data) => {
                         response($.map(data, function (value, key) {
-                            if (value.dpt === "3.007" || value.dpt === "5.001") {
+                            if (value.dpt === "5.001") {
                                 var sSearch = (value.ga + " (" + value.devicename + ") DPT" + value.dpt);
                                 if (fullSearch(sSearch, request.term)) {
                                     return {
@@ -751,7 +758,30 @@
         </div>
 
   
-    
+    <div class="form-row">
+        <label for="node-input-nameLightHSV" style="width:100px;"><i class="fa fa-play-circle-o"></i> Tunable white</label>
+
+        <label for="node-input-GALightHSV" style="width:20px;"><span data-i18n="knxUltimateHueLight.node-input-GALightState"></span></label>
+        <input type="text" id="node-input-GALightHSV" placeholder="Ex: 1/1/1" style="width:70px;margin-left: 5px; text-align: left;">
+
+        <label for="node-input-dptLightHSV" style="width:40px; margin-left: 0px; text-align: right;">DPT</label>
+        <select id="node-input-dptLightHSV" style="width:140px;"></select>
+
+        <label for="node-input-nameLightHSV" style="width:50px; margin-left: 0px; text-align: right;"><span data-i18n="knxUltimateHueLight.node-input-name"></span></label>
+        <input type="text" id="node-input-nameLightHSV" style="width:200px;margin-left: 5px; text-align: left;">
+    </div>
+    <div class="form-row">
+        <label for="node-input-nameLightHSVState" style="width:100px;"><i class="fa fa-play-circle-o"></i> Tunable white Status</label>
+
+        <label for="node-input-GALightHSVState" style="width:20px;"><span data-i18n="knxUltimateHueLight.node-input-GALightState"></span></label>
+        <input type="text" id="node-input-GALightHSVState" placeholder="Ex: 1/1/1" style="width:70px;margin-left: 5px; text-align: left;">
+
+        <label for="node-input-dptLightHSVState" style="width:40px; margin-left: 0px; text-align: right;">DPT</label>
+        <select id="node-input-dptLightHSVState" style="width:140px;"></select>
+
+        <label for="node-input-nameLightHSVState" style="width:50px; margin-left: 0px; text-align: right;"><span data-i18n="knxUltimateHueLight.node-input-name"></span></label>
+        <input type="text" id="node-input-nameLightHSVState" style="width:200px;margin-left: 5px; text-align: left;">
+    </div>
       
    
         <div class="form-row">
@@ -836,8 +866,8 @@ Start typing in the GA field, the name or group address of your KNX device, the
 | Dimming | Relative DIM the HUE light |
 | Color | This command is used to change the HUE light's color. Accepted datapoint is RGB triplet (r,g,b). The node handles the gamut color correction. As soon as you send a color KNX telegran, the light turns on and sets color and brightness, derived from the brightness human perception. As soon as you send a KNX telegram with r,g,b set to zero, the light turns off |
 | Color Status | Link this to the light's color status group address. Accepted datapoint is RGB triplet (r,g,b)|
-| Tunable white | This command is used to change the HUE light's white temperature. There are a bunch of Datapoints you can choose from, to suit your needs. |
-| Tunable white Status | Link this to the light temperature status group address. |
+| Tunable white | This command is used to change the HUE light's white temperature. Datapoint is 3.007 dimming. |
+| Tunable white Status | Link this to the light temperature status group address. Datapoint is 5.001 absolute value|
 | Brightness | This command is used to change the absolute HUE light's brightness |
 | Brightness Status| Link this to the light's brightness status group address |
 | Blink| *true* Blink the light, *false* Stop blinking. Blinks the light on and off. Useful for signalling. Works with all HUE lights. |

package/nodes/knxUltimateHueLight.js

@@ -2,7 +2,7 @@ module.exports = function (RED) {
   const dptlib = require('./../KNXEngine/src/dptlib')
   const hueColorConverter = require('./utils/hueColorConverter')
 
-  function knxUltimateHueLight (config) {
+  function knxUltimateHueLight(config) {
     RED.nodes.createNode(this, config)
     const node = this
     node.server = RED.nodes.getNode(config.server)
@@ -60,6 +60,21 @@ module.exports = function (RED) {
               node.startDimStopper('stop')
             }
             break
+          case config.GALightHSV:
+            if (config.dptLightHSV === '3.007') {
+              // MDT smartbutton will dim the color temperature
+              // { 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.dptLightHSV))
+              if (msg.payload.data > 0) {
+                let dimDirectionTunableWhite = 'down'
+                dimDirectionTunableWhite = msg.payload.decr_incr === 1 ? 'up' : 'down'
+                node.startDimStopperTunableWhite(dimDirectionTunableWhite)
+              } else {
+                node.startDimStopperTunableWhite('stop')
+              }
+            }
+            break
           case config.GALightBrightness:
             msg.payload = dptlib.fromBuffer(msg.knx.rawValue, dptlib.resolve(config.dptLightBrightness))
             state = { dimming: { brightness: msg.payload } }
@@ -97,7 +112,7 @@ module.exports = function (RED) {
               node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, { on: { on: true } }, 'setLight')
               node.timerColorCycle = setInterval(() => {
                 try {
-                  function getRandomIntInclusive (min, max) {
+                  function getRandomIntInclusive(min, max) {
                     min = Math.ceil(min)
                     max = Math.floor(max)
                     return Math.floor(Math.random() * (max - min + 1) + min) // The maximum is inclusive and the minimum is inclusive
@@ -150,6 +165,29 @@ module.exports = function (RED) {
       }, 300)
     }
 
+    // Start dimming tunable white
+    // mirek: required(integer – minimum: 153 – maximum: 500)
+    node.timerDimTunableWhite = undefined
+    node.dimDirectionTunableWhite = {}
+    node.startDimStopperTunableWhite = function (_direction) {
+      if (node.timerDimTunableWhite !== undefined) clearInterval(node.timerDimTunableWhite)
+      if (_direction === 'stop') return
+      switch (_direction) {
+        case 'up':
+          node.dimDirectionTunableWhite = { color_temperature_delta: { action: 'up', mirek_delta: 10 } }
+          break
+        case 'down':
+          node.dimDirectionTunableWhite = { color_temperature_delta: { action: 'down', mirek_delta: 10 } }
+          break
+        default:
+          break
+      }
+      node.timerDimTunableWhite = setInterval(() => {
+        node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, node.dimDirectionTunableWhite, 'setLight')
+      }, 300)
+
+    }
+
     node.handleSendHUE = _event => {
       try {
         if (_event.id === config.hueDevice) {
@@ -187,6 +225,17 @@ module.exports = function (RED) {
             // 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 (_event.hasOwnProperty('color_temperature')) {
+            knxMsgPayload.topic = config.GALightHSVState
+            knxMsgPayload.dpt = config.dptLightHSVState
+            if (config.dptLightHSVState === '5.001') {
+              //NewValue = (((OldValue - OldMin) * (NewMax - NewMin)) / (OldMax - OldMin)) + NewMin
+              let NewValue = (((_event.color_temperature.mirek - 153) * (100 - 0)) / (500 - 153)) + 0
+              knxMsgPayload.payload = NewValue
+            }
+            // 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 State ' + JSON.stringify(knxMsgPayload.payload) + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
         }
       } catch (error) {

package/nodes/utils/hueUtils.js

@@ -4,9 +4,10 @@
 const hueApiV2 = require('node-hue')
 const { EventEmitter } = require('events')
 const https = require('https')
+const EventSource = require('eventsource');
 
 class classHUE extends EventEmitter {
-  constructor (_hueBridgeIP, _username, _clientkey, _bridgeid) {
+  constructor(_hueBridgeIP, _username, _clientkey, _bridgeid) {
     super()
     this.setup(_hueBridgeIP, _username, _clientkey, _bridgeid)
   }
@@ -19,6 +20,8 @@ class classHUE extends EventEmitter {
     this.commandQueue = []
     this.closePushEventStream = false
     this.timerwriteQueueAdd = setTimeout(this.handleQueue, 3000) // First start
+    this.connect()
+
     // this.run()
     // start the SSE Stream Receiver
     // #############################################
@@ -80,28 +83,84 @@ class classHUE extends EventEmitter {
     // // Starts the connection for the first time
     // req();
 
+
     // Eventstream Reader using hueApiV2
-    const runStreamReader = async () => {
+    // const runStreamReader = async () => {
+    //   try {
+    //     const listener = (event) => {
+    //       // console.log(event)
+    //       event.data.forEach(element => {
+    //         if (event.type === 'update') this.emit('event', element)
+    //       })
+    //     }
+    //     const hueEventStream = hueApiV2.connect({
+    //       host: this.hueBridgeIP,
+    //       key: this.username,
+    //       eventListener: listener
+    //     })
+    //   } catch (error) {
+    //     console.log('KNXUltimateHUEConfig: classHUE: const run = async: ' + error.message)
+    //   }
+    // }
+    // runStreamReader()
+
+
+
+    // #############################################
+  }
+
+
+  connect() {
+    // #############################################
+    const options = {
+      headers: {
+        'hue-application-key': this.username,
+      },
+      https: {
+        rejectUnauthorized: false,
+      },
+    };
+
+    this.es = new EventSource('https://' + this.hueBridgeIP + '/eventstream/clip/v2', options);
+
+    this.es.onmessage = (event) => {
       try {
-        const listener = (event) => {
-          // console.log(event)
-          event.data.forEach(element => {
-            if (event.type === 'update') this.emit('event', element)
+        if (event && event.type === 'message' && event.data) {
+          const data = JSON.parse(event.data);
+          data.forEach(element => {
+            if (element.type === 'update') {
+              element.data.forEach(ev => {
+                this.emit('event', ev)
+              })
+            }
           })
         }
-        const hueEventStream = hueApiV2.connect({
-          host: this.hueBridgeIP,
-          key: this.username,
-          eventListener: listener
-        })
       } catch (error) {
-        console.log('KNXUltimateHUEConfig: classHUE: const run = async: ' + error.message)
+        console.log('KNXUltimateHUEConfig: classHUE: this.es.onmessage: ' + error.message)
       }
+
+    };
+
+    this.es.onopen = () => {
+      //console.log('KNXUltimateHUEConfig: classHUE: SSE-Connected')
+      //this.emit('connected');
     }
-    runStreamReader()
+    this.es.onerror = (error) => {
+      try {
+        this.es.close()
+        this.es = null
+        console.log('KNXUltimateHUEConfig: classHUE: request.on(error): ' + error.message)
+        setTimeout(() => {
+          this.connect()
+        }, 5000);
+      } catch (error) {
 
-    // #############################################
+      }
+      //this.emit('error', err)
+    };
   }
+  // #############################################
+
 
   // Handle the send queue
   // ######################################
@@ -131,7 +190,7 @@ class classHUE extends EventEmitter {
       }
     }
     // The Hue bridge allows about 10 telegram per second, so i need to make a queue manager
-    setTimeout(this.handleQueue, 100)
+    setTimeout(this.handleQueue, 150)
   }
 
   writeHueQueueAdd = async (_lightID, _state, _operation, _callback) => {
@@ -185,10 +244,22 @@ class classHUE extends EventEmitter {
     }
   }
 
+  // Get the light details
+  getLightStatus = async (_rid) => { 
+    try {
+      const hue = hueApiV2.connect({ host: this.hueBridgeIP, key: this.username })
+      const oLight = await hue.getLight(_rid)
+      return oLight[0]
+    } catch (error) {      
+    }    
+  }
+
   close = async () => {
     return new Promise((resolve, reject) => {
       try {
         this.closePushEventStream = true
+        this.es.close();
+        this.es = null;
         setTimeout(() => {
           resolve(true)
         }, 1000)

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "2.1.11",
+  "version": "2.1.12",
   "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",
@@ -18,7 +18,8 @@
     "dns-sync": "0.2.1",
     "node-hue-api": "5.0.0-beta.16",
     "node-hue": "1.0.4",
-    "color-convert": "2.0.1"
+    "color-convert": "2.0.1",
+    "eventsource": "2.0.2"    
   },
   "node-red": {
     "version": ">=2.0.0",