node-red-contrib-knx-ultimate 1.4.18 → 2.0.1

package/CHANGELOG.md

@@ -7,6 +7,15 @@
 # CHANGELOG
 
 <p>
+<b>Version 2.0.1</b> - June 2023<br/>
+- NEW: more KNX group addresses in the HUE Light node<br/>
+</p>
+<p>
+<b>Version 2.0.0</b> - June 2023<br/>
+- NEW Added HUE Light node. More HUE nodes to come. Please feel free to try it.<br/>
+- Global context node: in the node name, only chas a-z are now allowed, to overcome syntax errors.<br/>
+- As i spend 50% of my time to translate all documentation and node texts to 4 languages, i'll leave only English as main language, so you will see the UI only in English.<br/>
+</p>
 <b>Version 1.4.18</b> - Mai 2023<br/>
 - NEW: Gateway Config Node: Starting from version 1.4.18, you can also simply enter the path to the ETS exported file (e.g.: /home/pi/mycsv.csv), instead of pasting it's content.<br/>
 </p>

package/KNXEngine/dptlib/index.js

@@ -95,7 +95,7 @@ dpts.populateAPDU = function (value, apdu, dptid) {
       }
     }
     // generic APDU is assumed to convey an unsigned integer of arbitrary bitlength
-    if (dpt.basetype.hasOwnProperty('signedness') && dpt.basetype.signedness == 'signed') {
+    if (dpt.basetype.hasOwnProperty('signedness') && dpt.basetype.signedness === 'signed') {
       apdu.data.writeIntBE(tgtvalue, 0, nbytes)
     } else {
       apdu.data.writeUIntBE(tgtvalue, 0, nbytes)

package/KNXUltimate.code-workspace

@@ -9,5 +9,15 @@
 			"path": "../node-red-contrib-knx-ultimate.wiki"
 		}
 	],
-	"settings": {}
+	"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/README.md

@@ -35,6 +35,7 @@ msg.payload = {red:255, green:200, blue:30} // Put some colors in our life
 * **ALERTER node** [here](https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/Alerter-Configuration). With the Alerter node you can signal to a display or to the node-red-contrib-tts-ultimate node (audio feedback), whenever the selected devices are alerted, i.e. they have payload **true**.
 * **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 lights and sensors to KNX in a simple way.
 
 <br>
 <br>
@@ -62,13 +63,10 @@ High knowledge of cryptography and KNX is needed.
 
 ## HELP, SAMPLES, TROUBLESHOOT, WIKI, FAQ, BEST PRACTICES
 
-Click your language to go to the documentation.<br/>
 <a href="https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/Overview"><img src="https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/wiki/flags/usa-today.png"/></a>
-<a href="https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/de-Overview"><img src="https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/wiki/flags/germany.png"/></a>
-<a href="https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/it-Overview"><img src="https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/wiki/flags/italy.png"/></a>
-<a href="https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/cn-Overview"><img src="https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/wiki/flags/cn.png"/></a><br/>
 
-> Click a language above. Tons of documentation, samples, even for use in conjunction with <img width="90px" src="https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/homekit.png" > <img width="70px" src="https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/alexa.png" > <img width="90px" src="https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/googleassistant.png" >
+
+> Tons of documentation, samples, even for use in conjunction with <img width="90px" src="https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/homekit.png" > <img width="70px" src="https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/alexa.png" > <img width="90px" src="https://raw.githubusercontent.com/Supergiovane/node-red-contrib-knx-ultimate/master/img/googleassistant.png" >
 
 
 

package/nodes/hue-config.html

