node-red-contrib-knx-ultimate 2.1.4 → 2.1.6

package/CHANGELOG.md

@@ -6,6 +6,10 @@
 
 # CHANGELOG
 
+<p>
+<b>Version 2.1.6</b> - June 2023<br/>
+- Several fixes for reading the correct GAMUT color.<br/>
+</p>
 <p>
 <b>Version 2.1.4</b> - June 2023<br/>
 - NEW: Hue light node: added random color cycle effect group address.<br/>

package/nodes/hue-config.js

@@ -28,14 +28,6 @@ const convertSubtype = (baseType) => (kv) => {
   }
 }
 
-// 06/02/2020 To be tested
-// convertSubtype = (baseType) => (kv) => {
-//     let value = `${baseType.base}.${kv[0]}`
-//     return {
-//         value: value
-//         , text: value + ` (${kv[1].name}${kv[1].unit !== undefined?" - " + kv[1].unit:""})`
-//     }
-// }
 
 const toConcattedSubtypes = (acc, baseType) => {
   const subtypes =

package/nodes/knxUltimateHueLight.js

@@ -47,7 +47,7 @@ module.exports = function (RED) {
           case config.GALightSwitch:
             msg.payload = dptlib.fromBuffer(msg.knx.rawValue, dptlib.resolve(config.dptLightSwitch))
             state = msg.payload === true ? { on: { on: true } } : { on: { on: false } }
-            node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state)
+            node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state, 'setLight')
             break
           case config.GALightDIM:
             // { decr_incr: 1, data: 1 } : Start increasing until { decr_incr: 0, data: 0 } is received.
@@ -64,17 +64,16 @@ module.exports = function (RED) {
           case config.GALightBrightness:
             msg.payload = dptlib.fromBuffer(msg.knx.rawValue, dptlib.resolve(config.dptLightBrightness))
             state = { dimming: { brightness: msg.payload } }
-            node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state)
+            node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state, 'setLight')
             break
           case config.GALightColor:
             // Behavior like ISE HUE CONNECT, by setting the brightness and on/off as well
-            if (node.currentHUEDevice === undefined) return
             msg.payload = dptlib.fromBuffer(msg.knx.rawValue, dptlib.resolve(config.dptLightColor))
-            const gamut = node.currentHUEDevice.color.gamut_type || null
+            const gamut = node.currentHUEDevice !== undefined ? node.currentHUEDevice.color.gamut_type : null
             const retXY = hueColorConverter.ColorConverter.rgbToXy(msg.payload.red, msg.payload.green, msg.payload.blue, gamut)
             const bright = hueColorConverter.ColorConverter.getBrightnessFromRGB(msg.payload.red, msg.payload.green, msg.payload.blue)
             state = bright > 0 ? { on: { on: true }, dimming: { brightness: bright }, color: { xy: retXY } } : { on: { on: false } }
-            node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state)
+            node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state, 'setLight')
             break
           case config.GALightBlink:
             const gaVal = dptlib.fromBuffer(msg.knx.rawValue, dptlib.resolve(config.dptLightSwitch))
@@ -85,36 +84,42 @@ module.exports = function (RED) {
                 msg.payload = node.blinkValue
                 //state = msg.payload === true ? { on: { on: true } } : { on: { on: false } }
                 state = msg.payload === true ? { on: { on: true }, dimming: { brightness: 100 } } : { on: { on: false } }
-                node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state)
-                node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state) // It's ok twice, so the light turns off immeridaley
+                node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state, 'setLight')
+                node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state, 'setLight') // It's ok twice, so the light turns off immeridaley
               }, 600);
             } else {
               if (node.timerBlink !== undefined) clearInterval(node.timerBlink)
-              node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, { on: { on: false } })
+              node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, { on: { on: false } }, 'setLight')
             }
             break
           case config.GALightColorCycle:
             const gaValColorCycle = dptlib.fromBuffer(msg.knx.rawValue, dptlib.resolve(config.dptLightSwitch))
             if (gaValColorCycle) {
-              node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, { on: { on: true } })
+
+              node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, { on: { on: true } }, 'setLight')
               node.timerColorCycle = setInterval(() => {
-                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
+                try {
+                  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
+                  }
+                  const red = getRandomIntInclusive(0, 255)
+                  const green = getRandomIntInclusive(0, 255)
+                  const blue = getRandomIntInclusive(0, 255)
+                  const gamut = node.currentHUEDevice !== undefined ? node.currentHUEDevice.color.gamut_type : null
+                  const retXY = hueColorConverter.ColorConverter.rgbToXy(red, green, blue, gamut)
+                  const bright = hueColorConverter.ColorConverter.getBrightnessFromRGB(red, green, blue)
+                  state = bright > 0 ? { on: { on: true }, dimming: { brightness: bright }, color: { xy: retXY } } : { on: { on: false } }
+                  node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state, 'setLight')
+                } catch (error) {
+
                 }
