node-red-contrib-knx-ultimate 2.1.3 → 2.1.5

package/CHANGELOG.md

@@ -6,6 +6,13 @@
 
 # CHANGELOG
 
+<p>
+<b>Version 2.1.5</b> - June 2023<br/>
+- NEW: Hue light node: added random color cycle effect group address.<br/>
+- Fixed destroying KNX nodes.<br/>
+- Fixed destroying HUE nodes.<br/>
+- Several HUE bugfixes.<br/>
+</p>
 <p>
 <b>Version 2.1.3</b> - June 2023<br/>
 - Bugfix.<br/>

package/nodes/hue-config.js

@@ -1,7 +1,7 @@
 
 const dptlib = require('./../KNXEngine/dptlib')
 const hueClass = require('./utils/hueUtils').classHUE
-
+const loggerEngine = require('./utils/sysLogger.js')
 // Helpers
 const sortBy = (field) => (a, b) => {
   if (a[field] > b[field]) { return 1 } else { return -1 }
@@ -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 =
@@ -57,7 +49,7 @@ module.exports = (RED) => {
         .sort(sortBy('base'))
         .reduce(toConcattedSubtypes, [])
 
-    res.json(dpts)   
+    res.json(dpts)
   })
 
   function hueConfig(config) {
@@ -68,7 +60,7 @@ module.exports = (RED) => {
     node.loglevel = config.loglevel !== undefined ? config.loglevel : 'error' // 18/02/2020 Loglevel default error
     node.sysLogger = null // 20/03/2022 Default
     try {
-      node.sysLogger = require('./utils/sysLogger.js').get({ loglevel: node.loglevel }) // 08/04/2021 new logger to adhere to the loglevel selected in the config-window
+      node.sysLogger = loggerEngine.get({ loglevel: node.loglevel }) // 08/04/2021 new logger to adhere to the loglevel selected in the config-window
     } catch (error) { }
     node.name = (config.name === undefined || config.name === '') ? node.host : config.name // 12/08/2021
 
@@ -80,7 +72,7 @@ module.exports = (RED) => {
       node.nodeClients.forEach(_oClient => {
         const oClient = RED.nodes.getNode(_oClient.id)
         try {
-          oClient.handleSendHUE(_event)
+          if (oClient.handleSendHUE !== undefined) oClient.handleSendHUE(_event)
         } catch (error) {
           if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error('Errore node.hueManager.on(event): ' + error.message)
         }
@@ -112,7 +104,7 @@ module.exports = (RED) => {
       // Check if node already exists
       if (node.nodeClients.filter(x => x.id === _Node.id).length === 0) {
         // Add _Node to the clients array
-        _Node.setNodeStatus({ fill: 'grey', shape: 'ring', text: 'Hue initialized.', payload: '', GA: '', dpt: '', devicename: '' })
+        _Node.setNodeStatusHue({ fill: 'grey', shape: 'ring', text: 'Hue initialized.' })
         // 01/06/2023 Add node to the array
         const jNode = {}
         jNode.id = _Node.id
@@ -130,10 +122,19 @@ module.exports = (RED) => {
 
     node.on('close', function (done) {
       try {
-        if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.destroy()
+        if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger = null; loggerEngine.destroy()
         node.nodeClients = []
-      } catch (error) { }
-      done()
+        node.hueManager.removeAllListeners();
+        (async () => {
+          await node.hueManager.close()
+          node.hueManager = null;
+          delete node.hueManager;
+          done()
+        })()
+      } catch (error) {
+        done()
+        console.log(error.message)
+      }
     })
   }
 

package/nodes/knxUltimate-config.js

@@ -11,6 +11,7 @@ const path = require('path')
 const fs = require('fs')
 // const { Server } = require('http')
 const payloadRounder = require('./utils/payloadManipulation')
+const loggerEngine = require('./utils/sysLogger.js')
 
 // Helpers
 const sortBy = (field) => (a, b) => {
@@ -127,7 +128,7 @@ return msg;`,
     node.loglevel = config.loglevel !== undefined ? config.loglevel : 'error' // 18/02/2020 Loglevel default error
     node.sysLogger = null // 20/03/2022 Default
     try {
-      node.sysLogger = require('./utils/sysLogger.js').get({ loglevel: node.loglevel }) // 08/04/2021 new logger to adhere to the loglevel selected in the config-window
+      node.sysLogger = loggerEngine.get({ loglevel: node.loglevel }) // 08/04/2021 new logger to adhere to the loglevel selected in the config-window
     } catch (error) { }
     // 12/11/2021 Connect at start delay
     node.autoReconnect = true // 20/03/2022 Default
@@ -1840,7 +1841,7 @@ return msg;`,
       node.telegramsQueue = []
       node.nodeClients = [] // 05/04/2022 Nullify
       try {
-        if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.destroy()
+        if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger = null; loggerEngine.destroy()
       } catch (error) { }
       done()
     })

package/nodes/knxUltimateHueButton.js

@@ -31,7 +31,12 @@ module.exports = function (RED) {
     node.setNodeStatus = ({ fill, shape, text, payload }) => {
 
     }
-
+    // Used to call the status update from the HUE config node.
+    node.setNodeStatusHue = ({ fill, shape, text }) => {
+      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 => {
       const state = {}
@@ -159,6 +164,9 @@ module.exports = function (RED) {
       if (node.server) {
         node.server.removeClient(node)
       }
+      if (node.serverHue) {
+        node.serverHue.removeClient(node)
+      }
       done()
     })
   }

package/nodes/knxUltimateHueLight.html

@@ -40,6 +40,10 @@
             GALightBlink: { value: "" },
             dptLightBlink: { value: "" },
 
+            nameLightColorCycle: { value: "" },
+            GALightColorCycle: { value: "" },
+            dptLightColorCycle: { value: "" },
+
             hueDevice: { value: "" }
         },
         inputs: 0,
@@ -447,6 +451,54 @@
 
 
 
+            // DPT Cycle Colors
+            // ########################
+            $.getJSON('knxUltimateDpts', (data) => {
+                data.forEach(dpt => {
+                    if (dpt.value.startsWith("1.")) {
+                        $("#node-input-dptLightColorCycle").append($("<option></option>")
+                            .attr("value", dpt.value)
+                            .text(dpt.text))
+                    }
+                });
+                $("#node-input-dptLightColorCycle").val(this.dptLightColorCycle)
+            })
+
+            // Autocomplete suggestion with ETS csv File
+            $("#node-input-GALightColorCycle").autocomplete({
+                minLength: 1,
+                source: function (request, response) {
+                    //$.getJSON("csv", request, function( data, status, xhr ) {
+                    $.getJSON("knxUltimatecsv?nodeID=" + oNodeServer.id, (data) => {
+                        response($.map(data, function (value, key) {
+                            var sSearch = (value.ga + " (" + value.devicename + ") DPT" + value.dpt);
+                            if (fullSearch(sSearch, request.term + " 1.")) {
+                                return {
+                                    label: value.ga + " # " + value.devicename + " # " + value.dpt, // Label for Display
+                                    value: value.ga // Value
+                                }
+                            } else {
+                                return null;
+                            }
+                        }));
+                    });
+                }, select: function (event, ui) {
+                    // Sets Datapoint and device name automatically
+                    var sDevName = ui.item.label.split("#")[1].trim();
+                    try {
+                        sDevName = sDevName.substr(sDevName.indexOf(")") + 1).trim();
+                    } catch (error) {
+                    }
+                    $('#node-input-nameLightColorCycle').val(sDevName);
+                    var optVal = $("#node-input-dptLightColorCycle option:contains('" + ui.item.label.split("#")[2].trim() + "')").attr('value');
+                    // Select the option value 
+                    $("#node-input-dptLightColorCycle").val(optVal);
+                }
+            });
+            // ########################
+
+
+
             // Autocomplete suggestion with HUE Lights
             $("#node-input-name").autocomplete({
                 minLength: 1,
@@ -643,7 +695,19 @@
         <label for="node-input-nameLightBlink" style="width:50px; margin-left: 0px; text-align: right;"><span data-i18n="knxUltimateHueLight.node-input-name"></span></label>
         <input type="text" id="node-input-nameLightBlink" style="width:200px;margin-left: 5px; text-align: left;">
     </div>
+    </div>
+        <div class="form-row">
+        <label for="node-input-nameLightColorCycle" style="width:100px;"><i class="fa fa-play-circle-o"></i> Color Cycle</label>
 
+        <label for="node-input-GALightColorCycle" style="width:20px;">GA</label>
+        <input type="text" id="node-input-GALightColorCycle" placeholder="Ex: 1/1/1" style="width:70px;margin-left: 5px; text-align: left;">
+       
+        <label for="node-input-dptLightColorCycle" style="width:40px; margin-left: 0px; text-align: right;">DPT</label>
+        <select id="node-input-dptLightColorCycle" style="width:140px;"></select>
+       
+        <label for="node-input-nameLightColorCycle" style="width:50px; margin-left: 0px; text-align: right;"><span data-i18n="knxUltimateHueLight.node-input-name"></span></label>
+        <input type="text" id="node-input-nameLightColorCycle" style="width:200px;margin-left: 5px; text-align: left;">
+    </div>
 <br/>
 <br/>
 <br/>
@@ -676,7 +740,8 @@ Start typing in the GA field, the name or group address of your KNX device, the
 | Color Status | Link this to the light's color status group address. Accepted datapoint is RGB triplet (r,g,b)|
 | 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. It is compatible with all HUE lights. |
+| Blink| *true* Blink the light, *false* Stop blinking. Blinks the light on and off. Useful for signalling. Works with all HUE lights. |
+| Color Cycle| *true* start cycle, *false* Stop cycle. Randomly changes the HUE light's color at regular interval. Works with all HUE lights having color capabilities. |
 
 <br/>
 

package/nodes/knxUltimateHueLight.js

@@ -33,6 +33,11 @@ module.exports = function (RED) {
     node.setNodeStatus = ({ fill, shape, text, payload }) => {
 
     }
+    // Used to call the status update from the HUE config node.
+    node.setNodeStatusHue = ({ fill, shape, text }) => {
+      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 => {
@@ -81,13 +86,51 @@ module.exports = function (RED) {
                 //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)
+                node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state) // 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 } })
             }
             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.timerColorCycle = setInterval(() => {
+                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.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)
+                } catch (error) {
+                  (async () => {
+                    try {
+                      const retLight = await node.serverHue.hueManager.getLight(config.hueDevice)
+                      node.currentHUEDevice = retLight[0]
+                      RED.log.error('Errore knxUltimateHueLight node.currentHUEDevice Samba ' + error.message)
+                    } catch (err) {
+                      RED.log.error('Errore knxUltimateHueLight node.currentHUEDevice Banana ' + err.message)
+                    }
+                  })()
+                }
+              }, 10000);
+
+            } else {              
+              if (node.timerColorCycle !== undefined) clearInterval(node.timerColorCycle)
+              node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, { on: { on: false } })
+            }
+            break
           default:
             break
         }
@@ -174,23 +217,17 @@ 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)
-            })
+      if (node !== null && node.serverHue !== null && node.serverHue.hueManager !== null) {
+        (async () => {
+          try {
+            const retLight = await node.serverHue.hueManager.getLight(config.hueDevice)
+            node.currentHUEDevice = retLight[0]
+            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)
-        }
-      }, 1000);
-
+        })()
+      }
     }
 
 
