iobroker.zigbee 1.8.18 → 1.8.20

package/main.js

@@ -13,6 +13,8 @@ try {
 }
 const originalLogMethod = debug.log;
 
+const zigbeeHerdsmanConvertersUtils = require('zigbee-herdsman-converters/lib/utils');
+
 const safeJsonStringify = require('./lib/json');
 const fs = require('fs');
 const path = require('path');
@@ -271,30 +273,6 @@ class Zigbee extends utils.Adapter {
 
             }
         }
-
-    /*    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,
-                module: {},
-            };
-            const converterCode = fs.readFileSync(moduleName, {encoding: 'utf8'});
-            vm.runInNewContext(converterCode, sandbox);
-            const converter = sandbox.module.exports;
-            if (Array.isArray(converter)) {
-                for (const item of converter) {
-                    yield item;
-                }
-            } else {
-                yield converter;
-            }
-        }
-    */
    }
 
     applyExternalConverters() {
@@ -483,6 +461,7 @@ class Zigbee extends utils.Adapter {
 
     async onZigbeeEvent(type, entity, message) {
         this.log.debug(`Type ${type} device ${safeJsonStringify(entity)} incoming event: ${safeJsonStringify(message)}`);
+
         const device = entity.device;
         const mappedModel = entity.mapped;
         const model = entity.mapped ? entity.mapped.model : entity.device.modelID;
@@ -493,25 +472,65 @@ class Zigbee extends utils.Adapter {
         // this assigment give possibility to use iobroker logger in code of the converters, via meta.logger
         meta.logger = this.log;
 
-        await this.checkIfModelUpdate(entity);
-        // always publish link_quality
-        if (message.linkquality) {
+        await this.checkIfModelUpdate(entity);        
+
+        let voltage = 0;
+        let battKey = false;
+
+        if (mappedModel.meta != undefined && mappedModel.meta.battery != undefined) {
+            const isVoltage = entity.mapped.meta.battery.hasOwnProperty('voltageToPercentage');
+    
+            if (isVoltage) {
+                const keys = Object.keys(message.data);
+    
+                for (const key of keys) {
+                    const value = message.data[key];
+                    
+                    this.log.debug(`--> BatteryValue ${safeJsonStringify(value)} from battery search`);
+                    
+                    if (value != undefined && value[1] != undefined) {
+                        if (key == 65282 && value[1][1] != undefined) {
+                            voltage = value[1][1].elmVal;
+                            battKey = true;
+                            break;
+                        }
+                        if (key == 65281) {
+                            voltage = value[1];
+                            battKey = true;
+                            break;
+                        }      
+                    }
+                }
+            }
+        }
+        
+        // always publish link_quality and battery
+        if (message.linkquality) { // send battery with
             this.publishToState(devId, model, {linkquality: message.linkquality});
+            if (battKey) {
+                this.publishToState(devId, model, {voltage: voltage});
+                const  battProz = zigbeeHerdsmanConvertersUtils.batteryVoltageToPercentage(voltage,entity.mapped.meta.battery.voltageToPercentage);
+                this.publishToState(devId, model, {battery: battProz});
+            }
         }
+
         // publish raw event to "from_zigbee"
         // some cleanup
         const msgForState = Object.assign({}, message);
         delete msgForState['device'];
         delete msgForState['endpoint'];
+
         msgForState['endpoint_id'] = message.endpoint.ID;
         this.publishToState(devId, model, {msg_from_zigbee: safeJsonStringify(msgForState)});
 
         if (!entity.mapped) {
             return;
         }
+
         let converters = mappedModel.fromZigbee.filter(c => c && c.cluster === cluster && (
             (c.type instanceof Array) ? c.type.includes(type) : c.type === type));
 
+
         if (!converters.length && type === 'readResponse') {
             converters = mappedModel.fromZigbee.filter(c => c.cluster === cluster && (
                 (c.type instanceof Array) ? c.type.includes('attributeReport') : c.type === 'attributeReport'));
@@ -519,24 +538,33 @@ class Zigbee extends utils.Adapter {
 
         if (!converters.length) {
             if (type !== 'readResponse') {
-                this.log.debug(`No converter available for '${mappedModel.model}' '${devId}' with cluster '${cluster}' and type '${type}'`
-                );
+                this.log.debug(`No converter available for '${mappedModel.model}' '${devId}' with cluster '${cluster}' and type '${type}'`);
             }
             return;
         }
 
-       const publish = (payload) => {
-            this.log.debug(`Publish '${safeJsonStringify(payload)}' devId '${devId}'`);
-            if (payload) {
-                this.publishToState(devId, model, payload);
+        let payload = {};
+
+        const publish = (_payload) => {
+            if (_payload) {
+                this.publishToState(devId, model, _payload);
             }
         };
 
-        for (const converter of converters) {
-            let payload = await converter.convert(mappedModel, message, publish, mappedModel.options, meta);
-            if (payload) {
-                publish(payload);
+        try {
+            for (const converter of converters) {
+                this.stController.collectOptions(devId, model, (options) => {
+                    payload = converter.convert(mappedModel, message, publish, options, meta);
+    
+                    if (payload) {
+                        if (Object.keys(payload).length) {
+                            publish(payload);
+                        }
+                    }
+                });
             }
+        } catch (err) {
+            this.log.error(`convert problem with '${model}' '${devId}' `);
         }
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.zigbee",
-  "version": "1.8.18",
+  "version": "1.8.20",
   "author": {
     "name": "Kirov Ilya",
     "email": "kirovilya@gmail.com"
@@ -25,13 +25,14 @@
     "tar": "^6.1.15",
     "typescript": "^5.1.6",
     "zigbee-herdsman": "0.17.2",
-    "zigbee-herdsman-converters": "15.41.0"
+    "zigbee-herdsman-converters": "15.49.0"
   },
   "description": "Zigbee devices",
   "devDependencies": {
-    "@alcalzone/release-script": "^3.5.9",
-    "@alcalzone/release-script-plugin-iobroker": "^3.5.9",
+    "@alcalzone/release-script": "^3.6.0",
+    "@alcalzone/release-script-plugin-iobroker": "^3.6.0",
     "@alcalzone/release-script-plugin-license": "^3.5.9",
+    "@alcalzone/release-script-plugin-manual-review": "^3.5.9",
     "@iobroker/testing": "^4.1.0",
     "axios": "^1.3.4",
     "chai": "^4.3.7",
@@ -83,6 +84,7 @@
     "test:integration": "mocha test/integration --exit",
     "watch:parcel": "parcel admin/src/index.tsx -d admin/build --hmr-port 1235",
     "test:js": "mocha --opts test/mocha.custom.opts",
+    "lint": "eslint .",
     "release": "release-script",
     "release-patch": "release-script patch --yes --no-update-lockfile",
     "release-minor": "release-script minor --yes --no-update-lockfile",

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);