@willieee802/zigbee-herdsman 0.48.2 → 0.49.0

package/src/controller/touchlink.ts

@@ -0,0 +1,195 @@
+import type {Adapter} from "../adapter";
+import {wait} from "../utils";
+import {logger} from "../utils/logger";
+import {assertString} from "../utils/utils";
+import * as Zcl from "../zspec/zcl";
+
+const NS = "zh:controller:touchlink";
+const scanChannels = [11, 15, 20, 25, 12, 13, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26];
+
+const createScanRequestFrame = (transaction: number): Zcl.Frame =>
+    Zcl.Frame.create(
+        Zcl.FrameType.SPECIFIC,
+        Zcl.Direction.CLIENT_TO_SERVER,
+        true,
+        undefined,
+        0,
+        "scanRequest",
+        Zcl.Clusters.touchlink.ID,
+        {transactionID: transaction, zigbeeInformation: 4, touchlinkInformation: 18},
+        {},
+    );
+
+const createIdentifyRequestFrame = (transaction: number): Zcl.Frame =>
+    Zcl.Frame.create(
+        Zcl.FrameType.SPECIFIC,
+        Zcl.Direction.CLIENT_TO_SERVER,
+        true,
+        undefined,
+        0,
+        "identifyRequest",
+        Zcl.Clusters.touchlink.ID,
+        {transactionID: transaction, duration: 65535},
+        {},
+    );
+
+const createResetFactoryNewRequestFrame = (transaction: number): Zcl.Frame =>
+    Zcl.Frame.create(
+        Zcl.FrameType.SPECIFIC,
+        Zcl.Direction.CLIENT_TO_SERVER,
+        true,
+        undefined,
+        0,
+        "resetToFactoryNew",
+        Zcl.Clusters.touchlink.ID,
+        {transactionID: transaction},
+        {},
+    );
+
+export class Touchlink {
+    private adapter!: Adapter;
+    private locked = false;
+
+    public constructor(adapter: Adapter) {
+        this.adapter = adapter;
+    }
+
+    async stop(): Promise<void> {
+        if (this.locked) {
+            await this.restoreChannelInterPAN();
+
+            this.locked = false;
+        }
+    }
+
+    public lock(lock: boolean): void {
+        if (lock && this.locked) {
+            throw new Error("Touchlink operation already in progress");
+        }
+
+        this.locked = lock;
+    }
+
+    private transactionNumber(): number {
+        return Math.floor(Math.random() * 0xffffffff);
+    }
+
+    public async setChannelInterPAN(channel: number): Promise<void> {
+        logger.info(`Set InterPAN channel to '${channel}'`, NS);
+        await this.adapter.setChannelInterPAN(channel);
+    }
+
+    public async restoreChannelInterPAN(): Promise<void> {
+        logger.info("Restore InterPAN channel", NS);
+        await this.adapter.restoreChannelInterPAN();
+    }
+
+    public async scan(): Promise<{ieeeAddr: string; channel: number}[]> {
+        this.lock(true);
+        const result = [];
+
+        try {
+            for (const channel of scanChannels) {
+                await this.setChannelInterPAN(channel);
+
+                try {
+                    // TODO: multiple responses are not handled yet.
+                    const response = await this.adapter.sendZclFrameInterPANBroadcast(createScanRequestFrame(this.transactionNumber()), 500, false);
+                    logger.debug(`Got scan response on channel '${channel}' of '${response.address}'`, NS);
+                    assertString(response.address);
+                    result.push({ieeeAddr: response.address, channel});
+                } catch (error) {
+                    logger.warning(`Scan request failed or was not answered: '${error}'`, NS);
+                }
+            }
+        } finally {
+            await this.restoreChannelInterPAN();
+            this.lock(false);
+        }
+
+        return result;
+    }
+
+    public async identify(ieeeAddr: string, channel: number): Promise<void> {
+        this.lock(true);
+
+        try {
+            const transaction = this.transactionNumber();
+
+            await this.setChannelInterPAN(channel);
+
+            await this.adapter.sendZclFrameInterPANBroadcast(createScanRequestFrame(transaction), 500, false);
+            logger.debug(`Got scan response on channel '${channel}'`, NS);
+
+            logger.debug(`Identifying '${ieeeAddr}'`, NS);
+            await this.adapter.sendZclFrameInterPANToIeeeAddr(createIdentifyRequestFrame(transaction), ieeeAddr);
+        } finally {
+            await this.restoreChannelInterPAN();
+            this.lock(false);
+        }
+    }
+
+    public async factoryReset(ieeeAddr: string, channel: number): Promise<boolean> {
+        this.lock(true);
+        try {
+            const transaction = this.transactionNumber();
+
+            await this.setChannelInterPAN(channel);
+
+            await this.adapter.sendZclFrameInterPANBroadcast(createScanRequestFrame(transaction), 500, false);
+            logger.debug(`Got scan response on channel '${channel}'`, NS);
+
+            logger.debug(`Identifying '${ieeeAddr}'`, NS);
+            await this.adapter.sendZclFrameInterPANToIeeeAddr(createIdentifyRequestFrame(transaction), ieeeAddr);
+            await wait(2000);
+
+            logger.debug(`Reset to factory new '${ieeeAddr}'`, NS);
+            await this.adapter.sendZclFrameInterPANToIeeeAddr(createResetFactoryNewRequestFrame(transaction), ieeeAddr);
+        } finally {
+            await this.restoreChannelInterPAN();
+            this.lock(false);
+        }
+
+        return true;
+    }
+
+    public async factoryResetFirst(): Promise<boolean> {
+        this.lock(true);
+        let done = false;
+
+        try {
+            for (const channel of scanChannels) {
+                await this.setChannelInterPAN(channel);
+
+                try {
+                    const transaction = this.transactionNumber();
+
+                    const response = await this.adapter.sendZclFrameInterPANBroadcast(createScanRequestFrame(transaction), 500, false);
+                    logger.debug(`Got scan response on channel '${channel}'`, NS);
+                    assertString(response.address);
+
+                    // Device answered (if not it will fall in the catch below),
+                    // identify it (this will make e.g. the bulb flash)
+                    logger.debug("Identifying", NS);
+                    await this.adapter.sendZclFrameInterPANToIeeeAddr(createIdentifyRequestFrame(transaction), response.address);
+                    await wait(2000);
+
+                    logger.debug("Reset to factory new", NS);
+                    await this.adapter.sendZclFrameInterPANToIeeeAddr(createResetFactoryNewRequestFrame(transaction), response.address);
+                    done = true;
+                } catch (error) {
+                    logger.warning(`Scan request failed or was not answered: '${error}'`, NS);
+                }
+
+                if (done) break;
+            }
+        } finally {
+            await this.restoreChannelInterPAN();
+            this.lock(false);
+        }
+
+        return done;
+    }
+}
+
+export default Touchlink;

