iobroker.zigbee 2.0.5 → 3.0.0

package/lib/statescontroller.js

@@ -34,6 +34,7 @@ class StatesController extends EventEmitter {
         this.stashedErrors = {};
         this.stashedUnknownModels = [];
         this.debugMessages = { nodevice:{ in:[], out: []} };
+        this.debugActive = true;
     }
 
     info(message, data) {
@@ -75,14 +76,19 @@ class StatesController extends EventEmitter {
 
     getStashedErrors() {
         const rv = [];
-        if (Object.keys(this.stashedErrors).length > 0)
-        {
-            rv.push('<p><b>Stashed Messages</b></p>')
-            rv.push(Object.values(this.stashedErrors).join('<br>'));
+        try {
+            if (Object.keys(this.stashedErrors).length > 0)
+            {
+                rv.push('<p><b>Stashed Messages</b></p>')
+                rv.push(Object.values(this.stashedErrors).join('<br>'));
+            }
+            if (this.stashedUnknownModels.length > 0) {
+                rv.push('<p><b>Devices whithout Model definition</b></p>')
+                rv.push()
+            }
         }
-        if (this.stashedUnknownModels.length > 0) {
-            rv.push('<p><b>Devices whithout Model definition</b></p>')
-            rv.push()
+        catch (error) {
+            if (this.debugActive) this.debug(`Error collecting stashed errors: ${error && error.message ? error.message : 'no message available'}`);
         }
         return rv;
     }
@@ -94,14 +100,94 @@ class StatesController extends EventEmitter {
     async AddModelFromHerdsman(device, model) {
         // this.warn('addModelFromHerdsman ' + JSON.stringify(model) + ' ' + JSON.stringify(this.localConfig.getOverrideWithKey(model, 'legacy', true)));
         if (this.localConfig.getOverrideWithKey(model, 'legacy', true)) {
-            //this.warn('legacy for ' + model);
+            this.debug('Applying legacy definition for ' + model);
             await this.addLegacyDevice(model);
         }
         else {
-            const pre = statesMapping.devices.length;
-            await statesMapping.addExposeToDevices(device, this, model);
-            const post = statesMapping.devices.length;
-            //this.warn('expose for ' + model + ' '+ pre + '->'+post);
+            this.debug('Generating states from exposes for ' + model);
+            const modelDesc = await statesMapping.addExposeToDevices(device, this, model);
+            const srcIcon = modelDesc.icon;
+            // download icon if it external and not undefined
+            if (model === undefined) {
+                const dev_name = this.verifyDeviceName(device.ieeeAddr.substr(2), model, device.modelID);
+                this.warn(`download icon ${dev_name} for undefined Device not available. Check your devices.`);
+            } else {
+                const model_modif = model.replace(/\//g, '-');
+                const pathToAdminIcon = `img/${model_modif}.png`;
+
+                const namespace = `${this.adapter.name}.admin`;
+                if (srcIcon.startsWith('http')) {
+                    this.adapter.fileExists(namespace, srcIcon, async(err, result) => {
+                        if (result) {
+                            this.debug(`icon ${modelDesc.icon} found - no copy needed`);
+                            return;
+                        }
+                        try {
+                            this.downloadIconToAdmin(srcIcon, pathToAdminIcon)
+                            modelDesc.icon = pathToAdminIcon;
+                        } catch (e) {
+                            this.warn(`ERROR : icon not found at ${srcIcon}`);
+                        }
+                        return;
+                    });
+                    return;
+                }
+                const base64Match = srcIcon.match(/data:image\/(.+);base64,/);
+                if (base64Match) {
+                    modelDesc.icon = pathToAdminIcon;
+                    this.adapter.fileExists(namespace, pathToAdminIcon, async (err,result) => {
+                        if (result) {
+                            this.debug(`no need to save icon to ${pathToAdminIcon}`);
+                            return;
+                        }
+                        this.debug(`Saving base64 data to ${pathToAdminIcon}`)
+                        const buffer = new Buffer(srcIcon.replace(base64Match[0],''), 'base64');
+                        this.adapter.writeFile(pathToAdminIcon, buffer);
+                    });
+                    return;
+                }
+                modelDesc.icon = pathToAdminIcon;
+                this.adapter.fileExists(namespace, pathToAdminIcon, async(err, result) => {
+                    if (result) {
+                        this.debug(`icon ${modelDesc.icon} found - no copy needed`);
+                        return;
+                    }
+                    // try 3 options for source file
+                    let src = srcIcon; // as given
+                    const locations=[];
+                    if (!fs.existsSync(src)) {
+                        locations.push(src);
+                        src = path.normalize(this.adapter.expandFileName(src));
+                    } // assumed relative to data folder
+                    if (!fs.existsSync(src)) {
+                        locations.push(src);
+                        src = path.normalize(this.adapter.expandFileName(path.basename(src)));
+                    } // filename relative to data folder
+                    if (!fs.existsSync(src)) {
+                        locations.push(src);
+                        src = path.normalize(this.adapter.expandFileName(path.join('img',path.basename(src))));
+                    } // img/<filename> relative to data folder
+                    if (!fs.existsSync(src)) {
+                        this.warn(`Unable to copy icon from device definition, looked at ${locations.join(', ')} and ${src}`)
+                        return;
+                    }
+                    fs.readFile(src, (err, data) => {
+                        if (err) {
+                            this.error('unable to read ' + src + ' : '+ (err && err.message? err.message:' no message given'))
+                            return;
+                        }
+                        if (data) {
+                            this.adapter.writeFile(namespace, pathToAdminIcon, data, (err) => {
+                                if (err) {
+                                    this.error('error writing file ' + path + JSON.stringify(err))
+                                    return;
+                                }
+                                this.info('Updated image file ' + pathToAdminIcon);
+                            });
+                        }
+                    })
+                })
+            }
         }
     }
 
@@ -158,6 +244,9 @@ class StatesController extends EventEmitter {
         if (!this.adapter.zbController || !this.adapter.zbController.connected()) {
             return;
         }
+        if (id.includes('logLevel')) {
+            if (state) this.adapter.updateDebugLevel(state.val);
+        }
         const debugId = Date.now();
         if (state && !state.ack) {
             if (id.endsWith('pairingCountdown') || id.endsWith('pairingMessage') || id.endsWith('connection')) {
@@ -180,7 +269,7 @@ class StatesController extends EventEmitter {
                 const message = `User state change of state ${id} with value ${state.val} (ack: ${state.ack}) from ${state.from}`;
                 this.emit('device_debug', { ID:debugId, data: { ID: deviceId, flag:'01' }, message:message});
             } else
-                this.debug(`User stateChange ${id} ${JSON.stringify(state)}`);
+                if (this.debugActive) this.debug(`User stateChange ${id} ${JSON.stringify(state)}`);
             // const stateKey = id.split('.')[3];
             const arr = /zigbee.[0-9].[^.]+.(\S+)/gm.exec(id);
             if (arr[1] === undefined) {
@@ -195,7 +284,7 @@ class StatesController extends EventEmitter {
                         return;
                     }
                     if (obj.common.deactivated) {
-                        this.debug('State Change detected on deactivated Device - ignored');
+                        if (this.debugActive) this.debug('State Change detected on deactivated Device - ignored');
                         return;
                     }
                     if (model === 'group') {
@@ -315,7 +404,7 @@ class StatesController extends EventEmitter {
     }
 
     async publishFromState(deviceId, model, stateKey, state, options, debugId) {
-        this.debug(`Change state '${stateKey}' at device ${deviceId} type '${model}'`);
+        if (this.debugActive) this.debug(`Change state '${stateKey}' at device ${deviceId} type '${model}'`);
         const elevated = this.checkDebugDevice(deviceId);
 
         if (elevated)  {
@@ -390,7 +479,7 @@ class StatesController extends EventEmitter {
             objName = (obj.common.type == 'group' ? stateId.replace('_',' ') : obj.common.type);
         }
         this.localConfig.updateDeviceName(stateId, newName);
-        this.debug('rename device: newname ~' + newName + '~ objName ~' + objName + '~')
+        if (this.debugActive) this.debug('rename device: newname ~' + newName + '~ objName ~' + objName + '~')
         this.adapter.extendObject(id, {common: {name: objName}});
     }
 
@@ -432,7 +521,7 @@ class StatesController extends EventEmitter {
                     let statename = state._id;
                     const arr = /zigbee.[0-9].[^.]+.(\S+)/gm.exec(statename);
                     if (arr[1] === undefined) {
-                        this.debug(`unable to extract id from state ${statename}`);
+                        if (this.debugActive) this.debug(`unable to extract id from state ${statename}`);
                         const idx = statename.lastIndexOf('.');
                         if (idx > -1) {
                             statename = statename.slice(idx + 1);
@@ -467,7 +556,7 @@ class StatesController extends EventEmitter {
                         }
                     } else {
                         if (!markOnly) {
-                            this.debug(`keeping connected state ${JSON.stringify(statename)} of  ${devId} `);
+                            if (this.debugActive) this.debug(`keeping connected state ${JSON.stringify(statename)} of  ${devId} `);
                             messages.push(`keeping connecte state ${JSON.stringify(statename)} of  ${devId} `);
                         }
                     }
@@ -565,8 +654,8 @@ class StatesController extends EventEmitter {
                 if (value !== undefined) {
                     const type = stobj ? stobj.common.type : new_common.type;
                     if (type === 'number') {
-                        const minval = (stobj ? stobj.common.min: new_common.min) || -Number.MAX_VALUE;
-                        const maxval = (stobj ? stobj.common.max: new_common.max) || Number.MAX_VALUE;
+                        const minval = (stobj ? stobj.common.min : new_common.min);
+                        const maxval = (stobj ? stobj.common.max : new_common.max);
                         let nval = (typeof value == 'number' ? value : parseFloat(value));
                         if (isNaN(nval)) {
                             if (minval !== undefined && typeof minval === 'number')
@@ -574,7 +663,7 @@ class StatesController extends EventEmitter {
                             else
                                 nval = 0;
                         }
-                        if (nval < minval) {
+                        if (typeof minval == 'number' && nval < minval) {
                             hasChanges = true;
                             new_common.color = '#FF0000'
                             value = minval
@@ -584,7 +673,7 @@ class StatesController extends EventEmitter {
                                 this.stashedErrors[`${stateId}.min`] = `State value for ${stateId} has value "${nval}." less than min "${minval}"`;
                             }
                         }
-                        if (nval > maxval) {
+                        if (typeof maxval == 'number' && nval > maxval) {
                             hasChanges = true;
                             hasChanges = true;
                             new_common.color = '#FF0000'
@@ -605,10 +694,10 @@ class StatesController extends EventEmitter {
                     this.setState_typed(stateId, value, true, stobj.common.type);
                 }
             } else {
-                this.debug(`UpdateState: Device is deactivated ${devId} ${JSON.stringify(obj)}`);
+                if (this.debugActive) this.debug(`UpdateState: Device is deactivated ${devId} ${JSON.stringify(obj)}`);
             }
         } else {
-            this.debug(`UpdateState: missing device ${devId} ${JSON.stringify(obj)}`);
+            if (this.debugActive) this.debug(`UpdateState: missing device ${devId} ${JSON.stringify(obj)}`);
         }
     }
 
@@ -616,7 +705,7 @@ class StatesController extends EventEmitter {
         // never set a null or undefined value
         if (value === null || value === undefined) return;
         if (!type) {
-            this.debug('SetState_typed called without type');
+            if (this.debugActive) this.debug('SetState_typed called without type');
             // identify datatype, recursively call this function with set datatype
             this.adapter.getObject(id, (err, obj) => {
                 if (obj && obj.common) {
@@ -628,7 +717,7 @@ class StatesController extends EventEmitter {
             return;
         }
         if (typeof value !== type) {
-            this.debug(`SetState_typed : converting ${JSON.stringify(value)} for ${id} from ${typeof value} to ${type}`);
+            if (this.debugActive) this.debug(`SetState_typed : converting ${JSON.stringify(value)} for ${id} from ${typeof value} to ${type}`);
             switch (type) {
                 case 'number':
                     value = parseFloat(value);
@@ -685,7 +774,7 @@ class StatesController extends EventEmitter {
     async updateDev(dev_id, dev_name, model, callback) {
 
         const __dev_name = this.verifyDeviceName(dev_id, model, (dev_name ? dev_name : model));
-        this.debug(`UpdateDev called with ${dev_id}, ${dev_name}, ${model}, ${__dev_name}`);
+        if (this.debugActive) this.debug(`UpdateDev called with ${dev_id}, ${dev_name}, ${model}, ${__dev_name}`);
         const id = '' + dev_id;
         const modelDesc = statesMapping.findModel(model);
         const modelIcon = (model == 'group' ? await this.getDefaultGroupIcon(dev_id) : modelDesc && modelDesc.icon ? modelDesc.icon : 'img/unknown.png');
@@ -807,12 +896,17 @@ class StatesController extends EventEmitter {
     }
 
     CleanupRequired(set) {
-        if (typeof set === 'boolean') this.cleanupRequired = set;
-        return this.cleanupRequired;
+        try {
+            if (typeof set === 'boolean') this.cleanupRequired = set;
+            return this.cleanupRequired;
+        }
+        catch (error) {
+            if (this.debugActive) this.debug(`Error setting cleanup required: ${error && error.message ? error.message : 'no message available'}`);
+        }
     }
 
     async syncDevStates(dev, model) {
-        this.debug('synchronizing device states for ' + dev.ieeeAddr + ' (' + model + ')');
+        if (this.debugActive) this.debug('synchronizing device states for ' + dev.ieeeAddr + ' (' + model + ')');
         const devId = dev.ieeeAddr.substr(2);
         // devId - iobroker device id
         const devStates = await this.getDevStates(dev.ieeeAddr, model);
@@ -890,11 +984,11 @@ class StatesController extends EventEmitter {
 
             const message = `message received '${JSON.stringify(payload)}' from device ${devId} type '${model}'`;
             if (has_elevated_debug) this.emit('device_debug', { ID:debugId, data: { deviceID: devId, flag:'01', IO:true }, message:message});
-            else this.debug(message);
+            else if (this.debugActive) this.debug(message);
             if (!devStates) {
                 const message = `no device states for device ${devId} type '${model}'`;
                 if (has_elevated_debug)this.emit('device_debug', { ID:debugId, data: { error:'NOSTATE',states:[{ id:'--', value:'--', payload:payload}], IO:true }, message:message});
-                else this.debug(message);
+                else if (this.debugActive) this.debug(message);
                 return;
             }
             // find states for payload
@@ -922,7 +1016,7 @@ class StatesController extends EventEmitter {
 
                         const message = `value generated '${JSON.stringify(value)}' from device ${devId} for '${statedesc.name}'`;
                         if (has_elevated_debug) this.emit('device_debug', { ID:debugId, data: { states:[{id:stateID, value:value, payload:payload }],flag:'02', IO:true }, message});
-                        else this.debug(message);
+                        else if (this.debugActive) this.debug(message);
 
                         const common = {
                             name: statedesc.name,
@@ -968,16 +1062,16 @@ class StatesController extends EventEmitter {
                 } catch (e) {
                     const message = `unable to enumerate states of ${devId} for payload ${JSON.stringify(payload)}, ${(e ? e.name : 'undefined')} (${(e ? e.message : '')}).`;
                     if (has_elevated_debug) this.emit('device_debug', { ID:debugId, data:{ error:'ESTATE', IO:true }, message:message});
-                    else this.debug(message);
+                    else if (this.debugActive) this.debug(message);
                 }
                 const message = `No value published for device ${devId}`;
                 if (!has_published && has_elevated_debug) this.emit('device_debug', { ID:debugId, data:{ error:'NOVAL', IO:true }, message:message});
-                else this.debug(message);
+                else if (this.debugActive) this.debug(message);
             }
             else {
                 const message = `ELEVATED IE05 - NOSTATE: No states matching the payload ${JSON.stringify(payload)} for device ${devId}`;
                 if (has_elevated_debug) this.emit('device_debug', { ID:debugId, data:{ error:'NOSTATE', IO:true }, message});
-                else this.debug(message);
+                else if (this.debugActive) this.debug(message);
             }
         }
         catch (error) {
@@ -1012,7 +1106,7 @@ class StatesController extends EventEmitter {
 
 
     async onZigbeeEvent(type, entity, message) {
-        this.debug(`Type ${type} device ${safeJsonStringify(entity)} incoming event: ${safeJsonStringify(message)}`);
+        if (this.debugActive) this.debug(`Type ${type} device ${safeJsonStringify(entity)} incoming event: ${safeJsonStringify(message)}`);
 
         const device = entity.device;
         const mappedModel = entity.mapped;
@@ -1113,7 +1207,7 @@ class StatesController extends EventEmitter {
             if (type !== 'readResponse') {
                 const message = `No converter available for '${mappedModel.model}' '${devId}' with cluster '${cluster}' and type '${type}'`;
                 if (has_elevated_debug) this.emit('device_debug', { ID:debugId, data: { error:'NOCONV', IO:true }, message:message});
-                else this.debug(message);
+                else if (this.debugActive) this.debug(message);
             }
             return;
         }

package/lib/utils.js

@@ -1,7 +1,5 @@
 'use strict';
 
-const zigbeeHerdsmanConverters = require('zigbee-herdsman-converters');
-
 /**
  * Converts a bulb level of range [0...254] to an adapter level of range [0...100]
  * @param {number} the bulb level of range [0...254]
@@ -125,18 +123,13 @@ function sanitizeImageParameter(parameter) {
 }
 
 function getDeviceIcon(definition) {
-    let icon = definition.icon;
+    const icon = definition.icon;
     if (icon) {
-        icon = icon.replace('${model}', sanitizeImageParameter(definition.model));
-    }
-    //    if (!icon) {
-    //        icon = `https://www.zigbee2mqtt.io/images/devices/${sanitizeImageParameter(definition.model)}.jpg`;
-    //    }
-    if (!icon) {
-        icon = `https://www.zigbee2mqtt.io/images/devices/${sanitizeImageParameter(definition.model)}.png`;
+        return icon;
     }
-    return icon;
+    return `https://www.zigbee2mqtt.io/images/devices/${sanitizeImageParameter(definition.model)}.png`;
 }
+
 function getModelRegEx( model) {
     const stripModel = (model) ? model.replace(/\0.*$/g, '').trim() : '';
     return stripModel;
@@ -149,6 +142,40 @@ function getEntityInfo(entity) {
     return `getEntityInfo: Illegal Entity ${JSON.stringify(entity)}`;
 }
 
+
+function byteArrayToString(data) {
+    if (data) {
+        return data.map(function (x) {
+            x = x + 0x100;  // twos complement
+            x = x.toString(16); // to hex
+            x = ('00'+x).substr(-2); // zero-pad to 8-digits
+            return x
+        }).join('');
+    }
+    else return '';
+}
+
+function getNetAddress(address) {
+    const TcpData = address.match(/[tT][cC][pP]:\/\/(.+)/);
+    if (TcpData) {
+        const hostarr = TcpData[1].split(':');
+        return { strAddress :`tcp://${hostarr.length > 1 ? hostarr[0]+':'+hostarr[1] : hostarr[0]}`, host:hostarr[0], port:(hostarr.length > 1 ? hostarr[1] : undefined) };
+    }
+    return {};
+}
+
+function reverseByteString(source) {
+    if (source && typeof source == 'string') {
+        const rv = [];
+        for (let i=0;i<source.length;i+=2)
+            rv.push(source.slice(i,i+2))
+        return rv.reverse().join('');
+    }
+    return '';
+}
+
+
+
 exports.secondsToMilliseconds   = seconds => seconds * 1000;
 exports.bulbLevelToAdapterLevel = bulbLevelToAdapterLevel;
 exports.adapterLevelToBulbLevel = adapterLevelToBulbLevel;
@@ -168,3 +195,6 @@ exports.isXiaomiDevice          = device =>
 exports.isIkeaTradfriDevice     = device => ikeaTradfriManufacturerID.includes(device.manufacturerID);
 exports.getDeviceIcon           = getDeviceIcon;
 exports.getEntityInfo           = getEntityInfo;
+exports.getNetAddress           = getNetAddress;
+exports.byteArrayToString       = byteArrayToString;
+exports.reverseByteString       = reverseByteString;

package/lib/zbDeviceConfigure.js

@@ -180,15 +180,20 @@ class DeviceConfigure extends BaseExtension {
                     if (this.configureOnMessageAttempts.hasOwnProperty(device.ieeeAddr)) {
                         const com = this.configureOnMessageAttempts[device.ieeeAddr];
                         com.count--;
+                        com.attempts++;
                         com.timestamp = Date.now();
-                        this.info(`Timeout trying to configure ${device.ieeeAddr} ${mappedDevice.model} (${com.count}).`)
-                        if ( com.count < 0) delete this.configureOnMessage[device.ieeeAddr];
+                        if ( com.count < 0) {
+                            delete this.configureOnMessageAttempts[device.ieeeAddr];
+                            this.info(`Configure on message abandoned for ${device.ieeeAddr} ${mappedDevice.model} after failing ${com.attempts} times.`)
+                        }
+                        else this.info(`Timeout trying to configure ${device.ieeeAddr} ${mappedDevice.model} (${com.count}).`)
                     }
                     else {
                         this.info(`Timeout trying to configure ${device.ieeeAddr} ${mappedDevice.model} (starting CoM).`)
                         this.configureOnMessageAttempts[device.ieeeAddr] = {
                             count: 5,
                             timestamp: 0,
+                            attempts: 0,
                         };
                     }
                     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.`;
@@ -203,6 +208,8 @@ class DeviceConfigure extends BaseExtension {
             }
         }
         return 'no return value specified';
+
+
     }
 
     async stop() {