zigbee-herdsman 3.5.1 → 4.0.0

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;
+    }[];
+}

package/src/models/backup.ts

@@ -0,0 +1,37 @@
+import type {ZnpVersion} from "../adapter/z-stack/adapter/tstype";
+import type {NetworkOptions} from "./network-options";
+
+/**
+ * Internal representation of stored backup. Contains all essential network information.
+ *
+ * Additional `znp` object may contain extra information specific to Z-Stack based coordinators.
+ */
+export interface Backup {
+    networkOptions: NetworkOptions;
+    logicalChannel: number;
+    networkKeyInfo: {
+        sequenceNumber: number;
+        frameCounter: number;
+    };
+    securityLevel: number;
+    networkUpdateId: number;
+    coordinatorIeeeAddress: Buffer;
+    devices: {
+        networkAddress: number | null;
+        ieeeAddress: Buffer;
+        isDirectChild: boolean;
+        linkKey?: {
+            key: Buffer;
+            rxCounter: number;
+            txCounter: number;
+        };
+    }[];
+    znp?: {
+        version?: ZnpVersion;
+        trustCenterLinkKeySeed?: Buffer;
+    };
+    ezsp?: {
+        version?: number;
+        hashed_tclk?: Buffer;
+    };
+}

package/src/models/index.ts

@@ -0,0 +1,5 @@
+/* v8 ignore start */
+export * from "./backup";
+export * from "./backup-storage-legacy";
+export * from "./backup-storage-unified";
+export * from "./network-options";

package/src/models/network-options.ts

@@ -0,0 +1,11 @@
+/**
+ * Buffer-oriented structure representing network configuration.
+ */
+export interface NetworkOptions {
+    panId: number;
+    extendedPanId: Buffer;
+    channelList: number[];
+    networkKey: Buffer;
+    networkKeyDistribute: boolean;
+    hasDefaultExtendedPanId?: boolean;
+}

package/src/utils/backup.ts

