iobroker.zigbee 1.8.9 → 1.8.12

package/main.js

@@ -216,9 +216,64 @@ class Zigbee extends utils.Adapter {
         }
         const extfiles = this.config.external.split(';');
         for (const moduleName of extfiles) {
-            if (!moduleName) {
-                continue;
+            if (!moduleName) continue;
+            const sandbox = {
+                require,
+                module: {},
+            };
+            const mN = (fs.existsSync(moduleName) ? moduleName : this.expandFileName(moduleName).replace('.', '_'));
+            if (!fs.existsSync(mN)) {
+              this.log.warn(`External converter not loaded - neither ${moduleName} nor ${mN} exist.`)
+
             }
+            else {
+                const converterCode = fs.readFileSync(mN, {encoding: 'utf8'}).toString();
+                let converterLoaded = true;
+                if (converterCode.match(/..\/lib\/legacy/gm)) {
+                    this.log.warn(`External converter ${mN} contains an unsupported reference to '/lib/legacy' - external converter not loaded.`)
+                    converterLoaded = false;
+                }
+                else
+                {
+                    // remove the require statements and attempt to place them in the sandbox
+                    const requiredLibraries = converterCode.matchAll(/(\w+) += +require\(['"](\S+)['"]\);/gm);
+                    for (const line of requiredLibraries) {
+                        const movedLine = line[2].replace('..', '../zigbee-herdsman-converters')
+                        try {
+                            sandbox[line[1]] = require(movedLine);
+                        }
+                        catch (e) {
+                            this.log.warn(`error adding ${line[1]} (${movedLine}) to the sandbox: ${e}`);
+                            converterLoaded = false;
+                        }
+                    }
+                }
+                if (converterLoaded) {
+                    this.log.info(`Apply converter from module: ${mN}`);
+                    //this.log.warn(converterCode.replace(/const (\w+) += +require\(['"](\S+)['"]\);/gm, ''));
+                    try {
+                        vm.runInNewContext(converterCode.replace(/const (\w+) += +require\(['"](\S+)['"]\);/gm, ''), sandbox);
+                        const converter = sandbox.module.exports;
+
+                        if (Array.isArray(converter)) for (const item of converter) yield item;
+                        else yield converter;
+                    }
+                    catch (e) {
+                        this.log.error(`Unable to apply converter from module: ${mN} - the code does not run: ${e}`)
+                    }
+                }
+                else
+                    this.log.info(`Ignoring converter from module: ${mN} - see warn messages for reason`);
+
+            }
+        }
+
+    /*    if (this.config.external === undefined) {
+            return;
+        }
+        const extfiles = this.config.external.split(';');
+        for (const moduleName of extfiles) {
+            if (!moduleName) continue;
             this.log.info(`Apply converter from module: ${moduleName}`);
             const sandbox = {
                 require,
@@ -235,14 +290,23 @@ class Zigbee extends utils.Adapter {
                 yield converter;
             }
         }
-    }
+    */
+   }
 
     applyExternalConverters() {
+      try {
         for (const definition of this.getExternalDefinition()) {
             const toAdd = {...definition};
             delete toAdd['homeassistant'];
-            zigbeeHerdsmanConverters.addDeviceDefinition(toAdd);
+            try {
+              zigbeeHerdsmanConverters.addDeviceDefinition(toAdd);
+            }
+            catch { this.log.error(`unable to apply external converter ${JSON.stringfy(toAdd)}`) }
         }
+      }
+      catch(error) {
+         this.log.error('error applying external converters');
+      }
     }
 
     async doConnect() {
@@ -503,7 +567,7 @@ class Zigbee extends utils.Adapter {
             deviceId = parseInt(deviceId);
         }
         const entity = await this.zbController.resolveEntity(deviceId);
-        this.log.debug(`entity: ${safeJsonStringify(entity)}`);
+        this.log.debug(`entity: ${deviceId} ${model} ${safeJsonStringify(entity)}`);
         const mappedModel = entity.mapped;
         if (!mappedModel) {
             this.log.debug(`No mapped model for ${model}`);
@@ -851,6 +915,7 @@ class Zigbee extends utils.Adapter {
 
     onPairing(message, data) {
         if (Number.isInteger(data)) {
+            _pairingMode = true;
             this.setState('info.pairingCountdown', data, true);
             _pairingMode = true;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.zigbee",
-  "version": "1.8.9",
+  "version": "1.8.12",
   "author": {
     "name": "Kirov Ilya",
     "email": "kirovilya@gmail.com"
@@ -21,11 +21,11 @@
     "serialport": "^10.5.0"
   },
   "dependencies": {
-    "@iobroker/adapter-core": "^2.6.7",
-    "tar": "^6.1.12",
-    "typescript": "^4.9.3",
-    "zigbee-herdsman": "0.14.80",
-    "zigbee-herdsman-converters": "14.0.687"
+    "@iobroker/adapter-core": "^2.6.8",
+    "tar": "^6.1.15",
+    "typescript": "^5.0.4",
+    "zigbee-herdsman": "0.16.0",
+    "zigbee-herdsman-converters": "15.32.0"
   },
   "description": "Zigbee devices",
   "devDependencies": {
@@ -33,17 +33,17 @@
     "@alcalzone/release-script-plugin-iobroker": "^3.5.9",
     "@alcalzone/release-script-plugin-license": "^3.5.9",
     "@iobroker/testing": "^4.1.0",
-    "axios": "^1.2.0",
+    "axios": "^1.3.4",
     "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^8.28.0",
-    "eslint-config-prettier": "^8.5.0",
+    "eslint": "^8.41.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^4.2.1",
     "gulp": "^4.0.2",
     "gulp-jsdoc3": "^3.0.0",
-    "gulp-replace": "^1.1.3",
+    "gulp-replace": "^1.1.4",
     "mixin-deep": "^2.0.1",
-    "mocha": "^10.1.0"
+    "mocha": "^10.2.0"
   },
   "homepage": "https://github.com/ioBroker/ioBroker.zigbee",
   "keywords": [

package/support/docgen.js

@@ -1,93 +1,93 @@
-/**
- * This script generates the supported devices page.
- * 
- */
-
-let devices = [...require('zigbee-herdsman-converters').devices];
-
-for (const device of devices) {
-    if (device.whiteLabel) {
-        for (const whiteLabel of device.whiteLabel) {
-            const whiteLabelDevice = {
-                ...device,
-                model: whiteLabel.model,
-                vendor: whiteLabel.vendor,
-                description: whiteLabel.description,
-                whiteLabelOf: device,
-            };
-
-            delete whiteLabelDevice.whiteLabel;
-
-            devices.push(whiteLabelDevice);
-        }
-    }
-}
-
-devices = new Map(devices.map((d) => [d.model, d]));
-
-const Devices = require('../lib/devices');
-let iobDevices = Devices.devices;
-Devices.fillStatesWithExposes('');
-
-const iobCount = iobDevices.filter((d) => (!d.exposed)).length;
-iobDevices = new Map(iobDevices.map((d) => d.models.map((m) => [m, d])).flat());
-
-const fs = require('fs');
-const outputdir = process.argv[2];
-
-if (!outputdir) {
-    console.error('Please specify an output directory');
-}
-
-const file = 'Supported-devices.md';
-let text = `*NOTE: Automatically generated by 'npm run docgen'* \n\n` +
-    `Currently **${iobDevices.size}**(${iobCount} described in adapter) devices are supported.\n\n` +
-    `(⭐EXP) - means that the device is presented automatically, based on the 'exposes' from the zigbee-herdsman-converters.\n\n`;
-
-const logDevices = (devmodels) => {
-    let result = '';
-
-    devmodels.forEach((devmodel) => {
-        const iobDevice = iobDevices.get(devmodel);
-        const device = devices.get(devmodel);
-        const pathImg = (iobDevice.icon.startsWith('http')) ? devmodel : iobDevice.icon.replace(new RegExp('img/', 'g'), '').replace(new RegExp('.png', 'g'), '');
-        const icon = (iobDevice.icon.startsWith('http')) ? iobDevice.icon : `https://github.com/ioBroker/ioBroker.zigbee/raw/master/admin/${iobDevice.icon}`;
-        let brand;
-        const models = [];
-        let zmodels;
-        if (device.zigbeeModel) {
-            zmodels = device.zigbeeModel;
-        } else {
-            zmodels = [devmodel];
-        }
-        zmodels.forEach((modelId) => {
-            const re = /[^\x20-\x7E]+/g;
-            const model = modelId.replace(re, ' ');
-            const desc = `${device.description} (${device.supports})`;
-            const name = `**${device.model}${(iobDevice.exposed) ? ' (⭐EXP)': ''}**<br>`;
-            if (brand == undefined) {
-                brand= {
-                    name: name,
-                    desc: desc,
-                    pathImg: pathImg,
-                };
-            }
-            models.push(model);
-        });
-        const modelsStr = models.join(', ');
-        result += `| ${brand.name} (${modelsStr}) | ${brand.desc} |  ![${brand.pathImg}](${icon}) |\n`;
-    });
-
-    return result;
-};
-
-const vendors = Array.from(new Set([...iobDevices.keys()].map((m) => (devices.get(m)) ? devices.get(m).vendor : null)));
-vendors.sort();
-text += '|  Model | Description | Picture |\n';
-text += '| ------------- | ------------- | -------------------------- |\n';
-vendors.forEach((vendor) => {
-    text += `|  | **${vendor}**  |   |\n`;   
-    text += logDevices([...iobDevices.keys()].map((m) => devices.get(m)).filter((d) => d && d.vendor === vendor).map((d) => d.model));
-});
-
-fs.writeFileSync(outputdir + '/' + file, text);
+/**
+ * This script generates the supported devices page.
+ * 
+ */
+
+let devices = [...require('zigbee-herdsman-converters').devices];
+
+for (const device of devices) {
+    if (device.whiteLabel) {
+        for (const whiteLabel of device.whiteLabel) {
+            const whiteLabelDevice = {
+                ...device,
+                model: whiteLabel.model,
+                vendor: whiteLabel.vendor,
+                description: whiteLabel.description,
+                whiteLabelOf: device,
+            };
+
+            delete whiteLabelDevice.whiteLabel;
+
+            devices.push(whiteLabelDevice);
+        }
+    }
+}
+
+devices = new Map(devices.map((d) => [d.model, d]));
+
+const Devices = require('../lib/devices');
+let iobDevices = Devices.devices;
+Devices.fillStatesWithExposes('');
+
+const iobCount = iobDevices.filter((d) => (!d.exposed)).length;
+iobDevices = new Map(iobDevices.map((d) => d.models.map((m) => [m, d])).flat());
+
+const fs = require('fs');
+const outputdir = process.argv[2];
+
+if (!outputdir) {
+    console.error('Please specify an output directory');
+}
+
+const file = 'Supported-devices.md';
+let text = `*NOTE: Automatically generated by 'npm run docgen'* \n\n` +
+    `Currently **${iobDevices.size}**(${iobCount} described in adapter) devices are supported.\n\n` +
+    `(⭐EXP) - means that the device is presented automatically, based on the 'exposes' from the zigbee-herdsman-converters.\n\n`;
+
+const logDevices = (devmodels) => {
+    let result = '';
+
+    devmodels.forEach((devmodel) => {
+        const iobDevice = iobDevices.get(devmodel);
+        const device = devices.get(devmodel);
+        const pathImg = (iobDevice.icon.startsWith('http')) ? devmodel : iobDevice.icon.replace(new RegExp('img/', 'g'), '').replace(new RegExp('.png', 'g'), '');
+        const icon = (iobDevice.icon.startsWith('http')) ? iobDevice.icon : `https://github.com/ioBroker/ioBroker.zigbee/raw/master/admin/${iobDevice.icon}`;
+        let brand;
+        const models = [];
+        let zmodels;
+        if (device.zigbeeModel) {
+            zmodels = device.zigbeeModel;
+        } else {
+            zmodels = [devmodel];
+        }
+        zmodels.forEach((modelId) => {
+            const re = /[^\x20-\x7E]+/g;
+            const model = modelId.replace(re, ' ');
+            const desc = `${device.description} (${device.supports})`;
+            const name = `**${device.model}${(iobDevice.exposed) ? ' (⭐EXP)': ''}**<br>`;
+            if (brand == undefined) {
+                brand= {
+                    name: name,
+                    desc: desc,
+                    pathImg: pathImg,
+                };
+            }
+            models.push(model);
+        });
+        const modelsStr = models.join(', ');
+        result += `| ${brand.name} (${modelsStr}) | ${brand.desc} |  ![${brand.pathImg}](${icon}) |\n`;
+    });
+
+    return result;
+};
+
+const vendors = Array.from(new Set([...iobDevices.keys()].map((m) => (devices.get(m)) ? devices.get(m).vendor : null)));
+vendors.sort();
+text += '|  Model | Description | Picture |\n';
+text += '| ------------- | ------------- | -------------------------- |\n';
+vendors.forEach((vendor) => {
+    text += `|  | **${vendor}**  |   |\n`;   
+    text += logDevices([...iobDevices.keys()].map((m) => devices.get(m)).filter((d) => d && d.vendor === vendor).map((d) => d.model));
+});
+
+fs.writeFileSync(outputdir + '/' + file, text);