zigbee-herdsman 6.0.1 → 6.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (260) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/adapter/ezsp/driver/uart.js +1 -1
  3. package/dist/adapter/ezsp/driver/uart.js.map +1 -1
  4. package/dist/adapter/z-stack/adapter/zStackAdapter.js +4 -4
  5. package/dist/adapter/z-stack/adapter/zStackAdapter.js.map +1 -1
  6. package/dist/adapter/zigate/adapter/zigateAdapter.js +4 -4
  7. package/dist/adapter/zigate/adapter/zigateAdapter.js.map +1 -1
  8. package/dist/controller/model/device.d.ts.map +1 -1
  9. package/dist/controller/model/device.js +1 -0
  10. package/dist/controller/model/device.js.map +1 -1
  11. package/package.json +14 -6
  12. package/.github/ISSUE_TEMPLATE/config.yml +0 -5
  13. package/.github/dependabot.yml +0 -22
  14. package/.github/workflows/ci.yml +0 -64
  15. package/.github/workflows/release-please.yml +0 -18
  16. package/.github/workflows/stale.yml +0 -20
  17. package/.github/workflows/typedoc.yaml +0 -47
  18. package/.release-please-manifest.json +0 -3
  19. package/.vscode/extensions.json +0 -3
  20. package/.vscode/settings.json +0 -11
  21. package/biome.json +0 -98
  22. package/examples/join-and-log.js +0 -24
  23. package/release-please-config.json +0 -9
  24. package/src/adapter/adapter.ts +0 -189
  25. package/src/adapter/adapterDiscovery.ts +0 -666
  26. package/src/adapter/const.ts +0 -12
  27. package/src/adapter/deconz/adapter/deconzAdapter.ts +0 -877
  28. package/src/adapter/deconz/driver/constants.ts +0 -246
  29. package/src/adapter/deconz/driver/driver.ts +0 -1540
  30. package/src/adapter/deconz/driver/frame.ts +0 -11
  31. package/src/adapter/deconz/driver/frameParser.ts +0 -753
  32. package/src/adapter/deconz/driver/parser.ts +0 -45
  33. package/src/adapter/deconz/driver/writer.ts +0 -22
  34. package/src/adapter/deconz/types.d.ts +0 -13
  35. package/src/adapter/ember/adapter/emberAdapter.ts +0 -2265
  36. package/src/adapter/ember/adapter/endpoints.ts +0 -86
  37. package/src/adapter/ember/adapter/oneWaitress.ts +0 -324
  38. package/src/adapter/ember/adapter/tokensManager.ts +0 -782
  39. package/src/adapter/ember/consts.ts +0 -178
  40. package/src/adapter/ember/enums.ts +0 -1746
  41. package/src/adapter/ember/ezsp/buffalo.ts +0 -1392
  42. package/src/adapter/ember/ezsp/consts.ts +0 -148
  43. package/src/adapter/ember/ezsp/enums.ts +0 -1114
  44. package/src/adapter/ember/ezsp/ezsp.ts +0 -9061
  45. package/src/adapter/ember/ezspError.ts +0 -10
  46. package/src/adapter/ember/types.ts +0 -866
  47. package/src/adapter/ember/uart/ash.ts +0 -1960
  48. package/src/adapter/ember/uart/consts.ts +0 -109
  49. package/src/adapter/ember/uart/enums.ts +0 -192
  50. package/src/adapter/ember/uart/parser.ts +0 -48
  51. package/src/adapter/ember/uart/queues.ts +0 -247
  52. package/src/adapter/ember/uart/writer.ts +0 -53
  53. package/src/adapter/ember/utils/initters.ts +0 -58
  54. package/src/adapter/ember/utils/math.ts +0 -73
  55. package/src/adapter/events.ts +0 -21
  56. package/src/adapter/ezsp/adapter/backup.ts +0 -109
  57. package/src/adapter/ezsp/adapter/ezspAdapter.ts +0 -614
  58. package/src/adapter/ezsp/driver/commands.ts +0 -2497
  59. package/src/adapter/ezsp/driver/consts.ts +0 -11
  60. package/src/adapter/ezsp/driver/driver.ts +0 -1002
  61. package/src/adapter/ezsp/driver/ezsp.ts +0 -802
  62. package/src/adapter/ezsp/driver/frame.ts +0 -101
  63. package/src/adapter/ezsp/driver/index.ts +0 -4
  64. package/src/adapter/ezsp/driver/multicast.ts +0 -78
  65. package/src/adapter/ezsp/driver/parser.ts +0 -81
  66. package/src/adapter/ezsp/driver/types/basic.ts +0 -201
  67. package/src/adapter/ezsp/driver/types/index.ts +0 -239
  68. package/src/adapter/ezsp/driver/types/named.ts +0 -2330
  69. package/src/adapter/ezsp/driver/types/struct.ts +0 -844
  70. package/src/adapter/ezsp/driver/uart.ts +0 -460
  71. package/src/adapter/ezsp/driver/utils/crc16ccitt.ts +0 -44
  72. package/src/adapter/ezsp/driver/utils/index.ts +0 -32
  73. package/src/adapter/ezsp/driver/writer.ts +0 -64
  74. package/src/adapter/index.ts +0 -3
  75. package/src/adapter/serialPort.ts +0 -58
  76. package/src/adapter/socketPortUtils.ts +0 -16
  77. package/src/adapter/tstype.ts +0 -78
  78. package/src/adapter/z-stack/adapter/adapter-backup.ts +0 -519
  79. package/src/adapter/z-stack/adapter/adapter-nv-memory.ts +0 -457
  80. package/src/adapter/z-stack/adapter/endpoints.ts +0 -57
  81. package/src/adapter/z-stack/adapter/manager.ts +0 -543
  82. package/src/adapter/z-stack/adapter/tstype.ts +0 -6
  83. package/src/adapter/z-stack/adapter/zStackAdapter.ts +0 -1190
  84. package/src/adapter/z-stack/constants/af.ts +0 -27
  85. package/src/adapter/z-stack/constants/common.ts +0 -285
  86. package/src/adapter/z-stack/constants/dbg.ts +0 -23
  87. package/src/adapter/z-stack/constants/index.ts +0 -11
  88. package/src/adapter/z-stack/constants/mac.ts +0 -128
  89. package/src/adapter/z-stack/constants/sapi.ts +0 -25
  90. package/src/adapter/z-stack/constants/sys.ts +0 -72
  91. package/src/adapter/z-stack/constants/util.ts +0 -82
  92. package/src/adapter/z-stack/constants/utils.ts +0 -14
  93. package/src/adapter/z-stack/constants/zdo.ts +0 -103
  94. package/src/adapter/z-stack/models/startup-options.ts +0 -13
  95. package/src/adapter/z-stack/structs/entries/address-manager-entry.ts +0 -44
  96. package/src/adapter/z-stack/structs/entries/address-manager-table.ts +0 -19
  97. package/src/adapter/z-stack/structs/entries/aps-link-key-data-entry.ts +0 -12
  98. package/src/adapter/z-stack/structs/entries/aps-link-key-data-table.ts +0 -21
  99. package/src/adapter/z-stack/structs/entries/aps-tc-link-key-entry.ts +0 -19
  100. package/src/adapter/z-stack/structs/entries/aps-tc-link-key-table.ts +0 -21
  101. package/src/adapter/z-stack/structs/entries/channel-list.ts +0 -8
  102. package/src/adapter/z-stack/structs/entries/has-configured.ts +0 -16
  103. package/src/adapter/z-stack/structs/entries/index.ts +0 -16
  104. package/src/adapter/z-stack/structs/entries/nib.ts +0 -66
  105. package/src/adapter/z-stack/structs/entries/nwk-key-descriptor.ts +0 -15
  106. package/src/adapter/z-stack/structs/entries/nwk-key.ts +0 -13
  107. package/src/adapter/z-stack/structs/entries/nwk-pan-id.ts +0 -8
  108. package/src/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-entry.ts +0 -20
  109. package/src/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-table.ts +0 -19
  110. package/src/adapter/z-stack/structs/entries/security-manager-entry.ts +0 -33
  111. package/src/adapter/z-stack/structs/entries/security-manager-table.ts +0 -22
  112. package/src/adapter/z-stack/structs/index.ts +0 -4
  113. package/src/adapter/z-stack/structs/serializable-memory-object.ts +0 -14
  114. package/src/adapter/z-stack/structs/struct.ts +0 -367
  115. package/src/adapter/z-stack/structs/table.ts +0 -198
  116. package/src/adapter/z-stack/unpi/constants.ts +0 -33
  117. package/src/adapter/z-stack/unpi/frame.ts +0 -62
  118. package/src/adapter/z-stack/unpi/index.ts +0 -4
  119. package/src/adapter/z-stack/unpi/parser.ts +0 -56
  120. package/src/adapter/z-stack/unpi/writer.ts +0 -21
  121. package/src/adapter/z-stack/utils/channel-list.ts +0 -40
  122. package/src/adapter/z-stack/utils/index.ts +0 -2
  123. package/src/adapter/z-stack/utils/network-options.ts +0 -26
  124. package/src/adapter/z-stack/znp/buffaloZnp.ts +0 -175
  125. package/src/adapter/z-stack/znp/definition.ts +0 -2713
  126. package/src/adapter/z-stack/znp/index.ts +0 -2
  127. package/src/adapter/z-stack/znp/parameterType.ts +0 -22
  128. package/src/adapter/z-stack/znp/tstype.ts +0 -44
  129. package/src/adapter/z-stack/znp/utils.ts +0 -10
  130. package/src/adapter/z-stack/znp/znp.ts +0 -342
  131. package/src/adapter/z-stack/znp/zpiObject.ts +0 -148
  132. package/src/adapter/zboss/adapter/zbossAdapter.ts +0 -526
  133. package/src/adapter/zboss/commands.ts +0 -1184
  134. package/src/adapter/zboss/consts.ts +0 -9
  135. package/src/adapter/zboss/driver.ts +0 -422
  136. package/src/adapter/zboss/enums.ts +0 -360
  137. package/src/adapter/zboss/frame.ts +0 -227
  138. package/src/adapter/zboss/reader.ts +0 -65
  139. package/src/adapter/zboss/types.ts +0 -0
  140. package/src/adapter/zboss/uart.ts +0 -428
  141. package/src/adapter/zboss/utils.ts +0 -58
  142. package/src/adapter/zboss/writer.ts +0 -49
  143. package/src/adapter/zigate/adapter/patchZdoBuffaloBE.ts +0 -27
  144. package/src/adapter/zigate/adapter/zigateAdapter.ts +0 -618
  145. package/src/adapter/zigate/driver/LICENSE +0 -17
  146. package/src/adapter/zigate/driver/buffaloZiGate.ts +0 -212
  147. package/src/adapter/zigate/driver/commandType.ts +0 -418
  148. package/src/adapter/zigate/driver/constants.ts +0 -150
  149. package/src/adapter/zigate/driver/frame.ts +0 -197
  150. package/src/adapter/zigate/driver/messageType.ts +0 -287
  151. package/src/adapter/zigate/driver/parameterType.ts +0 -32
  152. package/src/adapter/zigate/driver/ziGateObject.ts +0 -146
  153. package/src/adapter/zigate/driver/zigate.ts +0 -423
  154. package/src/adapter/zoh/adapter/utils.ts +0 -27
  155. package/src/adapter/zoh/adapter/zohAdapter.ts +0 -838
  156. package/src/buffalo/buffalo.ts +0 -342
  157. package/src/buffalo/index.ts +0 -1
  158. package/src/controller/controller.ts +0 -1022
  159. package/src/controller/database.ts +0 -124
  160. package/src/controller/events.ts +0 -52
  161. package/src/controller/greenPower.ts +0 -603
  162. package/src/controller/helpers/index.ts +0 -1
  163. package/src/controller/helpers/installCodes.ts +0 -107
  164. package/src/controller/helpers/request.ts +0 -96
  165. package/src/controller/helpers/requestQueue.ts +0 -125
  166. package/src/controller/helpers/zclFrameConverter.ts +0 -47
  167. package/src/controller/helpers/zclTransactionSequenceNumber.ts +0 -19
  168. package/src/controller/index.ts +0 -6
  169. package/src/controller/model/device.ts +0 -1248
  170. package/src/controller/model/endpoint.ts +0 -1105
  171. package/src/controller/model/entity.ts +0 -23
  172. package/src/controller/model/group.ts +0 -424
  173. package/src/controller/model/index.ts +0 -5
  174. package/src/controller/model/zigbeeEntity.ts +0 -30
  175. package/src/controller/touchlink.ts +0 -189
  176. package/src/controller/tstype.ts +0 -274
  177. package/src/index.ts +0 -12
  178. package/src/models/backup-storage-legacy.ts +0 -48
  179. package/src/models/backup-storage-unified.ts +0 -47
  180. package/src/models/backup.ts +0 -37
  181. package/src/models/index.ts +0 -5
  182. package/src/models/network-options.ts +0 -11
  183. package/src/utils/backup.ts +0 -152
  184. package/src/utils/index.ts +0 -5
  185. package/src/utils/logger.ts +0 -20
  186. package/src/utils/patchBigIntSerialization.ts +0 -8
  187. package/src/utils/queue.ts +0 -76
  188. package/src/utils/types.d.ts +0 -3
  189. package/src/utils/utils.ts +0 -19
  190. package/src/utils/wait.ts +0 -5
  191. package/src/utils/waitress.ts +0 -96
  192. package/src/zspec/consts.ts +0 -84
  193. package/src/zspec/enums.ts +0 -22
  194. package/src/zspec/index.ts +0 -3
  195. package/src/zspec/tstypes.ts +0 -18
  196. package/src/zspec/utils.ts +0 -247
  197. package/src/zspec/zcl/buffaloZcl.ts +0 -1220
  198. package/src/zspec/zcl/definition/cluster.ts +0 -5915
  199. package/src/zspec/zcl/definition/clusters-typegen.ts +0 -588
  200. package/src/zspec/zcl/definition/clusters-types.ts +0 -7331
  201. package/src/zspec/zcl/definition/consts.ts +0 -24
  202. package/src/zspec/zcl/definition/enums.ts +0 -203
  203. package/src/zspec/zcl/definition/foundation.ts +0 -329
  204. package/src/zspec/zcl/definition/manufacturerCode.ts +0 -729
  205. package/src/zspec/zcl/definition/status.ts +0 -69
  206. package/src/zspec/zcl/definition/tstype.ts +0 -377
  207. package/src/zspec/zcl/index.ts +0 -11
  208. package/src/zspec/zcl/utils.ts +0 -321
  209. package/src/zspec/zcl/zclFrame.ts +0 -356
  210. package/src/zspec/zcl/zclHeader.ts +0 -102
  211. package/src/zspec/zcl/zclStatusError.ts +0 -10
  212. package/src/zspec/zdo/buffaloZdo.ts +0 -2336
  213. package/src/zspec/zdo/definition/clusters.ts +0 -722
  214. package/src/zspec/zdo/definition/consts.ts +0 -16
  215. package/src/zspec/zdo/definition/enums.ts +0 -99
  216. package/src/zspec/zdo/definition/status.ts +0 -105
  217. package/src/zspec/zdo/definition/tstypes.ts +0 -1062
  218. package/src/zspec/zdo/index.ts +0 -7
  219. package/src/zspec/zdo/utils.ts +0 -76
  220. package/src/zspec/zdo/zdoStatusError.ts +0 -10
  221. package/test/adapter/adapter.test.ts +0 -1062
  222. package/test/adapter/ember/ash.test.ts +0 -337
  223. package/test/adapter/ember/consts.ts +0 -131
  224. package/test/adapter/ember/emberAdapter.test.ts +0 -3449
  225. package/test/adapter/ember/ezsp.test.ts +0 -385
  226. package/test/adapter/ember/ezspBuffalo.test.ts +0 -93
  227. package/test/adapter/ember/ezspError.test.ts +0 -12
  228. package/test/adapter/ember/math.test.ts +0 -206
  229. package/test/adapter/ezsp/frame.test.ts +0 -30
  230. package/test/adapter/ezsp/uart.test.ts +0 -181
  231. package/test/adapter/z-stack/adapter.test.ts +0 -3984
  232. package/test/adapter/z-stack/constants.test.ts +0 -33
  233. package/test/adapter/z-stack/structs.test.ts +0 -115
  234. package/test/adapter/z-stack/unpi.test.ts +0 -213
  235. package/test/adapter/z-stack/znp.test.ts +0 -1284
  236. package/test/adapter/zboss/fixZdoResponse.test.ts +0 -179
  237. package/test/adapter/zigate/patchZdoBuffaloBE.test.ts +0 -81
  238. package/test/adapter/zigate/zdo.test.ts +0 -187
  239. package/test/adapter/zoh/utils.test.ts +0 -36
  240. package/test/adapter/zoh/zohAdapter.test.ts +0 -1307
  241. package/test/buffalo.test.ts +0 -431
  242. package/test/controller.bench.ts +0 -193
  243. package/test/controller.test.ts +0 -8702
  244. package/test/greenpower.test.ts +0 -1408
  245. package/test/mockAdapters.ts +0 -65
  246. package/test/mockDevices.ts +0 -598
  247. package/test/requests.bench.ts +0 -206
  248. package/test/testUtils.ts +0 -20
  249. package/test/tsconfig.json +0 -9
  250. package/test/utils/math.ts +0 -19
  251. package/test/utils.test.ts +0 -279
  252. package/test/vitest.config.mts +0 -27
  253. package/test/zcl.test.ts +0 -2831
  254. package/test/zspec/utils.test.ts +0 -68
  255. package/test/zspec/zcl/buffalo.test.ts +0 -1374
  256. package/test/zspec/zcl/frame.test.ts +0 -960
  257. package/test/zspec/zcl/utils.test.ts +0 -273
  258. package/test/zspec/zdo/buffalo.test.ts +0 -1850
  259. package/test/zspec/zdo/utils.test.ts +0 -241
  260. package/tsconfig.json +0 -24