package/src/controller/tstype.ts

@@ -0,0 +1,374 @@
+import type {
+    TClusterAttributes,
+    TClusterCommandPayload,
+    TClusterCommandResponses,
+    TClusterCommands,
+    TClusterPayload,
+    TClusters,
+    TFoundation,
+    TFoundationGenericPayload,
+    TFoundationPayload,
+    TPartialClusterAttributes,
+} from "../zspec/zcl/definition/clusters-types";
+import type {DataType, Direction, FrameType} from "../zspec/zcl/definition/enums";
+
+export interface KeyValue {
+    // biome-ignore lint/suspicious/noExplicitAny: API
+    [s: string]: any;
+}
+
+/**
+ * Send request policies:
+ * - 'bulk':           Message must be sent together with other messages in the correct sequence.
+ *                     No immediate delivery required.
+ * - 'queue':          Request shall be sent 'as-is' as soon as possible.
+ *                     Multiple identical requests shall be delivered multiple times.
+ *                     Not strict ordering required.
+ * - 'immediate':      Request shall be sent immediately and not be kept for later retries (e.g. response message).
+ * - 'keep-payload':   Request shall be sent as soon as possible.
+ *                     If immediate delivery fails, the exact same payload is only sent once, even if there were
+ *                     multiple requests.
+ * - 'keep-command':   Request shall be sent as soon as possible.
+ *                     If immediate delivery fails, only the latest command for each command ID is kept for delivery.
+ * - 'keep-cmd-undiv': Request shall be sent as soon as possible.
+ *                     If immediate delivery fails, only the latest undivided set of commands is sent for each unique
+ *                     set of command IDs.
+ */
+export type SendPolicy = "bulk" | "queue" | "immediate" | "keep-payload" | "keep-command" | "keep-cmd-undiv";
+export type DeviceType = "Coordinator" | "Router" | "EndDevice" | "Unknown" | "GreenPower";
+
+export type EntityType = DeviceType | "Group";
+
+export interface DatabaseEntry {
+    id: number;
+    type: EntityType;
+    // biome-ignore lint/suspicious/noExplicitAny: API
+    [s: string]: any;
+}
+
+export interface GreenPowerDeviceJoinedPayload {
+    sourceID: number;
+    deviceID: number;
+    networkAddress: number;
+    securityKey?: Buffer;
+}
+
+// #region OTA
+export interface OtaSource {
+    url?: string;
+    downgrade?: boolean;
+}
+
+export interface OtaDataSettings {
+    requestTimeout: number;
+    responseDelay: number;
+    baseSize: number;
+}
+
+export interface OtaUpdateAvailableResult {
+    /** based on `source.downgrade` */
+    available: boolean;
+    current: TClusterCommandPayload<"genOta", "queryNextImageRequest">;
+    availableMeta?: ZigbeeOtaImageMeta;
+}
+
+export interface OtaImageHeader {
+    otaUpgradeFileIdentifier: number;
+    otaHeaderVersion: number;
+    otaHeaderLength: number;
+    otaHeaderFieldControl: number;
+    manufacturerCode: number;
+    imageType: number;
+    fileVersion: number;
+    zigbeeStackVersion: number;
+    otaHeaderString: string;
+    totalImageSize: number;
+    securityCredentialVersion?: number;
+    upgradeFileDestination?: Buffer;
+    minimumHardwareVersion?: number;
+    maximumHardwareVersion?: number;
+}
+
+export interface OtaImageElement {
+    tagId: number;
+    length: number;
+    data: Buffer;
+}
+
+export interface OtaImage {
+    header: OtaImageHeader;
+    elements: OtaImageElement[];
+    raw: Buffer;
+}
+
+export interface OtaImageMeta {
+    fileVersion: OtaImageHeader["fileVersion"];
+    fileSize?: OtaImageHeader["totalImageSize"];
+    url: string;
+    force?: boolean;
+    sha512?: string;
+    otaHeaderString?: OtaImageHeader["otaHeaderString"];
+    hardwareVersionMin?: OtaImageHeader["minimumHardwareVersion"];
+    hardwareVersionMax?: OtaImageHeader["maximumHardwareVersion"];
+}
+
+export interface ZigbeeOtaImageMeta
+    extends Omit<TClusterCommandPayload<"genOta", "queryNextImageRequest">, "fieldControl" | "hardwareVersion">,
+        OtaImageMeta {
+    fileName: string;
+    modelId?: string;
+    manufacturerName?: string[];
+    minFileVersion?: OtaImageHeader["fileVersion"];
+    maxFileVersion?: OtaImageHeader["fileVersion"];
+    originalUrl?: string;
+    releaseNotes?: string;
+}
+
+export type OtaExtraMetas = Pick<ZigbeeOtaImageMeta, "modelId" | "otaHeaderString" | "hardwareVersionMin" | "hardwareVersionMax"> & {
+    manufacturerName?: string;
+    suppressElementImageParseFailure?: boolean;
+};
+
+// #endregion
+
+export interface RawPayload {
+    ieeeAddress?: string;
+    networkAddress?: number;
+    groupId?: number;
+    dstEndpoint?: number;
+    /** defaults to `ZSpec.HA_ENDPOINT` */
+    srcEndpoint?: number;
+    /** defaults to false */
+    interPan?: boolean;
+    /** defaults to `ZSpec.HA_PROFILE_ID` */
+    profileId?: number;
+    /** Expected as `number` for ZDO */
+    clusterKey?: number | string;
+    /** Only used for ZDO */
+    zdoParams?: unknown[];
+    /** Only used for ZCL */
+    zcl?: {
+        frameType?: FrameType;
+        direction?: Direction;
+        disableDefaultResponse?: boolean;
+        manufacturerCode?: number;
+        tsn?: number;
+        commandKey: string;
+        /** TODO: zclFrame.ts `ZclPayload` should be refactor to this type */
+        payload?: Record<string, unknown> | Record<string, unknown>[];
+    };
+    /** defaults to false */
+    disableResponse?: boolean;
+    /** defaults to 10000 */
+    timeout?: number;
+}
+
+export interface TCustomCluster {
+    attributes: Record<string, unknown> | never;
+    commands: Record<string, Record<string, unknown | never>> | never;
+    commandResponses: Record<string, Record<string, unknown | never>> | never;
+}
+
+export type RawClusterAttribute = {value: unknown; type: DataType};
+
+export type RawClusterAttributes = Record<number, RawClusterAttribute>;
+
+// below Cluster types follow roughly the same logic:
+//   - if cluster has attributes/commands/commandsResponse
+//     - if Custom is defined and has attributes/commands/commandsResponse, use Custom and/or raw
+//     - else use raw
+//   - else
+//     - if cluster is ZCL
+//       - if Custom is defined and has attributes/commands/commandsResponse, use Custom and/or ZCL and/or raw
+//       - else use ZCL and/or raw
+//     - else
+//       - if Custom is defined, use Custom and/or raw
+//       - else use raw
+//
+// where `raw` represents the type used for full manual input (usually using ID)
+
+export type ClusterOrRawAttributeKeys<Cl extends string | number, Custom extends TCustomCluster | undefined = undefined> =
+    TClusterAttributes<Cl> extends never
+        ? Custom extends TCustomCluster
+            ? Custom["attributes"] extends never
+                ? number[]
+                : (keyof Custom["attributes"] | number)[]
+            : number[]
+        : Cl extends keyof TClusters
+          ? Custom extends TCustomCluster
+              ? Custom["attributes"] extends never
+                  ? // don't use `TClusterAttributeKeys<Cl>` as that allows "symbol"
+                    (keyof TClusters[Cl]["attributes"] | number)[]
+                  : (keyof Custom["attributes"] | keyof TClusters[Cl]["attributes"] | number)[]
+              : (keyof TClusters[Cl]["attributes"] | number)[]
+          : Custom extends TCustomCluster
+            ? Custom["attributes"] extends never
+                ? number[]
+                : (keyof Custom["attributes"] | number)[]
+            : number[];
+
+export type ClusterOrRawWriteAttributes<Cl extends string | number, Custom extends TCustomCluster | undefined = undefined> =
+    TClusterAttributes<Cl> extends never
+        ? Custom extends TCustomCluster
+            ? Custom["attributes"] extends never
+                ? RawClusterAttributes
+                : Custom["attributes"] & RawClusterAttributes
+            : RawClusterAttributes
+        : Cl extends keyof TClusters
+          ? (Custom extends TCustomCluster
+                ? Custom["attributes"] extends never
+                    ? TClusterAttributes<Cl>
+                    : Custom["attributes"] & TClusterAttributes<Cl>
+                : TClusterAttributes<Cl>) &
+                RawClusterAttributes
+          : Custom extends TCustomCluster
+            ? Custom["attributes"] extends never
+                ? RawClusterAttributes
+                : Custom["attributes"] & RawClusterAttributes
+            : RawClusterAttributes;
+
+export type PartialClusterOrRawWriteAttributes<Cl extends string | number, Custom extends TCustomCluster | undefined = undefined> =
+    TClusterAttributes<Cl> extends never
+        ? Custom extends TCustomCluster
+            ? Custom["attributes"] extends never
+                ? RawClusterAttributes
+                : Partial<Custom["attributes"]> & RawClusterAttributes
+            : RawClusterAttributes
+        : Cl extends keyof TClusters
+          ? (Custom extends TCustomCluster
+                ? Custom["attributes"] extends never
+                    ? TPartialClusterAttributes<Cl>
+                    : Partial<Custom["attributes"]> & TPartialClusterAttributes<Cl>
+                : TPartialClusterAttributes<Cl>) &
+                RawClusterAttributes
+          : Custom extends TCustomCluster
+            ? Custom["attributes"] extends never
+                ? RawClusterAttributes
+                : Partial<Custom["attributes"]> & RawClusterAttributes
+            : RawClusterAttributes;
+
+export type ClusterOrRawAttributes<Cl extends string | number, Custom extends TCustomCluster | undefined = undefined> =
+    TClusterAttributes<Cl> extends never
+        ? Custom extends TCustomCluster
+            ? Custom["attributes"] extends never
+                ? Record<number, unknown>
+                : Custom["attributes"] & Record<number, unknown>
+            : Record<number, unknown>
+        : Cl extends keyof TClusters
+          ? (Custom extends TCustomCluster
+                ? Custom["attributes"] extends never
+                    ? TClusterAttributes<Cl>
+                    : Custom["attributes"] & TClusterAttributes<Cl>
+                : TClusterAttributes<Cl>) &
+                Record<number, unknown>
+          : Custom extends TCustomCluster
+            ? Custom["attributes"] extends never
+                ? Record<number, unknown>
+                : Custom["attributes"] & Record<number, unknown>
+            : Record<number, unknown>;
+
+export type PartialClusterOrRawAttributes<Cl extends string | number, Custom extends TCustomCluster | undefined = undefined> =
+    TClusterAttributes<Cl> extends never
+        ? Custom extends TCustomCluster
+            ? Custom["attributes"] extends never
+                ? Record<number, unknown>
+                : Partial<Custom["attributes"]> & Record<number, unknown>
+            : Record<number, unknown>
+        : Cl extends keyof TClusters
+          ? (Custom extends TCustomCluster
+                ? Custom["attributes"] extends never
+                    ? TPartialClusterAttributes<Cl>
+                    : Partial<Custom["attributes"]> & TPartialClusterAttributes<Cl>
+                : TPartialClusterAttributes<Cl>) &
+                Record<number, unknown>
+          : Custom extends TCustomCluster
+            ? Custom["attributes"] extends never
+                ? Record<number, unknown>
+                : Partial<Custom["attributes"]> & Record<number, unknown>
+            : Record<number, unknown>;
+
+export type ClusterCommandKeys<Cl extends string | number, Custom extends TCustomCluster | undefined = undefined> =
+    TClusterCommands<Cl> extends never
+        ? Custom extends TCustomCluster
+            ? Custom["commands"] extends never
+                ? number[]
+                : (keyof Custom["commands"] | number)[]
+            : number[]
+        : Cl extends keyof TClusters
+          ? Custom extends TCustomCluster
+              ? Custom["commands"] extends never
+                  ? // don't use `TClusterCommandKeys<Cl>` as that allows "symbol"
+                    (keyof TClusters[Cl]["commands"] | number)[]
+                  : (keyof Custom["commands"] | keyof TClusters[Cl]["commands"] | number)[]
+              : (keyof TClusters[Cl]["commands"] | number)[]
+          : Custom extends TCustomCluster
+            ? Custom["commands"] extends never
+                ? number[]
+                : (keyof Custom["commands"] | number)[]
+            : number[];
+
+export type ClusterCommandResponseKeys<Cl extends string | number, Custom extends TCustomCluster | undefined = undefined> =
+    TClusterCommandResponses<Cl> extends never
+        ? Custom extends TCustomCluster
+            ? Custom["commandResponses"] extends never
+                ? number[]
+                : (keyof Custom["commandResponses"] | number)[]
+            : number[]
+        : Cl extends keyof TClusters
+          ? Custom extends TCustomCluster
+              ? Custom["commandResponses"] extends never
+                  ? // don't use `TClusterCommandResponseKeys<Cl>` as that allows "symbol"
+                    (keyof TClusters[Cl]["commandResponses"] | number)[]
+                  : (keyof Custom["commandResponses"] | keyof TClusters[Cl]["commandResponses"] | number)[]
+              : (keyof TClusters[Cl]["commandResponses"] | number)[]
+          : Custom extends TCustomCluster
+            ? Custom["commandResponses"] extends never
+                ? number[]
+                : (keyof Custom["commandResponses"] | number)[]
+            : number[];
+
+export type TCustomClusterPayload<Custom extends TCustomCluster, Co extends string | number> = Custom["commands"] extends never
+    ? Custom["commandResponses"] extends never
+        ? never
+        : Co extends keyof Custom["commandResponses"]
+          ? Custom["commandResponses"][Co]
+          : never
+    : Co extends keyof Custom["commands"]
+      ? Custom["commands"][Co]
+      : Co extends keyof Custom["commandResponses"]
+        ? Custom["commandResponses"][Co]
+        : never;
+
+export type ClusterOrRawPayload<
+    Cl extends string | number,
+    Co extends string | number,
+    Custom extends TCustomCluster | undefined = undefined,
+> = Cl extends number
+    ? Record<string, unknown>
+    : Co extends number
+      ? Record<string, unknown>
+      : TClusterPayload<Cl, Co> extends never
+        ? Custom extends TCustomCluster
+            ? TCustomClusterPayload<Custom, Co> extends never
+                ? never
+                : TCustomClusterPayload<Custom, Co>
+            : never
+        : Cl extends keyof TClusters
+          ? Custom extends TCustomCluster
+              ? TCustomClusterPayload<Custom, Co> extends never
+                  ? TClusterPayload<Cl, Co>
+                  : TCustomClusterPayload<Custom, Co> & TClusterPayload<Cl, Co>
+              : TClusterPayload<Cl, Co>
+          : Custom extends TCustomCluster
+            ? TCustomClusterPayload<Custom, Co> extends never
+                ? never
+                : TCustomClusterPayload<Custom, Co>
+            : never;
+
+export type FoundationOrRawPayload<Co extends string | number> = Co extends number
+    ? TFoundationGenericPayload
+    : TFoundationPayload<Co> extends never
+      ? never
+      : Co extends keyof TFoundation
+        ? TFoundationPayload<Co>
+        : never;

