zigbee-herdsman 6.0.2 → 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 (252) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/package.json +12 -3
  3. package/.github/ISSUE_TEMPLATE/config.yml +0 -5
  4. package/.github/dependabot.yml +0 -22
  5. package/.github/workflows/ci.yml +0 -69
  6. package/.github/workflows/release-please.yml +0 -18
  7. package/.github/workflows/stale.yml +0 -20
  8. package/.github/workflows/typedoc.yaml +0 -47
  9. package/.release-please-manifest.json +0 -3
  10. package/.vscode/extensions.json +0 -3
  11. package/.vscode/settings.json +0 -11
  12. package/biome.json +0 -98
  13. package/examples/join-and-log.js +0 -24
  14. package/release-please-config.json +0 -9
  15. package/src/adapter/adapter.ts +0 -189
  16. package/src/adapter/adapterDiscovery.ts +0 -666
  17. package/src/adapter/const.ts +0 -12
  18. package/src/adapter/deconz/adapter/deconzAdapter.ts +0 -877
  19. package/src/adapter/deconz/driver/constants.ts +0 -246
  20. package/src/adapter/deconz/driver/driver.ts +0 -1540
  21. package/src/adapter/deconz/driver/frame.ts +0 -11
  22. package/src/adapter/deconz/driver/frameParser.ts +0 -753
  23. package/src/adapter/deconz/driver/parser.ts +0 -45
  24. package/src/adapter/deconz/driver/writer.ts +0 -22
  25. package/src/adapter/deconz/types.d.ts +0 -13
  26. package/src/adapter/ember/adapter/emberAdapter.ts +0 -2265
  27. package/src/adapter/ember/adapter/endpoints.ts +0 -86
  28. package/src/adapter/ember/adapter/oneWaitress.ts +0 -324
  29. package/src/adapter/ember/adapter/tokensManager.ts +0 -782
  30. package/src/adapter/ember/consts.ts +0 -178
  31. package/src/adapter/ember/enums.ts +0 -1746
  32. package/src/adapter/ember/ezsp/buffalo.ts +0 -1392
  33. package/src/adapter/ember/ezsp/consts.ts +0 -148
  34. package/src/adapter/ember/ezsp/enums.ts +0 -1114
  35. package/src/adapter/ember/ezsp/ezsp.ts +0 -9061
  36. package/src/adapter/ember/ezspError.ts +0 -10
  37. package/src/adapter/ember/types.ts +0 -866
  38. package/src/adapter/ember/uart/ash.ts +0 -1960
  39. package/src/adapter/ember/uart/consts.ts +0 -109
  40. package/src/adapter/ember/uart/enums.ts +0 -192
  41. package/src/adapter/ember/uart/parser.ts +0 -48
  42. package/src/adapter/ember/uart/queues.ts +0 -247
  43. package/src/adapter/ember/uart/writer.ts +0 -53
  44. package/src/adapter/ember/utils/initters.ts +0 -58
  45. package/src/adapter/ember/utils/math.ts +0 -73
  46. package/src/adapter/events.ts +0 -21
  47. package/src/adapter/ezsp/adapter/backup.ts +0 -109
  48. package/src/adapter/ezsp/adapter/ezspAdapter.ts +0 -614
  49. package/src/adapter/ezsp/driver/commands.ts +0 -2497
  50. package/src/adapter/ezsp/driver/consts.ts +0 -11
  51. package/src/adapter/ezsp/driver/driver.ts +0 -1002
  52. package/src/adapter/ezsp/driver/ezsp.ts +0 -802
  53. package/src/adapter/ezsp/driver/frame.ts +0 -101
  54. package/src/adapter/ezsp/driver/index.ts +0 -4
  55. package/src/adapter/ezsp/driver/multicast.ts +0 -78
  56. package/src/adapter/ezsp/driver/parser.ts +0 -81
  57. package/src/adapter/ezsp/driver/types/basic.ts +0 -201
  58. package/src/adapter/ezsp/driver/types/index.ts +0 -239
  59. package/src/adapter/ezsp/driver/types/named.ts +0 -2330
  60. package/src/adapter/ezsp/driver/types/struct.ts +0 -844
  61. package/src/adapter/ezsp/driver/uart.ts +0 -460
  62. package/src/adapter/ezsp/driver/utils/crc16ccitt.ts +0 -44
  63. package/src/adapter/ezsp/driver/utils/index.ts +0 -32
  64. package/src/adapter/ezsp/driver/writer.ts +0 -64
  65. package/src/adapter/index.ts +0 -3
  66. package/src/adapter/serialPort.ts +0 -58
  67. package/src/adapter/socketPortUtils.ts +0 -16
  68. package/src/adapter/tstype.ts +0 -78
  69. package/src/adapter/z-stack/adapter/adapter-backup.ts +0 -519
  70. package/src/adapter/z-stack/adapter/adapter-nv-memory.ts +0 -457
  71. package/src/adapter/z-stack/adapter/endpoints.ts +0 -57
  72. package/src/adapter/z-stack/adapter/manager.ts +0 -543
  73. package/src/adapter/z-stack/adapter/tstype.ts +0 -6
  74. package/src/adapter/z-stack/adapter/zStackAdapter.ts +0 -1190
  75. package/src/adapter/z-stack/constants/af.ts +0 -27
  76. package/src/adapter/z-stack/constants/common.ts +0 -285
  77. package/src/adapter/z-stack/constants/dbg.ts +0 -23
  78. package/src/adapter/z-stack/constants/index.ts +0 -11
  79. package/src/adapter/z-stack/constants/mac.ts +0 -128
  80. package/src/adapter/z-stack/constants/sapi.ts +0 -25
  81. package/src/adapter/z-stack/constants/sys.ts +0 -72
  82. package/src/adapter/z-stack/constants/util.ts +0 -82
  83. package/src/adapter/z-stack/constants/utils.ts +0 -14
  84. package/src/adapter/z-stack/constants/zdo.ts +0 -103
  85. package/src/adapter/z-stack/models/startup-options.ts +0 -13
  86. package/src/adapter/z-stack/structs/entries/address-manager-entry.ts +0 -44
  87. package/src/adapter/z-stack/structs/entries/address-manager-table.ts +0 -19
  88. package/src/adapter/z-stack/structs/entries/aps-link-key-data-entry.ts +0 -12
  89. package/src/adapter/z-stack/structs/entries/aps-link-key-data-table.ts +0 -21
  90. package/src/adapter/z-stack/structs/entries/aps-tc-link-key-entry.ts +0 -19
  91. package/src/adapter/z-stack/structs/entries/aps-tc-link-key-table.ts +0 -21
  92. package/src/adapter/z-stack/structs/entries/channel-list.ts +0 -8
  93. package/src/adapter/z-stack/structs/entries/has-configured.ts +0 -16
  94. package/src/adapter/z-stack/structs/entries/index.ts +0 -16
  95. package/src/adapter/z-stack/structs/entries/nib.ts +0 -66
  96. package/src/adapter/z-stack/structs/entries/nwk-key-descriptor.ts +0 -15
  97. package/src/adapter/z-stack/structs/entries/nwk-key.ts +0 -13
  98. package/src/adapter/z-stack/structs/entries/nwk-pan-id.ts +0 -8
  99. package/src/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-entry.ts +0 -20
  100. package/src/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-table.ts +0 -19
  101. package/src/adapter/z-stack/structs/entries/security-manager-entry.ts +0 -33
  102. package/src/adapter/z-stack/structs/entries/security-manager-table.ts +0 -22
  103. package/src/adapter/z-stack/structs/index.ts +0 -4
  104. package/src/adapter/z-stack/structs/serializable-memory-object.ts +0 -14
  105. package/src/adapter/z-stack/structs/struct.ts +0 -367
  106. package/src/adapter/z-stack/structs/table.ts +0 -198
  107. package/src/adapter/z-stack/unpi/constants.ts +0 -33
  108. package/src/adapter/z-stack/unpi/frame.ts +0 -62
  109. package/src/adapter/z-stack/unpi/index.ts +0 -4
  110. package/src/adapter/z-stack/unpi/parser.ts +0 -56
  111. package/src/adapter/z-stack/unpi/writer.ts +0 -21
  112. package/src/adapter/z-stack/utils/channel-list.ts +0 -40
  113. package/src/adapter/z-stack/utils/index.ts +0 -2
  114. package/src/adapter/z-stack/utils/network-options.ts +0 -26
  115. package/src/adapter/z-stack/znp/buffaloZnp.ts +0 -175
  116. package/src/adapter/z-stack/znp/definition.ts +0 -2713
  117. package/src/adapter/z-stack/znp/index.ts +0 -2
  118. package/src/adapter/z-stack/znp/parameterType.ts +0 -22
  119. package/src/adapter/z-stack/znp/tstype.ts +0 -44
  120. package/src/adapter/z-stack/znp/utils.ts +0 -10
  121. package/src/adapter/z-stack/znp/znp.ts +0 -342
  122. package/src/adapter/z-stack/znp/zpiObject.ts +0 -148
  123. package/src/adapter/zboss/adapter/zbossAdapter.ts +0 -526
  124. package/src/adapter/zboss/commands.ts +0 -1184
  125. package/src/adapter/zboss/consts.ts +0 -9
  126. package/src/adapter/zboss/driver.ts +0 -422
  127. package/src/adapter/zboss/enums.ts +0 -360
  128. package/src/adapter/zboss/frame.ts +0 -227
  129. package/src/adapter/zboss/reader.ts +0 -65
  130. package/src/adapter/zboss/types.ts +0 -0
  131. package/src/adapter/zboss/uart.ts +0 -428
  132. package/src/adapter/zboss/utils.ts +0 -58
  133. package/src/adapter/zboss/writer.ts +0 -49
  134. package/src/adapter/zigate/adapter/patchZdoBuffaloBE.ts +0 -27
  135. package/src/adapter/zigate/adapter/zigateAdapter.ts +0 -618
  136. package/src/adapter/zigate/driver/LICENSE +0 -17
  137. package/src/adapter/zigate/driver/buffaloZiGate.ts +0 -212
  138. package/src/adapter/zigate/driver/commandType.ts +0 -418
  139. package/src/adapter/zigate/driver/constants.ts +0 -150
  140. package/src/adapter/zigate/driver/frame.ts +0 -197
  141. package/src/adapter/zigate/driver/messageType.ts +0 -287
  142. package/src/adapter/zigate/driver/parameterType.ts +0 -32
  143. package/src/adapter/zigate/driver/ziGateObject.ts +0 -146
  144. package/src/adapter/zigate/driver/zigate.ts +0 -423
  145. package/src/adapter/zoh/adapter/utils.ts +0 -27
  146. package/src/adapter/zoh/adapter/zohAdapter.ts +0 -838
  147. package/src/buffalo/buffalo.ts +0 -342
  148. package/src/buffalo/index.ts +0 -1
  149. package/src/controller/controller.ts +0 -1022
  150. package/src/controller/database.ts +0 -124
  151. package/src/controller/events.ts +0 -52
  152. package/src/controller/greenPower.ts +0 -603
  153. package/src/controller/helpers/index.ts +0 -1
  154. package/src/controller/helpers/installCodes.ts +0 -107
  155. package/src/controller/helpers/request.ts +0 -96
  156. package/src/controller/helpers/requestQueue.ts +0 -125
  157. package/src/controller/helpers/zclFrameConverter.ts +0 -47
  158. package/src/controller/helpers/zclTransactionSequenceNumber.ts +0 -19
  159. package/src/controller/index.ts +0 -6
  160. package/src/controller/model/device.ts +0 -1249
  161. package/src/controller/model/endpoint.ts +0 -1105
  162. package/src/controller/model/entity.ts +0 -23
  163. package/src/controller/model/group.ts +0 -424
  164. package/src/controller/model/index.ts +0 -5
  165. package/src/controller/model/zigbeeEntity.ts +0 -30
  166. package/src/controller/touchlink.ts +0 -189
  167. package/src/controller/tstype.ts +0 -274
  168. package/src/index.ts +0 -12
  169. package/src/models/backup-storage-legacy.ts +0 -48
  170. package/src/models/backup-storage-unified.ts +0 -47
  171. package/src/models/backup.ts +0 -37
  172. package/src/models/index.ts +0 -5
  173. package/src/models/network-options.ts +0 -11
  174. package/src/utils/backup.ts +0 -152
  175. package/src/utils/index.ts +0 -5
  176. package/src/utils/logger.ts +0 -20
  177. package/src/utils/patchBigIntSerialization.ts +0 -8
  178. package/src/utils/queue.ts +0 -76
  179. package/src/utils/types.d.ts +0 -3
  180. package/src/utils/utils.ts +0 -19
  181. package/src/utils/wait.ts +0 -5
  182. package/src/utils/waitress.ts +0 -96
  183. package/src/zspec/consts.ts +0 -84
  184. package/src/zspec/enums.ts +0 -22
  185. package/src/zspec/index.ts +0 -3
  186. package/src/zspec/tstypes.ts +0 -18
  187. package/src/zspec/utils.ts +0 -247
  188. package/src/zspec/zcl/buffaloZcl.ts +0 -1220
  189. package/src/zspec/zcl/definition/cluster.ts +0 -5915
  190. package/src/zspec/zcl/definition/clusters-typegen.ts +0 -588
  191. package/src/zspec/zcl/definition/clusters-types.ts +0 -7331
  192. package/src/zspec/zcl/definition/consts.ts +0 -24
  193. package/src/zspec/zcl/definition/enums.ts +0 -203
  194. package/src/zspec/zcl/definition/foundation.ts +0 -329
  195. package/src/zspec/zcl/definition/manufacturerCode.ts +0 -729
  196. package/src/zspec/zcl/definition/status.ts +0 -69
  197. package/src/zspec/zcl/definition/tstype.ts +0 -377
  198. package/src/zspec/zcl/index.ts +0 -11
  199. package/src/zspec/zcl/utils.ts +0 -321
  200. package/src/zspec/zcl/zclFrame.ts +0 -356
  201. package/src/zspec/zcl/zclHeader.ts +0 -102
  202. package/src/zspec/zcl/zclStatusError.ts +0 -10
  203. package/src/zspec/zdo/buffaloZdo.ts +0 -2336
  204. package/src/zspec/zdo/definition/clusters.ts +0 -722
  205. package/src/zspec/zdo/definition/consts.ts +0 -16
  206. package/src/zspec/zdo/definition/enums.ts +0 -99
  207. package/src/zspec/zdo/definition/status.ts +0 -105
  208. package/src/zspec/zdo/definition/tstypes.ts +0 -1062
  209. package/src/zspec/zdo/index.ts +0 -7
  210. package/src/zspec/zdo/utils.ts +0 -76
  211. package/src/zspec/zdo/zdoStatusError.ts +0 -10
  212. package/test/adapter/adapter.test.ts +0 -1062
  213. package/test/adapter/ember/ash.test.ts +0 -337
  214. package/test/adapter/ember/consts.ts +0 -131
  215. package/test/adapter/ember/emberAdapter.test.ts +0 -3449
  216. package/test/adapter/ember/ezsp.test.ts +0 -385
  217. package/test/adapter/ember/ezspBuffalo.test.ts +0 -93
  218. package/test/adapter/ember/ezspError.test.ts +0 -12
  219. package/test/adapter/ember/math.test.ts +0 -206
  220. package/test/adapter/ezsp/frame.test.ts +0 -30
  221. package/test/adapter/ezsp/uart.test.ts +0 -181
  222. package/test/adapter/z-stack/adapter.test.ts +0 -3984
  223. package/test/adapter/z-stack/constants.test.ts +0 -33
  224. package/test/adapter/z-stack/structs.test.ts +0 -115
  225. package/test/adapter/z-stack/unpi.test.ts +0 -213
  226. package/test/adapter/z-stack/znp.test.ts +0 -1284
  227. package/test/adapter/zboss/fixZdoResponse.test.ts +0 -179
  228. package/test/adapter/zigate/patchZdoBuffaloBE.test.ts +0 -81
  229. package/test/adapter/zigate/zdo.test.ts +0 -187
  230. package/test/adapter/zoh/utils.test.ts +0 -36
  231. package/test/adapter/zoh/zohAdapter.test.ts +0 -1307
  232. package/test/benchOptions.ts +0 -14
  233. package/test/buffalo.test.ts +0 -431
  234. package/test/controller.bench.ts +0 -214
  235. package/test/controller.test.ts +0 -8702
  236. package/test/greenpower.test.ts +0 -1408
  237. package/test/mockAdapters.ts +0 -65
  238. package/test/mockDevices.ts +0 -598
  239. package/test/requests.bench.ts +0 -229
  240. package/test/testUtils.ts +0 -20
  241. package/test/tsconfig.json +0 -9
  242. package/test/utils/math.ts +0 -19
  243. package/test/utils.test.ts +0 -279
  244. package/test/vitest.config.mts +0 -26
  245. package/test/zcl.test.ts +0 -2831
  246. package/test/zspec/utils.test.ts +0 -68
  247. package/test/zspec/zcl/buffalo.test.ts +0 -1374
  248. package/test/zspec/zcl/frame.test.ts +0 -960
  249. package/test/zspec/zcl/utils.test.ts +0 -273
  250. package/test/zspec/zdo/buffalo.test.ts +0 -1850
  251. package/test/zspec/zdo/utils.test.ts +0 -241
  252. package/tsconfig.json +0 -24