@@ -1,78 +0,0 @@
1
- export type Adapter = "deconz" | "ember" | "zstack" | "zboss" | "zigate" | "ezsp" | "zoh";
2
- export type DiscoverableUsbAdapter = "deconz" | "ember" | "zstack" | "zboss" | "zigate";
3
-
4
- export type UsbAdapterFingerprint = {
5
- vendorId: string;
6
- productId: string;
7
- manufacturer?: string;
8
- pathRegex: string;
9
- };
10
-
11
- export interface NetworkOptions {
12
- panID: number;
13
- extendedPanID?: number[];
14
- channelList: number[];
15
- networkKey?: number[];
16
- networkKeyDistribute?: boolean;
17
- }
18
-
19
- export interface SerialPortOptions {
20
- baudRate?: number;
21
- rtscts?: boolean;
22
- path?: string;
23
- adapter?: Adapter;
24
- }
25
-
26
- export interface AdapterOptions {
27
- concurrent?: number;
28
- delay?: number;
29
- disableLED: boolean;
30
- transmitPower?: number;
31
- forceStartWithInconsistentAdapterConfiguration?: boolean;
32
- }
33
-
34
- export interface CoordinatorVersion {
35
- type: string;
36
- meta: {[s: string]: number | string};
37
- }
38
-
39
- export type DeviceType = "Coordinator" | "EndDevice" | "Router" | "Unknown";
40
-
41
- export type StartResult = "resumed" | "reset" | "restored";
42
-
43
- export interface LQINeighbor {
44
- ieeeAddr: string;
45
- networkAddress: number;
46
- linkquality: number;
47
- relationship: number;
48
- depth: number;
49
- }
50
-
51
- export interface Lqi {
52
- neighbors: LQINeighbor[];
53
- }
54
-
55
- export interface RoutingTableEntry {
56
- destinationAddress: number;
57
- status: string;
58
- nextHop: number;
59
- }
60
-
61
- export interface RoutingTable {
62
- table: RoutingTableEntry[];
63
- }
64
-
65
- export interface Backup {
66
- adapterType: "zStack";
67
- time: string;
68
- meta: {[s: string]: number};
69
- // biome-ignore lint/suspicious/noExplicitAny: API
70
- data: any;
71
- }
72
-
73
- export interface NetworkParameters {
74
- panID: number;
75
- extendedPanID: string; // `0x${string}` same as IEEE address
76
- channel: number;
77
- nwkUpdateID: number;
78
- }
@@ -1,519 +0,0 @@
1
- import assert from "node:assert";
2
- import * as fs from "node:fs";
3
-
4
- import type * as Models from "../../../models";
5
- import {BackupUtils} from "../../../utils";
6
- import {logger} from "../../../utils/logger";
7
- import {NULL_NODE_ID, Utils as ZSpecUtils} from "../../../zspec";
8
- import {NvItemsIds, NvSystemIds} from "../constants/common";
9
- import * as Structs from "../structs";
10
- import {AddressManagerUser, SecurityManagerAuthenticationOption} from "../structs";
11
- import {Subsystem} from "../unpi/constants";
12
- import * as Utils from "../utils";
13
- import type {Znp} from "../znp";
14
- import type {AdapterNvMemory} from "./adapter-nv-memory";
15
- import {ZnpVersion} from "./tstype";
16
-
17
- const NS = "zh:zstack:backup";
18
-
19
- /**
20
- * Class providing ZNP adapter backup and restore procedures based mostly on NV memory manipulation.
21
- */
22
- export class AdapterBackup {
23
- private znp: Znp;
24
- private nv: AdapterNvMemory;
25
- private defaultPath: string;
26
-
27
- public constructor(znp: Znp, nv: AdapterNvMemory, path: string) {
28
- this.znp = znp;
29
- this.nv = nv;
30
- this.defaultPath = path;
31
- }
32
-
33
- /**
34
- * Loads currently stored backup and returns it in internal backup model.
35
- */
36
- public getStoredBackup(): Models.Backup | undefined {
37
- try {
38
- fs.accessSync(this.defaultPath);
39
- } catch {
40
- return undefined;
41
- }
42
- let data: Models.UnifiedBackupStorage | Models.LegacyBackupStorage;
43
- try {
44
- data = JSON.parse(fs.readFileSync(this.defaultPath).toString());
45
- } catch (error) {
46
- throw new Error(`Coordinator backup is corrupted (${error})`);
47
- }
48
-
49
- if ("adapterType" in data) {
50
- return BackupUtils.fromLegacyBackup(data as Models.LegacyBackupStorage);
51
- }
52
-
53
- if (data.metadata?.format === "zigpy/open-coordinator-backup" && data.metadata?.version) {
54
- if (data.metadata?.version !== 1) {
55
- throw new Error(`Unsupported open coordinator backup version (version=${data.metadata?.version})`);
56
- }
57
- return BackupUtils.fromUnifiedBackup(data as Models.UnifiedBackupStorage);
58
- }
59
-
60
- throw new Error("Unknown backup format");
61
- }
62
-
63
- /**
64
- * Creates a new backup from connected ZNP adapter and returns it in internal backup model format.
65
- */
66
- public async createBackup(ieeeAddressesInDatabase: string[]): Promise<Models.Backup> {
67
- logger.debug("creating backup", NS);
68
- const version: ZnpVersion = await this.getAdapterVersion();
69
-
70
- /* get adapter ieee address */
71
- const ieeeAddressResponse = await this.znp.requestWithReply(Subsystem.SYS, "getExtAddr", {});
72
- if (!ieeeAddressResponse.payload.extaddress || !ieeeAddressResponse.payload.extaddress.startsWith("0x")) {
73
- throw new Error("Failed to read adapter IEEE address");
74
- }
75
- const ieeeAddress = Buffer.from(ieeeAddressResponse.payload.extaddress.split("0x")[1], "hex");
76
- logger.debug("fetched adapter ieee address", NS);
77
-
78
- /* get adapter nib */
79
- const nib = await this.nv.readItem(NvItemsIds.NIB, 0, Structs.nib);
80
- if (!nib) {
81
- throw new Error("Cannot backup - adapter not commissioned");
82
- }
83
- logger.debug("fetched adapter nib", NS);
84
-
85
- /* get adapter active key information */
86
- let activeKeyInfo: ReturnType<typeof Structs.nwkKeyDescriptor>;
87
- if (version === ZnpVersion.ZStack12) {
88
- const key = Structs.nwkKey(
89
- (await this.znp.requestWithReply(Subsystem.SAPI, "readConfiguration", {configid: NvItemsIds.PRECFGKEY})).payload.value,
90
- );
91
- activeKeyInfo = Structs.nwkKeyDescriptor();
92
- activeKeyInfo.key = key.key;
93
- } else {
94
- activeKeyInfo = await this.nv.readItem(NvItemsIds.NWK_ACTIVE_KEY_INFO, 0, Structs.nwkKeyDescriptor);
95
- }
96
-
97
- if (!activeKeyInfo) {
98
- throw new Error("Cannot backup - missing active key info");
99
- }
100
- logger.debug("fetched adapter active key information", NS);
101
-
102
- /* get adapter security data */
103
- const preconfiguredKeyEnabled = await this.nv.readItem(NvItemsIds.PRECFGKEYS_ENABLE, 0);
104
- logger.debug("fetched adapter pre-configured key", NS);
105
- const addressManagerTable = await this.getAddressManagerTable(version);
106
- logger.debug(
107
- `fetched adapter address manager table (capacity=${addressManagerTable?.capacity || 0}, used=${addressManagerTable?.usedCount || 0})`,
108
- NS,
109
- );
110
- const securityManagerTable = await this.getSecurityManagerTable();
111
- logger.debug(
112
- `fetched adapter security manager table (capacity=${securityManagerTable?.usedCount || 0}, used=${securityManagerTable?.usedCount || 0})`,
113
- NS,
114
- );
115
- const apsLinkKeyDataTable = await this.getApsLinkKeyDataTable(version);
116
- logger.debug(
117
- `fetched adapter aps link key data table (capacity=${apsLinkKeyDataTable?.usedCount || 0}, used=${apsLinkKeyDataTable?.usedCount || 0})`,
118
- NS,
119
- );
120
- const tclkSeed = version === ZnpVersion.ZStack12 ? null : await this.nv.readItem(NvItemsIds.TCLK_SEED, 0, Structs.nwkKey);
121
- logger.debug("fetched adapter tclk seed", NS);
122
- const tclkTable = await this.getTclkTable(version);
123
- logger.debug(`fetched adapter tclk table (capacity=${tclkTable?.usedCount || 0}, used=${tclkTable?.usedCount || 0})`, NS);
124
- const secMaterialTable = await this.getNetworkSecurityMaterialTable(version);
125
- logger.debug(
126
- `fetched adapter network security material table (capacity=${secMaterialTable?.usedCount || 0}, used=${secMaterialTable?.usedCount || 0})`,
127
- NS,
128
- );
129
-
130
- /* examine network security material table */
131
- const genericExtendedPanId = Buffer.alloc(8, 0xff);
132
- let secMaterialDescriptor: ReturnType<typeof Structs.nwkSecMaterialDescriptorEntry> | undefined;
133
- for (const entry of secMaterialTable.used) {
134
- if (entry.extendedPanID.equals(nib.extendedPANID)) {
135
- secMaterialDescriptor = entry;
136
- break;
137
- }
138
-
139
- if (!secMaterialDescriptor && entry.extendedPanID.equals(genericExtendedPanId)) {
140
- secMaterialDescriptor = entry;
141
- }
142
- }
143
-
144
- if (!secMaterialDescriptor) {
145
- secMaterialDescriptor = Structs.nwkSecMaterialDescriptorEntry();
146
- secMaterialDescriptor.extendedPanID = nib.extendedPANID;
147
- secMaterialDescriptor.FrameCounter = version === ZnpVersion.ZStack12 ? 0 : 1250;
148
- }
149
-
150
- /* return backup structure */
151
- const backup: Models.Backup = {
152
- znp: {
153
- version: version,
154
- trustCenterLinkKeySeed: tclkSeed?.key || undefined,
155
- },
156
- networkOptions: {
157
- panId: nib.nwkPanId,
158
- extendedPanId: nib.extendedPANID,
159
- channelList: Utils.unpackChannelList(nib.channelList),
160
- networkKey: activeKeyInfo.key,
161
- networkKeyDistribute: preconfiguredKeyEnabled && preconfiguredKeyEnabled[0] === 0x01,
162
- },
163
- logicalChannel: nib.nwkLogicalChannel,
164
- networkKeyInfo: {
165
- sequenceNumber: activeKeyInfo.keySeqNum,
166
- frameCounter: secMaterialDescriptor.FrameCounter,
167
- },
168
- securityLevel: nib.SecurityLevel,
169
- networkUpdateId: nib.nwkUpdateId,
170
- coordinatorIeeeAddress: ieeeAddress,
171
- devices:
172
- addressManagerTable?.used
173
- .map((ame, ami) => {
174
- /* take all entries of assoc and/or security type */
175
- /* v8 ignore start */
176
- if (!ame.isSet() || (ame.user & (AddressManagerUser.Assoc | AddressManagerUser.Security)) === 0) {
177
- return null;
178
- }
179
- /* v8 ignore stop */
180
- let linkKeyInfo: {key: Buffer; rxCounter: number; txCounter: number} | undefined;
181
- const sme = securityManagerTable.used.find((e) => e.ami === ami);
182
- if (sme) {
183
- const apsKeyDataIndex = version === ZnpVersion.ZStack30x ? sme.keyNvId - NvItemsIds.APS_LINK_KEY_DATA_START : sme.keyNvId;
184
- /* v8 ignore next */
185
- const apsKeyData = apsLinkKeyDataTable.used[apsKeyDataIndex] || null;
186
- if (apsKeyData) {
187
- linkKeyInfo = {
188
- key: apsKeyData.key,
189
- rxCounter: apsKeyData.rxFrmCntr,
190
- txCounter: apsKeyData.txFrmCntr,
191
- };
192
- }
193
- } else {
194
- const tclkTableEntry = tclkTable.used.find((e) => e.extAddr.equals(ame.extAddr));
195
- if (tclkTableEntry) {
196
- assert(tclkSeed, "Cannot be undefined because this is only called for ZStack 3");
197
- const rotatedSeed = Buffer.concat([
198
- tclkSeed.key.subarray(tclkTableEntry.SeedShift_IcIndex),
199
- tclkSeed.key.subarray(0, tclkTableEntry.SeedShift_IcIndex),
200
- ]);
201
- const extAddrReversed = Buffer.from(ame.extAddr).reverse();
202
- const extAddrRepeated = Buffer.concat([extAddrReversed, extAddrReversed]);
203
- const derivedKey = Buffer.alloc(16);
204
- for (let i = 0; i < 16; i++) {
205
- derivedKey[i] = rotatedSeed[i] ^ extAddrRepeated[i];
206
- }
207
- linkKeyInfo = {
208
- key: derivedKey,
209
- rxCounter: tclkTableEntry.rxFrmCntr,
210
- txCounter: tclkTableEntry.txFrmCntr,
211
- };
212
- }
213
- }
214
- return {
215
- networkAddress: ame.nwkAddr,
216
- ieeeAddress: ame.extAddr,
217
- isDirectChild: (ame.user & AddressManagerUser.Assoc) > 0,
218
- linkKey: !linkKeyInfo ? undefined : linkKeyInfo,
219
- };
220
- })
221
- .filter((e) => e != null) || [],
222
- };
223
-
224
- try {
225
- /**
226
- * Due to a bug in ZStack, some devices go missing from the backed-up device tables which makes them disappear from the backup.
227
- * This causes the devices not to be restored when e.g. re-flashing the adapter.
228
- * If you then try to join a new device via a Zigbee 3.0 router that went missing (those with a linkkey), joining fails as the coordinator
229
- * does not have the linkKey anymore.
230
- * Below we don't remove any devices from the backup which have a linkkey and are still in the database (=ieeeAddressesInDatabase)
231
- */
232
- const oldBackup = this.getStoredBackup();
233
- assert(oldBackup, "Old backup doesn't exist");
234
- const missing = oldBackup.devices.filter(
235
- (d) =>
236
- d.linkKey &&
237
- ieeeAddressesInDatabase.includes(ZSpecUtils.eui64BEBufferToHex(d.ieeeAddress)) &&
238
- !backup.devices.find((dd) => d.ieeeAddress.equals(dd.ieeeAddress)),
239
- );
240
- const missingStr = missing.map((d) => ZSpecUtils.eui64BEBufferToHex(d.ieeeAddress)).join(", ");
241
- logger.debug(
242
- `Following devices with link key are missing from new backup but present in old backup and database, adding them back: ${missingStr}`,
243
- NS,
244
- );
245
- backup.devices = [...backup.devices, ...missing];
246
- } catch (error) {
247
- logger.debug(`Failed to read old backup, not checking for missing routers: ${error}`, NS);
248
- }
249
-
250
- return backup;
251
- }
252
-
253
- /**
254
- * Restores a structure in internal backup format to connected ZNP adapter.
255
- *
256
- * @param backup Backup to restore to connected adapter.
257
- */
258
- public async restoreBackup(backup: Models.Backup): Promise<void> {
259
- logger.debug("restoring backup", NS);
260
- const version: ZnpVersion = await this.getAdapterVersion();
261
- /* v8 ignore start */
262
- if (version === ZnpVersion.ZStack12) {
263
- throw new Error("backup cannot be restored on Z-Stack 1.2 adapter");
264
- }
265
- /* v8 ignore stop */
266
-
267
- /* fetch provisional NIB */
268
- const nib = await this.nv.readItem(NvItemsIds.NIB, 0, Structs.nib);
269
-
270
- /* update NIB with desired nwk config */
271
- nib.nwkPanId = backup.networkOptions.panId;
272
- nib.channelList = Utils.packChannelList(backup.networkOptions.channelList);
273
- nib.nwkLogicalChannel = backup.networkOptions.channelList[0];
274
- nib.extendedPANID = backup.networkOptions.extendedPanId;
275
- nib.SecurityLevel = backup.securityLevel;
276
- nib.nwkUpdateId = backup.networkUpdateId;
277
-
278
- /* prepare key info */
279
- const keyDescriptor = Structs.nwkKeyDescriptor();
280
- keyDescriptor.keySeqNum = backup.networkKeyInfo.sequenceNumber || 0;
281
- keyDescriptor.key = backup.networkOptions.networkKey;
282
-
283
- /* determine table sizes */
284
- const currentAddressManagerTable = await this.getAddressManagerTable(version);
285
- const currentSecurityManagerTable = await this.getSecurityManagerTable();
286
- const currentApsLinkKeyDataTable = await this.getApsLinkKeyDataTable(version);
287
- const currentTclkTable = await this.getTclkTable(version);
288
- const currentNwkSecMaterialTable = await this.getNetworkSecurityMaterialTable(version);
289
- logger.debug("got target adapter table sizes:", NS);
290
- logger.debug(` - address manager table: ${currentAddressManagerTable.capacity}`, NS);
291
- logger.debug(` - security manager table: ${currentSecurityManagerTable.capacity}`, NS);
292
- logger.debug(` - aps link key data table: ${currentApsLinkKeyDataTable.capacity}`, NS);
293
- logger.debug(` - tclk table: ${currentTclkTable.capacity}`, NS);
294
- logger.debug(` - network security material table: ${currentNwkSecMaterialTable.capacity}`, NS);
295
-
296
- /* prepare table structures */
297
- const addressManagerTable = Structs.addressManagerTable(currentAddressManagerTable.capacity);
298
- const securityManagerTable = Structs.securityManagerTable(currentSecurityManagerTable.capacity);
299
- const apsLinkKeyDataTable = Structs.apsLinkKeyDataTable(currentApsLinkKeyDataTable.capacity);
300
- const tclkTable = Structs.apsTcLinkKeyTable(currentTclkTable.capacity);
301
- const nwkSecurityMaterialTable = Structs.nwkSecMaterialDescriptorTable(currentNwkSecMaterialTable.capacity);
302
-
303
- /* prepare security material table (nwk frame counters) */
304
- const mwkSecMaterialEntry = nwkSecurityMaterialTable.entries[0];
305
- mwkSecMaterialEntry.extendedPanID = backup.networkOptions.extendedPanId;
306
- mwkSecMaterialEntry.FrameCounter = backup.networkKeyInfo.frameCounter + 2500;
307
- const genericNwkSecMaterialEntry = nwkSecurityMaterialTable.entries[nwkSecurityMaterialTable.capacity - 1];
308
- genericNwkSecMaterialEntry.extendedPanID = Buffer.alloc(8, 0xff);
309
- genericNwkSecMaterialEntry.FrameCounter = backup.networkKeyInfo.frameCounter + 2500;
310
-
311
- /* populate device & security tables and write them */
312
- for (const device of backup.devices) {
313
- const ame = addressManagerTable.getNextFree();
314
- ame.nwkAddr = device.networkAddress != null ? device.networkAddress : NULL_NODE_ID;
315
- ame.extAddr = device.ieeeAddress;
316
- ame.user = device.isDirectChild ? AddressManagerUser.Assoc : AddressManagerUser.Default;
317
- if (device.linkKey) {
318
- let linkKeyProcessed = false;
319
- /* attempt to recover tclk seed parameters (if available) */
320
- if (backup.znp?.trustCenterLinkKeySeed) {
321
- const tclkSeed = backup.znp.trustCenterLinkKeySeed;
322
- const extAddrReversed = Buffer.from(ame.extAddr).reverse();
323
- const extAddrRepeated = Buffer.concat([extAddrReversed, extAddrReversed]);
324
- const recoveredKey = Buffer.alloc(16);
325
- for (let i = 0; i < 16; i++) {
326
- recoveredKey[i] = device.linkKey.key[i] ^ extAddrRepeated[i];
327
- }
328
-
329
- let recoveredSeedShift: number | null = null;
330
- for (let i = 0; i < 16; i++) {
331
- const rotated = Buffer.concat([
332
- recoveredKey.slice(recoveredKey.length - i, recoveredKey.length),
333
- recoveredKey.slice(0, recoveredKey.length - i),
334
- ]);
335
- if (rotated.equals(tclkSeed)) {
336
- recoveredSeedShift = i;
337
- break;
338
- }
339
- }
340
-
341
- if (recoveredSeedShift !== null) {
342
- ame.user |= AddressManagerUser.Security;
343
- const tclkEntry = tclkTable.getNextFree();
344
- if (!tclkEntry) {
345
- throw new Error(`target adapter tclk table size insufficient (size=${tclkTable.capacity})`);
346
- }
347
- tclkEntry.extAddr = ame.extAddr;
348
- tclkEntry.SeedShift_IcIndex = recoveredSeedShift;
349
- tclkEntry.keyAttributes = 2;
350
- tclkEntry.keyType = 0;
351
- tclkEntry.rxFrmCntr = device.linkKey.rxCounter;
352
- tclkEntry.txFrmCntr = device.linkKey.txCounter + 2500;
353
- linkKeyProcessed = true;
354
- logger.debug(
355
- `successfully recovered link key for ${device.ieeeAddress.toString("hex")} using tclk seed (shift=${recoveredSeedShift})`,
356
- NS,
357
- );
358
- }
359
- }
360
-
361
- /* attempt to create aps link key data entry */
362
- if (!linkKeyProcessed) {
363
- ame.user |= AddressManagerUser.Security;
364
-
365
- const apsKeyDataEntry = apsLinkKeyDataTable.getNextFree();
366
- if (!apsKeyDataEntry) {
367
- throw new Error(`target adapter aps link key data table size insufficient (size=${apsLinkKeyDataTable.capacity})`);
368
- }
369
- apsKeyDataEntry.key = device.linkKey.key;
370
- apsKeyDataEntry.rxFrmCntr = device.linkKey.rxCounter;
371
- apsKeyDataEntry.txFrmCntr = device.linkKey.txCounter + 2500;
372
-
373
- const sme = securityManagerTable.getNextFree();
374
- if (!sme) {
375
- throw new Error(`target adapter security manager table size insufficient (size=${securityManagerTable.capacity})`);
376
- }
377
- const ameIndex = addressManagerTable.indexOf(ame);
378
- assert(ameIndex != null);
379
- sme.ami = ameIndex;
380
-
381
- const apsKeyDataEntryIndex = apsLinkKeyDataTable.indexOf(apsKeyDataEntry);
382
- assert(apsKeyDataEntryIndex != null);
383
- sme.keyNvId = version === ZnpVersion.ZStack3x0 ? apsKeyDataEntryIndex : NvItemsIds.APS_LINK_KEY_DATA_START + apsKeyDataEntryIndex;
384
- sme.authenticationOption = SecurityManagerAuthenticationOption.AuthenticatedCBCK;
385
-
386
- linkKeyProcessed = true;
387
- logger.debug(`successfully recovered link key for ${device.ieeeAddress.toString("hex")} using aps key data table`, NS);
388
- }
389
- }
390
- }
391
-
392
- /* recover coordinator ieee address */
393
- const reversedAdapterIeee = Buffer.from(backup.coordinatorIeeeAddress).reverse();
394
- await this.nv.writeItem(NvItemsIds.EXTADDR, reversedAdapterIeee);
395
-
396
- /* write updated nib */
397
- await this.nv.writeItem(NvItemsIds.NIB, nib);
398
-
399
- /* write network key info */
400
- await this.nv.updateItem(NvItemsIds.NWK_ACTIVE_KEY_INFO, keyDescriptor.serialize());
401
- await this.nv.updateItem(NvItemsIds.NWK_ALTERN_KEY_INFO, keyDescriptor.serialize());
402
-
403
- /* write tclk seed if present */
404
- if (backup.znp?.trustCenterLinkKeySeed) {
405
- await this.nv.writeItem(NvItemsIds.TCLK_SEED, backup.znp.trustCenterLinkKeySeed);
406
- }
407
-
408
- /* write network security material table (nwk frame counters) */
409
- if (version === ZnpVersion.ZStack3x0) {
410
- await this.nv.writeTable("extended", NvSystemIds.ZSTACK, NvItemsIds.EX_NWK_SEC_MATERIAL_TABLE, nwkSecurityMaterialTable);
411
- } else {
412
- await this.nv.writeTable("legacy", NvItemsIds.LEGACY_NWK_SEC_MATERIAL_TABLE_START, nwkSecurityMaterialTable);
413
- }
414
-
415
- /* write address manager table */
416
- if (version === ZnpVersion.ZStack3x0) {
417
- await this.nv.writeTable("extended", NvSystemIds.ZSTACK, NvItemsIds.ZCD_NV_EX_ADDRMGR, addressManagerTable);
418
- } else {
419
- await this.nv.writeItem(NvItemsIds.ADDRMGR, addressManagerTable);
420
- }
421
-
422
- /* write security manager table */
423
- await this.nv.writeItem(NvItemsIds.APS_LINK_KEY_TABLE, securityManagerTable);
424
-
425
- /* write aps link key data table */
426
- if (version === ZnpVersion.ZStack3x0) {
427
- await this.nv.writeTable("extended", NvSystemIds.ZSTACK, NvItemsIds.ZCD_NV_EX_APS_KEY_DATA_TABLE, apsLinkKeyDataTable);
428
- } else {
429
- await this.nv.writeTable("legacy", NvItemsIds.APS_LINK_KEY_DATA_START, apsLinkKeyDataTable);
430
- }
431
-
432
- /* write tclk table */
433
- if (version === ZnpVersion.ZStack3x0) {
434
- await this.nv.writeTable("extended", NvSystemIds.ZSTACK, NvItemsIds.EX_TCLK_TABLE, tclkTable);
435
- } else {
436
- await this.nv.writeTable("legacy", NvItemsIds.LEGACY_TCLK_TABLE_START, tclkTable);
437
- }
438
- }
439
-
440
- /**
441
- * Acquires ZNP version internal to `zigbee-herdsman` from controller.
442
- *
443
- * *If Z-Stack 1.2 controller is detected an error is thrown, since Z-Stack 1.2 backup
444
- * and restore procedures are not supported.*
445
- */
446
- private async getAdapterVersion(): Promise<ZnpVersion> {
447
- const versionResponse = await this.znp.requestWithReply(Subsystem.SYS, "version", {});
448
- const version: ZnpVersion = versionResponse.payload.product;
449
- return version;
450
- }
451
-
452
- /**
453
- * Internal method to retrieve address manager table.
454
- *
455
- * @param version ZNP stack version the adapter is running.
456
- */
457
- private async getAddressManagerTable(version: ZnpVersion): Promise<ReturnType<typeof Structs.addressManagerTable>> {
458
- if (version === ZnpVersion.ZStack3x0) {
459
- return await this.nv.readTable("extended", NvSystemIds.ZSTACK, NvItemsIds.ZCD_NV_EX_ADDRMGR, undefined, Structs.addressManagerTable);
460
- }
461
- return await this.nv.readItem(NvItemsIds.ADDRMGR, 0, Structs.addressManagerTable);
462
- }
463
-
464
- /**
465
- * Internal method to retrieve security manager table. Also referred to as APS Link Key Table.
466
- */
467
- private async getSecurityManagerTable(): Promise<ReturnType<typeof Structs.securityManagerTable>> {
468
- return await this.nv.readItem(NvItemsIds.APS_LINK_KEY_TABLE, 0, Structs.securityManagerTable);
469
- }
470
-
471
- /**
472
- * Internal method to retrieve APS Link Key Data Table containing arbitrary APS link keys.
473
- *
474
- * @param version ZNP stack version the adapter is running.
475
- */
476
- private async getApsLinkKeyDataTable(version: ZnpVersion): Promise<ReturnType<typeof Structs.apsLinkKeyDataTable>> {
477
- if (version === ZnpVersion.ZStack3x0) {
478
- return await this.nv.readTable(
479
- "extended",
480
- NvSystemIds.ZSTACK,
481
- NvItemsIds.ZCD_NV_EX_APS_KEY_DATA_TABLE,
482
- undefined,
483
- Structs.apsLinkKeyDataTable,
484
- );
485
- }
486
- return await this.nv.readTable("legacy", NvItemsIds.APS_LINK_KEY_DATA_START, 255, Structs.apsLinkKeyDataTable);
487
- }
488
-
489
- /**
490
- * Internal method to retrieve Trust Center Link Key table which describes seed-based APS link keys for devices.
491
- *
492
- * @param version ZNP stack version the adapter is running.
493
- */
494
- private async getTclkTable(version: ZnpVersion): Promise<ReturnType<typeof Structs.apsTcLinkKeyTable>> {
495
- if (version === ZnpVersion.ZStack3x0) {
496
- return await this.nv.readTable("extended", NvSystemIds.ZSTACK, NvItemsIds.EX_TCLK_TABLE, undefined, Structs.apsTcLinkKeyTable);
497
- }
498
- return await this.nv.readTable("legacy", NvItemsIds.LEGACY_TCLK_TABLE_START, 239, Structs.apsTcLinkKeyTable);
499
- }
500
-
501
- /**
502
- * Internal method to retrieve network security material table, which contains network key frame counter.
503
- *
504
- * @param version ZNP stack version the adapter is running.
505
- */
506
- private async getNetworkSecurityMaterialTable(version: ZnpVersion): Promise<ReturnType<typeof Structs.nwkSecMaterialDescriptorTable>> {
507
- if (version === ZnpVersion.ZStack3x0) {
508
- return await this.nv.readTable(
509
- "extended",
510
- NvSystemIds.ZSTACK,
511
- NvItemsIds.EX_NWK_SEC_MATERIAL_TABLE,
512
- undefined,
513
- Structs.nwkSecMaterialDescriptorTable,
514
- );
515
- }
516
-
517
- return await this.nv.readTable("legacy", NvItemsIds.LEGACY_NWK_SEC_MATERIAL_TABLE_START, 12, Structs.nwkSecMaterialDescriptorTable);
518
- }
519
- }