iobroker.zigbee2mqtt 2.7.0 → 2.7.1

package/README.md

@@ -32,6 +32,11 @@ This adapter allows to control the data points of the devices of a Zigbee2MQTT i
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+### 2.7.1 (2023-01-24)
+
+-   (o0shojo0o) added option for use folder description
+-   (o0shojo0o) use the iobroker device folder description for device description or events
+
 ### 2.7.0 (2023-01-18)
 
 -   (o0shojo0o) added support for  wildcard actions (eg. *_single) ([#116](https://github.com/o0shojo0o/ioBroker.zigbee2mqtt/issues/116))

package/admin/i18n/de/translations.json

@@ -24,5 +24,6 @@
     "Brightness move should also turn the light on or off": "Brightness move soll auch das Licht ein- oder ausschalten",
     "Brightness step should also turn the light on or off": "Brightness step soll auch das Licht ein- oder ausschalten",
     "Use Auth-Token": "Auth-Token verwenden",
-    "Auth-Token (special characters are not supported)": "Auth-Token (Sonderzeichen werden nicht unterstützt)"
-}
+    "Auth-Token (special characters are not supported)": "Auth-Token (Sonderzeichen werden nicht unterstützt)",
+    "The events such as 'Device removed' or 'Disabled' are displayed in the description instead of in the name.": "Die Ereignisse wie „Gerät entfernt“ oder „Deaktiviert“ werden in der Beschreibung statt im Namen angezeigt."
+}

package/admin/i18n/en/translations.json

@@ -24,5 +24,6 @@
 	"Other configurations": "Other configurations",
 	"Proxy Zigbee2MQTT logs to ioBroker logs": "Proxy Zigbee2MQTT logs to ioBroker logs",
 	"Brightness move should also turn the light on or off": "Brightness move should also turn the light on or off",
-	"Brightness step should also turn the light on or off": "Brightness step should also turn the light on or off"
+	"Brightness step should also turn the light on or off": "Brightness step should also turn the light on or off",
+	"The events such as 'Device removed' or 'Disabled' are displayed in the description instead of in the name.": "The events such as 'Device removed' or 'Disabled' are displayed in the description instead of in the name."
 }

package/admin/i18n/es/translations.json

@@ -24,5 +24,6 @@
     "Other configurations": "Otras configuraciones",
     "Proxy Zigbee2MQTT logs to ioBroker logs": "Proxy de registros Zigbee2MQTT a registros de ioBroker",
     "Brightness move should also turn the light on or off": "El movimiento de brillo también debe encender o apagar la luz",
-    "Brightness step should also turn the light on or off": "El paso de brillo también debe encender o apagar la luz"
+    "Brightness step should also turn the light on or off": "El paso de brillo también debe encender o apagar la luz",
+    "The events such as 'Device removed' or 'Disabled' are displayed in the description instead of in the name.": "Los eventos como 'Dispositivo eliminado' o 'Deshabilitado' se muestran en la descripción en lugar del nombre."
 }

package/admin/i18n/fr/translations.json

@@ -24,5 +24,6 @@
     "Other configurations": "Autres configurations",
     "Proxy Zigbee2MQTT logs to ioBroker logs": "Proxy Zigbee2MQTT se connecte aux journaux ioBroker",
     "Brightness move should also turn the light on or off": "Le mouvement de luminosité devrait également allumer ou éteindre la lumière",
-    "Brightness step should also turn the light on or off": "L'étape de luminosité devrait également allumer ou éteindre la lumière"
+    "Brightness step should also turn the light on or off": "L'étape de luminosité devrait également allumer ou éteindre la lumière",
+    "The events such as 'Device removed' or 'Disabled' are displayed in the description instead of in the name.": "Les événements tels que 'Appareil supprimé' ou 'Désactivé' sont affichés dans la description plutôt que dans le nom."
 }

package/admin/i18n/it/translations.json

@@ -24,5 +24,6 @@
     "Other configurations": "Altre configurazioni",
     "Proxy Zigbee2MQTT logs to ioBroker logs": "Il proxy Zigbee2MQTT registra nei registri ioBroker",
     "Brightness move should also turn the light on or off": "Lo spostamento della luminosità dovrebbe anche accendere o spegnere la luce",
