@willieee802/zigbee-herdsman 0.34.3 → 0.48.1

package/dist/controller/model/device.js

@@ -30,18 +30,16 @@ const zclTransactionSequenceNumber_1 = __importDefault(require("../helpers/zclTr
 const endpoint_1 = __importDefault(require("./endpoint"));
 const entity_1 = __importDefault(require("./entity"));
 const utils_1 = require("../../utils");
-const debug_1 = __importDefault(require("debug"));
-const Zcl = __importStar(require("../../zcl"));
+const Zcl = __importStar(require("../../zspec/zcl"));
 const assert_1 = __importDefault(require("assert"));
 const helpers_1 = require("../helpers");
+const logger_1 = require("../../utils/logger");
+const enums_1 = require("../../zspec/enums");
 /**
  * @ignore
  */
 const OneJanuary2000 = new Date('January 01, 2000 00:00:00 UTC+00:00').getTime();
-const debug = {
-    error: (0, debug_1.default)('zigbee-herdsman:controller:device:error'),
-    log: (0, debug_1.default)('zigbee-herdsman:controller:device:log'),
-};
+const NS = 'zh:controller:device';
 class Device extends entity_1.default {
     databaseID;
     ID;
@@ -64,11 +62,12 @@ class Device extends entity_1.default {
     _zclVersion;
     _linkquality;
     _skipDefaultResponse;
-    _skipTimeResponse;
+    _customReadResponse;
     _deleted;
     _lastDefaultResponseSequenceNumber;
     _checkinInterval;
     _pendingRequestTimeout;
+    _customClusters = {};
     // Getters/setters
     get ieeeAddr() { return this._ieeeAddr; }
     set ieeeAddr(ieeeAddr) { this._ieeeAddr = ieeeAddr; }
@@ -99,7 +98,7 @@ class Device extends entity_1.default {
     }
     get powerSource() { return this._powerSource; }
     set powerSource(powerSource) {
-        this._powerSource = typeof powerSource === 'number' ? Zcl.PowerSource[powerSource & ~(1 << 7)] : powerSource;
+        this._powerSource = typeof powerSource === 'number' ? Zcl.POWER_SOURCES[powerSource & ~(1 << 7)] : powerSource;
     }
     get softwareBuildID() { return this._softwareBuildID; }
     set softwareBuildID(softwareBuildID) { this._softwareBuildID = softwareBuildID; }
@@ -111,8 +110,8 @@ class Device extends entity_1.default {
     set linkquality(linkquality) { this._linkquality = linkquality; }
     get skipDefaultResponse() { return this._skipDefaultResponse; }
     set skipDefaultResponse(skipDefaultResponse) { this._skipDefaultResponse = skipDefaultResponse; }
-    get skipTimeResponse() { return this._skipTimeResponse; }
-    set skipTimeResponse(skipTimeResponse) { this._skipTimeResponse = skipTimeResponse; }
+    get customReadResponse() { return this._customReadResponse; }
+    set customReadResponse(customReadResponse) { this._customReadResponse = customReadResponse; }
     get checkinInterval() { return this._checkinInterval; }
     set checkinInterval(checkinInterval) {
         this._checkinInterval = checkinInterval;
@@ -120,6 +119,7 @@ class Device extends entity_1.default {
     }
     get pendingRequestTimeout() { return this._pendingRequestTimeout; }
     set pendingRequestTimeout(pendingRequestTimeout) { this._pendingRequestTimeout = pendingRequestTimeout; }
+    get customClusters() { return this._customClusters; }
     meta;
     // This lookup contains all devices that are queried from the database, this is to ensure that always
     // the same instance is returned.
@@ -156,7 +156,6 @@ class Device extends entity_1.default {
         this._interviewCompleted = interviewCompleted;
         this._interviewing = false;
         this._skipDefaultResponse = false;
-        this._skipTimeResponse = false;
         this.meta = meta;
         this._lastSeen = lastSeen;
         this._checkinInterval = checkinInterval;
@@ -183,7 +182,7 @@ class Device extends entity_1.default {
     }
     // There might be multiple endpoints with same DeviceId but it is not supported and first endpoint is returned
     getEndpointByDeviceType(deviceType) {
-        const deviceID = Zcl.EndpointDeviceType[deviceType];
+        const deviceID = Zcl.ENDPOINT_DEVICE_TYPE[deviceType];
         return this.endpoints.find((d) => d.deviceID === deviceID);
     }
     implicitCheckin() {
@@ -200,110 +199,113 @@ class Device extends entity_1.default {
     hasPendingRequests() {
         return this.endpoints.find(e => e.hasPendingRequests()) !== undefined;
     }
-    async onZclData(dataPayload, endpoint) {
-        const frame = dataPayload.frame;
+    async onZclData(dataPayload, frame, endpoint) {
         // Update reportable properties
         if (frame.isCluster('genBasic') && (frame.isCommand('readRsp') || frame.isCommand('report'))) {
-            for (const [key, val] of Object.entries(helpers_1.ZclFrameConverter.attributeKeyValue(frame, this.manufacturerID))) {
+            for (const [key, val] of Object.entries(helpers_1.ZclFrameConverter.attributeKeyValue(frame, this.manufacturerID, this.customClusters))) {
                 Device.ReportablePropertiesMapping[key]?.set(val, this);
             }
         }
         // Respond to enroll requests
-        if (frame.isSpecific() && frame.isCluster('ssIasZone') && frame.isCommand('enrollReq')) {
-            debug.log(`IAS - '${this.ieeeAddr}' responding to enroll response`);
+        if (frame.header.isSpecific && frame.isCluster('ssIasZone') && frame.isCommand('enrollReq')) {
+            logger_1.logger.debug(`IAS - '${this.ieeeAddr}' responding to enroll response`, NS);
             const payload = { enrollrspcode: 0, zoneid: 23 };
             await endpoint.command('ssIasZone', 'enrollRsp', payload, { disableDefaultResponse: true });
         }
         // Reponse to read requests
-        if (frame.isGlobal() && frame.isCommand('read')) {
+        if (frame.header.isGlobal && frame.isCommand('read') && !(this._customReadResponse?.(frame, endpoint))) {
             const time = Math.round(((new Date()).getTime() - OneJanuary2000) / 1000);
             const attributes = {
                 ...endpoint.clusters,
-                genTime: { attributes: {
+                genTime: {
+                    attributes: {
                         timeStatus: 3, // Time-master + synchronised
                         time: time,
                         timeZone: ((new Date()).getTimezoneOffset() * -1) * 60,
                         localTime: time - (new Date()).getTimezoneOffset() * 60,
                         lastSetTime: time,
                         validUntilTime: time + (24 * 60 * 60), // valid for 24 hours
-                    } },
+                    },
+                },
             };
-            if (frame.Cluster.name in attributes && (frame.Cluster.name !== 'genTime' || !this._skipTimeResponse)) {
+            if (frame.cluster.name in attributes) {
                 const response = {};
-                for (const entry of frame.Payload) {
-                    if (frame.Cluster.hasAttribute(entry.attrId)) {
-                        const name = frame.Cluster.getAttribute(entry.attrId).name;
-                        if (name in attributes[frame.Cluster.name].attributes) {
-                            response[name] = attributes[frame.Cluster.name].attributes[name];
+                for (const entry of frame.payload) {
+                    if (frame.cluster.hasAttribute(entry.attrId)) {
+                        const name = frame.cluster.getAttribute(entry.attrId).name;
+                        if (name in attributes[frame.cluster.name].attributes) {
+                            response[name] = attributes[frame.cluster.name].attributes[name];
                         }
                     }
                 }
                 try {
-                    await endpoint.readResponse(frame.Cluster.ID, frame.Header.transactionSequenceNumber, response, { srcEndpoint: dataPayload.destinationEndpoint });
+                    await endpoint.readResponse(frame.cluster.ID, frame.header.transactionSequenceNumber, response, { srcEndpoint: dataPayload.destinationEndpoint });
                 }
                 catch (error) {
-                    debug.error(`Read response to ${this.ieeeAddr} failed`);
+                    logger_1.logger.error(`Read response to ${this.ieeeAddr} failed`, NS);
                 }
             }
         }
         // Handle check-in from sleeping end devices
-        if (frame.isSpecific() && frame.isCluster("genPollCtrl") && frame.isCommand("checkin")) {
+        if (frame.header.isSpecific && frame.isCluster("genPollCtrl") && frame.isCommand("checkin")) {
             try {
                 if (this.hasPendingRequests() || (this._checkinInterval === undefined)) {
                     const payload = {
                         startFastPolling: true,
                         fastPollTimeout: 0,
                     };
-                    debug.log(`check-in from ${this.ieeeAddr}: accepting fast-poll`);
-                    await endpoint.command(frame.Cluster.ID, 'checkinRsp', payload, { sendPolicy: 'immediate' });
+                    logger_1.logger.debug(`check-in from ${this.ieeeAddr}: accepting fast-poll`, NS);
+                    await endpoint.command(frame.cluster.ID, 'checkinRsp', payload, { sendPolicy: 'immediate' });
                     // This is a good time to read the checkin interval if we haven't stored it previously
                     if (this._checkinInterval === undefined) {
                         const pollPeriod = await endpoint.read('genPollCtrl', ['checkinInterval'], { sendPolicy: 'immediate' });
                         this._checkinInterval = pollPeriod.checkinInterval / 4; // convert to seconds
                         this.resetPendingRequestTimeout();
-                        debug.log(`Request Queue (${this.ieeeAddr}): default expiration timeout set to ${this.pendingRequestTimeout}`);
+                        logger_1.logger.debug(`Request Queue (${this.ieeeAddr}): default expiration timeout set to ${this.pendingRequestTimeout}`, NS);
                     }
                     await Promise.all(this.endpoints.map(async (e) => e.sendPendingRequests(true)));
                     // We *must* end fast-poll when we're done sending things. Otherwise
                     // we cause undue power-drain.
-                    debug.log(`check-in from ${this.ieeeAddr}: stopping fast-poll`);
-                    await endpoint.command(frame.Cluster.ID, 'fastPollStop', {}, { sendPolicy: 'immediate' });
+                    logger_1.logger.debug(`check-in from ${this.ieeeAddr}: stopping fast-poll`, NS);
+                    await endpoint.command(frame.cluster.ID, 'fastPollStop', {}, { sendPolicy: 'immediate' });
                 }
                 else {
                     const payload = {
                         startFastPolling: false,
                         fastPollTimeout: 0,
                     };
-                    debug.log(`check-in from ${this.ieeeAddr}: declining fast-poll`);
-                    await endpoint.command(frame.Cluster.ID, 'checkinRsp', payload, { sendPolicy: 'immediate' });
+                    logger_1.logger.debug(`check-in from ${this.ieeeAddr}: declining fast-poll`, NS);
+                    await endpoint.command(frame.cluster.ID, 'checkinRsp', payload, { sendPolicy: 'immediate' });
                 }
             }
             catch (error) {
                 /* istanbul ignore next */
-                debug.error(`Handling of poll check-in form ${this.ieeeAddr} failed`);
+                logger_1.logger.error(`Handling of poll check-in from ${this.ieeeAddr} failed`, NS);
             }
         }
         // Send a default response if necessary.
-        const isDefaultResponse = frame.isGlobal() && frame.getCommand().name === 'defaultRsp';
-        const commandHasResponse = frame.getCommand().hasOwnProperty('response');
-        const disableDefaultResponse = frame.Header.frameControl.disableDefaultResponse;
+        const isDefaultResponse = frame.header.isGlobal && frame.command.name === 'defaultRsp';
+        const commandHasResponse = frame.command.hasOwnProperty('response');
+        const disableDefaultResponse = frame.header.frameControl.disableDefaultResponse;
+        /* istanbul ignore next */
+        const disableTuyaDefaultResponse = endpoint.getDevice().manufacturerName?.startsWith('_TZ') && process.env['DISABLE_TUYA_DEFAULT_RESPONSE'];
         // Sometimes messages are received twice, prevent responding twice
-        const alreadyResponded = this._lastDefaultResponseSequenceNumber === frame.Header.transactionSequenceNumber;
+        const alreadyResponded = this._lastDefaultResponseSequenceNumber === frame.header.transactionSequenceNumber;
         if (this.type !== 'GreenPower' && !dataPayload.wasBroadcast && !disableDefaultResponse && !isDefaultResponse &&
-            !commandHasResponse && !this._skipDefaultResponse && !alreadyResponded) {
+            !commandHasResponse && !this._skipDefaultResponse && !alreadyResponded && !disableTuyaDefaultResponse) {
             try {
-                this._lastDefaultResponseSequenceNumber = frame.Header.transactionSequenceNumber;
+                this._lastDefaultResponseSequenceNumber = frame.header.transactionSequenceNumber;
                 // In the ZCL it is not documented what the direction of the default response should be
                 // In https://github.com/Koenkk/zigbee2mqtt/issues/18096 a commandResponse (SERVER_TO_CLIENT)
                 // is send and the device expects a CLIENT_TO_SERVER back.
                 // Previously SERVER_TO_CLIENT was always used.
                 // Therefore for non-global commands we inverse the direction.                
-                const direction = frame.isGlobal() ? Zcl.Direction.SERVER_TO_CLIENT : (frame.Header.frameControl.direction === Zcl.Direction.CLIENT_TO_SERVER
+                const direction = frame.header.isGlobal ? Zcl.Direction.SERVER_TO_CLIENT : (frame.header.frameControl.direction === Zcl.Direction.CLIENT_TO_SERVER
                     ? Zcl.Direction.SERVER_TO_CLIENT : Zcl.Direction.CLIENT_TO_SERVER);
-                await endpoint.defaultResponse(frame.getCommand().ID, 0, frame.Cluster.ID, frame.Header.transactionSequenceNumber, { direction });
+                await endpoint.defaultResponse(frame.command.ID, 0, frame.cluster.ID, frame.header.transactionSequenceNumber, { direction });
             }
             catch (error) {
-                debug.error(`Default response to ${this.ieeeAddr} failed`);
+                logger_1.logger.error(`Default response to ${this.ieeeAddr} failed`, NS);
             }
         }
     }
@@ -322,7 +324,7 @@ class Device extends entity_1.default {
         }
         // default: no timeout (messages expire immediately after first send attempt)
         let pendingRequestTimeout = 0;
-        if ((endpoints.filter((e) => e.supportsInputCluster('genPollCtrl'))).length > 0) {
+        if ((endpoints.filter((e) => e.inputClusters.includes(Zcl.Clusters.genPollCtrl.ID))).length > 0) {
             // default for devices that support genPollCtrl cluster (RX off when idle): 1 day
             pendingRequestTimeout = 86400000;
             /* istanbul ignore else */
@@ -331,7 +333,7 @@ class Device extends entity_1.default {
                 pendingRequestTimeout = entry.checkinInterval * 1000; // milliseconds
             }
         }
-        debug.log(`Request Queue (${ieeeAddr}): default expiration timeout set to ${pendingRequestTimeout}`);
+        logger_1.logger.debug(`Request Queue (${ieeeAddr}): default expiration timeout set to ${pendingRequestTimeout}`, NS);
         return new Device(databaseID, entry.id, entry.type, ieeeAddr, networkAddress, entry.manufId, endpoints, entry.manufName, entry.powerSource, entry.modelId, entry.appVersion, entry.stackVersion, entry.zclVersion, entry.hwVersion, entry.dateCode, entry.swBuildId, entry.interviewCompleted, meta, entry.lastSeen || null, entry.checkinInterval, pendingRequestTimeout);
     }
     toDatabaseEntry() {
@@ -364,13 +366,18 @@ class Device extends entity_1.default {
             }
         });
     }
+    static find(databaseID, ieeeOrNwkAddress, includeDeleted = false) {
+        return typeof ieeeOrNwkAddress === 'string' ? Device.byIeeeAddr(databaseID, ieeeOrNwkAddress, includeDeleted)
+            : Device.byNetworkAddress(ieeeOrNwkAddress, databaseID, includeDeleted);
+    }
     static byIeeeAddr(databaseID, ieeeAddr, includeDeleted = false) {
         Device.loadFromDatabaseIfNecessary();
         const device = Device.devices.get(databaseID)[ieeeAddr];
         return device?._deleted && !includeDeleted ? undefined : device;
     }
-    static byNetworkAddress(networkAddress, databaseID) {
-        return Device.allByDatabaseID(databaseID).find(d => d.networkAddress === networkAddress);
+    static byNetworkAddress(networkAddress, databaseID, includeDeleted = false) {
+        Device.loadFromDatabaseIfNecessary();
+        return Object.values(Device.allByDatabaseID(databaseID)).find(d => (includeDeleted || !d._deleted) && d.networkAddress === networkAddress);
     }
     static byType(type, databaseID) {
         return Device.allByDatabaseID(databaseID).filter(d => d.type === type);
@@ -414,23 +421,23 @@ class Device extends entity_1.default {
     async interview() {
         if (this.interviewing) {
             const message = `Interview - interview already in progress for '${this.ieeeAddr}'`;
-            debug.log(message);
+            logger_1.logger.debug(message, NS);
             throw new Error(message);
         }
         let error;
         this._interviewing = true;
-        debug.log(`Interview - start device '${this.ieeeAddr}'`);
+        logger_1.logger.debug(`Interview - start device '${this.ieeeAddr}'`, NS);
         try {
             await this.interviewInternal();
-            debug.log(`Interview - completed for device '${this.ieeeAddr}'`);
+            logger_1.logger.debug(`Interview - completed for device '${this.ieeeAddr}'`, NS);
             this._interviewCompleted = true;
         }
         catch (e) {
             if (this.interviewQuirks()) {
-                debug.log(`Interview - completed for device '${this.ieeeAddr}' because of quirks ('${e}')`);
+                logger_1.logger.debug(`Interview - completed for device '${this.ieeeAddr}' because of quirks ('${e}')`, NS);
             }
             else {
-                debug.log(`Interview - failed for device '${this.ieeeAddr}' with error '${e.stack}'`);
+                logger_1.logger.debug(`Interview - failed for device '${this.ieeeAddr}' with error '${e.stack}'`, NS);
                 error = e;
             }
         }
@@ -443,7 +450,7 @@ class Device extends entity_1.default {
         }
     }
     interviewQuirks() {
-        debug.log(`Interview - quirks check for '${this.modelID}'-'${this.manufacturerName}'-'${this.type}'`);
+        logger_1.logger.debug(`Interview - quirks check for '${this.modelID}'-'${this.manufacturerName}'-'${this.type}'`, NS);
         // TuYa devices are typically hard to interview. They also don't require a full interview to work correctly
         // e.g. no ias enrolling is required for the devices to work.
         // Assume that in case we got both the manufacturerName and modelID the device works correctly.
@@ -457,7 +464,7 @@ class Device extends entity_1.default {
             this._powerSource = this._powerSource || 'Battery';
             this._interviewing = false;
             this._interviewCompleted = true;
-            debug.log(`Interview - quirks matched for TuYa end device`);
+            logger_1.logger.debug(`Interview - quirks matched for TuYa end device`, NS);
             return true;
         }
         // Some devices, e.g. Xiaomi end devices have a different interview procedure, after pairing they
@@ -480,18 +487,18 @@ class Device extends entity_1.default {
         const match = Object.keys(lookup).find((key) => this.modelID && this.modelID.match(key));
         if (match) {
             const info = lookup[match];
-            debug.log(`Interview procedure failed but got modelID matching '${match}', assuming interview succeeded`);
+            logger_1.logger.debug(`Interview procedure failed but got modelID matching '${match}', assuming interview succeeded`, NS);
             this._type = this._type === 'Unknown' ? info.type : this._type;
             this._manufacturerID = this._manufacturerID || info.manufacturerID;
             this._manufacturerName = this._manufacturerName || info.manufacturerName;
             this._powerSource = this._powerSource || info.powerSource;
             this._interviewing = false;
             this._interviewCompleted = true;
-            debug.log(`Interview - quirks matched on '${match}'`);
+            logger_1.logger.debug(`Interview - quirks matched on '${match}'`, NS);
             return true;
         }
         else {
-            debug.log('Interview - quirks did not match');
+            logger_1.logger.debug('Interview - quirks did not match', NS);
             return false;
         }
     }
@@ -500,7 +507,7 @@ class Device extends entity_1.default {
             const nodeDescriptor = await entity_1.default.getAdapterByID(this.databaseID).nodeDescriptor(this.networkAddress);
             this._manufacturerID = nodeDescriptor.manufacturerCode;
             this._type = nodeDescriptor.type;
-            debug.log(`Interview - got node descriptor for device '${this.ieeeAddr}'`);
+            logger_1.logger.debug(`Interview - got node descriptor for device '${this.ieeeAddr}'`, NS);
         };
         const hasNodeDescriptor = () => this._manufacturerID != null && this._type != null;
         if (!hasNodeDescriptor()) {
@@ -511,18 +518,18 @@ class Device extends entity_1.default {
                 }
                 catch (error) {
                     if (this.interviewQuirks()) {
-                        debug.log(`Interview - completed for device '${this.ieeeAddr}' because of quirks ('${error}')`);
+                        logger_1.logger.debug(`Interview - completed for device '${this.ieeeAddr}' because of quirks ('${error}')`, NS);
                         return;
                     }
                     else {
                         // Most of the times the first node descriptor query fails and the seconds one succeeds.
-                        debug.log(`Interview - node descriptor request failed for '${this.ieeeAddr}', attempt ${attempt + 1}`);
+                        logger_1.logger.debug(`Interview - node descriptor request failed for '${this.ieeeAddr}', attempt ${attempt + 1}`, NS);
                     }
                 }
             }
         }
         else {
-            debug.log(`Interview - skip node descriptor request for '${this.ieeeAddr}', already got it`);
+            logger_1.logger.debug(`Interview - skip node descriptor request for '${this.ieeeAddr}', already got it`, NS);
         }
         if (!hasNodeDescriptor()) {
             throw new Error(`Interview failed because can not get node descriptor ('${this.ieeeAddr}')`);
@@ -530,7 +537,7 @@ class Device extends entity_1.default {
         if (this.manufacturerID === 4619 && this._type === 'EndDevice') {
             // Give TuYa end device some time to pair. Otherwise they leave immediately.
             // https://github.com/Koenkk/zigbee2mqtt/issues/5814
-            debug.log("Interview - Detected TuYa end device, waiting 10 seconds...");
+            logger_1.logger.debug("Interview - Detected TuYa end device, waiting 10 seconds...", NS);
             await (0, utils_1.Wait)(10000);
         }
         else if ([0, 4098].includes(this.manufacturerID)) {
@@ -538,7 +545,7 @@ class Device extends entity_1.default {
             // In case the device responds, the endoint and modelID/manufacturerName are set
             // in controller.onZclOrRawData()
             // https://github.com/Koenkk/zigbee2mqtt/issues/7553
-            debug.log("Interview - Detected potential TuYa end device, reading modelID and manufacturerName...");
+            logger_1.logger.debug("Interview - Detected potential TuYa end device, reading modelID and manufacturerName...", NS);
             try {
                 const endpoint = endpoint_1.default.create(this.databaseID, 1, undefined, undefined, [], [], this.networkAddress, this.ieeeAddr);
                 const result = await endpoint.read('genBasic', ['modelId', 'manufacturerName'], { sendPolicy: 'immediate' });
@@ -547,7 +554,7 @@ class Device extends entity_1.default {
             }
             catch (error) {
                 /* istanbul ignore next */
-                debug.log(`Interview - TuYa read modelID and manufacturerName failed (${error})`);
+                logger_1.logger.debug(`Interview - TuYa read modelID and manufacturerName failed (${error})`, NS);
             }
         }
         // e.g. Xiaomi Aqara Opple devices fail to respond to the first active endpoints request, therefore try 2 times
@@ -560,7 +567,7 @@ class Device extends entity_1.default {
                 break;
             }
             catch (error) {
-                debug.log(`Interview - active endpoints request failed for '${this.ieeeAddr}', attempt ${attempt + 1}`);
+                logger_1.logger.debug(`Interview - active endpoints request failed for '${this.ieeeAddr}', attempt ${attempt + 1}`, NS);
             }
         }
         if (!activeEndpoints) {
@@ -572,7 +579,7 @@ class Device extends entity_1.default {
         // This is not a valid endpoint number according to the ZCL, requesting a simple descriptor will result
         // into an error. Therefore we filter it, more info: https://github.com/Koenkk/zigbee-herdsman/issues/82
         activeEndpoints.endpoints.filter((e) => e !== 0 && !this.getEndpoint(e)).forEach((e) => this._endpoints.push(endpoint_1.default.create(this.databaseID, e, undefined, undefined, [], [], this.networkAddress, this.ieeeAddr)));
-        debug.log(`Interview - got active endpoints for device '${this.ieeeAddr}'`);
+        logger_1.logger.debug(`Interview - got active endpoints for device '${this.ieeeAddr}'`, NS);
         for (const endpointID of activeEndpoints.endpoints.filter((e) => e !== 0)) {
             const endpoint = this.getEndpoint(endpointID);
             const simpleDescriptor = await adapter.simpleDescriptor(this.networkAddress, endpoint.ID);
@@ -580,7 +587,7 @@ class Device extends entity_1.default {
             endpoint.deviceID = simpleDescriptor.deviceID;
             endpoint.inputClusters = simpleDescriptor.inputClusters;
             endpoint.outputClusters = simpleDescriptor.outputClusters;
-            debug.log(`Interview - got simple descriptor for endpoint '${endpoint.ID}' device '${this.ieeeAddr}'`);
+            logger_1.logger.debug(`Interview - got simple descriptor for endpoint '${endpoint.ID}' device '${this.ieeeAddr}'`, NS);
             // Read attributes, nice to have but not required for succesfull pairing as most of the attributes
             // are not mandatory in ZCL specification.
             if (endpoint.supportsInputCluster('genBasic')) {
@@ -597,8 +604,7 @@ class Device extends entity_1.default {
                                 // https://github.com/Koenkk/zigbee-herdsman-converters/issues/2485.
                                 // The modelID and manufacturerName are crucial for device identification, so retry.
                                 if (item.key === 'modelID' || item.key === 'manufacturerName') {
-                                    debug.log(`Interview - first ${item.key} retrieval attempt failed, ` +
-                                        `retrying after 10 seconds...`);
+                                    logger_1.logger.debug(`Interview - first ${item.key} retrieval attempt failed, retrying after 10 seconds...`, NS);
                                     await (0, utils_1.Wait)(10000);
                                     result = await endpoint.read('genBasic', [key], { sendPolicy: 'immediate' });
                                 }
@@ -607,11 +613,10 @@ class Device extends entity_1.default {
                                 }
                             }
                             item.set(result[key], this);
-                            debug.log(`Interview - got '${item.key}' for device '${this.ieeeAddr}'`);
+                            logger_1.logger.debug(`Interview - got '${item.key}' for device '${this.ieeeAddr}'`, NS);
                         }
                         catch (error) {
-                            debug.log(`Interview - failed to read attribute '${item.key}' from ` +
-                                `endpoint '${endpoint.ID}' (${error})`);
+                            logger_1.logger.debug(`Interview - failed to read attribute '${item.key}' from endpoint '${endpoint.ID}' (${error})`, NS);
                         }
                     }
                 }
@@ -620,14 +625,14 @@ class Device extends entity_1.default {
         const coordinator = Device.byType('Coordinator', this.databaseID)[0];
         // Enroll IAS device
         for (const endpoint of this.endpoints.filter((e) => e.supportsInputCluster('ssIasZone'))) {
-            debug.log(`Interview - IAS - enrolling '${this.ieeeAddr}' endpoint '${endpoint.ID}'`);
+            logger_1.logger.debug(`Interview - IAS - enrolling '${this.ieeeAddr}' endpoint '${endpoint.ID}'`, NS);
             const stateBefore = await endpoint.read('ssIasZone', ['iasCieAddr', 'zoneState'], { sendPolicy: 'immediate' });
-            debug.log(`Interview - IAS - before enrolling state: '${JSON.stringify(stateBefore)}'`);
+            logger_1.logger.debug(`Interview - IAS - before enrolling state: '${JSON.stringify(stateBefore)}'`, NS);
             // Do not enroll when device has already been enrolled
             if (stateBefore.zoneState !== 1 || stateBefore.iasCieAddr !== coordinator.ieeeAddr) {
-                debug.log(`Interview - IAS - not enrolled, enrolling`);
+                logger_1.logger.debug(`Interview - IAS - not enrolled, enrolling`, NS);
                 await endpoint.write('ssIasZone', { 'iasCieAddr': coordinator.ieeeAddr }, { sendPolicy: 'immediate' });
-                debug.log(`Interview - IAS - wrote iasCieAddr`);
+                logger_1.logger.debug(`Interview - IAS - wrote iasCieAddr`, NS);
                 // There are 2 enrollment procedures:
                 // - Auto enroll: coordinator has to send enrollResponse without receiving an enroll request
                 //                this case is handled below.
@@ -635,34 +640,34 @@ class Device extends entity_1.default {
                 //                  this case in hanled in onZclData().
                 // https://github.com/Koenkk/zigbee2mqtt/issues/4569#issuecomment-706075676
                 await (0, utils_1.Wait)(500);
-                debug.log(`IAS - '${this.ieeeAddr}' sending enroll response (auto enroll)`);
+                logger_1.logger.debug(`IAS - '${this.ieeeAddr}' sending enroll response (auto enroll)`, NS);
                 const payload = { enrollrspcode: 0, zoneid: 23 };
                 await endpoint.command('ssIasZone', 'enrollRsp', payload, { disableDefaultResponse: true, sendPolicy: 'immediate' });
                 let enrolled = false;
                 for (let attempt = 0; attempt < 20; attempt++) {
                     await (0, utils_1.Wait)(500);
                     const stateAfter = await endpoint.read('ssIasZone', ['iasCieAddr', 'zoneState'], { sendPolicy: 'immediate' });
-                    debug.log(`Interview - IAS - after enrolling state (${attempt}): '${JSON.stringify(stateAfter)}'`);
+                    logger_1.logger.debug(`Interview - IAS - after enrolling state (${attempt}): '${JSON.stringify(stateAfter)}'`, NS);
                     if (stateAfter.zoneState === 1) {
                         enrolled = true;
                         break;
                     }
                 }
                 if (enrolled) {
-                    debug.log(`Interview - IAS successfully enrolled '${this.ieeeAddr}' endpoint '${endpoint.ID}'`);
+                    logger_1.logger.debug(`Interview - IAS successfully enrolled '${this.ieeeAddr}' endpoint '${endpoint.ID}'`, NS);
                 }
                 else {
                     throw new Error(`Interview failed because of failed IAS enroll (zoneState didn't change ('${this.ieeeAddr}')`);
                 }
             }
             else {
-                debug.log(`Interview - IAS - already enrolled, skipping enroll`);
+                logger_1.logger.debug(`Interview - IAS - already enrolled, skipping enroll`, NS);
             }
         }
         // Bind poll control
         try {
             for (const endpoint of this.endpoints.filter((e) => e.supportsInputCluster('genPollCtrl'))) {
-                debug.log(`Interview - Poll control - binding '${this.ieeeAddr}' endpoint '${endpoint.ID}'`);
+                logger_1.logger.debug(`Interview - Poll control - binding '${this.ieeeAddr}' endpoint '${endpoint.ID}'`, NS);
                 await endpoint.bind('genPollCtrl', coordinator.endpoints[0]);
                 const pollPeriod = await endpoint.read('genPollCtrl', ['checkinInterval'], { sendPolicy: 'immediate' });
                 this._checkinInterval = pollPeriod.checkinInterval / 4; // convert to seconds
@@ -671,7 +676,7 @@ class Device extends entity_1.default {
         }
         catch (error) {
             /* istanbul ignore next */
-            debug.log(`Interview - failed to bind genPollCtrl (${error})`);
+            logger_1.logger.debug(`Interview - failed to bind genPollCtrl (${error})`, NS);
         }
     }
     async removeFromNetwork() {
@@ -680,8 +685,8 @@ class Device extends entity_1.default {
                 options: 0x002550,
                 srcID: Number(this.ieeeAddr),
             };
-            const frame = Zcl.ZclFrame.create(Zcl.FrameType.SPECIFIC, Zcl.Direction.SERVER_TO_CLIENT, true, null, zclTransactionSequenceNumber_1.default.next(), 'pairing', 33, payload);
-            await entity_1.default.getAdapterByID(this.databaseID).sendZclFrameToAll(242, frame, 242);
+            const frame = Zcl.Frame.create(Zcl.FrameType.SPECIFIC, Zcl.Direction.SERVER_TO_CLIENT, true, null, zclTransactionSequenceNumber_1.default.next(), 'pairing', 33, payload, this.customClusters);
+            await entity_1.default.getAdapterByID(this.databaseID).sendZclFrameToAll(242, frame, 242, enums_1.BroadcastAddress.RX_ON_WHEN_IDLE);
         }
         else
             await entity_1.default.getAdapterByID(this.databaseID).removeDevice(this.networkAddress, this.ieeeAddr);
@@ -720,6 +725,22 @@ class Device extends entity_1.default {
         const endpoint = this.endpoints.find((ep) => ep.inputClusters.includes(0)) ?? this.endpoints[0];
         await endpoint.read('genBasic', ['zclVersion'], { disableRecovery });
     }
+    addCustomCluster(name, cluster) {
+        (0, assert_1.default)(!([Zcl.Clusters.touchlink.ID, Zcl.Clusters.greenPower.ID].includes(cluster.ID)), 'Overriding of greenPower or touchlink cluster is not supported');
+        if (Zcl.Utils.isClusterName(name)) {
+            const existingCluster = Zcl.Clusters[name];
+            // Extend existing cluster
+            (0, assert_1.default)(existingCluster.ID === cluster.ID, `Custom cluster ID (${cluster.ID}) should match existing cluster ID (${existingCluster.ID})`);
+            cluster = {
+                ID: cluster.ID,
+                manufacturerCode: cluster.manufacturerCode,
+                attributes: { ...existingCluster.attributes, ...cluster.attributes },
+                commands: { ...existingCluster.commands, ...cluster.commands },
+                commandsResponse: { ...existingCluster.commandsResponse, ...cluster.commandsResponse },
+            };
+        }
+        this._customClusters[name] = cluster;
+    }
 }
 exports.default = Device;
 //# sourceMappingURL=device.js.map