iobroker.openknx 0.1.9 → 0.1.13

package/main.js

@@ -11,8 +11,8 @@ const utils = require("@iobroker/adapter-core");
 const projectImport = require(__dirname + "/lib/projectImport");
 
 const knx = require(__dirname + "/lib/knx"); //todo copy for the moment
-const _ = require("underscore");
 const tools = require("./lib/tools.js");
+const DoubleKeyedMap = require("./lib/doubleKeyedMap.js");
 
 class openknx extends utils.Adapter {
     /**
@@ -34,6 +34,28 @@ class openknx extends utils.Adapter {
         this.on("unload", this.onUnload.bind(this));
 
         this.mynamespace = this.namespace;
+
+        //redirect log from knx.js to adapter log
+        console.log = (args) => {
+            if (args && typeof args === "string") {
+                if (args.indexOf("deferring outbound_TUNNELING_REQUEST") !== -1) {
+                    return;
+                }
+                if (args.indexOf("[debug]") !== -1) {
+                    this.log.debug(args);
+                } else if (args.indexOf("[info]") !== -1) {
+                    this.log.info(args);
+                } else if (args.indexOf("[warn]") !== -1) {
+                    this.log.warn(args);
+                } else if (args.indexOf("[error]") !== -1) {
+                    this.log.error(args);
+                }else if (args.indexOf("[trace]") !== -1) {
+                    this.log.silly(args);
+                } else {
+                    this.log.info(args);
+                }
+            }
+        };
     }
 
     /**
@@ -107,9 +129,22 @@ class openknx extends utils.Adapter {
                         });
                     });
                     break;
+                case "createAlias":
+                    this.log.info("Create aliases...");
+                    projectImport.findStatusGAs(this, this.gaList, (count) => {
+                        if (obj.callback) {
+                            const res = {
+                                error: null,
+                                count: count,
+                            };
+                            this.sendTo(obj.from, obj.command, res, obj.callback);
+                        }
+                    });
+                    break;
                 case "reset":
                     this.log.info("Restarting...");
                     this.restart();
+                // eslint-disable-next-line no-fallthrough
                 default:
                     this.log.warn("Unknown command: " + obj.command);
                     break;
@@ -130,9 +165,8 @@ class openknx extends utils.Adapter {
         }
         if (onlyAddNewObjects) {
             //if user setting Add only new Objects write only new objects
-            //extend object will overwrite user made element changes if known in the import, not intended
-            //this.extendObject(this.mynamespace + "." + objects[index]._id, objects[index], (err, obj) => {
-            this.setObjectNotExists(this.mynamespace + '.' + objects[index]._id, objects[index], (err, obj) => {
+            //extend object would overwrite user made element changes if known in the import, not intended
+            this.setObjectNotExists(this.mynamespace + "." + objects[index]._id, objects[index], (err, obj) => {
                 if (err) {
                     this.log.warn("error store Object " + objects[index]._id + " " + (err ? " " + err : ""));
                 }
@@ -140,7 +174,7 @@ class openknx extends utils.Adapter {
             });
         } else {
             //setObjet to overwrite all existing settings, default
-            this.setForeignObject(this.mynamespace + "." + objects[index]._id, objects[index], (err, obj) => {
+            this.setObject(this.mynamespace + "." + objects[index]._id, objects[index], (err, obj) => {
                 if (err) {
                     this.log.warn("error store Object " + objects[index]._id + (err ? " " + err : ""));
                 }
@@ -155,7 +189,6 @@ class openknx extends utils.Adapter {
     warnDuplicates(objects) {
         const arr = [];
         const duplicates = [];
-        let message;
 
         for (const object of objects) {
             arr.push(object._id);
@@ -167,17 +200,17 @@ class openknx extends utils.Adapter {
             }
         }
 
-        message = "Object with identical Group Address name not created: " + duplicates;
+        const message = "Object with an already existing Group Address name has not been created: " + duplicates;
         if (duplicates.length) {
             this.log.warn(message);
         }
         return duplicates.length ? message : null;
     }
 
-    //obj to string and date to number for iobroker, convert to object for knx
+    //obj to string and date to number for iobroker from knx stack
     convertType(val) {
         let ret;
-        //convert, state value for iobroker to set has to be one of type "string", "number", "boolean" and not type "object"
+        //convert, state value for iobroker to set has to be one of type "string", "number", "boolean" and additionally type "object"
         if (val instanceof Date) {
             //convert Date to number
             ret = Number(new Date(val));
@@ -185,11 +218,10 @@ class openknx extends utils.Adapter {
             //before object check
             ret = val.toString("hex");
         } else if (typeof val === "object") {
+            //https://github.com/ioBroker/ioBroker.docs/blob/master/docs/en/dev/objectsschema.md#states
             ret = JSON.stringify(val);
-        } else if (typeof val === "string") {
-            //use as is
         } else {
-            //both can handle number and boolean
+            //keep sring, boolean and number
             ret = val;
         }
         return ret;
@@ -221,8 +253,18 @@ class openknx extends utils.Adapter {
         }
 
         if (state.ack) {
+            //ack flag is responsible to set act flag, only continue when application triggered a change without ack flag
+
             //enable this for system testing
             //this.interfaceTest(id, state);
+
+            //check if actGa is available to set the value from status to actGa
+            if (this.gaList.getDataById(id).native.actGA) {
+                const actGa = this.gaList.getDataById(id).native.actGA;
+                const gaId = this.gaList.getIdByAddress(actGa);
+                this.log.debug("Set GA " + actGa + " to " + state.val + " from " + id);
+                this.setState(gaId, state.val, true);
+            }
             return;
         }
 
@@ -231,16 +273,30 @@ class openknx extends utils.Adapter {
         let knxVal;
         let rawVal;
 
+        //check for boolean and ensure the correct datatype
+        if (this.gaList.getDataById(id).common && this.gaList.getDataById(id).common.type === "boolean") {
+            state.val = state.val ? true : false;
+        }
+        if (this.gaList.getDataById(id).common && this.gaList.getDataById(id).common.type === "number") {
+            if (isNaN(Number(state.val))) {
+                this.log.warn("Value " +state.val + " for "+ id + " is not a number");
+            }
+        }
         //convert val into object for certain dpts
         if (tools.isDateDPT(dpt)) {
             //before composite check, date is also composite
             knxVal = new Date(state.val);
         } else if (this.gaList.getDataById(id).native.valuetype == "composite") {
-            try {
-                knxVal = JSON.parse(state.val);
-            } catch (e) {
-                this.log.warn("stateChange: unsupported value format " + state.val + " for " + ga);
-                return;
+            //input from IOB is either object or string in object notation, type of this conversion is object needed by the knx lib
+            if (typeof state.val == "object") {
+                knxVal = state.val;
+            } else {
+                try {
+                    knxVal = JSON.parse(state.val);
+                } catch (e) {
+                    this.log.warn("stateChange: unsupported value format " + state.val + " for " + ga);
+                    return;
+                }
             }
         } else if (tools.isStringDPT(dpt)) {
             knxVal = state.val;
@@ -249,17 +305,17 @@ class openknx extends utils.Adapter {
             //bitlength is the buffers bytelength * 8.
             rawVal = Buffer.from(state.val, "hex");
             isRaw = true;
-            this.log.warn("Missing implementation for unhandeled DPT " + dpt + ", assuming raw values");
+            this.log.debug("Unhandeled DPT " + dpt + ", assuming raw value");
         } else {
             knxVal = state.val;
         }
 
         if (state.c == "GroupValue_Read") {
             //interface to trigger GrouValue_Read is this comment
-            this.log.debug("Outgoing GroupValue_Read to " + ga + " value " + knxVal);
+            this.log.debug("Outbound GroupValue_Read to " + ga + " value " + JSON.stringify(knxVal));
             this.knxConnection.read(ga);
         } else if (this.gaList.getDataById(id).common.write) {
-            this.log.debug("Outgoing GroupValue_Write to " + ga + " value " + (isRaw ? rawVal : knxVal) + " from " + id);
+            this.log.debug("Outbound GroupValue_Write to " + ga + " value " + (isRaw ? rawVal : JSON.stringify(knxVal)) + " from " + id);
             if (isRaw) {
                 this.knxConnection.writeRaw(ga, rawVal);
             } else {
@@ -293,21 +349,18 @@ class openknx extends utils.Adapter {
                             if (this.gaList.getDataById(key).native.address.match(/\d*\/\d*\/\d*/) && this.gaList.getDataById(key).native.dpt) {
                                 try {
                                     const dp = new 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
                                     );
                                     this.gaList.setDpById(key, dp);
                                     cnt_withDPT++;
                                     this.log.debug(
-                                        "Datapoint " +
-                                        (this.gaList.getDataById(key).native.autoread ? "autoread " : "") +
-                                        "created and GroupValueWrite sent: " +
-                                        this.gaList.getDataById(key).native.address +
-                                        " " +
-                                        key
+                                        `Datapoint ${this.gaList.getDataById(key).native.autoread ? "autoread " : ""} created and GroupValueWrite sent: ${
+                                            this.gaList.getDataById(key).native.address
+                                        } ${key}`
                                     );
                                 } catch (e) {
                                     this.log.warn("could not create KNX Datapoint for " + key + " with error: " + e);
@@ -333,7 +386,11 @@ class openknx extends utils.Adapter {
                 },
 
                 //KNX Bus event received
-                event: ( /** @type {string} */ evt, /** @type {string} */ src, /** @type {string} */ dest, /** @type {string} */ val) => {
+
+                //src: KnxDeviceAddress, dest: KnxGroupAddress
+                event: (/** @type {string} */ evt, /** @type {string} */ src, /** @type {string} */ dest, /** @type {string} */ val) => {
+                    let convertedVal;
+
                     if (src == this.config.eibadr) {
                         //called by self, avoid loop
                         //console.log('receive self ga: ', dest);
@@ -341,12 +398,15 @@ class openknx extends utils.Adapter {
                     }
 
                     /* some checks */
+                    if (dest == "0/0/0" || tools.isDeviceAddress(dest)) {
+                        //seems that knx lib does not guarantee dest group adresses
+                        return;
+                    }
                     if (!this.gaList.getDpByAddress(dest)) {
-                        this.log.warn("Ignoring " + evt + " received on unknown GA: " + dest);
+                        this.log.warn("Ignoring " + evt + " received on unknown GA: " + dest + ". GA was not in imported XML");
                         return;
                     }
 
-                    let convertedVal;
                     if (tools.isStringDPT(this.gaList.getDataByAddress(dest).native.dpt)) {
                         convertedVal = this.gaList.getDpByAddress(dest).current_value;
                     } else {
@@ -356,13 +416,11 @@ class openknx extends utils.Adapter {
                     switch (evt) {
                         case "GroupValue_Read":
                             //fetch val from addressed object and write on bus if configured to answer
-                            this.getForeignState(this.gaList.getIdByAddress(dest), (err, state) => {
+                            this.getState(this.gaList.getIdByAddress(dest), (err, state) => {
                                 if (state) {
-                                    this.log.debug("Incoming GroupValue_Read from " + src + " to " + "(" + dest + ") " + this.gaList.getDataByAddress(dest).common.name);
+                                    this.log.debug("Inbound GroupValue_Read from " + src + " to " + "(" + dest + ") " + this.gaList.getDataByAddress(dest).common.name);
                                     if (this.gaList.getDataByAddress(dest).native.answer_groupValueResponse) {
-                                        //https://bitbucket.org/ekarak/knx.js/issues/83/send-groupvalue_response
-                                        //workaround, send out a write instead response
-                                        this.knxConnection.write(dest, state.val, this.gaList.getDataByAddress(dest).native.dpt);
+                                        this.knxConnection.respond(dest, state.val, this.gaList.getDataByAddress(dest).native.dpt);
                                         this.log.debug("responding with value " + state.val);
                                     }
                                 }
@@ -374,7 +432,7 @@ class openknx extends utils.Adapter {
                                 val: convertedVal,
                                 ack: true,
                             });
-                            this.log.debug("Incoming GroupValue_Response from " + src + " to " + "(" + dest + ") " + this.gaList.getDataByAddress(dest).common.name + ": " + convertedVal);
+                            this.log.debug(`Inbound GroupValue_Response from ${src} to (${dest}) ${this.gaList.getDataByAddress(dest).common.name} :  ${convertedVal}`);
                             break;
 
                         case "GroupValue_Write":
@@ -383,15 +441,9 @@ class openknx extends utils.Adapter {
                                 ack: true,
                             });
                             this.log.debug(
-                                "Incoming GroupValue_Write ga: " +
-                                dest +
-                                "  val: " +
-                                convertedVal +
-                                " dpt: " +
-                                this.gaList.getDataByAddress(dest).native.dpt +
-                                " to Object: " +
-                                this.gaList.getIdByAddress(dest)
+                                `Inbound GroupValue_Write ${dest} val: ${convertedVal}  dpt: ${this.gaList.getDataByAddress(dest).native.dpt} to Object: ${this.gaList.getIdByAddress(dest)}`
                             );
+
                             break;
 
                         default:
@@ -412,7 +464,7 @@ class openknx extends utils.Adapter {
             const out = outpath + id.replace(inpath, "");
             this.setState(out, {
                 val: state.val,
-                ack: true,
+                ack: false,
             });
         }
     }
@@ -437,7 +489,7 @@ class openknx extends utils.Adapter {
                     for (let i = res.rows.length - 1; i >= 0; i--) {
                         const id = res.rows[i].id;
                         const value = res.rows[i].value;
-                        if (value && value.native.address != undefined) {
+                        if (value && value.native && value.native.address != undefined) {
                             //add only elements from tree that are knx objects, identified by a group adress
                             this.gaList.set(id, value.native.address, res.rows[i].value);
                         }
@@ -449,59 +501,6 @@ class openknx extends utils.Adapter {
     }
 }
 
-class DoubleKeyedMap {
-    constructor() {
-        //id, ga
-        this.keymap = new Map();
-        //id,  iobroker object
-        this.data = new Map();
-        //id, knx dp
-        this.dp = new Map();
-    }
-    //update or add
-    set(id, address, data) {
-        this.keymap.set(address, id);
-        this.data.set(id, data);
-    }
-    //only dp returns transformed value, hold a reference to it
-    setDpById(id, dp) {
-        this.dp.set(id, dp);
-    }
-    getDpById(id) {
-        return this.dp.get(id);
-    }
-    getDpByAddress(address) {
-        return this.dp.get(this.keymap.get(address));
-    }
-    getDataById(id) {
-        return this.data.get(id);
-    }
-    getDataByAddress(address) {
-        return this.data.get(this.keymap.get(address));
-    }
-    getIdByAddress(address) {
-        return this.keymap.get(address);
-    }
-
-    //key value is id
-    [Symbol.iterator] = () => {
-        return {
-            index: -1,
-            data: this.data,
-            next() {
-                return ++this.index < this.data.size ?
-                    {
-                        done: false,
-                        value: Array.from(this.data.keys())[this.index],
-                    } :
-                    {
-                        done: true,
-                    };
-            },
-        };
-    };
-}
-
 if (require.main !== module) {
     // Export the constructor in compact mode
     /**
@@ -511,4 +510,4 @@ if (require.main !== module) {
 } else {
     // otherwise start the instance directly
     new openknx();
-}
+}

package/package.json

@@ -1,37 +1,26 @@
 {
     "name": "iobroker.openknx",
-    "version": "0.1.9",
+    "version": "0.1.13",
     "description": "ioBroker knx Adapter",
     "author": "boellner",
     "homepage": "https://github.com/iobroker-community-adapters/ioBroker.openknx.git",
     "license": "GPL-3.0-only",
     "keywords": [
         "ioBroker",
-        "knx",
-        "Smart Home",
-        "home automation"
+        "knx", "eib", "ets",
+        "bus", "communication",
+        "Smart Home", "home automation", "Heimautomatisierung"
     ],
     "repository": {
         "type": "git",
         "url": "https://github.com/iobroker-community-adapters/ioBroker.openknx"
     },
-    "dependencies_unused": {
-        "binary-parser": "^1.1.5",
-        "binary-protocol": "^0.0.0",
-        "fs": "^0.0.2",
-        "ipaddr.js": "1.2.0",
-        "ipv4.js": "^0.0.2",
-        "machina": "^2.0.0-1",
-        "similarity": "^1.1.0",
-        "xml2js": "^0.4.17",
-        "xml2js-xpath": "^0.7.0"
-    },
     "dependencies": {
         "@iobroker/adapter-core": "^2.5.1",
         "knx": "2.4.1",
-        "underscore": "^1.8.3",
-        "xmldom": "^0.1.27",
-        "xpath": "0.0.23"
+        "xmldom": "^0.6.0",
+        "xpath": "0.0.32",
+        "similarity": "^1.2.1"
     },
     "devDependencies": {
         "@alcalzone/release-script": "^2.2.1",
@@ -69,9 +58,8 @@
         "test:js": "mocha --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",
-        "test:integration": "mocha test/integration --exit",
+        "test:integration": "mocha test/integration --exit --timeout 15000",
         "test": "npm run test:js && npm run test:package",
-        "test:myunittest": "mocha test/test --exit",
         "check": "tsc --noEmit -p tsconfig.check.json",
         "lint": "eslint",
         "release": "release-script"