-                const red = getRandomIntInclusive(0, 255)
-                const green = getRandomIntInclusive(0, 255)
-                const blue = getRandomIntInclusive(0, 255)
-                const gamut = node.currentHUEDevice.color.gamut_type || null
-                const retXY = hueColorConverter.ColorConverter.rgbToXy(red, green, blue, gamut)
-                const bright = hueColorConverter.ColorConverter.getBrightnessFromRGB(red, green, blue)
-                state = bright > 0 ? { on: { on: true }, dimming: { brightness: bright }, color: { xy: retXY } } : { on: { on: false } }
-                node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state)
               }, 10000);
+
             } else {
               if (node.timerColorCycle !== undefined) clearInterval(node.timerColorCycle)
-              node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, { on: { on: false } })
+              node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, { on: { on: false } }, 'setLight')
             }
             break
           default:
@@ -144,7 +149,7 @@ module.exports = function (RED) {
       node.timerDim = setInterval(() => {
         node.timeoutDim += 1
         if (node.timeoutDim > 100) { node.timeoutDim = 0; clearInterval(node.timerDim) }
-        node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, node.dimDirection)
+        node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, node.dimDirection, 'setLight')
       }, 300);
     }
 
@@ -168,10 +173,9 @@ module.exports = function (RED) {
             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')) {
-            if (node.currentHUEDevice === undefined) return
             knxMsgPayload.topic = config.GALightColorState
             knxMsgPayload.dpt = config.dptLightColorState
-            knxMsgPayload.payload = hueColorConverter.ColorConverter.xyBriToRgb(_event.color.xy.x, _event.color.xy.y, node.currentHUEDevice.dimming.brightness)
+            knxMsgPayload.payload = hueColorConverter.ColorConverter.xyBriToRgb(_event.color.xy.x, _event.color.xy.y, (node.currentHUEDevice !== undefined ? node.currentHUEDevice.dimming.brightness : 100))
             // 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 })
           }
