@willieee802/zigbee-herdsman 0.34.3 → 0.48.1

package/dist/controller/controller.js

@@ -33,9 +33,8 @@ const model_1 = require("./model");
 const helpers_1 = require("./helpers");
 const Events = __importStar(require("./events"));
 const tstype_1 = require("./tstype");
-const debug_1 = __importDefault(require("debug"));
 const fs_1 = __importDefault(require("fs"));
-const zcl_1 = require("../zcl");
+const Zcl = __importStar(require("../zspec/zcl"));
 const touchlink_1 = __importDefault(require("./touchlink"));
 const greenPower_1 = __importDefault(require("./greenPower"));
 const utils_1 = require("../utils");
@@ -44,12 +43,14 @@ const assert_1 = __importDefault(require("assert"));
 // @ts-ignore
 const mixin_deep_1 = __importDefault(require("mixin-deep"));
 const group_1 = __importDefault(require("./model/group"));
+const logger_1 = require("../utils/logger");
+const NS = 'zh:controller';
 async function catcho(func, errorMessage) {
     try {
         await func();
     }
     catch (error) {
-        debug.error(`${errorMessage}: ${error}`);
+        logger_1.logger.error(`${errorMessage}: ${error}`, NS);
     }
 }
 const DefaultOptions = {
@@ -67,10 +68,6 @@ const DefaultOptions = {
     adapter: { disableLED: false },
     acceptJoiningDeviceHandler: null,
 };
-const debug = {
-    error: (0, debug_1.default)('zigbee-herdsman:controller:error'),
-    log: (0, debug_1.default)('zigbee-herdsman:controller:log'),
-};
 /**
  * @noInheritDoc
  */
@@ -90,18 +87,18 @@ class Controller extends events_1.default.EventEmitter {
     databaseSaveTimer;
     touchlink;
     stopping;
+    adapterDisconnected;
     networkParametersCached;
-    logger;
     /**
      * Create a controller
      *
      * To auto detect the port provide `null` for `options.serialPort.path`
      */
-    constructor(options, logger) {
+    constructor(options) {
         super();
         this.stopping = false;
+        this.adapterDisconnected = true; // set false after adapter.start() is successfully called
         this.options = (0, mixin_deep_1.default)(JSON.parse(JSON.stringify(DefaultOptions)), options);
-        this.logger = logger;
         // Validate options
         for (const channel of this.options.network.channelList) {
             if (channel < 11 || channel > 26) {
@@ -115,8 +112,7 @@ class Controller extends events_1.default.EventEmitter {
             throw new Error(`ExtendedPanID must be 8 digits long, got ${this.options.network.extendedPanID.length}.`);
         }
         if (this.options.network.panID >= 0xFFFF || this.options.network.panID <= 0) {
-            throw new Error(`PanID must have a value of 0x0001 (1) - 0xFFFE (65534), ` +
-                `got ${this.options.network.panID}.`);
+            throw new Error(`PanID must have a value of 0x0001 (1) - 0xFFFE (65534), got ${this.options.network.panID}.`);
         }
     }
     /**
@@ -127,19 +123,28 @@ class Controller extends events_1.default.EventEmitter {
         this.database = database_1.default.open(this.options.databasePath);
         model_1.Entity.injectDatabase(this.database);
         // Adapter (create and inject)
-        this.adapter = await adapter_1.Adapter.create(this.options.network, this.options.serialPort, this.options.backupPath, this.options.adapter, this.logger);
-        debug.log(`Starting with options '${JSON.stringify(this.options)}'`);
+        this.adapter = await adapter_1.Adapter.create(this.options.network, this.options.serialPort, this.options.backupPath, this.options.adapter);
+        logger_1.logger.debug(`Starting with options '${JSON.stringify(this.options)}'`, NS);
         const startResult = await this.adapter.start();
-        debug.log(`Started with result '${startResult}'`);
+        logger_1.logger.debug(`Started with result '${startResult}'`, NS);
+        this.adapterDisconnected = false;
+        // Check if we have to change the channel, only do this when adapter `resumed` because:
+        // - `getNetworkParameters` might be return wrong info because it needs to propogate after backup restore
+        // - If result is not `resumed` (`reset` or `restored`), the adapter should comission with the channel from `this.options.network`
+        if ((startResult === 'resumed') && (await this.adapter.supportsChangeChannel())) {
+            const netParams = (await this.getNetworkParameters());
+            if (this.options.network.channelList[0] !== netParams.channel) {
+                await this.changeChannel();
+            }
+        }
         model_1.Entity.injectAdapter(this.database.id, this.adapter);
         // log injection
-        debug.log(`Injected database: ${this.database != null}, adapter: ${this.adapter != null}`);
+        logger_1.logger.debug(`Injected database: ${this.database != null}, adapter: ${this.adapter != null}`, NS);
         this.greenPower = new greenPower_1.default(this.adapter);
         this.greenPower.on(tstype_1.GreenPowerEvents.deviceJoined, this.onDeviceJoinedGreenPower.bind(this));
         // Register adapter events
         this.adapter.on(adapter_1.Events.Events.deviceJoined, this.onDeviceJoined.bind(this));
-        this.adapter.on(adapter_1.Events.Events.zclData, (data) => this.onZclOrRawData('zcl', data));
-        this.adapter.on(adapter_1.Events.Events.rawData, (data) => this.onZclOrRawData('raw', data));
+        this.adapter.on(adapter_1.Events.Events.zclPayload, this.onZclPayload.bind(this));
         this.adapter.on(adapter_1.Events.Events.disconnected, this.onAdapterDisconnected.bind(this));
         this.adapter.on(adapter_1.Events.Events.deviceAnnounce, this.onDeviceAnnounce.bind(this));
         this.adapter.on(adapter_1.Events.Events.deviceLeave, this.onDeviceLeave.bind(this));
@@ -148,7 +153,7 @@ class Controller extends events_1.default.EventEmitter {
             if (this.options.databaseBackupPath && fs_1.default.existsSync(this.options.databasePath)) {
                 fs_1.default.copyFileSync(this.options.databasePath, this.options.databaseBackupPath);
             }
-            debug.log('Clearing database...');
+            logger_1.logger.debug('Clearing database...', NS);
             for (const group of group_1.default.allByDatabaseID(this.database.id)) {
                 group.removeFromDatabase();
             }
@@ -162,13 +167,13 @@ class Controller extends events_1.default.EventEmitter {
         // Add coordinator to the database if it is not there yet.
         const coordinator = await this.adapter.getCoordinator();
         if (model_1.Device.byType('Coordinator', this.database.id).length === 0) {
-            debug.log('No coordinator in database, querying...');
+            logger_1.logger.debug('No coordinator in database, querying...', NS);
             model_1.Device.create('Coordinator', coordinator.ieeeAddr, coordinator.networkAddress, coordinator.manufacturerID, undefined, undefined, undefined, true, coordinator.endpoints, this.database.id);
         }
         // Update coordinator ieeeAddr if changed, can happen due to e.g. reflashing
         const databaseCoordinator = model_1.Device.byType('Coordinator', this.database.id)[0];
         if (databaseCoordinator.ieeeAddr !== coordinator.ieeeAddr) {
-            debug.log(`Coordinator address changed, updating to '${coordinator.ieeeAddr}'`);
+            logger_1.logger.info(`Coordinator address changed, updating to '${coordinator.ieeeAddr}'`, NS);
             databaseCoordinator.changeIeeeAddress(coordinator.ieeeAddr);
         }
         // Set backup timer to 1 day.
@@ -243,7 +248,7 @@ class Controller extends events_1.default.EventEmitter {
             this.emit(Events.Events.permitJoinChanged, data);
         }
         else {
-            debug.log('Disable joining');
+            logger_1.logger.debug('Disable joining', NS);
             await this.greenPower.permitJoin(0, null);
             await this.adapter.permitJoin(0, null);
             const data = { permitted: false, reason, timeout: this.permitJoinTimeout };
@@ -259,21 +264,28 @@ class Controller extends events_1.default.EventEmitter {
     isStopping() {
         return this.stopping;
     }
+    isAdapterDisconnected() {
+        return this.adapterDisconnected;
+    }
     async stop() {
         this.stopping = true;
-        this.databaseSave();
         // Unregister adapter events
         this.adapter.removeAllListeners(adapter_1.Events.Events.deviceJoined);
-        this.adapter.removeAllListeners(adapter_1.Events.Events.zclData);
-        this.adapter.removeAllListeners(adapter_1.Events.Events.rawData);
+        this.adapter.removeAllListeners(adapter_1.Events.Events.zclPayload);
         this.adapter.removeAllListeners(adapter_1.Events.Events.disconnected);
         this.adapter.removeAllListeners(adapter_1.Events.Events.deviceAnnounce);
         this.adapter.removeAllListeners(adapter_1.Events.Events.deviceLeave);
-        await catcho(() => this.permitJoinInternal(false, 'manual'), "Failed to disable join on stop");
         clearInterval(this.backupTimer);
         clearInterval(this.databaseSaveTimer);
-        await this.backup();
-        await this.adapter.stop();
+        if (this.adapterDisconnected) {
+            this.databaseSave();
+        }
+        else {
+            await catcho(() => this.permitJoinInternal(false, 'manual'), "Failed to disable join on stop");
+            await this.backup(); // always calls databaseSave()
+            await this.adapter.stop();
+            this.adapterDisconnected = true;
+        }
     }
     databaseSave() {
         for (const device of model_1.Device.allByDatabaseID(this.database.id)) {
@@ -287,13 +299,13 @@ class Controller extends events_1.default.EventEmitter {
     async backup() {
         this.databaseSave();
         if (this.options.backupPath && await this.adapter.supportsBackup()) {
-            debug.log('Creating coordinator backup');
+            logger_1.logger.debug('Creating coordinator backup', NS);
             const backup = await this.adapter.backup(model_1.Device.all().map((d) => d.ieeeAddr));
             const unifiedBackup = await utils_1.BackupUtils.toUnifiedBackup(backup);
             const tmpBackupPath = this.options.backupPath + '.tmp';
             fs_1.default.writeFileSync(tmpBackupPath, JSON.stringify(unifiedBackup, null, 2));
             fs_1.default.renameSync(tmpBackupPath, this.options.backupPath);
-            debug.log(`Wrote coordinator backup to '${this.options.backupPath}'`);
+            logger_1.logger.info(`Wrote coordinator backup to '${this.options.backupPath}'`, NS);
         }
     }
     async coordinatorCheck() {
@@ -363,6 +375,14 @@ class Controller extends events_1.default.EventEmitter {
     createGroup(groupID) {
         return group_1.default.create(groupID, this.database.id);
     }
+    /**
+     * Broadcast a network-wide channel change.
+     */
+    async changeChannel() {
+        logger_1.logger.info(`Broadcasting change channel to '${this.options.network.channelList[0]}'.`, NS);
+        await this.adapter.changeChannel(this.options.network.channelList[0]);
+        this.networkParametersCached = null; // invalidate cache
+    }
     /**
      *  Set transmit power of the adapter
      */
@@ -370,15 +390,16 @@ class Controller extends events_1.default.EventEmitter {
         return this.adapter.setTransmitPower(value);
     }
     onNetworkAddress(payload) {
-        debug.log(`Network address '${payload.ieeeAddr}'`);
+        logger_1.logger.debug(`Network address '${payload.ieeeAddr}'`, NS);
         const device = model_1.Device.byIeeeAddr(this.database.id, payload.ieeeAddr);
         if (!device) {
-            debug.log(`Network address is from unknown device '${payload.ieeeAddr}'`);
+            logger_1.logger.debug(`Network address is from unknown device '${payload.ieeeAddr}'`, NS);
             return;
         }
+        device.updateLastSeen();
         this.selfAndDeviceEmit(device, Events.Events.lastSeenChanged, { device, reason: 'networkAddress' });
         if (device.networkAddress !== payload.networkAddress) {
-            debug.log(`Device '${payload.ieeeAddr}' got new networkAddress '${payload.networkAddress}'`);
+            logger_1.logger.debug(`Device '${payload.ieeeAddr}' got new networkAddress '${payload.networkAddress}'`, NS);
             device.networkAddress = payload.networkAddress;
             device.save();
             const data = { device };
@@ -386,17 +407,17 @@ class Controller extends events_1.default.EventEmitter {
         }
     }
     onDeviceAnnounce(payload) {
-        debug.log(`Device announce '${payload.ieeeAddr}'`);
+        logger_1.logger.debug(`Device announce '${payload.ieeeAddr}'`, NS);
         const device = model_1.Device.byIeeeAddr(this.database.id, payload.ieeeAddr);
         if (!device) {
-            debug.log(`Device announce is from unknown device '${payload.ieeeAddr}'`);
+            logger_1.logger.debug(`Device announce is from unknown device '${payload.ieeeAddr}'`, NS);
             return;
         }
         device.updateLastSeen();
         this.selfAndDeviceEmit(device, Events.Events.lastSeenChanged, { device, reason: 'deviceAnnounce' });
         device.implicitCheckin();
         if (device.networkAddress !== payload.networkAddress) {
-            debug.log(`Device '${payload.ieeeAddr}' announced with new networkAddress '${payload.networkAddress}'`);
+            logger_1.logger.debug(`Device '${payload.ieeeAddr}' announced with new networkAddress '${payload.networkAddress}'`, NS);
             device.networkAddress = payload.networkAddress;
             device.save();
         }
@@ -404,22 +425,25 @@ class Controller extends events_1.default.EventEmitter {
         this.selfAndDeviceEmit(device, Events.Events.deviceAnnounce, data);
     }
     onDeviceLeave(payload) {
-        debug.log(`Device leave '${payload.ieeeAddr}'`);
-        const device = model_1.Device.byIeeeAddr(this.database.id, payload.ieeeAddr);
-        if (device) {
-            debug.log(`Removing device from database '${payload.ieeeAddr}'`);
-            device.removeFromDatabase();
+        logger_1.logger.debug(`Device leave '${payload.ieeeAddr}'`, NS);
+        const device = payload.ieeeAddr ? model_1.Device.byIeeeAddr(this.database.id, payload.ieeeAddr) : model_1.Device.byNetworkAddress(this.database.id, payload.networkAddress);
+        if (!device) {
+            logger_1.logger.debug(`Device leave is from unknown or already deleted device '${payload.ieeeAddr ?? payload.networkAddress}'`, NS);
+            return;
         }
-        const data = { ieeeAddr: payload.ieeeAddr };
+        logger_1.logger.debug(`Removing device from database '${device.ieeeAddr}'`, NS);
+        device.removeFromDatabase();
+        const data = { ieeeAddr: device.ieeeAddr };
         this.selfAndDeviceEmit(device, Events.Events.deviceLeave, data);
     }
     async onAdapterDisconnected() {
-        debug.log(`Adapter disconnected'`);
+        logger_1.logger.debug(`Adapter disconnected`, NS);
+        this.adapterDisconnected = true;
         await catcho(() => this.adapter.stop(), 'Failed to stop adapter on disconnect');
         this.emit(Events.Events.adapterDisconnected);
     }
     async onDeviceJoinedGreenPower(payload) {
-        debug.log(`Green power device '${JSON.stringify(payload)}' joined`);
+        logger_1.logger.debug(`Green power device '${JSON.stringify(payload)}' joined`, NS);
         // Green power devices don't have an ieeeAddr, the sourceID is unique and static so use this.
         let ieeeAddr = payload.sourceID.toString(16);
         ieeeAddr = `0x${'0'.repeat(16 - ieeeAddr.length)}${ieeeAddr}`;
@@ -427,8 +451,8 @@ class Controller extends events_1.default.EventEmitter {
         const modelID = `GreenPower_${payload.deviceID}`;
         let device = model_1.Device.byIeeeAddr(this.database.id, ieeeAddr, true);
         if (!device) {
-            debug.log(`New green power device '${ieeeAddr}' joined`);
-            debug.log(`Creating device '${ieeeAddr}'`);
+            logger_1.logger.debug(`New green power device '${ieeeAddr}' joined`, NS);
+            logger_1.logger.debug(`Creating device '${ieeeAddr}'`, NS);
             device = model_1.Device.create('GreenPower', ieeeAddr, payload.networkAddress, null, undefined, undefined, modelID, true, [], this.database.id);
             device.save();
             this.selfAndDeviceEmit(device, Events.Events.deviceJoined, { device });
@@ -436,7 +460,7 @@ class Controller extends events_1.default.EventEmitter {
             this.selfAndDeviceEmit(device, Events.Events.deviceInterview, deviceInterviewPayload);
         }
         else if (device.isDeleted) {
-            debug.log(`Deleted green power device '${ieeeAddr}' joined`);
+            logger_1.logger.debug(`Deleted green power device '${ieeeAddr}' joined, undeleting`, NS);
             device.undelete(true);
             this.selfAndDeviceEmit(device, Events.Events.deviceJoined, { device });
             const deviceInterviewPayload = { status: 'successful', device };
@@ -448,32 +472,31 @@ class Controller extends events_1.default.EventEmitter {
         this.emit(event, data);
     }
     async onDeviceJoined(payload) {
-        debug.log(`Device '${payload.ieeeAddr}' joined`);
+        logger_1.logger.debug(`Device '${payload.ieeeAddr}' joined`, NS);
         if (this.options.acceptJoiningDeviceHandler) {
             if (!(await this.options.acceptJoiningDeviceHandler(payload.ieeeAddr))) {
-                debug.log(`Device '${payload.ieeeAddr}' rejected by handler, removing it`);
+                logger_1.logger.debug(`Device '${payload.ieeeAddr}' rejected by handler, removing it`, NS);
                 await catcho(() => this.adapter.removeDevice(payload.networkAddress, payload.ieeeAddr), 'Failed to remove rejected device');
                 return;
             }
             else {
-                debug.log(`Device '${payload.ieeeAddr}' accepted by handler`);
+                logger_1.logger.debug(`Device '${payload.ieeeAddr}' accepted by handler`, NS);
             }
         }
         let device = model_1.Device.byIeeeAddr(this.database.id, payload.ieeeAddr, true);
         if (!device) {
-            debug.log(`New device '${payload.ieeeAddr}' joined`);
-            debug.log(`Creating device '${payload.ieeeAddr}'`);
+            logger_1.logger.debug(`New device '${payload.ieeeAddr}' joined`, NS);
+            logger_1.logger.debug(`Creating device '${payload.ieeeAddr}'`, NS);
             device = model_1.Device.create('Unknown', payload.ieeeAddr, payload.networkAddress, undefined, undefined, undefined, undefined, false, [], this.database.id);
             this.selfAndDeviceEmit(device, Events.Events.deviceJoined, { device });
         }
         else if (device.isDeleted) {
-            debug.log(`Delete device '${payload.ieeeAddr}' joined, undeleting`);
+            logger_1.logger.debug(`Deleted device '${payload.ieeeAddr}' joined, undeleting`, NS);
             device.undelete();
             this.selfAndDeviceEmit(device, Events.Events.deviceJoined, { device });
         }
         if (device.networkAddress !== payload.networkAddress) {
-            debug.log(`Device '${payload.ieeeAddr}' is already in database with different networkAddress, ` +
-                `updating networkAddress`);
+            logger_1.logger.debug(`Device '${payload.ieeeAddr}' is already in database with different network address, updating network address`, NS);
             device.networkAddress = payload.networkAddress;
             device.save();
         }
@@ -482,124 +505,156 @@ class Controller extends events_1.default.EventEmitter {
         device.implicitCheckin();
         if (!device.interviewCompleted && !device.interviewing) {
             const payloadStart = { status: 'started', device };
-            debug.log(`Interview '${device.ieeeAddr}' start`);
+            logger_1.logger.info(`Interview for '${device.ieeeAddr}' started`, NS);
             this.selfAndDeviceEmit(device, Events.Events.deviceInterview, payloadStart);
             try {
                 await device.interview();
-                debug.log(`Succesfully interviewed '${device.ieeeAddr}'`);
+                logger_1.logger.info(`Succesfully interviewed '${device.ieeeAddr}'`, NS);
                 const event = { status: 'successful', device };
                 this.selfAndDeviceEmit(device, Events.Events.deviceInterview, event);
             }
             catch (error) {
-                debug.error(`Interview failed for '${device.ieeeAddr} with error '${error}'`);
+                logger_1.logger.error(`Interview failed for '${device.ieeeAddr} with error '${error}'`, NS);
                 const event = { status: 'failed', device };
                 this.selfAndDeviceEmit(device, Events.Events.deviceInterview, event);
             }
         }
         else {
-            debug.log(`Not interviewing '${payload.ieeeAddr}', completed '${device.interviewCompleted}', ` +
-                `in progress '${device.interviewing}'`);
+            logger_1.logger.debug(`Not interviewing '${payload.ieeeAddr}', completed '${device.interviewCompleted}', in progress '${device.interviewing}'`, NS);
         }
     }
-    isZclDataPayload(dataPayload, type) {
-        return type === 'zcl';
-    }
-    async onZclOrRawData(dataType, dataPayload) {
-        const logDataPayload = JSON.parse(JSON.stringify(dataPayload));
-        if (dataType === 'zcl') {
-            delete logDataPayload.frame.Cluster;
+    async onZclPayload(payload) {
+        let frame = undefined;
+        let device = undefined;
+        if (payload.clusterID === Zcl.Clusters.touchlink.ID) {
+            // This is handled by touchlink
+            return;
         }
-        debug.log(`Received '${dataType}' data '${JSON.stringify(logDataPayload)}'`);
-        let gpDevice = null;
-        if (this.isZclDataPayload(dataPayload, dataType)) {
-            if (dataPayload.frame.Cluster.name === 'touchlink') {
-                // This is handled by touchlink
-                return;
+        else if (payload.clusterID === Zcl.Clusters.greenPower.ID) {
+            try {
+                // Custom clusters are not supported for Green Power since we need to parse the frame to get the device.
+                frame = Zcl.Frame.fromBuffer(payload.clusterID, payload.header, payload.data, {});
             }
-            else if (dataPayload.frame.Cluster.name === 'greenPower') {
-                await this.greenPower.onZclGreenPowerData(dataPayload);
-                // lookup encapsulated gpDevice for further processing
-                gpDevice = model_1.Device.byNetworkAddress(dataPayload.frame.Payload.srcID & 0xFFFF, this.database.id);
+            catch (error) {
+                logger_1.logger.debug(`Failed to parse frame green power frame, ignoring it: ${error}`, NS);
+                return;
+                // <<<<<<< HEAD
+                //             } else if (dataPayload.frame.Cluster.name === 'greenPower') {
+                //                 await this.greenPower.onZclGreenPowerData(dataPayload);
+                //                 // lookup encapsulated gpDevice for further processing
+                //                 gpDevice = Device.byNetworkAddress(dataPayload.frame.Payload.srcID & 0xFFFF, this.database.id);
+                //             }
+                //         }
+                //         let device = gpDevice ? gpDevice : (typeof dataPayload.address === 'string'
+                //             ? Device.byIeeeAddr(this.database.id, dataPayload.address)
+                //             : Device.byNetworkAddress(dataPayload.address, this.database.id));
+                //         /**
+                //          * Handling of re-transmitted Xiaomi messages.
+                //          * https://github.com/Koenkk/zigbee2mqtt/issues/1238
+                //          * https://github.com/Koenkk/zigbee2mqtt/issues/3592
+                //          *
+                //          * Some Xiaomi router devices re-transmit messages from Xiaomi end devices.
+                //          * The network address of these message is set to the one of the Xiaomi router.
+                //          * Therefore it looks like if the message came from the Xiaomi router, while in
+                //          * fact it came from the end device.
+                //          * Handling these message would result in false state updates.
+                //          * The group ID attribute of these message defines the network address of the end device.
+                //          */
+                //         if (device?.manufacturerName === 'LUMI' && device?.type == 'Router' && dataPayload.groupID) {
+                //             debug.log(`Handling re-transmitted Xiaomi message ${device.networkAddress} -> ${dataPayload.groupID}`);
+                //             device = Device.byNetworkAddress(dataPayload.groupID, this.database.id);
+                //         }
+                // =======
             }
+            await this.greenPower.onZclGreenPowerData(payload, frame);
+            // lookup encapsulated gpDevice for further processing
+            device = model_1.Device.byNetworkAddress(frame.payload.srcID & 0xffff, this.database.id);
         }
-        let device = gpDevice ? gpDevice : (typeof dataPayload.address === 'string'
-            ? model_1.Device.byIeeeAddr(this.database.id, dataPayload.address)
-            : model_1.Device.byNetworkAddress(dataPayload.address, this.database.id));
-        /**
-         * Handling of re-transmitted Xiaomi messages.
-         * https://github.com/Koenkk/zigbee2mqtt/issues/1238
-         * https://github.com/Koenkk/zigbee2mqtt/issues/3592
-         *
-         * Some Xiaomi router devices re-transmit messages from Xiaomi end devices.
-         * The network address of these message is set to the one of the Xiaomi router.
-         * Therefore it looks like if the message came from the Xiaomi router, while in
-         * fact it came from the end device.
-         * Handling these message would result in false state updates.
-         * The group ID attribute of these message defines the network address of the end device.
-         */
-        if (device?.manufacturerName === 'LUMI' && device?.type == 'Router' && dataPayload.groupID) {
-            debug.log(`Handling re-transmitted Xiaomi message ${device.networkAddress} -> ${dataPayload.groupID}`);
-            device = model_1.Device.byNetworkAddress(dataPayload.groupID, this.database.id);
+        else {
+            /**
+             * Handling of re-transmitted Xiaomi messages.
+             * https://github.com/Koenkk/zigbee2mqtt/issues/1238
+             * https://github.com/Koenkk/zigbee2mqtt/issues/3592
+             *
+             * Some Xiaomi router devices re-transmit messages from Xiaomi end devices.
+             * The network address of these message is set to the one of the Xiaomi router.
+             * Therefore it looks like if the message came from the Xiaomi router, while in
+             * fact it came from the end device.
+             * Handling these message would result in false state updates.
+             * The group ID attribute of these message defines the network address of the end device.
+             */
+            device = model_1.Device.find(this.database.id, payload.address);
+            if (device?.manufacturerName === 'LUMI' && device?.type == 'Router' && payload.groupID) {
+                logger_1.logger.debug(`Handling re-transmitted Xiaomi message ${device.networkAddress} -> ${payload.groupID}`, NS);
+                device = model_1.Device.byNetworkAddress(this.database.id, payload.groupID);
+            }
+            try {
+                frame = Zcl.Frame.fromBuffer(payload.clusterID, payload.header, payload.data, device?.customClusters);
+            }
+            catch (error) {
+                logger_1.logger.debug(`Failed to parse frame: ${error}`, NS);
+            }
         }
         if (!device) {
-            debug.log(`'${dataType}' data is from unknown device with address '${dataPayload.address}', ` +
-                `skipping...`);
+            logger_1.logger.debug(`Data is from unknown device with address '${payload.address}', skipping...`, NS);
             return;
         }
+        logger_1.logger.debug(`Received payload: clusterID=${payload.clusterID}, address=${payload.address}, groupID=${payload.groupID}, `
+            + `endpoint=${payload.endpoint}, destinationEndpoint=${payload.destinationEndpoint}, wasBroadcast=${payload.wasBroadcast}, `
+            + `linkQuality=${payload.linkquality}, frame=${frame?.toString()}`, NS);
         device.updateLastSeen();
         //no implicit checkin for genPollCtrl data because it might interfere with the explicit checkin
-        if (!this.isZclDataPayload(dataPayload, dataType) || !dataPayload.frame.isCluster("genPollCtrl")) {
+        if (!frame?.isCluster("genPollCtrl")) {
             device.implicitCheckin();
         }
-        device.linkquality = dataPayload.linkquality;
-        let endpoint = device.getEndpoint(dataPayload.endpoint);
+        device.linkquality = payload.linkquality;
+        let endpoint = device.getEndpoint(payload.endpoint);
         if (!endpoint) {
-            debug.log(`'${dataType}' data is from unknown endpoint '${dataPayload.endpoint}' from device with ` +
-                `network address '${dataPayload.address}', creating it...`);
-            endpoint = device.createEndpoint(dataPayload.endpoint);
+            logger_1.logger.debug(`Data is from unknown endpoint '${payload.endpoint}' from device with ` +
+                `network address '${payload.address}', creating it...`, NS);
+            endpoint = device.createEndpoint(payload.endpoint);
         }
         // Parse command for event
         let type = undefined;
         let data;
         let clusterName = undefined;
         const meta = {};
-        if (this.isZclDataPayload(dataPayload, dataType)) {
-            const frame = dataPayload.frame;
-            const command = frame.getCommand();
-            clusterName = frame.Cluster.name;
-            meta.zclTransactionSequenceNumber = frame.Header.transactionSequenceNumber;
-            meta.manufacturerCode = frame.Header.manufacturerCode;
-            meta.frameControl = frame.Header.frameControl;
-            if (frame.isGlobal()) {
+        if (frame) {
+            const command = frame.command;
+            clusterName = frame.cluster.name;
+            meta.zclTransactionSequenceNumber = frame.header.transactionSequenceNumber;
+            meta.manufacturerCode = frame.header.manufacturerCode;
+            meta.frameControl = frame.header.frameControl;
+            if (frame.header.isGlobal) {
                 if (frame.isCommand('report')) {
                     type = 'attributeReport';
-                    data = helpers_1.ZclFrameConverter.attributeKeyValue(dataPayload.frame, device.manufacturerID);
+                    data = helpers_1.ZclFrameConverter.attributeKeyValue(frame, device.manufacturerID, device.customClusters);
                 }
                 else if (frame.isCommand('read')) {
                     type = 'read';
-                    data = helpers_1.ZclFrameConverter.attributeList(dataPayload.frame, device.manufacturerID);
+                    data = helpers_1.ZclFrameConverter.attributeList(frame, device.manufacturerID, device.customClusters);
                 }
                 else if (frame.isCommand('write')) {
                     type = 'write';
-                    data = helpers_1.ZclFrameConverter.attributeKeyValue(dataPayload.frame, device.manufacturerID);
+                    data = helpers_1.ZclFrameConverter.attributeKeyValue(frame, device.manufacturerID, device.customClusters);
                 }
                 else {
                     /* istanbul ignore else */
                     if (frame.isCommand('readRsp')) {
                         type = 'readResponse';
-                        data = helpers_1.ZclFrameConverter.attributeKeyValue(dataPayload.frame, device.manufacturerID);
+                        data = helpers_1.ZclFrameConverter.attributeKeyValue(frame, device.manufacturerID, device.customClusters);
                     }
                 }
             }
             else {
                 /* istanbul ignore else */
-                if (frame.isSpecific()) {
+                if (frame.header.isSpecific) {
                     if (Events.CommandsLookup[command.name]) {
                         type = Events.CommandsLookup[command.name];
-                        data = dataPayload.frame.Payload;
+                        data = frame.payload;
                     }
                     else {
-                        debug.log(`Skipping command '${command.name}' because it is missing from the lookup`);
+                        logger_1.logger.debug(`Skipping command '${command.name}' because it is missing from the lookup`, NS);
                     }
                 }
             }
@@ -611,19 +666,19 @@ class Controller extends events_1.default.EventEmitter {
                         property.set(value, device);
                     }
                 }
-                endpoint.saveClusterAttributeKeyValue(frame.Cluster.ID, data);
+                endpoint.saveClusterAttributeKeyValue(frame.cluster.ID, data);
             }
         }
         else {
             type = 'raw';
-            data = dataPayload.data;
-            const name = zcl_1.Utils.getCluster(dataPayload.clusterID).name;
+            data = payload.data;
+            const name = Zcl.Utils.getCluster(payload.clusterID, device.manufacturerID, device.customClusters).name;
             clusterName = Number.isNaN(Number(name)) ? name : Number(name);
         }
         if (type && data) {
-            const endpoint = device.getEndpoint(dataPayload.endpoint);
-            const linkquality = dataPayload.linkquality;
-            const groupID = dataPayload.groupID;
+            const endpoint = device.getEndpoint(payload.endpoint);
+            const linkquality = payload.linkquality;
+            const groupID = payload.groupID;
             const eventData = {
                 type: type, device, endpoint, data, linkquality, groupID, cluster: clusterName, meta
             };
@@ -633,8 +688,8 @@ class Controller extends events_1.default.EventEmitter {
         else {
             this.selfAndDeviceEmit(device, Events.Events.lastSeenChanged, { device, reason: 'messageNonEmitted' });
         }
-        if (this.isZclDataPayload(dataPayload, dataType)) {
-            await device.onZclData(dataPayload, endpoint);
+        if (frame) {
+            await device.onZclData(payload, frame, endpoint);
         }
     }
 }