node-red-contrib-knx-ultimate 2.4.10 → 2.4.12

package/CHANGELOG.md

@@ -6,9 +6,10 @@
 
 # CHANGELOG
 
-**Version 2.4.10** - March 2024<br/>
+**Version 2.4.12** - April 2024<br/>
 - Warning: this version uses the Node-Red plugin system; the  Node-Red version must be **equals or major than 3.1.1**<br/>
-- NEW: Home Assistant translator node: translates the HA input msg, to a KNX value. Comes with a built.in translation table, that's user editable.<br/>
+- NEW: Home Assistant translator node: translates the HA input msg, to a KNX value. Comes with a built-in translation table, that's user editable.<br/>
+- NEW: HUE Contact Sensor node.<br/>
 - Updated KNX-Ultimate device node help.<br/>
 - Minor KNX-Ultimate device node UI changes.<br/>
 

package/README.md

@@ -38,7 +38,7 @@ msg.payload = {red:255, green:200, blue:30} // Put some colors in our life
 * **LOAD CONTROL node** [here](https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/LoadControl-Configuration). Control your loads (Oven, Washing machine, etc..) and avoit shutting down the main voltage due to too high power consumption.
 * **VIEWER node** [here](https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/knxUltimateViewer). View all Group Addresses and values of your KNX BUS, in the Node-Red Dashboard.
 * **PHILIPS HUE nodeset** [here](https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/en-hue-configuration). Link HUE devices to KNX in a simple way.
-* **Homeassistant translator node** translates the HA input msg, to a KNX value. Comes with a built.in translation table, that's user editable.
+* **HOME ASSISTANT translator node** translates the HA input msg, to a KNX value. Comes with a built-in translation table, that's user editable.
 
 
 <br>

package/nodes/hue-config.js

@@ -317,6 +317,14 @@ module.exports = (RED) => {
               //const zigbee = node.hueAllResources.filter((a) => a.services !== undefined).find((a) => a.services.rtype === "zigbee_connectivity");
               //const devs = zigbee.filter((a) => a.rtype === "zigbee_connectivity");
             }