@@ -203,26 +207,22 @@ module.exports = function (RED) {
     }
     if (node.serverHue) {
       node.serverHue.removeClient(node)
-      node.serverHue.addClient(node)
-      setTimeout(() => {
-        try {
-          if (node !== null && node.serverHue !== null && node.serverHue.hueManager !== null) {
-            node.serverHue.hueManager.getLight(config.hueDevice).then(ret => {
-              try {
-                if (ret !== undefined && ret.length > 0) node.currentHUEDevice = ret[0]
-              } catch (error) {
-              }
-              //console.log("retrieving node.currentHUEDevice" + node.currentHUEDevice.metadata.name)
+      // I must get the light object, to store it in the node.currentHUEDevice variable
+      // I queue the state request, by passing the callback to call whenever the HUE bridge send me the light status async
+      if (node !== null && node.serverHue !== null && node.serverHue.hueManager !== null) {
+        (async () => {
+          try {
+            await node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, null, 'getLight', (jLight) => {
+              node.currentHUEDevice = jLight
+              node.serverHue.addClient(node)
             })
+          } catch (err) {
+            RED.log.error('Errore knxUltimateHueLight node.currentHUEDevice ' + err.message)
           }
-        } catch (error) {
-          console.log('Error: knxUltimateHueLight: node.serverHue.hueManager.getLight: ' + error.message)
-        }
-      }, 5000);
-
+        })()
+      }
     }
 
-
     node.on('input', function (msg) {
 
     })

package/nodes/knxUltimateHueTapDial.html

@@ -249,7 +249,7 @@ Start typing in the GA field, the name or group address of your KNX device, the
 
 |Property|Description|
 |--|--|
-| Rotate | This command is used either to send DIM (increase/decrease), aboslute brightness, or a random color, depending on the selected datapoint. |
+| 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** |
 
 ### Outputs
 

package/nodes/knxUltimateHueTapDial.js

@@ -1,19 +1,5 @@
 module.exports = function (RED) {
 
-  async function getLightState(node, _lightID) {
-    return new Promise((resolve, reject) => {
-      try {
-        if (node !== null && node.serverHue !== null && node.serverHue.hueManager !== null) {
-          node.serverHue.hueManager.getLight(_lightID).then(ret => {
-            node.currentHUEDevice = ret[0]
-            resolve(ret)
-          })
-        }
-      } catch (error) {
-        reject(error)
-      }
-    })
-  }
 
   function knxUltimateHueTapDial(config) {
     RED.nodes.createNode(this, config)
@@ -41,14 +27,6 @@ module.exports = function (RED) {
     node.brightnessState = 0
     node.isTimerDimStopRunning = false
 
-    // Read the state of the light and store it in the holding object
-    try {
-      if (config.hueLight !== undefined && config.hueLight !== '') getLightState(node, config.hueLight)
-    } catch (error) {
-    }
-
-
-
     // Used to call the status update from the config node.
     node.setNodeStatus = ({ fill, shape, text, payload }) => {
 
@@ -58,7 +36,7 @@ module.exports = function (RED) {
       const dDate = new Date()
       node.status({ fill: fill, shape: shape, text: text + ' (' + dDate.getDate() + ', ' + dDate.toLocaleTimeString() + ')' })
     }
-    
+
     // This function is called by the knx-ultimate config node, to output a msg.payload.
     node.handleSend = msg => {
     }
@@ -84,16 +62,20 @@ module.exports = function (RED) {
               node.brightnessState < 100 ? node.brightnessState += 20 : node.brightnessState = 100
               knxMsgPayload.payload = node.brightnessState
             } else if (knxMsgPayload.dpt.startsWith('232.600')) {
-              // Random color
-              knxMsgPayload.payload = { red: getRandomIntInclusive(0, 255), green: getRandomIntInclusive(0, 255), blue: getRandomIntInclusive(0, 255) }
-              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
+
+              if (_event.relative_rotary.last_event.action === 'start') {
+                // Random color
+                knxMsgPayload.payload = { red: getRandomIntInclusive(0, 255), green: getRandomIntInclusive(0, 255), blue: getRandomIntInclusive(0, 255) }
+                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
+                }
+                // 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 Change color clockwise' + ' (' + 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 })
-              if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) node.status({ fill: 'green', shape: 'dot', text: 'HUE->KNX Change color clockwise' + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
+
             }
           } else if (_event.relative_rotary.last_event.rotation.direction === 'counter_clock_wise') {
             if (knxMsgPayload.dpt.startsWith('3.007')) {
@@ -108,16 +90,15 @@ module.exports = function (RED) {
               node.brightnessState > 0 ? node.brightnessState -= 20 : node.brightnessState = 0
               knxMsgPayload.payload = node.brightnessState
             } else if (knxMsgPayload.dpt.startsWith('232.600')) {
-              // Random color
-              knxMsgPayload.payload = { red: getRandomIntInclusive(0, 255), green: getRandomIntInclusive(0, 255), blue: getRandomIntInclusive(0, 255) } 
-              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
+
+              if (_event.relative_rotary.last_event.action === 'start') {
+                // Set white color
+                knxMsgPayload.payload = { red: 255, green: 255, blue: 255 }
+                // 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 Change color counterclockwise' + ' (' + 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 })
-              if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) node.status({ fill: 'green', shape: 'dot', text: 'HUE->KNX Change color counterclockwise' + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
+
             }
           }
 

package/nodes/utils/hueUtils.js

@@ -75,6 +75,7 @@ class classHUE extends EventEmitter {
         console.log('KNXUltimateHUEConfig: classHUE: request.on(error): ' + error.message)
         // Restart the connection
         setTimeout(() => {
+          this.commandQueue = []
           req();
         }, 2000);
       });
@@ -89,19 +90,33 @@ class classHUE extends EventEmitter {
   handleQueue = async () => {
     if (this.commandQueue.length > 0) {
       const jRet = this.commandQueue.shift()
-      try {
-        const hue = hueApiV2.connect({ host: this.hueBridgeIP, key: this.username })
-        const ok = await hue.setLight(jRet._lightID, jRet._state)
-      } catch (error) {
-        console.log('KNXUltimateHUEConfig: classHUE: handleQueue: ' + error.message)
-        return ({ error: error.message })
+      switch (jRet._operation) {
+        case 'setLight':
+          try {
+            const hue = hueApiV2.connect({ host: this.hueBridgeIP, key: this.username })
+            const ok = await hue.setLight(jRet._lightID, jRet._state)
+          } catch (error) {
+            console.log('KNXUltimateHUEConfig: classHUE: handleQueue: setLight: ' + error.message)
+          }
+          break;
+        case 'getLight':
+          try {
+            const hue = hueApiV2.connect({ host: this.hueBridgeIP, key: this.username })
+            const jReturn = await hue.getLight(jRet._lightID)
+            jRet._callback(jReturn[0]) // Need to call the callback, because the event is absolutely async
+          } catch (error) {
+            console.log('KNXUltimateHUEConfig: classHUE: handleQueue: getLight: ' + error.message)
+          }
+          break
+        default:
+          break;
       }
     }
     // The Hue bridge allows about 10 telegram per second, so i need to make a queue manager
     setTimeout(this.handleQueue, 100)
   }
-  writeHueQueueAdd = async (_lightID, _state) => {
-    this.commandQueue.push({ _lightID, _state })
+  writeHueQueueAdd = async (_lightID, _state, _operation = 'setLight', _callback) => {
+    this.commandQueue.push({ _lightID, _state, _operation, _callback })
   }
 
 
@@ -153,15 +168,7 @@ class classHUE extends EventEmitter {
   }
 
 
-  // Get light state
-  getLight = async (_LightID) => {
-    try {
-      const hue = hueApiV2.connect({ host: this.hueBridgeIP, key: this.username })
-      return await hue.getLight(_LightID)
-    } catch (error) {
-      console.log('KNXUltimateHUEConfig: classHUE: getLight: ' + error.message)
-    }
-  }
+
 
   close = async () => {
     return new Promise((resolve, reject) => {

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=14.0.0"
   },
-  "version": "2.1.4",
+  "version": "2.1.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 handling.",
   "dependencies": {
     "mkdirp": "1.0.4",