zigbee-herdsman 3.5.2 → 4.0.0

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

@@ -0,0 +1,103 @@
+const ZDO = {
+    status: {
+        SUCCESS: 0,
+        INVALID_REQTYPE: 128,
+        DEVICE_NOT_FOUND: 129,
+        INVALID_EP: 130,
+        NOT_ACTIVE: 131,
+        NOT_SUPPORTED: 132,
+        TIMEOUT: 133,
+        NO_MATCH: 134,
+        NO_ENTRY: 136,
+        NO_DESCRIPTOR: 137,
+        INSUFFICIENT_SPACE: 138,
+        NOT_PERMITTED: 139,
+        TABLE_FULL: 140,
+        NOT_AUTHORIZED: 141,
+        BINDING_TABLE_FULL: 142,
+    },
+    initDev: {
+        RESTORED_NETWORK_STATE: 0,
+        NEW_NETWORK_STATE: 1,
+        LEAVE_NOT_STARTED: 2,
+    },
+    serverCapability: {
+        NOT_SUPPORTED: 0,
+        PRIM_TRUST_CENTER: 1,
+        BKUP_TRUST_CENTER: 2,
+        PRIM_BIND_TABLE: 4,
+        BKUP_BIND_TABLE: 8,
+        PRIM_DISC_TABLE: 16,
+        BKUP_DISC_TABLE: 32,
+        NETWORK_MANAGER: 64,
+    },
+    appDevVer: {
+        VER_100: 0,
+        RESERVE01: 1,
+        RESERVE02: 2,
+        RESERVE03: 3,
+        RESERVE04: 4,
+        RESERVE05: 5,
+        RESERVE06: 6,
+        RESERVE07: 7,
+        RESERVE08: 8,
+        RESERVE09: 9,
+        RESERVE10: 10,
+        RESERVE11: 11,
+        RESERVE12: 12,
+        RESERVE13: 13,
+        RESERVE14: 14,
+        RESERVE15: 15,
+    },
+    stackProfileId: {
+        NETWORK_SPECIFIC: 0,
+        HOME_CONTROLS: 1,
+        ZIGBEEPRO_PROFILE: 2,
+        GENERIC_STAR: 3,
+        GENERIC_TREE: 4,
+    },
+    deviceLogicalType: {
+        COORDINATOR: 0,
+        ROUTER: 1,
+        ENDDEVICE: 2,
+        COMPLEX_DESC_AVAIL: 4,
+        USER_DESC_AVAIL: 8,
+        RESERVED1: 16,
+        RESERVED2: 32,
+        RESERVED3: 64,
+        RESERVED4: 128,
+    },
+    addrReqType: {
+        SINGLE: 0,
+        EXTENDED: 1,
+    },
+    leaveAndRemoveChild: {
+        NONE: 0,
+        LEAVE_REMOVE_CHILDREN: 1,
+    },
+    leaveIndRequest: {
+        INDICATION: 0,
+        REQUEST: 1,
+    },
+    leaveIndRemove: {
+        NONE: 0,
+        REMOVE_CHILDREN: 1,
+    },
+    leaveIndRejoin: {
+        NONE: 0,
+        REJOIN: 1,
+    },
+    descCapability: {
+        EXT_LIST_NOT_SUPPORTED: 0,
+        EXT_ACTIVE_EP_LIST_AVAIL: 1,
+        EXT_SIMPLE_DESC_LIST_AVAIL: 2,
+        RESERVED1: 4,
+        RESERVED2: 8,
+        RESERVED3: 16,
+        RESERVED4: 32,
+        RESERVED5: 64,
+        RESERVED6: 128,
+    },
+};
+
+export default ZDO;

package/src/adapter/z-stack/models/startup-options.ts

@@ -0,0 +1,13 @@
+import type {TsType} from "../../";
+import type {ZnpVersion} from "../adapter/tstype";
+
+/**
+ * Startup options structure is used by `zStackAdapter` to pass configuration to adapter manager.
+ */
+export interface StartupOptions {
+    version: ZnpVersion;
+    networkOptions: TsType.NetworkOptions;
+    greenPowerGroup: number;
+    backupPath: string;
+    adapterOptions: TsType.AdapterOptions;
+}

package/src/adapter/z-stack/structs/entries/address-manager-entry.ts

