iobroker.zigbee2mqtt 2.7.1 → 2.7.2

package/README.md

@@ -32,6 +32,10 @@ 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.2 (2023-02-01)
+
+-   (o0shojo0o) rework of the detection of removed devices
+
 ### 2.7.1 (2023-01-24)
 
 -   (o0shojo0o) added option for use folder description

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "zigbee2mqtt",
-    "version": "2.7.1",
+    "version": "2.7.2",
     "news": {
+      "2.7.2": {
+        "en": "rework of the detection of removed devices",
+        "de": "nacharbeiten der erkennung von entfernten geräten",
+        "ru": "переработка обнаружения удаленных устройств",
+        "pt": "retrabalho da detecção de dispositivos removidos",
+        "nl": "_",
+        "fr": "retravail de la détection des dispositifs enlevés",
+        "it": "rielaborazione del rilevamento dei dispositivi rimossi",
+        "es": "rework of the detection of removed devices",
+        "pl": "przepraszanie detekcji usuniętych urządzeń",
+        "uk": "реконструкція виявлення видалених пристроїв",
+        "zh-cn": "清除装置的探查工作"
+      },
       "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",
@@ -80,19 +93,6 @@
         "pl": "zobacz też: #79 (https:/github.com/o0shojo0o/ioBroker.zigbee2mqtt/issues/79)",
         "uk": "[79] (https://github.com/o0shojo0o/ioBroker.zigbee2mqtt/issues/79)",
         "zh-cn": "更好的国家辨认(http://github.com/oshojo0o/ioBroker.zigbee2mqt/issues/79)"
-      },
-      "2.4.3": {
-        "en": "fix availability when `friendly_name` `/` contains",
-        "de": "verfügbarkeit korrigieren bei friendly_name `/` enthält",
-        "ru": "исправить доступность когда friendly_name `/` содержит",
-        "pt": "corrigir disponibilidade quando friendly_name `/` contém",
-        "nl": "_ _",
-        "fr": "fixer la disponibilité lorsque friendly_name `/` contient",
-        "it": "fissare la disponibilità quando amichevole_name `/` contiene",
-        "es": "fijar disponibilidad cuando friendly_name `/` contiene",
-        "pl": "ustanowić dostęp do przyjaznej nazwy. zawierać",
-        "uk": "застосувати доступність при дружній_ім`я `/` в наявності",
-        "zh-cn": "f 在友好的情况下,可提供“/”一词 内载"
       }
     },
     "titleLang": {
@@ -143,6 +143,7 @@
     "mode": "daemon",
     "type": "hardware",
     "compact": true,
+    "stopTimeout": 2000,
     "connectionType": "local",
     "dataSource": "push",
     "adminUI": {

package/lib/deviceController.js

@@ -198,10 +198,13 @@ class DeviceController {
         this.groupCache.push(newDevice);
     }
 
-    async createGroupDefinitions(exposes) {
+    async createGroupDefinitions(groupsMessage) {
         utils.clearArray(this.groupCache);
-        for (const expose of exposes) {
-            await this.defineGroupDevice(expose.friendly_name, `group_${expose.id}`, expose.scenes);
+        for (const groupMessage of groupsMessage) {
+            if (this.logCustomizations.debugDevices.includes(groupMessage.id)) {
+                this.adapter.log.warn(`--->>> fromZ2M -> ${groupMessage.id} exposes: ${JSON.stringify(groupMessage)}`);
+            }
+            await this.defineGroupDevice(groupMessage.friendly_name, `group_${groupMessage.id}`, groupMessage.scenes);
         }
     }
 
@@ -231,22 +234,26 @@ class DeviceController {
                     type: 'device',
                     common: {
                         name: deviceName,
-                        desc: description
+                        desc: description,
+                        statusStates: { onlineId: '' }
                     },
-
-                    native: {}
+                    native: {
+                        deviceRemoved: false,
+                        groupDevice: false
+                    }
                 };
 
-                // Only the onlineId is set if the device is not disabled and is not a group
-                if (!device.ieee_address.includes('group_') && (!device.disabled || device.disabled == false)) {
-                    deviceObj.common.statusStates = {
-                        onlineId: `${this.adapter.name}.${this.adapter.instance}.${device.ieee_address}.available`
-                    };
+                // Group Device
+                if (device.ieee_address.includes('group_')) {
+                    deviceObj.native.groupDevice = true;
+                }
+                // Disabled Device
+                else if (device.disabled || device.disabled == true) {
+                    // Placeholder for possible later logic
                 }
+                // Only the onlineId is set if the device is not disabled and is not a group
                 else {
-                    deviceObj.common.statusStates = {
-                        onlineId: ''
-                    };
+                    deviceObj.common.statusStates.onlineId = `${this.adapter.name}.${this.adapter.instance}.${device.ieee_address}.available`;
                 }
 
                 //@ts-ignore
@@ -287,40 +294,41 @@ class DeviceController {
         }
     }
 
-    processRemoveEvent(messageObj) {
-        let ieee_address = undefined;
+    async checkAndProgressDeviceRemove() {
         let description = '';
         let deviceName = '';
-        if (messageObj.payload && messageObj.payload.type == 'device_leave') {
-            ieee_address = messageObj.payload.data.ieee_address;
-        }
+        let iobDevices = await this.adapter.getDevicesAsync();
+        // Do not consider devices already marked as "deviceRemoved"
+        iobDevices = iobDevices.filter(x => x.native.deviceRemoved == false);
+        // Do not consider groups
+        iobDevices = iobDevices.filter(x => x.native.groupDevice == false);
 
-        //{"data":{"block":false,"force":true,"id":"0xa4c138c954baaf54"},"status":"ok","transaction":"zhvjf-5"}
-        if (messageObj.payload && messageObj.payload.data) {
-            const device = this.deviceCache.find(x => x.id == messageObj.payload.data.id);
-            if (device) {
-                ieee_address = device.ieee_address;
-                deviceName = this.getDeviceName(device);
-            }
-        }
+        for (const iobDevice of iobDevices) {
+            const ieee_address = iobDevice._id.split('.')[2];
+            //Check whether the devices found from the object tree are also available in the DeviceCache
+            if (!this.deviceCache.find(x => x.ieee_address == ieee_address)) {
+                deviceName = iobDevice.common.name;
 
-        if (ieee_address != undefined) {
-            this.adapter.setState(`${ieee_address}.available`, false, true);
-            deviceName = this.createCache[ieee_address].name;
+                if (this.config.useEventInDesc == true) {
+                    description = 'Device was removed!';
+                }
+                else {
+                    deviceName = `[Removed] ${deviceName}`;
+                }
 
-            if (this.config.useEventInDesc == true) {
-                description = 'Device was removed!';
-            }
-            else {
-                deviceName = `[Removed] ${deviceName}`;
+                this.adapter.extendObject(`${ieee_address}`, {
+                    common: {
+                        name: deviceName,
+                        desc: description
+                    },
+                    native: {
+                        deviceRemoved: true
+                    }
+                });
+                this.adapter.setStateChangedAsync(`${ieee_address}.available`, false, true);
+
+                delete this.createCache[ieee_address];
             }
-            this.adapter.extendObject(`${ieee_address}`, {
-                common: {
-                    name: deviceName,
-                    desc: description
-                }
-            });
-            delete this.createCache[ieee_address];
         }
     }
 

package/lib/statesController.js

@@ -133,12 +133,17 @@ class StatesController {
     }
 
     async setAllAvailableToFalse() {
-        for (const device of this.deviceCache) {
-            for (const state of device.states) {
-                if (state.id == 'available') {
-                    await this.adapter.setStateChangedAsync(`${device.ieee_address}.${state.id}`, false, true);
-                }
-            }
+        // for (const device of this.deviceCache) {
+        //     for (const state of device.states) {
+        //         if (state.id == 'available') {
+        //             await this.adapter.setStateChangedAsync(`${device.ieee_address}.${state.id}`, false, true);
+        //         }
+        //     }
+        // }
+
+        const availableStates = await this.adapter.getStatesAsync('*.available');
+        for (const availableState in availableStates) {
+            await this.adapter.setStateChangedAsync(availableState, false, true);
         }
     }
 

package/main.js

@@ -153,6 +153,7 @@ class Zigbee2mqtt extends core.Adapter {
             case 'bridge/devices':
                 await deviceController.createDeviceDefinitions(messageObj.payload);
                 await deviceController.createOrUpdateDevices();
+                await deviceController.checkAndProgressDeviceRemove();
                 await statesController.subscribeWritableStates();
                 statesController.processQueue();
                 break;
@@ -163,13 +164,13 @@ class Zigbee2mqtt extends core.Adapter {
                 statesController.processQueue();
                 break;
             case 'bridge/event':
-                deviceController.processRemoveEvent(messageObj);
                 break;
             case 'bridge/response/device/remove':
-                deviceController.processRemoveEvent(messageObj);
                 break;
             case 'bridge/response/device/options':
                 break;
+            case 'bridge/response/permit_join':
+                break;
             case 'bridge/extensions':
                 break;
             case 'bridge/logging':
@@ -177,6 +178,8 @@ class Zigbee2mqtt extends core.Adapter {
                     z2mController.proxyZ2MLogs(messageObj);
                 }
                 break;
+            case 'bridge/response/device/configure':
+                break;
             case 'bridge/response/device/rename':
                 await deviceController.renameDeviceInCache(messageObj);
                 await deviceController.createOrUpdateDevices();
@@ -210,7 +213,6 @@ class Zigbee2mqtt extends core.Adapter {
                         }
                         // States
                     } else {
-                        //console.log(JSON.stringify(messageObj));
                         statesController.processDeviceMessage(messageObj);
                     }
                 }
@@ -219,33 +221,45 @@ class Zigbee2mqtt extends core.Adapter {
     }
 
     async onUnload(callback) {
-        try {
+        // Close MQTT connections
+        if (['exmqtt', 'intmqtt'].includes(this.config.connectionType)) {
             if (mqttClient && !mqttClient.closed) {
-                mqttClient.close();
+                try {
+                    mqttClient.close();
+                } catch (e) {
+                    this.log.error(e);
+                }
             }
-            websocketController.closeConnection();
-        } catch (e) {
-            this.log.error(e);
         }
-
-        try {
-            mqttServerController.closeServer();
-        } catch (e) {
-            this.log.error(e);
+        // Internal or Dummy MQTT-Server
+        if (this.config.connectionType == 'intmqtt' || this.config.dummyMqtt == true) {
+            try {
+                mqttServerController.closeServer();
+            } catch (e) {
+                this.log.error(e);
+            }
         }
-
+        // Websocket
+        else if (this.config.connectionType == 'ws') {
+            try {
+                websocketController.closeConnection();
+            } catch (e) {
+                this.log.error(e);
+            }
+        }
+        // Set all device available states of false
         try {
             await statesController.setAllAvailableToFalse();
         } catch (e) {
             this.log.error(e);
         }
-
+        // Clear all websocket timers
         try {
             await websocketController.allTimerClear();
         } catch (e) {
             this.log.error(e);
         }
-
+        // Clear all state timers
         try {
             await statesController.allTimerClear();
         } catch (e) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.zigbee2mqtt",
-  "version": "2.7.1",
+  "version": "2.7.2",
   "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.32.0",
+    "eslint": "^8.33.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-prettier": "^4.2.1",
     "mocha": "^10.2.0",