@@ -0,0 +1,132 @@
+<script type="text/javascript">
+    RED.nodes.registerType('hue-config', {
+        category: 'config',
+        defaults: {
+            host: { value: "" },
+            name: { value: "Hue Bridge" },
+            bridgeid: { value: "" }
+        },
+        credentials: {
+            username: { type: "password" },
+            clientkey: { type: "password" }
+        },
+        oneditprepare: function () {
+
+
+            $("#getinfocam").click(function () {
+
+                var myNotification = RED.notify("Please press the Link button on the HUE Bridge / Pre favore, premi il pulsante sul bridge HUE",
+                    {
+                        modal: true,
+                        fixed: true,
+                        type: 'info',
+                        buttons: [
+                            {
+                                text: "OK",
+                                click: function (e) {
+                                    // Send the infos to Supergiovane
+                                    $.getJSON("KNXUltimateRegisterToHueBridge", (data) => {
+                                        this.value = "Connect";
+                                        this.disabled = false;
+                                        if (data.hasOwnProperty("error")) {
+                                            RED.notify(JSON.stringify(data.error),
+                                                {
+                                                    modal: true,
+                                                    fixed: false,
+                                                    type: 'error'
+                                                });
+                                            this.disabled = true;
+                                            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-username").val(data.user.username);
+                                        $("#node-config-input-clientkey").val(data.user.clientkey);
+                                        $("#node-config-input-bridgeid").val(data.bridge.data.bridgeid);
+                                        
+                                    }).error(function (jqXHR, textStatus, errorThrown) {
+                                        RED.notify("Something went wrong. Please create at least a KNX Gateway node first.",
+                                            {
+                                                modal: false,
+                                                fixed: false,
+                                                type: 'error'
+                                            })
+                                    });
+                                    myNotification.close();
+                                }
+                            },
+                            {
+                                text: "CANCEL",
+                                click: function (e) {
+                                    myNotification.close();
+                                }
+                            }]
+                    });
+
+
+
+
+            });
+
+
+        },
+        oneditsave: function () {
+
+        },
+        label: function () {
+            return typeof this.name === undefined ? "Hue Bridge " + this.host : this.name + " " + this.host;
+        }
+    });
+</script>
+
+
+<script type="text/x-red" data-template-name="hue-config">
+    <div class="form-row">
+       <b><span data-i18n="hue-config.properties.title"></span></b>&nbsp&nbsp<span style="color:red" data-i18n="[html]hue-config.properties.helplink"></span>
+
+    <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>&nbsp&nbsp<span data-i18n="hue-config.properties.getinfocam"</span></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>
+        </label>
+        <input type="text" id="node-config-input-host"><data-i18n="[Title]hue-config.properties.host_info" style="margin-left:5px;">
+    </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>
+
+    
+    
+</script>

package/nodes/hue-config.js

@@ -0,0 +1,150 @@
+
+const dptlib = require('./../KNXEngine/dptlib')
+const hueClass = require('./utils/hueUtils').classHUE
+
+// Helpers
+const sortBy = (field) => (a, b) => {
+  if (a[field] > b[field]) { return 1 } else { return -1 }
+}
+
+const onlyDptKeys = (kv) => {
+  return kv[0].startsWith('DPT')
+}
+
+const extractBaseNo = (kv) => {
+  return {
+    subtypes: kv[1].subtypes,
+    base: parseInt(kv[1].id.replace('DPT', ''))
+  }
+}
+
+const convertSubtype = (baseType) => (kv) => {
+  const value = `${baseType.base}.${kv[0]}`
+  // let sRet = value + " " + kv[1].name + (kv[1].unit === undefined ? "" : " (" + kv[1].unit + ")");
+  const sRet = value + ' ' + kv[1].name
+  return {
+    value,
+    text: sRet
+  }
+}
+
+// 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 =
+    Object.entries(baseType.subtypes)
+      .sort(sortBy(0))
+      .map(convertSubtype(baseType))
+
+  return acc.concat(subtypes)
+}
+
+module.exports = (RED) => {
+  'use strict'
+
+  RED.httpAdmin.get('/knxUltimateDpts', RED.auth.needsPermission('hue-config.read'), function (req, res) {
+    const dpts =
+      Object.entries(dptlib)
+        .filter(onlyDptKeys)
+        .map(extractBaseNo)
+        .sort(sortBy('base'))
+        .reduce(toConcattedSubtypes, [])
+
+    res.json(dpts)
+    // Utilità per visualizzare i datapoints, da copiare in README
+    // var stringa = "";
+    // for (let index = 0; index < dpts.length; index++) {
+    //     const element = dpts[index];
+    //     stringa += element.text + "<br/>\n";
+    // }
+    // if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.warn(stringa)
+  })
+
+  function hueConfig(config) {
+    RED.nodes.createNode(this, config)
+    const node = this
+    node.host = config.host
+    node.nodeClients = [] // Stores the registered clients
+    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
+    } catch (error) { }
+    node.name = (config.name === undefined || config.name === '') ? node.host : config.name // 12/08/2021
+
+    // Init HUE Utility
+    node.hueManager = new hueClass(node.host, node.credentials.username, node.credentials.clientkey, config.bridgeid)
+
+    // Event clip V2
+    node.hueManager.on('event', _event => {
+      node.nodeClients.forEach(_oClient => {
+        const oClient = RED.nodes.getNode(_oClient.id)
+        oClient.handleSendHUE(_event)
+      })
+    })
+
+    // Endpoint for connecting to HUE Bridge
+    RED.httpAdmin.get('/KNXUltimateGetAllLightsHUE', RED.auth.needsPermission('hue-config.read'), function (req, res) {
+      try {
+        (async () => {
+          try {
+            // °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
+            const jRet = await node.hueManager.getAllLights()
+            res.json(jRet)
+            // °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
+          } catch (err) {
+            RED.log.error('Errore KNXUltimateGetAllLightsHUE non gestito ' + err.message)
+            res.json({ error: err.message })
+          }
+        })()
+      } catch (err) {
+        RED.log.error('Errore KNXUltimateGetAllLightsHUE bsonto ' + err.message)
+        res.json({ error: err.message })
+      }
+    })
+
+  
+    node.addClient = (_Node) => {
+      // 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: '' })
+        // 01/06/2023 Add node to the array
+        const jNode = {}
+        jNode.id = _Node.id
+        jNode.topic = _Node.topic
+        node.nodeClients.push(jNode)
+      }
+    }
+
+    node.removeClient = (_Node) => {
+      // Remove the client node from the clients array
+      try {
+        node.nodeClients = node.nodeClients.filter(x => x.id !== _Node.id)
+      } catch (error) { }
+    }
+
+    node.on('close', function (done) {
+      try {
+        if (node.sysLogger !== undefined && node.sysLogger !== null) node.sysLogger.destroy()
+        node.nodeClients = []
+      } catch (error) { }
+      done()
+    })
+  }
+
+  // RED.nodes.registerType("hue-config", hue-config);
+  RED.nodes.registerType('hue-config', hueConfig, {
+    credentials: {
+      username: { type: 'password' },
+      clientkey: { type: 'password' }
+    }
+  })
+}