@@ -0,0 +1,44 @@
+import {Struct} from "../struct";
+
+/**
+ * Address manager entry flags present in `user` field.
+ *
+ * *Definition from Z-Stack 3.0.2 `ADdrMgr.h`*
+ */
+export enum AddressManagerUser {
+    /* ADDRMGR_USER_DEFAULT */
+    Default = 0x00,
+
+    /* ADDRMGR_USER_ASSOC */
+    Assoc = 0x01,
+
+    /* ADDRMGR_USER_SECURITY */
+    Security = 0x02,
+
+    /* ADDRMGR_USER_BINDING */
+    Binding = 0x04,
+
+    /* ADDRMGR_USER_PRIVATE1 */
+    Private1 = 0x08,
+}
+
+const emptyAddress1 = Buffer.alloc(8, 0x00);
+const emptyAddress2 = Buffer.alloc(8, 0xff);
+
+/**
+ * Creates an address manager entry.
+ *
+ * *Definition from Z-Stack 3.0.2 `AddrMgr.h`*
+ * *The `uint16` index field is not physically present.*
+ *
+ * @param data Data to initialize structure with.
+ */
+export const addressManagerEntry = (data?: Buffer) => {
+    return Struct.new()
+        .member("uint8", "user")
+        .member("uint16", "nwkAddr")
+        .member("uint8array-reversed", "extAddr", 8)
+        .method("isSet", Boolean.prototype, (e) => e.user !== 0x00 && !e.extAddr.equals(emptyAddress1) && !e.extAddr.equals(emptyAddress2))
+        .padding(0xff)
+        .build(data);
+};

package/src/adapter/z-stack/structs/entries/address-manager-table.ts

@@ -0,0 +1,19 @@
+import assert from "node:assert";
+
+import type {StructMemoryAlignment} from "../struct";
+import {Table} from "../table";
+import {addressManagerEntry} from "./address-manager-entry";
+
+/**
+ * Creates an address manager inline table present within Z-Stack NV memory.
+ *
+ * @param data Data to initialize table with.
+ * @param alignment Memory alignment of initialization data.
+ */
+export const addressManagerTable = (dataOrCapacity?: Buffer | Buffer[] | number, alignment: StructMemoryAlignment = "unaligned") => {
+    const table = Table.new<ReturnType<typeof addressManagerEntry>>()
+        .struct(addressManagerEntry)
+        .occupancy((e) => e.isSet() as boolean);
+    assert(dataOrCapacity !== undefined, "dataOrCapacity cannot be undefined");
+    return typeof dataOrCapacity === "number" ? table.build(dataOrCapacity) : table.build(dataOrCapacity, alignment);
+};

package/src/adapter/z-stack/structs/entries/aps-link-key-data-entry.ts

@@ -0,0 +1,12 @@
+import {Struct} from "../struct";
+
+/**
+ * Creates a APS Link Key Data Entry.
+ *
+ * *Definition from Z-Stack 3.0.2 `APSMEDE.h`*
+ *
+ * @param data Data to initialize structure with.
+ */
+export const apsLinkKeyDataEntry = (data?: Buffer) => {
+    return Struct.new().member("uint8array", "key", 16).member("uint32", "txFrmCntr").member("uint32", "rxFrmCntr").build(data);
+};

package/src/adapter/z-stack/structs/entries/aps-link-key-data-table.ts

@@ -0,0 +1,21 @@
+import assert from "node:assert";
+
+import type {StructMemoryAlignment} from "../struct";
+import {Table} from "../table";
+import {apsLinkKeyDataEntry} from "./aps-link-key-data-entry";
+
+const emptyKey = Buffer.alloc(16, 0x00);
+
+/**
+ * Creates an APS link key data table.
+ *
+ * @param data Data to initialize table with.
+ * @param alignment Memory alignment of initialization data.
+ */
+export const apsLinkKeyDataTable = (dataOrCapacity?: Buffer | Buffer[] | number, alignment: StructMemoryAlignment = "unaligned") => {
+    const table = Table.new<ReturnType<typeof apsLinkKeyDataEntry>>()
+        .struct(apsLinkKeyDataEntry)
+        .occupancy((e) => !e.key.equals(emptyKey));
+    assert(dataOrCapacity !== undefined, "dataOrCapacity cannot be undefined");
+    return typeof dataOrCapacity === "number" ? table.build(dataOrCapacity) : table.build(dataOrCapacity, alignment);
+};

package/src/adapter/z-stack/structs/entries/aps-tc-link-key-entry.ts

