node-red-contrib-knx-ultimate 2.0.12 → 2.0.14

package/CHANGELOG.md

@@ -6,13 +6,18 @@
 
 # CHANGELOG
 
+<p>
+<b>Version 2.0.13</b> - June 2023<br/>
+- HUE: CAUTION BREAKING CHANGES TO THE HUE NODES. PLEASE BE AWARE THAT HUE NODES ARE STILL IN BETA<br/>
+- Hue Button node: fixed missing events in output msg.<br/>
+</p>
 <p>
 <b>Version 2.0.12</b> - June 2023<br/>
 - HUE: CAUTION BREAKING CHANGES TO THE HUE NODES. PLEASE BE AWARE THAT HUE NODES ARE STILL IN BETA<br/>
 - NEW: Hue light sensor node.<br/>
 </p>
 <p>
-<b>Version 2.0.10</b> - June 2023<br/>
+<b>Version 2.0.11</b> - June 2023<br/>
 - HUE: CAUTION BREAKING CHANGES TO THE HUE NODES. PLEASE BE AWARE THAT HUE NODES ARE STILL IN BETA<br/>
 - Hotfix for Hue Button node, not retain property in config window.<br/>
 - Removed "Double Tap" event, because it doesn't exists yet.<br/>

package/KNXUltimate.code-workspace

@@ -11,13 +11,6 @@
 	],
 	"settings": {
 		
-  "editor.defaultFormatter": "rvest.vs-code-prettier-eslint",
-  "editor.formatOnPaste": false, // required 
-  "editor.formatOnType": false, // required
-  "editor.formatOnSave": true, // optional 
-  "editor.formatOnSaveMode": "file", // required to format on save
-  "files.autoSave": "onFocusChange", // optional but recommended
-  "vs-code-prettier-eslint.prettierLast": "false" // set as "true" to run 'prettier' last not first
 
 	}
 }

package/nodes/knxUltimateHueButton.js

@@ -63,27 +63,48 @@ module.exports = function (RED) {
       try {
         if (_event.id === config.hueDevice) {
           const knxMsgPayload = {}
-
-          // Switch
-          if (_event.button.last_event === 'short_release') {
-            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() + ')' })
-          }
-          // Dim
-          if (_event.button.last_event === '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 })
+          // Handling events with toggles
+          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
+              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
+              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
+              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
+              break
+            case 'short_release':
+              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() + ')' })
+              // 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 })
+              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 })
+              break
+            default:
+              break
           }
 
           // Setup the output msg

package/nodes/knxUltimateHueLightSensor.js