@@ -1,543 +0,0 @@
1
- import * as crypto from "node:crypto";
2
- import type * as Models from "../../../models";
3
- import {wait} from "../../../utils";
4
- import {logger} from "../../../utils/logger";
5
- import * as ZSpec from "../../../zspec";
6
- import * as Zdo from "../../../zspec/zdo";
7
- import type {TsType} from "../../";
8
- import * as ZnpConstants from "../constants";
9
- import {DevStates, NvItemsIds, ZnpCommandStatus} from "../constants/common";
10
- import type {StartupOptions} from "../models/startup-options";
11
- import * as Structs from "../structs";
12
- import * as UnpiConstants from "../unpi/constants";
13
- import {Subsystem} from "../unpi/constants";
14
- import * as Utils from "../utils";
15
- import type {Znp} from "../znp";
16
- import {AdapterBackup} from "./adapter-backup";
17
- import {AdapterNvMemory} from "./adapter-nv-memory";
18
- import {Endpoints} from "./endpoints";
19
- import {ZnpVersion} from "./tstype";
20
- import type {ZStackAdapter} from "./zStackAdapter";
21
-
22
- const NS = "zh:adapter:zstack:manager";
23
-
24
- /**
25
- * Startup strategy is internally used to determine required startup method.
26
- */
27
- type StartupStrategy = "startup" | "restoreBackup" | "startCommissioning";
28
-
29
- /**
30
- * ZNP Adapter Manager is responsible for handling adapter startup, network commissioning,
31
- * configuration backup and restore.
32
- */
33
- export class ZnpAdapterManager {
34
- public nv: AdapterNvMemory;
35
- public backup: AdapterBackup;
36
-
37
- private znp: Znp;
38
- private adapter: ZStackAdapter;
39
- private options: StartupOptions;
40
- // @ts-expect-error initialized in `start()`
41
- private nwkOptions: Models.NetworkOptions;
42
-
43
- public constructor(adapter: ZStackAdapter, znp: Znp, options: StartupOptions) {
44
- this.znp = znp;
45
- this.adapter = adapter;
46
- this.options = options;
47
- this.nv = new AdapterNvMemory(this.znp);
48
- this.backup = new AdapterBackup(this.znp, this.nv, this.options.backupPath);
49
- }
50
-
51
- /**
52
- * Performs ZNP adapter startup. After this method returns the adapter is configured, endpoints are registered
53
- * and network is ready to process frames.
54
- */
55
- public async start(): Promise<TsType.StartResult> {
56
- logger.debug("beginning znp startup", NS);
57
- this.nwkOptions = await this.parseConfigNetworkOptions(this.options.networkOptions);
58
- await this.nv.init();
59
-
60
- /* determine startup strategy */
61
- const strategy = await this.determineStrategy();
62
- logger.debug(`determined startup strategy: ${strategy}`, NS);
63
-
64
- /* perform coordinator startup based on determined strategy */
65
- let result: TsType.StartResult;
66
- switch (strategy) {
67
- case "startup": {
68
- await this.beginStartup();
69
- result = "resumed";
70
- break;
71
- }
72
- case "restoreBackup": {
73
- if (this.options.version === ZnpVersion.ZStack12) {
74
- logger.debug("performing recommissioning instead of restore for z-stack 1.2", NS);
75
- await this.beginCommissioning(this.nwkOptions);
76
- await this.beginStartup();
77
- } else {
78
- await this.beginRestore();
79
- }
80
- result = "restored";
81
- break;
82
- }
83
- case "startCommissioning": {
84
- if (this.options.version === ZnpVersion.ZStack12) {
85
- const hasConfigured = await this.nv.readItem(NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK1, 0, Structs.hasConfigured);
86
- await this.beginCommissioning(this.nwkOptions);
87
- await this.beginStartup();
88
- result = hasConfigured?.isConfigured() ? "reset" : "restored";
89
- } else {
90
- await this.beginCommissioning(this.nwkOptions);
91
- result = "reset";
92
- }
93
- break;
94
- }
95
- }
96
-
97
- /* register endpoints */
98
- await this.registerEndpoints();
99
-
100
- /* add green power group */
101
- await this.addToGroup(242, this.options.greenPowerGroup);
102
-
103
- return result;
104
- }
105
-
106
- /**
107
- * Internal function to determine startup strategy. The strategy determination flow is described in
108
- * [this GitHub issue comment](https://github.com/Koenkk/zigbee-herdsman/issues/286#issuecomment-761029689).
109
- */
110
- private async determineStrategy(): Promise<StartupStrategy> {
111
- logger.debug("determining znp startup strategy", NS);
112
-
113
- /* acquire data from adapter */
114
- const hasConfiguredNvId =
115
- this.options.version === ZnpVersion.ZStack12 ? NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK1 : NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK3;
116
- const hasConfigured = await this.nv.readItem(hasConfiguredNvId, 0, Structs.hasConfigured);
117
- const nib = await this.nv.readItem(NvItemsIds.NIB, 0, Structs.nib);
118
- const preconfiguredKey =
119
- this.options.version === ZnpVersion.ZStack12
120
- ? Structs.nwkKey(
121
- (await this.znp.requestWithReply(Subsystem.SAPI, "readConfiguration", {configid: NvItemsIds.PRECFGKEY})).payload.value,
122
- )
123
- : await this.nv.readItem(NvItemsIds.PRECFGKEY, 0, Structs.nwkKey);
124
- let activeKeyInfo = await this.nv.readItem(NvItemsIds.NWK_ACTIVE_KEY_INFO, 0, Structs.nwkKeyDescriptor);
125
- let alternateKeyInfo = await this.nv.readItem(NvItemsIds.NWK_ALTERN_KEY_INFO, 0, Structs.nwkKeyDescriptor);
126
-
127
- /* Z-Stack 1.2 does not provide key info entries */
128
- if (this.options.version === ZnpVersion.ZStack12) {
129
- activeKeyInfo = Structs.nwkKeyDescriptor();
130
- activeKeyInfo.key = Buffer.from(preconfiguredKey.key);
131
- alternateKeyInfo = Structs.nwkKeyDescriptor();
132
- alternateKeyInfo.key = Buffer.from(preconfiguredKey.key);
133
- }
134
-
135
- /* get backup if available and supported by target */
136
- const backup = this.backup.getStoredBackup();
137
-
138
- /* special treatment for incorrectly reversed Extended PAN IDs from previous releases */
139
- const isExtendedPanIdReversed = nib && this.nwkOptions.extendedPanId.equals(Buffer.from(nib.extendedPANID).reverse());
140
-
141
- const configMatchesAdapter =
142
- nib &&
143
- // Don't check for channel anymore because channel change is supported.
144
- // Utils.compareChannelLists(this.nwkOptions.channelList, nib.channelList) &&
145
- this.nwkOptions.panId === nib.nwkPanId &&
146
- (this.nwkOptions.extendedPanId.equals(nib.extendedPANID) ||
147
- /* exception for migration from previous code-base */
148
- /* v8 ignore next */
149
- isExtendedPanIdReversed ||
150
- /* exception for some adapters which may actually use 0xdddddddddddddddd as EPID (backward compatibility) */
151
- /* v8 ignore next */
152
- this.nwkOptions.hasDefaultExtendedPanId) &&
153
- this.nwkOptions.networkKey.equals(preconfiguredKey.key) &&
154
- this.nwkOptions.networkKey.equals(activeKeyInfo.key) &&
155
- this.nwkOptions.networkKey.equals(alternateKeyInfo.key);
156
-
157
- const backupMatchesAdapter =
158
- backup &&
159
- nib &&
160
- backup.networkOptions.panId === nib.nwkPanId &&
161
- backup.networkOptions.extendedPanId.equals(nib.extendedPANID) &&
162
- Utils.compareChannelLists(backup.networkOptions.channelList, nib.channelList) &&
163
- backup.networkOptions.networkKey.equals(activeKeyInfo.key);
164
-
165
- const configMatchesBackup = backup && Utils.compareNetworkOptions(this.nwkOptions, backup.networkOptions, true);
166
-
167
- const checkRestoreVersionCompatibility = (): void => {
168
- if (
169
- this.options.version === ZnpVersion.ZStack12 &&
170
- backup &&
171
- backup.znp?.version !== undefined &&
172
- backup.znp.version !== ZnpVersion.ZStack12
173
- ) {
174
- throw new Error(
175
- "your backup is from newer platform version (Z-Stack 3.0.x+) and cannot be restored onto Z-Stack 1.2 adapter - please remove backup before proceeding",
176
- );
177
- }
178
- };
179
-
180
- /* Determine startup strategy */
181
- if (!hasConfigured || !hasConfigured.isConfigured() || !nib) {
182
- /* Adapter is not configured or not commissioned */
183
- logger.debug("(stage-1) adapter is not configured / not commissioned", NS);
184
- if (configMatchesBackup) {
185
- /* Adapter backup is available and matches configuration */
186
- logger.debug("(stage-2) configuration matches backup", NS);
187
- checkRestoreVersionCompatibility();
188
- return "restoreBackup";
189
- }
190
- /* Adapter backup is either not available or does not match configuration */
191
- if (!backup) {
192
- logger.debug("(stage-2) adapter backup does not exist", NS);
193
- } else {
194
- logger.debug("(stage-2) configuration does not match backup", NS);
195
- }
196
- return "startCommissioning";
197
- }
198
- /* Adapter is configured and commissioned */
199
- logger.debug("(stage-1) adapter is configured", NS);
200
-
201
- if (configMatchesAdapter) {
202
- /* Warn if EPID is reversed (backward-compat) */
203
- if (isExtendedPanIdReversed) {
204
- logger.debug("(stage-2) extended pan id is reversed", NS);
205
- logger.warning(
206
- `Extended PAN ID is reversed (expected=${this.nwkOptions.extendedPanId.toString("hex")}, actual=${nib.extendedPANID.toString("hex")})`,
207
- NS,
208
- );
209
- }
210
-
211
- /* Configuration matches adapter state - regular startup */
212
- logger.debug("(stage-2) adapter state matches configuration", NS);
213
- return "startup";
214
- }
215
- /* Configuration does not match adapter state */
216
- logger.debug("(stage-2) adapter state does not match configuration", NS);
217
- if (backup) {
218
- /* Backup is present */
219
- logger.debug("(stage-3) got adapter backup", NS);
220
- if (backupMatchesAdapter) {
221
- /* Backup matches adapter state */
222
- logger.debug("(stage-4) adapter state matches backup", NS);
223
- logger.error("Configuration is not consistent with adapter state/backup!", NS);
224
- logger.error(`- PAN ID: configured=${this.nwkOptions.panId}, adapter=${nib.nwkPanId}`, NS);
225
- logger.error(
226
- `- Extended PAN ID: configured=${this.nwkOptions.extendedPanId.toString("hex")}, adapter=${nib.extendedPANID.toString("hex")}`,
227
- NS,
228
- );
229
- logger.error(
230
- `- Network Key: configured=${this.nwkOptions.networkKey.toString("hex")}, adapter:active=${activeKeyInfo.key.toString("hex")} ` +
231
- `adapter:preconfigured=${preconfiguredKey.key.toString("hex")}, adapter:alternate=${alternateKeyInfo.key.toString("hex")}`,
232
- NS,
233
- );
234
- logger.error(
235
- `- Channel List: configured=${this.nwkOptions.channelList.toString()}, adapter=${Utils.unpackChannelList(nib.channelList).toString()}`,
236
- NS,
237
- );
238
- logger.error("Please update configuration to prevent further issues.", NS);
239
- logger.error(`If you wish to re-commission your network, please remove coordinator backup at ${this.options.backupPath}.`, NS);
240
- logger.error("Re-commissioning your network will require re-pairing of all devices!", NS);
241
- if (this.options.adapterOptions.forceStartWithInconsistentAdapterConfiguration) {
242
- logger.error(
243
- "Running despite adapter configuration mismatch as configured. Please update the adapter to compatible firmware and recreate your network as soon as possible.",
244
- NS,
245
- );
246
- return "startup";
247
- }
248
- throw new Error("startup failed - configuration-adapter mismatch - see logs above for more information");
249
- }
250
- /* Backup does not match adapter state */
251
- logger.debug("(stage-4) adapter state does not match backup", NS);
252
- if (configMatchesBackup) {
253
- /* Adapter backup matches configuration */
254
- logger.debug("(stage-5) adapter backup matches configuration", NS);
255
- checkRestoreVersionCompatibility();
256
- return "restoreBackup";
257
- }
258
- /* Adapter backup does not match configuration */
259
- logger.debug("(stage-5) adapter backup does not match configuration", NS);
260
- return "startCommissioning";
261
- }
262
- /* Configuration mismatches adapter and no backup is available */
263
- logger.debug("(stage-3) configuration-adapter mismatch (no backup)", NS);
264
- return "startCommissioning";
265
- }
266
-
267
- /**
268
- * Internal method to perform regular adapter startup in coordinator mode.
269
- */
270
- private async beginStartup(): Promise<void> {
271
- const deviceInfo = await this.znp.requestWithReply(Subsystem.UTIL, "getDeviceInfo", {});
272
- if (deviceInfo.payload.devicestate !== DevStates.ZB_COORD) {
273
- logger.debug("starting adapter as coordinator", NS);
274
- const started = this.znp.waitFor(UnpiConstants.Type.AREQ, Subsystem.ZDO, "stateChangeInd", undefined, undefined, 9, 60000);
275
- await this.znp.request(Subsystem.ZDO, "startupFromApp", {startdelay: 100}, undefined, undefined, [
276
- ZnpCommandStatus.SUCCESS,
277
- ZnpCommandStatus.FAILURE,
278
- ]);
279
- await started.start().promise;
280
- logger.debug("adapter successfully started in coordinator mode", NS);
281
- } else {
282
- logger.debug("adapter is already running in coordinator mode", NS);
283
- }
284
- }
285
-
286
- /**
287
- * Internal method to perform adapter restore.
288
- */
289
- private async beginRestore(): Promise<void> {
290
- const backup = this.backup.getStoredBackup();
291
- /* v8 ignore start */
292
- if (!backup) {
293
- throw new Error("Cannot restore backup - none is available");
294
- }
295
- /* v8 ignore stop */
296
-
297
- /* generate random provisioning network parameters */
298
- const provisioningNwkOptions: Models.NetworkOptions = {
299
- panId: 1 + Math.round(Math.random() * 65532),
300
- extendedPanId: crypto.randomBytes(8),
301
- channelList: [11 + Math.round(Math.random() * (26 - 11))],
302
- networkKey: crypto.randomBytes(16),
303
- networkKeyDistribute: false,
304
- };
305
-
306
- /* commission provisioning network */
307
- logger.debug("commissioning random provisioning network:", NS);
308
- logger.debug(` - panId: ${provisioningNwkOptions.panId}`, NS);
309
- logger.debug(` - extendedPanId: ${provisioningNwkOptions.extendedPanId.toString("hex")}`, NS);
310
- logger.debug(` - channelList: ${provisioningNwkOptions.channelList.join(", ")}`, NS);
311
- logger.debug(` - networkKey: ${provisioningNwkOptions.networkKey.toString("hex")}`, NS);
312
- logger.debug(` - networkKeyDistribute: ${provisioningNwkOptions.networkKeyDistribute}`, NS);
313
- await this.beginCommissioning(provisioningNwkOptions, false, false);
314
-
315
- /* perform NV restore */
316
- await this.backup.restoreBackup(backup);
317
-
318
- /* update commissioning NV items with desired nwk configuration */
319
- await this.updateCommissioningNvItems(this.nwkOptions);
320
-
321
- /* settle & reset adapter */
322
- logger.debug("giving adapter some time to settle", NS);
323
- await wait(1000);
324
- await this.resetAdapter();
325
-
326
- /* startup with restored adapter */
327
- await this.beginStartup();
328
-
329
- /* write configuration flag */
330
- await this.writeConfigurationFlag();
331
- }
332
-
333
- /**
334
- * Internal method to perform new network commissioning. Network commissioning creates a new ZigBee
335
- * network using the adapter.
336
- *
337
- * @param nwkOptions Options to configure the new network with.
338
- * @param failOnCollision Whether process should throw an error if PAN ID collision is detected.
339
- * @param writeConfiguredFlag Whether zigbee-herdsman `hasConfigured` flag should be written to NV.
340
- */
341
- private async beginCommissioning(nwkOptions: Models.NetworkOptions, failOnCollision = true, writeConfiguredFlag = true): Promise<void> {
342
- if (nwkOptions.panId === 65535) {
343
- throw new Error("network commissioning failed - cannot use pan id 65535");
344
- }
345
-
346
- /* clear and reset the adapter */
347
- await this.nv.deleteItem(NvItemsIds.NIB);
348
- await this.clearAdapter();
349
-
350
- /* commission the network as per parameters */
351
- await this.updateCommissioningNvItems(nwkOptions);
352
- logger.debug("beginning network commissioning", NS);
353
- if ([ZnpVersion.ZStack30x, ZnpVersion.ZStack3x0].includes(this.options.version)) {
354
- /* configure channel */
355
- await this.znp.request(Subsystem.APP_CNF, "bdbSetChannel", {isPrimary: 0x1, channel: Utils.packChannelList(nwkOptions.channelList)});
356
- await this.znp.request(Subsystem.APP_CNF, "bdbSetChannel", {isPrimary: 0x0, channel: 0x0});
357
-
358
- /* perform bdb commissioning */
359
- const started = this.znp.waitFor(UnpiConstants.Type.AREQ, Subsystem.ZDO, "stateChangeInd", undefined, undefined, 9, 60000);
360
- await this.znp.request(Subsystem.APP_CNF, "bdbStartCommissioning", {mode: 0x04});
361
- try {
362
- await started.start().promise;
363
- } catch (error) {
364
- throw new Error(
365
- `network commissioning timed out - most likely network with the same panId or extendedPanId already exists nearby (${(error as Error).stack})`,
366
- );
367
- }
368
- } else {
369
- /* Z-Stack 1.2 requires startup to be performed instead of BDB commissioning */
370
- await this.beginStartup();
371
- }
372
-
373
- /* wait for NIB to settle (takes different amount of time of different platforms */
374
- logger.debug("waiting for NIB to settle", NS);
375
- let reads = 0;
376
- let nib: ReturnType<typeof Structs.nib>;
377
- do {
378
- await wait(3000);
379
- nib = await this.nv.readItem(NvItemsIds.NIB, 0, Structs.nib);
380
- reads++;
381
- } while ((!nib || nib.nwkPanId === 65535 || nib.nwkLogicalChannel === 0) && reads < 10);
382
- if (!nib || nib.nwkPanId === 65535 || nib.nwkLogicalChannel === 0) {
383
- throw new Error("network commissioning failed - timed out waiting for nib to settle");
384
- }
385
-
386
- /* validate provisioned PAN ID */
387
- const extNwkInfo = await this.znp.requestWithReply(Subsystem.ZDO, "extNwkInfo", {});
388
- if (extNwkInfo.payload.panid !== nwkOptions.panId && failOnCollision) {
389
- throw new Error(
390
- `network commissioning failed - panId collision detected (expected=${nwkOptions.panId}, actual=${extNwkInfo.payload.panid})`,
391
- );
392
- }
393
-
394
- logger.debug("network commissioned", NS);
395
-
396
- /* write configuration flag */
397
- if (writeConfiguredFlag) {
398
- await this.writeConfigurationFlag();
399
- }
400
- }
401
-
402
- /**
403
- * Updates commissioning NV memory parameters in connected controller. This method should be invoked
404
- * to configure network commissioning parameters or update the controller after restore.
405
- *
406
- * @param options Network options to set in NV memory.
407
- */
408
- private async updateCommissioningNvItems(options: Models.NetworkOptions): Promise<void> {
409
- const nwkPanId = Structs.nwkPanId();
410
- nwkPanId.panId = options.panId;
411
- const channelList = Structs.channelList();
412
- channelList.channelList = Utils.packChannelList(options.channelList);
413
- const extendedPanIdReversed = Buffer.from(options.extendedPanId).reverse();
414
-
415
- logger.debug("setting network commissioning parameters", NS);
416
-
417
- await this.nv.updateItem(NvItemsIds.STARTUP_OPTION, Buffer.from([0x00]));
418
- await this.nv.updateItem(NvItemsIds.LOGICAL_TYPE, Buffer.from([ZnpConstants.ZDO.deviceLogicalType.COORDINATOR]));
419
- await this.nv.updateItem(NvItemsIds.ZDO_DIRECT_CB, Buffer.from([0x01]));
420
- await this.nv.updateItem(NvItemsIds.CHANLIST, channelList.serialize());
421
- await this.nv.updateItem(NvItemsIds.PANID, nwkPanId.serialize());
422
- await this.nv.updateItem(NvItemsIds.EXTENDED_PAN_ID, extendedPanIdReversed);
423
- await this.nv.updateItem(NvItemsIds.APS_USE_EXT_PANID, extendedPanIdReversed);
424
- /* v8 ignore next */
425
- await this.nv.updateItem(NvItemsIds.PRECFGKEYS_ENABLE, Buffer.from([options.networkKeyDistribute ? 0x01 : 0x00]));
426
-
427
- if ([ZnpVersion.ZStack30x, ZnpVersion.ZStack3x0].includes(this.options.version)) {
428
- await this.nv.updateItem(NvItemsIds.PRECFGKEY, options.networkKey);
429
- } else {
430
- await this.znp.request(Subsystem.SAPI, "writeConfiguration", {
431
- configid: NvItemsIds.PRECFGKEY,
432
- len: options.networkKey.length,
433
- value: options.networkKey,
434
- });
435
- await this.nv.writeItem(
436
- NvItemsIds.LEGACY_TCLK_TABLE_START_12,
437
- Buffer.from([
438
- 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x5a, 0x69, 0x67, 0x42, 0x65, 0x65, 0x41, 0x6c, 0x6c, 0x69, 0x61, 0x6e, 0x63,
439
- 0x65, 0x30, 0x39, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
440
- ]),
441
- );
442
- }
443
- }
444
-
445
- /**
446
- * Registers endpoints before beginning normal operation.
447
- */
448
- private async registerEndpoints(): Promise<void> {
449
- const clusterId = Zdo.ClusterId.ACTIVE_ENDPOINTS_REQUEST;
450
- const zdoPayload = Zdo.Buffalo.buildRequest(this.adapter.hasZdoMessageOverhead, clusterId, ZSpec.COORDINATOR_ADDRESS);
451
- const response = await this.adapter.sendZdo(ZSpec.BLANK_EUI64, ZSpec.COORDINATOR_ADDRESS, clusterId, zdoPayload, false);
452
-
453
- if (Zdo.Buffalo.checkStatus<Zdo.ClusterId.ACTIVE_ENDPOINTS_RESPONSE>(response)) {
454
- const activeEndpoints = response[1].endpointList;
455
-
456
- for (const endpoint of Endpoints) {
457
- if (activeEndpoints.includes(endpoint.endpoint)) {
458
- logger.debug(`endpoint '${endpoint.endpoint}' already registered`, NS);
459
- } else {
460
- logger.debug(`registering endpoint '${endpoint.endpoint}'`, NS);
461
- await this.znp.request(Subsystem.AF, "register", endpoint);
462
- }
463
- }
464
- } else {
465
- throw new Zdo.StatusError(response[0]);
466
- }
467
- }
468
-
469
- /**
470
- * Adds endpoint to group.
471
- *
472
- * @param endpoint Endpoint index to add.
473
- * @param group Target group index.
474
- */
475
- private async addToGroup(endpoint: number, group: number): Promise<void> {
476
- const result = await this.znp.requestWithReply(5, "extFindGroup", {endpoint, groupid: group}, undefined, undefined, [
477
- ZnpCommandStatus.SUCCESS,
478
- ZnpCommandStatus.FAILURE,
479
- ]);
480
- if (result.payload.status === ZnpCommandStatus.FAILURE) {
481
- await this.znp.request(5, "extAddGroup", {endpoint, groupid: group, namelen: 0, groupname: []});
482
- }
483
- }
484
-
485
- /**
486
- * Internal method to reset the adapter.
487
- */
488
- private async resetAdapter(): Promise<void> {
489
- logger.debug("adapter reset requested", NS);
490
- await this.znp.request(Subsystem.SYS, "resetReq", {type: ZnpConstants.SYS.resetType.SOFT});
491
- logger.debug("adapter reset successful", NS);
492
- }
493
-
494
- /**
495
- * Internal method to reset adapter config and data.
496
- */
497
- private async clearAdapter(): Promise<void> {
498
- logger.debug("clearing adapter using startup option 3", NS);
499
- await this.nv.writeItem(NvItemsIds.STARTUP_OPTION, Buffer.from([0x03]));
500
- await this.resetAdapter();
501
- await this.nv.writeItem(NvItemsIds.STARTUP_OPTION, Buffer.from([0x00]));
502
- }
503
-
504
- /**
505
- * Transforms Z2M number-based network options to local Buffer-based options.
506
- *
507
- * This function also takes care of `dd:dd:dd:dd:dd:dd:dd:dd` extended PAN ID
508
- * and replaces it with adapter IEEE address.
509
- *
510
- * @param options Source Z2M network options.
511
- */
512
- private async parseConfigNetworkOptions(options: TsType.NetworkOptions): Promise<Models.NetworkOptions> {
513
- const channelList = options.channelList;
514
- channelList.sort((c1, c2) => (c1 < c2 ? -1 : c1 > c2 ? 1 : 0));
515
-
516
- const parsed: Models.NetworkOptions = {
517
- channelList: channelList,
518
- panId: options.panID,
519
- // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
520
- extendedPanId: Buffer.from(options.extendedPanID!),
521
- // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
522
- networkKey: Buffer.from(options.networkKey!),
523
- networkKeyDistribute: Boolean(options.networkKeyDistribute),
524
- };
525
- if (parsed.extendedPanId.equals(Buffer.alloc(8, 0xdd))) {
526
- const adapterIeeeAddressResponse = await this.znp.requestWithReply(Subsystem.SYS, "getExtAddr", {});
527
- parsed.extendedPanId = Buffer.from(adapterIeeeAddressResponse.payload.extaddress.split("0x")[1], "hex");
528
- parsed.hasDefaultExtendedPanId = true;
529
- }
530
- return parsed;
531
- }
532
-
533
- /**
534
- * Writes ZNP `hasConfigured` flag to NV memory. This flag indicates the adapter has been configured.
535
- */
536
- private async writeConfigurationFlag(): Promise<void> {
537
- logger.debug("writing configuration flag to adapter NV memory", NS);
538
- await this.nv.writeItem(
539
- this.options.version === ZnpVersion.ZStack12 ? NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK1 : NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK3,
540
- Buffer.from([0x55]),
541
- );
542
- }
543
- }
@@ -1,6 +0,0 @@
1
- enum ZnpVersion {
2
- ZStack12 = 0,
3
- ZStack3x0 = 1,
4
- ZStack30x = 2,
5
- }
6
- export {ZnpVersion};