package/src/index.ts

@@ -0,0 +1,14 @@
+/* v8 ignore start */
+
+export type * as AdapterEvents from "./adapter/events";
+export type * as AdapterTypes from "./adapter/tstype";
+export {Controller} from "./controller/controller";
+export type * as Events from "./controller/events";
+export {getOtaFirmware, getOtaIndex, parseOtaHeader, parseOtaImage, parseOtaSubElement, setOtaConfiguration} from "./controller/helpers/ota";
+export type * as Models from "./controller/model";
+export type * as Types from "./controller/tstype";
+export {setLogger} from "./utils/logger";
+export {getTimeClusterAttributes} from "./utils/timeService";
+export * as ZSpec from "./zspec";
+export * as Zcl from "./zspec/zcl";
+export * as Zdo from "./zspec/zdo";

package/src/models/backup-storage-legacy.ts

@@ -0,0 +1,48 @@
+import type {ZnpVersion} from "../adapter/z-stack/adapter/tstype";
+import type {NvSystemIds} from "../adapter/z-stack/constants/common";
+
+type LegacyNvItemKey =
+    | "ZCD_NV_EXTADDR"
+    | "ZCD_NV_NIB"
+    | "ZCD_NV_PANID"
+    | "ZCD_NV_EXTENDED_PAN_ID"
+    | "ZCD_NV_NWK_ACTIVE_KEY_INFO"
+    | "ZCD_NV_NWK_ALTERN_KEY_INFO"
+    | "ZCD_NV_APS_USE_EXT_PANID"
+    | "ZCD_NV_PRECFGKEY"
+    | "ZCD_NV_PRECFGKEY_ENABLE"
+    | "ZCD_NV_CHANLIST"
+
+    /* Z-Stack 3.0.x tables */
+    | "ZCD_NV_LEGACY_TCLK_TABLE_START"
+    | "ZCD_NV_LEGACY_NWK_SEC_MATERIAL_TABLE_START"
+
+    /* SimpleLink Z-Stack 3.x.0 tables */
+    | "ZCD_NV_EX_TCLK_TABLE"
+    | "ZCD_NV_EX_NWK_SEC_MATERIAL_TABLE";
+
+/**
+ * Legacy backup format to allow for backup migration.
+ */
+export interface LegacyBackupStorage {
+    adapterType: "zStack";
+    time: string;
+    meta: {
+        product: ZnpVersion;
+    };
+    data: Record<
+        LegacyNvItemKey,
+        {
+            id: number;
+            product: ZnpVersion;
+            offset: number;
+            osal: boolean;
+            value: number[];
+            len: number;
+
+            /* System ID and Sub ID used in SimpleLink Z-Stack 3.x.0 */
+            sysid?: NvSystemIds;
+            subid?: number;
+        }
+    >;
+}

