iobroker.openknx 0.1.24 → 0.2.2

package/README.md

@@ -126,9 +126,9 @@ The whole name including path is used to check for similarity.
 
 ### ACK flags
 Applications shall never set ack flags, application is notified from this adapter by the ack flag if data is updated.
-KNX Stack sets the ack flag of the corresponding IoBroker object on receiption of a group address.
-Sent frames on KNX triggered by application writing to a object does not result into an acknowledgement message to that object.
-This behavior can be overwritten by checking in the admin dialog the checkbox "set acknowledgement flag when application writes to object".
+KNX Stack sets the ack flag of the corresponding IoBroker object on receiption of a group address if another knx host writes to the bus.
+Sent frames on KNX triggered by application writing to a object does not result into an immediate acknowledgement message to that object.
+If the write is coming from this adapter, the the ack flag is generated on postivive confirmance in tunneling mode.
 
 ### Node Red complex datatype example
 Create a function node that connects to a ioBroker out node that connects with a KNX object of DPT2.
@@ -306,6 +306,18 @@ Data is sent to Iobroker Sentry server hosted in Germany. If you have allowed io
 - only IPv4 supported
 
 ## Changelog
+### 0.2.2 (2022-05-26)
+* feature: writing to bus l_data.con creates a ack on the iobroker object if successful (the knx conf flag unset)
+* bugfix: remove manual Physical KNX address dialog, use 0.0.0 instead
+* bugfix: remove error log when answering to GroupValueRead: #183
+* bugfix: improve warning logs on intended and unintended disconnects
+
+### 0.1.25 (2022-04-18)
+* feature: datatype check for raw value
+* feature: check if knx is connected before usage
+* bugfix: if update ack after write, use correct timestamp and set adapter as user
+* bugfix: remove enless loop if event received before initialisation
+
 ### 0.1.24 (2022-03-31)
 * feature: support for latin1 charset in dpt16
 
@@ -433,7 +445,7 @@ Data is sent to Iobroker Sentry server hosted in Germany. If you have allowed io
 * (boellner) feature: import ga xml
 
 ### initial version
-* initial version inspired by https://www.npmjs.com/package/iobroker.knx/v/0.8.3
+* initial version from https://www.npmjs.com/package/iobroker.knx/v/0.8.3
 
 ## License
 					GNU GENERAL PUBLIC LICENSE

package/admin/index_m.html

@@ -78,7 +78,6 @@
             if (settings.gwip === undefined) settings.gwip = "127.0.0.1";
             if (settings.gwipport === undefined) settings.gwipport = 3671;
             if (settings.minimumDelay === undefined) settings.minimumDelay = 50;
-            if (settings.eibadr === undefined) settings.eibadr = "1.1.1";
             if (settings.onlyAddNewObjects === undefined) settings.onlyAddNewObjects = false;
             if (settings.localInterface === undefined) settings.localInterface = "";
             if (settings.setAckOnWrite === undefined) settings.setAckOnWrite = false;
@@ -136,16 +135,6 @@
                         }
                     }
 
-                    if (id === "eibadr") {
-                        var eibadr1 = $("#eibadr").val();
-                        if (isKnxAddressValid(eibadr1)) {
-                            $("#eibadr").val(eibadr1);
-                        } else {
-                            alert("physical KNX address in format a/b/c not valid");
-                            $("#eibadr").val(settings.eibadr).change();
-                        }
-                    }
-
                     if (id === "minimumDelay") {
                         var intervall = $("#minimumDelay").val();
                         number = Number(intervall);
@@ -280,7 +269,6 @@
                     } else {
                         $("#deviceName")[0].innerHTML = result.deviceName;
                         $("#gwip").val(result.ip).change();
-                        $("#eibadr").val(result.knxAdr).change();
                         $("#gwipport").val(result.port).change();
                         if (result.devicesFound > 1) showMessage(_("more than one KNX gateway found"));
                     }
@@ -357,11 +345,6 @@
                             <input type="text" class="value" id="gwipport" />
                             <label for="gwipport" class="translate">Port</label>
                         </div>
