iobroker.openknx 0.1.9 → 0.1.13

package/lib/knx/src/dptlib/dpt11.js

@@ -9,7 +9,7 @@ const util = require('util');
 // DPT11.*: date
 //
 exports.formatAPDU = (value) => {
-  if (!value) return log.error('cannot write null value for DPT11');
+  if (value == null) return log.error('cannot write null value for DPT11');
   switch (typeof value) {
     case 'string':
     case 'number':

package/lib/knx/src/dptlib/dpt14.js

@@ -14,7 +14,7 @@ const log = require('log-driver').logger;
  */
 
 exports.formatAPDU = (value) => {
-  if (!value || typeof value != 'number')
+  if (value == null || typeof value != 'number')
     log.error('DPT14: Must supply a number value');
   const apdu_data = Buffer.alloc(4);
   apdu_data.writeFloatBE(value, 0);

package/lib/knx/src/dptlib/dpt18.js

@@ -25,7 +25,7 @@
 const log = require('log-driver').logger;
 
 exports.formatAPDU = function (value) {
-    if (!value) log.warn("DPT18: cannot write null value");
+    if (value == null) log.warn("DPT18: cannot write null value");
     else {
         var apdu_data = new Buffer(1);
         if (typeof value == 'object' &&

package/lib/knx/src/dptlib/dpt2.js

@@ -8,18 +8,20 @@ const log = require('log-driver').logger;
 // DPT2 frame description.
 // Always 8-bit aligned.
 exports.formatAPDU = (value) => {
-  if (!value) return log.error('DPT2: cannot write null value');
+  if (value == null) return log.error('DPT2: cannot write null value');
 
   if (
     typeof value === 'object' &&
     value.hasOwnProperty('priority') &&
     value.hasOwnProperty('data')
   )
-    return Buffer.from([(value.priority << 1) + (value.data & 0b00000001)]);
+    return Buffer.from([((value.priority << 1) & 0b00000010) + (value.data & 0b00000001)]);
 
   log.error('DPT2: Must supply an value {priority:<bool>, data:<bool>}');
   // FIXME: should this return zero buffer when error? Or nothing?
-  return Buffer.from([0]);
+  //a malformed object shall not result in transmission
+  //return Buffer.from([0]);
+  return null;
 };
 
 exports.fromBuffer = (buf) => {

package/lib/knx/src/dptlib/dpt21.js

@@ -17,7 +17,7 @@ const log = require('log-driver').logger;
 
 // FIXME: help needed
 exports.formatAPDU = function(value) {
-    if (!value) return log.error('DPT21: cannot write null value');
+    if (value == null) return log.error('DPT21: cannot write null value');
     log.debug('./knx/src/dpt21.js : input value = ' + value);
 
     //var apdu_data = new Buffer(1);
@@ -31,7 +31,9 @@ exports.formatAPDU = function(value) {
 
     log.error('DPT21: Must supply a value which is an object');
     //return apdu_data;
-    return Buffer.from([0]);
+    //a malformed object shall not result in transmission
+    //return Buffer.from([0]);
+    return null;
 }
 
 exports.fromBuffer = function(buf) {

package/lib/knx/src/dptlib/dpt232.js

@@ -10,7 +10,7 @@ const log = require('log-driver').logger;
 // MSB: Red, Green, LSB: Blue
 //
 exports.formatAPDU = (value) => {
-  if (!value) return log.error('DPT232: cannot write null value');
+  if (value == null) return log.error('DPT232: cannot write null value');
 
   if (typeof value === 'object') {
     const { red, green, blue } = value;

package/lib/knx/src/dptlib/dpt237.js

@@ -9,7 +9,7 @@ const log = require('log-driver').logger;
 // DPT237: 2-byte unsigned value
 //
 exports.formatAPDU = function(value) {
-    if (!value) return log.error('DPT237: cannot write null value');
+    if (value == null) return log.error('DPT237: cannot write null value');
 
     log.trace('dpt278.js : input value = ' + value);
 

package/lib/knx/src/dptlib/dpt3.js

@@ -9,7 +9,7 @@ const log = require('log-driver').logger;
 // DPT3.*: 4-bit dimming/blinds control
 //
 exports.formatAPDU = (value) => {
-  if (!value) return log.warn('DPT3: cannot write null value');
+  if (value == null) return log.warn('DPT3: cannot write null value');
 
   if (
     typeof value == 'object' &&

package/lib/knx/src/dptlib/dpt4.js

@@ -9,7 +9,7 @@ const log = require('log-driver').logger;
 // DPT4: 8-bit character
 //
 exports.formatAPDU = (value) => {
-  if (!value) return log.warn('DPT4: cannot write null value');
+  if (value == null) return log.warn('DPT4: cannot write null value');
 
   if (typeof value !== 'string')
     return log.warn('DPT4: Must supply a character or string');

package/lib/knx/src/dptlib/dpt7.js

@@ -90,5 +90,12 @@ exports.subtypes = {
       "name" : "DPT_Brightness",
       "desc" : "interior brightness",
       "unit" : "lux"
-  }
+  },
+   // 7.600
+   "600" : { "use" : "FB",
+   "name" : "DPT_Absolute_Colour_Temperature",
+   "desc" : "Absolute colour temperature",
+   "unit" : "K"
+}
+  
 }

package/lib/projectImport.js

@@ -1,19 +1,16 @@
-/* eslint-disable quotes */
 "use strict";
 
 const DPTLib = require(__dirname + "/knx/src/dptlib"); //todo copy for the moment
 const select = require("xpath");
-const _ = require("underscore");
 const util = require("util");
 const dom = require("xmldom").DOMParser;
 const tools = require("./tools.js");
-
-let groupAddresses = {};
+const similarity = require("similarity");
 
 module.exports = {
     // get xml Files from index.html via adapter.on 'message' and put it into file Obj
     parseInput: function (adapter, xml, callback) {
-        let fileObjectList = {};
+        const fileObjectList = {};
 
         if (xml) {
             fileObjectList["ga.xml"] = new dom().parseFromString(xml);
@@ -27,45 +24,50 @@ module.exports = {
 
     // generate the Groupaddress structure
     generateIoBObjects: function (adapter, fileObjectList, callback) {
-        groupAddresses = {};
-        let iobrokerObjects = [];
+        const groupAddresses = {};
+        const iobrokerObjects = [];
 
         function processFile(adapter, err, objectList) {
             //from xml export
             const doc = objectList["ga.xml"];
             if (doc)
-                _.each(select.select("//*[local-name(.)='GroupAddress' and string(@Address)]", doc), function (ga) {
+                select.select("//*[local-name(.)='GroupAddress' and string(@Address)]", doc).forEach(ga => {
                     const address = ga.getAttribute("Address");
                     groupAddresses[address] = ga;
                 });
 
             //format and put each found group address into the object tree
-            _.each(groupAddresses, function (groupAddress) {
+            Object.entries(groupAddresses).forEach(([key, groupAddress]) => {
                 const gaName = groupAddress.getAttribute("Name");
                 let autoread = true;
-                const dpt = tools.convertDPTtype(groupAddress.getAttribute("DatapointType") || groupAddress.getAttribute("DPTs")); //DPT or DPTs
                 let dptObj = {};
-                let fullPath = tools.formatGa(gaName);
-                let range = [,];
+                let fullPath = tools.formatGaForIob(gaName);
+                let range = [];
                 let role = "state";
                 let type;
 
                 //add name of Mittelgruppe and Hauptgruppe to fullPath if exist
                 if (groupAddress.parentNode.nodeName === "GroupRange") {
-                    fullPath = tools.formatGa(groupAddress.parentNode.getAttribute("Name")) + "." + fullPath;
+                    fullPath = tools.formatGaForIob(groupAddress.parentNode.getAttribute("Name")) + "." + fullPath;
                     if (groupAddress.parentNode.parentNode.nodeName === "GroupRange") {
-                        fullPath = tools.formatGa(groupAddress.parentNode.parentNode.getAttribute("Name")) + "." + fullPath;
+                        fullPath = tools.formatGaForIob(groupAddress.parentNode.parentNode.getAttribute("Name")) + "." + fullPath;
                     }
                 }
 
+                const dpt = tools.formatDpt(groupAddress.getAttribute("DatapointType") || groupAddress.getAttribute("DPTs")); //DPT or DPTs
                 if (dpt == "") {
-                    const text = "no import of " + fullPath + " address " + groupAddress.getAttribute("Address") + " with no DPT set";
+                    const text = `Not adding ${fullPath} because no DPT is assigned to ${groupAddress.getAttribute("Address")}. The GA is not connected to a KO in ETS`;
                     adapter.log.warn(text);
                     if (!err) err = text;
-                    else err += " ," + text;
+                    else err += "<br/>\n" + text;
                     return;
                 }
-
+                if (dpt.indexOf(".") === -1) {
+                    const text = `${fullPath} ${groupAddress.getAttribute("Address")} has only set a base DPT in ETS. No additional information (e.g. unit) for this GA available.`;
+                    adapter.log.info(text);
+                    if (!err) err = text;
+                    else err += "<br/>\n" + text;
+                }
                 try {
                     dptObj = DPTLib.resolve(dpt);
                 } catch (e) {
@@ -73,14 +75,14 @@ module.exports = {
                 }
 
                 // is there a scalar range? eg. DPT5.003 angle degrees (0=0, ff=360)
-                if (!!dptObj && dptObj.hasOwnProperty("subtype") && dptObj.subtype && dptObj.subtype.hasOwnProperty("scalar_range")) {
+                if (!!dptObj && dptObj.subtype && dptObj.subtype.scalar_range) {
                     range = dptObj.subtype.scalar_range;
-                } else if (!!dptObj && dptObj.hasOwnProperty("scalar_range")) {
+                } else if (!!dptObj && dptObj.scalar_range) {
                     range = dptObj.scalar_range;
-                } else if (!!dptObj && dptObj.hasOwnProperty("subtype") && dptObj.subtype && dptObj.subtype.hasOwnProperty("range")) {
+                } else if (!!dptObj && dptObj.subtype && dptObj.subtype.range) {
                     // just a plain numeric value, only check if within bounds
                     range = dptObj.subtype.range;
-                } else if (!!dptObj && dptObj.basetype && dptObj.basetype.hasOwnProperty("range")) {
+                } else if (!!dptObj && dptObj.basetype && dptObj.basetype.range) {
                     // just a plain numeric value, only check if within bounds
                     range = dptObj.basetype.range;
                 } else if (!!dptObj && !tools.isEmptyObject(dptObj)) {
@@ -116,79 +118,175 @@ module.exports = {
                     range[1] = undefined;
                     type = "number";
                 } else if (tools.isUnknownDPT(dpt)) {
+                    //raw interface
                     range[0] = undefined;
                     range[1] = undefined;
-                    type = "string"; //raw
+                    type = "string";
                 } else {
                     type = "number";
                 }
 
                 //if dpt is for sure not a status, remove from autoread
-                if (tools.isStriggerDPT(dpt)) {
+                if (tools.isTriggerDPT(dpt)) {
                     autoread = false;
                 }
 
+                //https://github.com/ioBroker/ioBroker.docs/blob/master/docs/en/dev/objectsschema.md#objects
                 const iobrokerObject = {
                     _id: fullPath,
                     type: "state",
                     common: {
-                        desc:
-                            "Basetype: " +
-                            (!dptObj || tools.isEmptyObject(dptObj)
-                                ? "raw value"
-                                : dptObj.basetype.desc +
-                                  (Object.prototype.hasOwnProperty.call(dptObj, "subtype") && Object.prototype.hasOwnProperty.call(dptObj, "desc") ? ", Subtype: " + dptObj.subtype.desc : "")),
+                        desc: "Basetype: " +
+                            (!dptObj || tools.isEmptyObject(dptObj) ?
+                                "raw value" :
+                                dptObj.basetype.desc +
+                                (Object.prototype.hasOwnProperty.call(dptObj, "subtype") && Object.prototype.hasOwnProperty.call(dptObj, "desc") ? ", Subtype: " + dptObj.subtype.desc : "")),
                         min: range[0],
                         max: range[1],
                         name: gaName,
                         read: true,
                         role: role, //description: https://github.com/ioBroker/ioBroker/blob/master/doc/STATE_ROLES.md#state-roles
-                        type: type, //default is mixed==any type) (possible values: number, string, boolean, array, object, mixed, file). As exception the objects with type meta could have common.type=meta.user or meta.folder. It is important to note that array, object, mixed and file must be serialized using JSON.stringify().
-                        unit: !!dptObj && Object.prototype.hasOwnProperty.call(dptObj, "subtype") && Object.prototype.hasOwnProperty.call(dptObj, "unit") ? dptObj.subtype.unit : undefined,
+                        type: type, //possible values: number, string, boolean, array, object, mixed, file. It is important to note that array, object, mixed and file must be serialized using JSON.stringify().
+                        unit: !!dptObj && dptObj.subtype && dptObj.subtype.unit ? dptObj.subtype.unit : undefined,
                         write: true,
+                        states: undefined, //todo can be extracted from some dpts
                     },
                     native: {
-                        address: adr2ga(groupAddress.getAttribute("Address")),
+                        address: convertToGa(groupAddress.getAttribute("Address")),
                         answer_groupValueResponse: false, //overwrite manually
                         autoread: autoread,
                         bitlength: !dptObj || tools.isEmptyObject(dptObj) ? undefined : dptObj.basetype.bitlength, //informative
                         dpt: dpt,
                         encoding:
-                            !!dptObj && Object.prototype.hasOwnProperty.call(dptObj, "subtype")
-                                ? Object.prototype.hasOwnProperty.call(dptObj, "enc")
-                                    ? dptObj.subtype.enc
-                                    : dptObj.basetype.enc
-                                : undefined, //informative ,todo matcht zu common.states`? hat basetype enc?
+                            !!dptObj && Object.prototype.hasOwnProperty.call(dptObj, "subtype") ?
+                                Object.prototype.hasOwnProperty.call(dptObj, "enc") ?
+                                    dptObj.subtype.enc :
+                                    dptObj.basetype.enc : undefined, //informative
                         force_encoding:
-                            !!dptObj && Object.prototype.hasOwnProperty.call(dptObj, "subtype") && Object.prototype.hasOwnProperty.call(dptObj, "subtype") && dptObj.subtype
-                                ? dptObj.subtype.force_encoding
-                                : undefined, //DPT16
+                            !!dptObj && Object.prototype.hasOwnProperty.call(dptObj, "subtype") && Object.prototype.hasOwnProperty.call(dptObj, "subtype") && dptObj.subtype ?
+                                dptObj.subtype.force_encoding : undefined, //DPT16
                         signedness:
-                            !!dptObj && !tools.isEmptyObject(dptObj)
-                                ? Object.prototype.hasOwnProperty.call(dptObj, "signedness") && dptObj.basetype
-                                    ? dptObj.basetype.signedness
-                                    : undefined
-                                : undefined, //signed or unsigned or empty
+                            !!dptObj && !tools.isEmptyObject(dptObj) ?
+                                Object.prototype.hasOwnProperty.call(dptObj, "signedness") && dptObj.basetype ?
+                                    dptObj.basetype.signedness :
+                                    undefined : undefined, //signed or unsigned or empty
                         valuetype: !dptObj || tools.isEmptyObject(dptObj) ? undefined : dptObj.basetype.valuetype, //informative: composite or basic
                     },
                 };
 
                 iobrokerObjects.push(iobrokerObject);
             });
-            if (typeof callback === "function") callback(err, iobrokerObjects);
+
+            if (typeof callback === "function") {
+                callback(err, iobrokerObjects);
+            }
         }
 
         // check if fileObjectList is typeof Object
-        if (!fileObjectList.hasOwnProperty("push")) {
+        if (!Object.prototype.hasOwnProperty.call(fileObjectList, "push")) {
             processFile(adapter, null, fileObjectList);
         }
     },
+
+    //find statusGAs based on regexp
+    findStatusGAs(adapter, gaList, callback) {
+        let count = 0;
+        const regex = RegExp(adapter.config.statusRegex, "gi");
+        for (const statusElement of gaList) {
+            if (regex.test(statusElement)) {
+                //for all status gas
+                const reducedStatusElement = statusElement.replace((regex), "");
+                const nonStatusElement = Array.from(gaList).reduce((previousValue, currentValue) => {
+                    //compare with all others
+                    if (!previousValue) {
+                        return currentValue;
+                    }
+                    if (currentValue === statusElement) {
+                        //found itself, skip
+                        return previousValue;
+                    }
+                    if (regex.test(currentValue)) {
+                        //found another status, skip
+                        return previousValue;
+                    }
+                    //reduce the list to the best match
+                    if (similarity(unify(currentValue,adapter), unify(reducedStatusElement,adapter)) > similarity(unify(previousValue,adapter), unify(reducedStatusElement, adapter))) {
+                        return currentValue;
+                    } else {
+                        return previousValue;
+                    }
+                });
+                const a = unify(reducedStatusElement, adapter);
+                const b = unify(nonStatusElement, adapter);
+                if (similarity(a, b) > adapter.config.regexSimil) {
+                    //found a match that is not and status and good enough, generate alias object
+                    createAlias(adapter, nonStatusElement, statusElement);
+                    count++;
+                    adapter.log.info("create aliases: found match " + nonStatusElement + " and " + statusElement);
+                }
+            }
+        }
+        callback(count);
+    }
 };
 
+/* make strings comparable*/
+function unify(element, adapter) {
+    element = element.toLowerCase().replace(/_/g,"");
+    if (!(adapter.config.aliasRange)) {
+        //exclude group names from search if user sets
+        const n = element.lastIndexOf(".");
+        element = element.substring(n + 1);
+    }
+    return element;
+}
+
+
 //possibly convert 2byte value into ././. form
-function adr2ga(adr) {
+function convertToGa(adr) {
     //check if already in good format
     if (adr.includes("/")) return adr;
     //Bereiche: Hauptgruppe = 0..31, Mittelgruppe = 0..7, Untergruppe = 0..255
     return util.format("%d/%d/%d", (adr >> 11) & 0x1f, (adr >> 8) & 0x7, adr & 0xff);
 }
+
+function createAlias(adapter, idDst, idSrc) {
+    adapter.getObject(idDst, null, (err, obj) => {
+        if (obj != null) {
+            const dstObj = obj;
+            adapter.getObject(idSrc, null, (err, srcObj) => {
+                if (srcObj != null) {
+                    const aliasId = adapter.config.aliasPath + dstObj._id.replace(adapter.namespace, "");
+                    const aliasObject = {
+                        "_id": aliasId,
+                        "type": "state",
+                        "common": {
+                            "name": dstObj.common.name,
+                            "desc": dstObj.common.desc,
+                            "role": dstObj.common.role,
+                            "type": dstObj.common.type,
+                            "read": dstObj.common.read,
+                            "write": dstObj.common.write,
+                            "unit": dstObj.common.unit,
+                            "min": dstObj.common.min,
+                            "max": dstObj.common.max,
+                            "def": "",
+                            "alias": {
+                                "id": {
+                                    "read": srcObj._id,
+                                    "write": dstObj._id
+                                }
+                            }
+                        },
+                    };
+
+                    adapter.setForeignObject(aliasId, aliasObject, (err, obj) => {});
+                } else {
+                    adapter.log.debug("createAlias: source object not found: " + idSrc);
+                }
+            });
+        } else {
+            adapter.log.debug("createAlias: destination object not found: " + idDst);
+        }
+    });
+}