iobroker.zigbee 2.0.1 → 2.0.3

package/lib/zbDeviceConfigure.js

@@ -3,20 +3,19 @@
 const zigbeeHerdsmanConverters = require('zigbee-herdsman-converters');
 const BaseExtension = require('./zbBaseExtension');
 
-const forcedConfigureOnEachStart = [
-    zigbeeHerdsmanConverters.findByModel('V3-BTZB'),
-    zigbeeHerdsmanConverters.findByModel('014G2461'),
-    zigbeeHerdsmanConverters.findByModel('SPZB0001'),
-    zigbeeHerdsmanConverters.findByModel('ZK03840')
-];
+const forcedConfigureOnEachStart = ['V3-BTZB','014G2461','SPZB0001','ZK03840'];
 
 class DeviceConfigure extends BaseExtension {
     constructor(zigbee, options) {
         super(zigbee, options);
 
+        this.delayedConfigure = {};
+
         this.configuring = new Set();
         this.attempts = {};
         this.name = 'DeviceConfigure';
+
+        this.configureKeys = {};
     }
 
     setOptions(options) {
@@ -30,14 +29,42 @@ class DeviceConfigure extends BaseExtension {
         if (!mappedDevice || !mappedDevice.configure) {
             return false;
         }
-        if (device.meta.hasOwnProperty('configured') &&
-            zigbeeHerdsmanConverters.getConfigureKey(mappedDevice)) {
-            return false;
+        const delayedAttempts = this.checkDelayedConfigure(device, 0);
+        if (!this.configureKeys.hasOwnProperty(device.ieeeAddr)) this.configureKeys[device.ieeeAddr] = zigbeeHerdsmanConverters.getConfigureKey(mappedDevice);
+        if (delayedAttempts > 0 && !device.interviewing) return true;
+        if (device.meta.hasOwnProperty('configured') && device.meta.configured !== this.configureKeys[device.ieeeAddr]) return true;
+        return (device.interviewing !== true && this.checkDelayedConfigure(device)>0);
+    }
+
+    checkDelayedConfigure(device, num) {
+        if (!this.delayedConfigure.hasOwnProperty(device.ieeeAddr)) {
+            if (num && num > 0) {
+                // this.warn('adding dev ' + device.ieeeAddr + ' to delayedConfigure with ' + num + ' attempts');
+                this.delayedConfigure[device.ieeeAddr] = { maxAttempts:num };
+                return num;
+            }
+            return 0;
         }
+        const dc = this.delayedConfigure[device.ieeeAddr];
+        // this.warn('checkDelayedConfigure for ' + device.ieeeAddr + ' with ' + JSON.stringify(dc));
+        dc.maxAttempts--;
+        if (dc.maxAttempts > 0) return dc.maxAttempts;
+        if (num && num > 0) {
+            dc.maxAttempts = num;
+            return num;
+        }
+        return 0;
+    }
 
-        return device.interviewing !== true;
+    delayedConfigureAttempt(device, status) {
+        if (status) {
+            delete this.delayedConfigure[device.ieeeAddr];
+            return 0;
+        }
+        return this.checkDelayedConfigure(device, 10);
     }
 
+
     async onZigbeeStarted() {
         try {
             this.coordinatorEndpoint = await this.zigbee.getDevicesByType('Coordinator')[0].endpoints[0];
@@ -58,7 +85,7 @@ class DeviceConfigure extends BaseExtension {
             }
         } catch (error) {
             this.sendError(error);
-            this.error(`Failed to DeviceConfigure.onZigbeeStarted (${error.stack})`);
+            this.error(`Failed to DeviceConfigure.onZigbeeStarted (${error && error.message ? error.message : 'no error message'})`);
         }
     }
 
@@ -66,14 +93,16 @@ class DeviceConfigure extends BaseExtension {
         try {
             const device = data.device;
             if (this.shouldConfigure(device, mappedDevice)) {
+                this.debug('ShouldConfigure ' + device.ieeeAddr);
                 this.configure(device, mappedDevice);
             }
         } catch (error) {
             this.sendError(error);
-            this.error(`Failed to DeviceConfigure.onZigbeeEvent (${error.stack})`);
+            this.error(`Failed to DeviceConfigure.onZigbeeEvent (${error && error.message ? error.message : 'no error message'})`);
         }
     }
 
+
     onDeviceRemove(device) {
         try {
             if (this.configuring.has(device.ieeeAddr)) {
@@ -85,7 +114,7 @@ class DeviceConfigure extends BaseExtension {
             }
         } catch (error) {
             this.sendError(error);
-            this.error(`Failed to DeviceConfigure.onDeviceRemove (${error.stack})`);
+            this.error(`Failed to DeviceConfigure.onDeviceRemove (${error && error.message ? error.message : 'no error message'})`);
         }
     }
 
@@ -100,23 +129,11 @@ class DeviceConfigure extends BaseExtension {
     async configure(device, mappedDevice) {
         try {
             if (mappedDevice !== undefined && device !== undefined) {
-                if (this.configuring.has(device.ieeeAddr) || this.attempts[device.ieeeAddr] >= 5) {
-                    return false;
-                }
-
-                this.configuring.add(device.ieeeAddr);
-
-                if (!this.attempts.hasOwnProperty(device.ieeeAddr)) {
-                    this.attempts[device.ieeeAddr] = 0;
-                }
-
                 try {
-                    await this.doConfigure(device, mappedDevice);
-                    //       this.configuring.delete(device.ieeeAddr);
+                    await this.doConfigure(device, mappedDevice)
                 } catch (error) {
                     this.sendError(error);
-                    this.warn(`DeviceConfigure failed ${device.ieeeAddr} ${device.modelID} attempt ${this.attempts[device.ieeeAddr] + 1} (${error.stack})`);
-                    this.attempts[device.ieeeAddr]++;
+                    this.warn(`DeviceConfigure failed ${device.ieeeAddr} ${device.modelID}`);
                 }
             }
         } catch (error) {
@@ -129,24 +146,41 @@ class DeviceConfigure extends BaseExtension {
         const coordinatorEndpoint = await this.zigbee.getDevicesByType('Coordinator')[0].endpoints[0];
         try {
             if (mappedDevice) {
-                this.info(`-> Configuring ${device.ieeeAddr} ${device.modelID}`);
-
-                await mappedDevice.configure(device, coordinatorEndpoint, this);
-
+                if (mappedDevice.configure === undefined) return `No configure available for ${device.ieeeAddr} ${device.modelID}.`;
+                this.info(`Configuring ${device.ieeeAddr} ${device.modelID}`);
+                if (typeof mappedDevice.configure === 'function') await mappedDevice.configure(device, coordinatorEndpoint, this);
+                else {
+                    const promises = [];
+                    promises.push(...mappedDevice.configure);
+                    await Promise.all(promises.map(callback => callback(device, coordinatorEndpoint, mappedDevice)))
+                }
                 device.meta.configured = zigbeeHerdsmanConverters.getConfigureKey(mappedDevice);
+                this.configureKeys[device.ieeeAddr] = device.meta.configured;
                 device.save();
                 this.info(`DeviceConfigure successful ${device.ieeeAddr} ${device.modelID}`);
+                this.delayedConfigureAttempt(device, true);
+                return '';
             }
         } catch (error) {
             // https://github.com/Koenkk/zigbee2mqtt/issues/14857
             if (error.stack.includes('UNSUPPORTED_ATTRIBUTE')) {
                 // do nothing
             } else {
-                this.sendError(error);
-                this.warn(` ${device.ieeeAddr} ${device.modelID} Failed to configure. When device works is all fine when not wake up the device and check again`);
-                this.debug(` --> ${error.stack} `);
+                if (error && error.message && error.message.match(/(\d+)ms/gm)) {
+                    // timeout message - we do want to start the configure chain
+                    const num = this.delayedConfigureAttempt(device, false);
+                    this.warn(`Timeout trying to configure ${device.ieeeAddr} ${device.modelID}:  ${num} attempts remaining`)
+                    return `Configuration timed out ${device.ieeeAddr} ${device.modelID}. The device did not repond in time to the configuration request. Another attempt will be made when the device is awake.`;
+                } else {
+                    this.sendError(error);
+                    this.warn(`${device.ieeeAddr} ${device.modelID} Failed to configure. --> ${error && error.message ? error.message : ' no error message given'} `);
+                    return `${device.ieeeAddr} ${device.modelID} Failed to configure. --> ${error && error.message ? error.message : ' no error message given'} `
+                }
+
+
             }
         }
+        return 'no return value specified';
     }
 }
 

package/lib/zigbeecontroller.js

@@ -73,6 +73,17 @@ class ZigbeeController extends EventEmitter {
             new DelayedActionExt(this, {}),
         ];
         this.herdsmanTimeoutRegexp = new RegExp(/(\d+)ms/);
+        this.herdsmanLogSettings = {}
+    }
+
+
+    ByteArrayToString(data) {
+        return data.map(function (x) {
+            x = x + 0x100 + 1;  // twos complement
+            x = x.toString(16); // to hex
+            x = ('00'+x).substr(-2); // zero-pad to 8-digits
+            return x
+        }).join('');
     }
 
     configure(options) {
@@ -110,8 +121,9 @@ class ZigbeeController extends EventEmitter {
         }
         this.disableLed = options.disableLed;
         this.warnOnDeviceAnnouncement = options.warnOnDeviceAnnouncement;
-
-        this.debug(`Using zigbee-herdsman with settings: ${JSON.stringify(herdsmanSettings)}`);
+        this.herdsmanLogSettings.panID = herdsmanSettings.network.panID;
+        this.herdsmanLogSettings.channel = herdsmanSettings.network.channelList[0];
+        this.herdsmanLogSettings.extendedPanID = this.ByteArrayToString(herdsmanSettings.network.extendedPanID);
         this.herdsman = new ZigbeeHerdsman.Controller(herdsmanSettings, this.adapter.log);
         this.callExtensionMethod('setOptions', [{
             disableActivePing: options.disablePing,
@@ -136,11 +148,10 @@ class ZigbeeController extends EventEmitter {
             this.herdsman.on('message', this.handleMessage.bind(this));
             this.herdsman.on('permitJoinChanged', this.handlePermitJoinChanged.bind(this));
 
+            this.info('Starting Zigbee-Herdsman');
             await this.herdsman.start();
-
-            this.debug('zigbee-herdsman started');
             this.herdsmanStarted = true;
-            this.info(`Coordinator firmware version: ${JSON.stringify(await this.herdsman.getCoordinatorVersion())}`);
+            this.info(`Zigbee-Herdsman started successfully with Coordinator firmware version: ${JSON.stringify(await this.herdsman.getCoordinatorVersion())}`);
 
             // debug info from herdsman getNetworkParameters
             const debNetworkParam = JSON.parse(JSON.stringify(await this.herdsman.getNetworkParameters()));
@@ -152,14 +163,29 @@ class ZigbeeController extends EventEmitter {
                 extPanIDDebug += extendedPanIDDebug[i];
                 i--;
             }
-
-            this.info(`Zigbee network parameters: panID=${debNetworkParam.panID} channel=${debNetworkParam.channel} extendedPanID=${extPanIDDebug}`);
+            this.debug(`Network parameters: panID=${debNetworkParam.panID} channel=${debNetworkParam.channel} extendedPanID=${extPanIDDebug}`);
         } catch (e) {
+            try {
+                const debNetworkParam = JSON.parse(JSON.stringify(await this.herdsman.getNetworkParameters()));
+                const extendedPanIDDebug = typeof debNetworkParam.extendedPanID === 'string' ? debNetworkParam.extendedPanID.replace('0x', '') : debNetworkParam.extendedPanID;
+
+                let extPanIDDebug = '';
+                for (let i = extendedPanIDDebug.length - 1; i >= 0; i--) {
+                    extPanIDDebug += extendedPanIDDebug[i - 1];
+                    extPanIDDebug += extendedPanIDDebug[i];
+                    i--;
+                }
+                this.warn(`Network parameters in Config     : panID=${this.herdsmanLogSettings.panID} channel=${this.herdsmanLogSettings.channel} extendedPanID=${this.herdsmanLogSettings.extendedPanID}`)
+                this.warn(`Network parameters on Coordinator: panID=${debNetworkParam.panID} channel=${debNetworkParam.channel} extendedPanID=${extPanIDDebug}`);
+            }
+            catch (error) {
+                this.info(`Unable to obtain herdsman settings`)
+            }
             try {
                 await this.herdsman.stop();
             }
             catch (error) {
-                this.warn(`Starting zigbee-herdsman problem : ${error && error.message ? error.message : 'no error message'}`)
+                this.warn('unable to stop zigbee-herdsman after failed startup');
             }
             this.sendError(e);
             this.error(`Starting zigbee-herdsman problem : ${(e && e.message ? e.message : 'no error message')}`);
@@ -207,18 +233,20 @@ class ZigbeeController extends EventEmitter {
         }
 
         // Call extensions
-        this.callExtensionMethod('onZigbeeStarted', []);
 
         const deviceIterator = this.getClientIterator();
         let deviceCount = 0;
         try {
             for (const device of deviceIterator) {
                 deviceCount++;
+                // get the model description for the known devices
                 const entity = await this.resolveEntity(device);
                 if (!entity) {
                     this.warn('failed to resolve Entity for ' + device.ieeeAddr);
                     continue;
                 }
+                //await this.adapter.stController.AddModelFromHerdsman(device, entity.mapped.model);
+
                 this.adapter.getObject(device.ieeeAddr.substr(2), (err, obj) => {
                     if (obj && obj.common && obj.common.deactivated) {
                         this.callExtensionMethod('deregisterDevicePing', [device, entity]);
@@ -248,6 +276,7 @@ class ZigbeeController extends EventEmitter {
             } else {
                 this.info(`Currently no devices.`);
             }
+            this.callExtensionMethod('onZigbeeStarted', []);
         }
         catch (error) {
             this.error('error iterating devices : '+ (error && error.message ? error.message: 'no reason given'));
@@ -718,7 +747,11 @@ class ZigbeeController extends EventEmitter {
             this.debug('handleDeviceLeave', message);
             const entity = await this.resolveEntity(message.device || message.ieeeAddr);
             const friendlyName = entity ? entity.name : message.ieeeAddr;
-            this.debug(`Device '${friendlyName}' left the network`);
+            if (this.adapter.stController.checkDebugDevice(friendlyName)) {
+                this.emit('device_debug', {ID: Date.now(), data: {flag:'dl', states:[{id: '--', value:'--', payload:message}], IO:true},message:`Device '${friendlyName}' has left the network`});
+            }
+            else
+                this.info(`Device '${friendlyName}' left the network`);
             this.emit('leave', message.ieeeAddr);
             // Call extensions
             this.callExtensionMethod(
@@ -735,7 +768,10 @@ class ZigbeeController extends EventEmitter {
         this.debug('handleDeviceAnnounce', message);
         const entity = await this.resolveEntity(message.device || message.ieeeAddr);
         const friendlyName = entity.name;
-        if (this.warnOnDeviceAnnouncement) {
+        if (this.adapter.stController.checkDebugDevice(friendlyName)) {
+            this.emit('device_debug', {ID: Date.now(), data: {flag:'da', states:[{id: '--', value:'--', payload:message}] , IO:true} ,message:`Device '${friendlyName}' announced itself`});
+        }
+        else if (this.warnOnDeviceAnnouncement) {
             this.warn(`Device '${friendlyName}' announced itself`);
         } else {
             this.info(`Device '${friendlyName}' announced itself`);
@@ -854,7 +890,7 @@ class ZigbeeController extends EventEmitter {
                 let resolved = await this.resolveEntity(device, 0);
                 if (!resolved) {
                     resolved = { name:'unresolved device', device:device }
-                    this.warn('resolve Entity failed for ' + device.ieeeAddr)
+                    this.debug('resolve Entity failed for ' + device.ieeeAddr)
                 }
                 let result;
 
@@ -914,9 +950,9 @@ class ZigbeeController extends EventEmitter {
 
             callback && callback({lqis, routing, errors});
             if (errors.length) {
-                this.warn(`Map Data collection complete with ${errors.length} issues:`);
+                this.debug(`Map Data collection complete with ${errors.length} issues:`);
                 for (const msg of errors)
-                    this.warn(msg);
+                    this.debug(msg);
             }
             else
                 this.info('Map data collection complete');