@@ -0,0 +1,152 @@
+import * as fs from "node:fs";
+import * as path from "node:path";
+
+import * as ZStackStructs from "../adapter/z-stack/structs";
+import * as ZStackUtils from "../adapter/z-stack/utils";
+import type * as Models from "../models";
+
+/**
+ * Converts internal backup format to unified backup storage format as described by
+ * [zigpy/open-coordinator-backup](https://github.com/zigpy/open-coordinator-backup).
+ *
+ * @param backup Backup to create unified backup format from.
+ */
+export const toUnifiedBackup = async (backup: Models.Backup): Promise<Models.UnifiedBackupStorage> => {
+    const packageInfo = JSON.parse(fs.readFileSync(path.join(__dirname, "../../", "package.json")).toString());
+
+    return {
+        metadata: {
+            format: "zigpy/open-coordinator-backup",
+            version: 1,
+            source: `${packageInfo.name}@${packageInfo.version}`,
+            internal: {
+                date: new Date().toISOString(),
+                ...(backup.znp ? {znpVersion: backup.znp?.version ?? undefined} : /* v8 ignore next */ undefined),
+                ...(backup.ezsp ? {ezspVersion: backup.ezsp?.version ?? undefined} : /* v8 ignore next */ undefined),
+            },
+        },
+        stack_specific: {
+            /* v8 ignore next */
+            ...(backup.znp ? {zstack: {tclk_seed: backup.znp?.trustCenterLinkKeySeed?.toString("hex") || undefined}} : undefined),
+            ...(backup.ezsp ? {ezsp: {hashed_tclk: backup.ezsp?.hashed_tclk?.toString("hex") || undefined}} : /* v8 ignore next */ undefined),
+        },
+        coordinator_ieee: backup.coordinatorIeeeAddress.toString("hex"),
+        pan_id: backup.networkOptions.panId.toString(16),
+        extended_pan_id: backup.networkOptions.extendedPanId.toString("hex"),
+        nwk_update_id: backup.networkUpdateId || 0,
+        security_level: backup.securityLevel,
+        channel: backup.logicalChannel,
+        channel_mask: backup.networkOptions.channelList,
+        network_key: {
+            key: backup.networkOptions.networkKey.toString("hex"),
+            sequence_number: backup.networkKeyInfo.sequenceNumber,
+            frame_counter: backup.networkKeyInfo.frameCounter,
+        },
+        devices: backup.devices.map((device) => {
+            return {
+                nwk_address: device.networkAddress !== null ? device.networkAddress.toString(16) : /* v8 ignore next */ null,
+                ieee_address: device.ieeeAddress.toString("hex"),
+                is_child: device.isDirectChild,
+                link_key: device.linkKey
+                    ? {key: device.linkKey.key.toString("hex"), rx_counter: device.linkKey.rxCounter, tx_counter: device.linkKey.txCounter}
+                    : undefined,
+            };
+        }),
+    };
+};
+
+/**
+ * Converts unified backup storage format to internal backup format.
+ *
+ * @param backup Unified format to convert to internal backup format.
+ */
+export const fromUnifiedBackup = (backup: Models.UnifiedBackupStorage): Models.Backup => {
+    const tclkSeedString = backup.stack_specific?.zstack?.tclk_seed || undefined;
+
+    return {
+        networkOptions: {
+            panId: Number.parseInt(backup.pan_id, 16),
+            extendedPanId: Buffer.from(backup.extended_pan_id, "hex"),
+            channelList: backup.channel_mask,
+            networkKey: Buffer.from(backup.network_key.key, "hex"),
+            networkKeyDistribute: false,
+        },
+        logicalChannel: backup.channel,
+        networkKeyInfo: {
+            sequenceNumber: backup.network_key.sequence_number,
+            frameCounter: backup.network_key.frame_counter,
+        },
+        coordinatorIeeeAddress: Buffer.from(backup.coordinator_ieee, "hex"),
+        securityLevel: backup.security_level,
+        networkUpdateId: backup.nwk_update_id,
+        devices: backup.devices.map((device) => ({
+            networkAddress: device.nwk_address ? Number.parseInt(device.nwk_address, 16) : null,
+            ieeeAddress: Buffer.from(device.ieee_address, "hex"),
+            isDirectChild: typeof device.is_child === "boolean" ? device.is_child : true,
+            linkKey: device.link_key
+                ? {key: Buffer.from(device.link_key.key, "hex"), rxCounter: device.link_key.rx_counter, txCounter: device.link_key.tx_counter}
+                : undefined,
+        })),
+        znp: {
+            version: backup.metadata.internal?.znpVersion || undefined,
+            trustCenterLinkKeySeed: tclkSeedString ? Buffer.from(tclkSeedString, "hex") : undefined,
+        },
+        ezsp: {
+            version: backup.metadata.internal?.ezspVersion || undefined,
+            hashed_tclk: backup.stack_specific?.ezsp?.hashed_tclk ? Buffer.from(backup.stack_specific.ezsp.hashed_tclk, "hex") : undefined,
+        },
+    };
+};
+
+/**
+ * Converts legacy Zigbee2MQTT format to internal backup format.
+ *
+ * @param backup Legacy format to convert.
+ */
+export const fromLegacyBackup = (backup: Models.LegacyBackupStorage): Models.Backup => {
+    if (!backup.data.ZCD_NV_NIB) {
+        throw new Error("Backup corrupted - missing NIB");
+    }
+
+    if (!backup.data.ZCD_NV_NWK_ACTIVE_KEY_INFO) {
+        throw new Error("Backup corrupted - missing active key info");
+    }
+
+    if (!backup.data.ZCD_NV_PRECFGKEY_ENABLE) {
+        throw new Error("Backup corrupted - missing pre-configured key enable attribute");
+    }
+
+    if (!backup.data.ZCD_NV_EX_NWK_SEC_MATERIAL_TABLE && !backup.data.ZCD_NV_LEGACY_NWK_SEC_MATERIAL_TABLE_START) {
+        throw new Error("Backup corrupted - missing network security material table");
+    }
+
+    if (!backup.data.ZCD_NV_EXTADDR) {
+        throw new Error("Backup corrupted - missing adapter IEEE address NV entry");
+    }
+
+    const ieeeAddress = Buffer.from(backup.data.ZCD_NV_EXTADDR.value).reverse();
+    const nib = ZStackStructs.nib(Buffer.from(backup.data.ZCD_NV_NIB.value));
+    const activeKeyInfo = ZStackStructs.nwkKeyDescriptor(Buffer.from(backup.data.ZCD_NV_NWK_ACTIVE_KEY_INFO.value));
+    const preconfiguredKeyEnabled = backup.data.ZCD_NV_PRECFGKEY_ENABLE.value[0] !== 0x00;
+    const nwkSecMaterialSource = backup.data.ZCD_NV_EX_NWK_SEC_MATERIAL_TABLE || backup.data.ZCD_NV_LEGACY_NWK_SEC_MATERIAL_TABLE_START;
+    const nwkSecMaterialEntry = ZStackStructs.nwkSecMaterialDescriptorEntry(Buffer.from(nwkSecMaterialSource.value));
+
+    return {
+        networkOptions: {
+            panId: nib.nwkPanId,
+            extendedPanId: nib.extendedPANID,
+            channelList: ZStackUtils.unpackChannelList(nib.channelList),
+            networkKey: activeKeyInfo.key,
+            networkKeyDistribute: preconfiguredKeyEnabled,
+        },
+        logicalChannel: nib.nwkLogicalChannel,
+        networkKeyInfo: {
+            sequenceNumber: activeKeyInfo.keySeqNum,
+            frameCounter: nwkSecMaterialEntry.FrameCounter,
+        },
+        coordinatorIeeeAddress: ieeeAddress,
+        securityLevel: nib.SecurityLevel,
+        networkUpdateId: nib.nwkUpdateId,
+        devices: [],
+    };
+};

