@willieee802/zigbee-herdsman 0.49.3 → 0.50.0

package/src/adapter/z-stack/adapter/adapter-backup.ts

@@ -59,7 +59,7 @@ export class AdapterBackup {
 
         /* get adapter ieee address */
         const ieeeAddressResponse = await this.znp.requestWithReply(Subsystem.SYS, "getExtAddr", {});
-        if (!ieeeAddressResponse.payload.extaddress || !ieeeAddressResponse.payload.extaddress.startsWith("0x")) {
+        if (!ieeeAddressResponse.payload.extaddress?.startsWith("0x")) {
             throw new Error("Failed to read adapter IEEE address");
         }
         const ieeeAddress = Buffer.from(ieeeAddressResponse.payload.extaddress.split("0x")[1], "hex");

package/src/adapter/z-stack/adapter/adapter-nv-memory.ts

@@ -151,7 +151,7 @@ export class AdapterNvMemory {
     public async updateItem(id: NvItemsIds, data: Buffer, autoInit = true): Promise<void> {
         this.checkMemoryAlignmentSetup();
         const current = await this.readItem(id);
-        if (!current || !current.equals(data)) {
+        if (!current?.equals(data)) {
             await this.writeItem(id, data, 0, autoInit);
         }
     }

package/src/adapter/z-stack/adapter/manager.ts

@@ -150,7 +150,11 @@ export class ZnpAdapterManager {
                 /* exception for some adapters which may actually use 0xdddddddddddddddd as EPID (backward compatibility) */
                 /* v8 ignore next */
                 this.nwkOptions.hasDefaultExtendedPanId) &&
-            this.nwkOptions.networkKey.equals(preconfiguredKey.key) &&
+            /* On Z-Stack 3.x, the preconfigured (transport) key in NVRAM may retain a default
+             * firmware value that does not match the configured network key, even though the
+             * active and alternate keys are correct. Only require preconfiguredKey match on
+             * Z-Stack 1.2 where it serves as the active key (see lines 128-133 above). */
+            (this.options.version !== ZnpVersion.ZStack12 || this.nwkOptions.networkKey.equals(preconfiguredKey.key)) &&
             this.nwkOptions.networkKey.equals(activeKeyInfo.key) &&
             this.nwkOptions.networkKey.equals(alternateKeyInfo.key);
 
@@ -178,7 +182,7 @@ export class ZnpAdapterManager {
         };
 
         /* Determine startup strategy */
-        if (!hasConfigured || !hasConfigured.isConfigured() || !nib) {
+        if (!hasConfigured?.isConfigured() || !nib) {
             /* Adapter is not configured or not commissioned */
             logger.debug("(stage-1) adapter is not configured / not commissioned", NS);
             if (configMatchesBackup) {
@@ -199,6 +203,16 @@ export class ZnpAdapterManager {
         logger.debug("(stage-1) adapter is configured", NS);
 
         if (configMatchesAdapter) {
+            /* Warn if preconfigured key doesn't match (Z-Stack 3.x only, non-fatal) */
+            if (this.options.version !== ZnpVersion.ZStack12 && !this.nwkOptions.networkKey.equals(preconfiguredKey.key)) {
+                logger.warning(
+                    "Adapter preconfigured (transport) key does not match configured network key " +
+                        `(preconfigured=${preconfiguredKey.key.toString("hex")}, configured=${this.nwkOptions.networkKey.toString("hex")}). ` +
+                        "This is typically harmless on Z-Stack 3.x adapters where only the active key matters.",
+                    NS,
+                );
+            }
+
             /* Warn if EPID is reversed (backward-compat) */
             if (isExtendedPanIdReversed) {
                 logger.debug("(stage-2) extended pan id is reversed", NS);

package/src/adapter/z-stack/adapter/tstype.ts

@@ -3,4 +3,5 @@ enum ZnpVersion {
     ZStack3x0 = 1,
     ZStack30x = 2,
 }
+
 export {ZnpVersion};

package/src/adapter/z-stack/adapter/zStackAdapter.ts

@@ -1,7 +1,5 @@
 import assert from "node:assert";
-
 import debounce from "debounce";
-
 import type * as Models from "../../../models";
 import {Queue, Waitress, wait} from "../../../utils";
 import {logger} from "../../../utils/logger";
@@ -11,7 +9,7 @@ import type {Eui64} from "../../../zspec/tstypes";
 import * as Zcl from "../../../zspec/zcl";
 import * as Zdo from "../../../zspec/zdo";
 import type * as ZdoTypes from "../../../zspec/zdo/definition/tstypes";
-import Adapter from "../../adapter";
+import Adapter, {type ClusterWaitressMatcher, type ZclWaitressPayload} from "../../adapter";
 import type * as Events from "../../events";
 import type {AdapterOptions, CoordinatorVersion, NetworkOptions, NetworkParameters, SerialPortOptions, StartResult} from "../../tstype";
 import * as Constants from "../constants";
@@ -31,16 +29,6 @@ const {ZnpCommandStatus, AddressMode} = Constants.COMMON;
 
 const DataConfirmTimeout = 9999; // Not an actual code
 
-interface WaitressMatcher {
-    address?: number | string;
-    endpoint: number;
-    transactionSequenceNumber?: number;
-    frameType: Zcl.FrameType;
-    clusterID: number;
-    commandIdentifier: number;
-    direction: number;
-}
-
 class DataConfirmError extends Error {
     public code: number;
     constructor(code: number) {
@@ -72,7 +60,7 @@ export class ZStackAdapter extends Adapter {
     private supportsLED?: boolean;
     private interpanLock: boolean;
     private interpanEndpointRegistered: boolean;
-    private waitress: Waitress<Events.ZclPayload, WaitressMatcher>;
+    private waitress: Waitress<ZclWaitressPayload, ClusterWaitressMatcher>;
     private konnextConfig: KonnextConfig;
 
     public constructor(networkOptions: NetworkOptions, serialPortOptions: SerialPortOptions, backupPath: string, adapterOptions: AdapterOptions, konnextConfig: KonnextConfig) {
@@ -88,7 +76,7 @@ export class ZStackAdapter extends Adapter {
         this.interpanLock = false;
         this.interpanEndpointRegistered = false;
         this.closing = false;
-        this.waitress = new Waitress<Events.ZclPayload, WaitressMatcher>(this.waitressValidator, this.waitressTimeoutFormatter);
+        this.waitress = new Waitress(Adapter.zclWaitressValidator, Adapter.clusterWaitressTimeoutFormatter);
 
         this.znp.on("received", this.onZnpRecieved.bind(this));
         this.znp.on("close", this.onZnpClose.bind(this));
@@ -530,22 +518,20 @@ export class ZStackAdapter extends Adapter {
             response = this.waitForInternal(
                 networkAddress,
                 endpoint,
-                zclFrame.header.frameControl.frameType,
-                Zcl.Direction.SERVER_TO_CLIENT,
                 zclFrame.header.transactionSequenceNumber,
                 zclFrame.cluster.ID,
                 command.response,
+                undefined,
                 timeout,
             );
         } else if (!zclFrame.header.frameControl.disableDefaultResponse) {
             response = this.waitForInternal(
                 networkAddress,
                 endpoint,
-                Zcl.FrameType.GLOBAL,
-                Zcl.Direction.SERVER_TO_CLIENT,
                 zclFrame.header.transactionSequenceNumber,
                 zclFrame.cluster.ID,
                 Zcl.Foundation.defaultRsp.ID,
+                undefined,
                 timeout,
             );
         }
@@ -978,7 +964,11 @@ export class ZStackAdapter extends Adapter {
                                         wasBroadcast: object.payload.wasbroadcast === 1,
                                         destinationEndpoint: object.payload.dstendpoint,
                                     };
-                                    this.waitress.resolve(payload);
+
+                                    if (payload.header !== undefined) {
+                                        this.waitress.resolve(payload as ZclWaitressPayload);
+                                    }
+
                                     this.emit("zclPayload", payload);
                                 }
                             })
@@ -999,7 +989,10 @@ export class ZStackAdapter extends Adapter {
                             destinationEndpoint: object.payload.dstendpoint,
                         };
 
-                        this.waitress.resolve(payload);
+                        if (payload.header !== undefined) {
+                            this.waitress.resolve(payload as ZclWaitressPayload);
+                        }
+
                         this.emit("zclPayload", payload);
                     }
                 }
@@ -1077,16 +1070,7 @@ export class ZStackAdapter extends Adapter {
             let response: ReturnType<typeof this.waitForInternal> | undefined;
 
             if (!disableResponse && command.response !== undefined) {
-                response = this.waitForInternal(
-                    undefined,
-                    0xfe,
-                    zclFrame.header.frameControl.frameType,
-                    Zcl.Direction.SERVER_TO_CLIENT,
-                    undefined,
-                    zclFrame.cluster.ID,
-                    command.response,
-                    timeout,
-                );
+                response = this.waitForInternal(undefined, 0xfe, undefined, zclFrame.cluster.ID, command.response, undefined, timeout);
             }
 
             try {
@@ -1125,22 +1109,13 @@ export class ZStackAdapter extends Adapter {
     private waitForInternal(
         networkAddress: number | undefined,
         endpoint: number,
-        frameType: Zcl.FrameType,
-        direction: Zcl.Direction,
         transactionSequenceNumber: number | undefined,
-        clusterID: number,
-        commandIdentifier: number,
+        clusterId: number,
+        commandId: number,
+        defaultRspCommandId: number | undefined,
         timeout: number,
     ): {start: () => {promise: Promise<Events.ZclPayload>}; cancel: () => void} {
-        const payload = {
-            address: networkAddress,
-            endpoint,
-            clusterID,
-            commandIdentifier,
-            frameType,
-            direction,
-            transactionSequenceNumber,
-        };
+        const payload = {address: networkAddress, endpoint, clusterId, commandId, defaultRspCommandId, transactionSequenceNumber};
 
         const waiter = this.waitress.waitFor(payload, timeout);
         const cancel = (): void => this.waitress.remove(waiter.ID);
@@ -1148,25 +1123,17 @@ export class ZStackAdapter extends Adapter {
     }
 
     public waitFor(
-        networkAddress: number | undefined,
+        networkAddress: number,
         endpoint: number,
-        frameType: Zcl.FrameType,
-        direction: Zcl.Direction,
+        _frameType: Zcl.FrameType,
+        _direction: Zcl.Direction,
         transactionSequenceNumber: number | undefined,
-        clusterID: number,
-        commandIdentifier: number,
+        clusterId: number,
+        commandId: number,
+        defaultRspCommandId: number | undefined,
         timeout: number,
     ): {promise: Promise<Events.ZclPayload>; cancel: () => void} {
-        const waiter = this.waitForInternal(
-            networkAddress,
-            endpoint,
-            frameType,
-            direction,
-            transactionSequenceNumber,
-            clusterID,
-            commandIdentifier,
-            timeout,
-        );
+        const waiter = this.waitForInternal(networkAddress, endpoint, transactionSequenceNumber, clusterId, commandId, defaultRspCommandId, timeout);
 
         return {cancel: waiter.cancel, promise: waiter.start().promise};
     }
@@ -1186,6 +1153,13 @@ export class ZStackAdapter extends Adapter {
         const transactionID = this.nextTransactionID();
         const response = this.znp.waitFor(Type.AREQ, Subsystem.AF, "dataConfirm", undefined, transactionID, undefined, timeout);
 
+        let options = 0;
+
+        // Zigbee Direct cluster, enable APS layer encryption
+        if (clusterID === Zcl.Clusters.zigbeeDirectConfiguration.ID) {
+            options |= Constants.AF.options.EN_SECURITY;
+        }
+
         await this.znp.request(
             Subsystem.AF,
             "dataRequest",
@@ -1195,7 +1169,7 @@ export class ZStackAdapter extends Adapter {
                 srcendpoint: sourceEndpoint,
                 clusterid: clusterID,
                 transid: transactionID,
-                options: 0,
+                options,
                 radius: radius,
                 len: data.length,
                 data: data,
@@ -1301,27 +1275,6 @@ export class ZStackAdapter extends Adapter {
         return typeof address === "number" ? `0x${address.toString(16).padStart(16, "0")}` : address.toString();
     }
 
-    private waitressTimeoutFormatter(matcher: WaitressMatcher, timeout: number): string {
-        return (
-            `Timeout - ${matcher.address} - ${matcher.endpoint}` +
-            ` - ${matcher.transactionSequenceNumber} - ${matcher.clusterID}` +
-            ` - ${matcher.commandIdentifier} after ${timeout}ms`
-        );
-    }
-
-    private waitressValidator(payload: Events.ZclPayload, matcher: WaitressMatcher): boolean {
-        return Boolean(
-            payload.header &&
-                (!matcher.address || payload.address === matcher.address) &&
-                payload.endpoint === matcher.endpoint &&
-                (matcher.transactionSequenceNumber === undefined || payload.header.transactionSequenceNumber === matcher.transactionSequenceNumber) &&
-                payload.clusterID === matcher.clusterID &&
-                matcher.frameType === payload.header.frameControl.frameType &&
-                matcher.commandIdentifier === payload.header.commandIdentifier &&
-                matcher.direction === payload.header.frameControl.direction,
-        );
-    }
-
     private checkInterpanLock(): void {
         if (this.interpanLock) {
             throw new Error("Cannot execute command, in Inter-PAN mode");

package/src/adapter/z-stack/constants/index.ts

@@ -8,4 +8,4 @@ import UTIL from "./util";
 import * as Utils from "./utils";
 import ZDO from "./zdo";
 
-export {AF, common as COMMON, DBG, MAC, SAPI, SYS, UTIL, ZDO, Utils};
+export {AF, common as COMMON, DBG, MAC, SAPI, SYS, UTIL, Utils, ZDO};

package/src/adapter/z-stack/unpi/constants.ts

@@ -30,4 +30,4 @@ const PositionCmd1 = 3;
 const MinMessageLength = 5;
 const MaxDataSize = 250;
 
-export {Type, Subsystem, DataStart, SOF, PositionDataLength, MinMessageLength, PositionCmd0, PositionCmd1, MaxDataSize};
+export {DataStart, MaxDataSize, MinMessageLength, PositionCmd0, PositionCmd1, PositionDataLength, SOF, Subsystem, Type};

package/src/adapter/zboss/adapter/zbossAdapter.ts

@@ -8,35 +8,23 @@ import * as ZSpec from "../../../zspec";
 import * as Zcl from "../../../zspec/zcl";
 import * as Zdo from "../../../zspec/zdo";
 import type * as ZdoTypes from "../../../zspec/zdo/definition/tstypes";
-import {Adapter, type TsType} from "../..";
+import {Adapter, type ClusterWaitressMatcher, type ZclWaitressPayload} from "../../adapter";
 import {WORKAROUND_JOIN_MANUF_IEEE_PREFIX_TO_CODE} from "../../const";
 import type {ZclPayload} from "../../events";
+import type {AdapterOptions, CoordinatorVersion, NetworkOptions, NetworkParameters, SerialPortOptions, StartResult} from "../../tstype";
 import {ZBOSSDriver} from "../driver";
 import {CommandId, DeviceUpdateStatus} from "../enums";
 import {FrameType, type ZBOSSFrame} from "../frame";
 
 const NS = "zh:zboss";
 
-interface WaitressMatcher {
-    address: number | string;
-    endpoint: number;
-    transactionSequenceNumber?: number;
-    clusterID: number;
-    commandIdentifier: number;
-}
-
 export class ZBOSSAdapter extends Adapter {
     private queue: Queue;
     private readonly driver: ZBOSSDriver;
-    private waitress: Waitress<ZclPayload, WaitressMatcher>;
+    private waitress: Waitress<ZclWaitressPayload, ClusterWaitressMatcher>;
     private currentManufacturerCode: Zcl.ManufacturerCode;
 
-    constructor(
-        networkOptions: TsType.NetworkOptions,
-        serialPortOptions: TsType.SerialPortOptions,
-        backupPath: string,
-        adapterOptions: TsType.AdapterOptions,
-    ) {
+    constructor(networkOptions: NetworkOptions, serialPortOptions: SerialPortOptions, backupPath: string, adapterOptions: AdapterOptions) {
         super(networkOptions, serialPortOptions, backupPath, adapterOptions);
         this.hasZdoMessageOverhead = false;
         this.manufacturerID = Zcl.ManufacturerCode.NORDIC_SEMICONDUCTOR_ASA;
@@ -45,7 +33,7 @@ export class ZBOSSAdapter extends Adapter {
         logger.debug(`Adapter concurrent: ${concurrent}`, NS);
         this.queue = new Queue(concurrent);
 
-        this.waitress = new Waitress<ZclPayload, WaitressMatcher>(this.waitressValidator, this.waitressTimeoutFormatter);
+        this.waitress = new Waitress(Adapter.zclWaitressValidator, Adapter.clusterWaitressTimeoutFormatter);
         this.driver = new ZBOSSDriver(serialPortOptions, networkOptions);
         this.driver.on("frame", this.processMessage.bind(this));
     }
@@ -107,7 +95,10 @@ export class ZBOSSAdapter extends Adapter {
                         destinationEndpoint: frame.payload.dstEndpoint,
                     };
 
-                    this.waitress.resolve(payload);
+                    if (payload.header !== undefined) {
+                        this.waitress.resolve(payload as ZclWaitressPayload);
+                    }
+
                     this.emit("zclPayload", payload);
                     break;
                 }
@@ -115,7 +106,7 @@ export class ZBOSSAdapter extends Adapter {
         }
     }
 
-    public async start(): Promise<TsType.StartResult> {
+    public async start(): Promise<StartResult> {
         logger.info("ZBOSS Adapter starting", NS);
 
         await this.driver.connect();
@@ -133,8 +124,8 @@ export class ZBOSSAdapter extends Adapter {
         return await Promise.resolve(this.driver.netInfo.ieeeAddr);
     }
 
-    public async getCoordinatorVersion(): Promise<TsType.CoordinatorVersion> {
-        return await this.queue.execute<TsType.CoordinatorVersion>(async () => {
+    public async getCoordinatorVersion(): Promise<CoordinatorVersion> {
+        return await this.queue.execute<CoordinatorVersion>(async () => {
             const ver = await this.driver.execCommand(CommandId.GET_MODULE_VERSION, {});
             const cver = await this.driver.execCommand(CommandId.GET_COORDINATOR_VERSION, {});
             const ver2str = (version: number): string => {
@@ -169,7 +160,7 @@ export class ZBOSSAdapter extends Adapter {
         return await Promise.reject(new Error("This adapter does not support backup"));
     }
 
-    public async getNetworkParameters(): Promise<TsType.NetworkParameters> {
+    public async getNetworkParameters(): Promise<NetworkParameters> {
         return await this.queue.execute(async () => {
             // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
             const channel = this.driver.netInfo!.network.channel;
@@ -362,6 +353,7 @@ export class ZBOSSAdapter extends Adapter {
                 zclFrame.cluster.ID,
                 // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
                 command.response!,
+                undefined,
                 timeout,
             );
         } else if (!zclFrame.header.frameControl.disableDefaultResponse) {
@@ -371,6 +363,7 @@ export class ZBOSSAdapter extends Adapter {
                 zclFrame.header.transactionSequenceNumber,
                 zclFrame.cluster.ID,
                 Zcl.Foundation.defaultRsp.ID,
+                undefined,
                 timeout,
             );
         }
@@ -480,18 +473,13 @@ export class ZBOSSAdapter extends Adapter {
         networkAddress: number,
         endpoint: number,
         transactionSequenceNumber: number | undefined,
-        clusterID: number,
-        commandIdentifier: number,
+        clusterId: number,
+        commandId: number,
+        defaultRspCommandId: number | undefined,
         timeout: number,
     ): {start: () => {promise: Promise<ZclPayload>}; cancel: () => void} {
         const waiter = this.waitress.waitFor(
-            {
-                address: networkAddress,
-                endpoint,
-                clusterID,
-                commandIdentifier,
-                transactionSequenceNumber,
-            },
+            {address: networkAddress, endpoint, clusterId, commandId, defaultRspCommandId, transactionSequenceNumber},
             timeout,
         );
         const cancel = (): void => this.waitress.remove(waiter.ID);
@@ -504,32 +492,13 @@ export class ZBOSSAdapter extends Adapter {
         _frameType: Zcl.FrameType,
         _direction: Zcl.Direction,
         transactionSequenceNumber: number | undefined,
-        clusterID: number,
-        commandIdentifier: number,
+        clusterId: number,
+        commandId: number,
+        defaultRspCommandId: number | undefined,
         timeout: number,
     ): {promise: Promise<ZclPayload>; cancel: () => void} {
-        const waiter = this.waitForInternal(networkAddress, endpoint, transactionSequenceNumber, clusterID, commandIdentifier, timeout);
+        const waiter = this.waitForInternal(networkAddress, endpoint, transactionSequenceNumber, clusterId, commandId, defaultRspCommandId, timeout);
 
         return {cancel: waiter.cancel, promise: waiter.start().promise};
     }
-
-    private waitressTimeoutFormatter(matcher: WaitressMatcher, timeout: number): string {
-        return (
-            `Timeout - ${matcher.address} - ${matcher.endpoint}` +
-            ` - ${matcher.transactionSequenceNumber} - ${matcher.clusterID}` +
-            ` - ${matcher.commandIdentifier} after ${timeout}ms`
-        );
-    }
-
-    private waitressValidator(payload: ZclPayload, matcher: WaitressMatcher): boolean {
-        return (
-            (payload.header &&
-                (!matcher.address || payload.address === matcher.address) &&
-                payload.endpoint === matcher.endpoint &&
-                (matcher.transactionSequenceNumber === undefined || payload.header.transactionSequenceNumber === matcher.transactionSequenceNumber) &&
-                payload.clusterID === matcher.clusterID &&
-                matcher.commandIdentifier === payload.header.commandIdentifier) ||
-            false
-        );
-    }
 }

package/src/adapter/zboss/driver.ts

@@ -8,6 +8,7 @@ import {Waitress} from "../../utils";
 import {AsyncMutex} from "../../utils/async-mutex";
 import {logger} from "../../utils/logger";
 import type * as ZSpec from "../../zspec";
+import * as Zcl from "../../zspec/zcl";
 import * as Zdo from "../../zspec/zdo";
 import type {TsType} from "..";
 import {ZDO_REQ_CLUSTER_ID_TO_ZBOSS_COMMAND_ID} from "./commands";
@@ -307,6 +308,12 @@ export class ZBOSSDriver extends EventEmitter {
     }
 
     public async request(ieee: string, profileID: number, clusterID: number, dstEp: number, srcEp: number, data: Buffer): Promise<ZBOSSFrame> {
+        // Default APS options
+        let txOptions = 0x02; // ROUTE DISCOVERY
+        // Zigbee Direct cluster, enable APS layer encryption
+        if (clusterID === Zcl.Clusters.zigbeeDirectConfiguration.ID) {
+            txOptions |= 0x01;
+        }
         const payload = {
             paramLength: 21,
             dataLength: data.length,
@@ -317,7 +324,7 @@ export class ZBOSSDriver extends EventEmitter {
             srcEndpoint: srcEp,
             radius: 3,
             dstAddrMode: 3, // ADDRESS MODE ieee
-            txOptions: 2, // ROUTE DISCOVERY
+            txOptions,
             useAlias: 0,
             aliasAddr: 0,
             aliasSequence: 0,

package/src/adapter/zboss/uart.ts

@@ -208,7 +208,20 @@ export class ZBOSSUart extends EventEmitter {
     }
 
     private async onPackage(data: Buffer): Promise<void> {
-        if (this.inReset) return;
+        // Do not drop frames while `inReset` is set.
+        //
+        // `inReset` is set by `reset()` and only cleared by `onPortClose`
+        // (after a 3s wait + reopen). On some NCP transports the underlying
+        // port does not reliably close around `esp_restart()` (e.g. ESP32-C6
+        // USB-Serial-JTAG re-attaches the same CDC descriptor essentially
+        // instantly), so `onPortClose` never fires, `inReset` never clears,
+        // and the device's tsn-matching NCP_RESET response plus the
+        // post-reboot boot-ready frame both get silently dropped here.
+        // `Driver.execCommand(NCP_RESET, ...)` already uses an undefined-tsn
+        // waitress matcher, so either frame would resolve the pending
+        // promise if it reached the `"frame"` emitter. The CRC8/CRC16 checks below
+        // reject any garbage (ROM banner ASCII, partial frames, electrical
+        // noise) that legitimately arrives during the reset window.
         const len = data.readUInt16LE(0);
         const pType = data.readUInt8(2);
         const pFlags = data.readUInt8(3);

package/src/adapter/zigate/adapter/zigateAdapter.ts

@@ -8,7 +8,7 @@ import type {BroadcastAddress} from "../../../zspec/enums";
 import * as Zcl from "../../../zspec/zcl";
 import * as Zdo from "../../../zspec/zdo";
 import type * as ZdoTypes from "../../../zspec/zdo/definition/tstypes";
-import Adapter from "../../adapter";
+import Adapter, {type ClusterWaitressMatcher, type ZclWaitressPayload} from "../../adapter";
 import type * as Events from "../../events";
 import type * as TsType from "../../tstype";
 import type {RawAPSDataRequestPayload} from "../driver/commandType";
@@ -19,20 +19,11 @@ import {patchZdoBuffaloBE} from "./patchZdoBuffaloBE";
 
 const NS = "zh:zigate";
 const default_bind_group = 901; // https://github.com/Koenkk/zigbee-herdsman-converters/blob/master/lib/constants.js#L3
-interface WaitressMatcher {
-    address?: number | string;
-    endpoint: number;
-    transactionSequenceNumber?: number;
-    frameType: Zcl.FrameType;
-    clusterID: number;
-    commandIdentifier: number;
-    direction: number;
-}
 
 export class ZiGateAdapter extends Adapter {
     private driver: Driver;
     private joinPermitted: boolean;
-    private waitress: Waitress<Events.ZclPayload, WaitressMatcher>;
+    private waitress: Waitress<ZclWaitressPayload, ClusterWaitressMatcher>;
     private closing: boolean;
     private queue: Queue;
 
@@ -54,7 +45,7 @@ export class ZiGateAdapter extends Adapter {
         this.queue = new Queue(concurrent);
         // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
         this.driver = new Driver(serialPortOptions.path!, serialPortOptions);
-        this.waitress = new Waitress<Events.ZclPayload, WaitressMatcher>(this.waitressValidator, this.waitressTimeoutFormatter);
+        this.waitress = new Waitress(Adapter.zclWaitressValidator, Adapter.clusterWaitressTimeoutFormatter);
 
         this.driver.on("received", this.dataListener.bind(this));
         this.driver.on("LeaveIndication", this.leaveIndicationListener.bind(this));
@@ -357,6 +348,7 @@ export class ZiGateAdapter extends Adapter {
                 zclFrame.header.transactionSequenceNumber,
                 zclFrame.cluster.ID,
                 command.response,
+                undefined,
                 timeout,
             );
         } else if (!zclFrame.header.frameControl.disableDefaultResponse) {
@@ -368,6 +360,7 @@ export class ZiGateAdapter extends Adapter {
                 zclFrame.header.transactionSequenceNumber,
                 zclFrame.cluster.ID,
                 Zcl.Foundation.defaultRsp.ID,
+                undefined,
                 timeout,
             );
         }
@@ -518,24 +511,17 @@ export class ZiGateAdapter extends Adapter {
     }
 
     public waitFor(
-        networkAddress: number | undefined,
+        networkAddress: number,
         endpoint: number,
-        frameType: Zcl.FrameType,
-        direction: Zcl.Direction,
+        _frameType: Zcl.FrameType,
+        _direction: Zcl.Direction,
         transactionSequenceNumber: number | undefined,
-        clusterID: number,
-        commandIdentifier: number,
+        clusterId: number,
+        commandId: number,
+        defaultRspCommandId: number | undefined,
         timeout: number,
     ): {promise: Promise<Events.ZclPayload>; cancel: () => void} {
-        const payload = {
-            address: networkAddress,
-            endpoint,
-            clusterID,
-            commandIdentifier,
-            frameType,
-            direction,
-            transactionSequenceNumber,
-        };
+        const payload = {address: networkAddress, endpoint, clusterId, commandId, defaultRspCommandId, transactionSequenceNumber};
         const waiter = this.waitress.waitFor(payload, timeout);
         const cancel = (): void => this.waitress.remove(waiter.ID);
         return {promise: waiter.start().promise, cancel};
@@ -591,7 +577,11 @@ export class ZiGateAdapter extends Adapter {
             wasBroadcast: false, // TODO
             destinationEndpoint: <number>ziGateObject.payload.destinationEndpoint,
         };
-        this.waitress.resolve(payload);
+
+        if (payload.header !== undefined) {
+            this.waitress.resolve(payload as ZclWaitressPayload);
+        }
+
         this.emit("zclPayload", payload);
     }
 
@@ -604,27 +594,6 @@ export class ZiGateAdapter extends Adapter {
         this.emit("deviceLeave", payload);
     }
 
-    private waitressTimeoutFormatter(matcher: WaitressMatcher, timeout: number): string {
-        return (
-            `Timeout - ${matcher.address} - ${matcher.endpoint}` +
-            ` - ${matcher.transactionSequenceNumber} - ${matcher.clusterID}` +
-            ` - ${matcher.commandIdentifier} after ${timeout}ms`
-        );
-    }
-
-    private waitressValidator(payload: Events.ZclPayload, matcher: WaitressMatcher): boolean {
-        return Boolean(
-            payload.header &&
-                (!matcher.address || payload.address === matcher.address) &&
-                matcher.endpoint === payload.endpoint &&
-                (matcher.transactionSequenceNumber === undefined || payload.header.transactionSequenceNumber === matcher.transactionSequenceNumber) &&
-                matcher.clusterID === payload.clusterID &&
-                matcher.frameType === payload.header.frameControl.frameType &&
-                matcher.commandIdentifier === payload.header.commandIdentifier &&
-                matcher.direction === payload.header.frameControl.direction,
-        );
-    }
-
     private onZiGateClose(): void {
         if (!this.closing) {
             this.emit("disconnected");