-    "Brightness step should also turn the light on or off": "Il passo di luminosità dovrebbe anche accendere o spegnere la luce"
+    "Brightness step should also turn the light on or off": "Il passo di luminosità dovrebbe anche accendere o spegnere la luce",
+    "The events such as 'Device removed' or 'Disabled' are displayed in the description instead of in the name.": "Gli eventi come \"Dispositivo rimosso\" o \"Disabilitato\" vengono visualizzati nella descrizione anziché nel nome."
 }

package/admin/i18n/nl/translations.json

@@ -24,5 +24,6 @@
     "Other configurations": "Andere configuraties",
     "Proxy Zigbee2MQTT logs to ioBroker logs": "Proxy Zigbee2MQTT logt naar ioBroker-logboeken",
     "Brightness move should also turn the light on or off": "Helderheidsbeweging zou ook het licht aan of uit moeten zetten",
-    "Brightness step should also turn the light on or off": "De helderheidsstap moet het licht ook in- of uitschakelen"
+    "Brightness step should also turn the light on or off": "De helderheidsstap moet het licht ook in- of uitschakelen",
+    "The events such as 'Device removed' or 'Disabled' are displayed in the description instead of in the name.": "De gebeurtenissen zoals 'Apparaat verwijderd' of 'Uitgeschakeld' worden weergegeven in de beschrijving in plaats van in de naam."
 }

package/admin/i18n/pl/translations.json

@@ -24,5 +24,6 @@
     "Other configurations": "Inne konfiguracje",
     "Proxy Zigbee2MQTT logs to ioBroker logs": "Proxy Zigbee2MQTT loguje się do logów ioBroker",
     "Brightness move should also turn the light on or off": "Ruch jasności powinien również włączać lub wyłączać światło",
-    "Brightness step should also turn the light on or off": "Krok jasności powinien również włączać lub wyłączać światło"
+    "Brightness step should also turn the light on or off": "Krok jasności powinien również włączać lub wyłączać światło",
+    "The events such as 'Device removed' or 'Disabled' are displayed in the description instead of in the name.": "Zdarzenia takie jak „Urządzenie usunięte” lub „Wyłączone” są wyświetlane w opisie zamiast w nazwie."
 }

package/admin/i18n/pt/translations.json

@@ -24,5 +24,6 @@
     "Other configurations": "Outras configurações",
     "Proxy Zigbee2MQTT logs to ioBroker logs": "Logs proxy Zigbee2MQTT para logs ioBroker",
     "Brightness move should also turn the light on or off": "O movimento de brilho também deve ligar ou desligar a luz",
-    "Brightness step should also turn the light on or off": "A etapa de brilho também deve ligar ou desligar a luz"
+    "Brightness step should also turn the light on or off": "A etapa de brilho também deve ligar ou desligar a luz",
+    "The events such as 'Device removed' or 'Disabled' are displayed in the description instead of in the name.": "Os eventos como 'Dispositivo removido' ou 'Desativado' são exibidos na descrição em vez de no nome."
 }

package/admin/i18n/ru/translations.json

@@ -24,5 +24,6 @@
     "Other configurations": "Другие конфигурации",
     "Proxy Zigbee2MQTT logs to ioBroker logs": "Проксировать журналы Zigbee2MQTT в журналы ioBroker",
     "Brightness move should also turn the light on or off": "Изменение яркости также должно включать или выключать свет.",
-    "Brightness step should also turn the light on or off": "Шаг яркости также должен включать или выключать свет."
+    "Brightness step should also turn the light on or off": "Шаг яркости также должен включать или выключать свет.",
+    "The events such as 'Device removed' or 'Disabled' are displayed in the description instead of in the name.": "Такие события, как «Устройство удалено» или «Отключено», отображаются в описании, а не в названии."
 }

package/admin/i18n/uk/translations.json

