iobroker.zigbee 3.1.6 → 3.2.0

package/lib/commands.js

@@ -1,13 +1,11 @@
 'use strict';
 
-const getZbId = require('./utils').getZbId;
-const getNetAddress = require('./utils').getNetAddress;
-const reverseByteString = require('./utils').reverseByteString;
+const { getZbId, getNetAddress, reverseByteString, zbIdorIeeetoAdId, adIdtoZbIdorIeee } = require('./utils');
 const fs = require('fs');
 const statesMapping = require('./devices');
-const utils = require('@iobroker/adapter-core'); // Get common adapter utils
 const colors = require('./colors.js');
 /* currently not needed, kept for referencce
+const utils = require('@iobroker/adapter-core'); // Get common adapter utils
 const dns = require('dns');
 const net = require('net');
 const access = fs.access;
@@ -54,12 +52,12 @@ class Commands {
     /**
      * @param {ioBroker.Message} obj
      */
-    onMessage(obj) {
+    async onMessage(obj) {
         if (typeof obj === 'object' && obj.command) {
             if (obj) {
                 switch (obj.command) {
                     case 'testConnect':
-                        this.adapter.testConnect(obj.from, obj.command, obj.message, obj.callback);
+                        this.adapter.sendTo(obj.from, obj.command, await this.adapter.testConnect(obj.message), obj.callback);
                         break;
                     case 'deleteNVBackup':
                         this.delNvBackup(obj.from, obj.command, {}, obj.callback);
@@ -153,7 +151,7 @@ class Commands {
                         break;
                     case 'updateLocalConfigItems':
                         if (obj.message && typeof obj.message === 'object') {
-                            this.updateLocalConfigItems(obj.from, obj.command, obj.message, obj.callback);
+                            this.updateConfigItems(obj.from, obj.command, obj.message, obj.callback);
                         }
                         break;
                     case 'getLocalConfigItems':
@@ -298,8 +296,7 @@ class Commands {
 
             if (await this.zbController.permitJoin(cTimer, devId)) {
                 this.adapter.setState('info.pairingMode', cTimer > 0, true);
-                if (devId) this.zbController.emit(`Pairing started for ${devId}`);
-                this.adapter.sendTo(from, command, cTimer ? 'Start pairing!':'Stop pairing!', callback);
+                //this.adapter.sendTo(from, command, cTimer ? 'Start pairing!':'Stop pairing!', callback);
             }
             else {
                 this.adapter.sendTo(
@@ -340,7 +337,7 @@ class Commands {
     }
 
     async handleGroupforInfo(group, groups) {
-        group.icon = 'img/group.png';
+        group.icon = 'img/group_1.png';
         group.vendor = 'ioBroker';
         // get group members and store them
         const match = /zigbee.\d.group_([0-9]+)/.exec(group._id);
@@ -352,8 +349,8 @@ class Commands {
                 const memberinfo = [];
                 for (const member of groupmembers) {
                     if (member && typeof member.ieee === 'string') {
-                        const memberId = member.ieee.substr(2);
-                        const device = await this.adapter.getObjectAsync(`${this.adapter.namespace}.${member.ieee.substr(2)}`);
+                        const memberId = zbIdorIeeetoAdId(this.adapter, member.ieee, false);
+                        const device = await this.adapter.getObjectAsync(zbIdorIeeetoAdId(this.adapter, member.ieee, true));
                         const item = groups[memberId] || { groups:[], gep: { }};
                         const gep = item.gep[member.epid] || [];
 
@@ -361,12 +358,12 @@ class Commands {
                         if (!gep.includes(`${groupID}`)) gep.push(`${groupID}`);
                         item.gep[member.epid] = gep;
                         groups[memberId] = item;
-                        if (device) {
-                            member.device = device.common.name;
-                        } else {
-                            member.device = 'unknown';
-                        }
-                        memberinfo.push(member);
+                        memberinfo.push({
+                            ieee:member.ieee,
+                            epid:member.epid,
+                            model:member.model,
+                            device:device? device.common.name:'unknown'
+                        });
                     }
                 }
                 group.memberinfo = memberinfo;
@@ -414,6 +411,8 @@ class Commands {
                 setOptions: this.adapter.stController.localConfig.getByModel(device.info?.mapped?.model || 'unknown') || [],
                 devices: [device],
             }
+            if (!models.byUID[UID].model.type)
+                models.byUID[UID].model.type = 'Group';
             models.UIDbyModel[device.info?.mapped?.model || 'unknown'] = UID;
         }
         // check configuration
@@ -432,6 +431,20 @@ class Commands {
     }
 
     buildDeviceInfo(device) {
+        function getKey(object, value) {
+            try {
+                for (const key of Object.keys(object)) {
+                    if (object[key] == value) {
+                        return key;
+                    }
+                }
+            }
+            catch {
+                return undefined;
+            }
+            return undefined;
+
+        }
         const rv = {};
         try {
             rv.device = {
@@ -456,22 +469,29 @@ class Commands {
                 const ep = device.endpoints[ep_idx];
                 rv.endpoints.push({
                     ID:ep.ID,
+                    epName: device.mapped?.endpoint ? getKey(device.mapped?.endpoint(device), ep.ID) : ep.ID,
                     profile:ep.profileID,
                     input_clusters:ep.inputClusters,
                     output_clusters:ep.outputClusters,
                 })
+                if (ep.inputClusters.includes(4)) rv.device.isGroupable = true;
             }
             if (device.mapped) {
                 rv.mapped = {
                     model:device.mapped.model,
+                    type:device.device.type,
                     description:device.mapped.description,
+                    hasLegacyDef:statesMapping.hasLegacyDevice(device.mapped.model),
                     //fingerprint:JSON.stringify(device.mapped.fingerprint),
                     vendor:device.mapped.vendor,
                     hasOnEvent:device.mapped.onEvent != undefined,
                     hasConfigure:device.mapped.configure != undefined,
+                    icon:`img/${device.mapped.model.replace(/\//g, '-')}.png`,
+                    legacyIcon: statesMapping.getIconforLegacyModel(device.mapped.model),
                     options:[],
                 }
                 if (device.mapped.options && typeof (device.mapped.options == 'object')) {
+                    rv.mapped.optionExposes = device.mapped.options;
                     for (const option of device.mapped.options) {
                         if (option.name) {
                             rv.mapped.options.push(option.name);
@@ -482,6 +502,7 @@ class Commands {
             else {
                 rv.mapped = {
                     model:device.name,
+                    type: device.device.type,
                     description:device.name,
                     vendor:'not set',
                     hasOnEvent: false,
@@ -511,14 +532,14 @@ class Commands {
                 paired: true,
                 info: this.buildDeviceInfo(device),
                 native: { id: device.device.ieeeAddr.substring(2) },
-                mapped : { model:'Coordinator' },
+                mapped : { model: client.modelID || client.type || 'NotSet' },
                 statesDev: [],
             }
-            if (device.device.name === 'Coordinator') {
+            if (device.name === 'Coordinator') {
                 coordinatorData.icon = 'zigbee.png';
-                coordinatorData.common = { name: undefined, type: undefined  };
-            } else {
                 coordinatorData.common = { name: 'Coordinator', type: 'Coordinator'  };
+            } else {
+                coordinatorData.common = { name: device.mapped?.model || 'unknown', type: device.type  };
                 coordinatorData.icon= 'img/unknown.png';
             }
             devices.push(coordinatorData);
@@ -547,8 +568,7 @@ class Commands {
                 const modelDesc = statesMapping.findModel(devInfo.common.type);
                 devInfo.icon = (modelDesc && modelDesc.icon) ? modelDesc.icon : 'img/unknown.png';
                 devInfo.vendor = modelDesc ? modelDesc.vendor : '';
-                const legacyDesc = statesMapping.findModel(devInfo.common.type, true);
-                devInfo.legacyIcon = (legacyDesc && legacyDesc.icon) ? legacyDesc.icon : undefined;
+                devInfo.legacyIcon = statesMapping.getIconforLegacyModel(devInfo.common.type);
                 const lq_state = all_states[`${devInfo._id}.link_quality`];
                 devInfo.link_quality = lq_state ? lq_state.val : -1;
                 devInfo.link_quality_lc = lq_state ? lq_state.lc : undefined;
@@ -698,32 +718,43 @@ class Commands {
         }
     }
 
-    deleteZigbeeDevice(from, command, msg, callback) {
+    async deleteZigbeeDevice(from, command, msg, callback) {
         if (this.zbController && this.zbController.herdsmanStarted && this.stController) {
             this.debug(`deleteZigbeeDevice message: ${JSON.stringify(msg)}`);
             const id = msg.id;
             const force = msg.force;
-            const sysid = id.replace(this.adapter.namespace + '.', '0x');
+            const sysid = id.startsWith(this.adapter.namespace) ?  id.replace(this.adapter.namespace + '.', '0x') : `0x${id}`;
             const devId = id.replace(this.adapter.namespace + '.', '');
             this.debug(`deleteZigbeeDevice sysid: ${sysid}`);
             const dev = this.zbController.getDevice(sysid);
             if (!dev) {
+
                 this.info(`Attempted to delete device ${devId} - the device is not known to the zigbee controller.`);
-                this.stController.deleteObj(devId, () =>
-                    this.adapter.sendTo(from, command, {}, callback));
+                const err = await this.stController.deleteObj(devId);
+                if (err != '') this.adapter.sendTo(from, command, {errror:err}, callback);
+                else this.adapter.sendTo(from, command, {}, callback);
                 return;
             }
             this.info(`${force ? 'Force removing' : 'Gracefully removing '} device ${devId} from the network.`);
-            this.zbController.remove(sysid, force, err => {
+            this.zbController.remove(sysid, force, async (err) => {
                 if (!err) {
                     this.info('Device removed from the network, deleting objects.')
-                    this.stController.deleteObj(devId, () => {
-                        this.adapter.sendTo(from, command, {}, callback);
-                    });
+                    if (!force) {
+                        const err = await this.stController.deleteObj(devId);
+                        if (err == '') this.adapter.sendTo(from, command, {}, callback);
+                        else this.adapter.sendTo(from, command, {error:err}, callback);
+                    }
+                    this.adapter.sendTo(from, command, {}, callback);
+                    this.adapter.stController.localConfig.removeLocalData()
                 } else {
                     this.adapter.sendTo(from, command, {error: err}, callback);
                 }
             });
+            if (force) {
+                const err = await this.stController.deleteObj(devId);
+                if (err != '') this.adapter.sendTo(from, command, {errror:err}, callback);
+                else this.adapter.sendTo(from, command, {}, callback);
+            }
         } else {
             this.adapter.sendTo(from, command, {error: 'No active connection to Zigbee Hardware!'}, callback);
         }
@@ -818,43 +849,47 @@ class Commands {
         }
     }
 
-    async updateLocalConfigItems(from, command, msg, callback) {
+    async updateConfigItems(from, command, msg, callback) {
         if (this.stController) {
-            this.debug(`updateLocalConfigItems : ${JSON.stringify(msg)}`);
-            const target = msg.target.replace(`${this.adapter.namespace}.`, '');
-            const entity = await this.zbController.resolveEntity(target);
-            if (entity && !entity.mapped) {
-                this.warn('unable to set local Override for device whithout mapped model');
+            this.debug(`updateConfigItems : ${JSON.stringify(msg)}`);
+            if (msg == {}) {
+                this.adapter.sendTo(from, command, {}, callback);
                 return;
             }
-            if (msg.data)
+            const target = msg.target ? msg.target.replace(`${this.adapter.namespace}.`, '') : '';
+            const entity = await this.zbController.resolveEntity(target);
+            if (msg.data);
             {
                 for (const prop in msg.data) {
                     if (prop==='options') {
                         // we need to trigger the option change
-                        const changed_from = entity.options;
-                        const changed_to = msg.data.prop;
-                        /*
-                        const allKeys = Object.keys(changed_from);
-                        for (const nk of Object.keys(changed_to)) {
-                            if (allKeys.includes(nk)) continue;
-                            allKeys.push(nk);
-                        }
-                        for (const key of allKeys) {
-                            if (changed_from.hasOwnProperty(key) && changed_to.hasOwnProperty(key) && changed_from[key] == changed_to[key])
-                            {
-                                delete changed_from[key];
-                                delete changed_to[key];
+                        // first: retrieve the global options.
+                        const newOptions = {};
+                        const globalOptions = this.stController.localConfig.getLocalOverride(target, entity?.mapped?.model || '', prop, true)?.options;
+                        if (globalOptions) {
+                            for (const key of Object.keys(entity.options)) {
+                                if (globalOptions[key] != undefined)
+                                    newOptions[key] = globalOptions[key];
                             }
                         }
-                        */
-                        this.zbController.callExtensionMethod(
-                            'onZigbeeEvent',
-                            [{'device': entity.device, 'type': 'deviceOptionsChanged', from: changed_from, to:changed_to  || {}, }, entity ? entity.mapped : null]);
+                        for (const key of Object.keys(msg.data.options)) {
+                            newOptions[key]= msg.data.options[key];
+                        }
+                        if (entity && entity.device) {
+                            this.zbController.callExtensionMethod(
+                                'onZigbeeEvent',
+                                [{'device': entity.device, 'type': 'deviceOptionsChanged', from: entity.options, to:newOptions  || {}, }, entity.mapped]);
+                        }
                     }
-                    this.debug('enumerating data: ' + prop);
-                    await this.stController.localConfig.updateLocalOverride(target, (entity ? entity.mapped.model : 'group'), prop, msg.data[prop], msg.global);
+                    this.warn(`enumerating data: ${JSON.stringify(prop)}`);
+                    let val = msg.data[prop];
+                    if (typeof val === 'string') {
+                        val = val.trim();
+                        if (val.length < 1) val = '##REMOVE##';
+                    }
+                    await this.stController.localConfig.updateLocalOverride(target, target, prop, val, msg.global);
                 }
+                await this.stController.localConfig.retainData();
             }
             try {
                 if (entity) {
@@ -862,8 +897,12 @@ class Commands {
                     this.stController.updateDev(target, entity.mapped.model, entity.mapped.model, () => {this.adapter.sendTo(from, command, {}, callback)});
                 }
                 else {
-                    this.debug('updateLocalConfigItems without Entity');
-                    this.stController.updateDev(target, undefined, 'group',() => {this.adapter.sendTo(from, command, {}, callback)});
+                    // try to see if it is a model -> find the devices for that model
+                    const devicesFromObjects = (await this.adapter.getDevicesAsync()).filter(item => item.common.type === target).map((item) => item.native.id);
+                    for (const device of devicesFromObjects) {
+                        await this.stController.updateDev(device, target, target);
+                    }
+
                 }
             }
             catch (error) {

package/lib/devices.js

@@ -3165,9 +3165,16 @@ function setLegacyDevices(legacyModels) {
 }
 
 function getIconforLegacyModel(model) {
+    const mid = findModel(model, true);
+    if (!mid) return undefined;
+    return mid.icon;
 
 }
 
+function hasLegacyDevice(model) {
+    return Boolean(findModel(model, true));
+}
+
 module.exports = {
     devices,
     legacy_devices,
@@ -3183,5 +3190,7 @@ module.exports = {
     findModel,
     fillDevicesForLegacy,
     pairedLegacyDevices,
-    setLegacyDevices
+    setLegacyDevices,
+    hasLegacyDevice,
+    getIconforLegacyModel,
 };

package/lib/exclude.js

@@ -1,5 +1,6 @@
 'use strict';
 const devicedefinitions = require('./devices');
+const utils = require('./utils');
 
 class Exclude {
     constructor(adapter) {
@@ -126,7 +127,7 @@ class Exclude {
         const devices = this.zbController.getClients();
         const excludables = [];
         for (const device of devices) {
-            const obj = await this.adapter.getObjectAsync(device.ieeeAddr.substr(2));
+            const obj = await this.adapter.getObjectAsync(utils.zbIdorIeeetoAdId(this.adapter, device.ieeeAddr, false));//device.ieeeAddr.substr(2));
             if (obj && obj.common && obj.common.type) {
                 excludables.push(obj.common.tyoe);
             }

package/lib/exposes.js

@@ -259,7 +259,7 @@ function createFromExposes(model, def, device, log) {
 
     // maybee here check manufacturerName for tuya devices
     if (typeof def.exposes == 'function') {
-        const expFunction = def.exposes(device === undefined ? {isDummyDevice: true} : device, {});   // maybee here check manufacturerName for tuya devices
+        const expFunction = def.exposes((device === undefined || device === null) ? {isDummyDevice: true} : device, {});   // maybee here check manufacturerName for tuya devices
         for (const expose of expFunction) {
             genStateFromExpose(expose);
         }
@@ -344,7 +344,22 @@ function createFromExposes(model, def, device, log) {
                                 epname: expose.endpoint,
                                 setattr: 'brightness',
                             }, prop.access);
-                            pushToStates(statesDefs.brightness_move, prop.access);
+                            //pushToStates(statesDefs.brightness_move, prop.access);
+                            pushToStates({
+                                id: 'brightness_move',
+                                prop: 'brightness_move',
+                                name: `Dimming ${expose.endpoint ? expose.endpoint : ''}`.trim(),
+                                icon: undefined,
+                                role: 'state',
+                                write: true,
+                                read: false,
+                                type: 'number',
+                                min: -50, // ignore expose.value_min
+                                max: 50, // ignore expose.value_max
+                                epname: expose.endpoint,
+                                setattr: 'brightness_move',
+                            }, prop.access);
+                            //pushToStates(statesDefs.brightness_move, prop.access);
                             break;
                         }
                         case 'color_temp': {

package/lib/groups.js

@@ -629,7 +629,7 @@ class Groups {
                     const entity = await this.zbController.resolveEntity(member.ieee, member.epid);
                     let epname = undefined;
                     if (entity && entity.mapped && entity.mapped.endpoint) {
-                        const epnames = entity.mapped.endpoint();
+                        const epnames = entity.mapped.endpoint(entity);
                         for (const key in epnames) {
                             if (epnames[key] == member.epid) {
                                 epname = key;
@@ -657,7 +657,7 @@ class Groups {
                     this.rebuildGroupMemberStateList(j, memberInfo);
                 }
 
-                const name = this.stController.localConfig.NameForId(id, 'group', groups[j]);
+                const name = await this.stController.localConfig.NameForId(id, 'group', groups[j]);
                 const icon = this.stController.localConfig.IconForId(id, 'group', await this.stController.getDefaultGroupIcon(id));
                 chain.push(new Promise(resolve => {
                     const isActive = false;

package/lib/localConfig.js

@@ -69,17 +69,30 @@ class localConfig extends EventEmitter {
         return true;
     }
 
+    isValid(data) {
+        const t = typeof data;
+        const invalidators= ['none', '##REMOVE##'];
+        switch (t) {
+            case 'number': return true;
+            case 'string': return invalidators.indexOf(data)< 0;
+            case 'object': return true;
+            default: return false;
+        }
+    }
+
     async updateLocalOverride(_target, model, key, data, global)
     {
         const target = (global ? model : _target);
-        this.info(`updating local data: (${global ? 'global':'local'}) : ${target}:${key}:${JSON.stringify(data)}`);
+        this.debug(`updating local data: (${global ? 'global':'local'}) : ${target}:${key}:${JSON.stringify(data)}`);
 
         if (typeof target != 'string' || typeof key != 'string') {
             this.error(`update called with illegal id data:${JSON.stringify(target)}:${JSON.stringify(key)}:${JSON.stringify(data)}`)
             return false;
         }
         const base = global ? this.localData.by_model[target] || {} : this.localData.by_id[target] || {};
-        if (data && Object.keys(data).length > 0 && data != 'none') {
+
+
+        if (data && Object.keys(data).length > 0 && this.isValid(data)) {
             if (key == 'icon')
                 base[key] = data.replace(this.basefolder, '.');
             else
@@ -99,33 +112,33 @@ class localConfig extends EventEmitter {
             if (base == {}) delete this.localData.by_id[target];
             else this.localData.by_id[target] = base;
         }
-        this.info(`Local Data for ${target} is ${JSON.stringify(base)} after update`);
+        this.debug(`Local Data for ${target} is ${JSON.stringify(base)} after update`);
         this.retainData();
         return true;
     }
 
-    async getLocalOverride(_target, model, key, global)
+    getLocalOverride(target, model, key, global)
     {
-        const target = (global ? model : _target);
-        this.info(`getting local data: (${global ? 'global':'local'}) : ${target}:${key}`);
+        this.debug(`getting local data: (${global ? 'global':'local'}) : ${target}:${key}`);
 
         if (typeof target != 'string' || typeof key != 'string') {
             this.error(`update called with illegal id data:${JSON.stringify(target)}:${JSON.stringify(key)}`)
             return false;
         }
         const rv = {};
-        if ((this.localData.byModel[target] || {}).hasOwnProperty(key))
-            rv[key] = this.localData.byModel[target] || {}[key];
+        if ((this.localData.by_model[model] || {}).hasOwnProperty(key))
+            rv[key] = this.localData.by_model[model][key];
         if (global) return rv;
-        if ((this.localData.by_id[_target] || {}).hasOwnProperty(key))
-            rv[key] = this.localData.by_id[_target] || {}[key];
+        if ((this.localData.by_id[target] || {}).hasOwnProperty(key))
+            rv[key] = this.localData.by_id[target][key];
         return rv;
     }
 
     NameForId(id, model, defaultName) {
         this.debug('name for id with ' + id + ' and ' + defaultName + ' from ' + JSON.stringify(this.localData));
-        const localstorage = (this.localData.by_id[id] || this.localData.by_model[model]);
-        if (localstorage && localstorage.hasOwnProperty['name']) return localstorage.name;
+        const nameObj = this.getLocalOverride(id, model, 'name', false);
+        if (nameObj.name)
+            return nameObj.name
         return defaultName;
     }
 
@@ -164,7 +177,7 @@ class localConfig extends EventEmitter {
                                 this.error('error writing file ' + path + JSON.stringify(err))
                                 return;
                             }
-                            this.info('Updated image file ' + rv)
+                            this.debug('Updated image file ' + rv)
                         })
                     }
                 })
@@ -228,8 +241,13 @@ class localConfig extends EventEmitter {
     }
 
     getOverrideWithTargetAndKey(target, key, isGlobal) {
-        const targetdata = this.getOverrideData(target, isGlobal);
-        if (targetdata && targetdata.hasOwnProperty(key)) return targetdata[key];
+        let targetdata = this.getOverrideData(target, isGlobal);
+        const keyparts = key.split('.');
+        while (keyparts.length > 1) {
+            targetdata = targetdata[keyparts[0]] || {};
+            keyparts.splice(0,1);
+        }
+        if (targetdata && targetdata.hasOwnProperty(keyparts[0])) return targetdata[keyparts[0]];
         return undefined;
     }
 
@@ -249,7 +267,7 @@ class localConfig extends EventEmitter {
                 try {
                     for (const prop in data_js) {
                         if (data_js[prop] != 'undefined') {
-                            this.info(`updating device name for ${prop} as ${data_js[prop]}`);
+                            this.debug(`updating device name for ${prop} as ${data_js[prop]}`);
                             this.updateDeviceName(prop, data_js[prop]);
                         }
                     }
@@ -284,8 +302,8 @@ class localConfig extends EventEmitter {
         }
     }
 
-    async retainData() {
-        this.debug('retaining local config: ' + JSON.stringify(this.localData));
+    writeData() {
+        this.info('retaining local config: ' + JSON.stringify(this.localData));
         try {
             fs.writeFileSync(this.filename, JSON.stringify(this.localData, null, 2))
             this.info('Saved local configuration data');
@@ -293,6 +311,18 @@ class localConfig extends EventEmitter {
         catch (error) {
             this.error(`error saving local config: ${error.message}`);
         }
+        this.delayRetain = null;
+    }
+
+    async retainData(isStopping) {
+        if (isStopping) {
+            if (this.delayRetain) clearTimeout(this.delayRetain);
+            this.writeData(this);
+            return;
+        }
+        if (this.delayRetain) return;
+        const t = this;
+        this.delayRetain = setTimeout(() => this.writeData(t), 500);
     }
 
     enumerateImages(_path) {