package/src/utils/index.ts

@@ -0,0 +1,5 @@
+export * as BackupUtils from "./backup";
+export {Queue} from "./queue";
+export * as Utils from "./utils";
+export {wait} from "./wait";
+export {Waitress} from "./waitress";

package/src/utils/logger.ts

@@ -0,0 +1,20 @@
+export interface Logger {
+    debug: (messageOrLambda: string | (() => string), namespace: string) => void;
+    info: (messageOrLambda: string | (() => string), namespace: string) => void;
+    warning: (messageOrLambda: string | (() => string), namespace: string) => void;
+    error: (messageOrLambda: string, namespace: string) => void;
+}
+
+export let logger: Logger = {
+    debug: (messageOrLambda, namespace) =>
+        console.debug(`[${new Date().toISOString()}] ${namespace}: ${typeof messageOrLambda === "function" ? messageOrLambda() : messageOrLambda}`),
+    info: (messageOrLambda, namespace) =>
+        console.info(`[${new Date().toISOString()}] ${namespace}: ${typeof messageOrLambda === "function" ? messageOrLambda() : messageOrLambda}`),
+    warning: (messageOrLambda, namespace) =>
+        console.warn(`[${new Date().toISOString()}] ${namespace}: ${typeof messageOrLambda === "function" ? messageOrLambda() : messageOrLambda}`),
+    error: (message, namespace) => console.error(`[${new Date().toISOString()}] ${namespace}: ${message}`),
+};
+
+export function setLogger(l: Logger): void {
+    logger = l;
+}

package/src/utils/patchBigIntSerialization.ts

@@ -0,0 +1,8 @@
+// Patch BigInt serialization which is used in e.g. Zcl payloads.
+// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#use_within_json
+// biome-ignore lint/suspicious/noExplicitAny: API
+(BigInt.prototype as any).toJSON = function (): string {
+    return this.toString();
+};
+
+export {};

package/src/utils/queue.ts

@@ -0,0 +1,76 @@
+interface Job {
+    key?: string | number;
+    running: boolean;
+    start?: () => void;
+}
+
+export class Queue {
+    private jobs: Job[];
+    private readonly concurrent: number;
+
+    constructor(concurrent = 1) {
+        this.jobs = [];
+        this.concurrent = concurrent;
+    }
+
+    public async execute<T>(func: () => Promise<T>, key?: string | number): Promise<T> {
+        const job: Job = {key, running: false};
+        this.jobs.push(job);
+
+        // Minor optimization/workaround: various tests like the idea that a job that is immediately runnable is run without an event loop spin.
+        // This also helps with stack traces in some cases, so avoid an `await` if we can help it.
+        if (this.getNext() !== job) {
+            await new Promise<void>((resolve): void => {
+                job.start = (): void => {
+                    job.running = true;
+                    resolve();
+                };
+
+                this.executeNext();
+            });
+        } else {
+            job.running = true;
+        }
+
+        try {
+            return await func();
+        } finally {
+            this.jobs.splice(this.jobs.indexOf(job), 1);
+            this.executeNext();
+        }
+    }
+
+    private executeNext(): void {
+        const job = this.getNext();
+
+        if (job) {
+            // if we get here, start is always defined for job
+            // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
+            job.start!();
+        }
+    }
+
+    private getNext(): Job | undefined {
+        if (this.jobs.filter((j) => j.running).length > this.concurrent - 1) {
+            return undefined;
+        }
+
+        for (let i = 0; i < this.jobs.length; i++) {
+            const job = this.jobs[i];
+
+            if (!job.running && (!job.key || !this.jobs.find((j) => j.key === job.key && j.running))) {
+                return job;
+            }
+        }
+
+        return undefined;
+    }
+
+    public clear(): void {
+        this.jobs = [];
+    }
+
+    public count(): number {
+        return this.jobs.length;
+    }
+}