@@ -44,7 +44,7 @@ module.exports = function (RED) {
           knxMsgPayload.dpt = config.dptlightsensor
 
           if (_event.hasOwnProperty('light') && _event.light.hasOwnProperty('light_level')) {
-            knxMsgPayload.payload = 10 ** ((_event.light.light_level - 1) / 10000)
+            knxMsgPayload.payload = Math.round(10 ** ((_event.light.light_level - 1) / 10000))
             // 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() + ')' })

package/nodes/knxUltimateHueTemperatureSensor.html

@@ -0,0 +1,256 @@
+<script type="text/javascript">
+    RED.nodes.registerType('knxUltimateHueTemperatureSensor', {
+        category: "KNX Ultimate",
+        color: '#C7E9C0',
+        defaults: {
+            //buttonState: {value: true},
+            server: { type: "knxUltimate-config", required: false },
+            serverHue: { type: "hue-config", required: true },
+            name: { value: "" },
+
+            nametemperaturesensor: { value: "" },
+            GAtemperaturesensor: { value: "" },
+            dpttemperaturesensor: { value: "" },
+
+            hueDevice: { value: "" }
+        },
+        inputs: 0,
+        outputs: 1,
+        icon: "node-hue-icon.svg",
+        label: function () {
+            return (this.name);
+        },
+        paletteLabel: "Hue Temperature Sensor (beta)",
+        // button: {
+        //     enabled: function() {
+        //         // return whether or not the button is enabled, based on the current
+        //         // configuration of the node
+        //         return !this.changed
+        //     },
+        //     visible: function() {
+        //         // return whether or not the button is visible, based on the current
+        //         // configuration of the node
+        //         return this.hasButton
+        //     },
+        //     //toggle: "buttonState",
+        //     onclick: function() {}
+        // },
+        oneditprepare: function () {
+            var node = this;
+            var oNodeServer = RED.nodes.node($("#node-input-server").val()); // Store the config-node
+            var oNodeServerHue = RED.nodes.node($("#node-input-serverHue").val()); // Store the config-node
+
+            // 19/02/2020 Used to get the server sooner als deploy.
+            $("#node-input-server").change(function () {
+                try {
+                    oNodeServer = RED.nodes.node($(this).val());
+                } catch (error) { }
+            });
+            // 19/02/2020 Used to get the server sooner als deploy.
+            $("#node-input-serverHue").change(function () {
+                try {
+                    oNodeServerHue = RED.nodes.node($(this).val());
+                } catch (error) { }
+            });
+
+            // 31/03/2020 Search Helper
+            function fullSearch(sourceText, searchString) {
+                // This searches for all words in a string
+                var aSearchWords = searchString.toLowerCase().split(" ");
+                var i = 0;
+                for (let index = 0; index < aSearchWords.length; index++) {
+                    if (sourceText.toLowerCase().indexOf(aSearchWords[index]) > -1) i += 1;
+                }
+                return i == aSearchWords.length;
+            }
+
+            // DPT 
+            // ########################
+            $.getJSON('knxUltimateDpts', (data) => {
+                data.forEach(dpt => {
+                    if (dpt.value.startsWith("9.001")) {
+                        $("#node-input-dpttemperaturesensor").append($("<option></option>")
+                            .attr("value", dpt.value)
+                            .text(dpt.text))
+                    }
+                });
+                $("#node-input-dpttemperaturesensor").val(this.dpttemperaturesensor)
+            })
+
+            // Autocomplete suggestion with ETS csv File
+            $("#node-input-GAtemperaturesensor").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 + " 9.001")) {
+                                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-nametemperaturesensor').val(sDevName);
+                    var optVal = $("#node-input-dpttemperaturesensor option:contains('" + ui.item.label.split("#")[2].trim() + "')").attr('value');
+                    // Select the option value 
+                    $("#node-input-dpttemperaturesensor").val(optVal);
+                }
+            });
+            // ######################## 
+
+
+
+
+            // Autocomplete suggestion with HUE
+            $("#node-input-name").autocomplete({
+                minLength: 1,
+                source: function (request, response) {
+                    $.getJSON("KNXUltimateGetDevicesHUE?rtype=temperature&nodeID=" + oNodeServerHue.id, (data) => {
+                        response($.map(data.devices, function (value, key) {
+                            //alert(JSON.stringify(value) + " "+ key)
+                            var sSearch = (value.name);
+                            if (fullSearch(sSearch, request.term)) {
+                                return {
+                                    hueDevice: value.id, // Label for Display
+                                    value: value.name // Value
+                                }
+                            } else {
+                                return null;
+                            }
+                        }));
+                    });
+                }, select: function (event, ui) {
+                    // Sets the fields
+                    $('#node-input-hueDevice').val(ui.item.hueDevice);
+                }
+            });
+
+
+            // ########################
+
+
+        },
+        oneditsave: function () {
+
+
+        },
+        oneditcancel: function () {
+
+        }
+    })
+
+</script>
+
+<script type="text/x-red" data-template-name="knxUltimateHueTemperatureSensor">
+
+
+<div class="form-row">
+    <b>HUE Light Sensor node</b>&nbsp&nbsp<span style="color:red"
+    &nbsp<i class="fa fa-question-circle"></i></span>
+    &nbsp<a target="_blank" href="https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/en-hue-configuration"><u>Configuration</u></a> 
+    <br />
+    <p align="center"><img src='https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/hueMotion.png'></p>
+    <br />
+    <label for="node-input-server" >
+        <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAKnRFWHRDcmVhdGlvbiBUaW1lAEZyIDYgQXVnIDIwMTAgMjE6NTI6MTkgKzAxMDD84aS8AAAAB3RJTUUH3gYYCicNV+4WIQAAAAlwSFlzAAALEgAACxIB0t1+/AAAAARnQU1BAACxjwv8YQUAAACUSURBVHjaY2CgFZg5c+Z/ZEyWAZ8+f/6/ZsWs/xoamqMGkGrA6Wla/1+fVARjEBuGsSoGmY4eZSCNL59d/g8DIDbIAHR14OgFGQByKjIGKX5+6/T///8gGMQGiV1+/B0Fg70GIkD+RMYgxf/O5/7//2MSmAZhkBi6OrgB6Bg5DGB4ajr3f2xqsYYLSDE2THJUDg0AAAqyDVd4tp4YAAAAAElFTkSuQmCC"></img>
+        KNX GW
+    </label>
+    <input type="text" id="node-input-server" />
+</div>
+
+<div class="form-row">
+    <label for="node-input-serverHue">
+        <img src="data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAERlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAA6ABAAMAAAABAAEAAKACAAQAAAABAAAAEKADAAQAAAABAAAAEAAAAAA0VXHyAAABFUlEQVQ4EZWSsWoCQRCG1yiENEFEi6QSkjqWWoqFoBYJ+Br6JHkMn8Iibd4ihQpaJIhWNkry/ZtdGZY78Qa+m39nZ+dm9s4550awglNBluS/gVtAX6KgDclf68w2OThgfR9iT/jnoEv4TtByDThWTCDKW4SSZTf/zj9/eZbN+izTDuKGimu0vPF8B/YN8aC8LmcOj/AAn9CFTEs70Js/oGqy79C69bqJ5XbQI2kGO5N8QL9D08S8zBtBF5ZaVsznpCMoqJnVdjTpb1Db0fwIWmQV6BLXzFOYgA6/gDVfQN9bBWp2J2hdWDPoBV5FrKnAJutHikk/CHHR8i7x4iG7qQ720IYvu3GFbpHjx3pFrOFYkA354z/5bkK826phyAAAAABJRU5ErkJggg=="/>
+        HUE Bridge
+    </label>
+    <input type="text" id="node-input-serverHue" />
+</div>
+
+<br/>
+<p>
+<b>Philips HUE</b>
+</p>
+    
+<div class="form-row">
+    <label for="node-input-hueDevice" >
+        <i class="fa fa-play-circle"></i>&nbspHue Sensor</label>
+        <input type="text" id="node-input-name" placeholder="Enter your hue device name" />
+    <input type="hidden" id="node-input-hueDevice" />
+</div>
+
+<br/>
+
+<p>
+<b>PHILIPS HUE LIGHT EVENTS -> TO KNX</b>
+</p>
+
+    <div class="form-row">
+        <label for="node-input-nametemperaturesensor" style="width:100px;"><i class="fa fa-play-circle-o"></i> Lux</span></label>
+
+        <label for="node-input-GAtemperaturesensor" style="width:20px;">GA</label>
+        <input type="text" id="node-input-GAtemperaturesensor" placeholder="Ex: 1/1/1" style="width:70px;margin-left: 5px; text-align: left;">
+    
+        <label for="node-input-dpttemperaturesensor" style="width:40px; margin-left: 0px; text-align: right;">DPT</label>
+        <select id="node-input-dpttemperaturesensor" style="width:140px;"></select>
+    
+        <label for="node-input-nametemperaturesensor" style="width:50px; margin-left: 0px; text-align: right;">Name</label>
+        <input type="text" id="node-input-nametemperaturesensor" style="width:200px;margin-left: 5px; text-align: left;">
+    </div>
+   
+</div>
+        
+
+<br/>
+<br/>
+<br/>
+
+
+</script>
+
+<script type="text/markdown" data-help-name="knxUltimateHueTemperatureSensor">
+<p> This node lets you get the events from your HUE motion device.<br/>
+
+Here you can get the HUE Light Sensors light events, that represents a lux value, evetytime the ambient light changes.<br/>
+Start typing in the GA field, the name or group address of your KNX device, the avaiable devices start showing up while you're typing.
+
+**General**
+|Property|Description|
+|--|--|
+| KNX GW | Select the KNX gateway to be used |
+| HUE Bridge | Select the HUE Bridge to be used |
+| Hue Sensor | HUE sensor to be used. The avaiable buttons start showing up while you're typing.|
+
+**PHILIPS HUE LIGHT EVENTS -> TO KNX**
+|Property|Description|
+|--|--|
+| Lux | Lux value |
+
+### Outputs
+
+1. Standard output
+: payload (integer) : the standard output of the command.
+
+### Details
+
+`msg.payload` is used as the payload of the published message.  
+It contains the detailed event sent by your Hue devicem so you can use it for whatever you want.  
+
+<br/>
+
+[Find it useful?](https://www.paypal.me/techtoday)
+
+<br/>
+
+    </script>

package/nodes/knxUltimateHueTemperatureSensor.js

@@ -0,0 +1,88 @@
+module.exports = function (RED) {
+
+
+  function knxUltimateHueLightSensor(config) {
+    RED.nodes.createNode(this, config)
+    const node = this
+    node.server = RED.nodes.getNode(config.server)
+    node.serverHue = RED.nodes.getNode(config.serverHue)
+    node.topic = node.name
+    node.name = config.name === undefined ? 'Hue' : config.name
+    node.dpt = ''
+    node.notifyreadrequest = false
+    node.notifyreadrequestalsorespondtobus = 'false'
+    node.notifyreadrequestalsorespondtobusdefaultvalueifnotinitialized = ''
+    node.notifyresponse = false
+    node.notifywrite = true
+    node.initialread = true
+    node.listenallga = true // Don't remove
+    node.outputtype = 'write'
+    node.outputRBE = false // Apply or not RBE to the output (Messages coming from flow)
+    node.inputRBE = false // Apply or not RBE to the input (Messages coming from BUS)
+    node.currentPayload = '' // Current value for the RBE input and for the .previouspayload msg
+    node.passthrough = 'no'
+    node.formatmultiplyvalue = 1
+    node.formatnegativevalue = 'leave'
+    node.formatdecimalsvalue = 2
+
+
+
+    // Used to call the status update from the config node.
+    node.setNodeStatus = ({ fill, shape, text, payload }) => {
+
+    }
+
+    // This function is called by the knx-ultimate config node, to output a msg.payload.
+    node.handleSend = msg => {
+    }
+
+    node.handleSendHUE = _event => {
+      try {
+        if (_event.id === config.hueDevice) {
+          const knxMsgPayload = {}
+          knxMsgPayload.topic = config.GAlightsensor
+          knxMsgPayload.dpt = config.dptlightsensor
+
+          if (_event.hasOwnProperty('light') && _event.light.hasOwnProperty('light_level')) {
+            knxMsgPayload.payload = Math.round(10 ** ((_event.light.light_level - 1) / 10000))
+            // 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 = 'light_level'
+
+            // Send payload
+            knxMsgPayload.rawEvent = _event
+            node.send(knxMsgPayload)
+          }
+        }
+      } catch (error) {
+        node.status({ fill: 'red', shape: 'dot', text: 'HUE->KNX error ' + error.message + ' (' + new Date().getDate() + ', ' + new Date().toLocaleTimeString() + ')' })
+      }
+    }
+
+    // On each deploy, unsubscribe+resubscribe
+    if (node.server) {
+      node.server.removeClient(node)
+      node.server.addClient(node)
+    }
+    if (node.serverHue) {
+      node.serverHue.removeClient(node)
+      node.serverHue.addClient(node)
+    }
+
+    node.on('input', function (msg) {
+
+    })
+
+    node.on('close', function (done) {
+      if (node.server) {
+        node.server.removeClient(node)
+      }
+      done()
+    })
+  }
+  RED.nodes.registerType('knxUltimateHueLightSensor', knxUltimateHueLightSensor)
+}

package/nodes/utils/hueUtils.js

@@ -48,7 +48,10 @@ class classHUE extends EventEmitter {
         if (_rtype === 'light_level') {
           retArray.push({ name: 'Light Level: ' + linkedDevName + (Room !== undefined ? ', room ' + Room.metadata.name : ''), id: device.id })
         }
-
+        if (_rtype === 'temperature') {
+          retArray.push({ name: 'Temp: ' + linkedDevName + (Room !== undefined ? ', room ' + Room.metadata.name : ''), id: device.id })
+        }
+        
       })
       return { devices: retArray }
     } catch (error) {

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=14.0.0"
   },
-  "version": "2.0.12",
+  "version": "2.0.14",
   "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",
@@ -37,7 +37,8 @@
       "knxUltimateHueButton": "/nodes/knxUltimateHueButton.js",
       "knxUltimateHueMotion": "/nodes/knxUltimateHueMotion.js",
       "knxUltimateHueTapDial": "/nodes/knxUltimateHueTapDial.js",
-      "knxUltimateHueLightSensor": "/nodes/knxUltimateHueLightSensor.js"
+      "knxUltimateHueLightSensor": "/nodes/knxUltimateHueLightSensor.js",
+      "knxUltimateHueTemperatureSensor": "/nodes/knxUltimateHueTemperatureSensor.js"
     }
   },
   "repository": {