iobroker.zigbee 1.9.1 → 1.9.3

package/lib/statescontroller.js

@@ -7,7 +7,7 @@ const getZbId = require('./utils').getZbId;
 const fs = require('fs');
 const request = require('request');
 
-let savedDeviceNames = {};
+let savedDeviceNamesDB = {};
 const knownUndefinedDevices = {};
 
 class StatesController extends EventEmitter {
@@ -23,9 +23,9 @@ class StatesController extends EventEmitter {
         fs.readFile(this.dev_names_fn, (err, data) => {
             if (!err) {
                 try {
-                    savedDeviceNames = JSON.parse(data);
+                    savedDeviceNamesDB = JSON.parse(data);
                 } catch {
-                    savedDeviceNames = {};
+                    savedDeviceNamesDB = {};
                 }
             }
         });
@@ -54,7 +54,7 @@ class StatesController extends EventEmitter {
     retainDeviceNames() {
         clearTimeout(this.retTimeoutHandle);
         this.retTimeoutHanlde = setTimeout(() => {
-            fs.writeFile(this.dev_names_fn, JSON.stringify(savedDeviceNames, null, 2), err => {
+            fs.writeFile(this.dev_names_fn, JSON.stringify(savedDeviceNamesDB, null, 2), err => {
                 if (err) {
                     this.error(`error saving device names: ${JSON.stringify(err)}`);
                 } else {
@@ -272,18 +272,30 @@ class StatesController extends EventEmitter {
         this.adapter.extendObject(id, {common: {deactivated: active}});
     }
 
+    async rebuildRetainDeviceNames() {
+        savedDeviceNamesDB = {};
+        const devList = await this.adapter.getAdapterObjectsAsync();
+
+        for (const key in devList) {
+            if (devList[key].type == 'device') {
+                savedDeviceNamesDB[devList[key]._id.replace(`${this.adapter.namespace}.`, '')] = devList[key].common.name;
+            }
+        }
+        this.retainDeviceNames();
+    }
+
     storeDeviceName(id, name) {
-        savedDeviceNames[id.replace(`${this.adapter.namespace}.`, '')] = name;
+        savedDeviceNamesDB[id.replace(`${this.adapter.namespace}.`, '')] = name;
         this.retainDeviceNames();
     }
 
     verifyDeviceName(id, name) {
         const savedId = id.replace(`${this.adapter.namespace}.`, '');
-        if (!savedDeviceNames.hasOwnProperty(savedId)) {
-            savedDeviceNames[savedId] = name;
+        if (!savedDeviceNamesDB.hasOwnProperty(savedId)) {
+            savedDeviceNamesDB[savedId] = name;
             this.retainDeviceNames();
         }
-        return savedDeviceNames[savedId];
+        return savedDeviceNamesDB[savedId];
     }
 
     deleteDeviceStates(devId, callback) {
@@ -597,8 +609,11 @@ class StatesController extends EventEmitter {
         let has_debug = false;
         if (this.debugDevices === undefined) this.getDebugDevices();
         for (const addressPart of this.debugDevices) {
-            if (typeof devId === 'string' && devId.includes(addressPart)) {
-                if (payload.hasOwnProperty('msg_from_zigbee')) break;
+            if (typeof(devId) == 'string' && devId.indexOf(addressPart) > -1) {
+                if (payload.hasOwnProperty('msg_from_zigbee')) {
+                    break;
+                }
+
                 this.warn(`ELEVATED publishToState: message received '${JSON.stringify(payload)}' from device ${devId} type '${model}'`);
                 has_debug = true;
                 break;

package/lib/tools.js

@@ -1,55 +1,55 @@
-'use strict';
-
-const axios = require('axios');
-
-/**
- * Tests whether the given variable is a real object and not an Array
- * @param {any} it The variable to test
- * @returns {it is Record<string, any>}
- */
-function isObject(it) {
-    // This is necessary because:
-    // typeof null === 'object'
-    // typeof [] === 'object'
-    // [] instanceof Object === true
-    return Object.prototype.toString.call(it) === '[object Object]';
-}
-
-/**
- * Tests whether the given variable is really an Array
- * @param {any} it The variable to test
- * @returns {it is any[]}
- */
-function isArray(it) {
-    if (Array.isArray != null)
-        return Array.isArray(it);
-    return Object.prototype.toString.call(it) === '[object Array]';
-}
-
-/**
- * Translates text using the Google Translate API
- * @param {string} text The text to translate
- * @param {string} targetLang The target languate
- * @returns {Promise<string>}
- */
-async function translateText(text, targetLang) {
-    if (targetLang === 'en')
-        return text;
-    try {
-        const url = `http://translate.googleapis.com/translate_a/single?client=gtx&sl=en&tl=${targetLang}&dt=t&q=${encodeURIComponent(text)}&ie=UTF-8&oe=UTF-8`;
-        const response = await axios({url, timeout: 5000});
-        if (isArray(response.data)) {
-            // we got a valid response
-            return response.data[0][0][0];
-        }
-        throw new Error('Invalid response for translate request');
-    } catch (e) {
-        throw new Error(`Could not translate to "${targetLang}": ${e}`);
-    }
-}
-
-module.exports = {
-    isArray,
-    isObject,
-    translateText
+'use strict';
+
+const axios = require('axios');
+
+/**
+ * Tests whether the given variable is a real object and not an Array
+ * @param {any} it The variable to test
+ * @returns {it is Record<string, any>}
+ */
+function isObject(it) {
+    // This is necessary because:
+    // typeof null === 'object'
+    // typeof [] === 'object'
+    // [] instanceof Object === true
+    return Object.prototype.toString.call(it) === '[object Object]';
+}
+
+/**
+ * Tests whether the given variable is really an Array
+ * @param {any} it The variable to test
+ * @returns {it is any[]}
+ */
+function isArray(it) {
+    if (Array.isArray != null)
+        return Array.isArray(it);
+    return Object.prototype.toString.call(it) === '[object Array]';
+}
+
+/**
+ * Translates text using the Google Translate API
+ * @param {string} text The text to translate
+ * @param {string} targetLang The target languate
+ * @returns {Promise<string>}
+ */
+async function translateText(text, targetLang) {
+    if (targetLang === 'en')
+        return text;
+    try {
+        const url = `http://translate.googleapis.com/translate_a/single?client=gtx&sl=en&tl=${targetLang}&dt=t&q=${encodeURIComponent(text)}&ie=UTF-8&oe=UTF-8`;
+        const response = await axios({url, timeout: 5000});
+        if (isArray(response.data)) {
+            // we got a valid response
+            return response.data[0][0][0];
+        }
+        throw new Error('Invalid response for translate request');
+    } catch (e) {
+        throw new Error(`Could not translate to "${targetLang}": ${e}`);
+    }
+}
+
+module.exports = {
+    isArray,
+    isObject,
+    translateText
 };

package/lib/utils.js

@@ -1,165 +1,165 @@
-'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]
- * @returns {the calculated adapter level}
- */
-function bulbLevelToAdapterLevel(bulbLevel) {
-    // Convert from bulb levels [0...254] to adapter levels [0...100]:
-    // - Bulb level 0 is a forbidden value according to the ZigBee spec "ZigBee Cluster Library
-    //   (for ZigBee 3.0) User Guide", but some bulbs (HUE) accept this value and interpret this
-    //   value as "switch the bulb off".
-    // - A bulb level of "1" is the "minimum possible level" which should mean "bulb off",
-    //   but there are bulbs that do not switch off (they need "0", some IKEA bulbs are affected).
-    // - No visible difference was seen between bulb level 1 and 2 on HUE LCT012 bulbs.
-    //
-    // Conclusion:
-    // - We map adapter level "0" to the (forbidden) bulb level "0" that seems to switch all
-    //   known bulbs.
-    // - Bulb level "1" is not used, but if received nevertheless, it is converted to
-    //   adapter level "0" (off).
-    // - Bulb level range [2...254] is linearly mapped to adapter level range [1...100].
-    if (bulbLevel >= 2) {
-        // Perform linear mapping of range [2...254] to [1...100]
-        return Math.round((bulbLevel - 2) * 99 / 252) + 1;
-    } else {
-        // The bulb is considered off. Even a bulb level of "1" is considered as off.
-        return 0;
-    } // else
-}
-
-/**
- * Converts an adapter level of range [0...100] to a bulb level of range [0...254]
- * @param {number} the adapter level of range [0...100]
- * @returns {the calculated bulb level}
- */
-function adapterLevelToBulbLevel(adapterLevel) {
-    // Convert from adapter levels [0...100] to bulb levels [0...254].
-    // This is the inverse of function bulbLevelToAdapterLevel().
-    // Please read the comments there regarding the rules applied here for mapping the values.
-    if (adapterLevel) {
-        // Perform linear mapping of range [1...100] to [2...254]
-        return Math.round((adapterLevel - 1) * 252 / 99) + 2;
-    } else {
-        // Switch the bulb off. Some bulbs need "0" (IKEA), others "1" (HUE), and according to the
-        // ZigBee docs "1" is the "minimum possible level"... we choose "0" here which seems to work.
-        return 0;
-    } // else
-}
-
-function bytesArrayToWordArray(ba) {
-    const wa = [];
-    for (let i = 0; i < ba.length; i++) {
-        wa[(i / 2) | 0] |= ba[i] << (8 * (i % 2));
-    }
-    return wa;
-}
-
-// If the value is greater than 1000, kelvin is assumed.
-// If smaller, it is assumed to be mired.
-function toMired(t) {
-    let miredValue = t;
-    if (t > 1000) {
-        miredValue = miredKelvinConversion(t);
-    }
-    return miredValue;
-}
-
-function miredKelvinConversion(t) {
-    return (1000000 / t).toFixed();
-}
-
-/**
- * Converts a decimal number to a hex string with zero-padding
- * @param {number} decimal The number to convert
- * @param {number} padding The desired length of the hex string, padded with zeros
- * @returns {it is string}
- */
-function decimalToHex(decimal, padding) {
-    let hex = Number(decimal).toString(16);
-    padding = typeof padding === 'undefined' || padding === null ? 2 : padding;
-
-    while (hex.length < padding) {
-        hex = '0' + hex;
-    }
-
-    return hex;
-}
-
-function getZbId(adapterDevId) {
-    const idx = adapterDevId.indexOf('group');
-    if (idx > 0) {
-        return adapterDevId.substr(idx + 6);
-    }
-    return `0x${adapterDevId.split('.')[2]}`;
-}
-
-function getAdId(adapter, id) {
-    return `${adapter.namespace}.${id.split('.')[2]}`; // iobroker device id
-}
-
-function flatten(arr) {
-    return arr.reduce((flat, toFlatten) =>
-        flat.concat(Array.isArray(toFlatten) ? flatten(toFlatten) : toFlatten), []);
-}
-
-const forceEndDevice = flatten(
-    ['QBKG03LM', 'QBKG04LM', 'ZNMS13LM', 'ZNMS12LM']
-        .map(model => zigbeeHerdsmanConverters.findByModel(model))
-        .map(mappedModel => mappedModel.zigbeeModel));
-
-// Xiaomi uses 4151 and 4447 (lumi.plug) as manufacturer ID.
-const xiaomiManufacturerID = [4151, 4447];
-const ikeaTradfriManufacturerID = [4476];
-
-function sanitizeImageParameter(parameter) {
-    const replaceByDash = [/\?/g, /&/g, /[^a-z\d\-_./:]/gi, /[/]/gi];
-    let sanitized = parameter;
-    replaceByDash.forEach(r => sanitized = sanitized.replace(r, '-'));
-    return sanitized;
-}
-
-function getDeviceIcon(definition) {
-    let 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`;
-    }
-    return icon;
-}
-function getModelRegEx( model) {
-    const stripModel = (model) ? model.replace(/\0.*$/g, '').trim() : '';
-    return stripModel;
-}
-
-function getEntityInfo(entity) {
-    if (entity) {
-        return `Type: ${entity.type} Name: ${entity.name}`;
-    }
-    return `getEntityInfo: Illegal Entity ${JSON.stringify(entity)}`;
-}
-
-exports.secondsToMilliseconds   = seconds => seconds * 1000;
-exports.bulbLevelToAdapterLevel = bulbLevelToAdapterLevel;
-exports.adapterLevelToBulbLevel = adapterLevelToBulbLevel;
-exports.bytesArrayToWordArray   = bytesArrayToWordArray;
-exports.toMired                 = toMired;
-exports.miredKelvinConversion   = miredKelvinConversion;
-exports.decimalToHex            = decimalToHex;
-exports.getZbId                 = getZbId;
-exports.getAdId                 = getAdId;
-exports.getModelRegEx           = getModelRegEx;
-exports.isRouter                = device => device.type === 'Router' && !forceEndDevice.includes(device.modelID);
-exports.isBatteryPowered        = device => device.powerSource && device.powerSource === 'Battery';
-exports.isXiaomiDevice          = device =>
-    device.modelID !== 'lumi.router' &&
-    xiaomiManufacturerID.includes(device.manufacturerID) &&
-    (!device.manufacturerName || !device.manufacturerName.startsWith('Trust'));
-exports.isIkeaTradfriDevice     = device => ikeaTradfriManufacturerID.includes(device.manufacturerID);
-exports.getDeviceIcon           = getDeviceIcon;
-exports.getEntityInfo           = getEntityInfo;
+'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]
+ * @returns {the calculated adapter level}
+ */
+function bulbLevelToAdapterLevel(bulbLevel) {
+    // Convert from bulb levels [0...254] to adapter levels [0...100]:
+    // - Bulb level 0 is a forbidden value according to the ZigBee spec "ZigBee Cluster Library
+    //   (for ZigBee 3.0) User Guide", but some bulbs (HUE) accept this value and interpret this
+    //   value as "switch the bulb off".
+    // - A bulb level of "1" is the "minimum possible level" which should mean "bulb off",
+    //   but there are bulbs that do not switch off (they need "0", some IKEA bulbs are affected).
+    // - No visible difference was seen between bulb level 1 and 2 on HUE LCT012 bulbs.
+    //
+    // Conclusion:
+    // - We map adapter level "0" to the (forbidden) bulb level "0" that seems to switch all
+    //   known bulbs.
+    // - Bulb level "1" is not used, but if received nevertheless, it is converted to
+    //   adapter level "0" (off).
+    // - Bulb level range [2...254] is linearly mapped to adapter level range [1...100].
+    if (bulbLevel >= 2) {
+        // Perform linear mapping of range [2...254] to [1...100]
+        return Math.round((bulbLevel - 2) * 99 / 252) + 1;
+    } else {
+        // The bulb is considered off. Even a bulb level of "1" is considered as off.
+        return 0;
+    } // else
+}
+
+/**
+ * Converts an adapter level of range [0...100] to a bulb level of range [0...254]
+ * @param {number} the adapter level of range [0...100]
+ * @returns {the calculated bulb level}
+ */
+function adapterLevelToBulbLevel(adapterLevel) {
+    // Convert from adapter levels [0...100] to bulb levels [0...254].
+    // This is the inverse of function bulbLevelToAdapterLevel().
+    // Please read the comments there regarding the rules applied here for mapping the values.
+    if (adapterLevel) {
+        // Perform linear mapping of range [1...100] to [2...254]
+        return Math.round((adapterLevel - 1) * 252 / 99) + 2;
+    } else {
+        // Switch the bulb off. Some bulbs need "0" (IKEA), others "1" (HUE), and according to the
+        // ZigBee docs "1" is the "minimum possible level"... we choose "0" here which seems to work.
+        return 0;
+    } // else
+}
+
+function bytesArrayToWordArray(ba) {
+    const wa = [];
+    for (let i = 0; i < ba.length; i++) {
+        wa[(i / 2) | 0] |= ba[i] << (8 * (i % 2));
+    }
+    return wa;
+}
+
+// If the value is greater than 1000, kelvin is assumed.
+// If smaller, it is assumed to be mired.
+function toMired(t) {
+    let miredValue = t;
+    if (t > 1000) {
+        miredValue = miredKelvinConversion(t);
+    }
+    return miredValue;
+}
+
+function miredKelvinConversion(t) {
+    return (1000000 / t).toFixed();
+}
+
+/**
+ * Converts a decimal number to a hex string with zero-padding
+ * @param {number} decimal The number to convert
+ * @param {number} padding The desired length of the hex string, padded with zeros
+ * @returns {it is string}
+ */
+function decimalToHex(decimal, padding) {
+    let hex = Number(decimal).toString(16);
+    padding = typeof padding === 'undefined' || padding === null ? 2 : padding;
+
+    while (hex.length < padding) {
+        hex = '0' + hex;
+    }
+
+    return hex;
+}
+
+function getZbId(adapterDevId) {
+    const idx = adapterDevId.indexOf('group');
+    if (idx > 0) {
+        return adapterDevId.substr(idx + 6);
+    }
+    return `0x${adapterDevId.split('.')[2]}`;
+}
+
+function getAdId(adapter, id) {
+    return `${adapter.namespace}.${id.split('.')[2]}`; // iobroker device id
+}
+
+function flatten(arr) {
+    return arr.reduce((flat, toFlatten) =>
+        flat.concat(Array.isArray(toFlatten) ? flatten(toFlatten) : toFlatten), []);
+}
+
+const forceEndDevice = flatten(
+    ['QBKG03LM', 'QBKG04LM', 'ZNMS13LM', 'ZNMS12LM']
+        .map(model => zigbeeHerdsmanConverters.findByModel(model))
+        .map(mappedModel => mappedModel.zigbeeModel));
+
+// Xiaomi uses 4151 and 4447 (lumi.plug) as manufacturer ID.
+const xiaomiManufacturerID = [4151, 4447];
+const ikeaTradfriManufacturerID = [4476];
+
+function sanitizeImageParameter(parameter) {
+    const replaceByDash = [/\?/g, /&/g, /[^a-z\d\-_./:]/gi, /[/]/gi];
+    let sanitized = parameter;
+    replaceByDash.forEach(r => sanitized = sanitized.replace(r, '-'));
+    return sanitized;
+}
+
+function getDeviceIcon(definition) {
+    let 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`;
+    }
+    return icon;
+}
+function getModelRegEx( model) {
+    const stripModel = (model) ? model.replace(/\0.*$/g, '').trim() : '';
+    return stripModel;
+}
+
+function getEntityInfo(entity) {
+    if (entity) {
+        return `Type: ${entity.type} Name: ${entity.name}`;
+    }
+    return `getEntityInfo: Illegal Entity ${JSON.stringify(entity)}`;
+}
+
+exports.secondsToMilliseconds   = seconds => seconds * 1000;
+exports.bulbLevelToAdapterLevel = bulbLevelToAdapterLevel;
+exports.adapterLevelToBulbLevel = adapterLevelToBulbLevel;
+exports.bytesArrayToWordArray   = bytesArrayToWordArray;
+exports.toMired                 = toMired;
+exports.miredKelvinConversion   = miredKelvinConversion;
+exports.decimalToHex            = decimalToHex;
+exports.getZbId                 = getZbId;
+exports.getAdId                 = getAdId;
+exports.getModelRegEx           = getModelRegEx;
+exports.isRouter                = device => device.type === 'Router' && !forceEndDevice.includes(device.modelID);
+exports.isBatteryPowered        = device => device.powerSource && device.powerSource === 'Battery';
+exports.isXiaomiDevice          = device =>
+    device.modelID !== 'lumi.router' &&
+    xiaomiManufacturerID.includes(device.manufacturerID) &&
+    (!device.manufacturerName || !device.manufacturerName.startsWith('Trust'));
+exports.isIkeaTradfriDevice     = device => ikeaTradfriManufacturerID.includes(device.manufacturerID);
+exports.getDeviceIcon           = getDeviceIcon;
+exports.getEntityInfo           = getEntityInfo;

package/lib/zbBaseExtension.js

@@ -1,36 +1,36 @@
-'use strict';
-
-/*eslint no-unused-vars: ['off']*/
-
-class BaseExtension {
-    constructor(zigbee, options) {
-        this.zigbee = zigbee;
-        this.name = 'BaseExtension';
-        this.elevate_debug = false;
-    }
-
-    info(message, data) {
-        this.zigbee.info(message, data);
-    }
-
-    error(message, data) {
-        this.zigbee.error(`${this.name}:${message}`, data);
-    }
-
-    warn(message, data) {
-        this.zigbee.warn(`${this.name}:${message}`, data);
-    }
-
-    debug(message, data) {
-        if (this.elevate_debug)
-            this.zigbee.warn(`DE ${this.name}:${message}`, data);
-        else
-            this.zigbee.debug(`${this.name}:${message}`, data);
-    }
-
-    sendError(error, message) {
-        this.zigbee.sendError(error, message);
-    }
-}
-
-module.exports = BaseExtension;
+'use strict';
+
+/*eslint no-unused-vars: ['off']*/
+
+class BaseExtension {
+    constructor(zigbee, options) {
+        this.zigbee = zigbee;
+        this.name = 'BaseExtension';
+        this.elevate_debug = false;
+    }
+
+    info(message, data) {
+        this.zigbee.info(message, data);
+    }
+
+    error(message, data) {
+        this.zigbee.error(`${this.name}:${message}`, data);
+    }
+
+    warn(message, data) {
+        this.zigbee.warn(`${this.name}:${message}`, data);
+    }
+
+    debug(message, data) {
+        if (this.elevate_debug)
+            this.zigbee.warn(`DE ${this.name}:${message}`, data);
+        else
+            this.zigbee.debug(`${this.name}:${message}`, data);
+    }
+
+    sendError(error, message) {
+        this.zigbee.sendError(error, message);
+    }
+}
+
+module.exports = BaseExtension;