@@ -0,0 +1,19 @@
+import {Struct} from "../struct";
+
+/**
+ * Creates a APS ME Trust Center Link Key NV Entry struct.
+ *
+ * *Definition from Z-Stack 3.0.2 `APSMEDE.h`*
+ *
+ * @param data Data to initialize structure with.
+ */
+export const apsTcLinkKeyEntry = (data?: Buffer) => {
+    return Struct.new()
+        .member("uint32", "txFrmCntr")
+        .member("uint32", "rxFrmCntr")
+        .member("uint8array-reversed", "extAddr", 8)
+        .member("uint8", "keyAttributes")
+        .member("uint8", "keyType")
+        .member("uint8", "SeedShift_IcIndex")
+        .build(data);
+};

package/src/adapter/z-stack/structs/entries/aps-tc-link-key-table.ts

@@ -0,0 +1,21 @@
+import assert from "node:assert";
+
+import type {StructMemoryAlignment} from "../struct";
+import {Table} from "../table";
+import {apsTcLinkKeyEntry} from "./aps-tc-link-key-entry";
+
+const emptyAddress = Buffer.alloc(8, 0x00);
+
+/**
+ * Creates an APS trust center link key data table.
+ *
+ * @param data Data to initialize table with.
+ * @param alignment Memory alignment of initialization data.
+ */
+export const apsTcLinkKeyTable = (dataOrCapacity?: Buffer | Buffer[] | number, alignment: StructMemoryAlignment = "unaligned") => {
+    const table = Table.new<ReturnType<typeof apsTcLinkKeyEntry>>()
+        .struct(apsTcLinkKeyEntry)
+        .occupancy((e) => !e.extAddr.equals(emptyAddress));
+    assert(dataOrCapacity !== undefined, "dataOrCapacity cannot be undefined");
+    return typeof dataOrCapacity === "number" ? table.build(dataOrCapacity) : table.build(dataOrCapacity, alignment);
+};

package/src/adapter/z-stack/structs/entries/channel-list.ts

@@ -0,0 +1,8 @@
+import {Struct} from "../struct";
+
+/**
+ * Creates a channel list struct.
+ *
+ * @param data Data to initialize structure with.
+ */
+export const channelList = (data?: Buffer) => Struct.new().member("uint32", "channelList").build(data);

package/src/adapter/z-stack/structs/entries/has-configured.ts

@@ -0,0 +1,16 @@
+import assert from "node:assert";
+
+import {Struct} from "../struct";
+
+/**
+ * Creates a zigbee-herdsman `hasConfigured` struct.
+ *
+ * @param data Data to initialize structure with.
+ */
+export const hasConfigured = (data?: Buffer | Buffer[]) => {
+    assert(!Array.isArray(data));
+    return Struct.new()
+        .member("uint8", "hasConfigured")
+        .method("isConfigured", Boolean.prototype, (struct) => struct.hasConfigured === 0x55)
+        .build(data);
+};

package/src/adapter/z-stack/structs/entries/index.ts

@@ -0,0 +1,16 @@
+export * from "./channel-list";
+export * from "./has-configured";
+export * from "./nib";
+export * from "./nwk-key-descriptor";
+export * from "./nwk-key";
+export * from "./nwk-pan-id";
+export * from "./nwk-sec-material-descriptor-entry";
+export * from "./nwk-sec-material-descriptor-table";
+export * from "./aps-tc-link-key-entry";
+export * from "./aps-tc-link-key-table";
+export * from "./aps-link-key-data-entry";
+export * from "./aps-link-key-data-table";
+export * from "./address-manager-entry";
+export * from "./address-manager-table";
+export * from "./security-manager-entry";
+export * from "./security-manager-table";

package/src/adapter/z-stack/structs/entries/nib.ts