@@ -202,6 +239,9 @@ module.exports = function (RED) {
       if (node.server) {
         node.server.removeClient(node)
       }
+      if (node.serverHue) {
+        node.serverHue.removeClient(node)
+      }
       done()
     })
   }

package/nodes/knxUltimateHueLightSensor.js

@@ -31,7 +31,12 @@ module.exports = function (RED) {
     node.setNodeStatus = ({ fill, shape, text, payload }) => {
 
     }
-
+    // Used to call the status update from the HUE config node.
+    node.setNodeStatusHue = ({ fill, shape, text }) => {
+      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 => {
     }
@@ -81,6 +86,9 @@ module.exports = function (RED) {
       if (node.server) {
         node.server.removeClient(node)
       }
+      if (node.serverHue) {
+        node.serverHue.removeClient(node)
+      }
       done()
     })
   }

package/nodes/knxUltimateHueMotion.js

@@ -31,7 +31,12 @@ module.exports = function (RED) {
     node.setNodeStatus = ({ fill, shape, text, payload }) => {
 
     }
-
+    // Used to call the status update from the HUE config node.
+    node.setNodeStatusHue = ({ fill, shape, text }) => {
+      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 => {
     }
@@ -81,6 +86,9 @@ module.exports = function (RED) {
       if (node.server) {
         node.server.removeClient(node)
       }
+      if (node.serverHue) {
+        node.serverHue.removeClient(node)
+      }
       done()
     })
   }