package/nodes/icons/node-hue-icon.svg

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Generated by Pixelmator Pro 3.3.5 -->
+<svg width="40" height="60" viewBox="0 0 40 60" xmlns="http://www.w3.org/2000/svg">
+    <path id="philipshue-white" fill="#ffffff" stroke="none" d="M 33.730667 10.312656 C 30.495916 10.312656 28.181084 12.442097 27.900833 15.560974 L 26.849501 15.560974 C 26.458418 15.560974 26.224083 15.782215 26.224083 16.150951 C 26.224083 16.519684 26.458418 16.740925 26.849501 16.740925 L 27.896082 16.740925 C 28.136749 19.951984 30.511749 22 34.094833 22 C 35.5895 22 36.762749 21.778759 37.787167 21.304012 C 38.037334 21.188786 38.320747 20.970615 38.2495 20.580372 C 38.231464 20.428261 38.144367 20.291912 38.011997 20.208565 C 37.847332 20.1087 37.616165 20.097942 37.343834 20.177837 C 37.156597 20.235058 36.970768 20.296528 36.786499 20.362206 C 36.131001 20.586517 35.56575 20.781639 34.254749 20.781639 C 31.483917 20.781639 29.650415 19.209908 29.580751 16.779335 L 29.580751 16.740925 L 38.200417 16.740925 C 38.695999 16.740925 38.979416 16.488956 39 16.029575 L 39 15.940464 C 38.990498 10.719799 34.965668 10.312656 33.730667 10.312656 Z M 37.492668 15.560974 L 29.576 15.560974 L 29.582333 15.507202 C 29.773916 13.0797 31.420582 11.511044 33.776585 11.511044 C 35.572083 11.511044 37.492668 12.563473 37.492668 15.514885 Z M 16.108166 11.266758 C 16.108166 10.752064 15.799417 10.446323 15.284834 10.446323 C 14.770249 10.446323 14.4615 10.753601 14.4615 11.266758 L 14.4615 15.560974 L 16.108166 15.560974 Z M 22.900667 17.131168 C 22.900667 19.165356 21.399666 20.758595 19.480667 20.758595 C 17.21175 20.758595 16.108166 19.586327 16.108166 17.174187 L 16.108166 16.740925 L 14.4615 16.740925 L 14.4615 17.263298 C 14.4615 20.406761 15.989417 22 19.002501 22 C 20.775833 22 22.078917 21.253311 22.870583 19.779911 L 22.90225 19.724602 L 22.90225 21.047436 C 22.90225 21.560589 23.207834 21.86787 23.724001 21.86787 C 24.238583 21.86787 24.547333 21.560589 24.547333 21.047436 L 24.547333 16.740925 L 22.900667 16.740925 Z M 23.724001 10.446323 C 23.207834 10.446323 22.900667 10.753601 22.900667 11.266758 L 22.900667 15.560974 L 24.547333 15.560974 L 24.547333 11.266758 C 24.547333 10.752064 24.238583 10.446323 23.724001 10.446323 Z M 6.77125 10.312656 C 4.142917 10.312656 3.11375 11.959671 2.858833 12.463608 L 2.645083 12.890724 L 2.645083 6.863453 C 2.645083 6.330326 2.33 6 1.82175 6 C 1.315083 6 1 6.330326 1 6.863453 L 1 15.560974 L 2.645083 15.560974 L 2.645083 15.53793 C 2.645083 13.618973 3.785083 11.555599 6.293083 11.555599 C 8.335583 11.555599 9.461333 12.827732 9.461333 15.138466 L 9.461333 15.560974 L 11.108 15.560974 L 11.108 15.183022 C 11.108 12.042633 9.567416 10.312656 6.77125 10.312656 Z M 1 21.00288 C 1 21.536011 1.315083 21.86787 1.823333 21.86787 C 2.33 21.86787 2.645083 21.536011 2.645083 21.00288 L 2.645083 16.740925 L 1 16.740925 Z M 9.461333 21.00288 C 9.461333 21.536011 9.778 21.86787 10.284666 21.86787 C 10.791333 21.86787 11.108 21.536011 11.108 21.00288 L 11.108 16.740925 L 9.461333 16.740925 Z"/>
+    <g id="Gruppo">
+        <g id="g1">
+            <path id="Percorso" fill="#ffffff" stroke="#ffffff" stroke-width="0.5" d="M 39.5 38 L 30.299999 30.299999 C 29.799999 29.9 29 29.9 28.4 30.299999 C 28.200001 30.5 28 30.799999 28 31.1 L 28 34.400002 L 18.799999 34.400002 C 18.1 34.400002 17.5 34.900002 17.5 35.5 C 17.5 36.099998 18.1 36.599998 18.799999 36.599998 L 29.299999 36.599998 C 30 36.599998 30.6 36.099998 30.6 35.5 L 30.6 33.799999 L 36.599998 38.799999 L 30.6 43.799999 L 30.6 42.099998 C 30.6 41.5 30 41 29.299999 41 L 14.9 41 L 14.9 37.700001 C 14.9 37.099998 14.3 36.599998 13.6 36.599998 C 13.3 36.599998 12.9 36.700001 12.7 36.900002 L 3.5 44.599998 C 3 45 3 45.700001 3.5 46.200001 L 12.7 53.900002 C 12.9 54.099998 13.3 54.200001 13.6 54.200001 C 13.8 54.200001 13.9 54.200001 14.1 54.099998 C 14.6 53.900002 14.9 53.5 14.9 53.099998 L 14.9 49.799999 L 24.1 49.799999 C 24.799999 49.799999 25.4 49.299999 25.4 48.700001 C 25.4 48.099998 24.799999 47.599998 24.1 47.599998 L 13.6 47.599998 C 12.9 47.599998 12.3 48.099998 12.3 48.700001 L 12.3 50.400002 L 6.3 45.400002 L 12.3 40.400002 L 12.3 42.099998 C 12.3 42.700001 12.9 43.200001 13.6 43.200001 L 28 43.200001 L 28 46.5 C 28 47.099998 28.6 47.599998 29.299999 47.599998 C 29.6 47.599998 30 47.5 30.200001 47.299999 L 39.400002 39.599998 C 40 39.200001 40 38.5 39.5 38 Z"/>
+        </g>
+    </g>
+</svg>