@@ -24,5 +24,6 @@
     "Other configurations": "Інші конфігурації",
     "Proxy Zigbee2MQTT logs to ioBroker logs": "Журнали проксі Zigbee2MQTT до журналів ioBroker",
     "Brightness move should also turn the light on or off": "Переміщення яскравості також повинно вмикати або вимикати світло",
-    "Brightness step should also turn the light on or off": "Крок яскравості також повинен вмикати або вимикати світло"
+    "Brightness step should also turn the light on or off": "Крок яскравості також повинен вмикати або вимикати світло",
+    "The events such as 'Device removed' or 'Disabled' are displayed in the description instead of in the name.": "Такі події, як «Пристрій видалено» або «Вимкнено», відображаються в описі, а не в назві."
 }

package/admin/i18n/zh-cn/translations.json

@@ -24,5 +24,6 @@
     "Other configurations": "其他配置",
     "Proxy Zigbee2MQTT logs to ioBroker logs": "代理 Zigbee2MQTT 日志到 ioBroker 日志",
     "Brightness move should also turn the light on or off": "亮度移动也应该打开或关闭灯",
-    "Brightness step should also turn the light on or off": "亮度步骤也应该打开或关闭灯"
+    "Brightness step should also turn the light on or off": "亮度步骤也应该打开或关闭灯",
+    "The events such as 'Device removed' or 'Disabled' are displayed in the description instead of in the name.": "“设备已移除”或“已禁用”等事件显示在描述中而不是名称中。"
 }

package/admin/jsonConfig.json