@@ -0,0 +1,66 @@
+import assert from "node:assert";
+
+import {Struct} from "../struct";
+import {nwkKeyDescriptor} from "./nwk-key-descriptor";
+
+/**
+ * Creates a NIB (Network Information Base) struct.
+ *
+ * *Definition from Z-Stack 3.0.2 `nwk.h`*
+ *
+ * @param data Data to initialize structure with.
+ */
+export const nib = (data?: Buffer | Buffer[]) => {
+    assert(!Array.isArray(data));
+    return Struct.new()
+        .member("uint8", "SequenceNum")
+        .member("uint8", "PassiveAckTimeout")
+        .member("uint8", "MaxBroadcastRetries")
+        .member("uint8", "MaxChildren")
+        .member("uint8", "MaxDepth")
+        .member("uint8", "MaxRouters")
+        .member("uint8", "dummyNeighborTable")
+        .member("uint8", "BroadcastDeliveryTime")
+        .member("uint8", "ReportConstantCost")
+        .member("uint8", "RouteDiscRetries")
+        .member("uint8", "dummyRoutingTable")
+        .member("uint8", "SecureAllFrames")
+        .member("uint8", "SecurityLevel")
+        .member("uint8", "SymLink")
+        .member("uint8", "CapabilityFlags")
+        .member("uint16", "TransactionPersistenceTime")
+        .member("uint8", "nwkProtocolVersion")
+        .member("uint8", "RouteDiscoveryTime")
+        .member("uint8", "RouteExpiryTime")
+        .member("uint16", "nwkDevAddress")
+        .member("uint8", "nwkLogicalChannel")
+        .member("uint16", "nwkCoordAddress")
+        .member("uint8array-reversed", "nwkCoordExtAddress", 8)
+        .member("uint16", "nwkPanId")
+        .member("uint8", "nwkState")
+        .member("uint32", "channelList")
+        .member("uint8", "beaconOrder")
+        .member("uint8", "superFrameOrder")
+        .member("uint8", "scanDuration")
+        .member("uint8", "battLifeExt")
+        .member("uint32", "allocatedRouterAddresses")
+        .member("uint32", "allocatedEndDeviceAddresses")
+        .member("uint8", "nodeDepth")
+        .member("uint8array-reversed", "extendedPANID", 8)
+        .member("uint8", "nwkKeyLoaded")
+        .member("struct", "spare1", nwkKeyDescriptor)
+        .member("struct", "spare2", nwkKeyDescriptor)
+        .member("uint8", "spare3")
+        .member("uint8", "spare4")
+        .member("uint8", "nwkLinkStatusPeriod")
+        .member("uint8", "nwkRouterAgeLimit")
+        .member("uint8", "nwkUseMultiCast")
+        .member("uint8", "nwkIsConcentrator")
+        .member("uint8", "nwkConcentratorDiscoveryTime")
+        .member("uint8", "nwkConcentratorRadius")
+        .member("uint8", "nwkAllFresh")
+        .member("uint16", "nwkManagerAddr")
+        .member("uint16", "nwkTotalTransmissions")
+        .member("uint8", "nwkUpdateId")
+        .build(data);
+};

package/src/adapter/z-stack/structs/entries/nwk-key-descriptor.ts

@@ -0,0 +1,15 @@
+import assert from "node:assert";
+
+import {Struct} from "../struct";
+
+/**
+ * Creates a Security Service Provider (SSP) Network Descriptor struct.
+ *
+ * *Definition from Z-Stack 3.0.2 `ssp.h`*
+ *
+ * @param data Data to initialize structure with.
+ */
+export const nwkKeyDescriptor = (data?: Buffer | Buffer[]) => {
+    assert(!Array.isArray(data));
+    return Struct.new().member("uint8", "keySeqNum").member("uint8array", "key", 16).build(data);
+};

package/src/adapter/z-stack/structs/entries/nwk-key.ts

@@ -0,0 +1,13 @@
+import assert from "node:assert";
+
+import {Struct} from "../struct";
+
+/**
+ * Creates a network key struct.
+ *
+ * @param data Data to initialize structure with.
+ */
+export const nwkKey = (data?: Buffer | Buffer[]) => {
+    assert(!Array.isArray(data));
+    return Struct.new().member("uint8array", "key", 16).build(data);
+};

package/src/adapter/z-stack/structs/entries/nwk-pan-id.ts

@@ -0,0 +1,8 @@
+import {Struct} from "../struct";
+
+/**
+ * Creates a network PAN ID struct.
+ *
+ * @param data Data to initialize structure with.
+ */
+export const nwkPanId = (data?: Buffer) => Struct.new().member("uint16", "panId").build(data);

package/src/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-entry.ts

@@ -0,0 +1,20 @@
+import {Struct} from "../struct";
+
+const emptyExtendedPanId = Buffer.alloc(8, 0x00);
+
+/**
+ * Create a ZigBee Device Security Manager Security Material struct. This structure stores a frame counter
+ * associated with a particular Extended PAN ID used by device. Used in NV in table format:
+ * - `ZCD_NV_EX_NWK_SEC_MATERIAL_TABLE` - extended table (SimpleLink Z-Stack 3.x.0)
+ * - `ZCD_NV_LEGACY_NWK_SEC_MATERIAL_TABLE_START` through `ZCD_NV_LEGACY_NWK_SEC_MATERIAL_TABLE_END` (Z-Stack 3.0.x)
+ *
+ * *Definition from Z-Stack 3.0.2 `ZDSecMgr.h`*
+ *
+ * @param data Data to initialize structure with.
+ */
+export const nwkSecMaterialDescriptorEntry = (data?: Buffer) =>
+    Struct.new()
+        .member("uint32", "FrameCounter")
+        .member("uint8array-reversed", "extendedPanID", 8)
+        .method("isSet", Boolean.prototype, (struct) => !struct.extendedPanID.equals(emptyExtendedPanId))
+        .build(data);

