iobroker.zigbee 1.7.5 → 1.7.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.zigbee",
-  "version": "1.7.5",
+  "version": "1.7.6",
   "author": {
     "name": "Kirov Ilya",
     "email": "kirovilya@gmail.com"
@@ -18,8 +18,8 @@
     "node": ">=10"
   },
   "dependencies": {
-    "zigbee-herdsman": "0.14.34",
-    "zigbee-herdsman-converters": "14.0.531",
+    "zigbee-herdsman": "0.14.46",
+    "zigbee-herdsman-converters": "14.0.575",
     "@iobroker/adapter-core": "^2.4.0",
     "tar": "^6.0.5",
     "typescript": "^4.0.5"

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

package/docs/de/readme.md

@@ -1,27 +0,0 @@
-# ioBroker Adapter für Zigbee-Geräte
-Mit Hilfe eines Koordinators für Zigbee-Netz, basierend auf Texas Instruments SoC cc253x (und anderen), wird ein eigenes Netz erschaffen, welchem sich andere Zigbee Geräte beitreten können. Dank der direkten Interaktion mit dem Koordinator, erlaubt der Zigbee Adapter die Steuerung der Geräte ohne jegliche Gateways/Bridges der Hersteller (Xiaomi/Tradfri/Hue). Über Funktionsweise der Zigbee-Netze kann man [hier nachlesen (Englisch)](https://github.com/Koenkk/zigbee2mqtt/wiki/ZigBee-network).
-
-## Die Hardware
-Für die Umsetzung wird einer der aufgezählten Geräte/Sticks verwendet, welche mit spezieller ZNP-Firmware geflasht sind: [cc2530, cc2530, cc2530+RF.](https://github.com/Koenkk/zigbee2mqtt/wiki/Supported-sniffer-devices#zigbee-coordinator)
-
-![](img/CC2531.png)
-![](img/sku_429478_2.png)
-![](img/sku_429601_2.png)
-![](img/CC2591.png)
-
-Der benötigte Flasher/Programmer und der Prozess der Vorbereitung werden [hier (Englisch)](https://github.com/Koenkk/zigbee2mqtt/wiki/Getting-started) oder [hier (Russisch)](https://github.com/kirovilya/ioBroker.zigbee/wiki/%D0%9F%D1%80%D0%BE%D1%88%D0%B8%D0%B2%D0%BA%D0%B0) beschrieben. 
-
-Die mit dem Zigbee-Netz verbundenen Geräte übermitteln dem Koordinator ihren Zustand und benachrichtigen über Ereignisse (Knopfdruck, Bewegungserkennung, Temperaturänderung). Diese Infos werden im Adapter unter den jeweiligen Objekten angezeigt. Außerdem ist es möglich manche Ereignisse/Status zurück zum Zigbee-Gerät zusenden (Zustandsänderung Steckdosen und Lampen, Farb- und Helligkeitseinstellungen).
-
-## Einstellungen und Pairing
-![](https://raw.githubusercontent.com/kirovilya/files/master/config.PNG)
-
-Zu Beginn muss der USB-Port angegeben werden, an welchem der cc253x angeschlossen ist. Wie man diesen Erkennt ist [hier beschrieben (Russisch)](https://github.com/kirovilya/ioBroker.zigbee/wiki#%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0-%D0%B0%D0%B4%D0%B0%D0%BF%D1%82%D0%B5%D1%80%D0%B0)
-
-Zum Verbinden der Geräte muss der Koordinator für Zigbee-Netz in den Pairingmodus versetzt werden, dazu auf den grünen Knopf im Adapter klicken. Pairingmodus ist ab jetzt für 60 Sekunden aktiv. Um die Geräte zu verbinden, reicht im Normallfall ein Betätigen des Knopfes auf dem zu verbindendem Gerät. Es gibt aber auch „besondere“ Geräte. Wie man diese verbindet ist [hier Englisch](https://github.com/Koenkk/zigbee2mqtt/wiki/Pairing-devices) [oder Russisch](https://github.com/kirovilya/ioBroker.zigbee/wiki#%D0%9F%D0%BE%D0%B4%D0%B4%D0%B5%D1%80%D0%B6%D0%B8%D0%B2%D0%B0%D0%B5%D0%BC%D1%8B%D0%B5-%D1%83%D1%81%D1%82%D1%80%D0%BE%D0%B9%D1%81%D1%82%D0%B2%D0%B0) beschrieben.
-
-Nach erfolgreichem Pairing, wird das Gerät im Adapter angezeigt. Sollte ein Gerät (aus der Liste) den Namen „undefined“ haben, dann versucht es zu löschen und nochmal zu pairen. Sollte es trotzdem nicht funktionieren, schreibt bitte ein Issue.
-Zigbee-Geräte die nicht in der Liste aufgeführt sind, können zwar gepairt werden, aber der Adapter kann mit diesen nicht kommunizieren.
-
-## Zusätzliche Informationen
-Es gibt noch ein [Freundschaftprojekt](https://github.com/koenkk/zigbee2mqtt) mit gleichen Funktionen und gleicher Technologie, welcher mit denselben Geräten über ein MQTT Protokoll kommuniziert. Wenn irgendwelche Verbesserungen oder neu unterstütze Geräte im Projekt Zigbee2MQTT eingefügt werden, können jene auch in dieses Projekt hinzugefügt werden. Solltet Ihr unterschiede merken, schreibt bitte ein Issue, wir kümmern uns darum

package/docs/en/readme.md

@@ -1,30 +0,0 @@
-# ioBroker adapter for working with Zigbee-devices
-With the Zigbee-coordinator based on Texas Instruments SoC cc253x (and others), it creates its own zigbee-network, into which zigbee-devices are connected. By work directly with the coordinator, the driver allows you to manage devices without additional gateways / bridge from device manufacturers (Xiaomi / TRADFRI / Hue). About the device Zigbee-network can be read [here (in English)](https://github.com/Koenkk/zigbee2mqtt/wiki/ZigBee-network).
-
-## Hardware
-For work, you need one of the following devices, flashed with a special ZNP firmware: [cc2531, cc2530, cc2530 + RF](https://github.com/Koenkk/zigbee2mqtt/wiki/Supported-sniffer-devices#zigbee-coordinator)
-
-![](img/CC2531.png)
-![](img/sku_429478_2.png)
-![](img/sku_429601_2.png)
-![](img/CC2591.png)
-
-The necessary equipment for the firmware and the device preparation process is described [here (in English)](https://github.com/Koenkk/zigbee2mqtt/wiki/Getting-started) or [here (in Russian)](https://github.com/kirovilya/ioBroker.zigbee/wiki/%D0%9F%D1%80%D0%BE%D1%88%D0%B8%D0%B2%D0%BA%D0%B0)
-
-The devices connected to the Zigbee-network inform the coordinator of their status and events (button presses, motion detection, temperature change). This information is reflected in the ioBroker object-states. Some ioBroker states have feedback and send commands to the zigbee-device when the value changes (switching the state of the outlet or lamp, changing the scene or the brightness of the lamp).
-
-## Work with adapter
-To start the driver, you must specify the name of the port on which the cc253x device is connected.
-
-To connect devices, you need to switch the Zigbee-coordinator to pairing mode by pressing the green button. The countdown will begin (60 seconds) until the device connectivity is available.
-To connect Zigbee devices in most cases, just press the pairing button on the device itself. But there are features for some devices. More information about pairing with devices can be found [here (in English)](https://github.com/Koenkk/zigbee2mqtt/wiki/Pairing-devices) or [here (in Russian)](https://github.com/kirovilya/ioBroker.zigbee/wiki#%D0%9F%D0%BE%D0%B4%D0%B4%D0%B5%D1%80%D0%B6%D0%B8%D0%B2%D0%B0%D0%B5%D0%BC%D1%8B%D0%B5-%D1%83%D1%81%D1%82%D1%80%D0%BE%D0%B9%D1%81%D1%82%D0%B2%D0%B0)
-
-After successful pairing, the device appears in the configuration panel. If the device appears in the configuration panel but has the type "undefined", then this is an unknown device and can not be work with it. If the device is in the list of available devices, but added as "undefined", then try to remove the device and add it again.
-
-## Additional info
-There is a [friendly project](https://github.com/koenkk/zigbee2mqtt) with similar functionality on the same technologies, where you can work with the same devices using the MQTT protocol. Therefore, if any improvements or support for new zigbee-devices occur in the Zigbee2MQTT project, we can transfer and add the same functionality to this adapter. If you notice this, then write the issue - we'll postpone it.
-
-There are knowledge bases that can be useful for working with Zigbee-devices and equipment:
-* in English https://github.com/koenkk/zigbee2mqtt/wiki
-* in Russian https://github.com/kirovilya/ioBroker.zigbee/wiki
-

package/docs/flashing_via_arduino_(en).md

@@ -1,110 +0,0 @@
-Flashing firmware via Arduino is implemented using the project https://github.com/wavesoft/CCLib
-**But with minor improvements!!!**
-
-[AndrewLinden](https://github.com/AndrewLinden) described that he was able to flash CC2531 using CCLib [with comments](https://github.com/wavesoft/CCLib/issues/19).
-
-As described [I made a fork of the CCLib library with minor changes](https://github.com/kirovilya/CCLib) for flashing firmware via Arduino:
-* Timeouts of operations
-* After opening the port (I have in Windows 7) Arduino reboots and, accordingly, does not respond to requests - made a 3 seconds pause (found somewhere in internet).
-* The port speed is reduced to 9600, because at another speed leaving communication errors:
-`ERROR: Could not read from the serial port!`
-
-## Checked on Arduino UNO on CC2531-stick
-
-0. Download and unpack the archive with the library https://github.com/kirovilya/CCLib.
-
-1. Flashing Arduino sketch via Arduino IDE
-CCLib\Arduino\CCLib\Examples\CCLib_proxy\CCLib_proxy.ino
-
-2. Install Python 2.7 or later (tested with python 2.7.13), if not installed
-
-3. Install pyserial 3.0.1, if not installed
-`pip install -r CCLib\Python\requirements.txt`
-or
-`pip install pyserial==3.0.1`
-
-4. Connect the contacts as described https://github.com/kirovilya/CCLib#1-prepare-your-arduino-board
-**But in my case, I connected completely without resistors, combined the contacts CC_DD_I and CC_DD_O together and connected to the DD pin of the DEBUG connector!**
-
-![](https://www.waveshare.com/img/devkit/CC-Debugger/CC-Debugger-JTAG-Header.jpg)
-
-I connected only 3 specified contacts and GND. During the firmware, the stick and Arduino must be connected to the USB.
-
-![](https://github.com/kirovilya/files/blob/master/IMG_20180111_193941.jpg)
-![](https://github.com/kirovilya/files/blob/master/IMG_20180111_193923.jpg)
-![](https://github.com/kirovilya/files/blob/master/IMG_20180110_234401.jpg)
-
-5. After that, try to get information about the chip - if it works, then the connection is correct (example for COM9 port - Arduino port):
-
-```
-C:\Projects\CCLib\Python>python cc_info.py -p COM9
-INFO: Found a CC2531 chip on COM9
-
-Chip information:
-      Chip ID : 0xb524
-   Flash size : 256 Kb
-    Page size : 2 Kb
-    SRAM size : 8 Kb
-          USB : Yes
-
-Device information:
- IEEE Address : 00124b0014aa
-           PC : 0000
-
-Debug status:
- [ ] CHIP_ERASE_BUSY
- [ ] PCON_IDLE
- [X] CPU_HALTED
- [ ] PM_ACTIVE
- [ ] HALT_STATUS
- [ ] DEBUG_LOCKED
- [X] OSCILLATOR_STABLE
- [ ] STACK_OVERFLOW
-
-Debug config:
- [ ] SOFT_POWER_MODE
- [ ] TIMERS_OFF
- [X] DMA_PAUSE
- [X] TIMER_SUSPEND
-```
-[Another example of connection on MacOS](https://github.com/wavesoft/CCLib/issues/22#issuecomment-384452424)
-
-6. If everything is successful, then download [modified firmware for flashing via Arduino](https://github.com/kirovilya/files/blob/master/CC2531ZNP-Pro-Secure_LinkKeyJoin_mod.hex)
-
-7. Start the flashing firmware (it takes a long time, about 2-3 hours):
-
-```
-C:\Projects\ZigBee>python cc_write_flash.py -e -p COM9 --in=CC2531ZNP-Pro-Secure_LinkKeyJoin_mod.hex
-INFO: Found a CC2531 chip on COM9
-
-Chip information:
-      Chip ID : 0xb524
-   Flash size : 256 Kb
-    Page size : 2 Kb
-    SRAM size : 8 Kb
-          USB : Yes
-Sections in CC2531ZNP-Pro-Secure_LinkKeyJoin_mod.hex:
-
- Addr.    Size
--------- -------------
- 0x0000   8176 B
- 0x1ff6   10 B
- 0x3fff0   1 B
- 0x2000   239616 B
-
-This is going to ERASE and REPROGRAM the chip. Are you sure? <y/N>:  y
-
-Flashing:
- - Chip erase...
- - Flashing 4 memory blocks...
- -> 0x0000 : 8176 bytes 
-    Progress 100%... OK
- -> 0x1ff6 : 10 bytes 
-    Progress 100%... OK
- -> 0x3fff0 : 1 bytes 
-    Progress 100%... OK
- -> 0x2000 : 239616 bytes 
-    Progress 100%... OK
-
-Completed
-```

package/docs/ru/readme.md

@@ -1,28 +0,0 @@
-# Драйвер ioBroker для работы с Zigbee-устройствами
-При помощи координатора Zigbee-сети на базе Texas Instruments SoC cc253x (и другими) создается собственная сеть, в которую подключаются zigbee-устройства. Взаимодействуя напрямую с координатором сети, драйвер позволяет управлять устройствами без дополнительных шлюзов/бриджей от производителей устройств (Xiaomi/TRADFRI/Hue). Про устройство Zigbee-сети можно прочитать [тут (на английском языке)](https://github.com/Koenkk/zigbee2mqtt/wiki/ZigBee-network). 
-
-## Оборудование
-Для работы необходимо одно из перечисленных устройств, прошитое специальной ZNP-прошивкой: [cc2531, cc2530, cc2530+RF](https://github.com/Koenkk/zigbee2mqtt/wiki/Supported-sniffer-devices#zigbee-coordinator)
-
-![](img/CC2531.png)
-![](img/sku_429478_2.png)
-![](img/sku_429601_2.png)
-![](img/CC2591.png)
-Необходимое для прошивки оборудование и процесс подготовки устройства описан [тут (на английском языке)](https://github.com/Koenkk/zigbee2mqtt/wiki/Getting-started) или [тут (на русском языке)](https://github.com/kirovilya/ioBroker.zigbee/wiki/%D0%9F%D1%80%D0%BE%D1%88%D0%B8%D0%B2%D0%BA%D0%B0) 
-
-Подключенные к Zigbee-сети устройства сообщают координатору своё состояние и информируют о событиях (нажатия кнопки, обнаружение движения, изменение температуры). Эти сведения отражаются в виде объектов-состояний ioBroker. Некоторые состояния имеют обратную связь и могут отправлять команды zigbee-устройству при изменении состояния (переключение состояния розетки и лампы, изменение сцены или яркости лампы).
-
-## Работа с драйвером
-Для запуска драйвера необходимо указать имя порта, на котором подключено устройство cc253x.
-Как узнать порт написано [тут (на русском языке)](https://github.com/kirovilya/ioBroker.zigbee/wiki#%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0-%D0%B0%D0%B4%D0%B0%D0%BF%D1%82%D0%B5%D1%80%D0%B0)
-
-Для подключения устройств необходимо перевести координатор Zigbee-сети в режим сопряжения, нажав зеленую кнопку. Начнется обратный отсчет времени (60 сек) пока будет доступна возможность подключения устройств.
-Для подключения Zigbee-устройств в большинстве случаев достаточно нажать кнопку сопряжения на самом устройстве. Но существуют особенности для некоторых устройств. Подробнее о сопряжении с устройствами читайте [тут (на английском языке)](https://github.com/Koenkk/zigbee2mqtt/wiki/Pairing-devices) или [тут (на русском языке)](https://github.com/kirovilya/ioBroker.zigbee/wiki#%D0%9F%D0%BE%D0%B4%D0%B4%D0%B5%D1%80%D0%B6%D0%B8%D0%B2%D0%B0%D0%B5%D0%BC%D1%8B%D0%B5-%D1%83%D1%81%D1%82%D1%80%D0%BE%D0%B9%D1%81%D1%82%D0%B2%D0%B0).
-
-После успешного сопряжения, устройство появится в панели устройств. Если устройство появилось в панели устройств, но имеет тип undefined, то это неизвестное устройство и с ним нельзя будет взаимодействовать. Если устройство есть в списке доступных устройств, но добавилось как undefined, то попробуйте удалить устройство и добавить заново.
-Если не получается подключить устройство, то напиши issue.
-
-## Дополнительные сведения
-Существует [дружественный проект](https://github.com/koenkk/zigbee2mqtt) со схожим функционалом на тех же технологиях, в котором с этими же устройствами можно работать по протоколу MQTT.
-Поэтому, если какие-либо улучшения или поддержка новых zigbee-устройств происходит в проекте Zigbee2MQTT, то можно перенести и добавить этот же функционал в этот драйвер. Если заметили это, то напиши issue - перенесем.
-