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,1540 +0,0 @@
1
- /* v8 ignore start */
2
-
3
- import events from "node:events";
4
- import net from "node:net";
5
-
6
- import slip from "slip";
7
- import {Buffalo} from "../../../buffalo";
8
- import type {Backup} from "../../../models";
9
- import {logger} from "../../../utils/logger";
10
- import {SerialPort} from "../../serialPort";
11
- import SocketPortUtils from "../../socketPortUtils";
12
- import type {NetworkOptions, SerialPortOptions} from "../../tstype";
13
- import PARAM, {
14
- ApsAddressMode,
15
- type ApsDataRequest,
16
- type ApsRequest,
17
- DataType,
18
- FirmwareCommand,
19
- NetworkState,
20
- NwkBroadcastAddress,
21
- ParamId,
22
- type ReceivedDataResponse,
23
- type Request,
24
- stackParameters,
25
- } from "./constants";
26
-
27
- import {frameParserEvents} from "./frameParser";
28
- import Parser from "./parser";
29
- import Writer from "./writer";
30
-
31
- const NS = "zh:deconz:driver";
32
-
33
- const queue: Array<Request> = [];
34
- export const busyQueue: Array<Request> = [];
35
- const apsQueue: Array<ApsRequest> = [];
36
- export const apsBusyQueue: Array<ApsRequest> = [];
37
-
38
- const DRIVER_EVENT = Symbol("drv_ev");
39
-
40
- const DEV_STATUS_NET_STATE_MASK = 0x03;
41
- const DEV_STATUS_APS_CONFIRM = 0x04;
42
- const DEV_STATUS_APS_INDICATION = 0x08;
43
- const DEV_STATUS_APS_FREE_SLOTS = 0x20;
44
- //const DEV_STATUS_CONFIG_CHANGED = 0x10;
45
-
46
- enum DriverState {
47
- Init = 0,
48
- Connected = 1,
49
- Connecting = 2,
50
- ReadConfiguration = 3,
51
- WaitToReconnect = 4,
52
- Reconfigure = 5,
53
- CloseAndRestart = 6,
54
- }
55
-
56
- enum TxState {
57
- Idle = 0,
58
- WaitResponse = 1,
59
- }
60
-
61
- enum DriverEvent {
62
- Action = 0,
63
- Connected = 1,
64
- Disconnected = 2,
65
- DeviceStateUpdated = 3,
66
- ConnectError = 4,
67
- CloseError = 5,
68
- EnqueuedApsDataRequest = 6,
69
- Tick = 7,
70
- FirmwareCommandSend = 8,
71
- FirmwareCommandReceived = 9,
72
- FirmwareCommandTimeout = 10,
73
- }
74
-
75
- interface CommandResult {
76
- cmd: number;
77
- seq: number;
78
- }
79
-
80
- type DriverEventData = number | CommandResult;
81
-
82
- class Driver extends events.EventEmitter {
83
- private serialPort?: SerialPort;
84
- private serialPortOptions: SerialPortOptions;
85
- private writer: Writer;
86
- private parser: Parser;
87
- private frameParserEvent = frameParserEvents;
88
- private seqNumber: number;
89
- private deviceStatus = 0;
90
- // biome-ignore lint/correctness/noUnusedPrivateClassMembers: ignore
91
- private configChanged: number;
92
- private socketPort?: net.Socket;
93
- // biome-ignore lint/correctness/noUnusedPrivateClassMembers: ignore
94
- private timeoutCounter = 0;
95
- private watchdogTriggeredTime = 0;
96
- // biome-ignore lint/correctness/noUnusedPrivateClassMembers: ignore
97
- private lastFirmwareRxTime = 0;
98
- // biome-ignore lint/correctness/noUnusedPrivateClassMembers: ignore
99
- private tickTimer: NodeJS.Timeout;
100
- private driverStateStart = 0;
101
- private driverState: DriverState = DriverState.Init;
102
- private firmwareLog: string[];
103
- private transactionID = 0; // for APS and ZDO
104
- // in flight lockstep sending commands
105
- private txState: TxState = TxState.Idle;
106
- private txCommand = 0;
107
- private txSeq = 0;
108
- private txTime = 0;
109
- private networkOptions: NetworkOptions;
110
- private backup: Backup | undefined;
111
- private configMatchesBackup = false;
112
- private configIsNewNetwork = false;
113
- public restoredFromBackup = false;
114
- public paramMacAddress = 0n;
115
- public paramTcAddress = 0n;
116
- public paramFirmwareVersion = 0;
117
- public paramCurrentChannel = 0;
118
- public paramNwkPanid = 0;
119
- public paramNwkKey = Buffer.alloc(16);
120
- public paramEndpoint0: Buffer | undefined;
121
- public paramEndpoint1: Buffer | undefined;
122
- public fixParamEndpoint0: Buffer;
123
- public fixParamEndpoint1: Buffer;
124
- public paramNwkUpdateId = 0;
125
- public paramChannelMask = 0;
126
- public paramProtocolVersion = 0;
127
- public paramFrameCounter = 0;
128
- public paramApsUseExtPanid = 0n;
129
-
130
- public constructor(serialPortOptions: SerialPortOptions, networkOptions: NetworkOptions, backup: Backup | undefined, firmwareLog: string[]) {
131
- super();
132
- this.seqNumber = 0;
133
- this.configChanged = 0;
134
- this.networkOptions = networkOptions;
135
- this.serialPortOptions = serialPortOptions;
136
- this.backup = backup;
137
- this.firmwareLog = firmwareLog;
138
-
139
- this.writer = new Writer();
140
- this.parser = new Parser();
141
-
142
- this.fixParamEndpoint0 = Buffer.from([
143
- 0x00, // index
144
- 0x01, // endpoint,
145
- 0x04, // profileId
146
- 0x01,
147
- 0x05, // deviceId
148
- 0x00,
149
- 0x01, // deviceVersion
150
- 0x05, // in cluster count
151
- 0x00, // basic
152
- 0x00,
153
- 0x06, // on/off
154
- 0x00,
155
- 0x0a, // time
156
- 0x00,
157
- 0x19, // ota
158
- 0x00,
159
- 0x01, // ias ace
160
- 0x05,
161
- 0x04, // out cluster count
162
- 0x01, // power configuration
163
- 0x00,
164
- 0x20, // poll control
165
- 0x00,
166
- 0x00, // ias zone
167
- 0x05,
168
- 0x02, // ias wd
169
- 0x05,
170
- ]);
171
-
172
- this.fixParamEndpoint1 = Buffer.from([
173
- 0x01, // index
174
- 0xf2, // endpoint,
175
- 0xe0, // profileId
176
- 0xa1,
177
- 0x64, // deviceId
178
- 0x00,
179
- 0x01, // deviceVersion
180
- 0x00, // in cluster count
181
- 0x01, // out cluster count
182
- 0x21, // green power
183
- 0x00,
184
- ]);
185
-
186
- this.tickTimer = setInterval(() => {
187
- this.tick();
188
- }, 100);
189
-
190
- this.onParsed = this.onParsed.bind(this);
191
- this.frameParserEvent.on("deviceStateUpdated", (data: number) => {
192
- this.checkDeviceStatus(data);
193
- });
194
-
195
- this.on("close", () => {
196
- for (const interval of this.intervals) {
197
- clearInterval(interval);
198
- }
199
-
200
- this.timeoutCounter = 0;
201
- this.cleanupAllQueues();
202
- });
203
-
204
- this.on(DRIVER_EVENT, (event, data) => {
205
- this.handleStateEvent(event, data);
206
- });
207
- }
208
-
209
- public cleanupAllQueues() {
210
- const msg = `Cleanup in state: ${DriverState[this.driverState]}`;
211
-
212
- for (let i = 0; i < queue.length; i++) {
213
- queue[i].reject(new Error(msg));
214
- }
215
- queue.length = 0;
216
-
217
- for (let i = 0; i < busyQueue.length; i++) {
218
- busyQueue[i].reject(new Error(msg));
219
- }
220
- busyQueue.length = 0;
221
-
222
- for (let i = 0; i < apsQueue.length; i++) {
223
- apsQueue[i].reject(new Error(msg));
224
- }
225
- apsQueue.length = 0;
226
-
227
- for (let i = 0; i < apsBusyQueue.length; i++) {
228
- apsBusyQueue[i].reject(new Error(msg));
229
- }
230
- apsBusyQueue.length = 0;
231
- }
232
-
233
- public started(): boolean {
234
- return this.driverState === DriverState.Connected;
235
- }
236
-
237
- protected intervals: NodeJS.Timeout[] = [];
238
-
239
- protected registerInterval(interval: NodeJS.Timeout): void {
240
- this.intervals.push(interval);
241
- }
242
-
243
- protected async catchPromise<T>(val: Promise<T>): Promise<undefined | Awaited<T>> {
244
- return (await Promise.resolve(val).catch((err) => logger.debug(`Promise was caught with reason: ${err}`, NS))) as undefined | Awaited<T>;
245
- }
246
-
247
- public nextTransactionID(): number {
248
- this.transactionID++;
249
-
250
- if (this.transactionID > 255) {
251
- this.transactionID = 1;
252
- }
253
-
254
- return this.transactionID;
255
- }
256
-
257
- private tick(): void {
258
- this.emitStateEvent(DriverEvent.Tick);
259
- }
260
-
261
- private emitStateEvent(event: DriverEvent, data?: DriverEventData) {
262
- this.emit(DRIVER_EVENT, event, data);
263
- }
264
-
265
- private needWatchdogReset(): boolean {
266
- const now = Date.now();
267
- if (300 * 1000 < now - this.watchdogTriggeredTime) {
268
- return true;
269
- }
270
- return false;
271
- }
272
-
273
- private async resetWatchdog(): Promise<void> {
274
- const lastTime = this.watchdogTriggeredTime;
275
-
276
- try {
277
- logger.debug("Reset firmware watchdog", NS);
278
- // Set timestamp before command to let needWatchdogReset() no trigger multiple times.
279
- this.watchdogTriggeredTime = Date.now();
280
- await this.writeParameterRequest(ParamId.DEV_WATCHDOG_TTL, 600);
281
- logger.debug("Reset firmware watchdog success", NS);
282
- } catch (_err) {
283
- this.watchdogTriggeredTime = lastTime;
284
- logger.debug("Reset firmware watchdog failed", NS);
285
- }
286
- }
287
-
288
- private handleFirmwareEvent(event: DriverEvent, data?: DriverEventData): void {
289
- if (event === DriverEvent.FirmwareCommandSend) {
290
- if (this.txState !== TxState.Idle) {
291
- throw new Error("Unexpected TX state not idle");
292
- }
293
-
294
- const d = data as CommandResult;
295
- this.txState = TxState.WaitResponse;
296
- this.txCommand = d.cmd;
297
- this.txSeq = d.seq;
298
- this.txTime = Date.now();
299
- //logger.debug(`tx wait for cmd: ${d.cmd.toString(16).padStart(2, "0")}, seq: ${d.seq}`, NS);
300
- } else if (event === DriverEvent.FirmwareCommandReceived) {
301
- if (this.txState !== TxState.WaitResponse) {
302
- return;
303
- }
304
-
305
- const d = data as CommandResult;
306
- if (this.txCommand === d.cmd && this.txSeq === d.seq) {
307
- this.txState = TxState.Idle;
308
- //logger.debug(`tx released for cmd: ${d.cmd.toString(16).padStart(2, "0")}, seq: ${d.seq}`, NS);
309
- }
310
- } else if (event === DriverEvent.FirmwareCommandTimeout) {
311
- if (this.txState === TxState.WaitResponse) {
312
- this.txState = TxState.Idle;
313
- logger.debug(`tx timeout for cmd: ${this.txCommand.toString(16).padStart(2, "0")}, seq: ${this.txSeq}`, NS);
314
- }
315
- } else if (event === DriverEvent.Tick) {
316
- if (this.txState === TxState.WaitResponse) {
317
- if (Date.now() - this.txTime > 2000) {
318
- this.emitStateEvent(DriverEvent.FirmwareCommandTimeout);
319
- }
320
- }
321
- }
322
- }
323
-
324
- private handleConnectedStateEvent(event: DriverEvent, _data?: DriverEventData): void {
325
- if (event === DriverEvent.DeviceStateUpdated) {
326
- this.handleApsQueueOnDeviceState();
327
- } else if (event === DriverEvent.Tick) {
328
- if (this.needWatchdogReset()) {
329
- this.resetWatchdog();
330
- }
331
-
332
- this.processQueue();
333
-
334
- if (this.txState === TxState.Idle) {
335
- this.deviceStatus = 0; // force refresh in response
336
- this.sendReadDeviceStateRequest(this.nextSeqNumber());
337
- }
338
- } else if (event === DriverEvent.Disconnected) {
339
- logger.debug("Disconnected wait and reconnect", NS);
340
- this.driverStateStart = Date.now();
341
- this.driverState = DriverState.WaitToReconnect;
342
- }
343
- }
344
-
345
- private handleConnectingStateEvent(event: DriverEvent, _data?: DriverEventData): void {
346
- if (event === DriverEvent.Action) {
347
- this.watchdogTriggeredTime = 0; // force reset watchdog
348
-
349
- this.cleanupAllQueues(); // start with fresh queues
350
-
351
- // TODO(mpi): In future we should simply try which baudrate may work (in a state machine).
352
- // E.g. connect with baudrate XY, query firmware, on timeout try other baudrate.
353
- // Most units out there are ConBee2/3 which support 115200.
354
- // The 38400 default is outdated now and only works for a few units.
355
- const baudrate = this.serialPortOptions.baudRate || 38400;
356
-
357
- if (!this.serialPortOptions.path) {
358
- // unlikely but handle it anyway
359
- this.driverStateStart = Date.now();
360
- this.driverState = DriverState.WaitToReconnect;
361
- return;
362
- }
363
-
364
- let prom: Promise<void> | undefined;
365
- if (SocketPortUtils.isTcpPath(this.serialPortOptions.path)) {
366
- prom = this.openSocketPort();
367
- } else if (baudrate) {
368
- prom = this.openSerialPort(baudrate);
369
- } else {
370
- // unlikely but handle it anyway
371
- this.driverStateStart = Date.now();
372
- this.driverState = DriverState.WaitToReconnect;
373
- }
374
-
375
- if (prom) {
376
- prom.catch((err) => {
377
- logger.debug(`${err}`, NS);
378
- this.driverStateStart = Date.now();
379
- this.driverState = DriverState.WaitToReconnect;
380
- });
381
- }
382
- } else if (event === DriverEvent.Connected) {
383
- this.driverStateStart = Date.now();
384
- this.driverState = DriverState.ReadConfiguration;
385
- this.emitStateEvent(DriverEvent.Action);
386
- }
387
- }
388
-
389
- private isNetworkConfigurationValid(): boolean {
390
- const opts = this.networkOptions;
391
-
392
- let configExtPanID = 0n;
393
- const configNetworkKey = Buffer.from(opts.networkKey || []);
394
-
395
- if (opts.extendedPanID) {
396
- // NOTE(mpi): U64 values in buffer are big endian!
397
- configExtPanID = Buffer.from(opts.extendedPanID).readBigUInt64BE();
398
- }
399
-
400
- if (this.backup) {
401
- // NOTE(mpi): U64 values in buffer are big endian!
402
- const backupExtPanID = Buffer.from(this.backup.networkOptions.extendedPanId).readBigUInt64BE();
403
-
404
- if (
405
- opts.panID === this.backup.networkOptions.panId &&
406
- configExtPanID === backupExtPanID &&
407
- opts.channelList.includes(this.backup.logicalChannel) &&
408
- configNetworkKey.equals(this.backup.networkOptions.networkKey)
409
- ) {
410
- logger.debug("Configuration matches backup", NS);
411
- this.configMatchesBackup = true;
412
- } else {
413
- logger.debug("Configuration doesn't match backup (ignore backup)", NS);
414
- this.configMatchesBackup = false; // ignore Backup
415
- }
416
- }
417
-
418
- if (this.paramMacAddress !== this.paramTcAddress) {
419
- return false;
420
- }
421
-
422
- if (!this.paramEndpoint0 || this.fixParamEndpoint0.compare(this.paramEndpoint0) !== 0) {
423
- logger.debug("Endpoint[0] doesn't match configuration", NS);
424
- return false;
425
- }
426
-
427
- if (!this.paramEndpoint1 || this.fixParamEndpoint1.compare(this.paramEndpoint1) !== 0) {
428
- logger.debug("Endpoint[1] doesn't match configuration", NS);
429
- return false;
430
- }
431
-
432
- if ((this.deviceStatus & DEV_STATUS_NET_STATE_MASK) !== NetworkState.Connected) {
433
- return false;
434
- }
435
-
436
- if (opts.channelList.find((ch) => ch === this.paramCurrentChannel) === undefined) {
437
- return false;
438
- }
439
-
440
- if (configExtPanID !== 0n) {
441
- if (configExtPanID !== this.paramApsUseExtPanid) {
442
- this.configIsNewNetwork = true;
443
- return false;
444
- }
445
- }
446
-
447
- if (opts.panID !== this.paramNwkPanid) {
448
- return false;
449
- }
450
-
451
- if (opts.networkKey) {
452
- if (!configNetworkKey.equals(this.paramNwkKey)) {
453
- // this.configIsNewNetwork = true; // maybe, but we need to consider key rotation
454
- return false;
455
- }
456
- }
457
-
458
- if (this.backup && this.configMatchesBackup) {
459
- // The backup might be from another unit, if the mac doesn't match clone it!
460
- // NOTE(mpi): U64 values in buffer are big endian!
461
- const backupMacAddress = this.backup.coordinatorIeeeAddress.readBigUInt64BE();
462
- if (backupMacAddress !== this.paramMacAddress) {
463
- this.configIsNewNetwork = true;
464
- return false;
465
- }
466
-
467
- if (this.paramNwkUpdateId < this.backup.networkUpdateId) {
468
- return false;
469
- }
470
-
471
- // NOTE(mpi): Ignore the frame counter for now and only handle in case of this.configIsNewNetwork == true.
472
- // TODO(mpi): We might also check Trust Center Link Key and key sequence number (unlikely but possible case).
473
- }
474
-
475
- // TODO(mpi): Check endpoint configuration
476
- // const ep1 = = await this.driver.readParameterRequest(PARAM.PARAM.STK.Endpoint,);
477
- return true;
478
- }
479
-
480
- private async reconfigureNetwork(): Promise<void> {
481
- const opts = this.networkOptions;
482
-
483
- // if the configuration has a different channel, broadcast a channel change to the network first
484
- if (this.networkOptions.channelList.length !== 0) {
485
- if (opts.channelList[0] !== this.paramCurrentChannel) {
486
- logger.debug(`change channel from ${this.paramCurrentChannel} to ${opts.channelList[0]}`, NS);
487
- // increase the NWK Update ID so devices which search for the network know this is an update
488
- this.paramNwkUpdateId = (this.paramNwkUpdateId + 1) % 255;
489
- this.paramCurrentChannel = opts.channelList[0];
490
-
491
- if ((this.deviceStatus & DEV_STATUS_NET_STATE_MASK) === NetworkState.Connected) {
492
- await this.sendChangeChannelRequest();
493
- }
494
- }
495
- }
496
-
497
- // first disconnect the network
498
- await this.changeNetworkStateRequest(NetworkState.Disconnected);
499
-
500
- // check if a backup needs to be applied
501
- // Ember check if backup is needed:
502
- // - panId, extPanId, network key different -> leave network
503
- // - left or not joined -> consider using backup
504
- // backup is only used when matching the z2m config: panId, extPanId, channel, network key
505
- // parameters restored from backup:
506
- // - networkKey,
507
- // - networkKeyInfo.sequenceNumber NOTE(mpi): not a reason for using backup!?
508
- // - networkKeyInfo.frameCounter
509
- // - networkOptions.panId
510
- // - extendedPanId
511
- // - logicalChannel
512
- // - backup!.ezsp!.hashed_tclk! NOTE(mpi): not a reason for using backup!?
513
- // - backup!.networkUpdateId NOTE(mpi): not a reason for using backup!?
514
-
515
- let frameCounter = 0;
516
-
517
- if (this.backup && this.configMatchesBackup) {
518
- // NOTE(mpi): U64 values in buffer are big endian!
519
- const backupMacAddress = this.backup.coordinatorIeeeAddress.readBigUInt64BE();
520
- if (backupMacAddress !== this.paramMacAddress) {
521
- logger.debug(
522
- `Use mac address from backup 0x${backupMacAddress.toString(16).padStart(16, "0")}, replaces 0x${this.paramMacAddress.toString(16).padStart(16, "0")}`,
523
- NS,
524
- );
525
- this.paramMacAddress = backupMacAddress;
526
- this.restoredFromBackup = true;
527
-
528
- await this.writeParameterRequest(ParamId.MAC_ADDRESS, backupMacAddress);
529
- }
530
-
531
- if (this.configIsNewNetwork && this.paramFrameCounter < this.backup.networkKeyInfo.frameCounter) {
532
- // delicate situation, only update frame counter if:
533
- // - backup counter is higher
534
- // - this is in fact a new network
535
- // - configIsNewNetwork guards also from mistreating counter overflow
536
- logger.debug(`Use higher frame counter from backup ${this.backup.networkKeyInfo.frameCounter}`, NS);
537
- // Additionally increase frame counter. Note this might still be too low!
538
- frameCounter = this.backup.networkKeyInfo.frameCounter + 1000;
539
- this.restoredFromBackup = true;
540
- }
541
-
542
- if (this.paramNwkUpdateId < this.backup.networkUpdateId) {
543
- logger.debug(`Use network update ID from backup ${this.backup.networkUpdateId}`, NS);
544
- this.paramNwkUpdateId = this.backup.networkUpdateId;
545
- this.restoredFromBackup = true;
546
- }
547
-
548
- // TODO(mpi): Later on also check key sequence number.
549
- }
550
-
551
- if (this.paramMacAddress !== this.paramTcAddress) {
552
- this.paramTcAddress = this.paramMacAddress;
553
- await this.writeParameterRequest(ParamId.APS_TRUST_CENTER_ADDRESS, this.paramTcAddress);
554
- }
555
-
556
- if (this.configIsNewNetwork && this.paramFrameCounter < frameCounter) {
557
- this.paramFrameCounter = frameCounter;
558
- try {
559
- await this.writeParameterRequest(ParamId.STK_FRAME_COUNTER, this.paramFrameCounter);
560
- } catch (_err) {
561
- // on older firmware versions this fails as unsuppored
562
- }
563
- }
564
-
565
- await this.writeParameterRequest(ParamId.STK_NWK_UPDATE_ID, this.paramNwkUpdateId);
566
-
567
- if (this.networkOptions.channelList.length !== 0) {
568
- await this.writeParameterRequest(ParamId.APS_CHANNEL_MASK, 1 << this.networkOptions.channelList[0]);
569
- }
570
-
571
- this.paramNwkPanid = this.networkOptions.panID;
572
- await this.writeParameterRequest(ParamId.NWK_PANID, this.networkOptions.panID);
573
- await this.writeParameterRequest(ParamId.STK_PREDEFINED_PANID, 1);
574
-
575
- if (this.networkOptions.extendedPanID) {
576
- // NOTE(mpi): U64 values in buffer are big endian!
577
- this.paramApsUseExtPanid = Buffer.from(this.networkOptions.extendedPanID).readBigUInt64BE();
578
- await this.writeParameterRequest(ParamId.APS_USE_EXTENDED_PANID, this.paramApsUseExtPanid);
579
- }
580
-
581
- // check current network key against configuration.yaml
582
- if (this.networkOptions.networkKey) {
583
- this.paramNwkKey = Buffer.from(this.networkOptions.networkKey);
584
- await this.writeParameterRequest(ParamId.STK_NETWORK_KEY, Buffer.from([0x0, ...this.networkOptions.networkKey]));
585
- }
586
-
587
- // check current endpoint configuration
588
- if (!this.paramEndpoint0 || this.fixParamEndpoint0.compare(this.paramEndpoint0) !== 0) {
589
- this.paramEndpoint0 = this.fixParamEndpoint0;
590
- await this.writeParameterRequest(ParamId.STK_ENDPOINT, this.paramEndpoint0);
591
- }
592
-
593
- if (!this.paramEndpoint1 || this.fixParamEndpoint1.compare(this.paramEndpoint1) !== 0) {
594
- this.paramEndpoint1 = this.fixParamEndpoint1;
595
- await this.writeParameterRequest(ParamId.STK_ENDPOINT, this.paramEndpoint1);
596
- }
597
-
598
- // now reconnect, this will also store configuration in nvram
599
- await this.changeNetworkStateRequest(NetworkState.Connected);
600
- return;
601
- }
602
-
603
- private handleReadConfigurationStateEvent(event: DriverEvent, _data?: DriverEventData): void {
604
- if (event === DriverEvent.Action) {
605
- logger.debug("Query firmware parameters", NS);
606
-
607
- this.deviceStatus = 0; // need fresh value
608
-
609
- Promise.all([
610
- this.resetWatchdog(),
611
- this.readFirmwareVersionRequest(),
612
- this.readDeviceStatusRequest(),
613
- this.readParameterRequest(ParamId.MAC_ADDRESS),
614
- this.readParameterRequest(ParamId.APS_TRUST_CENTER_ADDRESS),
615
- this.readParameterRequest(ParamId.NWK_PANID),
616
- this.readParameterRequest(ParamId.APS_USE_EXTENDED_PANID),
617
- this.readParameterRequest(ParamId.STK_CURRENT_CHANNEL),
618
- this.readParameterRequest(ParamId.STK_NETWORK_KEY, Buffer.from([0])),
619
- this.readParameterRequest(ParamId.STK_NWK_UPDATE_ID),
620
- this.readParameterRequest(ParamId.APS_CHANNEL_MASK),
621
- this.readParameterRequest(ParamId.STK_PROTOCOL_VERSION),
622
- this.readParameterRequest(ParamId.STK_FRAME_COUNTER),
623
- this.readParameterRequest(ParamId.STK_ENDPOINT, Buffer.from([0])),
624
- this.readParameterRequest(ParamId.STK_ENDPOINT, Buffer.from([1])),
625
- ])
626
- .then(
627
- ([
628
- _watchdog,
629
- fwVersion,
630
- _deviceState,
631
- mac,
632
- tcAddress,
633
- panid,
634
- apsUseExtPanid,
635
- currentChannel,
636
- nwkKey,
637
- nwkUpdateId,
638
- channelMask,
639
- protocolVersion,
640
- frameCounter,
641
- ep0,
642
- ep1,
643
- ]) => {
644
- this.paramFirmwareVersion = fwVersion;
645
- this.paramCurrentChannel = currentChannel as number;
646
- this.paramApsUseExtPanid = apsUseExtPanid as bigint;
647
- this.paramNwkPanid = panid as number;
648
- this.paramNwkKey = nwkKey as Buffer;
649
- this.paramNwkUpdateId = nwkUpdateId as number;
650
- this.paramMacAddress = mac as bigint;
651
- this.paramTcAddress = tcAddress as bigint;
652
- this.paramChannelMask = channelMask as number;
653
- this.paramProtocolVersion = protocolVersion as number;
654
- if (frameCounter !== null) {
655
- this.paramFrameCounter = frameCounter as number;
656
- }
657
- if (ep0 !== null) {
658
- this.paramEndpoint0 = ep0 as Buffer;
659
- }
660
-
661
- if (ep1 !== null) {
662
- this.paramEndpoint1 = ep1 as Buffer;
663
- }
664
-
665
- // console.log({fwVersion, mac, panid, apsUseExtPanid, currentChannel, nwkKey, nwkUpdateId, channelMask, protocolVersion, frameCounter});
666
-
667
- if (this.isNetworkConfigurationValid()) {
668
- logger.debug("Zigbee configuration valid", NS);
669
- this.driverStateStart = Date.now();
670
- this.driverState = DriverState.Connected;
671
-
672
- // enable optional firmware debug messages
673
- let logLevel = 0;
674
- for (const level of this.firmwareLog) {
675
- if (level === "APS") logLevel |= 0x00000100;
676
- else if (level === "APS_L2") logLevel |= 0x00010000;
677
- }
678
- if (logLevel !== 0) {
679
- this.writeParameterRequest(ParamId.STK_DEBUG_LOG_LEVEL, logLevel)
680
- .then((_x) => {
681
- logger.debug("Enabled firmware logging", NS);
682
- })
683
- .catch((_err) => {
684
- logger.debug("Firmware logging unsupported by firmware", NS);
685
- });
686
- }
687
- } else {
688
- this.driverStateStart = Date.now();
689
- this.driverState = DriverState.Reconfigure;
690
- this.emitStateEvent(DriverEvent.Action);
691
- }
692
- },
693
- )
694
- .catch((_err) => {
695
- this.driverStateStart = Date.now();
696
- this.driverState = DriverState.CloseAndRestart;
697
- logger.debug("Failed to query firmware parameters", NS);
698
- });
699
- } else if (event === DriverEvent.Tick) {
700
- this.processQueue();
701
- }
702
- }
703
-
704
- private handleReconfigureStateEvent(event: DriverEvent, _data?: DriverEventData): void {
705
- if (event === DriverEvent.Action) {
706
- logger.debug("Reconfigure Zigbee network to match configuration", NS);
707
-
708
- this.reconfigureNetwork()
709
- .then(() => {
710
- this.driverStateStart = Date.now();
711
- this.driverState = DriverState.Connected;
712
- })
713
- .catch((err) => {
714
- logger.debug(`Failed to reconfigure Zigbee network, error: ${err}, wait 15 seconds to retry`, NS);
715
- this.driverStateStart = Date.now();
716
- });
717
- } else if (event === DriverEvent.Tick) {
718
- this.processQueue();
719
-
720
- // if we run into this timeout assume some error and retry after waiting a bit
721
- if (15000 < Date.now() - this.driverStateStart) {
722
- this.driverStateStart = Date.now();
723
- this.driverState = DriverState.CloseAndRestart;
724
- }
725
-
726
- if (this.txState === TxState.Idle) {
727
- // needed to process channel change ZDP request
728
- this.deviceStatus = 0; // force refresh in response
729
- this.sendReadDeviceStateRequest(this.nextSeqNumber());
730
- }
731
- } else if (event === DriverEvent.DeviceStateUpdated) {
732
- this.handleApsQueueOnDeviceState();
733
- }
734
- }
735
-
736
- private handleWaitToReconnectStateEvent(event: DriverEvent, _data?: DriverEventData): void {
737
- if (event === DriverEvent.Tick) {
738
- if (5000 < Date.now() - this.driverStateStart) {
739
- this.driverState = DriverState.Connecting;
740
- this.emitStateEvent(DriverEvent.Action);
741
- }
742
- }
743
- }
744
-
745
- private handleCloseAndRestartStateEvent(event: DriverEvent, _data?: DriverEventData): void {
746
- if (event === DriverEvent.Tick) {
747
- if (1000 < Date.now() - this.driverStateStart) {
748
- // if the connection is open try to close it every second.
749
- this.driverStateStart = Date.now();
750
- if (this.isOpen()) {
751
- this.close();
752
- } else {
753
- this.driverState = DriverState.WaitToReconnect;
754
- }
755
- }
756
- }
757
- }
758
-
759
- private handleApsQueueOnDeviceState() {
760
- // logger.debug(`Updated device status: ${data.toString(2)}`, NS);
761
-
762
- const netState = this.deviceStatus & DEV_STATUS_NET_STATE_MASK;
763
-
764
- if (this.txState === TxState.Idle) {
765
- if (netState === NetworkState.Connected) {
766
- const status = this.deviceStatus;
767
- if (status & DEV_STATUS_APS_CONFIRM) {
768
- this.deviceStatus = 0; // force refresh in response
769
- this.sendReadApsConfirmRequest(this.nextSeqNumber());
770
- } else if (status & DEV_STATUS_APS_INDICATION) {
771
- this.deviceStatus = 0; // force refresh in response
772
- this.sendReadApsIndicationRequest(this.nextSeqNumber());
773
- } else if (status & DEV_STATUS_APS_FREE_SLOTS) {
774
- this.deviceStatus = 0; // force refresh in response
775
- this.processApsQueue();
776
- }
777
- }
778
- }
779
- }
780
-
781
- private handleStateEvent(event: DriverEvent, data?: DriverEventData): void {
782
- try {
783
- // all states
784
- if (
785
- event === DriverEvent.Tick ||
786
- event === DriverEvent.FirmwareCommandReceived ||
787
- event === DriverEvent.FirmwareCommandSend ||
788
- event === DriverEvent.FirmwareCommandTimeout
789
- ) {
790
- this.handleFirmwareEvent(event, data);
791
- this.processBusyQueueTimeouts();
792
- this.processApsBusyQueueTimeouts();
793
- }
794
-
795
- if (this.driverState === DriverState.Init) {
796
- this.driverState = DriverState.WaitToReconnect;
797
- this.driverStateStart = 0; // force fast initial connect
798
- } else if (this.driverState === DriverState.Connected) {
799
- this.handleConnectedStateEvent(event, data);
800
- } else if (this.driverState === DriverState.Connecting) {
801
- this.handleConnectingStateEvent(event, data);
802
- } else if (this.driverState === DriverState.WaitToReconnect) {
803
- this.handleWaitToReconnectStateEvent(event, data);
804
- } else if (this.driverState === DriverState.ReadConfiguration) {
805
- this.handleReadConfigurationStateEvent(event, data);
806
- } else if (this.driverState === DriverState.Reconfigure) {
807
- this.handleReconfigureStateEvent(event, data);
808
- } else if (this.driverState === DriverState.CloseAndRestart) {
809
- this.handleCloseAndRestartStateEvent(event, data);
810
- } else {
811
- if (event !== DriverEvent.Tick) {
812
- logger.debug(`handle state: ${DriverState[this.driverState]}, event: ${DriverEvent[event]}`, NS);
813
- }
814
- }
815
- } catch (_err) {
816
- // console.error(err);
817
- }
818
- }
819
-
820
- private onPortClose(error: boolean | Error): void {
821
- if (error) {
822
- logger.info(`Port close: state: ${DriverState[this.driverState]}, reason: ${error}`, NS);
823
- } else {
824
- logger.debug(`Port closed in state: ${DriverState[this.driverState]}`, NS);
825
- }
826
-
827
- this.emitStateEvent(DriverEvent.Disconnected);
828
- this.emit("close");
829
- }
830
-
831
- private onPortError(error: Error): void {
832
- logger.error(`Port error: ${error}`, NS);
833
- this.emitStateEvent(DriverEvent.Disconnected);
834
- this.emit("close");
835
- }
836
-
837
- private isOpen(): boolean {
838
- if (this.serialPort) return this.serialPort.isOpen;
839
- if (this.socketPort) return this.socketPort.readyState !== "closed";
840
- return false;
841
- }
842
-
843
- public openSerialPort(baudrate: number): Promise<void> {
844
- return new Promise((resolve, reject): void => {
845
- if (!this.serialPortOptions.path) {
846
- reject(new Error("Failed to open serial port, path is undefined"));
847
- }
848
-
849
- logger.debug(`Opening serial port: ${this.serialPortOptions.path}`, NS);
850
-
851
- const path = this.serialPortOptions.path || "";
852
-
853
- if (!this.serialPort) {
854
- this.serialPort = new SerialPort({path, baudRate: baudrate, autoOpen: false});
855
- this.writer.pipe(this.serialPort);
856
- this.serialPort.pipe(this.parser);
857
- this.parser.on("parsed", this.onParsed);
858
- this.serialPort.on("close", this.onPortClose.bind(this));
859
- this.serialPort.on("error", this.onPortError.bind(this));
860
- }
861
-
862
- if (!this.serialPort) {
863
- reject(new Error("Failed to create SerialPort instance"));
864
- return;
865
- }
866
-
867
- if (this.serialPort.isOpen) {
868
- resolve();
869
- return;
870
- }
871
-
872
- this.serialPort.open((error) => {
873
- if (error) {
874
- reject(new Error(`Error while opening serialport '${error}'`));
875
-
876
- if (this.serialPort) {
877
- if (this.serialPort.isOpen) {
878
- this.emitStateEvent(DriverEvent.ConnectError);
879
- //this.serialPort!.close();
880
- }
881
- }
882
- } else {
883
- logger.debug("Serialport opened", NS);
884
- this.emitStateEvent(DriverEvent.Connected);
885
- resolve();
886
- }
887
- });
888
- });
889
- }
890
-
891
- private async openSocketPort(): Promise<void> {
892
- if (!this.serialPortOptions.path) {
893
- throw new Error("No serial port TCP path specified");
894
- }
895
-
896
- const info = SocketPortUtils.parseTcpPath(this.serialPortOptions.path);
897
- logger.debug(`Opening TCP socket with ${info.host}:${info.port}`, NS);
898
- this.socketPort = new net.Socket();
899
- this.socketPort.setNoDelay(true);
900
- this.socketPort.setKeepAlive(true, 15000);
901
-
902
- this.writer = new Writer();
903
- this.writer.pipe(this.socketPort);
904
-
905
- this.parser = new Parser();
906
- this.socketPort.pipe(this.parser);
907
- this.parser.on("parsed", this.onParsed);
908
-
909
- return await new Promise((resolve, reject): void => {
910
- // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
911
- this.socketPort!.on("connect", () => {
912
- logger.debug("Socket connected", NS);
913
- });
914
-
915
- // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
916
- this.socketPort!.on("ready", () => {
917
- logger.debug("Socket ready", NS);
918
- this.emitStateEvent(DriverEvent.Connected);
919
- resolve();
920
- });
921
-
922
- // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
923
- this.socketPort!.once("close", this.onPortClose);
924
-
925
- // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
926
- this.socketPort!.on("error", (error) => {
927
- logger.error(`Socket error ${error}`, NS);
928
- reject(new Error("Error while opening socket"));
929
- });
930
-
931
- // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
932
- this.socketPort!.connect(info.port, info.host);
933
- });
934
- }
935
-
936
- public close(): Promise<void> {
937
- return new Promise((resolve, reject): void => {
938
- if (this.serialPort) {
939
- if (this.serialPort.isOpen) {
940
- // wait until remaining data is written
941
- this.serialPort.flush();
942
- this.serialPort.close((error): void => {
943
- if (error) {
944
- // TODO(mpi): monitor, this must not happen after drain
945
- // close() failes if there is pending data to write!
946
- this.emitStateEvent(DriverEvent.CloseError);
947
- reject(new Error(`Error while closing serialport '${error}'`));
948
- return;
949
- }
950
- });
951
- }
952
-
953
- this.emitStateEvent(DriverEvent.Disconnected);
954
- this.emit("close");
955
- resolve();
956
- } else if (this.socketPort) {
957
- this.socketPort.destroy();
958
- this.socketPort = undefined;
959
- this.emitStateEvent(DriverEvent.Disconnected);
960
- resolve();
961
- } else {
962
- resolve();
963
- this.emit("close");
964
- }
965
- });
966
- }
967
-
968
- public readParameterRequest(parameterId: ParamId, parameter?: Buffer | number | bigint): Promise<unknown> {
969
- const seqNumber = this.nextSeqNumber();
970
- return new Promise((resolve, reject): void => {
971
- //logger.debug(`push read parameter request to queue. seqNr: ${seqNumber} paramId: ${parameterId}`, NS);
972
- const ts = 0;
973
- const commandId = FirmwareCommand.ReadParameter;
974
- const networkState = NetworkState.Ignore;
975
-
976
- const req: Request = {commandId, networkState, parameterId, parameter, seqNumber, resolve, reject, ts};
977
- queue.push(req);
978
- });
979
- }
980
-
981
- public writeParameterRequest(parameterId: ParamId, parameter: Buffer | number | bigint): Promise<void> {
982
- const seqNumber = this.nextSeqNumber();
983
- return new Promise((resolve, reject): void => {
984
- //logger.debug(`push write parameter request to queue. seqNr: ${seqNumber} paramId: ${parameterId} parameter: ${parameter}`, NS);
985
- const ts = 0;
986
- const commandId = FirmwareCommand.WriteParameter;
987
- const networkState = NetworkState.Ignore;
988
- const req: Request = {commandId, networkState, parameterId, parameter, seqNumber, resolve, reject, ts};
989
- queue.push(req);
990
- });
991
- }
992
-
993
- private sendChangeChannelRequest(): Promise<undefined | ReceivedDataResponse> {
994
- const zdpSeq = this.nextTransactionID();
995
- const scanChannels = 1 << this.networkOptions.channelList[0];
996
- const scanDuration = 0xfe; // special value = channel change
997
-
998
- const payload = Buffer.alloc(7);
999
- let pos = 0;
1000
- payload.writeUInt8(zdpSeq, pos);
1001
- pos += 1;
1002
- payload.writeUInt32LE(scanChannels, pos);
1003
- pos += 4;
1004
- payload.writeUInt8(scanDuration, pos);
1005
- pos += 1;
1006
- payload.writeUInt8(this.paramNwkUpdateId, pos);
1007
- pos += 1;
1008
-
1009
- const req: ApsDataRequest = {
1010
- requestId: this.nextTransactionID(),
1011
- destAddrMode: ApsAddressMode.Nwk,
1012
- destAddr16: NwkBroadcastAddress.BroadcastRxOnWhenIdle,
1013
- destEndpoint: 0,
1014
- profileId: 0,
1015
- clusterId: 0x0038, // ZDP_MGMT_NWK_UPDATE_REQ_CLID
1016
- srcEndpoint: 0,
1017
- asduLength: payload.length,
1018
- asduPayload: payload,
1019
- txOptions: 0,
1020
- radius: PARAM.PARAM.txRadius.DEFAULT_RADIUS,
1021
- timeout: PARAM.PARAM.APS.MAX_SEND_TIMEOUT,
1022
- };
1023
-
1024
- return this.enqueueApsDataRequest(req);
1025
- }
1026
-
1027
- public async writeLinkKey(ieeeAddress: string, hashedKey: Buffer): Promise<void> {
1028
- const buf = Buffer.alloc(8 + 16);
1029
-
1030
- if (ieeeAddress[1] !== "x") {
1031
- ieeeAddress = `0x${ieeeAddress}`;
1032
- }
1033
-
1034
- buf.writeBigUint64LE(BigInt(ieeeAddress));
1035
- for (let i = 0; i < 16; i++) {
1036
- buf.writeUint8(hashedKey[i], 8 + i);
1037
- }
1038
-
1039
- await this.writeParameterRequest(ParamId.STK_LINK_KEY, buf);
1040
- }
1041
-
1042
- public readFirmwareVersionRequest(): Promise<number> {
1043
- const seqNumber = this.nextSeqNumber();
1044
- return new Promise((resolve, reject): void => {
1045
- //logger.debug(`push read firmware version request to queue. seqNr: ${seqNumber}`, NS);
1046
- const ts = 0;
1047
- const commandId = FirmwareCommand.FirmwareVersion;
1048
- const networkState = NetworkState.Ignore;
1049
- const parameterId = ParamId.NONE;
1050
- const req: Request = {commandId, networkState, parameterId, seqNumber, resolve, reject, ts};
1051
- queue.push(req);
1052
- });
1053
- }
1054
-
1055
- public readDeviceStatusRequest(): Promise<number> {
1056
- const seqNumber = this.nextSeqNumber();
1057
- return new Promise((resolve, reject): void => {
1058
- //logger.debug(`push read firmware version request to queue. seqNr: ${seqNumber}`, NS);
1059
- const ts = 0;
1060
- const commandId = FirmwareCommand.Status;
1061
- const networkState = NetworkState.Ignore;
1062
- const parameterId = ParamId.NONE;
1063
- const req: Request = {commandId, networkState, parameterId, seqNumber, resolve, reject, ts};
1064
- queue.push(req);
1065
- });
1066
- }
1067
-
1068
- private sendReadParameterRequest(parameterId: ParamId, seqNumber: number, arg?: Buffer | number | bigint): CommandResult {
1069
- let frameLength = 8; // starts with min. frame length
1070
- let payloadLength = 1; // min. parameterId
1071
-
1072
- if (arg instanceof Buffer) {
1073
- payloadLength += arg.byteLength;
1074
- frameLength += arg.byteLength;
1075
- }
1076
-
1077
- const buf = new Buffalo(Buffer.alloc(frameLength));
1078
-
1079
- buf.writeUInt8(FirmwareCommand.ReadParameter);
1080
- buf.writeUInt8(seqNumber);
1081
- buf.writeUInt8(0); // reserved, shall be 0
1082
- buf.writeUInt16(frameLength);
1083
- buf.writeUInt16(payloadLength);
1084
- buf.writeUInt8(parameterId);
1085
-
1086
- if (arg instanceof Buffer) {
1087
- buf.writeBuffer(arg, arg.byteLength);
1088
- }
1089
-
1090
- return this.sendRequest(buf.getBuffer());
1091
- }
1092
-
1093
- private sendWriteParameterRequest(parameterId: ParamId, value: Buffer | number | bigint, seqNumber: number): CommandResult {
1094
- // command id, sequence number, 0, framelength(U16), payloadlength(U16), parameter id, parameter
1095
- const param = stackParameters.find((x) => x.id === parameterId);
1096
- if (!param) {
1097
- throw new Error("tried to write unknown stack parameter");
1098
- }
1099
-
1100
- const buf = Buffer.alloc(128);
1101
- let pos = 0;
1102
- buf.writeUInt8(FirmwareCommand.WriteParameter, pos);
1103
- pos += 1;
1104
- buf.writeUInt8(seqNumber, pos);
1105
- pos += 1;
1106
- buf.writeUInt8(0, pos); // status: not used
1107
- pos += 1;
1108
-
1109
- const posFrameLength = pos; // remember
1110
- buf.writeUInt16LE(0, pos); // dummy frame length
1111
- pos += 2;
1112
- // -------------- actual data ---------------------------------------
1113
- const posPayloadLength = pos; // remember
1114
- buf.writeUInt16LE(0, pos); // dummy payload length
1115
- pos += 2;
1116
- buf.writeUInt8(parameterId, pos);
1117
- pos += 1;
1118
-
1119
- if (value instanceof Buffer) {
1120
- for (let i = 0; i < value.length; i++) {
1121
- buf.writeUInt8(value[i], pos);
1122
- pos += 1;
1123
- }
1124
- } else if (typeof value === "number") {
1125
- if (param.type === DataType.U8) {
1126
- buf.writeUInt8(value, pos);
1127
- pos += 1;
1128
- } else if (param.type === DataType.U16) {
1129
- buf.writeUInt16LE(value, pos);
1130
- pos += 2;
1131
- } else if (param.type === DataType.U32) {
1132
- buf.writeUInt32LE(value, pos);
1133
- pos += 4;
1134
- } else {
1135
- throw new Error("tried to write unknown parameter number type");
1136
- }
1137
- } else if (typeof value === "bigint") {
1138
- if (param.type === DataType.U64) {
1139
- buf.writeBigUInt64LE(value, pos);
1140
- pos += 8;
1141
- } else {
1142
- throw new Error("tried to write unknown parameter number type");
1143
- }
1144
- } else {
1145
- throw new Error("tried to write unknown parameter type");
1146
- }
1147
-
1148
- const payloadLength = pos - (posPayloadLength + 2);
1149
-
1150
- buf.writeUInt16LE(payloadLength, posPayloadLength); // actual payload length
1151
- buf.writeUInt16LE(pos, posFrameLength); // actual frame length
1152
-
1153
- const out = buf.subarray(0, pos);
1154
- return this.sendRequest(out);
1155
- }
1156
-
1157
- private sendReadFirmwareVersionRequest(seqNumber: number): CommandResult {
1158
- /* command id, sequence number, 0, framelength(U16) */
1159
- return this.sendRequest(Buffer.from([FirmwareCommand.FirmwareVersion, seqNumber, 0x00, 0x09, 0x00, 0x00, 0x00, 0x00, 0x00]));
1160
- }
1161
-
1162
- private sendReadDeviceStateRequest(seqNumber: number): CommandResult {
1163
- /* command id, sequence number, 0, framelength(U16) */
1164
- return this.sendRequest(Buffer.from([FirmwareCommand.Status, seqNumber, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00]));
1165
- }
1166
-
1167
- private sendRequest(buffer: Buffer): CommandResult {
1168
- const frame = Buffer.concat([buffer, this.calcCrc(buffer)]);
1169
- const slipframe = slip.encode(frame);
1170
-
1171
- if (frame[0] === 0x00) {
1172
- throw new Error(`send unexpected frame with invalid command ID: 0x${frame[0].toString(16).padStart(2, "0")}`);
1173
- }
1174
-
1175
- if (slipframe.length >= 256) {
1176
- throw new Error("send unexpected long slip frame");
1177
- }
1178
-
1179
- let written = false;
1180
-
1181
- if (this.serialPort) {
1182
- if (!this.serialPort.isOpen) {
1183
- throw new Error("Can't write to serial port while it isn't open");
1184
- }
1185
-
1186
- for (let retry = 0; retry < 3 && !written; retry++) {
1187
- written = this.serialPort.write(slipframe, (err) => {
1188
- if (err) {
1189
- throw new Error(`Failed to write to serial port: ${err.message}`);
1190
- }
1191
- });
1192
-
1193
- // if written is false, we also need to wait for drain()
1194
- this.serialPort.drain(); // flush
1195
- }
1196
- } else if (this.socketPort) {
1197
- written = this.socketPort.write(slipframe, (err) => {
1198
- if (err) {
1199
- throw new Error(`Failed to write to serial port: ${err.message}`);
1200
- }
1201
- written = true;
1202
- });
1203
-
1204
- // handle in upper functions
1205
- // if (!written) {
1206
- // await this.sleep(1000);
1207
- // }
1208
- }
1209
-
1210
- if (!written) {
1211
- throw new Error(`Failed to send request cmd: ${frame[0]}, seq: ${frame[1]}`);
1212
- }
1213
-
1214
- const result = {cmd: frame[0], seq: frame[1]};
1215
- this.emitStateEvent(DriverEvent.FirmwareCommandSend, result);
1216
- return result;
1217
- }
1218
-
1219
- private processQueue(): void {
1220
- if (queue.length === 0) {
1221
- return;
1222
- }
1223
- if (busyQueue.length > 0) {
1224
- return;
1225
- }
1226
-
1227
- if (this.txState !== TxState.Idle) {
1228
- return;
1229
- }
1230
-
1231
- const req: Request | undefined = queue.shift();
1232
-
1233
- if (req) {
1234
- req.ts = Date.now();
1235
-
1236
- try {
1237
- switch (req.commandId) {
1238
- case FirmwareCommand.ReadParameter:
1239
- logger.debug(`send read parameter request from queue. parameter: ${ParamId[req.parameterId]} seq: ${req.seqNumber}`, NS);
1240
- this.sendReadParameterRequest(req.parameterId, req.seqNumber, req.parameter);
1241
- break;
1242
- case FirmwareCommand.WriteParameter:
1243
- if (req.parameter === undefined) {
1244
- throw new Error(`Write parameter request without parameter: ${ParamId[req.parameterId]}`);
1245
- }
1246
- logger.debug(`Send write parameter request from queue. seq: ${req.seqNumber} parameter: ${ParamId[req.parameterId]}`, NS);
1247
- this.sendWriteParameterRequest(req.parameterId, req.parameter, req.seqNumber);
1248
- break;
1249
- case FirmwareCommand.FirmwareVersion:
1250
- logger.debug(`Send read firmware version request from queue. seq: ${req.seqNumber}`, NS);
1251
- this.sendReadFirmwareVersionRequest(req.seqNumber);
1252
- break;
1253
- case FirmwareCommand.Status:
1254
- //logger.debug(`Send read device state from queue. seqNr: ${req.seqNumber}`, NS);
1255
- this.sendReadDeviceStateRequest(req.seqNumber);
1256
- break;
1257
- case FirmwareCommand.ChangeNetworkState:
1258
- logger.debug(`Send change network state request from queue. seq: ${req.seqNumber}`, NS);
1259
- this.sendChangeNetworkStateRequest(req.seqNumber, req.networkState);
1260
- break;
1261
- default:
1262
- throw new Error("process queue - unknown command id");
1263
- }
1264
-
1265
- busyQueue.push(req);
1266
- } catch (_err) {
1267
- //console.error(err);
1268
- req.reject(new Error(`Failed to process request ${FirmwareCommand[req.commandId]}, seq: ${req.seqNumber}`));
1269
- }
1270
- }
1271
- }
1272
-
1273
- private processBusyQueueTimeouts(): void {
1274
- let i = busyQueue.length;
1275
- while (i--) {
1276
- const req: Request = busyQueue[i];
1277
- const now = Date.now();
1278
-
1279
- if (10000 < now - req.ts) {
1280
- //remove from busyQueue
1281
- busyQueue.splice(i, 1);
1282
- this.timeoutCounter++;
1283
- req.reject(new Error(`Timeout for queued command ${FirmwareCommand[req.commandId]}, seq: ${req.seqNumber}`));
1284
- }
1285
- }
1286
- }
1287
-
1288
- public changeNetworkStateRequest(networkState: NetworkState): Promise<void> {
1289
- const seqNumber = this.nextSeqNumber();
1290
- return new Promise((resolve, reject): void => {
1291
- //logger.debug(`push change network state request to apsQueue. seqNr: ${seqNumber}`, NS);
1292
- const ts = 0;
1293
- const commandId = FirmwareCommand.ChangeNetworkState;
1294
- const parameterId = ParamId.NONE;
1295
- const req: Request = {commandId, networkState, parameterId, seqNumber, resolve, reject, ts};
1296
- queue.push(req);
1297
- });
1298
- }
1299
-
1300
- private sendChangeNetworkStateRequest(seqNumber: number, networkState: NetworkState): CommandResult {
1301
- return this.sendRequest(Buffer.from([FirmwareCommand.ChangeNetworkState, seqNumber, 0x00, 0x06, 0x00, networkState]));
1302
- }
1303
-
1304
- private checkDeviceStatus(deviceStatus: number): void {
1305
- this.deviceStatus = deviceStatus;
1306
- this.configChanged = (deviceStatus >> 4) & 0x01;
1307
- this.emitStateEvent(DriverEvent.DeviceStateUpdated, deviceStatus);
1308
- }
1309
-
1310
- public enqueueApsDataRequest(request: ApsDataRequest): Promise<undefined | ReceivedDataResponse> {
1311
- const seqNumber = this.nextSeqNumber();
1312
- return new Promise((resolve, reject): void => {
1313
- //logger.debug(`push enqueue send data request to apsQueue. seqNr: ${seqNumber}`, NS);
1314
- const ts = Date.now();
1315
- const commandId = FirmwareCommand.ApsDataRequest;
1316
- const req: ApsRequest = {commandId, seqNumber, request, resolve, reject, ts};
1317
- apsQueue.push(req);
1318
- this.emitStateEvent(DriverEvent.EnqueuedApsDataRequest, req.seqNumber);
1319
- });
1320
- }
1321
-
1322
- private processApsQueue(): void {
1323
- if (apsQueue.length === 0) {
1324
- return;
1325
- }
1326
-
1327
- if (this.txState !== TxState.Idle) {
1328
- return;
1329
- }
1330
-
1331
- const req = apsQueue.shift();
1332
- if (!req) {
1333
- return;
1334
- }
1335
-
1336
- if (req.request) {
1337
- req.ts = Date.now();
1338
-
1339
- if (req.commandId !== FirmwareCommand.ApsDataRequest) {
1340
- // should never happen
1341
- throw new Error("process APS queue - unknown command id");
1342
- }
1343
-
1344
- try {
1345
- this.sendEnqueueApsDataRequest(req.request, req.seqNumber);
1346
- apsBusyQueue.push(req);
1347
- } catch (_) {
1348
- apsQueue.unshift(req);
1349
- }
1350
- }
1351
- }
1352
-
1353
- private sendReadApsConfirmRequest(seqNumber: number): CommandResult {
1354
- logger.debug(`Request APS-DATA.confirm seq: ${seqNumber}`, NS);
1355
- return this.sendRequest(Buffer.from([FirmwareCommand.ApsDataConfirm, seqNumber, 0x00, 0x07, 0x00, 0x00, 0x00]));
1356
- }
1357
-
1358
- private sendReadApsIndicationRequest(seqNumber: number): CommandResult {
1359
- logger.debug(`Request APS-DATA.indication seq: ${seqNumber}`, NS);
1360
- return this.sendRequest(Buffer.from([FirmwareCommand.ApsDataIndication, seqNumber, 0x00, 0x08, 0x00, 0x01, 0x00, 0x01]));
1361
- }
1362
-
1363
- private sendEnqueueApsDataRequest(request: ApsDataRequest, seqNumber: number): CommandResult {
1364
- const payloadLength =
1365
- 12 + (request.destAddrMode === ApsAddressMode.Group ? 2 : request.destAddrMode === ApsAddressMode.Nwk ? 3 : 9) + request.asduLength;
1366
- const frameLength = 7 + payloadLength;
1367
- const cid1 = request.clusterId & 0xff;
1368
- const cid2 = (request.clusterId >> 8) & 0xff;
1369
- const asdul1 = request.asduLength & 0xff;
1370
- const asdul2 = (request.asduLength >> 8) & 0xff;
1371
- let destArray: Array<number> = [];
1372
- let dest = "";
1373
-
1374
- if (request.destAddr16 !== undefined) {
1375
- destArray[0] = request.destAddr16 & 0xff;
1376
- destArray[1] = (request.destAddr16 >> 8) & 0xff;
1377
- dest = request.destAddr16.toString(16);
1378
- }
1379
- if (request.destAddr64 !== undefined) {
1380
- dest = request.destAddr64;
1381
- destArray = this.macAddrStringToArray(request.destAddr64);
1382
- }
1383
- if (request.destEndpoint !== undefined) {
1384
- destArray.push(request.destEndpoint);
1385
- dest += " EP:";
1386
- dest += request.destEndpoint;
1387
- }
1388
-
1389
- logger.debug(`Request APS-DATA.request: dest: 0x${dest} seq: ${seqNumber} requestId: ${request.requestId}`, NS);
1390
-
1391
- return this.sendRequest(
1392
- Buffer.from([
1393
- FirmwareCommand.ApsDataRequest,
1394
- seqNumber,
1395
- 0x00,
1396
- frameLength & 0xff,
1397
- (frameLength >> 8) & 0xff,
1398
- payloadLength & 0xff,
1399
- (payloadLength >> 8) & 0xff,
1400
- request.requestId,
1401
- 0x00,
1402
- request.destAddrMode,
1403
- ...destArray,
1404
- request.profileId & 0xff,
1405
- (request.profileId >> 8) & 0xff,
1406
- cid1,
1407
- cid2,
1408
- request.srcEndpoint,
1409
- asdul1,
1410
- asdul2,
1411
- ...request.asduPayload,
1412
- request.txOptions,
1413
- request.radius,
1414
- ]),
1415
- );
1416
- }
1417
-
1418
- private processApsBusyQueueTimeouts(): void {
1419
- let i = apsBusyQueue.length;
1420
- while (i--) {
1421
- const req = apsBusyQueue[i];
1422
- const now = Date.now();
1423
- let timeout = 60000;
1424
- if (req.request != null && req.request.timeout != null) {
1425
- timeout = req.request.timeout * 1000; // seconds * 1000 = milliseconds
1426
- }
1427
- if (now - req.ts > timeout) {
1428
- //remove from busyQueue
1429
- apsBusyQueue.splice(i, 1);
1430
- req.reject(new Error(`Timeout for APS-DATA.request, seq: ${req.seqNumber}`));
1431
- }
1432
- }
1433
- }
1434
-
1435
- private calcCrc(buffer: Uint8Array): Buffer {
1436
- let crc = 0;
1437
- for (let i = 0; i < buffer.length; i++) {
1438
- crc += buffer[i];
1439
- }
1440
- const crc0 = (~crc + 1) & 0xff;
1441
- const crc1 = ((~crc + 1) >> 8) & 0xff;
1442
- return Buffer.from([crc0, crc1]);
1443
- }
1444
-
1445
- public macAddrStringToArray(addr: string): Array<number> {
1446
- if (addr.indexOf("0x") === 0) {
1447
- addr = addr.slice(2, addr.length);
1448
- }
1449
- if (addr.length < 16) {
1450
- for (let l = 0; l < 16 - addr.length; l++) {
1451
- addr = `0${addr}`;
1452
- }
1453
- }
1454
- const result: number[] = [];
1455
- let y = 0;
1456
- for (let i = 0; i < 8; i++) {
1457
- result[i] = Number.parseInt(addr.substr(y, 2), 16);
1458
- y += 2;
1459
- }
1460
- const reverse = result.reverse();
1461
- return reverse;
1462
- }
1463
-
1464
- public macAddrArrayToString(addr: Array<number>): string {
1465
- if (addr.length !== 8) {
1466
- throw new Error(`invalid array length for MAC address: ${addr.length}`);
1467
- }
1468
-
1469
- let result = "0x";
1470
- let char = "";
1471
- let i = 8;
1472
- while (i--) {
1473
- char = addr[i].toString(16);
1474
- if (char.length < 2) {
1475
- char = `0${char}`;
1476
- }
1477
- result += char;
1478
- }
1479
- return result;
1480
- }
1481
-
1482
- /**
1483
- * generalArrayToString result is not reversed!
1484
- */
1485
- public generalArrayToString(key: Array<number>, length: number): string {
1486
- let result = "0x";
1487
- let char = "";
1488
- let i = 0;
1489
- while (i < length) {
1490
- char = key[i].toString(16);
1491
- if (char.length < 2) {
1492
- char = `0${char}`;
1493
- }
1494
- result += char;
1495
- i++;
1496
- }
1497
- return result;
1498
- }
1499
-
1500
- private nextSeqNumber(): number {
1501
- this.seqNumber++;
1502
-
1503
- if (this.seqNumber > 254) {
1504
- this.seqNumber = 1;
1505
- }
1506
-
1507
- return this.seqNumber;
1508
- }
1509
-
1510
- private onParsed(frame: Uint8Array): void {
1511
- if (frame.length >= 5) {
1512
- // min. packet length [cmd, seq, status, u16 storedLength]
1513
- const storedLength = (frame[4] << 8) | frame[3];
1514
- if (storedLength + 2 !== frame.length) {
1515
- // frame without CRC16
1516
- return;
1517
- }
1518
-
1519
- let crc = 0;
1520
- for (let i = 0; i < storedLength; i++) {
1521
- crc += frame[i];
1522
- }
1523
-
1524
- crc = (~crc + 1) & 0xffff;
1525
- const crcFrame = (frame[frame.length - 1] << 8) | frame[frame.length - 2];
1526
-
1527
- if (crc === crcFrame) {
1528
- this.lastFirmwareRxTime = Date.now();
1529
- this.emitStateEvent(DriverEvent.FirmwareCommandReceived, {cmd: frame[0], seq: frame[1]});
1530
- this.emit("rxFrame", frame.slice(0, storedLength));
1531
- } else {
1532
- logger.debug("frame CRC invalid (could be ASCII message)", NS);
1533
- }
1534
- } else {
1535
- logger.debug(`frame length (${frame.length}) < 5, discard`, NS);
1536
- }
1537
- }
1538
- }
1539
-
1540
- export default Driver;