node-red-contrib-knx-ultimate 2.5.1 → 3.0.0-beta2

package/.eslintrc.json

@@ -9,6 +9,7 @@
     "ecmaVersion": "latest"
   },
   "rules": {
-    "quotes": "off"
+    "quotes": "off",
+    "no-bitwise": "off"
   }
-}
+}

package/CHANGELOG.md

@@ -6,6 +6,19 @@
 
 # CHANGELOG
 
+**Version 3.0.0-beta2** - Juni 2024<br/>
+- Warning: Node-Red version **equals or major than 3.1.1** is needed to run this node.<br/>
+- NEW: Hue Node Software Update Status for the HUE devices. <br/>
+
+**Version 3.0.0-beta1** - Juni 2024<br/>
+- Warning: Node-Red version **equals or major than 3.1.1** is needed to run this node.<br/>
+- FEATURE CAUTION: rewrote the KNX engine in Typescript. If you encounter problems, please open a gitub issue. You can revert by installing the older version 2.5.1 <br/>
+- FEATURE: KNX Ultimate node: you can now set the group address from a global, flow or $env variable, beside the standard 3-level format. <br/>
+- FEATURE: KNX Ultimate node: if you imported the ETS file, as soon as you click to the Group Address field, the list shows up immediately. <br/>
+- FEATURE: KNX Ultimate node: msg.setConfig passed to the node, now can read the group address name and datapoint automatically, based on the group address (require the ETS file to be imported). <br/>
+- FEATURE: KNX Ultimate node: the object property *gainfo* has been added to the msg output. Refer to the help panel for further infos. <br/>
+
+
 **Version 2.5.1** - Mai 2024<br/>
 - Warning: Node-Red version **equals or major than 3.1.1** is needed to run this node.<br/>
 - NEW: HUE light node: you can now override the day/night mode by setting the day mode temporary, whenever you fast toggles the light switch on then off within 10 seconds. There are multiple choiches to select from. <br/>

package/README.md