@@ -10,7 +10,7 @@
 		},
 		"connectionType": {
 			"label": "Select connection to Zigbee2MQTT",
-			"sm": 4,
+			"sm": 5,
 			"type": "select",
 			"options": [
 				{
@@ -60,7 +60,7 @@
 			"type": "password",
 			"label": "Auth-Token (special characters are not supported)",
 			"newLine": true,
-			"lg": 2,
+			"lg": 5,
 			"hidden": "data.wsTokenEnabled != true || data.connectionType != 'ws'"
 		},
 		"dummyMqtt": {
@@ -171,6 +171,11 @@
 			"type": "checkbox",
 			"label": "Proxy Zigbee2MQTT logs to ioBroker logs",
 			"newLine": true
+		},
+		"useEventInDesc": {
+			"type": "checkbox",
+			"label": "The events such as 'Device removed' or 'Disabled' are displayed in the description instead of in the name.",
+			"newLine": true
 		}
 	}
 }

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "zigbee2mqtt",
-    "version": "2.7.0",
+    "version": "2.7.1",
     "news": {
+      "2.7.1": {
+        "en": "added option for use folder description\nuse the iobroker device folder description for device description or events",
+        "de": "zusatzoption für die ordnerbeschreibung\ndie beschreibung des iobroker geräteordners für gerätebeschreibung oder ereignisse",
+        "ru": "добавлена опция для использования описания папки\nиспользуйте описание папки iobroker для описания устройства или событий",
+        "pt": "opção adicionada para a descrição da pasta de uso\nuse a descrição da pasta do dispositivo iobroker para descrição do dispositivo ou eventos",
+        "nl": "voegde de optie toe voor gebruik van de beschrijving\ngebruik de beschrijving van het iobroker apparaat voor beschrijving of gebeurtenissen",
+        "fr": "option ajoutée pour la description du dossier d'utilisation\nutiliser la description du dossier de périphérique iobroker pour la description de périphérique ou les événements",
+        "it": "opzione aggiunta per l'uso descrizione della cartella\nutilizzare la descrizione della cartella del dispositivo iobroker per la descrizione o gli eventi del dispositivo",
+        "es": "opción adicional para la descripción de la carpeta de uso\nutilizar la descripción de la carpeta del dispositivo iobroker para la descripción del dispositivo o eventos",
+        "pl": "dodać opcję do opisu folder\nużywanie iobrokerowego opisu danych dla opisu urządzenia lub zdarzeń",
+        "uk": "доданий варіант для опису папок\nвикористовувати опис папки іоброкера для опису пристрою або подій",
+        "zh-cn": "增加使用时说明的选择\n对装置说明或事件使用零散器装置的描述"
+      },
       "2.7.0": {
         "en": "added support for  wildcard actions (eg. *_single) ([#116](https://github.com/o0shojo0o/ioBroker.zigbee2mqtt/issues/116))\nadded error handling optimizations ([more](https://github.com/ioBroker/ioBroker.repositories/pull/1976#issuecomment-1382038679))\nadded option `auth_token` for websocket connection ([#112](https://github.com/o0shojo0o/ioBroker.zigbee2mqtt/issues/112))\nwebsocket timeout increased",
         "de": "unterstützung für Wildcard-Aktionen (z.B. *_single) [#116](https://github.com/o0shojo0o/ioBroker.zigbee2mqt/issues/116)\nfehlerbehandlungsoptimierungen [mehr](https://github.com/ioBroker/ioBroker.repositories/pull/1976#issuecomment-1382038679)\nzusatzoption auth_token für Websocket-Verbindung [#112](https://github.com/o0shojo0o/ioBroker.zigbee2mqt/issues/112)\nwebsocket timeout erhöht",
@@ -80,19 +93,6 @@
         "pl": "ustanowić dostęp do przyjaznej nazwy. zawierać",
         "uk": "застосувати доступність при дружній_ім`я `/` в наявності",
         "zh-cn": "f 在友好的情况下,可提供“/”一词 内载"
-      },
-      "2.4.2": {
-        "en": "added correct handling of `move_to_saturation`, `hue_move` and `brightness_move_to_level` ([#68](https://github.com/o0shojo0o/ioBroker.zigbee2mqtt/issues/68))\nfix when `friendly_name` `/` contains",
-        "de": "die korrekte Handhabung von move_to_saturation, hue_move und bright_move_to_level [#68](https://github.com/o0shojo0o/ioBroker.zigbee2mqt/issues/68)\nbei freundlich_name `/` enthält",
-        "ru": "добавлена правильная обработка move_to_saturation, hue_move и brightness_move_to_level [#68](https://github.com/o0shojo0o/ioBroker.zigbee2mqtt/issues/68)\nисправить, когда friendly_name `/` содержит",
-        "pt": "adicionado manuseio correto de move_to_saturation, hue_move e brilho_move_to_level [#68](https://github.com/o0shojo0o/ioBroker.zigbee2mqtt/issues/68)\ncorrigir quando friendly_name `/` contém",
-        "nl": "voegde de juiste behandeling van verplaatsing, huemove and brightnessmovetolevel 68) (httub /0shojoo-0-Bio-Broctrotqusts)\nvertaling: _",
-        "fr": "ajouté correct handling of move_to_saturation, hue_move and brightness_move_to_level [#68](https://github.com/o0shojo0o/ioBroker.zigbee2mqt/issues/68)\nfixer lorsque friendly_name `/` contient",
-        "it": "aggiunto corretta gestione di move_to_saturation, hue_move e luminosità_move_to_level [#68](https://github.com/o0shojo0o/ioBroker.zigbee2mqt/issues/68)\nfissare quando amichevole_name `/` contiene",
-        "es": "añadido correcto manejo de move_to_saturation, hue_move and brightness_move_to_level [#68](https://github.com/o0shojo0o/ioBroker.zigbee2mqt/issues/68)\narreglar cuando friendly_name `/ contiene",
-        "pl": "(Prawdziwa obsługa ruchu_to_saturation, hue_move and brightness_move_to_level #68(https:/github.com/o0shojo0o/ioBroker.zigbee2mqtt/issues/68)\nustanowić się, gdy przyjaźnić nazwisko/'. zawierać",
-        "uk": "додано правильну обробку рухом_to_saturation, hue_move_move_to_level [#68](https://github.com/o0shojo0o/ioBroker.zigbee2mqtt/issues/68)\nфіксація при дружній_ім`я `/` в наявності",
-        "zh-cn": "进一步正确地处理搬迁问题:流向、障碍和光明_move_to_级[#68](http://github.com/o0shojo0o/ioBroker.zigbee2mqt/issues/68)\nfix 友好时的名称:“/” 内载"
       }
     },
     "titleLang": {
@@ -199,7 +199,8 @@
     "useKelvin": false,
     "colorTempSyncColor": false,
     "brightnessMoveOnOff": false,
-    "brightnessStepOnOff": false
+    "brightnessStepOnOff": false,
+    "useEventInDesc": true
   },
   "objects": [],
   "instanceObjects": [

package/lib/deviceController.js

@@ -207,22 +207,31 @@ class DeviceController {
 
     async createOrUpdateDevices() {
         for (const device of this.groupCache.concat(this.deviceCache)) {
-            let deviceName = device.id == device.ieee_address ? '' : device.id;
+            let deviceName = await this.getDeviceName(device);
+            let description = await this.getDeviceDescription(device);
 
             if (deviceName == '' && device.description) {
                 deviceName = device.description;
+                description = '';
             }
 
             // Manipulate deviceName if the device is disabled, so the update of the device is triggered as well
             if (device.disabled && device.disabled == true) {
-                deviceName = `[Disabled] ${deviceName}`;
+                if (this.config.useEventInDesc == true) {
+                    description = 'Device is disabled!';
+                }
+                else {
+                    deviceName = `[Disabled] ${deviceName}`;
+                }
+
             }
 
-            if (!this.createCache[device.ieee_address] || this.createCache[device.ieee_address].name != deviceName) {
+            if (!this.createCache[device.ieee_address] || this.createCache[device.ieee_address].name != deviceName || this.createCache[device.ieee_address].description != description) {
                 const deviceObj = {
                     type: 'device',
                     common: {
                         name: deviceName,
+                        desc: description
                     },
 
                     native: {}
@@ -242,7 +251,7 @@ class DeviceController {
 
                 //@ts-ignore
                 await this.adapter.extendObjectAsync(device.ieee_address, deviceObj);
-                this.createCache[device.ieee_address] = { name: deviceName };
+                this.createCache[device.ieee_address] = { name: deviceName, description: description };
             }
 
             // Here it is checked whether the scenes match the current data from z2m.
@@ -280,6 +289,8 @@ class DeviceController {
 
     processRemoveEvent(messageObj) {
         let ieee_address = undefined;
+        let description = '';
+        let deviceName = '';
         if (messageObj.payload && messageObj.payload.type == 'device_leave') {
             ieee_address = messageObj.payload.data.ieee_address;
         }
@@ -289,12 +300,26 @@ class DeviceController {
             const device = this.deviceCache.find(x => x.id == messageObj.payload.data.id);
             if (device) {
                 ieee_address = device.ieee_address;
+                deviceName = this.getDeviceName(device);
             }
         }
 
         if (ieee_address != undefined) {
             this.adapter.setState(`${ieee_address}.available`, false, true);
-            this.adapter.extendObject(`${ieee_address}`, { common: { name: 'Device removed!', } });
+            deviceName = this.createCache[ieee_address].name;
+
+            if (this.config.useEventInDesc == true) {
+                description = 'Device was removed!';
+            }
+            else {
+                deviceName = `[Removed] ${deviceName}`;
+            }
+            this.adapter.extendObject(`${ieee_address}`, {
+                common: {
+                    name: deviceName,
+                    desc: description
+                }
+            });
             delete this.createCache[ieee_address];
         }
     }
@@ -326,6 +351,14 @@ class DeviceController {
         }
         return iobState;
     }
+
+    getDeviceName(device) {
+        return device.id == device.ieee_address ? '' : device.id;
+    }
+
+    getDeviceDescription(device) {
+        return device.description ? device.description : '';
+    }
 }
 
 module.exports = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.zigbee2mqtt",
-  "version": "2.7.0",
+  "version": "2.7.1",
   "description": "Zigbee2MQTT adapter for ioBroker",
   "author": {
     "name": "Dennis Rathjen",
@@ -42,7 +42,7 @@
     "@types/sinon-chai": "^3.2.9",
     "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^8.31.0",
+    "eslint": "^8.32.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-prettier": "^4.2.1",
     "mocha": "^10.2.0",