node-red-contrib-knx-ultimate 2.3.4 → 2.4.1

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,6 +1,6 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Signal a bug
 title: ''
 labels: ''
 assignees: Supergiovane
@@ -10,26 +10,26 @@ assignees: Supergiovane
 **Salutation (i'll not respond to users that doesn’t wrote at least "Hello")**
 
 **Describe the bug**
-A clear and concise description of what the bug is.
+Write here a clear and concise description of what the bug is.
 
 **To Reproduce**
-Steps to reproduce the behavior:
+Write here the steps to reproduce the behavior, for example:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
 **Expected behavior**
-A clear and concise description of what you expected to happen.
+Write here a clear and concise description of what you expected to happen.
 
 **Screenshots**
-If applicable, add screenshots to help explain your problem.
+Here, if applicable, add screenshots to help explain your problem.
 
 **Knx-Ultimate Version**
- - Eg. 1.1.95
+ - Eg. 2.3.5
 
 **Are you running node-red behind homematic, docker or anything similar?**
  - Eg. Node-Red running alone in RaspberryPi
 
 **Additional context**
-Add any other context about the problem here.
+Write here any other context about the problem here.

package/CHANGELOG.md

@@ -6,6 +6,35 @@
 
 # CHANGELOG
 
+**Version 2.4.1** - Jan 2024<br/>
+- NEW: Added KNX Datapoint 275.100<br/>
+- HUE Light: fixed https://github.com/Supergiovane/node-red-contrib-knx-ultimate/issues/317<br/>
+- HUE Light: corrected the 7.600 kelvin range https://github.com/Supergiovane/node-red-contrib-knx-ultimate/issues/316<br/>
+- HUE Light: blinking effect and color cyle are now stopped, whenever an FALSE KNX telegram is received by the light switching group address.<br/>
+- HUE Light: when the light is off, the dim up sequence starts now with initial brightness = zero.<br/>
+- KNX Engine: moved all HTTP calls to a single js file, loaded at startup, to avoid multi KNX gateway or multi HUE bridges issues.<br/>
+- Minor fixes.<br/>
+
+**Version 2.4.0-beta.1** - Jan 2024<br/>
+- This is a public installable beta.<br/>
+- HUE Light: fixed https://github.com/Supergiovane/node-red-contrib-knx-ultimate/issues/317<br/>
+- HUE Light: corrected the 7.600 kelvin range https://github.com/Supergiovane/node-red-contrib-knx-ultimate/issues/316<br/>
+- HUE Light: blinking effect and color cyle are now stopped, whenever an FALSE KNX telegram is received by the light switching group address.<br/>
+- HUE Light: when the light is off, the dim up sequence starts now with initial brightness = zero.<br/>
+- KNX Engine: moved all HTTP calls to a single js file, loaded at startup, to avoid multi KNX gateway or multi HUE bridges issues.<br/>
+- Minor fixes.<br/>
+
+**Version 2.4.0-beta.0** - Jan 2024<br/>
+- THIS IS A BETA VERSION. INSTALL ONLY IF YOU HAVE MANY HUE BRIDGES.<br/>
+- HUE Light: fixed https://github.com/Supergiovane/node-red-contrib-knx-ultimate/issues/317<br/>
+- HUE Light: corrected the 7.600 kelvin range https://github.com/Supergiovane/node-red-contrib-knx-ultimate/issues/316<br/>
+- HUE Light: blinking effect and color cyle are now stopped, whenever an FALSE KNX telegram is received by the light switching group address.<br/>
+- HUE Light: when the light is off, the dim up sequence starts now with initial brightness = zero.<br/>
+- KNX Engine: moved all HTTP calls to a single js file, loaded at startup, to avoid multi KNX gateway or multi HUE bridges issues.<br/>
+
+**Version 2.3.5** - Jan 2024<br/>
+- HUE Light: fixed multi HUE Bridge GUI issue.<br/>
+
 **Version 2.3.4** - Jan 2024<br/>
 - HUE Light: fixex tab "DIM/Brightness" inaccessible, when "KNX Brightness Status" was set to use the default knx behaviour.<br/>
 

package/KNXEngine/CHANGELOG.md

@@ -7,7 +7,11 @@
 # CHANGELOG
 
 <p>
-<b>Version 1.0.43</b> - December 2023<br/>
+<b>Version 1.0.46</b> - January 2024<br/>
+- NEW: added DPT 275.100.<br/>
+</p>
+<p>
+<b>Version 1.0.44</b> - December 2023<br/>
 - Fixed DPT 9.001 issue when sending numberso having > 2 decimals.<br/>
 </p>
 <p>

package/KNXEngine/package.json

@@ -1,7 +1,7 @@
 {
   "name": "knxultimate",
   "description": "KNX IP protocol implementation for Node. This is the ENGINE of Node-Red KNX-Ultimate node.",
-  "version": "1.0.44",
+  "version": "1.0.46",
   "engines": {
     "node": ">=14"
   },

package/KNXEngine/src/dptlib/dpt275.js

@@ -0,0 +1,60 @@
+/* eslint-disable no-prototype-builtins */
+/**
+* KNXEngine - a KNX protocol stack in Javascript
+* (C) 2020-2024 Supergiovane
+*/
+
+const knxLog = require("../KnxLog");
+const dpt9 = require("./dpt9");
+
+//
+// 4x DPT9.* 2-byte floating point value
+//
+
+exports.formatAPDU = function (value) {
+  // Get the javascript object and create a telegram for the KNX bus.
+  if (typeof value === 'object' && value.hasOwnProperty('comfort') && value.hasOwnProperty('standby') && value.hasOwnProperty('economy') && value.hasOwnProperty('buildingProtection')) {
+    const comfort = dpt9.formatAPDU(value.comfort);
+    const standby = dpt9.formatAPDU(value.standby);
+    const economy = dpt9.formatAPDU(value.economy);
+    const buildingProtection = dpt9.formatAPDU(value.buildingProtection);
+    return Buffer.concat([comfort, standby, economy, buildingProtection]);
+  } else {
+    knxLog.get().error('DPT275.formatAPDU: Must supply all values, for example {comfort:22, standby:21.5, economy:21, buildingProtection:15}');
+  }
+}
+
+exports.fromBuffer = function (buf) {
+  // Get the telegram from the KNX bus and create a javascript object.
+  if (buf.length !== 8) {
+    knxLog.get().warn('DPT275.fromBuffer: buf should be 8 bytes long (got %d bytes)', buf.length);
+    return null;
+  }
+  const comfort = dpt9.fromBuffer(buf.slice(0, 2));
+  const standby = dpt9.fromBuffer(buf.slice(2, 4));
+  const economy = dpt9.fromBuffer(buf.slice(4, 6));
+  const buildingProtection = dpt9.fromBuffer(buf.slice(6, 8));
+  return { comfort: comfort, standby: standby, economy: economy, buildingProtection: buildingProtection };
+}
+
+// DPT275 basetype info
+exports.basetype = {
+  bitlength: 64,
+  valuetype: 'basic',
+  desc: 'Quadruple setpoints (comfort,standby,economy,buildingProtection) (4 float with 16 Bit)',
+  help:
+    `// Send comfort, standby, economy mode and buildingProtection temperatures, as n.4 DPT9.001.
+  msg.payload = {comfort:22, standby:21.5, economy:21, buildingProtection:15};
+  return msg;`
+}
+
+// DPT9 subtypes
+exports.subtypes = {
+  // 9.001 temperature (oC)
+  '100': {
+    name: 'Quadruple setpoints (comfort,standby,economy,buildingProtection) (4 float with 16 Bit)',
+    desc: 'DPT_TempRoomSetpSetF16[4]',
+    unit: '°C',
+    range: [-273, 670760]
+  }
+}

package/KNXEngine/src/dptlib/index.js

@@ -3,24 +3,24 @@
 * (C) 2020-2022 Supergiovane
 */
 
-const fs = require('fs')
-const path = require('path')
-const util = require('util')
-const knxLog = require('./../KnxLog')
+const fs = require('fs');
+const path = require('path');
+const util = require('util');
+const knxLog = require("../KnxLog");
 
-let matches
-const dirEntries = fs.readdirSync(__dirname)
-const dpts = {}
+let matches;
+const dirEntries = fs.readdirSync(__dirname);
+const dpts = {};
 for (let i = 0; i < dirEntries.length; i++) {
   if (matches = dirEntries[i].match(/(dpt.*)\.js/)) {
-    const dptid = matches[1].toUpperCase() // DPT1..DPTxxx
-    const mod = require(__dirname + path.sep + dirEntries[i])
-    if (!mod.hasOwnProperty('basetype') ||
-      !mod.basetype.hasOwnProperty('bitlength')) {
-      throw 'incomplete ' + dptid + ', missing basetype and/or bitlength!'
+    const dptid = matches[1].toUpperCase(); // DPT1..DPTxxx
+    const mod = require(__dirname + path.sep + dirEntries[i]);
+    if (!mod.hasOwnProperty('basetype')
+      || !mod.basetype.hasOwnProperty('bitlength')) {
+      throw `incomplete ${dptid}, missing basetype and/or bitlength!`;
     }
-    mod.id = dptid
-    dpts[dptid] = mod
+    mod.id = dptid;
+    dpts[dptid] = mod;
     // knxLog.get().trace('DPT library: loaded %s (%s)', dptid, dpts[dptid].basetype.desc);
   }
 }
@@ -28,20 +28,20 @@ for (let i = 0; i < dirEntries.length; i++) {
 // a generic DPT resolution function
 // DPTs might come in as 9/"9"/"9.001"/"DPT9.001"
 dpts.resolve = function (dptid) {
-  const m = dptid.toString().toUpperCase().match(/^(?:DPT)?(\d+)(\.(\d+))?$/)
-  if (m === null) { throw new Error('Invalid DPT format: ' + dptid) }
+  const m = dptid.toString().toUpperCase().match(/^(?:DPT)?(\d+)(\.(\d+))?$/);
+  if (m === null) { throw new Error(`Invalid DPT format: ${dptid}`); }
 
-  const dpt = dpts[util.format('DPT%s', m[1])]
-  if (!dpt) { throw new Error('Unsupported DPT: ' + dptid) }
+  const dpt = dpts[util.format('DPT%s', m[1])];
+  if (!dpt) { throw new Error(`Unsupported DPT: ${dptid}`); }
 
-  const cloned_dpt = cloneDpt(dpt)
+  const cloned_dpt = cloneDpt(dpt);
   if (m[3]) {
-    cloned_dpt.subtypeid = m[3]
-    cloned_dpt.subtype = cloned_dpt.subtypes[m[3]]
+    cloned_dpt.subtypeid = m[3];
+    cloned_dpt.subtype = cloned_dpt.subtypes[m[3]];
   }
 
-  return cloned_dpt
-}
+  return cloned_dpt;
+};
 
 /* POPULATE an APDU object from a given Javascript value for the given DPT
  * - either by a custom DPT formatAPDU function
@@ -51,59 +51,72 @@ dpts.resolve = function (dptid) {
  */
 dpts.populateAPDU = function (value, apdu, dptid) {
   // console.log ("BANANA " + dptid)
-  const dpt = dpts.resolve(dptid || 'DPT1')
-  const nbytes = Math.ceil(dpt.basetype.bitlength / 8)
+  const dpt = dpts.resolve(dptid || 'DPT1');
+  const nbytes = Math.ceil(dpt.basetype.bitlength / 8);
   // apdu.data = new Buffer(nbytes); // 14/09/2020 Supregiovane: Deprecated. Replaced with below.
-  apdu.data = Buffer.alloc(nbytes)
-  apdu.bitlength = dpt.basetype && dpt.basetype.bitlength || 1
-  let tgtvalue = value
+  apdu.data = Buffer.alloc(nbytes);
+  apdu.bitlength = dpt.basetype && dpt.basetype.bitlength || 1;
+  let tgtvalue = value;
   // get the raw APDU data for the given JS value
   if (typeof dpt.formatAPDU === 'function') {
     // nothing to do here, DPT-specific formatAPDU implementation will handle everything
     // knxLog.get().trace('>>> custom formatAPDU(%s): %j', dptid, value);
-    apdu.data = dpt.formatAPDU(value)
+    apdu.data = dpt.formatAPDU(value);
     // knxLog.get().trace('<<< custom formatAPDU(%s): %j', dptid, apdu.data);
   } else {
     if (!isFinite(value)) {
-      throw new Error(util.format('Invalid value, expected a %s',
-        dpt.desc))
+      throw new Error(util.format(
+        'Invalid value, expected a %s',
+        dpt.desc,
+      ));
     }
     // check if value is in range, be it explicitly defined or implied from bitlength
     const range = (dpt.basetype.hasOwnProperty('range'))
       ? dpt.basetype.range
-      : [0, Math.pow(2, dpt.basetype.bitlength) - 1]
+      : [0, 2 ** dpt.basetype.bitlength - 1];
     // is there a scalar range? eg. DPT5.003 angle degrees (0=0, ff=360)
     if (dpt.hasOwnProperty('subtype') && dpt.subtype.hasOwnProperty(
-      'scalar_range')) {
-      const scalar = dpt.subtype.scalar_range
+      'scalar_range',
+    )) {
+      const scalar = dpt.subtype.scalar_range;
       if (value < scalar[0] || value > scalar[1]) {
         knxLog.get().trace(
           'Value %j(%s) out of scalar range(%j) for %s',
-          value, (typeof value), scalar, dpt.id)
+          value, (
+          typeof value),
+          scalar,
+          dpt.id,
+        );
       } else {
         // convert value from its scalar representation
         // e.g. in DPT5.001, 50(%) => 0x7F , 100(%) => 0xFF
-        const a = (scalar[1] - scalar[0]) / (range[1] - range[0])
-        const b = (scalar[0] - range[0])
-        tgtvalue = Math.round((value - b) / a)
+        const a = (scalar[1] - scalar[0]) / (range[1] - range[0]);
+        const b = (scalar[0] - range[0]);
+        tgtvalue = Math.round((value - b) / a);
       }
     } else {
       // just a plain numeric value, only check if within bounds
       if (value < range[0] || value > range[1]) {
-        knxLog.get().trace('Value %j(%s) out of bounds(%j) for %s.%s',
-          value, (typeof value), range, dpt.id, dpt.subtypeid)
+        knxLog.get().trace(
+          'Value %j(%s) out of bounds(%j) for %s.%s',
+          value, (
+          typeof value),
+          range,
+          dpt.id,
+          dpt.subtypeid,
+        );
       }
     }
     // generic APDU is assumed to convey an unsigned integer of arbitrary bitlength
     if (dpt.basetype.hasOwnProperty('signedness') && dpt.basetype.signedness === 'signed') {
-      apdu.data.writeIntBE(tgtvalue, 0, nbytes)
+      apdu.data.writeIntBE(tgtvalue, 0, nbytes);
     } else {
-      apdu.data.writeUIntBE(tgtvalue, 0, nbytes)
+      apdu.data.writeUIntBE(tgtvalue, 0, nbytes);
     }
   }
   // knxLog.get().trace('generic populateAPDU tgtvalue=%j(%s) nbytes=%d => apdu=%j', tgtvalue, typeof tgtvalue, nbytes, apdu);
-  return apdu
-}
+  return apdu;
+};
 
 /* get the correct Javascript value from a APDU buffer for the given DPT
  * - either by a custom DPT formatAPDU function
@@ -112,48 +125,49 @@ dpts.populateAPDU = function (value, apdu, dptid) {
  */
 dpts.fromBuffer = function (buf, dpt) {
   // sanity check
-  if (!dpt) throw util.format('DPT %s not found', dpt)
-  let value = 0
+  if (!dpt) throw util.format('DPT %s not found', dpt);
+  let value = 0;
   // get the raw APDU data for the given JS value
   if (typeof dpt.fromBuffer === 'function') {
     // nothing to do here, DPT-specific fromBuffer implementation will handle everything
-    value = dpt.fromBuffer(buf)
+    value = dpt.fromBuffer(buf);
   } else {
     // knxLog.get().trace('%s buflength == %d => %j', typeof buf, buf.length, JSON.stringify(buf) );
     // get a raw unsigned integer from the buffer
     if (buf.length > 6) {
-      throw 'cannot handle unsigned integers more then 6 bytes in length'
+      throw 'cannot handle unsigned integers more then 6 bytes in length';
     }
     if (dpt.basetype.hasOwnProperty('signedness') && dpt.basetype.signedness == 'signed') {
-      value = buf.readIntBE(0, buf.length)
+      value = buf.readIntBE(0, buf.length);
     } else {
-      value = buf.readUIntBE(0, buf.length)
+      value = buf.readUIntBE(0, buf.length);
     }
     // knxLog.get().trace(' ../knx/src/index.js : DPT : ' + JSON.stringify(dpt));   // for exploring dpt and implementing description
     if (dpt.hasOwnProperty('subtype') && dpt.subtype.hasOwnProperty(
-      'scalar_range')) {
+      'scalar_range',
+    )) {
       const range = (dpt.basetype.hasOwnProperty('range'))
         ? dpt.basetype.range
-        : [0, Math.pow(2, dpt.basetype.bitlength) - 1]
-      const scalar = dpt.subtype.scalar_range
+        : [0, 2 ** dpt.basetype.bitlength - 1];
+      const scalar = dpt.subtype.scalar_range;
       // convert value from its scalar representation
       // e.g. in DPT5.001, 50(%) => 0x7F , 100(%) => 0xFF
-      const a = (scalar[1] - scalar[0]) / (range[1] - range[0])
-      const b = (scalar[0] - range[0])
-      value = Math.round(a * value + b)
+      const a = (scalar[1] - scalar[0]) / (range[1] - range[0]);
+      const b = (scalar[0] - range[0]);
+      value = Math.round(a * value + b);
       // knxLog.get().trace('fromBuffer scalar a=%j b=%j %j', a,b, value);
     }
   }
   //  knxLog.get().trace('generic fromBuffer buf=%j, value=%j', buf, value);
-  return value
-}
+  return value;
+};
 
-function cloneDpt (d) {
-  let result = {}
-  result = JSON.parse(JSON.stringify(d))
-  result.fromBuffer = d.fromBuffer
-  result.formatAPDU = d.formatAPDU
-  return result
+function cloneDpt(d) {
+  let result = {};
+  result = JSON.parse(JSON.stringify(d));
+  result.fromBuffer = d.fromBuffer;
+  result.formatAPDU = d.formatAPDU;
+  return result;
 }
 
-module.exports = dpts
+module.exports = dpts;