package/nodes/knxUltimateHueTapDial.js

@@ -53,7 +53,12 @@ module.exports = function (RED) {
     node.setNodeStatus = ({ fill, shape, text, payload }) => {
 
     }
-
+    // Used to call the status update from the HUE config node.
+    node.setNodeStatusHue = ({ fill, shape, text }) => {
+      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 => {
     }
@@ -88,7 +93,7 @@ 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 (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) node.status({ fill: 'green', shape: 'dot', text: 'HUE->KNX start Dim' + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
+              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')) {
@@ -112,7 +117,7 @@ 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 (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) node.status({ fill: 'green', shape: 'dot', text: 'HUE->KNX start Dim' + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
+              if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) node.status({ fill: 'green', shape: 'dot', text: 'HUE->KNX Change color counterclockwise' + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
             }
           }
 
@@ -159,6 +164,9 @@ module.exports = function (RED) {
       if (node.server) {
         node.server.removeClient(node)
       }
+      if (node.serverHue) {
+        node.serverHue.removeClient(node)
+      }
       done()
     })
   }

package/nodes/knxUltimateHueTemperatureSensor.js

@@ -31,6 +31,12 @@ module.exports = function (RED) {
     node.setNodeStatus = ({ fill, shape, text, payload }) => {
 
     }
+    // Used to call the status update from the HUE config node.
+    node.setNodeStatusHue = ({ fill, shape, text }) => {
+      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 => {
@@ -81,6 +87,9 @@ module.exports = function (RED) {
       if (node.server) {
         node.server.removeClient(node)
       }
+      if (node.serverHue) {
+        node.serverHue.removeClient(node)
+      }
       done()
     })
   }

package/nodes/utils/hueUtils.js

@@ -23,6 +23,7 @@ class classHUE extends EventEmitter {
     this.clientkey = _clientkey
     this.bridgeid = _bridgeid
     this.commandQueue = []
+    this.closePushEventStream = false
     this.timerwriteQueueAdd = setTimeout(this.handleQueue, 3000) // First start
 
     // start the SSE Stream Receiver
@@ -68,6 +69,7 @@ class classHUE extends EventEmitter {
     };
     // Funzione per richiedere gli eventi
     const req = () => {
+      if (this.closePushEventStream) return // I'm destroying the class
       const request = https.request(options, handleResponse);
       request.on('error', (error) => {
         console.log('KNXUltimateHUEConfig: classHUE: request.on(error): ' + error.message)
@@ -160,6 +162,20 @@ class classHUE extends EventEmitter {
       console.log('KNXUltimateHUEConfig: classHUE: getLight: ' + error.message)
     }
   }
-  
+
+  close = async () => {
+    return new Promise((resolve, reject) => {
+      try {
+        this.closePushEventStream = true
+        setTimeout(() => {
+          resolve(true)
+        }, 1000);
+      } catch (error) {
+        reject(error)
+      }
+    })
+
+
+  }
 }
 module.exports.classHUE = classHUE

package/nodes/utils/sysLogger.js

@@ -57,7 +57,7 @@ module.exports = {
           }
         }
       })
-    }
+    }    
     return (logger)
   },
   destroy: function () {

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=14.0.0"
   },
-  "version": "2.1.3",
+  "version": "2.1.5",
   "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",