-
-                        <div class="col s6 l3 input-field">
-                            <input class="value" id="eibadr" type="text" />
-                            <label for="eibadr" class="translate">Physical KNX address</label>
-                        </div>
                         <div class="col s6 l2">
                             <a id="detectInterface" class="waves-effect waves-light btn"><i
                                     class="material-icons right">live help</i><span class="translate">detect
@@ -382,13 +365,6 @@
                             <label for="minimumDelay" class="translate">Frames delay [ms]</label>
                         </div>
                     </div>
-                    <div class="row">
-                        <div class="col s12 input-field">
-                            <input class="value" id="setAckOnWrite" type="checkbox" />
-                            <label class="translate" for="setAckOnWrite">set acknowledgement flag when application writes to object</label>
-                        </div>
-                        
-                    </div>
                 </div>
             </div>
             <div class="card">

package/io-package.json

@@ -1,19 +1,11 @@
 {
     "common": {
         "name": "openknx",
-        "version": "0.1.24",
+        "version": "0.2.2",
         "news": {
-            "0.1.24": {
-                "en": "Bugfixing",
-                "de": "Fehler beheben",
-                "ru": "Исправление ошибок",
-                "pt": "Corrigindo erro",
-                "nl": "Bugfixing",
-                "fr": "Correction de bogues",
-                "it": "Correzione di bug",
-                "es": "Corrección de errores",
-                "pl": "Naprawa błędów",
-                "zh-cn": "错误修复"
+            "0.2.2": {
+                "en": "see https://www.npmjs.com/package/iobroker.openknx",
+                "de": "https://www.npmjs.com/package/iobroker.openknx"
             }
         },
         "title": "Open KNX",

package/lib/knx/src/Connection.js

@@ -74,7 +74,7 @@ FSM.prototype.AddCEMI = function(datagram, msgcode) {
     ctrl: {
       frameType: 1, // 0=extended 1=standard
       reserved: 0, // always 0
-      repeat: 1, // the OPPOSITE: 1=do NOT repeat
+      repeat: 1, // 0: no repetition, 1=don't care
       broadcast: 1, // 0-system broadcast 1-broadcast
       priority: 3, // 0-system 1-normal 2-urgent 3-low
       acknowledge: sendAck ? 1 : 0,

package/lib/knx/src/FSM.js

@@ -348,18 +348,18 @@ module.exports = machina.Fsm.extend({
        */
       ['inbound_TUNNELING_REQUEST_L_Data.con'](datagram) {
         if (this.useTunneling) {
-          const confirmed = this.sentTunnRequests[datagram.cemi.dest_addr];
-          if (confirmed) {
-            delete this.sentTunnRequests[datagram.cemi.dest_addr];
-            this.emit('confirmed', confirmed);
-          }
+          const confirmed = this.sentTunnRequests[datagram.cemi.dest_addr] && ! /*cofirmation error*/ datagram.cemi.ctrl.confirm;
+
+          delete this.sentTunnRequests[datagram.cemi.dest_addr];
+          this.emit('confirmed', datagram.cemi.dest_addr, confirmed);
+
           KnxLog.get().trace(
             '(%s): %s %s',
             this.compositeState(),
             datagram.cemi.dest_addr,
             confirmed
               ? 'delivery confirmation (L_Data.con) received'
-              : 'unknown dest addr'
+              : 'confirmation error'
           );
           this.acknowledge(datagram);
         }
@@ -558,6 +558,7 @@ module.exports = machina.Fsm.extend({
     },
   },
 
+  /* send tunnel acknowledge on knx bus*/
   acknowledge(datagram) {
     const ack = this.prepareDatagram(
       KnxConstants.SERVICE_TYPE.TUNNELING_ACK,

package/main.js

@@ -30,9 +30,6 @@ class openknx extends utils.Adapter {
         });
         this.gaList = new DoubleKeyedMap();
         this.autoreaddone = false;
-        /* knx stack starts connection process with disconnect msg*/
-        this.disconnectConfirmed = false;
-        this.connected = false;
         this.on("ready", this.onReady.bind(this));
         this.on("stateChange", this.onStateChange.bind(this));
         this.on("message", this.onMessage.bind(this));
@@ -51,7 +48,7 @@ class openknx extends utils.Adapter {
                 if (args.indexOf("deferring outbound_TUNNELING_REQUEST") !== -1) {
                     return;
                 } else if (args.indexOf("empty internal fsm queue due to inbound_DISCONNECT_REQUEST") !== -1) {
-                    this.log.warn("possible data loss due to gateway reset, consider increasing frame delay");
+                    //this.log.warn("possible data loss due to gateway reset, consider increasing frame delay");
                 }
 
                 if (args.indexOf("[debug]") !== -1) {
@@ -62,7 +59,13 @@ class openknx extends utils.Adapter {
                     this.log.warn(args);
                 } else if (args.indexOf("[error]") !== -1) {
                     this.log.error(args);
-                    //todo log onsentry
+                    if (this.sentryInstance) {
+                        this.Sentry && this.Sentry.withScope(scope => {
+                            scope.setLevel("error");
+                            scope.setExtra("error message", args);
+                            this.Sentry.captureMessage("knx library error event", "error");
+                        });
+                    }
                 } else if (args.indexOf("[trace]") !== -1) {
                     this.log.silly(args);
                 } else {
@@ -78,40 +81,18 @@ class openknx extends utils.Adapter {
      */
     async onReady() {
         // adapter initialization
-
-        /*
         if (this.supportsFeature && this.supportsFeature("PLUGINS")) {
             const sentryInstance = this.getPluginInstance("sentry");
             if (sentryInstance) {
                 const Sentry = sentryInstance.getSentryObject();
                 if (Sentry) {
                     Sentry.init({
-                        //environment: "development", //"production", todo distinguish
+                        //environment: "development", //"production"
+                        environment: "production"
                     });
-                    Sentry.configureScope(scope => {
-                        scope.addEventProcessor((event, _hint) => {
-                            if (event.exception && event.exception.values && event.exception.values[0]) {
-                                const eventData = event.exception.values[0];
-                                if (eventData.stacktrace && eventData.stacktrace.frames && Array.isArray(eventData.stacktrace.frames) && eventData.stacktrace.frames.length) {
-                                    /*
-                                    //Exclude event if own directory is included but not inside own node_modules
-                                    const ownNodeModulesDir = nodePath.join(__dirname, "node_modules");
-                                    if (!eventData.stacktrace.frames.find(frame => frame.filename && frame.filename.includes(__dirname) && !frame.filename.includes(ownNodeModulesDir))) {
-                                        return null;
-                                    }
-                                    */
-        // We have exception data and do not sorted it out, so report it
-        //                                    return event;
-        //    }
-        //}
-        // No exception in it ... do not report
-        //                            return null;
-        //                        });
-        //                    });
-        //                }
-        //            }
-        //}
-
+                }
+            }
+        }
 
         //after installation
         if (tools.isEmptyObject(this.config)) {
@@ -140,8 +121,7 @@ class openknx extends utils.Adapter {
             // clearTimeout(timeout2);
             // ...
             // clearInterval(interval1);
-
-            this.disconnectConfirmed = false;
+            this.startup = true;
             if (this.knxConnection) {
                 this.knxConnection.Disconnect();
             }
@@ -315,7 +295,7 @@ class openknx extends utils.Adapter {
 
     /**
      * Is called if a subscribed state changes
-     * state.ack is coming in false if set by user (nodered, script...), here we set it.
+     * state.ack is received with value false if set by user (nodered, script...), here we set it.
      * https://github.com/ioBroker/ioBroker.docs/blob/master/docs/en/dev/adapterdev.md
      * @param {string} id
      * @param {ioBroker.State | null | undefined} state
@@ -329,12 +309,15 @@ class openknx extends utils.Adapter {
         if (!this.gaList.getDataById(id) || !this.gaList.getDataById(id).native || !this.gaList.getDataById(id).native.address) {
             return "not a KNX object";
         }
+        if (this.knxConnection == undefined) {
+            return "KNX not started";
+        }
+
         if (state.ack) {
             //only continue when application triggered a change without ack flag, filter out reception state changes
 
             //enable this for system testing
             //this.interfaceTest(id, state);
-
             return "ack is set";
         }
         if (!(await this.getStateAsync("info.connection"))) {
@@ -375,6 +358,10 @@ class openknx extends utils.Adapter {
         } else if (tools.isUnknownDPT(dpt)) {
             //write raw buffers for unknown dpts, iterface is a hex value
             //bitlength is the buffers bytelength * 8.
+            if (typeof (knxVal) != "string") {
+                this.log.warn("unsupported datatype for raw value");
+                return "unsupported datatype";
+            }
             rawVal = Buffer.from(knxVal, "hex");
             isRaw = true;
             this.log.info("Unhandeled DPT " + dpt + ", assuming raw value");
@@ -386,6 +373,7 @@ class openknx extends utils.Adapter {
             }
         }
 
+        // @ts-ignore
         if (state.c == "GroupValue_Read" || state.q == 0x10) {
             //interface to trigger GrouValue_Read is this comment or null
             this.log.debug("Outbound GroupValue_Read to " + ga);
@@ -402,14 +390,10 @@ class openknx extends utils.Adapter {
             this.log.debug("Outbound GroupValue_Write to " + ga + " val: " + (isRaw ? rawVal : JSON.stringify(knxVal)) + " from " + id);
             if (isRaw) {
                 this.knxConnection.writeRaw(ga, rawVal, () => {
-                    if (this.config.setAckOnWrite)
-                        this.setState(id, state, true);
                 });
                 return "write raw";
             } else {
                 this.knxConnection.write(ga, knxVal, dpt, () => {
-                    if (this.config.setAckOnWrite)
-                        this.setState(id, state, true);
                 });
                 return "write";
             }
@@ -420,10 +404,11 @@ class openknx extends utils.Adapter {
     }
 
     startKnxStack() {
+        this.startup = true;
         this.knxConnection = this.knx.Connection({
             ipAddr: this.config.gwip,
             ipPort: this.config.gwipport,
-            physAddr: this.config.eibadr,
+            physAddr: "0.0.0",
             interface: this.translateInterface(this.config.localInterface),
             minimumDelay: this.config.minimumDelay,
             //https://github.com/Supergiovane/node-red-contrib-knx-ultimate/issues/78, some receivers cannot handle a ack request, spec makes no difference
@@ -434,8 +419,6 @@ class openknx extends utils.Adapter {
             //debug:
             handlers: {
                 connected: () => {
-                    this.disconnectConfirmed = false;
-                    this.connected = true;
                     //create new knx datapoint and bind to connection
                     //in order to have autoread work
                     let cnt_withDPT = 0;
@@ -444,11 +427,11 @@ class openknx extends utils.Adapter {
                         for (const key of this.gaList) {
                             try {
                                 const datapoint = new this.knx.Datapoint({
-                                    ga: this.gaList.getDataById(key).native.address,
-                                    dpt: this.gaList.getDataById(key).native.dpt,
-                                    autoread: this.gaList.getDataById(key).native.autoread, // issue a GroupValue_Read request to try to get the initial state from the bus (if any)
-                                },
-                                this.knxConnection
+                                        ga: this.gaList.getDataById(key).native.address,
+                                        dpt: this.gaList.getDataById(key).native.dpt,
+                                        autoread: this.gaList.getDataById(key).native.autoread, // issue a GroupValue_Read request to try to get the initial state from the bus (if any)
+                                    },
+                                    this.knxConnection
                                 );
                                 datapoint.on("error", (ga, dptid) => {
                                     this.log.warn("Received data length for GA " + ga + " does not match configured " + dptid);
@@ -456,7 +439,7 @@ class openknx extends utils.Adapter {
                                 this.gaList.setDpById(key, datapoint);
                                 cnt_withDPT++;
                                 this.log.debug(
-                                    `Datapoint ${this.gaList.getDataById(key).native.autoread ? "autoread" : ""} created and GroupValueWrite sent: ${
+                                    `Datapoint ${this.gaList.getDataById(key).native.autoread ? "autoread " : ""}created and GroupValueWrite sent: ${
                                         this.gaList.getDataById(key).native.address
                                     } ${key}`
                                 );
@@ -473,11 +456,28 @@ class openknx extends utils.Adapter {
 
                 disconnected: () => {
                     this.setState("info.connection", false, true);
-                    if (this.disconnectConfirmed) {
+                    if (this.startup != true) {
+                        //do not warn on initial startup or shutdown
                         this.log.warn("Connection lost");
                     }
-                    this.disconnectConfirmed = true;
-                    this.connected = false;
+                    this.startup = false;
+                },
+                error: (connstatus) => {
+                    this.log.warn(connstatus);
+                },
+
+                //l_data.con, confirmation set bei receiver with set ga s flag
+                confirmed: (dest, confirmed) => {
+                    for (const id of this.gaList.getIdsByGa(dest)) {
+                        if (confirmed) //if unconfirmed keep ack at false
+                            this.setState(id, {
+                                ack: true,
+                            });
+                        if (confirmed)
+                            this.log.debug(`confirmation true received for ${dest}`);
+                        else
+                            this.log.info(`confirmation false received for ${dest} ${id}`);
+                    }
                 },
 
                 //KNX Bus event received
@@ -486,26 +486,21 @@ class openknx extends utils.Adapter {
                 event: ( /** @type {string} */ evt, /** @type {string} */ src, /** @type {string} */ dest, /** @type {string} */ val) => {
                     let convertedVal = [];
                     let ret = "unknown";
-                    //workaround, lib can fire event without going through connected state?
-                    if (!this.connected) {
-                        this.knxConnection.Disconnect();
-                        this.startKnxStack();
-                        const err ="event received before initialisation";
-                        this.log.warn(err);
-                        return err;
-                    }
+
+                    this.log.silly(`event  ${evt} src: ${src} dst: ${dest}`);
 
                     if (src == this.config.eibadr) {
-                        //called by self, avoid loop
+                        //L_data.ind of own L_data.req
                         return "receive self ga";
                     }
+
                     /* some checks */
                     if (dest == "0/0/0" || tools.isDeviceAddress(dest)) {
                         //seems that knx lib does not guarantee dest group adresses
                         return "bad address";
                     }
                     if (!this.gaList.getIdsByGa(dest)) {
-                        this.log.warn("Ignoring " + evt + " received unknown GA: " + dest);
+                        this.log.warn(`Ignoring ${evt} received unknown GA: ${dest}`);
                         return "unknown GA";
                     }
 
@@ -525,7 +520,7 @@ class openknx extends utils.Adapter {
                                 this.getState(id, (err, state) => {
                                     let ret;
                                     if (state) {
-                                        this.log.debug("Inbound GroupValue_Read from " + src + " GA " + dest + " to " + id);
+                                        this.log.debug(`Inbound GroupValue_Read from ${src} GA ${dest} to ${id}`);
                                         ret = "GroupValue_Read";
                                         if (this.gaList.getDataById(id).native.answer_groupValueResponse) {
                                             let stateval = state.val;
@@ -534,7 +529,7 @@ class openknx extends utils.Adapter {
                                                 stateval = JSON.parse(state.val);
                                             } catch (e) {}
                                             this.knxConnection.respond(dest, stateval, this.gaList.getDataById(id).native.dpt);
-                                            this.log.error("responding with value " + state.val);
+                                            this.log.debug("responding with value " + state.val);
                                             ret = "GroupValue_Read Respond";
                                         }
                                         return ret;
@@ -641,16 +636,16 @@ class openknx extends utils.Adapter {
                         }
                     }
                     if (startKnxConnection)
-                    try {
-                        this.startKnxStack();
-                    } catch (e) {
-                        if (e.toString().indexOf("not found or has no useful IPv4 address!") !== -1)
-                            //ipaddr: the address has neither IPv6 nor IPv4 format ??
-                            //only handle certain exceptions
-                            this.log.error(`Cannot start KNX Stack ${e}`);
-                        else
-                            throw e;
-                    }
+                        try {
+                            this.startKnxStack();
+                        } catch (e) {
+                            if (e.toString().indexOf("not found or has no useful IPv4 address!") !== -1)
+                                //ipaddr: the address has neither IPv6 nor IPv4 format ??
+                                //only handle certain exceptions
+                                this.log.error(`Cannot start KNX Stack ${e}`);
+                            else
+                                throw e;
+                        }
                 }
             }
         );
@@ -673,4 +668,4 @@ if (require.main !== module) {
 
     // otherwise start the instance directly
     new openknx();
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "iobroker.openknx",
-    "version": "0.1.24",
+    "version": "0.2.2",
     "description": "ioBroker knx Adapter",
     "author": "boellner",
     "homepage": "https://github.com/iobroker-community-adapters/ioBroker.openknx.git",
@@ -29,7 +29,6 @@
     },
     "dependencies": {
         "@iobroker/adapter-core": "^2.6.0",
-        "js-controller": "0.0.6",
         "knx": "2.4.1",
         "similarity": "^1.2.1",
         "xmldom": "^0.6.0",
@@ -37,31 +36,37 @@
     },
     "devDependencies": {
         "@alcalzone/release-script": "^3.5.6",
-        "@iobroker/testing": "^2.5.6",
-        "@types/chai": "^4.3.0",
+        "@iobroker/adapter-dev": "^1.0.0",
+        "@iobroker/adapter-react": "2.1.0",
+        "@iobroker/testing": "^2.6.0",
+        "@material-ui/core": "^4.12.4",
+        "@types/chai": "^4.3.1",
         "@types/chai-as-promised": "^7.1.5",
-        "@types/gulp": "^4.0.9",
-        "@types/mocha": "^9.1.0",
-        "@types/node": "^17.0.23",
+        "@types/mocha": "^9.1.1",
+        "@types/node": "^17.0.35",
         "@types/proxyquire": "^1.3.28",
+        "@types/react-dom": "^18.0.3",
+        "@types/react": "^17.0.45",
         "@types/sinon": "^10.0.11",
         "@types/sinon-chai": "^3.2.8",
-        "axios": "^0.26.1",
         "chai": "^4.3.6",
         "chai-as-promised": "^7.1.1",
-        "eslint": "^8.12.0",
-        "gulp": "^4.0.2",
-        "mocha": "^9.2.2",
+        "eslint": "^8.16.0",
+        "eslint-plugin-react": "^7.30.0",
+        "mocha": "^10.0.0",
         "proxyquire": "^2.1.3",
-        "sinon": "^13.0.1",
+        "react-dom": "^17.0.2",
+        "react": "^17.0.2",
+        "sinon": "^14.0.0",
         "sinon-chai": "^3.7.0",
-        "typescript": "~4.6.3",
-        "iobroker.js-controller": "4.0.21"
+        "typescript": "~4.7.2",
+        "iobroker.js-controller": "4.0.23"
     },
     "main": "main.js",
     "files": [
         "admin{,/!(src)/**}/!(tsconfig|tsconfig.*).json",
         "admin{,/!(src)/**}/*.{html,css,png,svg,jpg,js}",
+        "admin/build/",
         "lib/",
         "www/",
         "io-package.json",
@@ -69,13 +74,20 @@
         "main.js"
     ],
     "scripts": {
+        "prebuild": "rimraf admin/build",
+        "build": "build-adapter react",
+        "watch": "build-adapter react --watch",
+        "prebuild:react": "rimraf admin/build",
+        "build:react": "build-adapter react",
+        "watch:react": "build-adapter react --watch",
         "test:js": "mocha --exit --reporter-option maxDiffSize=50000 --config test/mocharc.custom.json \"{!(node_modules|test)/**/*.test.js,*.test.js,test/**/test!(PackageFiles|Startup).js}\"",
         "test:package": "mocha test/package --exit",
         "test:unit": "mocha test/unit --exit --timeout 3000",
         "test:integration": "mocha test/integration --exit --timeout 15000",
         "test": "npm run test:js && npm run test:package",
         "check": "tsc --noEmit -p tsconfig.check.json",
-        "lint": "eslint",
+        "lint": "eslint --ext .js,.jsx",
+        "translate": "translate-adapter",
         "release": "release-script"
     },
     "bugs": {