package/src/utils/types.d.ts

@@ -0,0 +1,3 @@
+declare module "mixin-deep" {
+    export default function mixinDeep<T>(target: T, ...rest: object[]): T;
+}

package/src/utils/utils.ts

@@ -0,0 +1,20 @@
+export function isNumberArray(value: unknown): value is number[] {
+    return Array.isArray(value) && value.every((item) => typeof item === "number");
+}
+
+export function isNumberArrayOfLength(value: unknown, length: number): boolean {
+    return isNumberArray(value) && value.length === length;
+}
+
+export function assertString(input: unknown): asserts input is string {
+    if (typeof input !== "string") {
+        throw new Error("Input must be a string!");
+    }
+}
+
+export function isObjectEmpty(object: object): boolean {
+    // much faster than checking `Object.keys(object).length`
+    // biome-ignore lint/style/useNamingConvention: not working properly
+    for (const _k in object) return false;
+    return true;
+}

package/src/utils/wait.ts

@@ -0,0 +1,5 @@
+export function wait(milliseconds: number): Promise<void> {
+    return new Promise((resolve): void => {
+        setTimeout((): void => resolve(), milliseconds);
+    });
+}

package/src/utils/waitress.ts

@@ -0,0 +1,95 @@
+interface Waiter<TPayload, TMatcher> {
+    ID: number;
+    resolve: (payload: TPayload) => void;
+    reject: (error: Error) => void;
+    timer?: NodeJS.Timeout;
+    resolved: boolean;
+    timedout: boolean;
+    matcher: TMatcher;
+}
+
+type Validator<TPayload, TMatcher> = (payload: TPayload, matcher: TMatcher) => boolean;
+type TimeoutFormatter<TMatcher> = (matcher: TMatcher, timeout: number) => string;
+
+export class Waitress<TPayload, TMatcher> {
+    private waiters: Map<number, Waiter<TPayload, TMatcher>>;
+    private readonly validator: Validator<TPayload, TMatcher>;
+    private readonly timeoutFormatter: TimeoutFormatter<TMatcher>;
+    private currentID: number;
+
+    public constructor(validator: Validator<TPayload, TMatcher>, timeoutFormatter: TimeoutFormatter<TMatcher>) {
+        this.waiters = new Map();
+        this.timeoutFormatter = timeoutFormatter;
+        this.validator = validator;
+        this.currentID = 0;
+    }
+
+    public clear(): void {
+        for (const [, waiter] of this.waiters) {
+            clearTimeout(waiter.timer);
+        }
+
+        this.waiters.clear();
+    }
+
+    public resolve(payload: TPayload): boolean {
+        return this.forEachMatching(payload, (waiter) => waiter.resolve(payload));
+    }
+
+    public reject(payload: TPayload, message: string): boolean {
+        return this.forEachMatching(payload, (waiter) => waiter.reject(new Error(message)));
+    }
+
+    public remove(id: number): void {
+        const waiter = this.waiters.get(id);
+        if (waiter) {
+            if (!waiter.timedout && waiter.timer) {
+                clearTimeout(waiter.timer);
+            }
+
+            this.waiters.delete(id);
+        }
+    }
+
+    public waitFor(matcher: TMatcher, timeout: number): {ID: number; start: () => {promise: Promise<TPayload>; ID: number}} {
+        const ID = this.currentID++;
+
+        const promise: Promise<TPayload> = new Promise((resolve, reject): void => {
+            const object: Waiter<TPayload, TMatcher> = {matcher, resolve, reject, timedout: false, resolved: false, ID};
+            this.waiters.set(ID, object);
+        });
+
+        const start = (): {promise: Promise<TPayload>; ID: number} => {
+            const waiter = this.waiters.get(ID);
+            if (waiter && !waiter.resolved && !waiter.timer) {
+                // Capture the stack trace from the caller of start()
+                const error = new Error(this.timeoutFormatter(matcher, timeout));
+                Error.captureStackTrace(error);
+                waiter.timer = setTimeout((): void => {
+                    waiter.timedout = true;
+                    waiter.reject(error);
+                }, timeout);
+            }
+
+            return {promise, ID};
+        };
+
+        return {ID, start};
+    }
+
+    private forEachMatching(payload: TPayload, action: (waiter: Waiter<TPayload, TMatcher>) => void): boolean {
+        let foundMatching = false;
+        for (const [index, waiter] of this.waiters.entries()) {
+            if (waiter.timedout) {
+                this.waiters.delete(index);
+            } else if (this.validator(payload, waiter.matcher)) {
+                clearTimeout(waiter.timer);
+                waiter.resolved = true;
+                this.waiters.delete(index);
+                action(waiter);
+                foundMatching = true;
+            }
+        }
+        return foundMatching;
+    }
+}

