@willieee802/zigbee-herdsman 0.48.3 → 0.49.0

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

@@ -0,0 +1,633 @@
+/* v8 ignore start */
+
+import type * as Models from "../../../models";
+import {Queue, Waitress, wait} from "../../../utils";
+import {logger} from "../../../utils/logger";
+import * as ZSpec from "../../../zspec";
+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 type * as Events from "../../events";
+import type * as TsType from "../../tstype";
+import type {RawAPSDataRequestPayload} from "../driver/commandType";
+import {AddressMode, DeviceType, ZiGateCommandCode, ZiGateMessageCode, ZPSNwkKeyState} from "../driver/constants";
+import type ZiGateObject from "../driver/ziGateObject";
+import Driver from "../driver/zigate";
+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 closing: boolean;
+    private queue: Queue;
+
+    public constructor(
+        networkOptions: TsType.NetworkOptions,
+        serialPortOptions: TsType.SerialPortOptions,
+        backupPath: string,
+        adapterOptions: TsType.AdapterOptions,
+    ) {
+        patchZdoBuffaloBE();
+        super(networkOptions, serialPortOptions, backupPath, adapterOptions);
+        this.hasZdoMessageOverhead = false; // false for requests, true for responses
+        this.manufacturerID = Zcl.ManufacturerCode.RESERVED_10;
+
+        this.joinPermitted = false;
+        this.closing = false;
+        const concurrent = this.adapterOptions?.concurrent ? this.adapterOptions.concurrent : 2;
+        logger.debug(`Adapter concurrent: ${concurrent}`, NS);
+        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.driver.on("received", this.dataListener.bind(this));
+        this.driver.on("LeaveIndication", this.leaveIndicationListener.bind(this));
+        this.driver.on("DeviceAnnounce", this.deviceAnnounceListener.bind(this));
+        this.driver.on("close", this.onZiGateClose.bind(this));
+        this.driver.on("zdoResponse", this.onZdoResponse.bind(this));
+    }
+
+    /**
+     * Adapter methods
+     */
+    public async start(): Promise<TsType.StartResult> {
+        let startResult: TsType.StartResult = "resumed";
+        try {
+            await this.driver.open();
+            logger.info("Connected to ZiGate adapter successfully.", NS);
+
+            const resetResponse = await this.driver.sendCommand(ZiGateCommandCode.Reset, {}, 5000);
+            if (resetResponse.code === ZiGateMessageCode.RestartNonFactoryNew) {
+                startResult = "resumed";
+            } else if (resetResponse.code === ZiGateMessageCode.RestartFactoryNew) {
+                startResult = "reset";
+            }
+            await this.driver.sendCommand(ZiGateCommandCode.RawMode, {enabled: 0x01});
+            // @todo check
+            await this.driver.sendCommand(ZiGateCommandCode.SetDeviceType, {
+                deviceType: DeviceType.Coordinator,
+            });
+            await this.initNetwork();
+
+            await this.driver.sendCommand(ZiGateCommandCode.AddGroup, {
+                addressMode: AddressMode.Short,
+                shortAddress: ZSpec.COORDINATOR_ADDRESS,
+                sourceEndpoint: ZSpec.HA_ENDPOINT,
+                destinationEndpoint: ZSpec.HA_ENDPOINT,
+                groupAddress: default_bind_group,
+            });
+
+            if (this.adapterOptions.transmitPower != null) {
+                await this.driver.sendCommand(ZiGateCommandCode.SetTXpower, {value: this.adapterOptions.transmitPower});
+            }
+        } catch (error) {
+            throw new Error(`failed to connect to zigate adapter ${(error as Error).message}`);
+        }
+
+        return startResult; // 'resumed' | 'reset' | 'restored'
+    }
+
+    public async stop(): Promise<void> {
+        this.closing = true;
+        await this.driver.close();
+    }
+
+    public async getCoordinatorIEEE(): Promise<string> {
+        const networkResponse = await this.driver.sendCommand(ZiGateCommandCode.GetNetworkState);
+        return networkResponse.payload.extendedAddress;
+    }
+
+    public async getCoordinatorVersion(): Promise<TsType.CoordinatorVersion> {
+        const result = await this.driver.sendCommand(ZiGateCommandCode.GetVersion, {});
+        const meta = {
+            transportrev: 0,
+            product: 0,
+            majorrel: Number.parseInt(<string>result.payload.major, 10).toString(16),
+            minorrel: Number.parseInt(<string>result.payload.minor, 10).toString(16),
+            maintrel: Number.parseInt(<string>result.payload.revision, 10).toString(16),
+            revision: Number.parseInt(<string>result.payload.revision, 10).toString(16),
+        };
+
+        return {
+            type: "zigate",
+            meta: meta,
+        };
+    }
+
+    public async permitJoin(seconds: number, networkAddress?: number): Promise<void> {
+        const clusterId = Zdo.ClusterId.PERMIT_JOINING_REQUEST;
+
+        if (networkAddress !== undefined) {
+            // specific device that is not `Coordinator`
+            // `authentication`: TC significance always 1 (zb specs)
+            const zdoPayload = Zdo.Buffalo.buildRequest(this.hasZdoMessageOverhead, clusterId, seconds, 1, []);
+
+            const result = await this.sendZdo(ZSpec.BLANK_EUI64, networkAddress, clusterId, zdoPayload, false);
+
+            if (!Zdo.Buffalo.checkStatus<Zdo.ClusterId.PERMIT_JOINING_RESPONSE>(result)) {
+                // TODO: will disappear once moved upstream
+                throw new Zdo.StatusError(result[0]);
+            }
+        } else {
+            // broadcast permit joining ZDO
+            // `authentication`: TC significance always 1 (zb specs)
+            const zdoPayload = Zdo.Buffalo.buildRequest(this.hasZdoMessageOverhead, clusterId, seconds, 1, []);
+
+            await this.sendZdo(ZSpec.BLANK_EUI64, ZSpec.BroadcastAddress.DEFAULT, clusterId, zdoPayload, true);
+        }
+
+        this.joinPermitted = seconds !== 0;
+    }
+    public async addInstallCode(_ieeeAddress: string, _key: Buffer, _hashed: boolean): Promise<void> {
+        await Promise.reject(new Error("Add install code is not supported"));
+    }
+
+    public async reset(type: "soft" | "hard"): Promise<void> {
+        if (type === "soft") {
+            await this.driver.sendCommand(ZiGateCommandCode.Reset, {}, 5000);
+        } else if (type === "hard") {
+            await this.driver.sendCommand(ZiGateCommandCode.ErasePersistentData, {}, 5000);
+        }
+    }
+
+    public async getNetworkParameters(): Promise<TsType.NetworkParameters> {
+        try {
+            const result = await this.driver.sendCommand(ZiGateCommandCode.GetNetworkState, {}, 10000);
+
+            return {
+                panID: result.payload.PANID as number,
+                extendedPanID: result.payload.ExtPANID as string, // read as IEEEADDR, so `0x${string}`
+                channel: result.payload.Channel as number,
+                nwkUpdateID: 0 as number,
+            };
+        } catch (error) {
+            throw new Error(`Get network parameters failed ${error}`);
+        }
+    }
+
+    /**
+     * https://zigate.fr/documentation/deplacer-le-pdm-de-la-zigate/
+     * pdm from host
+     */
+    public async supportsBackup(): Promise<boolean> {
+        return await Promise.resolve(false);
+    }
+
+    public async backup(): Promise<Models.Backup> {
+        return await Promise.reject(new Error("This adapter does not support backup"));
+    }
+
+    public async sendZdo(
+        ieeeAddress: string,
+        networkAddress: number,
+        clusterId: Zdo.ClusterId,
+        payload: Buffer,
+        disableResponse: true,
+    ): Promise<void>;
+    public async sendZdo<K extends keyof ZdoTypes.RequestToResponseMap>(
+        ieeeAddress: string,
+        networkAddress: number,
+        clusterId: K,
+        payload: Buffer,
+        disableResponse: false,
+    ): Promise<ZdoTypes.RequestToResponseMap[K]>;
+    public async sendZdo<K extends keyof ZdoTypes.RequestToResponseMap>(
+        ieeeAddress: string,
+        networkAddress: number,
+        clusterId: K,
+        payload: Buffer,
+        disableResponse: boolean,
+    ): Promise<ZdoTypes.RequestToResponseMap[K] | undefined> {
+        return await this.queue.execute(async () => {
+            // stack-specific requirements
+            // https://zigate.fr/documentation/commandes-zigate/
+            switch (clusterId) {
+                case Zdo.ClusterId.LEAVE_REQUEST: {
+                    // extra zero for `removeChildren`
+                    const prefixedPayload = Buffer.alloc(payload.length + 1);
+                    prefixedPayload.set(payload, 0);
+
+                    payload = prefixedPayload;
+                    break;
+                }
+
+                case Zdo.ClusterId.BIND_REQUEST:
+                case Zdo.ClusterId.UNBIND_REQUEST: {
+                    // only need adjusting when Zdo.MULTICAST_BINDING
+                    if (payload.length === 14) {
+                        // extra zero for `endpoint`
+                        const prefixedPayload = Buffer.alloc(payload.length + 1);
+                        prefixedPayload.set(payload, 0);
+
+                        payload = prefixedPayload;
+                    }
+
+                    break;
+                }
+
+                case Zdo.ClusterId.PERMIT_JOINING_REQUEST:
+                case Zdo.ClusterId.SYSTEM_SERVER_DISCOVERY_REQUEST:
+                case Zdo.ClusterId.LQI_TABLE_REQUEST:
+                case Zdo.ClusterId.ROUTING_TABLE_REQUEST:
+                case Zdo.ClusterId.BINDING_TABLE_REQUEST:
+                case Zdo.ClusterId.NWK_UPDATE_REQUEST: {
+                    const prefixedPayload = Buffer.alloc(payload.length + 2);
+                    prefixedPayload.writeUInt16BE(networkAddress, 0);
+                    prefixedPayload.set(payload, 2);
+
+                    payload = prefixedPayload;
+                    break;
+                }
+            }
+
+            let waiter: ReturnType<typeof this.driver.zdoWaitFor> | undefined;
+
+            if (!disableResponse) {
+                const responseClusterId = Zdo.Utils.getResponseClusterId(clusterId);
+
+                if (responseClusterId) {
+                    waiter = this.driver.zdoWaitFor({
+                        clusterId: responseClusterId,
+                        target:
+                            responseClusterId === Zdo.ClusterId.NETWORK_ADDRESS_RESPONSE || responseClusterId === Zdo.ClusterId.LEAVE_RESPONSE
+                                ? ieeeAddress
+                                : networkAddress,
+                    });
+                }
+            }
+
+            await this.driver.requestZdo(clusterId, payload);
+
+            if (waiter) {
+                const result = await waiter.start().promise;
+
+                return result.zdo as ZdoTypes.RequestToResponseMap[K];
+            }
+        }, networkAddress);
+    }
+
+    public async sendZclFrameToEndpoint(
+        ieeeAddr: string,
+        networkAddress: number,
+        endpoint: number,
+        zclFrame: Zcl.Frame,
+        timeout: number,
+        disableResponse: boolean,
+        disableRecovery: boolean,
+        sourceEndpoint?: number,
+        profileId?: number,
+    ): Promise<Events.ZclPayload | undefined> {
+        return await this.queue.execute<Events.ZclPayload | undefined>(async () => {
+            return await this.sendZclFrameToEndpointInternal(
+                ieeeAddr,
+                networkAddress,
+                endpoint,
+                sourceEndpoint || 1,
+                zclFrame,
+                timeout,
+                disableResponse,
+                disableRecovery,
+                0,
+                0,
+                false,
+                false,
+                profileId,
+            );
+        }, networkAddress);
+    }
+
+    private async sendZclFrameToEndpointInternal(
+        ieeeAddr: string | undefined,
+        networkAddress: number,
+        endpoint: number,
+        sourceEndpoint: number,
+        zclFrame: Zcl.Frame,
+        timeout: number,
+        disableResponse: boolean,
+        disableRecovery: boolean,
+        responseAttempt: number,
+        dataRequestAttempt: number,
+        checkedNetworkAddress: boolean,
+        discoveredRoute: boolean,
+        profileId?: number,
+    ): Promise<Events.ZclPayload | undefined> {
+        logger.debug(
+            `sendZclFrameToEndpointInternal ${ieeeAddr}:${networkAddress}/${endpoint} (${responseAttempt},${dataRequestAttempt},${this.queue.count()})`,
+            NS,
+        );
+        let response = null;
+
+        const data = zclFrame.toBuffer();
+        const command = zclFrame.command;
+        const payload: RawAPSDataRequestPayload = {
+            addressMode: AddressMode.Short, //nwk
+            targetShortAddress: networkAddress,
+            sourceEndpoint: sourceEndpoint || ZSpec.HA_ENDPOINT,
+            destinationEndpoint: endpoint,
+            profileID: profileId ?? ZSpec.HA_PROFILE_ID,
+            clusterID: zclFrame.cluster.ID,
+            securityMode: 0x02,
+            radius: 30,
+            dataLength: data.length,
+            data: data,
+        };
+
+        if (command.response !== undefined && disableResponse === false) {
+            response = this.waitFor(
+                networkAddress,
+                endpoint,
+                zclFrame.header.frameControl.frameType,
+                Zcl.Direction.SERVER_TO_CLIENT,
+                zclFrame.header.transactionSequenceNumber,
+                zclFrame.cluster.ID,
+                command.response,
+                timeout,
+            );
+        } else if (!zclFrame.header.frameControl.disableDefaultResponse) {
+            response = this.waitFor(
+                networkAddress,
+                endpoint,
+                Zcl.FrameType.GLOBAL,
+                Zcl.Direction.SERVER_TO_CLIENT,
+                zclFrame.header.transactionSequenceNumber,
+                zclFrame.cluster.ID,
+                Zcl.Foundation.defaultRsp.ID,
+                timeout,
+            );
+        }
+
+        try {
+            await this.driver.sendCommand(ZiGateCommandCode.RawAPSDataRequest, payload, undefined, {}, disableResponse);
+        } catch {
+            if (responseAttempt < 1 && !disableRecovery) {
+                // @todo discover route
+                return await this.sendZclFrameToEndpointInternal(
+                    ieeeAddr,
+                    networkAddress,
+                    endpoint,
+                    sourceEndpoint,
+                    zclFrame,
+                    timeout,
+                    disableResponse,
+                    disableRecovery,
+                    responseAttempt + 1,
+                    dataRequestAttempt,
+                    checkedNetworkAddress,
+                    discoveredRoute,
+                );
+            }
+        }
+
+        // @TODO add dataConfirmResult
+        // @TODO if error codes route / no_resourses wait and resend
+        if (response !== null) {
+            try {
+                return await response.promise;
+
+                // @todo discover route
+            } catch (error) {
+                logger.error(`Response error ${(error as Error).message} (${ieeeAddr}:${networkAddress},${responseAttempt})`, NS);
+                if (responseAttempt < 1 && !disableRecovery) {
+                    return await this.sendZclFrameToEndpointInternal(
+                        ieeeAddr,
+                        networkAddress,
+                        endpoint,
+                        sourceEndpoint,
+                        zclFrame,
+                        timeout,
+                        disableResponse,
+                        disableRecovery,
+                        responseAttempt + 1,
+                        dataRequestAttempt,
+                        checkedNetworkAddress,
+                        discoveredRoute,
+                    );
+                }
+
+                throw error;
+            }
+        }
+    }
+
+    public async sendZclFrameToAll(
+        endpoint: number,
+        zclFrame: Zcl.Frame,
+        sourceEndpoint: number,
+        destination: BroadcastAddress,
+        profileId?: number,
+    ): Promise<void> {
+        return await this.queue.execute<void>(async () => {
+            if (sourceEndpoint !== 0x01 /*&& sourceEndpoint !== 242*/) {
+                // @todo on zigate firmware without gp causes hang
+                logger.error(`source endpoint ${sourceEndpoint}, not supported`, NS);
+                return;
+            }
+
+            const data = zclFrame.toBuffer();
+            const payload: RawAPSDataRequestPayload = {
+                addressMode: AddressMode.Short, //nwk
+                targetShortAddress: destination,
+                sourceEndpoint: sourceEndpoint,
+                destinationEndpoint: endpoint,
+                profileID: profileId ?? ZSpec.HA_PROFILE_ID,
+                clusterID: zclFrame.cluster.ID,
+                securityMode: 0x02,
+                radius: 30,
+                dataLength: data.length,
+                data: data,
+            };
+            logger.debug(() => `sendZclFrameToAll ${JSON.stringify(payload)}`, NS);
+
+            await this.driver.sendCommand(ZiGateCommandCode.RawAPSDataRequest, payload, undefined, {}, true);
+            await wait(200);
+        });
+    }
+
+    public async sendZclFrameToGroup(groupID: number, zclFrame: Zcl.Frame, sourceEndpoint?: number, profileId?: number): Promise<void> {
+        return await this.queue.execute<void>(async () => {
+            const data = zclFrame.toBuffer();
+            const payload: RawAPSDataRequestPayload = {
+                addressMode: AddressMode.Group, //nwk
+                targetShortAddress: groupID,
+                sourceEndpoint: sourceEndpoint || ZSpec.HA_ENDPOINT,
+                destinationEndpoint: 0xff,
+                profileID: profileId ?? ZSpec.HA_PROFILE_ID,
+                clusterID: zclFrame.cluster.ID,
+                securityMode: 0x02,
+                radius: 30,
+                dataLength: data.length,
+                data: data,
+            };
+
+            await this.driver.sendCommand(ZiGateCommandCode.RawAPSDataRequest, payload, undefined, {}, true);
+            await wait(200);
+        });
+    }
+
+    /**
+     * Supplementary functions
+     */
+    private async initNetwork(): Promise<void> {
+        logger.debug(`Set channel mask ${this.networkOptions.channelList} key`, NS);
+        await this.driver.sendCommand(ZiGateCommandCode.SetChannelMask, {
+            channelMask: ZSpec.Utils.channelsToUInt32Mask(this.networkOptions.channelList),
+        });
+
+        logger.debug("Set security key", NS);
+        await this.driver.sendCommand(ZiGateCommandCode.SetSecurityStateKey, {
+            keyType: this.networkOptions.networkKeyDistribute
+                ? ZPSNwkKeyState.ZPS_ZDO_DISTRIBUTED_LINK_KEY
+                : ZPSNwkKeyState.ZPS_ZDO_PRECONFIGURED_LINK_KEY,
+            key: this.networkOptions.networkKey,
+        });
+
+        try {
+            // The block is wrapped in trapping because if the network is already created, the firmware does not accept the new key.
+            logger.debug(
+                `Set EPanID ${
+                    // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
+                    this.networkOptions.extendedPanID!.toString()
+                }`,
+                NS,
+            );
+            await this.driver.sendCommand(ZiGateCommandCode.SetExtendedPANID, {
+                panId: this.networkOptions.extendedPanID,
+            });
+
+            await this.driver.sendCommand(ZiGateCommandCode.StartNetwork, {});
+        } catch (error) {
+            // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
+            logger.error((error as Error).stack!, NS);
+        }
+    }
+
+    public waitFor(
+        networkAddress: number | undefined,
+        endpoint: number,
+        frameType: Zcl.FrameType,
+        direction: Zcl.Direction,
+        transactionSequenceNumber: number | undefined,
+        clusterID: number,
+        commandIdentifier: number,
+        timeout: number,
+    ): {promise: Promise<Events.ZclPayload>; cancel: () => void} {
+        const payload = {
+            address: networkAddress,
+            endpoint,
+            clusterID,
+            commandIdentifier,
+            frameType,
+            direction,
+            transactionSequenceNumber,
+        };
+        const waiter = this.waitress.waitFor(payload, timeout);
+        const cancel = (): void => this.waitress.remove(waiter.ID);
+        return {promise: waiter.start().promise, cancel};
+    }
+
+    /**
+     * InterPAN !!! not implemented
+     */
+    public async setChannelInterPAN(_channel: number): Promise<void> {
+        await Promise.reject(new Error("Not supported"));
+    }
+    public async sendZclFrameInterPANToIeeeAddr(_zclFrame: Zcl.Frame, _ieeeAddress: string): Promise<void> {
+        await Promise.reject(new Error("Not supported"));
+    }
+    public async sendZclFrameInterPANBroadcast(zclFrame: Zcl.Frame, timeout: number, disableResponse: false): Promise<Events.ZclPayload>;
+    public async sendZclFrameInterPANBroadcast(zclFrame: Zcl.Frame, timeout: number, disableResponse: true): Promise<undefined>;
+    public async sendZclFrameInterPANBroadcast(
+        _zclFrame: Zcl.Frame,
+        _timeout: number,
+        _disableResponse: boolean,
+    ): Promise<Events.ZclPayload | undefined> {
+        return await Promise.reject(new Error("Not supported"));
+    }
+
+    public async restoreChannelInterPAN(): Promise<void> {
+        await Promise.reject(new Error("Not supported"));
+    }
+
+    private deviceAnnounceListener(response: ZdoTypes.EndDeviceAnnounce): void {
+        // @todo debounce
+        if (this.joinPermitted === true) {
+            this.emit("deviceJoined", {networkAddress: response.nwkAddress, ieeeAddr: response.eui64});
+        } else {
+            // convert to `zdoResponse` to avoid needing extra event upstream
+            this.emit("zdoResponse", Zdo.ClusterId.END_DEVICE_ANNOUNCE, [Zdo.Status.SUCCESS, response]);
+        }
+    }
+
+    private onZdoResponse(clusterId: Zdo.ClusterId, response: ZdoTypes.GenericZdoResponse): void {
+        this.emit("zdoResponse", clusterId, response);
+    }
+
+    private dataListener(ziGateObject: ZiGateObject): void {
+        const payload: Events.ZclPayload = {
+            address: <number>ziGateObject.payload.sourceAddress,
+            clusterID: ziGateObject.payload.clusterID,
+            data: ziGateObject.payload.payload,
+            header: Zcl.Header.fromBuffer(ziGateObject.payload.payload),
+            endpoint: <number>ziGateObject.payload.sourceEndpoint,
+            // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
+            linkquality: ziGateObject.frame!.readRSSI(), // read: frame valid
+            groupID: 0, // @todo
+            wasBroadcast: false, // TODO
+            destinationEndpoint: <number>ziGateObject.payload.destinationEndpoint,
+        };
+        this.waitress.resolve(payload);
+        this.emit("zclPayload", payload);
+    }
+
+    private leaveIndicationListener(ziGateObject: ZiGateObject): void {
+        logger.debug(() => `LeaveIndication ${JSON.stringify(ziGateObject)}`, NS);
+        const payload: Events.DeviceLeavePayload = {
+            networkAddress: <number>ziGateObject.payload.extendedAddress,
+            ieeeAddr: <string>ziGateObject.payload.extendedAddress,
+        };
+        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");
+        }
+    }
+}

package/src/adapter/zigate/driver/LICENSE

@@ -0,0 +1,17 @@
+When writing the adapter, the first tests and code implementation examples were taken from
+https://github.com/nouknouk/node-zigate
+https://github.com/Neonox31/zigate
+
+
+The zigate frame parsing is mostly inherited from Neonox31/zigate
+driver/frame.ts
+
+Copyright 2017 WEBER Logan <weberlogan@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+