@@ -57,9 +57,10 @@ msg.payload = {red:255, green:200, blue:30} // Put some colors in our life
 |--|--|
 | KNX Tunnelling | ![](https://placehold.co/200x20/green/white?text=YES) |
 | KNX Routing | ![](https://placehold.co/200x20/green/white?text=YES) |
+| Philips Hue v2 | ![](https://placehold.co/200x20/green/white?text=YES) |
 | KNX Secure Tunnelling | ![](https://placehold.co/200x20/orange/white?text=UNDER+DEVELOPMENT) |
 | KNX Secure Routing | ![](https://placehold.co/200x20/red/white?text=NO) |
-| KNX 3rd PARTY IOT API client | ![](https://placehold.co/200x20/orange/white?text=UNDER+DEVELOPMENT) |
+| KNX 3rd PARTY IOT API client | ![](https://placehold.co/200x20/red/white?text=DELAYED) |
 | Matter | ![](https://placehold.co/200x20/blue/white?text=UNDER+BRAINSTORMING) |
 
 <br/>

package/{KNXEngine → _JS_KNXEngine}/README.md

@@ -92,7 +92,7 @@ You should see something like this in the console window (the **msg.payload** is
 |Properties|Description|
 |--|--|
 | .isConnected() | Returns **true** if you the client is connected to the KNX Gateway Router/Interface, **false** if not connected. |
-| ._getClearToSend() | Returns **true** if you can send a telegram, **false** if the client is still waiting for the last telegram's ACK or whenever the client cannot temporary send the telegram. In tunneling mode, you could also refer to the event **KNXClientEvents.ackReceived**, that is fired everytime a telegram has been succesfully acknowledge or not acknowledge. See the sample.js file. |
+| .clearToSend | Returns **true** if you can send a telegram, **false** if the client is still waiting for the last telegram's ACK or whenever the client cannot temporary send the telegram. In tunneling mode, you could also refer to the event **KNXClientEvents.ackReceived**, that is fired everytime a telegram has been succesfully acknowledge or not acknowledge. See the sample.js file. |
 
 <br/>
 <br/>
@@ -333,24 +333,24 @@ knxUltimateClient.on(knx.KNXClient.KNXClientEvents.connected, info => {
     // Check wether knxUltimateClient is clear to send the next telegram.
     // This should be called bevore any .write, .response, and .read request.
     // If not clear to send, retry later because the knxUltimateClient is busy in sending another telegram.
-    console.log("Clear to send: " + knxUltimateClient._getClearToSend())
+    console.log("Clear to send: " + knxUltimateClient.clearToSend)
 
     // // Send a WRITE telegram to the KNX BUS
     // // You need: group address, payload (true/false/or any message), datapoint as string
     let payload = false;
-    if (knxUltimateClient._getClearToSend()) knxUltimateClient.write("0/1/1", payload, "1.001");
+    if (knxUltimateClient.clearToSend) knxUltimateClient.write("0/1/1", payload, "1.001");
 
     // Send a color RED to an RGB datapoint
     payload = { red: 125, green: 0, blue: 0 };
-    if (knxUltimateClient._getClearToSend()) knxUltimateClient.write("0/1/2", payload, "232.600");
+    if (knxUltimateClient.clearToSend) knxUltimateClient.write("0/1/2", payload, "232.600");
 
     // // Send a READ request to the KNX BUS
-    if (knxUltimateClient._getClearToSend()) knxUltimateClient.read("0/0/1");
+    if (knxUltimateClient.clearToSend) knxUltimateClient.read("0/0/1");
 
     // Send a RESPONSE telegram to the KNX BUS
     // You need: group address, payload (true/false/or any message), datapoint as string
     payload = false;
-    if (knxUltimateClient._getClearToSend()) knxUltimateClient.respond("0/0/1", payload, "1.001");
+    if (knxUltimateClient.clearToSend) knxUltimateClient.respond("0/0/1", payload, "1.001");
 
 });
 knxUltimateClient.on(knx.KNXClient.KNXClientEvents.connecting, info => {
@@ -510,7 +510,7 @@ async function go() {
         // The client is connected
         console.log("Connected. On Duty", info)
         // Write something to the BUS
-        if (knxUltimateClient._getClearToSend()) knxUltimateClient.write("0/1/1", false, "1.001");
+        if (knxUltimateClient.clearToSend) knxUltimateClient.write("0/1/1", false, "1.001");
     });
     knxUltimateClient.on(knx.KNXClient.KNXClientEvents.connecting, info => {
         // The client is setting up the connection

package/{KNXEngine → _JS_KNXEngine}/index.js

@@ -1,5 +1,5 @@
 const { KNXClient, KNXClientEvents, getDecodedKeyring, appendPropertyToDecodedKeyring } = require("./src/KNXClient.js");
-//const KNXSecureKeyring = require('./../knxultimate/src/KNXsecureKeyring.js');    
+//const KNXSecureKeyring = require('./.knxultimate/KNXsecureKeyring.js');    
 //exports.KNXSecureKeyring = KNXSecureKeyring;    
 
 //exports.KNXClientEvents = KNXClient.KNXClientEvents;

package/{KNXEngine → _JS_KNXEngine}/sample.js

@@ -125,24 +125,24 @@ knxUltimateClient.on(knx.KNXClient.KNXClientEvents.connected, info => {
     // Check wether knxUltimateClient is clear to send the next telegram.
     // This should be called bevore any .write, .response, and .read request.
     // If not clear to send, retry later because the knxUltimateClient is busy in sending another telegram.
-    console.log("Clear to send: " + knxUltimateClient._getClearToSend())
+    console.log("Clear to send: " + knxUltimateClient.clearToSend)
 
     // // Send a WRITE telegram to the KNX BUS
     // // You need: group address, payload (true/false/or any message), datapoint as string
     let payload = false;
-    if (knxUltimateClient._getClearToSend()) knxUltimateClient.write("0/1/1", payload, "1.001");
+    if (knxUltimateClient.clearToSend) knxUltimateClient.write("0/1/1", payload, "1.001");
 
     // Send a color RED to an RGB datapoint
     payload = { red: 125, green: 0, blue: 0 };
-    if (knxUltimateClient._getClearToSend()) knxUltimateClient.write("0/1/2", payload, "232.600");
+    if (knxUltimateClient.clearToSend) knxUltimateClient.write("0/1/2", payload, "232.600");
 
     // // Send a READ request to the KNX BUS
-    if (knxUltimateClient._getClearToSend()) knxUltimateClient.read("0/0/1");
+    if (knxUltimateClient.clearToSend) knxUltimateClient.read("0/0/1");
 
     // Send a RESPONSE telegram to the KNX BUS
     // You need: group address, payload (true/false/or any message), datapoint as string
     payload = false;
-    if (knxUltimateClient._getClearToSend()) knxUltimateClient.respond("0/0/1", payload, "1.001");
+    if (knxUltimateClient.clearToSend) knxUltimateClient.respond("0/0/1", payload, "1.001");
 
 });
 knxUltimateClient.on(knx.KNXClient.KNXClientEvents.connecting, info => {

package/{KNXEngine → _JS_KNXEngine}/sampleSecure.js

@@ -88,7 +88,7 @@ async function go() {
         // The client is connected
         console.log("Connected. On Duty", info)
         // Write something to the BUS
-        if (knxUltimateClient._getClearToSend()) knxUltimateClient.write("0/1/1", false, "1.001");
+        if (knxUltimateClient.clearToSend) knxUltimateClient.write("0/1/1", false, "1.001");
     });
     knxUltimateClient.on(knx.KNXClient.KNXClientEvents.connecting, info => {
         // The client is setting up the connection

package/{KNXEngine → _JS_KNXEngine}/src/KNXClient.js

@@ -736,12 +736,12 @@ class KNXClient extends EventEmitter {
           }
           this._clearToSend = true
           this.emit(KNXClientEvents.error, timeoutErr)
-          if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error('KNXClient: _setTimerWaitingForACK: ' + (timeoutErr.message || 'Undef error') + ' no ACK received. ABORT sending datagram with seqNumber ' + this._getSeqNumber() + ' from ' + knxTunnelingRequest.cEMIMessage.srcAddress.toString() + ' to ' + knxTunnelingRequest.cEMIMessage.dstAddress.toString())
+          if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error('KNXClient: _setTimerWaitingForACK: ' + (timeoutErr.message || 'Undef error') + ' no ACK received. ABORT sending datagram with seqNumber ' + this.getSeqNumber() + ' from ' + knxTunnelingRequest.cEMIMessage.srcAddress.toString() + ' to ' + knxTunnelingRequest.cEMIMessage.dstAddress.toString())
         } else {
           // 26/12/2021 // If no ACK received, resend the datagram once with the same sequence number
           this._setTimerWaitingForACK(knxTunnelingRequest)
           this.send(knxTunnelingRequest)
-          if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error('KNXClient: _setTimerWaitingForACK: ' + (timeoutErr.message || 'Undef error') + ' no ACK received. Retransmit datagram with seqNumber ' + this._getSeqNumber() + ' from ' + knxTunnelingRequest.cEMIMessage.srcAddress.toString() + ' to ' + knxTunnelingRequest.cEMIMessage.dstAddress.toString())
+          if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error('KNXClient: _setTimerWaitingForACK: ' + (timeoutErr.message || 'Undef error') + ' no ACK received. Retransmit datagram with seqNumber ' + this.getSeqNumber() + ' from ' + knxTunnelingRequest.cEMIMessage.srcAddress.toString() + ' to ' + knxTunnelingRequest.cEMIMessage.dstAddress.toString())
         }
       } catch (error) { }
     }, KNXConstants.KNX_CONSTANTS.TUNNELING_REQUEST_TIMEOUT * 1000)
@@ -907,7 +907,7 @@ class KNXClient extends EventEmitter {
 
         // Check the received ACK sequence number
         if (!this._options.suppress_ack_ldatareq) {
-          if (knxTunnelingAck.seqCounter === this._getSeqNumber()) {
+          if (knxTunnelingAck.seqCounter === this.getSeqNumber()) {
             if (this._timerWaitingForACK !== null) clearTimeout(this._timerWaitingForACK)
             this._numFailedTelegramACK = 0 // 25/12/2021 clear the current ACK failed telegram number
             this._clearToSend = true // I'm ready to send a new datagram now

package/_JS_KNXEngine/src/dptlib/dpt60002.js

@@ -0,0 +1,101 @@
+const knxLog = require('../KnxLog');
+
+function bitsToShutterPosition(bits) {
+    switch (bits) {
+        case 0b00: return 'intermediate';
+        case 0b01: return 'top';
+        case 0b10: return 'bottom';
+        default:
+            knxLog.get().error(`unknown position value: ${bits}`);
+            return null;
+    }
+}
+
+function shutterPositionToBits(position) {
+    switch (position) {
+        case 'intermediate': return 0b00;
+        case 'top': return 0b01;
+        case 'bottom': return 0b10;
+        default:
+            knxLog.get().error(`Unknown position: ${position}`);
+            return null;
+    }
+}
+
+function bitsToOperationMode(bits) {
+    switch (bits) {
+        case 0b000: return 'normal';
+        case 0b001: return 'priority';
+        case 0b010: return 'wind alarm';
+        case 0b011: return 'rain alarm';
+        case 0b100: return 'disabled';
+        default:
+            knxLog.get().error(`unknown operation mode value: ${bits}`);
+            return null;
+    }
+}
+
+function operationModeToBits(mode) {
+    switch (mode) {
+        case 'normal': return 0b000;
+        case 'priority': return 0b001;
+        case 'wind alarm': return 0b010;
+        case 'rain alarm': return 0b011;
+        case 'disabled': return 0b100;
+        default:
+            knxLog.get().error(`Unknown operation mode: ${mode}`);
+            return null;
+    }
+}
+
+// DPT2 frame description.
+// Always 8-bit aligned.
+exports.formatAPDU = function formatAPDU(value) {
+    if (!value) {
+        knxLog.get().error('DPT60002: cannot write null value');
+        return null;
+    }
+
+    let apduData;
+    if (typeof value === 'object'
+        && Object.prototype.hasOwnProperty.call(value, 'mode')
+        && Object.prototype.hasOwnProperty.call(value, 'position')) {
+        const mode = operationModeToBits(value.mode);
+        const position = shutterPositionToBits(value.position);
+        apduData = (mode << 2) + position;
+    } else {
+        knxLog.get().error('DPT60002: Must supply a value {mode: "normal"|"priority"|"wind|alarm"|"rain|alarm"|"disabled", position: "intermediate"|"top"|"bottom"}');
+    }
+    return Buffer.from([apduData]);
+};
+
+exports.fromBuffer = function fromBuffer(buf) {
+    if (buf.length !== 1) {
+        knxLog.get().error(`DPT60002: Buffer should be 1 byte long, got ${buf.length}`);
+        return null;
+    }
+
+    return {
+        mode: bitsToOperationMode((buf[0] >> 2) & 0b111),
+        position: bitsToShutterPosition(buf[0] & 0b11),
+    };
+};
+
+// DPT basetype info hash
+exports.basetype = {
+    bitlength: 2,
+    valuetype: 'composite',
+    desc: 'Status object for Hager TXA223/225',
+    help:
+        `// This would usually only be received.
+msg.payload = {position: "top", mode: "normal"};
+return msg;`,
+};
+
+// DPT subtypes info hash
+exports.subtypes = {
+    '001': {
+        name: 'Shutter state',
+        desc: 'Status object for Hager TXA223/225',
+    },
+};

package/{KNXEngine → _JS_KNXEngine}/src/protocol/KNXConnectResponse.js

@@ -39,6 +39,8 @@ class KNXConnectResponse extends KNXPacket.KNXPacket {
         return 'Invalid Connection Option'
       case KNXConstants.KNX_CONSTANTS.E_NO_MORE_CONNECTIONS:
         return 'No More Connections'
+      case KNXConstants.KNX_CONSTANTS.E_NO_MORE_UNIQUE_CONNECTIONS:
+        return 'No More Unique Connections';
       case KNXConstants.KNX_CONSTANTS.E_DATA_CONNECTION:
         return 'Invalid Data Connection'
       case KNXConstants.KNX_CONSTANTS.E_KNX_CONNECTION:

package/{KNXEngine → _JS_KNXEngine}/src/protocol/KNXConstants.js

@@ -34,6 +34,7 @@ exports.KNX_CONSTANTS = {
   E_CONNECTION_TYPE: 0x22,
   E_CONNECTION_OPTION: 0x23,
   E_NO_MORE_CONNECTIONS: 0x24,
+  E_NO_MORE_UNIQUE_CONNECTIONS: 0x25,
   E_DATA_CONNECTION: 0x26,
   E_KNX_CONNECTION: 0x27,
   E_TUNNELING_LAYER: 0x29,

package/nodes/commonFunctions.js

@@ -5,7 +5,7 @@ const fs = require("fs");
 const path = require("path");
 const yaml = require('js-yaml');
 const loggerEngine = require("./utils/sysLogger.js");
-const dptlib = require("../KNXEngine/src/dptlib");
+const dptlib = require('knxultimate').dptlib;
 
 
 
@@ -376,7 +376,7 @@ module.exports = (RED) => {
 
         RED.httpAdmin.get("/knxUltimateDpts", (req, res) => {
             try {
-                const dpts = Object.entries(dptlib).filter(onlyDptKeys).map(extractBaseNo).sort(sortBy("base"))
+                const dpts = Object.entries(dptlib.dpts).filter(onlyDptKeys).map(extractBaseNo).sort(sortBy("base"))
                     .reduce(toConcattedSubtypes, []);
                 res.json(dpts);
             } catch (error) { }
@@ -408,7 +408,7 @@ module.exports = (RED) => {
                     help: "NO",
                     helplink: "https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/-SamplesHome",
                 };
-                const dpts = Object.entries(dptlib).filter(onlyDptKeys);
+                const dpts = Object.entries(dptlib.dpts).filter(onlyDptKeys);
                 for (let index = 0; index < dpts.length; index++) {
                     if (dpts[index][0].toUpperCase() === `DPT${sDPT}`) {
                         jRet = {

package/nodes/hue-config.html

@@ -1,3 +1,5 @@
+<script type="text/javascript" src="resources/node-red-contrib-knx-ultimate/htmlUtils.js"></script>
+
 <script type="text/javascript">
     RED.nodes.registerType('hue-config', {
         category: 'config',

package/nodes/hue-config.js

@@ -344,6 +344,14 @@ module.exports = (RED) => {
                 id: resource.id,
               });
             }
+            if (_rtype === 'device_software_update') {
+              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: `Software status: ${linkedDevName}${Room !== undefined ? `, room ${Room.metadata.name}` : ''}`,
+                id: resource.id,
+              });
+            }
           } catch (error) {
             retArray.push({
               name: `${_rtype}: ERROR ${error.message}`,

package/nodes/knxUltimate-config.html

@@ -1,3 +1,5 @@
+<script type="text/javascript" src="resources/node-red-contrib-knx-ultimate/htmlUtils.js"></script>
+
 <script type="text/javascript">
     RED.nodes.registerType('knxUltimate-config', {
         category: 'config',