@willieee802/zigbee-herdsman 0.19.2 → 0.34.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 (530) hide show
  1. package/.babelrc.js +0 -4
  2. package/.release-please-manifest.json +1 -2
  3. package/CHANGELOG.md +376 -0
  4. package/README.md +1 -1
  5. package/dist/adapter/adapter.d.ts +61 -61
  6. package/dist/adapter/adapter.d.ts.map +1 -1
  7. package/dist/adapter/adapter.js +158 -146
  8. package/dist/adapter/adapter.js.map +1 -1
  9. package/dist/adapter/deconz/adapter/deconzAdapter.d.ts +68 -68
  10. package/dist/adapter/deconz/adapter/deconzAdapter.d.ts.map +1 -1
  11. package/dist/adapter/deconz/adapter/deconzAdapter.js +1081 -1060
  12. package/dist/adapter/deconz/adapter/deconzAdapter.js.map +1 -1
  13. package/dist/adapter/deconz/adapter/index.d.ts +2 -2
  14. package/dist/adapter/deconz/adapter/index.js +10 -10
  15. package/dist/adapter/deconz/driver/constants.d.ts +104 -104
  16. package/dist/adapter/deconz/driver/constants.js +55 -55
  17. package/dist/adapter/deconz/driver/driver.d.ts +81 -81
  18. package/dist/adapter/deconz/driver/driver.d.ts.map +1 -1
  19. package/dist/adapter/deconz/driver/driver.js +750 -732
  20. package/dist/adapter/deconz/driver/driver.js.map +1 -1
  21. package/dist/adapter/deconz/driver/frame.d.ts +6 -6
  22. package/dist/adapter/deconz/driver/frame.js +13 -13
  23. package/dist/adapter/deconz/driver/frameParser.d.ts +2 -2
  24. package/dist/adapter/deconz/driver/frameParser.js +443 -443
  25. package/dist/adapter/deconz/driver/frameParser.js.map +1 -1
  26. package/dist/adapter/deconz/driver/parser.d.ts +12 -12
  27. package/dist/adapter/deconz/driver/parser.js +63 -61
  28. package/dist/adapter/deconz/driver/parser.js.map +1 -1
  29. package/dist/adapter/deconz/driver/writer.d.ts +8 -8
  30. package/dist/adapter/deconz/driver/writer.js +44 -44
  31. package/dist/adapter/ember/adapter/emberAdapter.d.ts +817 -0
  32. package/dist/adapter/ember/adapter/emberAdapter.d.ts.map +1 -0
  33. package/dist/adapter/ember/adapter/emberAdapter.js +2981 -0
  34. package/dist/adapter/ember/adapter/emberAdapter.js.map +1 -0
  35. package/dist/adapter/ember/adapter/endpoints.d.ts +25 -0
  36. package/dist/adapter/ember/adapter/endpoints.d.ts.map +1 -0
  37. package/dist/adapter/ember/adapter/endpoints.js +66 -0
  38. package/dist/adapter/ember/adapter/endpoints.js.map +1 -0
  39. package/dist/adapter/ember/adapter/index.d.ts +3 -0
  40. package/dist/adapter/ember/adapter/index.d.ts.map +1 -0
  41. package/dist/adapter/ember/adapter/index.js +6 -0
  42. package/dist/adapter/ember/adapter/index.js.map +1 -0
  43. package/dist/adapter/ember/adapter/oneWaitress.d.ts +97 -0
  44. package/dist/adapter/ember/adapter/oneWaitress.d.ts.map +1 -0
  45. package/dist/adapter/ember/adapter/oneWaitress.js +226 -0
  46. package/dist/adapter/ember/adapter/oneWaitress.js.map +1 -0
  47. package/dist/adapter/ember/adapter/requestQueue.d.ts +59 -0
  48. package/dist/adapter/ember/adapter/requestQueue.d.ts.map +1 -0
  49. package/dist/adapter/ember/adapter/requestQueue.js +144 -0
  50. package/dist/adapter/ember/adapter/requestQueue.js.map +1 -0
  51. package/dist/adapter/ember/adapter/tokensManager.d.ts +69 -0
  52. package/dist/adapter/ember/adapter/tokensManager.d.ts.map +1 -0
  53. package/dist/adapter/ember/adapter/tokensManager.js +685 -0
  54. package/dist/adapter/ember/adapter/tokensManager.js.map +1 -0
  55. package/dist/adapter/ember/consts.d.ts +198 -0
  56. package/dist/adapter/ember/consts.d.ts.map +1 -0
  57. package/dist/adapter/ember/consts.js +253 -0
  58. package/dist/adapter/ember/consts.js.map +1 -0
  59. package/dist/adapter/ember/enums.d.ts +2184 -0
  60. package/dist/adapter/ember/enums.d.ts.map +1 -0
  61. package/dist/adapter/ember/enums.js +2391 -0
  62. package/dist/adapter/ember/enums.js.map +1 -0
  63. package/dist/adapter/ember/ezsp/buffalo.d.ts +156 -0
  64. package/dist/adapter/ember/ezsp/buffalo.d.ts.map +1 -0
  65. package/dist/adapter/ember/ezsp/buffalo.js +1033 -0
  66. package/dist/adapter/ember/ezsp/buffalo.js.map +1 -0
  67. package/dist/adapter/ember/ezsp/consts.d.ts +116 -0
  68. package/dist/adapter/ember/ezsp/consts.d.ts.map +1 -0
  69. package/dist/adapter/ember/ezsp/consts.js +128 -0
  70. package/dist/adapter/ember/ezsp/consts.js.map +1 -0
  71. package/dist/adapter/ember/ezsp/enums.d.ts +879 -0
  72. package/dist/adapter/ember/ezsp/enums.d.ts.map +1 -0
  73. package/dist/adapter/ember/ezsp/enums.js +948 -0
  74. package/dist/adapter/ember/ezsp/enums.js.map +1 -0
  75. package/dist/adapter/ember/ezsp/ezsp.d.ts +2664 -0
  76. package/dist/adapter/ember/ezsp/ezsp.d.ts.map +1 -0
  77. package/dist/adapter/ember/ezsp/ezsp.js +6438 -0
  78. package/dist/adapter/ember/ezsp/ezsp.js.map +1 -0
  79. package/dist/adapter/ember/types.d.ts +733 -0
  80. package/dist/adapter/ember/types.d.ts.map +1 -0
  81. package/dist/adapter/ember/types.js +3 -0
  82. package/dist/adapter/ember/types.js.map +1 -0
  83. package/dist/adapter/ember/uart/ash.d.ts +451 -0
  84. package/dist/adapter/ember/uart/ash.d.ts.map +1 -0
  85. package/dist/adapter/ember/uart/ash.js +1584 -0
  86. package/dist/adapter/ember/uart/ash.js.map +1 -0
  87. package/dist/adapter/ember/uart/consts.d.ts +91 -0
  88. package/dist/adapter/ember/uart/consts.d.ts.map +1 -0
  89. package/dist/adapter/ember/uart/consts.js +100 -0
  90. package/dist/adapter/ember/uart/consts.js.map +1 -0
  91. package/dist/adapter/ember/uart/enums.d.ts +191 -0
  92. package/dist/adapter/ember/uart/enums.d.ts.map +1 -0
  93. package/dist/adapter/ember/uart/enums.js +197 -0
  94. package/dist/adapter/ember/uart/enums.js.map +1 -0
  95. package/dist/adapter/ember/uart/parser.d.ts +10 -0
  96. package/dist/adapter/ember/uart/parser.d.ts.map +1 -0
  97. package/dist/adapter/ember/uart/parser.js +41 -0
  98. package/dist/adapter/ember/uart/parser.js.map +1 -0
  99. package/dist/adapter/ember/uart/queues.d.ts +85 -0
  100. package/dist/adapter/ember/uart/queues.d.ts.map +1 -0
  101. package/dist/adapter/ember/uart/queues.js +212 -0
  102. package/dist/adapter/ember/uart/queues.js.map +1 -0
  103. package/dist/adapter/ember/uart/writer.d.ts +15 -0
  104. package/dist/adapter/ember/uart/writer.d.ts.map +1 -0
  105. package/dist/adapter/ember/uart/writer.js +48 -0
  106. package/dist/adapter/ember/uart/writer.js.map +1 -0
  107. package/dist/adapter/ember/utils/initters.d.ts +20 -0
  108. package/dist/adapter/ember/utils/initters.d.ts.map +1 -0
  109. package/dist/adapter/ember/utils/initters.js +58 -0
  110. package/dist/adapter/ember/utils/initters.js.map +1 -0
  111. package/dist/adapter/ember/utils/math.d.ts +51 -0
  112. package/dist/adapter/ember/utils/math.d.ts.map +1 -0
  113. package/dist/adapter/ember/utils/math.js +102 -0
  114. package/dist/adapter/ember/utils/math.js.map +1 -0
  115. package/dist/adapter/ember/zdo.d.ts +921 -0
  116. package/dist/adapter/ember/zdo.d.ts.map +1 -0
  117. package/dist/adapter/ember/zdo.js +723 -0
  118. package/dist/adapter/ember/zdo.js.map +1 -0
  119. package/dist/adapter/events.d.ts +47 -47
  120. package/dist/adapter/events.js +13 -14
  121. package/dist/adapter/events.js.map +1 -1
  122. package/dist/adapter/ezsp/adapter/backup.d.ts +9 -9
  123. package/dist/adapter/ezsp/adapter/backup.d.ts.map +1 -1
  124. package/dist/adapter/ezsp/adapter/backup.js +72 -53
  125. package/dist/adapter/ezsp/adapter/backup.js.map +1 -1
  126. package/dist/adapter/ezsp/adapter/ezspAdapter.d.ts +61 -59
  127. package/dist/adapter/ezsp/adapter/ezspAdapter.d.ts.map +1 -1
  128. package/dist/adapter/ezsp/adapter/ezspAdapter.js +629 -603
  129. package/dist/adapter/ezsp/adapter/ezspAdapter.js.map +1 -1
  130. package/dist/adapter/ezsp/adapter/index.d.ts +2 -2
  131. package/dist/adapter/ezsp/adapter/index.js +10 -10
  132. package/dist/adapter/ezsp/driver/commands.d.ts +36 -36
  133. package/dist/adapter/ezsp/driver/commands.d.ts.map +1 -1
  134. package/dist/adapter/ezsp/driver/commands.js +2388 -2359
  135. package/dist/adapter/ezsp/driver/commands.js.map +1 -1
  136. package/dist/adapter/ezsp/driver/consts.d.ts +10 -10
  137. package/dist/adapter/ezsp/driver/consts.js +13 -13
  138. package/dist/adapter/ezsp/driver/driver.d.ts +106 -103
  139. package/dist/adapter/ezsp/driver/driver.d.ts.map +1 -1
  140. package/dist/adapter/ezsp/driver/driver.js +731 -639
  141. package/dist/adapter/ezsp/driver/driver.js.map +1 -1
  142. package/dist/adapter/ezsp/driver/ezsp.d.ts +105 -96
  143. package/dist/adapter/ezsp/driver/ezsp.d.ts.map +1 -1
  144. package/dist/adapter/ezsp/driver/ezsp.js +651 -586
  145. package/dist/adapter/ezsp/driver/ezsp.js.map +1 -1
  146. package/dist/adapter/ezsp/driver/frame.d.ts +40 -0
  147. package/dist/adapter/ezsp/driver/frame.d.ts.map +1 -0
  148. package/dist/adapter/ezsp/driver/frame.js +101 -0
  149. package/dist/adapter/ezsp/driver/frame.js.map +1 -0
  150. package/dist/adapter/ezsp/driver/index.d.ts +3 -3
  151. package/dist/adapter/ezsp/driver/index.js +8 -8
  152. package/dist/adapter/ezsp/driver/multicast.d.ts +12 -12
  153. package/dist/adapter/ezsp/driver/multicast.d.ts.map +1 -1
  154. package/dist/adapter/ezsp/driver/multicast.js +77 -74
  155. package/dist/adapter/ezsp/driver/multicast.js.map +1 -1
  156. package/dist/adapter/ezsp/driver/parser.d.ts +11 -12
  157. package/dist/adapter/ezsp/driver/parser.d.ts.map +1 -1
  158. package/dist/adapter/ezsp/driver/parser.js +104 -111
  159. package/dist/adapter/ezsp/driver/parser.js.map +1 -1
  160. package/dist/adapter/ezsp/driver/types/basic.d.ts +62 -62
  161. package/dist/adapter/ezsp/driver/types/basic.js +208 -208
  162. package/dist/adapter/ezsp/driver/types/basic.js.map +1 -1
  163. package/dist/adapter/ezsp/driver/types/index.d.ts +9 -9
  164. package/dist/adapter/ezsp/driver/types/index.d.ts.map +1 -1
  165. package/dist/adapter/ezsp/driver/types/index.js +138 -133
  166. package/dist/adapter/ezsp/driver/types/index.js.map +1 -1
  167. package/dist/adapter/ezsp/driver/types/named.d.ts +1287 -697
  168. package/dist/adapter/ezsp/driver/types/named.d.ts.map +1 -1
  169. package/dist/adapter/ezsp/driver/types/named.js +2329 -1726
  170. package/dist/adapter/ezsp/driver/types/named.js.map +1 -1
  171. package/dist/adapter/ezsp/driver/types/struct.d.ts +270 -251
  172. package/dist/adapter/ezsp/driver/types/struct.d.ts.map +1 -1
  173. package/dist/adapter/ezsp/driver/types/struct.js +803 -708
  174. package/dist/adapter/ezsp/driver/types/struct.js.map +1 -1
  175. package/dist/adapter/ezsp/driver/uart.d.ts +48 -44
  176. package/dist/adapter/ezsp/driver/uart.d.ts.map +1 -1
  177. package/dist/adapter/ezsp/driver/uart.js +382 -368
  178. package/dist/adapter/ezsp/driver/uart.js.map +1 -1
  179. package/dist/adapter/ezsp/driver/utils/crc16ccitt.d.ts +2 -2
  180. package/dist/adapter/ezsp/driver/utils/crc16ccitt.js +55 -55
  181. package/dist/adapter/ezsp/driver/utils/crc16ccitt.js.map +1 -1
  182. package/dist/adapter/ezsp/driver/utils/index.d.ts +18 -18
  183. package/dist/adapter/ezsp/driver/utils/index.js +72 -67
  184. package/dist/adapter/ezsp/driver/utils/index.js.map +1 -1
  185. package/dist/adapter/ezsp/driver/writer.d.ts +13 -13
  186. package/dist/adapter/ezsp/driver/writer.d.ts.map +1 -1
  187. package/dist/adapter/ezsp/driver/writer.js +85 -88
  188. package/dist/adapter/ezsp/driver/writer.js.map +1 -1
  189. package/dist/adapter/index.d.ts +4 -4
  190. package/dist/adapter/index.js +35 -35
  191. package/dist/adapter/serialPort.d.ts +10 -8
  192. package/dist/adapter/serialPort.d.ts.map +1 -1
  193. package/dist/adapter/serialPort.js +53 -22
  194. package/dist/adapter/serialPort.js.map +1 -1
  195. package/dist/adapter/serialPortUtils.d.ts +12 -12
  196. package/dist/adapter/serialPortUtils.js +18 -18
  197. package/dist/adapter/serialPortUtils.js.map +1 -1
  198. package/dist/adapter/socketPortUtils.d.ts +10 -10
  199. package/dist/adapter/socketPortUtils.js +16 -16
  200. package/dist/adapter/tstype.d.ts +85 -85
  201. package/dist/adapter/tstype.d.ts.map +1 -1
  202. package/dist/adapter/tstype.js +2 -2
  203. package/dist/adapter/z-stack/adapter/adapter-backup.d.ts +62 -62
  204. package/dist/adapter/z-stack/adapter/adapter-backup.d.ts.map +1 -1
  205. package/dist/adapter/z-stack/adapter/adapter-backup.js +462 -460
  206. package/dist/adapter/z-stack/adapter/adapter-backup.js.map +1 -1
  207. package/dist/adapter/z-stack/adapter/adapter-nv-memory.d.ts +150 -150
  208. package/dist/adapter/z-stack/adapter/adapter-nv-memory.js +258 -258
  209. package/dist/adapter/z-stack/adapter/adapter-nv-memory.js.map +1 -1
  210. package/dist/adapter/z-stack/adapter/endpoints.d.ts +11 -11
  211. package/dist/adapter/z-stack/adapter/endpoints.js +73 -73
  212. package/dist/adapter/z-stack/adapter/index.d.ts +2 -2
  213. package/dist/adapter/z-stack/adapter/index.js +8 -8
  214. package/dist/adapter/z-stack/adapter/manager.d.ts +86 -86
  215. package/dist/adapter/z-stack/adapter/manager.d.ts.map +1 -1
  216. package/dist/adapter/z-stack/adapter/manager.js +482 -476
  217. package/dist/adapter/z-stack/adapter/manager.js.map +1 -1
  218. package/dist/adapter/z-stack/adapter/tstype.d.ts +6 -6
  219. package/dist/adapter/z-stack/adapter/tstype.js +9 -10
  220. package/dist/adapter/z-stack/adapter/tstype.js.map +1 -1
  221. package/dist/adapter/z-stack/adapter/zStackAdapter.d.ts +81 -81
  222. package/dist/adapter/z-stack/adapter/zStackAdapter.d.ts.map +1 -1
  223. package/dist/adapter/z-stack/adapter/zStackAdapter.js +891 -868
  224. package/dist/adapter/z-stack/adapter/zStackAdapter.js.map +1 -1
  225. package/dist/adapter/z-stack/constants/af.d.ts +23 -23
  226. package/dist/adapter/z-stack/constants/af.js +27 -27
  227. package/dist/adapter/z-stack/constants/common.d.ts +278 -278
  228. package/dist/adapter/z-stack/constants/common.d.ts.map +1 -1
  229. package/dist/adapter/z-stack/constants/common.js +292 -289
  230. package/dist/adapter/z-stack/constants/common.js.map +1 -1
  231. package/dist/adapter/z-stack/constants/dbg.d.ts +22 -22
  232. package/dist/adapter/z-stack/constants/dbg.js +24 -24
  233. package/dist/adapter/z-stack/constants/index.d.ts +10 -10
  234. package/dist/adapter/z-stack/constants/index.js +47 -47
  235. package/dist/adapter/z-stack/constants/mac.d.ts +127 -127
  236. package/dist/adapter/z-stack/constants/mac.js +129 -129
  237. package/dist/adapter/z-stack/constants/sapi.d.ts +24 -24
  238. package/dist/adapter/z-stack/constants/sapi.js +26 -26
  239. package/dist/adapter/z-stack/constants/sys.d.ts +71 -71
  240. package/dist/adapter/z-stack/constants/sys.js +73 -73
  241. package/dist/adapter/z-stack/constants/util.d.ts +81 -81
  242. package/dist/adapter/z-stack/constants/util.js +83 -83
  243. package/dist/adapter/z-stack/constants/utils.d.ts +4 -4
  244. package/dist/adapter/z-stack/constants/utils.js +14 -14
  245. package/dist/adapter/z-stack/constants/zdo.d.ts +102 -102
  246. package/dist/adapter/z-stack/constants/zdo.js +104 -104
  247. package/dist/adapter/z-stack/models/index.d.ts +1 -1
  248. package/dist/adapter/z-stack/models/index.js +17 -17
  249. package/dist/adapter/z-stack/models/startup-options.d.ts +12 -12
  250. package/dist/adapter/z-stack/models/startup-options.js +2 -2
  251. package/dist/adapter/z-stack/structs/entries/address-manager-entry.d.ts +23 -23
  252. package/dist/adapter/z-stack/structs/entries/address-manager-entry.js +45 -45
  253. package/dist/adapter/z-stack/structs/entries/address-manager-entry.js.map +1 -1
  254. package/dist/adapter/z-stack/structs/entries/address-manager-table.d.ts +10 -10
  255. package/dist/adapter/z-stack/structs/entries/address-manager-table.js +22 -22
  256. package/dist/adapter/z-stack/structs/entries/aps-link-key-data-entry.d.ts +10 -10
  257. package/dist/adapter/z-stack/structs/entries/aps-link-key-data-entry.js +21 -21
  258. package/dist/adapter/z-stack/structs/entries/aps-link-key-data-table.d.ts +10 -10
  259. package/dist/adapter/z-stack/structs/entries/aps-link-key-data-table.js +23 -23
  260. package/dist/adapter/z-stack/structs/entries/aps-tc-link-key-entry.d.ts +10 -10
  261. package/dist/adapter/z-stack/structs/entries/aps-tc-link-key-entry.js +24 -24
  262. package/dist/adapter/z-stack/structs/entries/aps-tc-link-key-table.d.ts +10 -10
  263. package/dist/adapter/z-stack/structs/entries/aps-tc-link-key-table.js +23 -23
  264. package/dist/adapter/z-stack/structs/entries/channel-list.d.ts +8 -8
  265. package/dist/adapter/z-stack/structs/entries/channel-list.js +15 -15
  266. package/dist/adapter/z-stack/structs/entries/has-configured.d.ts +8 -8
  267. package/dist/adapter/z-stack/structs/entries/has-configured.js +16 -16
  268. package/dist/adapter/z-stack/structs/entries/index.d.ts +16 -16
  269. package/dist/adapter/z-stack/structs/entries/index.js +32 -32
  270. package/dist/adapter/z-stack/structs/entries/nib.d.ts +10 -10
  271. package/dist/adapter/z-stack/structs/entries/nib.js +68 -68
  272. package/dist/adapter/z-stack/structs/entries/nwk-key-descriptor.d.ts +10 -10
  273. package/dist/adapter/z-stack/structs/entries/nwk-key-descriptor.js +18 -18
  274. package/dist/adapter/z-stack/structs/entries/nwk-key.d.ts +8 -8
  275. package/dist/adapter/z-stack/structs/entries/nwk-key.js +15 -15
  276. package/dist/adapter/z-stack/structs/entries/nwk-pan-id.d.ts +8 -8
  277. package/dist/adapter/z-stack/structs/entries/nwk-pan-id.js +15 -15
  278. package/dist/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-entry.d.ts +13 -13
  279. package/dist/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-entry.js +23 -23
  280. package/dist/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-table.d.ts +10 -10
  281. package/dist/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-table.js +22 -22
  282. package/dist/adapter/z-stack/structs/entries/security-manager-entry.d.ts +20 -20
  283. package/dist/adapter/z-stack/structs/entries/security-manager-entry.js +36 -36
  284. package/dist/adapter/z-stack/structs/entries/security-manager-entry.js.map +1 -1
  285. package/dist/adapter/z-stack/structs/entries/security-manager-table.d.ts +10 -10
  286. package/dist/adapter/z-stack/structs/entries/security-manager-table.js +24 -24
  287. package/dist/adapter/z-stack/structs/index.d.ts +4 -4
  288. package/dist/adapter/z-stack/structs/index.js +20 -20
  289. package/dist/adapter/z-stack/structs/serializable-memory-object.d.ts +13 -13
  290. package/dist/adapter/z-stack/structs/serializable-memory-object.js +2 -2
  291. package/dist/adapter/z-stack/structs/struct.d.ts +99 -99
  292. package/dist/adapter/z-stack/structs/struct.js +296 -295
  293. package/dist/adapter/z-stack/structs/struct.js.map +1 -1
  294. package/dist/adapter/z-stack/structs/table.d.ts +94 -94
  295. package/dist/adapter/z-stack/structs/table.js +163 -161
  296. package/dist/adapter/z-stack/structs/table.js.map +1 -1
  297. package/dist/adapter/z-stack/unpi/constants.d.ts +28 -28
  298. package/dist/adapter/z-stack/unpi/constants.js +39 -41
  299. package/dist/adapter/z-stack/unpi/constants.js.map +1 -1
  300. package/dist/adapter/z-stack/unpi/frame.d.ts +16 -16
  301. package/dist/adapter/z-stack/unpi/frame.js +54 -48
  302. package/dist/adapter/z-stack/unpi/frame.js.map +1 -1
  303. package/dist/adapter/z-stack/unpi/index.d.ts +5 -5
  304. package/dist/adapter/z-stack/unpi/index.js +37 -37
  305. package/dist/adapter/z-stack/unpi/parser.d.ts +10 -10
  306. package/dist/adapter/z-stack/unpi/parser.js +75 -74
  307. package/dist/adapter/z-stack/unpi/parser.js.map +1 -1
  308. package/dist/adapter/z-stack/unpi/writer.d.ts +10 -10
  309. package/dist/adapter/z-stack/unpi/writer.js +44 -44
  310. package/dist/adapter/z-stack/utils/channel-list.d.ts +20 -20
  311. package/dist/adapter/z-stack/utils/channel-list.js +40 -40
  312. package/dist/adapter/z-stack/utils/channel-list.js.map +1 -1
  313. package/dist/adapter/z-stack/utils/index.d.ts +2 -2
  314. package/dist/adapter/z-stack/utils/index.js +18 -18
  315. package/dist/adapter/z-stack/utils/network-options.d.ts +8 -8
  316. package/dist/adapter/z-stack/utils/network-options.js +22 -22
  317. package/dist/adapter/z-stack/znp/buffaloZnp.d.ts +11 -11
  318. package/dist/adapter/z-stack/znp/buffaloZnp.js +113 -113
  319. package/dist/adapter/z-stack/znp/buffaloZnp.js.map +1 -1
  320. package/dist/adapter/z-stack/znp/definition.d.ts +5 -5
  321. package/dist/adapter/z-stack/znp/definition.js +3050 -3050
  322. package/dist/adapter/z-stack/znp/index.d.ts +3 -3
  323. package/dist/adapter/z-stack/znp/index.js +10 -10
  324. package/dist/adapter/z-stack/znp/parameterType.d.ts +22 -22
  325. package/dist/adapter/z-stack/znp/parameterType.js +25 -25
  326. package/dist/adapter/z-stack/znp/tstype.d.ts +21 -21
  327. package/dist/adapter/z-stack/znp/tstype.js +2 -2
  328. package/dist/adapter/z-stack/znp/znp.d.ts +44 -43
  329. package/dist/adapter/z-stack/znp/znp.d.ts.map +1 -1
  330. package/dist/adapter/z-stack/znp/znp.js +326 -325
  331. package/dist/adapter/z-stack/znp/znp.js.map +1 -1
  332. package/dist/adapter/z-stack/znp/zpiObject.d.ts +19 -19
  333. package/dist/adapter/z-stack/znp/zpiObject.js +102 -96
  334. package/dist/adapter/z-stack/znp/zpiObject.js.map +1 -1
  335. package/dist/adapter/zigate/adapter/index.d.ts +2 -2
  336. package/dist/adapter/zigate/adapter/index.js +10 -10
  337. package/dist/adapter/zigate/adapter/zigateAdapter.d.ts +70 -69
  338. package/dist/adapter/zigate/adapter/zigateAdapter.d.ts.map +1 -1
  339. package/dist/adapter/zigate/adapter/zigateAdapter.js +689 -678
  340. package/dist/adapter/zigate/adapter/zigateAdapter.js.map +1 -1
  341. package/dist/adapter/zigate/debug.d.ts +7 -7
  342. package/dist/adapter/zigate/debug.d.ts.map +1 -1
  343. package/dist/adapter/zigate/debug.js +19 -22
  344. package/dist/adapter/zigate/debug.js.map +1 -1
  345. package/dist/adapter/zigate/driver/buffaloZiGate.d.ts +18 -18
  346. package/dist/adapter/zigate/driver/buffaloZiGate.js +139 -139
  347. package/dist/adapter/zigate/driver/buffaloZiGate.js.map +1 -1
  348. package/dist/adapter/zigate/driver/commandType.d.ts +41 -41
  349. package/dist/adapter/zigate/driver/commandType.js +385 -385
  350. package/dist/adapter/zigate/driver/commandType.js.map +1 -1
  351. package/dist/adapter/zigate/driver/constants.d.ts +276 -276
  352. package/dist/adapter/zigate/driver/constants.d.ts.map +1 -1
  353. package/dist/adapter/zigate/driver/constants.js +371 -371
  354. package/dist/adapter/zigate/driver/constants.js.map +1 -1
  355. package/dist/adapter/zigate/driver/frame.d.ts +26 -26
  356. package/dist/adapter/zigate/driver/frame.js +172 -172
  357. package/dist/adapter/zigate/driver/frame.js.map +1 -1
  358. package/dist/adapter/zigate/driver/messageType.d.ts +11 -11
  359. package/dist/adapter/zigate/driver/messageType.js +278 -278
  360. package/dist/adapter/zigate/driver/messageType.js.map +1 -1
  361. package/dist/adapter/zigate/driver/parameterType.d.ts +20 -20
  362. package/dist/adapter/zigate/driver/parameterType.js +23 -23
  363. package/dist/adapter/zigate/driver/ziGateObject.d.ts +23 -23
  364. package/dist/adapter/zigate/driver/ziGateObject.js +110 -106
  365. package/dist/adapter/zigate/driver/ziGateObject.js.map +1 -1
  366. package/dist/adapter/zigate/driver/zigate.d.ts +49 -49
  367. package/dist/adapter/zigate/driver/zigate.d.ts.map +1 -1
  368. package/dist/adapter/zigate/driver/zigate.js +296 -303
  369. package/dist/adapter/zigate/driver/zigate.js.map +1 -1
  370. package/dist/buffalo/buffalo.d.ts +50 -50
  371. package/dist/buffalo/buffalo.js +324 -322
  372. package/dist/buffalo/buffalo.js.map +1 -1
  373. package/dist/buffalo/index.d.ts +3 -3
  374. package/dist/buffalo/index.js +33 -33
  375. package/dist/buffalo/tstype.d.ts +8 -8
  376. package/dist/buffalo/tstype.js +2 -2
  377. package/dist/controller/controller.d.ts +113 -113
  378. package/dist/controller/controller.d.ts.map +1 -1
  379. package/dist/controller/controller.js +641 -619
  380. package/dist/controller/controller.js.map +1 -1
  381. package/dist/controller/database.d.ts +18 -18
  382. package/dist/controller/database.js +96 -93
  383. package/dist/controller/database.js.map +1 -1
  384. package/dist/controller/events.d.ts +58 -58
  385. package/dist/controller/events.d.ts.map +1 -1
  386. package/dist/controller/events.js +108 -101
  387. package/dist/controller/events.js.map +1 -1
  388. package/dist/controller/greenPower.d.ts +12 -12
  389. package/dist/controller/greenPower.js +221 -220
  390. package/dist/controller/greenPower.js.map +1 -1
  391. package/dist/controller/helpers/index.d.ts +2 -2
  392. package/dist/controller/helpers/index.js +28 -28
  393. package/dist/controller/helpers/request.d.ts +21 -22
  394. package/dist/controller/helpers/request.d.ts.map +1 -1
  395. package/dist/controller/helpers/request.js +77 -71
  396. package/dist/controller/helpers/request.js.map +1 -1
  397. package/dist/controller/helpers/requestQueue.d.ts +13 -0
  398. package/dist/controller/helpers/requestQueue.d.ts.map +1 -0
  399. package/dist/controller/helpers/requestQueue.js +116 -0
  400. package/dist/controller/helpers/requestQueue.js.map +1 -0
  401. package/dist/controller/helpers/zclFrameConverter.d.ts +7 -7
  402. package/dist/controller/helpers/zclFrameConverter.d.ts.map +1 -1
  403. package/dist/controller/helpers/zclFrameConverter.js +50 -31
  404. package/dist/controller/helpers/zclFrameConverter.js.map +1 -1
  405. package/dist/controller/helpers/zclTransactionSequenceNumber.d.ts +5 -5
  406. package/dist/controller/helpers/zclTransactionSequenceNumber.js +13 -13
  407. package/dist/controller/helpers/zclTransactionSequenceNumber.js.map +1 -1
  408. package/dist/controller/index.d.ts +5 -5
  409. package/dist/controller/index.js +8 -8
  410. package/dist/controller/logger-stub.d.ts +6 -6
  411. package/dist/controller/logger-stub.js +2 -2
  412. package/dist/controller/model/device.d.ts +132 -133
  413. package/dist/controller/model/device.d.ts.map +1 -1
  414. package/dist/controller/model/device.js +724 -717
  415. package/dist/controller/model/device.js.map +1 -1
  416. package/dist/controller/model/endpoint.d.ts +128 -131
  417. package/dist/controller/model/endpoint.d.ts.map +1 -1
  418. package/dist/controller/model/endpoint.js +755 -816
  419. package/dist/controller/model/endpoint.js.map +1 -1
  420. package/dist/controller/model/entity.d.ts +14 -14
  421. package/dist/controller/model/entity.js +26 -26
  422. package/dist/controller/model/entity.js.map +1 -1
  423. package/dist/controller/model/group.d.ts +38 -38
  424. package/dist/controller/model/group.d.ts.map +1 -1
  425. package/dist/controller/model/group.js +225 -221
  426. package/dist/controller/model/group.js.map +1 -1
  427. package/dist/controller/model/index.d.ts +5 -5
  428. package/dist/controller/model/index.js +14 -14
  429. package/dist/controller/touchlink.d.ts +19 -19
  430. package/dist/controller/touchlink.js +159 -157
  431. package/dist/controller/touchlink.js.map +1 -1
  432. package/dist/controller/tstype.d.ts +20 -21
  433. package/dist/controller/tstype.d.ts.map +1 -1
  434. package/dist/controller/tstype.js +8 -9
  435. package/dist/controller/tstype.js.map +1 -1
  436. package/dist/index.d.ts +3 -3
  437. package/dist/index.js +33 -33
  438. package/dist/models/backup-storage-legacy.d.ts +26 -26
  439. package/dist/models/backup-storage-legacy.js +2 -2
  440. package/dist/models/backup-storage-unified.d.ts +49 -49
  441. package/dist/models/backup-storage-unified.js +2 -2
  442. package/dist/models/backup.d.ts +37 -37
  443. package/dist/models/backup.js +2 -2
  444. package/dist/models/index.d.ts +4 -4
  445. package/dist/models/index.js +20 -20
  446. package/dist/models/network-options.d.ts +12 -12
  447. package/dist/models/network-options.js +2 -2
  448. package/dist/utils/assertString.d.ts +2 -2
  449. package/dist/utils/assertString.js +8 -8
  450. package/dist/utils/assertString.js.map +1 -1
  451. package/dist/utils/backup.d.ts +20 -20
  452. package/dist/utils/backup.d.ts.map +1 -1
  453. package/dist/utils/backup.js +189 -187
  454. package/dist/utils/backup.js.map +1 -1
  455. package/dist/utils/equalsPartial.d.ts +2 -2
  456. package/dist/utils/equalsPartial.js +11 -11
  457. package/dist/utils/index.d.ts +9 -9
  458. package/dist/utils/index.js +45 -45
  459. package/dist/utils/isNumberArray.d.ts +2 -2
  460. package/dist/utils/isNumberArray.js +6 -6
  461. package/dist/utils/queue.d.ts +11 -11
  462. package/dist/utils/queue.d.ts.map +1 -1
  463. package/dist/utils/queue.js +61 -50
  464. package/dist/utils/queue.js.map +1 -1
  465. package/dist/utils/realpathSync.d.ts +2 -2
  466. package/dist/utils/realpathSync.js +12 -12
  467. package/dist/utils/wait.d.ts +2 -2
  468. package/dist/utils/wait.js +8 -8
  469. package/dist/utils/waitress.d.ts +21 -21
  470. package/dist/utils/waitress.d.ts.map +1 -1
  471. package/dist/utils/waitress.js +68 -61
  472. package/dist/utils/waitress.js.map +1 -1
  473. package/dist/zcl/buffaloZcl.d.ts +41 -41
  474. package/dist/zcl/buffaloZcl.d.ts.map +1 -1
  475. package/dist/zcl/buffaloZcl.js +594 -591
  476. package/dist/zcl/buffaloZcl.js.map +1 -1
  477. package/dist/zcl/definition/buffaloZclDataType.d.ts +17 -17
  478. package/dist/zcl/definition/buffaloZclDataType.js +20 -20
  479. package/dist/zcl/definition/cluster.d.ts +29 -29
  480. package/dist/zcl/definition/cluster.d.ts.map +1 -1
  481. package/dist/zcl/definition/cluster.js +5520 -5335
  482. package/dist/zcl/definition/cluster.js.map +1 -1
  483. package/dist/zcl/definition/dataType.d.ts +59 -59
  484. package/dist/zcl/definition/dataType.js +64 -64
  485. package/dist/zcl/definition/direction.d.ts +5 -5
  486. package/dist/zcl/definition/direction.js +8 -8
  487. package/dist/zcl/definition/endpointDeviceType.d.ts +4 -4
  488. package/dist/zcl/definition/endpointDeviceType.js +15 -15
  489. package/dist/zcl/definition/foundation.d.ts +11 -11
  490. package/dist/zcl/definition/foundation.js +167 -167
  491. package/dist/zcl/definition/frameControl.d.ts +10 -10
  492. package/dist/zcl/definition/frameControl.js +2 -2
  493. package/dist/zcl/definition/frameType.d.ts +5 -5
  494. package/dist/zcl/definition/frameType.js +8 -8
  495. package/dist/zcl/definition/index.d.ts +13 -13
  496. package/dist/zcl/definition/index.js +51 -51
  497. package/dist/zcl/definition/manufacturerCode.d.ts +1077 -1074
  498. package/dist/zcl/definition/manufacturerCode.d.ts.map +1 -1
  499. package/dist/zcl/definition/manufacturerCode.js +1082 -1079
  500. package/dist/zcl/definition/manufacturerCode.js.map +1 -1
  501. package/dist/zcl/definition/powerSource.d.ts +4 -4
  502. package/dist/zcl/definition/powerSource.js +12 -12
  503. package/dist/zcl/definition/status.d.ts +38 -38
  504. package/dist/zcl/definition/status.js +41 -41
  505. package/dist/zcl/definition/tstype.d.ts +16 -16
  506. package/dist/zcl/definition/tstype.js +2 -2
  507. package/dist/zcl/index.d.ts +16 -15
  508. package/dist/zcl/index.d.ts.map +1 -1
  509. package/dist/zcl/index.js +55 -55
  510. package/dist/zcl/index.js.map +1 -1
  511. package/dist/zcl/tstype.d.ts +56 -56
  512. package/dist/zcl/tstype.js +9 -10
  513. package/dist/zcl/tstype.js.map +1 -1
  514. package/dist/zcl/utils.d.ts +6 -6
  515. package/dist/zcl/utils.js +164 -165
  516. package/dist/zcl/utils.js.map +1 -1
  517. package/dist/zcl/zclFrame.d.ts +40 -45
  518. package/dist/zcl/zclFrame.d.ts.map +1 -1
  519. package/dist/zcl/zclFrame.js +351 -347
  520. package/dist/zcl/zclFrame.js.map +1 -1
  521. package/dist/zcl/zclHeader.d.ts +9 -0
  522. package/dist/zcl/zclHeader.d.ts.map +1 -0
  523. package/dist/zcl/zclHeader.js +3 -0
  524. package/dist/zcl/zclHeader.js.map +1 -0
  525. package/dist/zcl/zclStatusError.d.ts +5 -5
  526. package/dist/zcl/zclStatusError.js +14 -13
  527. package/dist/zcl/zclStatusError.js.map +1 -1
  528. package/package.json +11 -11
  529. package/release-please-config.json +1 -5
  530. package/tsconfig.json +4 -2
