@willieee802/zigbee-herdsman 0.48.2 → 0.49.0

package/src/controller/controller.ts

@@ -0,0 +1,1159 @@
+import assert from "node:assert";
+import events from "node:events";
+import fs from "node:fs";
+import {Adapter, type Events as AdapterEvents, type TsType as AdapterTsType} from "../adapter";
+import type {ZclPayload} from "../adapter/events";
+import {BackupUtils, wait} from "../utils";
+import {logger} from "../utils/logger";
+import {isNumberArrayOfLength} from "../utils/utils";
+import * as ZSpec from "../zspec";
+import type {Eui64} from "../zspec/tstypes";
+import * as Zcl from "../zspec/zcl";
+import type {TPartialClusterAttributes} from "../zspec/zcl/definition/clusters-types";
+import type {CustomClusters, FrameControl} from "../zspec/zcl/definition/tstype";
+import * as Zdo from "../zspec/zdo";
+import type * as ZdoTypes from "../zspec/zdo/definition/tstypes";
+import Database from "./database";
+import type * as Events from "./events";
+import GreenPower from "./greenPower";
+import {ZclFrameConverter} from "./helpers";
+import {checkInstallCode, parseInstallCode} from "./helpers/installCodes";
+import zclTransactionSequenceNumber from "./helpers/zclTransactionSequenceNumber";
+import {Device, Entity} from "./model";
+import {InterviewState} from "./model/device";
+import Group from "./model/group";
+import Touchlink from "./touchlink";
+import type {DeviceType, GreenPowerDeviceJoinedPayload, RawPayload} from "./tstype";
+import {KonnextConfig} from "./model/konnextConfig";
+
+const NS = "zh:controller";
+
+interface Options {
+    network: AdapterTsType.NetworkOptions;
+    serialPort: AdapterTsType.SerialPortOptions;
+    databasePath: string;
+    databaseBackupPath: string;
+    backupPath: string;
+    adapter: AdapterTsType.AdapterOptions;
+    konnextConfig: KonnextConfig;
+    /**
+     * This lambda can be used by an application to explictly reject or accept an incoming device.
+     * When false is returned zigbee-herdsman will not start the interview process and immidiately
+     * try to remove the device from the network.
+     */
+    acceptJoiningDeviceHandler: (ieeeAddr: string) => Promise<boolean>;
+}
+
+export interface ControllerEventMap {
+    message: [data: Events.MessagePayload];
+    adapterDisconnected: [];
+    deviceJoined: [data: Events.DeviceJoinedPayload];
+    deviceInterview: [data: Events.DeviceInterviewPayload];
+    deviceAnnounce: [data: Events.DeviceAnnouncePayload];
+    deviceNetworkAddressChanged: [data: Events.DeviceNetworkAddressChangedPayload];
+    deviceLeave: [data: Events.DeviceLeavePayload];
+    permitJoinChanged: [data: Events.PermitJoinChangedPayload];
+    lastSeenChanged: [data: Events.LastSeenChangedPayload];
+}
+
+/**
+ * @noInheritDoc
+ */
+export class Controller extends events.EventEmitter<ControllerEventMap> {
+    private options: Options;
+    private database!: Database;
+    private adapter!: Adapter;
+    #greenPower!: GreenPower;
+    #touchlink!: Touchlink;
+
+    private permitJoinTimer: NodeJS.Timeout | undefined;
+    private permitJoinEnd?: number;
+    private backupTimer: NodeJS.Timeout | undefined;
+    private databaseSaveTimer: NodeJS.Timeout | undefined;
+    private stopping: boolean;
+    private adapterDisconnected: boolean;
+    private networkParametersCached: AdapterTsType.NetworkParameters | undefined;
+    /** List of unknown devices detected during a single runtime session. Serves as de-dupe and anti-spam. */
+    private unknownDevices: Set<number>;
+
+    /**
+     * Create a controller
+     *
+     * To auto detect the port provide `null` for `options.serialPort.path`
+     */
+    public constructor(options: Options) {
+        super();
+        this.stopping = false;
+        this.adapterDisconnected = true; // set false after adapter.start() is successfully called
+        const {network: networkOpts, serialPort: serialPortOpts, adapter: adapterOpts, konnextConfig: konnextConfigOpts, ...restOpts} = options;
+        this.options = {
+            network: {
+                networkKeyDistribute: false,
+                networkKey: [0x01, 0x03, 0x05, 0x07, 0x09, 0x0b, 0x0d, 0x0f, 0x00, 0x02, 0x04, 0x06, 0x08, 0x0a, 0x0c, 0x0d],
+                extendedPanID: [0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd],
+                ...networkOpts,
+            },
+            serialPort: {...serialPortOpts},
+            adapter: {
+                ...adapterOpts,
+            },
+            konnextConfig: {
+                // @ts-ignore-next-line we need to set a default value for isEncrypted
+                isEncrypted: 0,
+                ...konnextConfigOpts,
+            },
+            ...restOpts,
+        };
+        this.unknownDevices = new Set();
+
+        // Validate options
+        for (const channel of this.options.network.channelList) {
+            if (channel < 11 || channel > 26) {
+                throw new Error(`'${channel}' is an invalid channel, use a channel between 11 - 26.`);
+            }
+        }
+
+        if (!isNumberArrayOfLength(this.options.network.networkKey, 16)) {
+            throw new Error(`Network key must be a 16 digits long array, got ${this.options.network.networkKey}.`);
+        }
+
+        if (!isNumberArrayOfLength(this.options.network.extendedPanID, 8)) {
+            throw new Error(`ExtendedPanID must be an 8 digits long array, got ${this.options.network.extendedPanID}.`);
+        }
+
+        if (this.options.network.panID < 1 || this.options.network.panID >= 0xffff) {
+            throw new Error(`PanID must have a value of 0x0001 (1) - 0xFFFE (65534), got ${this.options.network.panID}.`);
+        }
+    }
+
+    get greenPower() {
+        return this.#greenPower;
+    }
+
+    get touchlink() {
+        return this.#touchlink;
+    }
+
+    /**
+     * Start the Herdsman controller
+     */
+    public async start(abortSignal?: AbortSignal): Promise<AdapterTsType.StartResult> {
+        // Database (create end inject)
+        this.database = Database.open(this.options.databasePath);
+        Entity.injectDatabase(this.database);
+
+        // Adapter (create and inject)
+        this.adapter = await Adapter.create(this.options.network, this.options.serialPort, this.options.backupPath, this.options.adapter, this.options.konnextConfig);
+
+        abortSignal?.throwIfAborted();
+
+        const stringifiedOptions = JSON.stringify(this.options).replaceAll(JSON.stringify(this.options.network.networkKey), '"HIDDEN"');
+        logger.debug(`Starting with options '${stringifiedOptions}'`, NS);
+        const startResult = await this.adapter.start();
+        logger.debug(`Started with result '${startResult}'`, NS);
+        this.adapterDisconnected = false;
+
+        abortSignal?.throwIfAborted();
+
+        // Check if we have to change the channel, only do this when adapter `resumed` because:
+        // - `getNetworkParameters` might be return wrong info because it needs to propogate after backup restore
+        // - If result is not `resumed` (`reset` or `restored`), the adapter should comission with the channel from `this.options.network`
+        if (startResult === "resumed") {
+            const netParams = await this.getNetworkParameters();
+            const configuredChannel = this.options.network.channelList[0];
+            const adapterChannel = netParams.channel;
+            const nwkUpdateID = netParams.nwkUpdateID;
+
+            if (configuredChannel !== adapterChannel) {
+                logger.info(`Configured channel '${configuredChannel}' does not match adapter channel '${adapterChannel}', changing channel`, NS);
+                await this.changeChannel(adapterChannel, configuredChannel, nwkUpdateID);
+
+                abortSignal?.throwIfAborted();
+            }
+        }
+
+        Entity.injectAdapter(this.database.id, this.adapter);
+
+        // log injection
+        logger.debug(`Injected database: ${this.database !== undefined}, adapter: ${this.adapter !== undefined}`, NS);
+
+        this.#greenPower = new GreenPower(this.adapter, this.database.id);
+        this.#greenPower.on("deviceJoined", this.onDeviceJoinedGreenPower.bind(this));
+        this.#greenPower.on("deviceLeave", this.onDeviceLeaveGreenPower.bind(this));
+
+        // Register adapter events
+        this.adapter.on("deviceJoined", this.onDeviceJoined.bind(this));
+        this.adapter.on("zclPayload", this.onZclPayload.bind(this));
+        this.adapter.on("zdoResponse", this.onZdoResponse.bind(this));
+        this.adapter.on("disconnected", this.onAdapterDisconnected.bind(this));
+        this.adapter.on("deviceLeave", this.onDeviceLeave.bind(this));
+
+        if (startResult === "reset") {
+            if (this.options.databaseBackupPath && fs.existsSync(this.options.databasePath)) {
+                fs.copyFileSync(this.options.databasePath, this.options.databaseBackupPath);
+            }
+
+            this.database.clear();
+            Group.resetCache();
+            Device.resetCache();
+
+            abortSignal?.throwIfAborted();
+        }
+
+        if (startResult === "reset" || (this.options.backupPath && !fs.existsSync(this.options.backupPath))) {
+            await this.backup();
+
+            abortSignal?.throwIfAborted();
+        }
+
+        // Add coordinator to the database if it is not there yet.
+        const coordinatorIEEE = await this.adapter.getCoordinatorIEEE();
+
+        if (Device.byType(this.database.id, "Coordinator").length === 0) {
+            logger.debug("No coordinator in database, querying...", NS);
+            const coordinator = Device.create(
+                "Coordinator",
+                coordinatorIEEE,
+                ZSpec.COORDINATOR_ADDRESS,
+                this.adapter.manufacturerID,
+                undefined,
+                undefined,
+                undefined,
+                InterviewState.Successful,
+                undefined,
+                this.database.id,
+            );
+
+            await coordinator.updateActiveEndpoints();
+
+            abortSignal?.throwIfAborted();
+
+            for (const endpoint of coordinator.endpoints) {
+                await endpoint.updateSimpleDescriptor();
+
+                abortSignal?.throwIfAborted();
+            }
+
+            coordinator.save();
+        }
+
+        // Update coordinator ieeeAddr if changed, can happen due to e.g. reflashing
+        const databaseCoordinator = Device.byType(this.database.id, "Coordinator")[0];
+        if (databaseCoordinator.ieeeAddr !== coordinatorIEEE) {
+            logger.info(`Coordinator address changed, updating to '${coordinatorIEEE}'`, NS);
+            databaseCoordinator.changeIeeeAddress(coordinatorIEEE);
+        }
+
+        // Set backup timer to 1 day.
+        this.backupTimer = setInterval(() => this.backup(), 86400000);
+
+        // Set database save timer to 5 minutes.
+        this.databaseSaveTimer = setInterval(() => this.databaseSave(), 300000);
+
+        this.#touchlink = new Touchlink(this.adapter);
+
+        return startResult;
+    }
+
+    /**
+     * Send a request according to given payload.
+     * @param rawPayload Payload used to determine and build the request
+     * @param customClusters Manually passed custom clusters used in ZCL serialization (if any, if matching)
+     * @returns A response may or may not be returned depending on given payload (up to caller to verify)
+     */
+    public async sendRaw(rawPayload: RawPayload, customClusters: CustomClusters = {}): Promise<ZdoTypes.GenericZdoResponse | ZclPayload | undefined> {
+        const {
+            ieeeAddress,
+            networkAddress,
+            groupId,
+            dstEndpoint,
+            srcEndpoint = ZSpec.HA_ENDPOINT,
+            interPan = false,
+            profileId = ZSpec.HA_PROFILE_ID,
+            clusterKey,
+            zdoParams,
+            zcl,
+            disableResponse = false,
+            timeout = 10000,
+        } = rawPayload;
+
+        if (profileId === Zdo.ZDO_PROFILE_ID) {
+            assert(ieeeAddress);
+            assert(networkAddress !== undefined);
+            assert(clusterKey !== undefined && typeof clusterKey === "number");
+            // no ZDO request takes 0 params
+            assert(Array.isArray(zdoParams) && zdoParams.length > 0);
+
+            // will fail if args are incorrect for request
+            const buf = Zdo.Buffalo.buildRequest(this.adapter.hasZdoMessageOverhead, clusterKey, ...zdoParams);
+
+            return (await this.adapter.sendZdo(ieeeAddress, networkAddress, clusterKey, buf, disableResponse)) as ZdoTypes.GenericZdoResponse;
+        }
+
+        assert(zcl);
+
+        if (interPan) {
+            assert(zcl.commandKey);
+            assert(zcl.payload);
+            assert(zcl.frameType === undefined);
+            assert(zcl.direction === undefined);
+
+            const zclFrame = Zcl.Frame.create(
+                zcl.frameType ?? Zcl.FrameType.SPECIFIC,
+                zcl.direction ?? Zcl.Direction.CLIENT_TO_SERVER,
+                true,
+                zcl.manufacturerCode,
+                0,
+                zcl.commandKey,
+                clusterKey ?? Zcl.Clusters.touchlink.ID,
+                zcl.payload,
+                customClusters,
+            );
+
+            if (ieeeAddress) {
+                await this.adapter.sendZclFrameInterPANToIeeeAddr(zclFrame, ieeeAddress);
+                return;
+            }
+
+            return await this.adapter.sendZclFrameInterPANBroadcast(zclFrame, timeout, disableResponse);
+        }
+
+        assert(clusterKey !== undefined);
+        assert(zcl.frameType !== undefined);
+        assert(zcl.direction !== undefined);
+
+        const zclFrame = Zcl.Frame.create(
+            zcl.frameType,
+            zcl.direction,
+            zcl.disableDefaultResponse ?? false,
+            zcl.manufacturerCode,
+            zcl.tsn ?? zclTransactionSequenceNumber.next(),
+            zcl.commandKey,
+            clusterKey,
+            zcl.payload,
+            customClusters,
+        );
+
+        if (groupId !== undefined) {
+            assert(groupId >= 0x0000 && groupId <= 0xffff);
+
+            await this.adapter.sendZclFrameToGroup(groupId, zclFrame, srcEndpoint, profileId);
+            return;
+        }
+
+        assert(dstEndpoint !== undefined && dstEndpoint >= 0x01 && dstEndpoint <= 0xff);
+        assert(srcEndpoint >= 0x01 && srcEndpoint <= 0xff);
+        assert(networkAddress !== undefined && networkAddress >= 0x0000 && networkAddress <= 0xffff);
+
+        if (networkAddress >= ZSpec.BROADCAST_MIN) {
+            await this.adapter.sendZclFrameToAll(dstEndpoint, zclFrame, srcEndpoint, networkAddress, profileId);
+            return;
+        }
+
+        assert(ieeeAddress);
+
+        return await this.adapter.sendZclFrameToEndpoint(
+            ieeeAddress,
+            networkAddress,
+            dstEndpoint,
+            zclFrame,
+            timeout,
+            disableResponse,
+            false,
+            srcEndpoint,
+            profileId,
+        );
+    }
+
+    public async addInstallCode(installCode: string): Promise<void> {
+        // will throw if code cannot be parsed
+        const [ieeeAddr, keyStr] = parseInstallCode(installCode);
+        // biome-ignore lint/style/noNonNullAssertion: valid from above parsing
+        const key = Buffer.from(keyStr.match(/.{1,2}/g)!.map((d) => Number.parseInt(d, 16)));
+        // will throw if code cannot be fixed and is invalid
+        const [adjustedKey, adjusted] = checkInstallCode(key, true);
+
+        if (adjusted) {
+            logger.info(`Install code was adjusted for reason '${adjusted}'.`, NS);
+        }
+
+        logger.info(`Adding install code for ${ieeeAddr}.`, NS);
+
+        await this.adapter.addInstallCode(ieeeAddr, adjustedKey, false);
+
+        if (adjusted === "missing CRC") {
+            // in case the CRC was missing, could also be a "already-hashed" key, send both
+            // XXX: seems to be the case for old HA1.2 devices
+            await this.adapter.addInstallCode(ieeeAddr, key, true);
+        }
+    }
+
+    public async permitJoin(time: number, device?: Device): Promise<void> {
+        clearTimeout(this.permitJoinTimer);
+        this.permitJoinTimer = undefined;
+        this.permitJoinEnd = undefined;
+
+        if (time > 0) {
+            // never permit more than uint8, and never permit 255 that is often equal to "forever"
+            assert(time <= 254, "Cannot permit join for more than 254 seconds.");
+
+            await this.adapter.permitJoin(time, device?.networkAddress);
+            await this.#greenPower.permitJoin(time, device?.networkAddress);
+
+            const timeMs = time * 1000;
+            this.permitJoinEnd = Date.now() + timeMs;
+            this.permitJoinTimer = setTimeout((): void => {
+                this.emit("permitJoinChanged", {permitted: false});
+
+                this.permitJoinTimer = undefined;
+                this.permitJoinEnd = undefined;
+            }, timeMs);
+
+            this.emit("permitJoinChanged", {permitted: true, time});
+        } else {
+            logger.debug("Disable joining", NS);
+
+            await this.#greenPower.permitJoin(0);
+            await this.adapter.permitJoin(0);
+
+            this.emit("permitJoinChanged", {permitted: false});
+        }
+    }
+
+    public getPermitJoin(): boolean {
+        return this.permitJoinTimer !== undefined;
+    }
+
+    public getPermitJoinEnd(): number | undefined {
+        return this.permitJoinEnd;
+    }
+
+    public isStopping(): boolean {
+        return this.stopping;
+    }
+
+    public isAdapterDisconnected(): boolean {
+        return this.adapterDisconnected;
+    }
+
+    public async stop(): Promise<void> {
+        this.stopping = true;
+
+        // Unregister adapter events
+        this.adapter.removeAllListeners();
+
+        clearInterval(this.backupTimer);
+        clearInterval(this.databaseSaveTimer);
+
+        if (this.adapterDisconnected) {
+            this.databaseSave();
+        } else {
+            try {
+                await this.#touchlink.stop();
+            } catch (error) {
+                logger.error(`Failed to stop Touchlink: ${error}`, NS);
+            }
+
+            try {
+                await this.permitJoin(0);
+            } catch (error) {
+                logger.error(`Failed to disable join on stop: ${error}`, NS);
+            }
+
+            await this.backup(); // always calls databaseSave()
+            await this.adapter.stop();
+
+            this.adapterDisconnected = true;
+        }
+
+        Device.resetCache();
+        Group.resetCache();
+        Entity.removeAdapter(this.database.id);
+        Entity.removeDatabase(this.database.id);
+    }
+
+    private databaseSave(): void {
+        for (const device of Device.allIterator(this.database.id)) {
+            device.save(false);
+        }
+
+        for (const group of Group.allIterator(this.database.id)) {
+            group.save(false);
+        }
+
+        this.database.write();
+    }
+
+    public async backup(): Promise<void> {
+        this.databaseSave();
+        if (this.options.backupPath && (await this.adapter.supportsBackup())) {
+            logger.debug("Creating coordinator backup", NS);
+            const backup = await this.adapter.backup(this.getDeviceIeeeAddresses());
+            const unifiedBackup = BackupUtils.toUnifiedBackup(backup);
+            const tmpBackupPath = `${this.options.backupPath}.tmp`;
+            fs.writeFileSync(tmpBackupPath, JSON.stringify(unifiedBackup, null, 2));
+            fs.renameSync(tmpBackupPath, this.options.backupPath);
+            logger.info(`Wrote coordinator backup to '${this.options.backupPath}'`, NS);
+        }
+    }
+
+    public async coordinatorCheck(): Promise<{missingRouters: Device[]}> {
+        if (await this.adapter.supportsBackup()) {
+            const backup = await this.adapter.backup(this.getDeviceIeeeAddresses());
+            const devicesInBackup = backup.devices.map((d) => ZSpec.Utils.eui64BEBufferToHex(d.ieeeAddress));
+            const missingRouters = [];
+
+            for (const device of this.getDevicesIterator((d) => d.type === "Router" && !devicesInBackup.includes(d.ieeeAddr as Eui64))) {
+                missingRouters.push(device);
+            }
+
+            return {missingRouters};
+        }
+
+        throw new Error("Coordinator does not coordinator check because it doesn't support backups");
+    }
+
+    public async reset(type: "soft" | "hard"): Promise<void> {
+        await this.adapter.reset(type);
+    }
+
+    public async getCoordinatorVersion(): Promise<AdapterTsType.CoordinatorVersion> {
+        return await this.adapter.getCoordinatorVersion();
+    }
+
+    public async getNetworkParameters(): Promise<AdapterTsType.NetworkParameters> {
+        // Cache network parameters as they don't change anymore after start.
+        if (!this.networkParametersCached) {
+            this.networkParametersCached = await this.adapter.getNetworkParameters();
+        }
+
+        return this.networkParametersCached;
+    }
+
+    /**
+     * Get the database ID for this controller's database.
+     */
+    public getDatabaseId(): number {
+        return this.database.id;
+    }
+
+    /**
+     * Get all devices
+     * @deprecated use getDevicesIterator()
+     */
+    public getDevices(): Device[] {
+        return Device.allByDatabaseID(this.database.id);
+    }
+
+    /**
+     * Get iterator for all devices
+     */
+    public getDevicesIterator(predicate?: (value: Device) => boolean): Generator<Device> {
+        return Device.allIterator(this.database.id, predicate);
+    }
+
+    /**
+     * Get all devices with a specific type
+     */
+    public getDevicesByType(type: DeviceType): Device[] {
+        return Device.byType(this.database.id, type);
+    }
+
+    /**
+     * Get device by ieeeAddr
+     */
+    public getDeviceByIeeeAddr(ieeeAddr: string): Device | undefined {
+        return Device.byIeeeAddr(this.database.id, ieeeAddr);
+    }
+
+    /**
+     * Get device by networkAddress
+     */
+    public getDeviceByNetworkAddress(networkAddress: number): Device | undefined {
+        return Device.byNetworkAddress(this.database.id, networkAddress);
+    }
+
+    /**
+     * Get IEEE address for all devices
+     */
+    public getDeviceIeeeAddresses(): string[] {
+        const deviceIeeeAddresses = [];
+
+        for (const device of Device.allIterator(this.database.id)) {
+            deviceIeeeAddresses.push(device.ieeeAddr);
+        }
+
+        return deviceIeeeAddresses;
+    }
+
+    /**
+     * Get group by ID
+     */
+    public getGroupByID(groupID: number): Group | undefined {
+        return Group.byGroupID(groupID, this.database.id);
+    }
+
+    /**
+     * Get all groups
+     * @deprecated use getGroupsIterator()
+     */
+    public getGroups(): Group[] {
+        return Group.allByDatabaseID(this.database.id);
+    }
+
+    /**
+     * Get iterator for all groups
+     */
+    public getGroupsIterator(predicate?: (value: Group) => boolean): Generator<Group> {
+        return Group.allIterator(this.database.id, predicate);
+    }
+
+    /**
+     * Create a Group
+     */
+    public createGroup(groupID: number): Group {
+        return Group.create(groupID, this.database.id);
+    }
+
+    /**
+     * Broadcast a network-wide channel change.
+     */
+    private async changeChannel(oldChannel: number, newChannel: number, nwkUpdateID: number): Promise<void> {
+        logger.warning(`Changing channel from '${oldChannel}' to '${newChannel}'`, NS);
+
+        // According to the Zigbee specification:
+        // When broadcasting a Mgmt_NWK_Update_req to notify devices of a new channel, the nwkUpdateId parameter should be incremented in the NIB and included in the Mgmt_NWK_Update_req.
+        // The valid range of nwkUpdateId is 0x00 to 0xFF, and it should wrap back to 0 if necessary.
+        if (++nwkUpdateID > 0xff) {
+            nwkUpdateID = 0x00;
+        }
+
+        const clusterId = Zdo.ClusterId.NWK_UPDATE_REQUEST;
+        const zdoPayload = Zdo.Buffalo.buildRequest(
+            this.adapter.hasZdoMessageOverhead,
+            clusterId,
+            [newChannel],
+            0xfe,
+            undefined,
+            nwkUpdateID,
+            undefined,
+        );
+
+        await this.adapter.sendZdo(ZSpec.BLANK_EUI64, ZSpec.BroadcastAddress.SLEEPY, clusterId, zdoPayload, true);
+        logger.info(`Channel changed to '${newChannel}'`, NS);
+
+        this.networkParametersCached = undefined; // invalidate cache
+        // wait for the broadcast to propagate and the adapter to actually change
+        // NOTE: observed to ~9sec on `ember` with actual stack event
+        await wait(12000);
+    }
+
+    public async identifyUnknownDevice(nwkAddress: number): Promise<Device | undefined> {
+        if (this.unknownDevices.has(nwkAddress)) {
+            // prevent duplicate triggering
+            return;
+        }
+
+        logger.debug(`Trying to identify unknown device with address '${nwkAddress}'`, NS);
+        this.unknownDevices.add(nwkAddress);
+        const clusterId = Zdo.ClusterId.IEEE_ADDRESS_REQUEST;
+        const zdoPayload = Zdo.Buffalo.buildRequest(this.adapter.hasZdoMessageOverhead, clusterId, nwkAddress, false, 0);
+
+        try {
+            const response = await this.adapter.sendZdo(ZSpec.BLANK_EUI64, nwkAddress, clusterId, zdoPayload, false);
+
+            if (Zdo.Buffalo.checkStatus<Zdo.ClusterId.IEEE_ADDRESS_RESPONSE>(response)) {
+                const payload = response[1];
+                const device = Device.byIeeeAddr(this.database.id, payload.eui64);
+
+                if (device) {
+                    this.checkDeviceNetworkAddress(device, payload.eui64, payload.nwkAddress);
+                    this.unknownDevices.delete(payload.nwkAddress);
+                }
+
+                return device;
+            }
+
+            throw new Zdo.StatusError(response[0]);
+        } catch (error) {
+            // Catches 2 types of exception: Zdo.StatusError and no response from `adapter.sendZdo()`.
+            logger.debug(`Failed to retrieve IEEE address for device '${nwkAddress}': ${error}`, NS);
+        }
+
+        // NOTE: by keeping nwkAddress in `this.unknownDevices` on fail, it prevents a non-responding device from potentially spamming identify.
+        // This only lasts until next reboot (runtime Set), allowing to 'force' another trigger if necessary.
+    }
+
+    private checkDeviceNetworkAddress(device: Device, ieeeAddress: string, nwkAddress: number): void {
+        if (device.networkAddress !== nwkAddress) {
+            logger.debug(`Device '${ieeeAddress}' got new networkAddress '${nwkAddress}'`, NS);
+            device.networkAddress = nwkAddress;
+            device.save();
+
+            this.selfAndDeviceEmit(device, "deviceNetworkAddressChanged", {device});
+        }
+    }
+
+    private onNetworkAddress(payload: ZdoTypes.NetworkAddressResponse): void {
+        logger.debug(`Network address from '${payload.eui64}:${payload.nwkAddress}'`, NS);
+        const device = Device.byIeeeAddr(this.database.id, payload.eui64);
+
+        if (!device) {
+            logger.debug(`Network address is from unknown device '${payload.eui64}:${payload.nwkAddress}'`, NS);
+            return;
+        }
+
+        device.updateLastSeen();
+        this.selfAndDeviceEmit(device, "lastSeenChanged", {device, reason: "networkAddress"});
+        this.checkDeviceNetworkAddress(device, payload.eui64, payload.nwkAddress);
+    }
+
+    private onIEEEAddress(payload: ZdoTypes.IEEEAddressResponse): void {
+        logger.debug(`IEEE address from '${payload.eui64}:${payload.nwkAddress}'`, NS);
+        const device = Device.byIeeeAddr(this.database.id, payload.eui64);
+
+        if (!device) {
+            logger.debug(`IEEE address is from unknown device '${payload.eui64}:${payload.nwkAddress}'`, NS);
+            return;
+        }
+
+        device.updateLastSeen();
+        this.selfAndDeviceEmit(device, "lastSeenChanged", {device, reason: "networkAddress"});
+        this.checkDeviceNetworkAddress(device, payload.eui64, payload.nwkAddress);
+    }
+
+    private onDeviceAnnounce(payload: ZdoTypes.EndDeviceAnnounce): void {
+        logger.debug(`Device announce from '${payload.eui64}:${payload.nwkAddress}'`, NS);
+        const device = Device.byIeeeAddr(this.database.id, payload.eui64);
+
+        if (!device) {
+            logger.debug(`Device announce is from unknown device '${payload.eui64}:${payload.nwkAddress}'`, NS);
+            return;
+        }
+
+        device.updateLastSeen();
+        this.selfAndDeviceEmit(device, "lastSeenChanged", {device, reason: "deviceAnnounce"});
+        device.implicitCheckin();
+        this.checkDeviceNetworkAddress(device, payload.eui64, payload.nwkAddress);
+        this.selfAndDeviceEmit(device, "deviceAnnounce", {device});
+    }
+
+    private onDeviceLeave(payload: AdapterEvents.DeviceLeavePayload): void {
+        logger.debug(`Device leave '${payload.ieeeAddr}'`, NS);
+
+        // XXX: seems type is not properly detected?
+        // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
+        const device = payload.ieeeAddr ? Device.byIeeeAddr(this.database.id, payload.ieeeAddr) : Device.byNetworkAddress(this.database.id, payload.networkAddress!);
+
+        if (!device) {
+            logger.debug(`Device leave is from unknown or already deleted device '${payload.ieeeAddr ?? payload.networkAddress}'`, NS);
+            return;
+        }
+
+        logger.debug(`Removing device from database '${device.ieeeAddr}'`, NS);
+        device.removeFromDatabase();
+
+        this.selfAndDeviceEmit(device, "deviceLeave", {ieeeAddr: device.ieeeAddr});
+    }
+
+    private async onAdapterDisconnected(): Promise<void> {
+        logger.debug("Adapter disconnected", NS);
+
+        this.adapterDisconnected = true;
+
+        try {
+            await this.adapter.stop();
+        } catch (error) {
+            logger.error(`Failed to stop adapter on disconnect: ${error}`, NS);
+        }
+
+        this.emit("adapterDisconnected");
+    }
+
+    private onDeviceJoinedGreenPower(payload: GreenPowerDeviceJoinedPayload): void {
+        logger.debug(() => `Green power device '${JSON.stringify(payload).replaceAll(/\[[\d,]+\]/g, "HIDDEN")}' joined`, NS);
+
+        // Green power devices don't have an ieeeAddr, the sourceID is unique and static so use this.
+        const ieeeAddr = GreenPower.sourceIdToIeeeAddress(payload.sourceID);
+        // Green power devices dont' have a modelID, create a modelID based on the deviceID (=type)
+        const modelID = `GreenPower_${payload.deviceID}`;
+        let device = Device.byIeeeAddr(this.database.id, ieeeAddr, true);
+
+        if (!device) {
+            logger.debug(`New green power device '${ieeeAddr}' joined`, NS);
+            logger.debug(`Creating device '${ieeeAddr}'`, NS);
+            device = Device.create(
+                "GreenPower",
+                ieeeAddr,
+                payload.networkAddress,
+                undefined,
+                undefined,
+                undefined,
+                modelID,
+                InterviewState.Successful,
+                payload.securityKey ? Array.from(payload.securityKey) : /* v8 ignore next */ undefined,
+                this.database.id,
+            );
+
+            device.save();
+
+            this.selfAndDeviceEmit(device, "deviceJoined", {device});
+            this.selfAndDeviceEmit(device, "deviceInterview", {status: "successful", device});
+        } else if (device.isDeleted) {
+            logger.debug(`Deleted green power device '${ieeeAddr}' joined, undeleting`, NS);
+
+            device.undelete();
+
+            this.selfAndDeviceEmit(device, "deviceJoined", {device});
+            this.selfAndDeviceEmit(device, "deviceInterview", {status: "successful", device});
+        }
+    }
+
+    private onDeviceLeaveGreenPower(sourceID: number): void {
+        logger.debug(`Green power device '${sourceID}' left`, NS);
+
+        // Green power devices don't have an ieeeAddr, the sourceID is unique and static so use this.
+        const ieeeAddr = GreenPower.sourceIdToIeeeAddress(sourceID);
+        const device = Device.byIeeeAddr(this.database.id, ieeeAddr);
+
+        if (!device) {
+            logger.debug(`Green power device leave is from unknown or already deleted device '${ieeeAddr}'`, NS);
+            return;
+        }
+
+        logger.debug(`Removing green power device from database '${device.ieeeAddr}'`, NS);
+        device.removeFromDatabase();
+
+        this.selfAndDeviceEmit(device, "deviceLeave", {ieeeAddr: device.ieeeAddr});
+    }
+
+    private selfAndDeviceEmit<K extends keyof ControllerEventMap>(
+        device: Device,
+        event: K,
+        ...args: K extends keyof ControllerEventMap ? ControllerEventMap[K] : never
+    ): void {
+        device.emit(event, ...args);
+        this.emit(event, ...args);
+    }
+
+    private async onDeviceJoined(payload: AdapterEvents.DeviceJoinedPayload): Promise<void> {
+        logger.debug(`Device '${payload.ieeeAddr}' joined`, NS);
+
+        if (this.options.acceptJoiningDeviceHandler) {
+            if (!(await this.options.acceptJoiningDeviceHandler(payload.ieeeAddr))) {
+                logger.debug(`Device '${payload.ieeeAddr}' rejected by handler, removing it`, NS);
+
+                // XXX: GP devices? see Device.removeFromNetwork
+                try {
+                    const clusterId = Zdo.ClusterId.LEAVE_REQUEST;
+                    const zdoPayload = Zdo.Buffalo.buildRequest(
+                        this.adapter.hasZdoMessageOverhead,
+                        clusterId,
+                        payload.ieeeAddr as Eui64,
+                        Zdo.LeaveRequestFlags.WITHOUT_REJOIN,
+                    );
+                    const response = await this.adapter.sendZdo(payload.ieeeAddr, payload.networkAddress, clusterId, zdoPayload, false);
+
+                    if (!Zdo.Buffalo.checkStatus<Zdo.ClusterId.LEAVE_RESPONSE>(response)) {
+                        throw new Zdo.StatusError(response[0]);
+                    }
+                } catch (error) {
+                    logger.error(`Failed to remove rejected device: ${(error as Error).message}`, NS);
+                }
+
+                return;
+            }
+
+            logger.debug(`Device '${payload.ieeeAddr}' accepted by handler`, NS);
+        }
+
+        let device = Device.byIeeeAddr(this.database.id, payload.ieeeAddr, true);
+        if (!device) {
+            logger.debug(`New device '${payload.ieeeAddr}' joined`, NS);
+            logger.debug(`Creating device '${payload.ieeeAddr}'`, NS);
+            device = Device.create(
+                "Unknown",
+                payload.ieeeAddr,
+                payload.networkAddress,
+                undefined,
+                undefined,
+                undefined,
+                undefined,
+                InterviewState.Pending,
+                undefined,
+                this.database.id,
+            );
+            this.selfAndDeviceEmit(device, "deviceJoined", {device});
+        } else if (device.isDeleted) {
+            logger.debug(`Deleted device '${payload.ieeeAddr}' joined, undeleting`, NS);
+            device.undelete();
+            this.selfAndDeviceEmit(device, "deviceJoined", {device});
+        }
+
+        if (device.networkAddress !== payload.networkAddress) {
+            logger.debug(`Device '${payload.ieeeAddr}' is already in database with different network address, updating network address`, NS);
+            device.networkAddress = payload.networkAddress;
+            device.save();
+        }
+
+        device.updateLastSeen();
+        this.selfAndDeviceEmit(device, "lastSeenChanged", {device, reason: "deviceJoined"});
+        device.implicitCheckin();
+
+        if (device.interviewState === InterviewState.Pending || device.interviewState === InterviewState.Failed) {
+            logger.info(`Interview for '${device.ieeeAddr}' started`, NS);
+            this.selfAndDeviceEmit(device, "deviceInterview", {status: "started", device});
+
+            try {
+                await device.interview();
+                logger.info(`Succesfully interviewed '${device.ieeeAddr}'`, NS);
+                this.selfAndDeviceEmit(device, "deviceInterview", {status: "successful", device});
+            } catch (error) {
+                logger.error(`Interview failed for '${device.ieeeAddr} with error '${error}'`, NS);
+                this.selfAndDeviceEmit(device, "deviceInterview", {status: "failed", device});
+            }
+        } else {
+            logger.debug(`Not interviewing '${payload.ieeeAddr}', interviewState=${device.interviewState}'`, NS);
+        }
+    }
+
+    private onZdoResponse(clusterId: Zdo.ClusterId, response: ZdoTypes.GenericZdoResponse): void {
+        logger.debug(
+            `Received ZDO response: clusterId=${Zdo.ClusterId[clusterId]}, status=${Zdo.Status[response[0]]}, payload=${JSON.stringify(response[1])}`,
+            NS,
+        );
+
+        switch (clusterId) {
+            case Zdo.ClusterId.NETWORK_ADDRESS_RESPONSE: {
+                if (Zdo.Buffalo.checkStatus<typeof clusterId>(response)) {
+                    this.onNetworkAddress(response[1]);
+                }
+                break;
+            }
+
+            case Zdo.ClusterId.IEEE_ADDRESS_RESPONSE: {
+                if (Zdo.Buffalo.checkStatus<typeof clusterId>(response)) {
+                    this.onIEEEAddress(response[1]);
+                }
+                break;
+            }
+
+            case Zdo.ClusterId.END_DEVICE_ANNOUNCE: {
+                if (Zdo.Buffalo.checkStatus<typeof clusterId>(response)) {
+                    this.onDeviceAnnounce(response[1]);
+                }
+                break;
+            }
+        }
+    }
+
+    private async onZclPayload(payload: AdapterEvents.ZclPayload): Promise<void> {
+        let frame: Zcl.Frame | undefined;
+        let device: Device | undefined;
+
+        if (payload.clusterID === Zcl.Clusters.touchlink.ID) {
+            // This is handled by touchlink
+            return;
+        }
+
+        if (payload.clusterID === Zcl.Clusters.greenPower.ID) {
+            try {
+                // Custom clusters are not supported for Green Power since we need to parse the frame to get the device.
+                frame = Zcl.Frame.fromBuffer(payload.clusterID, payload.header, payload.data, {});
+            } catch (error) {
+                logger.debug(`Failed to parse frame green power frame, ignoring it: ${error}`, NS);
+                return;
+            }
+
+            if (frame.payload.commandID === undefined) {
+                // can be from gpd or gpp
+                // can be:
+                //   - greenPower.commandsResponse.commissioningMode
+                //   - Foundation.defaultRsp for greenPower.commandsResponse.pairing with status INVALID_FIELD or INSUFFICIENT_SPACE
+                //   - ...
+                device = Device.find(this.database.id, payload.address);
+            } else {
+                if (frame.payload.srcID === undefined) {
+                    logger.debug("Data is from unsupported green power device with IEEE addressing, skipping...", NS);
+                    return;
+                }
+
+                const ieeeAddr = GreenPower.sourceIdToIeeeAddress(frame.payload.srcID);
+                device = Device.byIeeeAddr(this.database.id, ieeeAddr);
+                frame = await this.#greenPower.processCommand(payload, frame, device?.gpSecurityKey ? Buffer.from(device.gpSecurityKey) : undefined);
+
+                // lookup encapsulated gpDevice for further processing (re-fetch, may have been created by above call)
+                device = Device.byIeeeAddr(this.database.id, ieeeAddr);
+
+                if (!device) {
+                    logger.debug(`Data is from unknown green power device with address '${ieeeAddr}' (${frame.payload.srcID}), skipping...`, NS);
+                    return;
+                }
+            }
+        } else {
+            /**
+             * Handling of re-transmitted Xiaomi messages.
+             * https://github.com/Koenkk/zigbee2mqtt/issues/1238
+             * https://github.com/Koenkk/zigbee2mqtt/issues/3592
+             *
+             * Some Xiaomi router devices re-transmit messages from Xiaomi end devices.
+             * The network address of these message is set to the one of the Xiaomi router.
+             * Therefore it looks like if the message came from the Xiaomi router, while in
+             * fact it came from the end device.
+             * Handling these message would result in false state updates.
+             * The group ID attribute of these message defines the network address of the end device.
+             */
+            device = Device.find(this.database.id, payload.address);
+
+            if (device?.manufacturerName === "LUMI" && device?.type === "Router" && payload.groupID) {
+                logger.debug(`Handling re-transmitted Xiaomi message ${device.networkAddress} -> ${payload.groupID}`, NS);
+                device = Device.byNetworkAddress(this.database.id, payload.groupID);
+            }
+
+            try {
+                frame = Zcl.Frame.fromBuffer(payload.clusterID, payload.header, payload.data, device ? device.customClusters : {});
+            } catch (error) {
+                logger.debug(`Failed to parse frame: ${error}`, NS);
+            }
+        }
+
+        if (!device) {
+            if (typeof payload.address === "number" && !Device.isDeletedByNetworkAddress(this.database.id, payload.address)) {
+                device = await this.identifyUnknownDevice(payload.address);
+            }
+
+            if (!device) {
+                logger.debug(`Data is from unknown device with address '${payload.address}', skipping...`, NS);
+                return;
+            }
+        }
+
+        logger.debug(
+            `Received payload: clusterID=${payload.clusterID}, address=${payload.address}, groupID=${payload.groupID}, ` +
+                `endpoint=${payload.endpoint}, destinationEndpoint=${payload.destinationEndpoint}, wasBroadcast=${payload.wasBroadcast}, ` +
+                `linkQuality=${payload.linkquality}, frame=${frame?.toString()}`,
+            NS,
+        );
+
+        device.updateLastSeen();
+
+        //no implicit checkin for genPollCtrl data because it might interfere with the explicit checkin
+        if (frame?.cluster.name !== "genPollCtrl") {
+            device.implicitCheckin();
+        }
+
+        device.linkquality = payload.linkquality;
+        let endpoint = device.getEndpoint(payload.endpoint);
+
+        if (!endpoint) {
+            logger.debug(
+                `Data is from unknown endpoint '${payload.endpoint}' from device with network address '${payload.address}', creating it...`,
+                NS,
+            );
+
+            endpoint = device.createEndpoint(payload.endpoint);
+        }
+
+        // Parse command for event
+        let type: Events.MessagePayload["type"] | undefined;
+        let data: Events.MessagePayload["data"] = {};
+        let clusterName: Events.MessagePayload["cluster"];
+        const meta: {
+            zclTransactionSequenceNumber?: number;
+            manufacturerCode?: number;
+            frameControl?: FrameControl;
+            rawData: Buffer;
+        } = {rawData: payload.data};
+
+        if (frame) {
+            const command = frame.command;
+            clusterName = frame.cluster.name;
+            meta.zclTransactionSequenceNumber = frame.header.transactionSequenceNumber;
+            meta.manufacturerCode = frame.header.manufacturerCode;
+            meta.frameControl = frame.header.frameControl;
+
+            if (frame.header.isGlobal) {
+                switch (frame.command.name) {
+                    case "report": {
+                        type = "attributeReport";
+                        data = ZclFrameConverter.attributeKeyValue(frame, device.manufacturerID, device.customClusters);
+                        break;
+                    }
+
+                    case "read": {
+                        type = "read";
+                        data = ZclFrameConverter.attributeList(frame, device.manufacturerID, device.customClusters);
+                        break;
+                    }
+
+                    case "write": {
+                        type = "write";
+                        data = ZclFrameConverter.attributeKeyValue(frame, device.manufacturerID, device.customClusters);
+                        break;
+                    }
+
+                    case "readRsp": {
+                        type = "readResponse";
+                        data = ZclFrameConverter.attributeKeyValue(frame, device.manufacturerID, device.customClusters);
+                        break;
+                    }
+
+                    case "defaultRsp": {
+                        if (frame.payload.statusCode !== Zcl.Status.SUCCESS) {
+                            logger.debug(
+                                `Failure default response from '${payload.address}': clusterID=${payload.clusterID} cmdId=${frame.payload.cmdId} status=${Zcl.Status[frame.payload.statusCode]}`,
+                                NS,
+                            );
+                        }
+
+                        break;
+                    }
+                }
+
+                if (type === "readResponse" || type === "attributeReport") {
+                    // devices report attributes through readRsp or attributeReport
+                    if (frame.cluster.name === "genBasic") {
+                        device.updateGenBasic(data as TPartialClusterAttributes<"genBasic">);
+                    }
+
+                    endpoint.saveClusterAttributeKeyValue(frame.cluster.ID, data);
+                }
+            } else {
+                if (frame.header.isSpecific) {
+                    type = `command${command.name.charAt(0).toUpperCase()}${command.name.slice(1)}`;
+                    data = frame.payload;
+                }
+            }
+        } else {
+            type = "raw";
+            data = payload.data;
+            const name = Zcl.Utils.getCluster(payload.clusterID, device.manufacturerID, device.customClusters).name;
+            clusterName = Number.isNaN(Number(name)) ? name : Number(name);
+        }
+
+        if (type && data) {
+            const linkquality = payload.linkquality;
+            const groupID = payload.groupID;
+
+            this.selfAndDeviceEmit(device, "message", {
+                type,
+                device,
+                endpoint,
+                data,
+                linkquality,
+                groupID,
+                cluster: clusterName,
+                meta,
+            });
+            this.selfAndDeviceEmit(device, "lastSeenChanged", {device, reason: "messageEmitted"});
+        } else {
+            this.selfAndDeviceEmit(device, "lastSeenChanged", {device, reason: "messageNonEmitted"});
+        }
+
+        if (frame) {
+            await device.onZclData(payload, frame, endpoint);
+        }
+    }
+}
+
+export default Controller;