package/src/zspec/consts.ts

@@ -0,0 +1,84 @@
+import type {ExtendedPanId} from "./tstypes";
+
+/** Current supported Zigbee revision: https://csa-iot.org/wp-content/uploads/2023/04/05-3474-23-csg-zigbee-specification-compressed.pdf */
+export const ZIGBEE_REVISION = 23;
+
+/** The network ID of the coordinator in a ZigBee network is 0x0000. */
+export const COORDINATOR_ADDRESS = 0x0000;
+
+/** Endpoint profile ID for Zigbee 3.0. "Home Automation" */
+export const HA_PROFILE_ID = 0x0104;
+/** Endpoint profile ID for Smart Energy */
+export const SE_PROFILE_ID = 0x0109;
+/** Endpoint profile ID for Green Power */
+export const GP_PROFILE_ID = 0xa1e0;
+/** The touchlink (ZigBee Light Link/ZLL) Profile ID. */
+export const TOUCHLINK_PROFILE_ID = 0xc05e;
+/** The profile ID used to address all the public profiles. */
+export const WILDCARD_PROFILE_ID = 0xffff;
+
+/** The default HA endpoint. */
+export const HA_ENDPOINT = 0x01;
+/** The GP endpoint, as defined in the ZigBee spec. */
+export const GP_ENDPOINT = 0xf2;
+
+export const GP_GROUP_ID = 0x0b84;
+
+/** The maximum 802.15.4 channel number is 26. */
+export const MAX_802_15_4_CHANNEL_NUMBER = 26;
+/** The minimum 2.4GHz 802.15.4 channel number is 11. */
+export const MIN_802_15_4_CHANNEL_NUMBER = 11;
+/** There are sixteen 802.15.4 channels. */
+export const NUM_802_15_4_CHANNELS = MAX_802_15_4_CHANNEL_NUMBER - MIN_802_15_4_CHANNEL_NUMBER + 1;
+/** A bitmask to scan all 2.4 GHz 802.15.4 channels. */
+export const ALL_802_15_4_CHANNELS_MASK = 0x07fff800;
+/** A bitmask of the preferred 2.4 GHz 802.15.4 channels to scan. */
+export const PREFERRED_802_15_4_CHANNELS_MASK = 0x0318c800;
+/** List of all Zigbee channels */
+export const ALL_802_15_4_CHANNELS = [11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26];
+/** List of preferred Zigbee channels */
+export const PREFERRED_802_15_4_CHANNELS = [11, 14, 15, 19, 20, 24, 25];
+
+/** A blank (also used as "wildcard") EUI64 hex string prefixed with 0x */
+export const BLANK_EUI64 = "0xFFFFFFFFFFFFFFFF";
+/** A blank extended PAN ID. (null/not present) */
+export const BLANK_EXTENDED_PAN_ID: Readonly<ExtendedPanId> = [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00];
+
+/** An invalid profile ID. This is a reserved profileId. */
+export const INVALID_PROFILE_ID = 0xffff;
+/** An invalid cluster ID. */
+export const INVALID_CLUSTER_ID = 0xffff;
+/** An invalid PAN ID. */
+export const INVALID_PAN_ID = 0xffff;
+
+/** A distinguished network ID that will never be assigned to any node. It is used to indicate the absence of a node ID. */
+export const NULL_NODE_ID = 0xffff;
+/** A distinguished binding index used to indicate the absence of a binding. */
+export const NULL_BINDING = 0xff;
+
+/** This key is "ZigBeeAlliance09" */
+export const INTEROPERABILITY_LINK_KEY: readonly number[] = [
+    0x5a, 0x69, 0x67, 0x42, 0x65, 0x65, 0x41, 0x6c, 0x6c, 0x69, 0x61, 0x6e, 0x63, 0x65, 0x30, 0x39,
+];
+
+export const PERMIT_JOIN_FOREVER = 0xff;
+export const PERMIT_JOIN_MAX_TIMEOUT = 0xfe;
+
+/** Size of EUI64 (an IEEE address) in bytes. */
+export const EUI64_SIZE = 8;
+/** Size of an PAN identifier in bytes. */
+export const PAN_ID_SIZE = 2;
+/** Size of an extended PAN identifier in bytes. */
+export const EXTENDED_PAN_ID_SIZE = 8;
+/** Size of an encryption key in bytes. */
+export const DEFAULT_ENCRYPTION_KEY_SIZE = 16;
+/** Size of a AES-128-MMO (Matyas-Meyer-Oseas) block in bytes. */
+export const AES_MMO_128_BLOCK_SIZE = 16;
+/**
+ * Valid install code sizes, including `INSTALL_CODE_CRC_SIZE`.
+ *
+ * NOTE: 18 is now standard, first for iterations, order after is important (8 before 10)!
+ */
+export const INSTALL_CODE_SIZES: ReadonlyArray<number> = [18, 8, 10, 14];
+/** Size of the CRC appended to install codes. */
+export const INSTALL_CODE_CRC_SIZE = 2;

