node-red-contrib-knx-ultimate 2.1.13 → 2.1.15

package/CHANGELOG.md

@@ -6,6 +6,14 @@
 
 # CHANGELOG
 
+<p>
+<b>Version 2.1.15</b> - June 2023<br/>
+- Fix an issue with auto discovery of not registered HUE bridges. Now you must first set the IP, then click CONNECT.<br/>
+</p>
+<p>
+<b>Version 2.1.14</b> - June 2023<br/>
+- Hue Light node: added day/night behaviour.<br/>
+</p>
 <p>
 <b>Version 2.1.13</b> - June 2023<br/>
 - Hue Light node: fixed inversion in the color temp state.<br/>

package/nodes/hue-config.html

@@ -11,8 +11,11 @@
             clientkey: { type: "password" }
         },
         oneditprepare: function () {
-
-
+            if (this.bridgeid === undefined || this.bridgeid === '') {
+                $("#divDetails").hide()
+            } else {
+                $("#divDetails").show()
+            }
             $("#getinfocam").click(function () {
 
                 var myNotification = RED.notify("Please press the Link button on the HUE Bridge / Pre favore, premi il pulsante sul bridge HUE",
@@ -25,7 +28,7 @@
                                 text: "OK",
                                 click: function (e) {
                                     // Send the infos to Supergiovane
-                                    $.getJSON("KNXUltimateRegisterToHueBridge", (data) => {
+                                    $.getJSON("KNXUltimateRegisterToHueBridge?IP=" + $("#node-config-input-host").val(), (data) => {
                                         this.value = "Connect";
                                         this.disabled = false;
                                         if (data.hasOwnProperty("error")) {
@@ -35,16 +38,18 @@
                                                     fixed: false,
                                                     type: 'error'
                                                 });
-                                            this.disabled = true;
+                                            this.disabled = false;
+                                            $("#divDetails").hide()
                                             return;
                                         }
 
                                         // Expected { bridge: bridgeConfig, user: createdUser }
                                         $("#node-config-input-name").val(data.bridge.data.name);
-                                        $("#node-config-input-host").val(data.bridge.data.ipaddress);
+                                        // $("#node-config-input-host").val(data.bridge.data.ipaddress);
                                         $("#node-config-input-username").val(data.user.username);
                                         $("#node-config-input-clientkey").val(data.user.clientkey);
                                         $("#node-config-input-bridgeid").val(data.bridge.data.bridgeid);
+                                        $("#divDetails").show()
 
                                     }).error(function (jqXHR, textStatus, errorThrown) {
                                         RED.notify("Something went wrong. Please create at least a KNX Gateway node first.",
@@ -88,51 +93,54 @@
 
     <p align='center'> <img src='https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/huehub.jpg' width='40%'></p>
 
-
-    <div class="form-row">
-            <label><i class="fa fa-sign-in"></i>&nbspRegister</label>
-            <input type="button" id="getinfocam" class="ui-button ui-corner-all ui-widget" style="background-color:#AEE1FF;width:150px" value="CONNECT">
-        </div>
-
-    <div class="form-row">
-    <label for="node-config-input-name">
-        <i class="fa fa-tag"></i>
-        <span data-i18n="hue-config.properties.node-config-input-name"</span>
-    </label>
-    <input type="text" id="node-config-input-name" ><data-i18n="[Title]hue-config.properties.node-config-input-name" style="margin-left:5px;">
-    </div>
-    
-    <div class="form-row">
-    <label for="node-config-input-bridgeid">
-        <i class="fa fa-tag"></i>
-        Bridge ID
-    </label>
-    <input type="text" id="node-config-input-bridgeid" disabled>
-    </div>
-
+   
     <div class="form-row">
         <label for="node-config-input-host">
             <i class="fa fa-server"></i>
-            <span data-i18n="hue-config.properties.host"</span>
+            <span data-i18n="hue-config.properties.host" </span>
         </label>
-        <input type="text" id="node-config-input-host"><data-i18n="[Title]hue-config.properties.host_info" style="margin-left:5px;">
+        <input type="text" id="node-config-input-host" placeholder="Write here the HUE bridge's IP, then click CONNECT">
     </div>
     <div class="form-row">
-        <label for="node-config-input-username"> Username</label>
-        <input type="password" id="node-config-input-username" placeholder="">
-    </div>
-    <div class="form-row">
-        <label for="node-config-input-clientkey"> Bridge Key</label>
-        <input type="password" id="node-config-input-clientkey" placeholder="">
+        <label><i class="fa fa-sign-in"></i>&nbspRegister</label>
+        <input type="button" id="getinfocam" class="ui-button ui-corner-all ui-widget"
+            style="background-color:#AEE1FF;width:150px" value="CONNECT">
     </div>
+   
+    <div id="divDetails" hidden>
+        <div class="form-row">
+            <label for="node-config-input-name">
+                <i class="fa fa-tag"></i>
+                <span data-i18n="hue-config.properties.node-config-input-name" </span>
+            </label>
+            <input type="text" id="node-config-input-name"><data-i18n="[Title]hue-config.properties.node-config-input-name"
+                style="margin-left:5px;">
+        </div>
 
+        <div class="form-row">
+            <label for="node-config-input-bridgeid">
+                <i class="fa fa-tag"></i>
+                Bridge ID
+            </label>
+            <input type="text" id="node-config-input-bridgeid" disabled>
+        </div>
+
+        <div class="form-row">
+            <label for="node-config-input-username"> Username</label>
+            <input type="password" id="node-config-input-username" placeholder="">
+        </div>
+        <div class="form-row">
+            <label for="node-config-input-clientkey"> Bridge Key</label>
+            <input type="password" id="node-config-input-clientkey" placeholder="">
+        </div>
+    </div>
     
     
 </script>
 <script type="text/html" data-help-name="hue-config">
 <p> This node registers to the Hue Bridge.<br/>
 
-Just click **Connect** button.
+Just set the Bridge's ip and click **CONNECT** button.
 
 [Find it useful?](https://www.paypal.me/techtoday)
 

package/nodes/hue-config.js

@@ -51,7 +51,7 @@ module.exports = (RED) => {
     res.json(dpts)
   })
 
-  function hueConfig (config) {
+  function hueConfig(config) {
     RED.nodes.createNode(this, config)
     const node = this
     node.host = config.host
@@ -124,9 +124,12 @@ module.exports = (RED) => {
         node.nodeClients = []
         node.hueManager.removeAllListeners();
         (async () => {
-          await node.hueManager.close()
-          node.hueManager = null
-          delete node.hueManager
+          try {
+            await node.hueManager.close()
+            node.hueManager = null
+            delete node.hueManager
+          } catch (error) {
+          }
           done()
         })()
       } catch (error) {

package/nodes/knxUltimate-config.js

@@ -99,7 +99,7 @@ return msg;`,
     res.json(jRet)
   })
 
-  function knxUltimateConfigNode (config) {
+  function knxUltimateConfigNode(config) {
     RED.nodes.createNode(this, config)
     const node = this
     node.host = config.host
@@ -170,7 +170,7 @@ return msg;`,
     }
 
     node.setAllClientsStatus = (_status, _color, _text) => {
-      function nextStatus (_oClient) {
+      function nextStatus(_oClient) {
         let oClient = RED.nodes.getNode(_oClient.id)
         oClient.setNodeStatus({ fill: _color, shape: 'dot', text: _status + ' ' + _text, payload: '', GA: oClient.topic, dpt: '', devicename: '' })
         oClient = null
@@ -216,7 +216,7 @@ return msg;`,
     // 04/04/2021 Supergiovane, creates the service paths where the persistent files are created.
     // The values file is stored only upon disconnection/close
     // ************************
-    function setupDirectory (_aPath) {
+    function setupDirectory(_aPath) {
       if (!fs.existsSync(_aPath)) {
         // Create the path
         try {
@@ -236,7 +236,7 @@ return msg;`,
       if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.info('KNXUltimate-config: payload cache set to ' + path.join(node.userDir, 'knxpersistvalues'))
     }
 
-    function saveExposedGAs () {
+    function saveExposedGAs() {
       const sFile = path.join(node.userDir, 'knxpersistvalues', 'knxpersist' + node.id + '.json')
       try {
         if (node.exposedGAs.length > 0) {
@@ -247,7 +247,7 @@ return msg;`,
         if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error('KNXUltimate-config: unable to write peristent values to the file ' + sFile + ' ' + err.message)
       }
     }
-    function loadExposedGAs () {
+    function loadExposedGAs() {
       const sFile = path.join(node.userDir, 'knxpersistvalues', 'knxpersist' + node.id + '.json')
       try {
         node.exposedGAs = JSON.parse(fs.readFileSync(sFile, 'utf8'))
@@ -262,6 +262,10 @@ return msg;`,
     // Endpoint for connecting to HUE Bridge
     RED.httpAdmin.get('/KNXUltimateRegisterToHueBridge', RED.auth.needsPermission('knxUltimate-config.read'), function (req, res) {
       try {
+        if (typeof req.query.nodeID !== 'undefined' && req.query.nodeID !== null && req.query.nodeID !== '') {
+          const _node = RED.nodes.getNode(req.query.nodeID)// Retrieve node.id of the config node.
+          if (_node !== null) res.json(RED.nodes.getNode(_node.id).csv)
+        }
         (async () => {
           try {
             // °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
@@ -272,20 +276,21 @@ return msg;`,
             const appName = 'KNXUltimate'
             const deviceName = 'Node-Red'
 
-            async function discoverBridge () {
-              const discoveryResults = await discovery.nupnpSearch()
+            // async function discoverBridge() {
+            //   const discoveryResults = await discovery.nupnpSearch()
 
-              if (discoveryResults.length === 0) {
-                if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error('Failed to resolve any Hue Bridges')
-                return null
-              } else {
-                // Ignoring that you could have more than one Hue Bridge on a network as this is unlikely in 99.9% of users situations
-                return discoveryResults[0].ipaddress
-              }
-            }
+            //   if (discoveryResults.length === 0) {
+            //     if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.error('Failed to resolve any Hue Bridges')
+            //     return null
+            //   } else {
+            //     // Ignoring that you could have more than one Hue Bridge on a network as this is unlikely in 99.9% of users situations
+            //     return discoveryResults[0].ipaddress
+            //   }
+            // }
 
-            async function discoverAndCreateUser () {
-              const ipAddress = await discoverBridge()
+            async function discoverAndCreateUser() {
+              // const ipAddress = await discoverBridge()
+              const ipAddress = req.query.IP
 
               // Create an unauthenticated instance of the Hue API so that we can create a new user
               const unauthenticatedApi = await hueApi.createLocal(ipAddress).connect()
@@ -533,7 +538,7 @@ return msg;`,
     }
 
     // 17/02/2020 Do initial read (called by node.timerDoInitialRead timer)
-    function DoInitialReadFromKNXBusOrFile () {
+    function DoInitialReadFromKNXBusOrFile() {
       if (node.linkStatus !== 'connected') return // 29/08/2019 If not connected, exit
       loadExposedGAs() // 04/04/2021 load the current values of GA payload
       try {
@@ -893,7 +898,7 @@ return msg;`,
 
     // Handle BUS events
     // ---------------------------------------------------------------------------------------
-    function handleBusEvents (_datagram, _echoed) {
+    function handleBusEvents(_datagram, _echoed) {
       // console.time('handleBusEvents');
 
       let _rawValue = null
@@ -1161,7 +1166,7 @@ return msg;`,
       node.telegramsQueue.unshift(_clonedMessage) // Add _clonedMessage as first in the queue pile
     }
 
-    function handleTelegramQueue () {
+    function handleTelegramQueue() {
       if (node.knxConnection !== null || node.host.toUpperCase() === 'EMULATE') {
         if (node.lockHandleTelegramQueue === true) return // Exits if the funtion is busy
         node.lockHandleTelegramQueue = true // Lock the function. It cannot be called again until finished.
@@ -1310,14 +1315,14 @@ return msg;`,
     }
 
     // 14/08/2019 If the node has payload same as the received telegram, return false
-    function checkRBEInputFromKNXBusAllowSend (_node, _KNXTelegramPayload) {
+    function checkRBEInputFromKNXBusAllowSend(_node, _KNXTelegramPayload) {
       if (_node.inputRBE !== true) return true
 
       return !_.isEqual(_node.currentPayload, _KNXTelegramPayload)
     }
 
     // 26/10/2019 Try to figure out the datapoint type from raw value
-    function tryToFigureOutDataPointFromRawValue (_rawValue) {
+    function tryToFigureOutDataPointFromRawValue(_rawValue) {
       // 25/10/2019 Try some Datapoints
       if (_rawValue === null) return '1.001'
       if (_rawValue.length === 1) {
@@ -1363,7 +1368,7 @@ return msg;`,
       }
     }
 
-    function buildInputMessage ({ _srcGA, _destGA, _event, _Rawvalue, _inputDpt, _devicename, _outputtopic, _oNode }) {
+    function buildInputMessage({ _srcGA, _destGA, _event, _Rawvalue, _inputDpt, _devicename, _outputtopic, _oNode }) {
       let sPayloadmeasureunit = 'unknown'
       let sDptdesc = 'unknown'
       let sPayloadsubtypevalue = 'unknown'
@@ -1470,7 +1475,7 @@ return msg;`,
       }
     };
 
-    function readCSV (_csvText) {
+    function readCSV(_csvText) {
       // 26/05/2023 check if the text is a file path
       if (_csvText.toUpperCase().includes('.CSV') || _csvText.toUpperCase().includes('.ESF')) {
         // I'ts a file. Read it now and pass to the _csvText
@@ -1564,7 +1569,7 @@ return msg;`,
       }
     }
 
-    function readESF (_esfText) {
+    function readESF(_esfText) {
       // 24/02/2020 must do an EIS to DPT conversion.
       // https://www.loxone.com/dede/kb/eibknx-datentypen/
       // Format: Attuatori luci.Luci primo piano.0/0/1	Luce camera da letto	EIS 1 'Switching' (1 Bit)	Low
@@ -1648,7 +1653,7 @@ return msg;`,
     }
 
     // 23/08/2019 Delete unwanted CRLF in the GA description
-    function correctCRLFInCSV (_csv) {
+    function correctCRLFInCSV(_csv) {
       let sOut = '' // fixed output text to return
       let sChar = ''
       let bStart = false
@@ -1681,7 +1686,7 @@ return msg;`,
     }
 
     // 26/02/2021 Used to send the messages if the node gateway is in EMULATION mode
-    function sendEmulatedTelegram (_msg) {
+    function sendEmulatedTelegram(_msg) {
       // INPUT IS
       // _msg = {
       //     grpaddr: '5/0/1',

package/nodes/knxUltimateHueLight.html

@@ -52,6 +52,13 @@
             GALightColorCycle: { value: "" },
             dptLightColorCycle: { value: "" },
 
+            colorAtSwitchOnDayTime: { value: '{"red":255, "green":255, "blue":255}' },
+            colorAtSwitchOnNightTime: { value: '{"red":23, "green":4, "blue":0}' },
+
+            nameDaylightSensor: { value: "" },
+            GADaylightSensor: { value: "" },
+            dptDaylightSensor: { value: "" },
+
             hueDevice: { value: "" }
         },
         inputs: 0,
@@ -607,6 +614,53 @@
             // ########################
 
 
+            // DPT Day/Time sensor
+            // ########################
+            $.getJSON('knxUltimateDpts', (data) => {
+                data.forEach(dpt => {
+                    if (dpt.value.startsWith("1.")) {
+                        $("#node-input-dptDaylightSensor").append($("<option></option>")
+                            .attr("value", dpt.value)
+                            .text(dpt.text))
+                    }
+                });
+                $("#node-input-dptDaylightSensor").val(this.dptDaylightSensor)
+            })
+
+            // Autocomplete suggestion with ETS csv File
+            $("#node-input-GADaylightSensor").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-nameDaylightSensor').val(sDevName);
+                    var optVal = $("#node-input-dptDaylightSensor option:contains('" + ui.item.label.split("#")[2].trim() + "')").attr('value');
+                    // Select the option value 
+                    $("#node-input-dptDaylightSensor").val(optVal);
+                }
+            });
+            // ########################
+
+
 
             // Autocomplete suggestion with HUE Lights
             $("#node-input-name").autocomplete({
@@ -727,6 +781,33 @@
             <label for="node-input-nameLightState" style="width:50px; margin-left: 0px; text-align: right;"><span data-i18n="knxUltimateHueLight.node-input-name"></span></label>
             <input type="text" id="node-input-nameLightState" style="width:200px;margin-left: 5px; text-align: left;">
         </div>
+        
+        <div class="form-row">
+            <label for="node-input-nameDaylightSensor" style="width:100px;"><i class="fa fa-clock-o"></i> Day/Night</label>
+
+            <label for="node-input-GADaylightSensor" style="width:20px;">GA</label>
+            <input type="text" id="node-input-GADaylightSensor" placeholder="Ex: 1/1/1" style="width:70px;margin-left: 5px; text-align: left;">
+        
+            <label for="node-input-dptDaylightSensor" style="width:40px; margin-left: 0px; text-align: right;">DPT</label>
+            <select id="node-input-dptDaylightSensor" style="width:140px;"></select>
+        
+            <label for="node-input-nameDaylightSensor" style="width:50px; margin-left: 0px; text-align: right;"><span data-i18n="knxUltimateHueLight.node-input-name"></span></label>
+            <input type="text" id="node-input-nameDaylightSensor" style="width:200px;margin-left: 5px; text-align: left;">
+        </div>
+
+        <div class="form-row">
+            <label for="node-input-colorAtSwitchOnDayTime" style="width:200px">
+                <i class="fa fa-sun-o"></i> Switch on color at Daytime
+            </label>
+            <input type="text" id="node-input-colorAtSwitchOnDayTime" placeholder='{"red":255, "green":255, "blue":255}' style="width:250px">            
+        </div>
+        <div class="form-row">
+            <label for="node-input-colorAtSwitchOnNightTime" style="width:200px">
+                <i class="fa fa-moon-o"></i> Switch on color at Nighttime
+            </label>
+            <input type="text" id="node-input-colorAtSwitchOnNightTime" placeholder='{"red":100, "green":0, "blue":50}' style="width:250px">            
+        </div>
+        
       </p>
     </div>
     <div id="tabs-2">
@@ -891,7 +972,9 @@ Start typing in the GA field, the name or group address of your KNX device, the
 | 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. |
 | 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. |
-
+| Day/Night | *true* if daytime, *false* if nighttime. This GA is used to change some behaviours at day or night. |
+| Switch on color at Daytime | You can choose the color/brightness of your light, at switch on, on night time. Set it as JSON object, like { "red": 255, "green": 255, "blue": 255 } |
+| Switch on color at Nighttime | You can choose the color/brightness of your light, at switch on, on night time. Set it as JSON object, like { "red": 100, "green": 0, "blue": 0 } |
 <br/>
 
 [Find it useful?](https://www.paypal.me/techtoday)

package/nodes/knxUltimateHueLight.js

@@ -27,6 +27,7 @@ module.exports = function (RED) {
     node.formatnegativevalue = 'leave'
     node.formatdecimalsvalue = 2
     node.currentHUEDevice = undefined
+    node.DayTime = true
 
     // Used to call the status update from the config node.
     node.setNodeStatus = ({ fill, shape, text, payload }) => {
@@ -45,7 +46,20 @@ module.exports = function (RED) {
         switch (msg.knx.destination) {
           case config.GALightSwitch:
             msg.payload = dptlib.fromBuffer(msg.knx.rawValue, dptlib.resolve(config.dptLightSwitch))
-            state = msg.payload === true ? { on: { on: true },dimming: { brightness: 100 } } : { on: { on: false }, dimming: { brightness: 0 }}
+            if (msg.payload) {
+              let jColorChoosen = { red: 255, green: 255, blue: 255 }
+              if (node.DayTime) {
+                jColorChoosen = JSON.parse(config.colorAtSwitchOnDayTime || '{ "red": 255, "green": 255, "blue": 255 }')
+              } else {
+                jColorChoosen = JSON.parse(config.colorAtSwitchOnNightTime || '{ "red": 255, "green": 255, "blue": 255 }')
+              }
+              let dgamut = node.currentHUEDevice !== undefined ? node.currentHUEDevice.color.gamut_type : null
+              let dretXY = hueColorConverter.ColorConverter.rgbToXy(jColorChoosen.red, jColorChoosen.green, jColorChoosen.blue, dgamut)
+              let dbright = hueColorConverter.ColorConverter.getBrightnessFromRGB(jColorChoosen.red, jColorChoosen.green, jColorChoosen.blue)
+              state = dbright > 0 ? { on: { on: true }, dimming: { brightness: dbright }, color: { xy: dretXY } } : { on: { on: false } }
+            } else {
+              state = { on: { on: false } }
+            }
             node.serverHue.hueManager.writeHueQueueAdd(config.hueDevice, state, 'setLight')
             break
           case config.GALightDIM:
@@ -59,6 +73,9 @@ module.exports = function (RED) {
               node.startDimStopper('stop')
             }
             break
+          case config.GADaylightSensor:
+            node.DayTime = Boolean(dptlib.fromBuffer(msg.knx.rawValue, dptlib.resolve(config.dptDaylightSensor)))
+            break
           case config.GALightHSV:
             if (config.dptLightHSV === '3.007') {
               // MDT smartbutton will dim the color temperature

package/nodes/utils/hueUtils.js

@@ -245,20 +245,20 @@ class classHUE extends EventEmitter {
   }
 
   // Get the light details
-  getLightStatus = async (_rid) => { 
+  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) {      
-    }    
+    } catch (error) {
+    }
   }
 
   close = async () => {
     return new Promise((resolve, reject) => {
       try {
         this.closePushEventStream = true
-        this.es.close();
+        if (this.es !== null) this.es.close();
         this.es = null;
         setTimeout(() => {
           resolve(true)

package/package.json

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