@@ -1,477 +1,483 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
25
- var __importDefault = (this && this.__importDefault) || function (mod) {
26
- return (mod && mod.__esModule) ? mod : { "default": mod };
27
- };
28
- Object.defineProperty(exports, "__esModule", { value: true });
29
- exports.ZnpAdapterManager = void 0;
30
- const debug_1 = __importDefault(require("debug"));
31
- const tstype_1 = require("./tstype");
32
- const common_1 = require("../constants/common");
33
- const Structs = __importStar(require("../structs"));
34
- const Utils = __importStar(require("../utils"));
35
- const ZnpConstants = __importStar(require("../constants"));
36
- const adapter_backup_1 = require("./adapter-backup");
37
- const adapter_nv_memory_1 = require("./adapter-nv-memory");
38
- const constants_1 = require("../unpi/constants");
39
- const UnpiConstants = __importStar(require("../unpi/constants"));
40
- const crypto = __importStar(require("crypto"));
41
- const utils_1 = require("../../../utils");
42
- const endpoints_1 = require("./endpoints");
43
- /**
44
- * ZNP Adapter Manager is responsible for handling adapter startup, network commissioning,
45
- * configuration backup and restore.
46
- */
47
- class ZnpAdapterManager {
48
- constructor(znp, options, logger) {
49
- this.debug = {
50
- startup: (0, debug_1.default)("zigbee-herdsman:adapter:zStack:startup"),
51
- strategy: (0, debug_1.default)("zigbee-herdsman:adapter:zStack:startup:strategy"),
52
- commissioning: (0, debug_1.default)("zigbee-herdsman:adapter:zStack:startup:commissioning")
53
- };
54
- this.znp = znp;
55
- this.options = options;
56
- this.nv = new adapter_nv_memory_1.AdapterNvMemory(this.znp);
57
- this.backup = new adapter_backup_1.AdapterBackup(this.znp, this.nv, this.options.backupPath);
58
- this.logger = logger;
59
- }
60
- /**
61
- * Performs ZNP adapter startup. After this method returns the adapter is configured, endpoints are registered
62
- * and network is ready to process frames.
63
- */
64
- async start() {
65
- this.debug.startup(`beginning znp startup`);
66
- this.nwkOptions = await this.parseConfigNetworkOptions(this.options.networkOptions);
67
- await this.nv.init();
68
- /* determine startup strategy */
69
- const strategy = await this.determineStrategy();
70
- this.debug.startup(`determined startup strategy: ${strategy}`);
71
- /* perform coordinator startup based on determined strategy */
72
- let result;
73
- switch (strategy) {
74
- case "startup": {
75
- await this.beginStartup();
76
- result = "resumed";
77
- break;
78
- }
79
- case "restoreBackup": {
80
- if (this.options.version === tstype_1.ZnpVersion.zStack12) {
81
- this.debug.startup(`performing recommissioning instead of restore for z-stack 1.2`);
82
- await this.beginCommissioning(this.nwkOptions);
83
- await this.beginStartup();
84
- }
85
- else {
86
- await this.beginRestore();
87
- }
88
- result = "restored";
89
- break;
90
- }
91
- case "startCommissioning": {
92
- if (this.options.version === tstype_1.ZnpVersion.zStack12) {
93
- const hasConfigured = await this.nv.readItem(common_1.NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK1, 0, Structs.hasConfigured);
94
- await this.beginCommissioning(this.nwkOptions);
95
- await this.beginStartup();
96
- result = hasConfigured && hasConfigured.isConfigured() ? "reset" : "restored";
97
- }
98
- else {
99
- await this.beginCommissioning(this.nwkOptions);
100
- result = "reset";
101
- }
102
- break;
103
- }
104
- }
105
- /* register endpoints */
106
- await this.registerEndpoints();
107
- /* add green power group */
108
- await this.addToGroup(242, this.options.greenPowerGroup);
109
- return result;
110
- }
111
- /**
112
- * Internal function to determine startup strategy. The strategy determination flow is described in
113
- * [this GitHub issue comment](https://github.com/Koenkk/zigbee-herdsman/issues/286#issuecomment-761029689).
114
- */
115
- async determineStrategy() {
116
- this.debug.strategy("determining znp startup strategy");
117
- /* acquire data from adapter */
118
- const hasConfiguredNvId = this.options.version === tstype_1.ZnpVersion.zStack12 ? common_1.NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK1 : common_1.NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK3;
119
- const hasConfigured = await this.nv.readItem(hasConfiguredNvId, 0, Structs.hasConfigured);
120
- const nib = await this.nv.readItem(common_1.NvItemsIds.NIB, 0, Structs.nib);
121
- const preconfiguredKey = this.options.version === tstype_1.ZnpVersion.zStack12 ?
122
- Structs.nwkKey((await this.znp.request(constants_1.Subsystem.SAPI, "readConfiguration", { configid: common_1.NvItemsIds.PRECFGKEY })).payload.value) :
123
- await this.nv.readItem(common_1.NvItemsIds.PRECFGKEY, 0, Structs.nwkKey);
124
- let activeKeyInfo = await this.nv.readItem(common_1.NvItemsIds.NWK_ACTIVE_KEY_INFO, 0, Structs.nwkKeyDescriptor);
125
- let alternateKeyInfo = await this.nv.readItem(common_1.NvItemsIds.NWK_ALTERN_KEY_INFO, 0, Structs.nwkKeyDescriptor);
126
- /* Z-Stack 1.2 does not provide key info entries */
127
- if (this.options.version === tstype_1.ZnpVersion.zStack12) {
128
- activeKeyInfo = Structs.nwkKeyDescriptor();
129
- activeKeyInfo.key = Buffer.from(preconfiguredKey.key);
130
- alternateKeyInfo = Structs.nwkKeyDescriptor();
131
- alternateKeyInfo.key = Buffer.from(preconfiguredKey.key);
132
- }
133
- /* get backup if available and supported by target */
134
- const backup = await this.backup.getStoredBackup();
135
- /* special treatment for incorrectly reversed Extended PAN IDs from previous releases */
136
- const isExtendedPanIdReversed = nib && this.nwkOptions.extendedPanId.equals(Buffer.from(nib.extendedPANID).reverse());
137
- /* istanbul ignore next */
138
- const configMatchesAdapter = (nib &&
139
- Utils.compareChannelLists(this.nwkOptions.channelList, nib.channelList) &&
140
- this.nwkOptions.panId === nib.nwkPanId &&
141
- (this.nwkOptions.extendedPanId.equals(nib.extendedPANID) ||
142
- /* exception for migration from previous code-base */
143
- isExtendedPanIdReversed ||
144
- /* exception for some adapters which may actually use 0xdddddddddddddddd as EPID (backward compatibility) */
145
- this.nwkOptions.hasDefaultExtendedPanId) &&
146
- this.nwkOptions.networkKey.equals(preconfiguredKey.key) &&
147
- this.nwkOptions.networkKey.equals(activeKeyInfo.key) &&
148
- this.nwkOptions.networkKey.equals(alternateKeyInfo.key));
149
- const backupMatchesAdapter = (backup &&
150
- nib &&
151
- backup.networkOptions.panId === nib.nwkPanId &&
152
- backup.networkOptions.extendedPanId.equals(nib.extendedPANID) &&
153
- Utils.compareChannelLists(backup.networkOptions.channelList, nib.channelList) &&
154
- backup.networkOptions.networkKey.equals(activeKeyInfo.key));
155
- const configMatchesBackup = (backup &&
156
- Utils.compareNetworkOptions(this.nwkOptions, backup.networkOptions, true));
157
- const checkRestoreVersionCompatibility = () => {
158
- var _a;
159
- if (this.options.version === tstype_1.ZnpVersion.zStack12 && backup && ((_a = backup.znp) === null || _a === void 0 ? void 0 : _a.version) !== undefined && backup.znp.version !== tstype_1.ZnpVersion.zStack12) {
160
- throw new Error(`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`);
161
- }
162
- };
163
- /* Determine startup strategy */
164
- if (!hasConfigured || !hasConfigured.isConfigured() || !nib) {
165
- /* Adapter is not configured or not commissioned */
166
- this.debug.strategy("(stage-1) adapter is not configured / not commissioned");
167
- if (configMatchesBackup) {
168
- /* Adapter backup is available and matches configuration */
169
- this.debug.strategy("(stage-2) configuration matches backup");
170
- checkRestoreVersionCompatibility();
171
- return "restoreBackup";
172
- }
173
- else {
174
- /* Adapter backup is either not available or does not match configuration */
175
- if (!backup) {
176
- this.debug.strategy("(stage-2) adapter backup does not exist");
177
- }
178
- else {
179
- this.debug.strategy("(stage-2) configuration does not match backup");
180
- }
181
- return "startCommissioning";
182
- }
183
- }
184
- else {
185
- /* Adapter is configured and commissioned */
186
- this.debug.strategy("(stage-1) adapter is configured");
187
- if (configMatchesAdapter) {
188
- /* Warn if EPID is reversed (backward-compat) */
189
- if (isExtendedPanIdReversed) {
190
- this.debug.strategy("(stage-2) extended pan id is reversed");
191
- this.logger.warn(`Extended PAN ID is reversed (expected=${this.nwkOptions.extendedPanId.toString("hex")}, actual=${nib.extendedPANID.toString("hex")})`);
192
- }
193
- /* Configuration matches adapter state - regular startup */
194
- this.debug.strategy("(stage-2) adapter state matches configuration");
195
- return "startup";
196
- }
197
- else {
198
- /* Configuration does not match adapter state */
199
- this.debug.strategy("(stage-2) adapter state does not match configuration");
200
- if (backup) {
201
- /* Backup is present */
202
- this.debug.strategy("(stage-3) got adapter backup");
203
- if (backupMatchesAdapter) {
204
- /* Backup matches adapter state */
205
- this.debug.strategy("(stage-4) adapter state matches backup");
206
- this.logger.error(`Configuration is not consistent with adapter state/backup!`);
207
- this.logger.error(`- PAN ID: configured=${this.nwkOptions.panId}, adapter=${nib.nwkPanId}`);
208
- this.logger.error(`- Extended PAN ID: configured=${this.nwkOptions.extendedPanId.toString("hex")}, adapter=${nib.extendedPANID.toString("hex")}`);
209
- this.logger.error(`- Network Key: configured=${this.nwkOptions.networkKey.toString("hex")}, adapter=${activeKeyInfo.key.toString("hex")}`);
210
- this.logger.error(`- Channel List: configured=${this.nwkOptions.channelList.toString()}, adapter=${Utils.unpackChannelList(nib.channelList).toString()}`);
211
- this.logger.error(`Please update configuration to prevent further issues.`);
212
- this.logger.error(`If you wish to re-commission your network, please remove coordinator backup at ${this.options.backupPath}.`);
213
- this.logger.error(`Re-commissioning your network will require re-pairing of all devices!`);
214
- if (this.options.adapterOptions.forceStartWithInconsistentAdapterConfiguration) {
215
- this.logger.error(`Running despite adapter configuration mismatch as configured. Please update the adapter to compatible firmware and recreate your network as soon as possible.`);
216
- return "startup";
217
- }
218
- else {
219
- throw new Error("startup failed - configuration-adapter mismatch - see logs above for more information");
220
- }
221
- }
222
- else {
223
- /* Backup does not match adapter state */
224
- this.debug.strategy("(stage-4) adapter state does not match backup");
225
- if (configMatchesBackup) {
226
- /* Adapter backup matches configuration */
227
- this.debug.strategy("(stage-5) adapter backup matches configuration");
228
- checkRestoreVersionCompatibility();
229
- return "restoreBackup";
230
- }
231
- else {
232
- /* Adapter backup does not match configuration */
233
- this.debug.strategy("(stage-5) adapter backup does not match configuration");
234
- return "startCommissioning";
235
- }
236
- }
237
- }
238
- else {
239
- /* Configuration mismatches adapter and no backup is available */
240
- this.debug.strategy("(stage-3) configuration-adapter mismatch (no backup)");
241
- return "startCommissioning";
242
- }
243
- }
244
- }
245
- }
246
- /**
247
- * Internal method to perform regular adapter startup in coordinator mode.
248
- */
249
- async beginStartup() {
250
- const deviceInfo = await this.znp.request(constants_1.Subsystem.UTIL, 'getDeviceInfo', {});
251
- if (deviceInfo.payload.devicestate !== common_1.DevStates.ZB_COORD) {
252
- this.debug.startup("starting adapter as coordinator");
253
- const started = this.znp.waitFor(UnpiConstants.Type.AREQ, constants_1.Subsystem.ZDO, 'stateChangeInd', { state: 9 }, 60000);
254
- await this.znp.request(constants_1.Subsystem.ZDO, 'startupFromApp', { startdelay: 100 }, null, null, [common_1.ZnpCommandStatus.SUCCESS, common_1.ZnpCommandStatus.FAILURE]);
255
- await started.start().promise;
256
- this.debug.startup("adapter successfully started in coordinator mode");
257
- }
258
- else {
259
- this.debug.startup("adapter is already running in coordinator mode");
260
- }
261
- }
262
- /**
263
- * Internal method to perform adapter restore.
264
- */
265
- async beginRestore() {
266
- const backup = await this.backup.getStoredBackup();
267
- /* istanbul ignore next */
268
- if (!backup) {
269
- throw Error("Cannot restore backup - none is available");
270
- }
271
- /* generate random provisioning network parameters */
272
- const provisioningNwkOptions = {
273
- panId: 1 + Math.round(Math.random() * 65532),
274
- extendedPanId: crypto.randomBytes(8),
275
- channelList: [11 + Math.round((Math.random() * (26 - 11)))],
276
- networkKey: crypto.randomBytes(16),
277
- networkKeyDistribute: false
278
- };
279
- /* commission provisioning network */
280
- this.debug.commissioning("commissioning random provisioning network:");
281
- this.debug.commissioning(` - panId: ${provisioningNwkOptions.panId}`);
282
- this.debug.commissioning(` - extendedPanId: ${provisioningNwkOptions.extendedPanId.toString("hex")}`);
283
- this.debug.commissioning(` - channelList: ${provisioningNwkOptions.channelList.join(", ")}`);
284
- this.debug.commissioning(` - networkKey: ${provisioningNwkOptions.networkKey.toString("hex")}`);
285
- this.debug.commissioning(` - networkKeyDistribute: ${provisioningNwkOptions.networkKeyDistribute}`);
286
- await this.beginCommissioning(provisioningNwkOptions, false, false);
287
- /* perform NV restore */
288
- await this.backup.restoreBackup(backup);
289
- /* update commissioning NV items with desired nwk configuration */
290
- await this.updateCommissioningNvItems(this.nwkOptions);
291
- /* settle & reset adapter */
292
- this.debug.commissioning("giving adapter some time to settle");
293
- await (0, utils_1.Wait)(1000);
294
- await this.resetAdapter();
295
- /* startup with restored adapter */
296
- await this.beginStartup();
297
- /* write configuration flag */
298
- await this.writeConfigurationFlag();
299
- }
300
- /**
301
- * Internal method to perform new network commissioning. Network commissioning creates a new ZigBee
302
- * network using the adapter.
303
- *
304
- * @param nwkOptions Options to configure the new network with.
305
- * @param failOnCollision Whether process should throw an error if PAN ID collision is detected.
306
- * @param writeConfiguredFlag Whether zigbee-herdsman `hasConfigured` flag should be written to NV.
307
- */
308
- async beginCommissioning(nwkOptions, failOnCollision = true, writeConfiguredFlag = true) {
309
- if (nwkOptions.panId === 65535) {
310
- throw new Error(`network commissioning failed - cannot use pan id 65535`);
311
- }
312
- /* clear and reset the adapter */
313
- await this.nv.deleteItem(common_1.NvItemsIds.NIB);
314
- await this.clearAdapter();
315
- /* commission the network as per parameters */
316
- await this.updateCommissioningNvItems(nwkOptions);
317
- this.debug.commissioning("beginning network commissioning");
318
- if ([tstype_1.ZnpVersion.zStack30x, tstype_1.ZnpVersion.zStack3x0].includes(this.options.version)) {
319
- /* configure channel */
320
- await this.znp.request(constants_1.Subsystem.APP_CNF, "bdbSetChannel", { isPrimary: 0x1, channel: Utils.packChannelList(nwkOptions.channelList) });
321
- await this.znp.request(constants_1.Subsystem.APP_CNF, "bdbSetChannel", { isPrimary: 0x0, channel: 0x0 });
322
- /* perform bdb commissioning */
323
- const started = this.znp.waitFor(UnpiConstants.Type.AREQ, constants_1.Subsystem.ZDO, "stateChangeInd", { state: 9 }, 60000);
324
- await this.znp.request(constants_1.Subsystem.APP_CNF, 'bdbStartCommissioning', { mode: 0x04 });
325
- try {
326
- await started.start().promise;
327
- }
328
- catch (error) {
329
- throw new Error(`network commissioning timed out - most likely network with the same panId or extendedPanId already exists nearby`);
330
- }
331
- }
332
- else {
333
- /* Z-Stack 1.2 requires startup to be performed instead of BDB commissioning */
334
- await this.beginStartup();
335
- }
336
- /* wait for NIB to settle (takes different amount of time of different platforms */
337
- this.debug.commissioning("waiting for NIB to settle");
338
- let reads = 0;
339
- let nib = null;
340
- do {
341
- await (0, utils_1.Wait)(3000);
342
- nib = await this.nv.readItem(common_1.NvItemsIds.NIB, 0, Structs.nib);
343
- reads++;
344
- } while ((!nib || nib.nwkPanId === 65535 || nib.nwkLogicalChannel === 0) && reads < 10);
345
- if (!nib || nib.nwkPanId === 65535 || nib.nwkLogicalChannel === 0) {
346
- throw new Error(`network commissioning failed - timed out waiting for nib to settle`);
347
- }
348
- /* validate provisioned PAN ID */
349
- const extNwkInfo = await this.znp.request(constants_1.Subsystem.ZDO, 'extNwkInfo', {});
350
- if (extNwkInfo.payload.panid !== nwkOptions.panId && failOnCollision) {
351
- throw new Error(`network commissioning failed - panId collision detected (expected=${nwkOptions.panId}, actual=${extNwkInfo.payload.panid})`);
352
- }
353
- this.debug.commissioning("network commissioned");
354
- /* write configuration flag */
355
- if (writeConfiguredFlag) {
356
- await this.writeConfigurationFlag();
357
- }
358
- }
359
- /**
360
- * Updates commissioning NV memory parameters in connected controller. This method should be invoked
361
- * to configure network commissioning parameters or update the controller after restore.
362
- *
363
- * @param options Network options to set in NV memory.
364
- */
365
- async updateCommissioningNvItems(options) {
366
- const nwkPanId = Structs.nwkPanId();
367
- nwkPanId.panId = options.panId;
368
- const channelList = Structs.channelList();
369
- channelList.channelList = Utils.packChannelList(options.channelList);
370
- const extendedPanIdReversed = Buffer.from(options.extendedPanId).reverse();
371
- this.debug.commissioning(`setting network commissioning parameters`);
372
- await this.nv.updateItem(common_1.NvItemsIds.STARTUP_OPTION, Buffer.from([0x00]));
373
- await this.nv.updateItem(common_1.NvItemsIds.LOGICAL_TYPE, Buffer.from([ZnpConstants.ZDO.deviceLogicalType.COORDINATOR]));
374
- await this.nv.updateItem(common_1.NvItemsIds.ZDO_DIRECT_CB, Buffer.from([0x01]));
375
- await this.nv.updateItem(common_1.NvItemsIds.CHANLIST, channelList.serialize());
376
- await this.nv.updateItem(common_1.NvItemsIds.PANID, nwkPanId.serialize());
377
- await this.nv.updateItem(common_1.NvItemsIds.EXTENDED_PAN_ID, extendedPanIdReversed);
378
- await this.nv.updateItem(common_1.NvItemsIds.APS_USE_EXT_PANID, extendedPanIdReversed);
379
- /* istanbul ignore next */
380
- await this.nv.updateItem(common_1.NvItemsIds.PRECFGKEYS_ENABLE, Buffer.from([options.networkKeyDistribute ? 0x01 : 0x00]));
381
- if ([tstype_1.ZnpVersion.zStack30x, tstype_1.ZnpVersion.zStack3x0].includes(this.options.version)) {
382
- await this.nv.updateItem(common_1.NvItemsIds.PRECFGKEY, options.networkKey);
383
- }
384
- else {
385
- await this.znp.request(constants_1.Subsystem.SAPI, "writeConfiguration", {
386
- configid: common_1.NvItemsIds.PRECFGKEY,
387
- len: options.networkKey.length,
388
- value: options.networkKey
389
- });
390
- await this.nv.writeItem(common_1.NvItemsIds.LEGACY_TCLK_TABLE_START_12, Buffer.from([
391
- 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x5a, 0x69, 0x67, 0x42, 0x65, 0x65, 0x41, 0x6c,
392
- 0x6c, 0x69, 0x61, 0x6e, 0x63, 0x65, 0x30, 0x39, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
393
- ]));
394
- }
395
- }
396
- /**
397
- * Registers endpoints before beginning normal operation.
398
- */
399
- async registerEndpoints() {
400
- const activeEpResponse = this.znp.waitFor(UnpiConstants.Type.AREQ, constants_1.Subsystem.ZDO, 'activeEpRsp');
401
- this.znp.request(constants_1.Subsystem.ZDO, 'activeEpReq', { dstaddr: 0, nwkaddrofinterest: 0 });
402
- const activeEp = await activeEpResponse.start().promise;
403
- for (const endpoint of endpoints_1.Endpoints) {
404
- if (activeEp.payload.activeeplist.includes(endpoint.endpoint)) {
405
- this.debug.startup(`endpoint '${endpoint.endpoint}' already registered`);
406
- }
407
- else {
408
- this.debug.startup(`registering endpoint '${endpoint.endpoint}'`);
409
- await this.znp.request(constants_1.Subsystem.AF, 'register', endpoint);
410
- }
411
- }
412
- }
413
- /**
414
- * Adds endpoint to group.
415
- *
416
- * @param endpoint Endpoint index to add.
417
- * @param group Target group index.
418
- */
419
- async addToGroup(endpoint, group) {
420
- const result = await this.znp.request(5, 'extFindGroup', { endpoint, groupid: group }, null, null, [common_1.ZnpCommandStatus.SUCCESS, common_1.ZnpCommandStatus.FAILURE]);
421
- if (result.payload.status === common_1.ZnpCommandStatus.FAILURE) {
422
- await this.znp.request(5, 'extAddGroup', { endpoint, groupid: group, namelen: 0, groupname: [] });
423
- }
424
- }
425
- /**
426
- * Internal method to reset the adapter.
427
- */
428
- async resetAdapter() {
429
- this.debug.startup("adapter reset requested");
430
- await this.znp.request(constants_1.Subsystem.SYS, 'resetReq', { type: ZnpConstants.SYS.resetType.SOFT });
431
- this.debug.startup("adapter reset successful");
432
- }
433
- /**
434
- * Internal method to reset adapter config and data.
435
- */
436
- async clearAdapter() {
437
- this.debug.startup("clearing adapter using startup option 3");
438
- await this.nv.writeItem(common_1.NvItemsIds.STARTUP_OPTION, Buffer.from([0x03]));
439
- await this.resetAdapter();
440
- await this.nv.writeItem(common_1.NvItemsIds.STARTUP_OPTION, Buffer.from([0x00]));
441
- }
442
- /**
443
- * Transforms Z2M number-based network options to local Buffer-based options.
444
- *
445
- * This function also takes care of `dd:dd:dd:dd:dd:dd:dd:dd` extended PAN ID
446
- * and replaces it with adapter IEEE address.
447
- *
448
- * @param options Source Z2M network options.
449
- */
450
- async parseConfigNetworkOptions(options) {
451
- const channelList = options.channelList;
452
- /* istanbul ignore next */
453
- channelList.sort((c1, c2) => c1 < c2 ? -1 : c1 > c2 ? 1 : 0);
454
- const parsed = {
455
- channelList: channelList,
456
- panId: options.panID,
457
- extendedPanId: Buffer.from(options.extendedPanID),
458
- networkKey: Buffer.from(options.networkKey),
459
- networkKeyDistribute: options.networkKeyDistribute
460
- };
461
- if (parsed.extendedPanId.equals(Buffer.alloc(8, 0xdd))) {
462
- const adapterIeeeAddressResponse = await this.znp.request(constants_1.Subsystem.SYS, "getExtAddr", {});
463
- parsed.extendedPanId = Buffer.from(adapterIeeeAddressResponse.payload.extaddress.split("0x")[1], "hex");
464
- parsed.hasDefaultExtendedPanId = true;
465
- }
466
- return parsed;
467
- }
468
- /**
469
- * Writes ZNP `hasConfigured` flag to NV memory. This flag indicates the adapter has been configured.
470
- */
471
- async writeConfigurationFlag() {
472
- this.debug.commissioning("writing configuration flag to adapter NV memory");
473
- await this.nv.writeItem(this.options.version === tstype_1.ZnpVersion.zStack12 ? common_1.NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK1 : common_1.NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK3, Buffer.from([0x55]));
474
- }
475
- }
476
- exports.ZnpAdapterManager = ZnpAdapterManager;
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || function (mod) {
19
+ if (mod && mod.__esModule) return mod;
20
+ var result = {};
21
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
+ __setModuleDefault(result, mod);
23
+ return result;
24
+ };
25
+ var __importDefault = (this && this.__importDefault) || function (mod) {
26
+ return (mod && mod.__esModule) ? mod : { "default": mod };
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.ZnpAdapterManager = void 0;
30
+ const debug_1 = __importDefault(require("debug"));
31
+ const tstype_1 = require("./tstype");
32
+ const common_1 = require("../constants/common");
33
+ const Structs = __importStar(require("../structs"));
34
+ const Utils = __importStar(require("../utils"));
35
+ const ZnpConstants = __importStar(require("../constants"));
36
+ const adapter_backup_1 = require("./adapter-backup");
37
+ const adapter_nv_memory_1 = require("./adapter-nv-memory");
38
+ const constants_1 = require("../unpi/constants");
39
+ const UnpiConstants = __importStar(require("../unpi/constants"));
40
+ const crypto = __importStar(require("crypto"));
41
+ const utils_1 = require("../../../utils");
42
+ const endpoints_1 = require("./endpoints");
43
+ /**
44
+ * ZNP Adapter Manager is responsible for handling adapter startup, network commissioning,
45
+ * configuration backup and restore.
46
+ */
47
+ class ZnpAdapterManager {
48
+ nv;
49
+ backup;
50
+ znp;
51
+ options;
52
+ nwkOptions;
53
+ logger;
54
+ debug = {
55
+ startup: (0, debug_1.default)("zigbee-herdsman:adapter:zStack:startup"),
56
+ strategy: (0, debug_1.default)("zigbee-herdsman:adapter:zStack:startup:strategy"),
57
+ commissioning: (0, debug_1.default)("zigbee-herdsman:adapter:zStack:startup:commissioning")
58
+ };
59
+ constructor(znp, options, logger) {
60
+ this.znp = znp;
61
+ this.options = options;
62
+ this.nv = new adapter_nv_memory_1.AdapterNvMemory(this.znp);
63
+ this.backup = new adapter_backup_1.AdapterBackup(this.znp, this.nv, this.options.backupPath);
64
+ this.logger = logger;
65
+ }
66
+ /**
67
+ * Performs ZNP adapter startup. After this method returns the adapter is configured, endpoints are registered
68
+ * and network is ready to process frames.
69
+ */
70
+ async start() {
71
+ this.debug.startup(`beginning znp startup`);
72
+ this.nwkOptions = await this.parseConfigNetworkOptions(this.options.networkOptions);
73
+ await this.nv.init();
74
+ /* determine startup strategy */
75
+ const strategy = await this.determineStrategy();
76
+ this.debug.startup(`determined startup strategy: ${strategy}`);
77
+ /* perform coordinator startup based on determined strategy */
78
+ let result;
79
+ switch (strategy) {
80
+ case "startup": {
81
+ await this.beginStartup();
82
+ result = "resumed";
83
+ break;
84
+ }
85
+ case "restoreBackup": {
86
+ if (this.options.version === tstype_1.ZnpVersion.zStack12) {
87
+ this.debug.startup(`performing recommissioning instead of restore for z-stack 1.2`);
88
+ await this.beginCommissioning(this.nwkOptions);
89
+ await this.beginStartup();
90
+ }
91
+ else {
92
+ await this.beginRestore();
93
+ }
94
+ result = "restored";
95
+ break;
96
+ }
97
+ case "startCommissioning": {
98
+ if (this.options.version === tstype_1.ZnpVersion.zStack12) {
99
+ const hasConfigured = await this.nv.readItem(common_1.NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK1, 0, Structs.hasConfigured);
100
+ await this.beginCommissioning(this.nwkOptions);
101
+ await this.beginStartup();
102
+ result = hasConfigured && hasConfigured.isConfigured() ? "reset" : "restored";
103
+ }
104
+ else {
105
+ await this.beginCommissioning(this.nwkOptions);
106
+ result = "reset";
107
+ }
108
+ break;
109
+ }
110
+ }
111
+ /* register endpoints */
112
+ await this.registerEndpoints();
113
+ /* add green power group */
114
+ await this.addToGroup(242, this.options.greenPowerGroup);
115
+ return result;
116
+ }
117
+ /**
118
+ * Internal function to determine startup strategy. The strategy determination flow is described in
119
+ * [this GitHub issue comment](https://github.com/Koenkk/zigbee-herdsman/issues/286#issuecomment-761029689).
120
+ */
121
+ async determineStrategy() {
122
+ this.debug.strategy("determining znp startup strategy");
123
+ /* acquire data from adapter */
124
+ const hasConfiguredNvId = this.options.version === tstype_1.ZnpVersion.zStack12 ? common_1.NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK1 : common_1.NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK3;
125
+ const hasConfigured = await this.nv.readItem(hasConfiguredNvId, 0, Structs.hasConfigured);
126
+ const nib = await this.nv.readItem(common_1.NvItemsIds.NIB, 0, Structs.nib);
127
+ const preconfiguredKey = this.options.version === tstype_1.ZnpVersion.zStack12 ?
128
+ Structs.nwkKey((await this.znp.request(constants_1.Subsystem.SAPI, "readConfiguration", { configid: common_1.NvItemsIds.PRECFGKEY })).payload.value) :
129
+ await this.nv.readItem(common_1.NvItemsIds.PRECFGKEY, 0, Structs.nwkKey);
130
+ let activeKeyInfo = await this.nv.readItem(common_1.NvItemsIds.NWK_ACTIVE_KEY_INFO, 0, Structs.nwkKeyDescriptor);
131
+ let alternateKeyInfo = await this.nv.readItem(common_1.NvItemsIds.NWK_ALTERN_KEY_INFO, 0, Structs.nwkKeyDescriptor);
132
+ /* Z-Stack 1.2 does not provide key info entries */
133
+ if (this.options.version === tstype_1.ZnpVersion.zStack12) {
134
+ activeKeyInfo = Structs.nwkKeyDescriptor();
135
+ activeKeyInfo.key = Buffer.from(preconfiguredKey.key);
136
+ alternateKeyInfo = Structs.nwkKeyDescriptor();
137
+ alternateKeyInfo.key = Buffer.from(preconfiguredKey.key);
138
+ }
139
+ /* get backup if available and supported by target */
140
+ const backup = await this.backup.getStoredBackup();
141
+ /* special treatment for incorrectly reversed Extended PAN IDs from previous releases */
142
+ const isExtendedPanIdReversed = nib && this.nwkOptions.extendedPanId.equals(Buffer.from(nib.extendedPANID).reverse());
143
+ /* istanbul ignore next */
144
+ const configMatchesAdapter = (nib &&
145
+ Utils.compareChannelLists(this.nwkOptions.channelList, nib.channelList) &&
146
+ this.nwkOptions.panId === nib.nwkPanId &&
147
+ (this.nwkOptions.extendedPanId.equals(nib.extendedPANID) ||
148
+ /* exception for migration from previous code-base */
149
+ isExtendedPanIdReversed ||
150
+ /* exception for some adapters which may actually use 0xdddddddddddddddd as EPID (backward compatibility) */
151
+ this.nwkOptions.hasDefaultExtendedPanId) &&
152
+ this.nwkOptions.networkKey.equals(preconfiguredKey.key) &&
153
+ this.nwkOptions.networkKey.equals(activeKeyInfo.key) &&
154
+ this.nwkOptions.networkKey.equals(alternateKeyInfo.key));
155
+ const backupMatchesAdapter = (backup &&
156
+ nib &&
157
+ backup.networkOptions.panId === nib.nwkPanId &&
158
+ backup.networkOptions.extendedPanId.equals(nib.extendedPANID) &&
159
+ Utils.compareChannelLists(backup.networkOptions.channelList, nib.channelList) &&
160
+ backup.networkOptions.networkKey.equals(activeKeyInfo.key));
161
+ const configMatchesBackup = (backup &&
162
+ Utils.compareNetworkOptions(this.nwkOptions, backup.networkOptions, true));
163
+ const checkRestoreVersionCompatibility = () => {
164
+ if (this.options.version === tstype_1.ZnpVersion.zStack12 && backup && backup.znp?.version !== undefined && backup.znp.version !== tstype_1.ZnpVersion.zStack12) {
165
+ throw new Error(`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`);
166
+ }
167
+ };
168
+ /* Determine startup strategy */
169
+ if (!hasConfigured || !hasConfigured.isConfigured() || !nib) {
170
+ /* Adapter is not configured or not commissioned */
171
+ this.debug.strategy("(stage-1) adapter is not configured / not commissioned");
172
+ if (configMatchesBackup) {
173
+ /* Adapter backup is available and matches configuration */
174
+ this.debug.strategy("(stage-2) configuration matches backup");
175
+ checkRestoreVersionCompatibility();
176
+ return "restoreBackup";
177
+ }
178
+ else {
179
+ /* Adapter backup is either not available or does not match configuration */
180
+ if (!backup) {
181
+ this.debug.strategy("(stage-2) adapter backup does not exist");
182
+ }
183
+ else {
184
+ this.debug.strategy("(stage-2) configuration does not match backup");
185
+ }
186
+ return "startCommissioning";
187
+ }
188
+ }
189
+ else {
190
+ /* Adapter is configured and commissioned */
191
+ this.debug.strategy("(stage-1) adapter is configured");
192
+ if (configMatchesAdapter) {
193
+ /* Warn if EPID is reversed (backward-compat) */
194
+ if (isExtendedPanIdReversed) {
195
+ this.debug.strategy("(stage-2) extended pan id is reversed");
196
+ this.logger.warn(`Extended PAN ID is reversed (expected=${this.nwkOptions.extendedPanId.toString("hex")}, actual=${nib.extendedPANID.toString("hex")})`);
197
+ }
198
+ /* Configuration matches adapter state - regular startup */
199
+ this.debug.strategy("(stage-2) adapter state matches configuration");
200
+ return "startup";
201
+ }
202
+ else {
203
+ /* Configuration does not match adapter state */
204
+ this.debug.strategy("(stage-2) adapter state does not match configuration");
205
+ if (backup) {
206
+ /* Backup is present */
207
+ this.debug.strategy("(stage-3) got adapter backup");
208
+ if (backupMatchesAdapter) {
209
+ /* Backup matches adapter state */
210
+ this.debug.strategy("(stage-4) adapter state matches backup");
211
+ this.logger.error(`Configuration is not consistent with adapter state/backup!`);
212
+ this.logger.error(`- PAN ID: configured=${this.nwkOptions.panId}, adapter=${nib.nwkPanId}`);
213
+ this.logger.error(`- Extended PAN ID: configured=${this.nwkOptions.extendedPanId.toString("hex")}, adapter=${nib.extendedPANID.toString("hex")}`);
214
+ this.logger.error(`- Network Key: configured=${this.nwkOptions.networkKey.toString("hex")}, adapter=${activeKeyInfo.key.toString("hex")}`);
215
+ this.logger.error(`- Channel List: configured=${this.nwkOptions.channelList.toString()}, adapter=${Utils.unpackChannelList(nib.channelList).toString()}`);
216
+ this.logger.error(`Please update configuration to prevent further issues.`);
217
+ this.logger.error(`If you wish to re-commission your network, please remove coordinator backup at ${this.options.backupPath}.`);
218
+ this.logger.error(`Re-commissioning your network will require re-pairing of all devices!`);
219
+ if (this.options.adapterOptions.forceStartWithInconsistentAdapterConfiguration) {
220
+ this.logger.error(`Running despite adapter configuration mismatch as configured. Please update the adapter to compatible firmware and recreate your network as soon as possible.`);
221
+ return "startup";
222
+ }
223
+ else {
224
+ throw new Error("startup failed - configuration-adapter mismatch - see logs above for more information");
225
+ }
226
+ }
227
+ else {
228
+ /* Backup does not match adapter state */
229
+ this.debug.strategy("(stage-4) adapter state does not match backup");
230
+ if (configMatchesBackup) {
231
+ /* Adapter backup matches configuration */
232
+ this.debug.strategy("(stage-5) adapter backup matches configuration");
233
+ checkRestoreVersionCompatibility();
234
+ return "restoreBackup";
235
+ }
236
+ else {
237
+ /* Adapter backup does not match configuration */
238
+ this.debug.strategy("(stage-5) adapter backup does not match configuration");
239
+ return "startCommissioning";
240
+ }
241
+ }
242
+ }
243
+ else {
244
+ /* Configuration mismatches adapter and no backup is available */
245
+ this.debug.strategy("(stage-3) configuration-adapter mismatch (no backup)");
246
+ return "startCommissioning";
247
+ }
248
+ }
249
+ }
250
+ }
251
+ /**
252
+ * Internal method to perform regular adapter startup in coordinator mode.
253
+ */
254
+ async beginStartup() {
255
+ const deviceInfo = await this.znp.request(constants_1.Subsystem.UTIL, 'getDeviceInfo', {});
256
+ if (deviceInfo.payload.devicestate !== common_1.DevStates.ZB_COORD) {
257
+ this.debug.startup("starting adapter as coordinator");
258
+ const started = this.znp.waitFor(UnpiConstants.Type.AREQ, constants_1.Subsystem.ZDO, 'stateChangeInd', { state: 9 }, 60000);
259
+ await this.znp.request(constants_1.Subsystem.ZDO, 'startupFromApp', { startdelay: 100 }, null, null, [common_1.ZnpCommandStatus.SUCCESS, common_1.ZnpCommandStatus.FAILURE]);
260
+ await started.start().promise;
261
+ this.debug.startup("adapter successfully started in coordinator mode");
262
+ }
263
+ else {
264
+ this.debug.startup("adapter is already running in coordinator mode");
265
+ }
266
+ }
267
+ /**
268
+ * Internal method to perform adapter restore.
269
+ */
270
+ async beginRestore() {
271
+ const backup = await this.backup.getStoredBackup();
272
+ /* istanbul ignore next */
273
+ if (!backup) {
274
+ throw Error("Cannot restore backup - none is available");
275
+ }
276
+ /* generate random provisioning network parameters */
277
+ const provisioningNwkOptions = {
278
+ panId: 1 + Math.round(Math.random() * 65532),
279
+ extendedPanId: crypto.randomBytes(8),
280
+ channelList: [11 + Math.round((Math.random() * (26 - 11)))],
281
+ networkKey: crypto.randomBytes(16),
282
+ networkKeyDistribute: false
283
+ };
284
+ /* commission provisioning network */
285
+ this.debug.commissioning("commissioning random provisioning network:");
286
+ this.debug.commissioning(` - panId: ${provisioningNwkOptions.panId}`);
287
+ this.debug.commissioning(` - extendedPanId: ${provisioningNwkOptions.extendedPanId.toString("hex")}`);
288
+ this.debug.commissioning(` - channelList: ${provisioningNwkOptions.channelList.join(", ")}`);
289
+ this.debug.commissioning(` - networkKey: ${provisioningNwkOptions.networkKey.toString("hex")}`);
290
+ this.debug.commissioning(` - networkKeyDistribute: ${provisioningNwkOptions.networkKeyDistribute}`);
291
+ await this.beginCommissioning(provisioningNwkOptions, false, false);
292
+ /* perform NV restore */
293
+ await this.backup.restoreBackup(backup);
294
+ /* update commissioning NV items with desired nwk configuration */
295
+ await this.updateCommissioningNvItems(this.nwkOptions);
296
+ /* settle & reset adapter */
297
+ this.debug.commissioning("giving adapter some time to settle");
298
+ await (0, utils_1.Wait)(1000);
299
+ await this.resetAdapter();
300
+ /* startup with restored adapter */
301
+ await this.beginStartup();
302
+ /* write configuration flag */
303
+ await this.writeConfigurationFlag();
304
+ }
305
+ /**
306
+ * Internal method to perform new network commissioning. Network commissioning creates a new ZigBee
307
+ * network using the adapter.
308
+ *
309
+ * @param nwkOptions Options to configure the new network with.
310
+ * @param failOnCollision Whether process should throw an error if PAN ID collision is detected.
311
+ * @param writeConfiguredFlag Whether zigbee-herdsman `hasConfigured` flag should be written to NV.
312
+ */
313
+ async beginCommissioning(nwkOptions, failOnCollision = true, writeConfiguredFlag = true) {
314
+ if (nwkOptions.panId === 65535) {
315
+ throw new Error(`network commissioning failed - cannot use pan id 65535`);
316
+ }
317
+ /* clear and reset the adapter */
318
+ await this.nv.deleteItem(common_1.NvItemsIds.NIB);
319
+ await this.clearAdapter();
320
+ /* commission the network as per parameters */
321
+ await this.updateCommissioningNvItems(nwkOptions);
322
+ this.debug.commissioning("beginning network commissioning");
323
+ if ([tstype_1.ZnpVersion.zStack30x, tstype_1.ZnpVersion.zStack3x0].includes(this.options.version)) {
324
+ /* configure channel */
325
+ await this.znp.request(constants_1.Subsystem.APP_CNF, "bdbSetChannel", { isPrimary: 0x1, channel: Utils.packChannelList(nwkOptions.channelList) });
326
+ await this.znp.request(constants_1.Subsystem.APP_CNF, "bdbSetChannel", { isPrimary: 0x0, channel: 0x0 });
327
+ /* perform bdb commissioning */
328
+ const started = this.znp.waitFor(UnpiConstants.Type.AREQ, constants_1.Subsystem.ZDO, "stateChangeInd", { state: 9 }, 60000);
329
+ await this.znp.request(constants_1.Subsystem.APP_CNF, 'bdbStartCommissioning', { mode: 0x04 });
330
+ try {
331
+ await started.start().promise;
332
+ }
333
+ catch (error) {
334
+ throw new Error(`network commissioning timed out - most likely network with the same panId or extendedPanId already exists nearby`);
335
+ }
336
+ }
337
+ else {
338
+ /* Z-Stack 1.2 requires startup to be performed instead of BDB commissioning */
339
+ await this.beginStartup();
340
+ }
341
+ /* wait for NIB to settle (takes different amount of time of different platforms */
342
+ this.debug.commissioning("waiting for NIB to settle");
343
+ let reads = 0;
344
+ let nib = null;
345
+ do {
346
+ await (0, utils_1.Wait)(3000);
347
+ nib = await this.nv.readItem(common_1.NvItemsIds.NIB, 0, Structs.nib);
348
+ reads++;
349
+ } while ((!nib || nib.nwkPanId === 65535 || nib.nwkLogicalChannel === 0) && reads < 10);
350
+ if (!nib || nib.nwkPanId === 65535 || nib.nwkLogicalChannel === 0) {
351
+ throw new Error(`network commissioning failed - timed out waiting for nib to settle`);
352
+ }
353
+ /* validate provisioned PAN ID */
354
+ const extNwkInfo = await this.znp.request(constants_1.Subsystem.ZDO, 'extNwkInfo', {});
355
+ if (extNwkInfo.payload.panid !== nwkOptions.panId && failOnCollision) {
356
+ throw new Error(`network commissioning failed - panId collision detected (expected=${nwkOptions.panId}, actual=${extNwkInfo.payload.panid})`);
357
+ }
358
+ this.debug.commissioning("network commissioned");
359
+ /* write configuration flag */
360
+ if (writeConfiguredFlag) {
361
+ await this.writeConfigurationFlag();
362
+ }
363
+ }
364
+ /**
365
+ * Updates commissioning NV memory parameters in connected controller. This method should be invoked
366
+ * to configure network commissioning parameters or update the controller after restore.
367
+ *
368
+ * @param options Network options to set in NV memory.
369
+ */
370
+ async updateCommissioningNvItems(options) {
371
+ const nwkPanId = Structs.nwkPanId();
372
+ nwkPanId.panId = options.panId;
373
+ const channelList = Structs.channelList();
374
+ channelList.channelList = Utils.packChannelList(options.channelList);
375
+ const extendedPanIdReversed = Buffer.from(options.extendedPanId).reverse();
376
+ this.debug.commissioning(`setting network commissioning parameters`);
377
+ await this.nv.updateItem(common_1.NvItemsIds.STARTUP_OPTION, Buffer.from([0x00]));
378
+ await this.nv.updateItem(common_1.NvItemsIds.LOGICAL_TYPE, Buffer.from([ZnpConstants.ZDO.deviceLogicalType.COORDINATOR]));
379
+ await this.nv.updateItem(common_1.NvItemsIds.ZDO_DIRECT_CB, Buffer.from([0x01]));
380
+ await this.nv.updateItem(common_1.NvItemsIds.CHANLIST, channelList.serialize());
381
+ await this.nv.updateItem(common_1.NvItemsIds.PANID, nwkPanId.serialize());
382
+ await this.nv.updateItem(common_1.NvItemsIds.EXTENDED_PAN_ID, extendedPanIdReversed);
383
+ await this.nv.updateItem(common_1.NvItemsIds.APS_USE_EXT_PANID, extendedPanIdReversed);
384
+ /* istanbul ignore next */
385
+ await this.nv.updateItem(common_1.NvItemsIds.PRECFGKEYS_ENABLE, Buffer.from([options.networkKeyDistribute ? 0x01 : 0x00]));
386
+ if ([tstype_1.ZnpVersion.zStack30x, tstype_1.ZnpVersion.zStack3x0].includes(this.options.version)) {
387
+ await this.nv.updateItem(common_1.NvItemsIds.PRECFGKEY, options.networkKey);
388
+ }
389
+ else {
390
+ await this.znp.request(constants_1.Subsystem.SAPI, "writeConfiguration", {
391
+ configid: common_1.NvItemsIds.PRECFGKEY,
392
+ len: options.networkKey.length,
393
+ value: options.networkKey
394
+ });
395
+ await this.nv.writeItem(common_1.NvItemsIds.LEGACY_TCLK_TABLE_START_12, Buffer.from([
396
+ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x5a, 0x69, 0x67, 0x42, 0x65, 0x65, 0x41, 0x6c,
397
+ 0x6c, 0x69, 0x61, 0x6e, 0x63, 0x65, 0x30, 0x39, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
398
+ ]));
399
+ }
400
+ }
401
+ /**
402
+ * Registers endpoints before beginning normal operation.
403
+ */
404
+ async registerEndpoints() {
405
+ const activeEpResponse = this.znp.waitFor(UnpiConstants.Type.AREQ, constants_1.Subsystem.ZDO, 'activeEpRsp');
406
+ // eslint-disable-next-line @typescript-eslint/no-floating-promises
407
+ this.znp.request(constants_1.Subsystem.ZDO, 'activeEpReq', { dstaddr: 0, nwkaddrofinterest: 0 });
408
+ const activeEp = await activeEpResponse.start().promise;
409
+ for (const endpoint of endpoints_1.Endpoints) {
410
+ if (activeEp.payload.activeeplist.includes(endpoint.endpoint)) {
411
+ this.debug.startup(`endpoint '${endpoint.endpoint}' already registered`);
412
+ }
413
+ else {
414
+ this.debug.startup(`registering endpoint '${endpoint.endpoint}'`);
415
+ await this.znp.request(constants_1.Subsystem.AF, 'register', endpoint);
416
+ }
417
+ }
418
+ }
419
+ /**
420
+ * Adds endpoint to group.
421
+ *
422
+ * @param endpoint Endpoint index to add.
423
+ * @param group Target group index.
424
+ */
425
+ async addToGroup(endpoint, group) {
426
+ const result = await this.znp.request(5, 'extFindGroup', { endpoint, groupid: group }, null, null, [common_1.ZnpCommandStatus.SUCCESS, common_1.ZnpCommandStatus.FAILURE]);
427
+ if (result.payload.status === common_1.ZnpCommandStatus.FAILURE) {
428
+ await this.znp.request(5, 'extAddGroup', { endpoint, groupid: group, namelen: 0, groupname: [] });
429
+ }
430
+ }
431
+ /**
432
+ * Internal method to reset the adapter.
433
+ */
434
+ async resetAdapter() {
435
+ this.debug.startup("adapter reset requested");
436
+ await this.znp.request(constants_1.Subsystem.SYS, 'resetReq', { type: ZnpConstants.SYS.resetType.SOFT });
437
+ this.debug.startup("adapter reset successful");
438
+ }
439
+ /**
440
+ * Internal method to reset adapter config and data.
441
+ */
442
+ async clearAdapter() {
443
+ this.debug.startup("clearing adapter using startup option 3");
444
+ await this.nv.writeItem(common_1.NvItemsIds.STARTUP_OPTION, Buffer.from([0x03]));
445
+ await this.resetAdapter();
446
+ await this.nv.writeItem(common_1.NvItemsIds.STARTUP_OPTION, Buffer.from([0x00]));
447
+ }
448
+ /**
449
+ * Transforms Z2M number-based network options to local Buffer-based options.
450
+ *
451
+ * This function also takes care of `dd:dd:dd:dd:dd:dd:dd:dd` extended PAN ID
452
+ * and replaces it with adapter IEEE address.
453
+ *
454
+ * @param options Source Z2M network options.
455
+ */
456
+ async parseConfigNetworkOptions(options) {
457
+ const channelList = options.channelList;
458
+ /* istanbul ignore next */
459
+ channelList.sort((c1, c2) => c1 < c2 ? -1 : c1 > c2 ? 1 : 0);
460
+ const parsed = {
461
+ channelList: channelList,
462
+ panId: options.panID,
463
+ extendedPanId: Buffer.from(options.extendedPanID),
464
+ networkKey: Buffer.from(options.networkKey),
465
+ networkKeyDistribute: options.networkKeyDistribute
466
+ };
467
+ if (parsed.extendedPanId.equals(Buffer.alloc(8, 0xdd))) {
468
+ const adapterIeeeAddressResponse = await this.znp.request(constants_1.Subsystem.SYS, "getExtAddr", {});
469
+ parsed.extendedPanId = Buffer.from(adapterIeeeAddressResponse.payload.extaddress.split("0x")[1], "hex");
470
+ parsed.hasDefaultExtendedPanId = true;
471
+ }
472
+ return parsed;
473
+ }
474
+ /**
475
+ * Writes ZNP `hasConfigured` flag to NV memory. This flag indicates the adapter has been configured.
476
+ */
477
+ async writeConfigurationFlag() {
478
+ this.debug.commissioning("writing configuration flag to adapter NV memory");
479
+ await this.nv.writeItem(this.options.version === tstype_1.ZnpVersion.zStack12 ? common_1.NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK1 : common_1.NvItemsIds.ZNP_HAS_CONFIGURED_ZSTACK3, Buffer.from([0x55]));
480
+ }
481
+ }
482
+ exports.ZnpAdapterManager = ZnpAdapterManager;
477
483
  //# sourceMappingURL=manager.js.map