+            if (_rtype === 'contact') {
+              const Room = node.hueAllRooms.find((room) => room.children.find((child) => child.rid === resource.owner.rid))
+              const linkedDevName = node.hueAllResources.find((dev) => dev.type === 'device' && dev.services.find((serv) => serv.rid === resource.id)).metadata.name || ''
+              retArray.push({
+                name: `Contact: ${linkedDevName}${Room !== undefined ? `, room ${Room.metadata.name}` : ''}`,
+                id: resource.id,
+              });
+            }
           } catch (error) {
             retArray.push({
               name: `${_rtype}: ERROR ${error.message}`,

package/nodes/knxUltimateHueContactSensor.html

@@ -0,0 +1,257 @@
+<script type="text/javascript" src="resources/node-red-contrib-knx-ultimate/11f26b4500.js"></script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('knxUltimateHueContactSensor', {
+        category: 'KNX Ultimate',
+        color: '#C0C7E9',
+        defaults: {
+            //buttonState: {value: true},
+            server: { type: 'knxUltimate-config', required: false },
+            serverHue: { type: 'hue-config', required: true },
+            name: { value: '' },
+
+            namecontact: { value: '' },
+            GAcontact: { value: '' },
+            dptcontact: { value: '' },
+
+            hueDevice: { value: '' },
+        },
+        inputs: 0,
+        outputs: 1,
+        icon: 'node-hue-icon.svg',
+        label: function () {
+            return (this.name || 'Hue Contact Sensor')
+        },
+        paletteLabel: 'Hue Contact Sensor',
+        // 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?serverId=' + $('#node-input-server').val(), (data) => {
+                data.forEach(dpt => {
+                    if (dpt.value.startsWith('1.')) {
+                        $('#node-input-dptcontact').append($('<option></option>')
+                            .attr('value', dpt.value)
+                            .text(dpt.text))
+                    }
+                })
+                $('#node-input-dptcontact').val(this.dptcontact)
+            })
+
+            // Autocomplete suggestion with ETS csv File
+            $('#node-input-GAcontact').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-namecontact').val(sDevName)
+                    var optVal = $('#node-input-dptcontact option:contains(\'' + ui.item.label.split('#')[2].trim() + '\')').attr('value')
+                    // Select the option value
+                    $('#node-input-dptcontact').val(optVal)
+                },
+            })
+            // ########################
+
+
+            // Autocomplete suggestion with HUE
+            $('#node-input-name').autocomplete({
+                minLength: 1,
+                source: function (request, response) {
+                    $.getJSON('KNXUltimateGetResourcesHUE?rtype=contact&serverId=' + 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/html" data-template-name="knxUltimateHueContactSensor">
+  <div class="form-row">
+    <b>HUE Motion node&nbsp&nbsp</b>
+    <span style="color:red">&nbsp<i class="fa fa-youtube"></i>&nbsp</span>
+    <a target="_blank" href="https://youtu.be/jjEUI1J8bkA">
+      <u>Youtube sample</u>
+    </a>
+    <br />
+    <br />
+    <p align="center">
+      <i class="fa-regular fa-door-open fa-shake fa-4x"></i>
+    </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>KNX</b>
+  </p>
+
+  <div class="form-row">
+    <label for="node-input-namecontact" style="width:100px;"><i class="fa fa-play-circle-o"></i> Contact</span></label>
+
+    <label for="node-input-GAcontact" style="width:20px;">GA</label>
+    <input type="text" id="node-input-GAcontact" placeholder="Ex: 1/1/1"
+           style="width:70px;margin-left: 5px; text-align: left;">
+
+    <label for="node-input-dptcontact" style="width:40px; margin-left: 0px; text-align: right;">DPT</label>
+    <select id="node-input-dptcontact" style="width:140px;"></select>
+
+    <label for="node-input-namecontact" style="width:50px; margin-left: 0px; text-align: right;">Name</label>
+    <input type="text" id="node-input-namecontact" style="width:200px;margin-left: 5px; text-align: left;">
+  </div>
+
+  <br />
+  <br />
+  <br />
+</script>
+
+<script type="text/markdown" data-help-name="knxUltimateHueContactSensor">
+  This node lets you get the events from your HUE contact sensor.
+
+  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 contact sensor to be used. The avaiable contact sensors start showing up while you're typing.|
+
+  |Property|Description|
+  |--|--|
+  | Contact | As soon as a contact sensor is being opene/closed, a *true* KNX value is sent to this group address, otherwise *false* is sent. |
+
+  ### Outputs
+
+  1. Standard output
+  : payload (boolean) : 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 device so you can use it for whatever you want.
+
+  <br/>
+
+  [Find it useful?](https://www.paypal.me/techtoday)
+
+  <br/>
+
+</script>

package/nodes/knxUltimateHueContactSensor.js

@@ -0,0 +1,129 @@
+module.exports = function (RED) {
+    function knxUltimateHueContactSensor(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
+        node.hueDevice = config.hueDevice
+        node.initializingAtStart = false
+
+        // Used to call the status update from the config node.
+        node.setNodeStatus = ({ fill, shape, text, payload }) => {
+        }
+        // Used to call the status update from the HUE config node.
+        node.setNodeStatusHue = ({ fill, shape, text, payload }) => {
+            if (payload === undefined) payload = ''
+            const dDate = new Date()
+            payload = typeof payload === 'object' ? JSON.stringify(payload) : payload.toString()
+            node.status({
+                fill,
+                shape,
+                text: `${text} ${payload} (${dDate.getDate()}, ${dDate.toLocaleTimeString()})`,
+            })
+        }
+
+        // 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) {
+
+                    if (!_event.hasOwnProperty('contact_report')) {
+                        return
+                    }
+
+                    const knxMsgPayload = {}
+                    knxMsgPayload.topic = config.GAcontact
+                    knxMsgPayload.dpt = config.dptcontact
+
+                    if (_event.hasOwnProperty('contact_report')) {
+                        knxMsgPayload.payload = _event.contact_report.state === 'contact'
+
+                        // 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()})`,
+                        })
+
+                        // Set up the output msg
+                        knxMsgPayload.name = node.name
+                        knxMsgPayload.event = 'contact'
+
+                        // Send payload
+                        knxMsgPayload.rawEvent = _event
+                        node.send(knxMsgPayload)
+                        node.setNodeStatusHue({
+                            fill: 'blue',
+                            shape: 'ring',
+                            text: 'HUE->KNX',
+                            payload: knxMsgPayload.payload,
+                        })
+                    }
+                }
+            } 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', (msg) => {
+        })
+
+        node.on('close', (done) => {
+            if (node.server) {
+                node.server.removeClient(node)
+            }
+            if (node.serverHue) {
+                node.serverHue.removeClient(node)
+            }
+            done()
+        })
+    }
+
+    RED.nodes.registerType('knxUltimateHueContactSensor', knxUltimateHueContactSensor)
+}

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "2.4.10",
+  "version": "2.4.12",
   "description": "Control your KNX intallation via Node-Red! A bunch of KNX nodes, with integrated Philips HUE control and ETS group address importer. Easy to use and highly configurable.",
   "dependencies": {
     "binary-parser": "2.2.1",
@@ -45,6 +45,7 @@
       "knxUltimateHueScene": "/nodes/knxUltimateHueScene.js",
       "knxUltimateHueBattery": "/nodes/knxUltimateHueBattery.js",
       "knxUltimateHueZigbeeConnectivity": "/nodes/knxUltimateHueZigbeeConnectivity.js",
+      "knxUltimateContactSensor": "/nodes/knxUltimateHueContactSensor.js",
       "knxUltimateHATranslator": "/nodes/knxUltimateHATranslator.js"
     }
   },