package/src/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-table.ts

@@ -0,0 +1,19 @@
+import assert from "node:assert";
+
+import type {StructMemoryAlignment} from "../struct";
+import {Table} from "../table";
+import {nwkSecMaterialDescriptorEntry} from "./nwk-sec-material-descriptor-entry";
+
+/**
+ * Creates a network security material table.
+ *
+ * @param data Data to initialize table with.
+ * @param alignment Memory alignment of initialization data.
+ */
+export const nwkSecMaterialDescriptorTable = (dataOrCapacity?: Buffer | Buffer[] | number, alignment: StructMemoryAlignment = "unaligned") => {
+    const table = Table.new<ReturnType<typeof nwkSecMaterialDescriptorEntry>>()
+        .struct(nwkSecMaterialDescriptorEntry)
+        .occupancy((e) => e.isSet() as boolean);
+    assert(dataOrCapacity !== undefined, "dataOrCapacity cannot be undefined");
+    return typeof dataOrCapacity === "number" ? table.build(dataOrCapacity) : table.build(dataOrCapacity, alignment);
+};

package/src/adapter/z-stack/structs/entries/security-manager-entry.ts

@@ -0,0 +1,33 @@
+import {Struct} from "../struct";
+
+/**
+ * Security manager authentication options.
+ *
+ * *Definition from Z-Stack 3.0.2 `ZDSecMgr.h.h`*
+ */
+export enum SecurityManagerAuthenticationOption {
+    /* ZDSecMgr_Not_Authenticated */
+    Default = 0x00,
+
+    /* ZDSecMgr_Authenticated_CBCK */
+    AuthenticatedCBCK = 0x01,
+
+    /* ZDSecMgr_Authenticated_EA */
+    AuthenticatedEA = 0x02,
+}
+
+/**
+ * Creates a security manager entry.
+ *
+ * *Definition from Z-Stack 3.0.2 `ZDSecMgr.c`*
+ *
+ * @param data Data to initialize structure with.
+ */
+export const securityManagerEntry = (data?: Buffer) => {
+    return Struct.new()
+        .member("uint16", "ami")
+        .member("uint16", "keyNvId")
+        .member("uint8", "authenticationOption")
+        .default(Buffer.from("feff000000", "hex"))
+        .build(data);
+};

package/src/adapter/z-stack/structs/entries/security-manager-table.ts

@@ -0,0 +1,22 @@
+import assert from "node:assert";
+
+import type {StructMemoryAlignment} from "../struct";
+import {Table} from "../table";
+import {SecurityManagerAuthenticationOption, securityManagerEntry} from "./security-manager-entry";
+
+/**
+ * Creates a security manager inline table present within Z-Stack NV memory.
+ *
+ * @param data Data to initialize table with.
+ * @param alignment Memory alignment of initialization data.
+ */
+export const securityManagerTable = (dataOrCapacity?: Buffer | Buffer[] | number, alignment: StructMemoryAlignment = "unaligned") => {
+    const table = Table.new<ReturnType<typeof securityManagerEntry>>()
+        .struct(securityManagerEntry)
+        .occupancy(
+            (e) => ![0xfffe, 0xffff].includes(e.ami) && !(e.ami === 0x0000 && e.authenticationOption === SecurityManagerAuthenticationOption.Default),
+        )
+        .inlineHeader();
+    assert(dataOrCapacity !== undefined, "dataOrCapacity cannot be undefined");
+    return typeof dataOrCapacity === "number" ? table.build(dataOrCapacity) : table.build(dataOrCapacity, alignment);
+};

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

@@ -0,0 +1,4 @@
+export * from "./struct";
+export * from "./table";
+export * from "./serializable-memory-object";
+export * from "./entries";

package/src/adapter/z-stack/structs/serializable-memory-object.ts

@@ -0,0 +1,14 @@
+import type {StructMemoryAlignment} from "./struct";
+
+/**
+ * Interface for serializable items to be written to NV. Objects implementing this interface
+ * are structs and tables.
+ */
+export interface SerializableMemoryObject {
+    serialize(alignment?: StructMemoryAlignment): Buffer;
+}
+
+/**
+ * Signature for factory returning a memory struct or a table.
+ */
+export type MemoryObjectFactory<T> = (data?: Buffer | Buffer[], alignment?: StructMemoryAlignment) => T;