package/src/models/backup-storage-unified.ts

@@ -0,0 +1,47 @@
+/**
+ * Unified configuration storage model based on
+ * [zigpy/open-coordinator-backup](https://github.com/zigpy/open-coordinator-backup).
+ *
+ * This format should allow for seamless migration between adapter types or event vendors.
+ */
+export interface UnifiedBackupStorage {
+    metadata: {
+        format: "zigpy/open-coordinator-backup";
+        version: 1;
+        source: string;
+        internal: {
+            /* zigbee-herdsman specific data */
+            date: string;
+            znpVersion?: number;
+            ezspVersion?: number;
+
+            [key: string]: unknown;
+        };
+    };
+    stack_specific?: {
+        zstack?: {
+            tclk_seed?: string;
+        };
+        ezsp?: {
+            hashed_tclk?: string;
+        };
+    };
+    coordinator_ieee: string;
+    pan_id: string;
+    extended_pan_id: string;
+    security_level: number;
+    nwk_update_id: number;
+    channel: number;
+    channel_mask: number[];
+    network_key: {
+        key: string;
+        sequence_number: number;
+        frame_counter: number;
+    };
+    devices: {
+        nwk_address: string | null;
+        ieee_address: string;
+        is_child: boolean;
+        link_key: {key: string; rx_counter: number; tx_counter: number} | undefined;
+    }[];
+}