package/src/zspec/enums.ts

@@ -0,0 +1,22 @@
+/**
+ * ZigBee Broadcast Addresses
+ *
+ * ZigBee specifies three different broadcast addresses that reach different collections of nodes.
+ * Broadcasts are normally sent only to routers.
+ * Broadcasts can also be forwarded to end devices, either all of them or only those that do not sleep.
+ * Broadcasting to end devices is both significantly more resource-intensive and significantly less reliable than broadcasting to routers.
+ */
+export enum BroadcastAddress {
+    // Reserved = 0xfff8,
+    // Reserved = 0xfff9,
+    // Reserved = 0xfffa,
+    /** Low power routers only */
+    LOW_POWER_ROUTERS = 0xfffb,
+    /** All routers and coordinator */
+    DEFAULT = 0xfffc,
+    /** macRxOnWhenIdle = TRUE (all non-sleepy devices) */
+    RX_ON_WHEN_IDLE = 0xfffd,
+    // Reserved = 0xFFFE,
+    /** All devices in PAN (including sleepy end devices) */
+    SLEEPY = 0xffff,
+}

package/src/zspec/index.ts

@@ -0,0 +1,3 @@
+export * from "./consts";
+export * from "./enums";
+export * as Utils from "./utils";

package/src/zspec/tstypes.ts

@@ -0,0 +1,18 @@
+/**
+ * EUI 64-bit ID (IEEE 802.15.4 long address). uint8[EUI64_SIZE]
+ *
+ * NOTE: Expected to contain `0x` prefix
+ */
+export type Eui64 = `0x${string}`;
+/** IEEE 802.15.4 node ID. Also known as short address. uint16 */
+export type NodeId = number;
+/** IEEE 802.15.4 PAN ID. uint16 */
+export type PanId = number;
+/** PAN 64-bit ID (IEEE 802.15.4 long address). uint8[EXTENDED_PAN_ID_SIZE] */
+export type ExtendedPanId = number[];
+/** 16-bit ZigBee multicast group identifier. uint16 */
+export type MulticastId = number;
+/** Refer to the Zigbee application profile ID. uint16 */
+export type ProfileId = number;
+/** Refer to the ZCL cluster ID. uint16 */
+export type ClusterId = number;