@willieee802/zigbee-herdsman 0.19.21 → 0.36.0

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 (523) hide show
  1. package/.babelrc.js +0 -4
  2. package/.release-please-manifest.json +1 -2
  3. package/CHANGELOG.md +462 -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 -153
  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 +810 -0
  32. package/dist/adapter/ember/adapter/emberAdapter.d.ts.map +1 -0
  33. package/dist/adapter/ember/adapter/emberAdapter.js +2970 -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 +100 -0
  44. package/dist/adapter/ember/adapter/oneWaitress.d.ts.map +1 -0
  45. package/dist/adapter/ember/adapter/oneWaitress.js +227 -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 +2174 -0
  60. package/dist/adapter/ember/enums.d.ts.map +1 -0
  61. package/dist/adapter/ember/enums.js +2377 -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 +2663 -0
  76. package/dist/adapter/ember/ezsp/ezsp.d.ts.map +1 -0
  77. package/dist/adapter/ember/ezsp/ezsp.js +6435 -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 +458 -0
  84. package/dist/adapter/ember/uart/ash.d.ts.map +1 -0
  85. package/dist/adapter/ember/uart/ash.js +1601 -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 +13 -9
  123. package/dist/adapter/ezsp/adapter/backup.d.ts.map +1 -1
  124. package/dist/adapter/ezsp/adapter/backup.js +104 -53
  125. package/dist/adapter/ezsp/adapter/backup.js.map +1 -1
  126. package/dist/adapter/ezsp/adapter/ezspAdapter.d.ts +61 -60
  127. package/dist/adapter/ezsp/adapter/ezspAdapter.d.ts.map +1 -1
  128. package/dist/adapter/ezsp/adapter/ezspAdapter.js +626 -608
  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 +111 -101
  139. package/dist/adapter/ezsp/driver/driver.d.ts.map +1 -1
  140. package/dist/adapter/ezsp/driver/driver.js +816 -638
  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 +652 -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.js +77 -72
  154. package/dist/adapter/ezsp/driver/multicast.js.map +1 -1
  155. package/dist/adapter/ezsp/driver/parser.d.ts +11 -12
  156. package/dist/adapter/ezsp/driver/parser.d.ts.map +1 -1
  157. package/dist/adapter/ezsp/driver/parser.js +104 -111
  158. package/dist/adapter/ezsp/driver/parser.js.map +1 -1
  159. package/dist/adapter/ezsp/driver/types/basic.d.ts +62 -62
  160. package/dist/adapter/ezsp/driver/types/basic.js +208 -208
  161. package/dist/adapter/ezsp/driver/types/basic.js.map +1 -1
  162. package/dist/adapter/ezsp/driver/types/index.d.ts +9 -9
  163. package/dist/adapter/ezsp/driver/types/index.d.ts.map +1 -1
  164. package/dist/adapter/ezsp/driver/types/index.js +138 -133
  165. package/dist/adapter/ezsp/driver/types/index.js.map +1 -1
  166. package/dist/adapter/ezsp/driver/types/named.d.ts +1287 -697
  167. package/dist/adapter/ezsp/driver/types/named.d.ts.map +1 -1
  168. package/dist/adapter/ezsp/driver/types/named.js +2329 -1726
  169. package/dist/adapter/ezsp/driver/types/named.js.map +1 -1
  170. package/dist/adapter/ezsp/driver/types/struct.d.ts +270 -251
  171. package/dist/adapter/ezsp/driver/types/struct.d.ts.map +1 -1
  172. package/dist/adapter/ezsp/driver/types/struct.js +803 -708
  173. package/dist/adapter/ezsp/driver/types/struct.js.map +1 -1
  174. package/dist/adapter/ezsp/driver/uart.d.ts +48 -44
  175. package/dist/adapter/ezsp/driver/uart.d.ts.map +1 -1
  176. package/dist/adapter/ezsp/driver/uart.js +382 -368
  177. package/dist/adapter/ezsp/driver/uart.js.map +1 -1
  178. package/dist/adapter/ezsp/driver/utils/crc16ccitt.d.ts +2 -2
  179. package/dist/adapter/ezsp/driver/utils/crc16ccitt.js +55 -55
  180. package/dist/adapter/ezsp/driver/utils/crc16ccitt.js.map +1 -1
  181. package/dist/adapter/ezsp/driver/utils/index.d.ts +19 -18
  182. package/dist/adapter/ezsp/driver/utils/index.d.ts.map +1 -1
  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 +13 -8
  192. package/dist/adapter/serialPort.d.ts.map +1 -1
  193. package/dist/adapter/serialPort.js +46 -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.js +462 -461
  205. package/dist/adapter/z-stack/adapter/adapter-backup.js.map +1 -1
  206. package/dist/adapter/z-stack/adapter/adapter-nv-memory.d.ts +150 -150
  207. package/dist/adapter/z-stack/adapter/adapter-nv-memory.js +258 -258
  208. package/dist/adapter/z-stack/adapter/adapter-nv-memory.js.map +1 -1
  209. package/dist/adapter/z-stack/adapter/endpoints.d.ts +11 -11
  210. package/dist/adapter/z-stack/adapter/endpoints.js +73 -73
  211. package/dist/adapter/z-stack/adapter/index.d.ts +2 -2
  212. package/dist/adapter/z-stack/adapter/index.js +8 -8
  213. package/dist/adapter/z-stack/adapter/manager.d.ts +86 -86
  214. package/dist/adapter/z-stack/adapter/manager.d.ts.map +1 -1
  215. package/dist/adapter/z-stack/adapter/manager.js +482 -476
  216. package/dist/adapter/z-stack/adapter/manager.js.map +1 -1
  217. package/dist/adapter/z-stack/adapter/tstype.d.ts +6 -6
  218. package/dist/adapter/z-stack/adapter/tstype.js +9 -10
  219. package/dist/adapter/z-stack/adapter/tstype.js.map +1 -1
  220. package/dist/adapter/z-stack/adapter/zStackAdapter.d.ts +81 -81
  221. package/dist/adapter/z-stack/adapter/zStackAdapter.d.ts.map +1 -1
  222. package/dist/adapter/z-stack/adapter/zStackAdapter.js +885 -868
  223. package/dist/adapter/z-stack/adapter/zStackAdapter.js.map +1 -1
  224. package/dist/adapter/z-stack/constants/af.d.ts +23 -23
  225. package/dist/adapter/z-stack/constants/af.js +27 -27
  226. package/dist/adapter/z-stack/constants/common.d.ts +278 -278
  227. package/dist/adapter/z-stack/constants/common.d.ts.map +1 -1
  228. package/dist/adapter/z-stack/constants/common.js +292 -289
  229. package/dist/adapter/z-stack/constants/common.js.map +1 -1
  230. package/dist/adapter/z-stack/constants/dbg.d.ts +22 -22
  231. package/dist/adapter/z-stack/constants/dbg.js +24 -24
  232. package/dist/adapter/z-stack/constants/index.d.ts +10 -10
  233. package/dist/adapter/z-stack/constants/index.js +47 -47
  234. package/dist/adapter/z-stack/constants/mac.d.ts +127 -127
  235. package/dist/adapter/z-stack/constants/mac.js +129 -129
  236. package/dist/adapter/z-stack/constants/sapi.d.ts +24 -24
  237. package/dist/adapter/z-stack/constants/sapi.js +26 -26
  238. package/dist/adapter/z-stack/constants/sys.d.ts +71 -71
  239. package/dist/adapter/z-stack/constants/sys.js +73 -73
  240. package/dist/adapter/z-stack/constants/util.d.ts +81 -81
  241. package/dist/adapter/z-stack/constants/util.js +83 -83
  242. package/dist/adapter/z-stack/constants/utils.d.ts +4 -4
  243. package/dist/adapter/z-stack/constants/utils.js +14 -14
  244. package/dist/adapter/z-stack/constants/zdo.d.ts +102 -102
  245. package/dist/adapter/z-stack/constants/zdo.js +104 -104
  246. package/dist/adapter/z-stack/models/index.d.ts +1 -1
  247. package/dist/adapter/z-stack/models/index.js +17 -17
  248. package/dist/adapter/z-stack/models/startup-options.d.ts +12 -12
  249. package/dist/adapter/z-stack/models/startup-options.js +2 -2
  250. package/dist/adapter/z-stack/structs/entries/address-manager-entry.d.ts +23 -23
  251. package/dist/adapter/z-stack/structs/entries/address-manager-entry.js +45 -45
  252. package/dist/adapter/z-stack/structs/entries/address-manager-entry.js.map +1 -1
  253. package/dist/adapter/z-stack/structs/entries/address-manager-table.d.ts +10 -10
  254. package/dist/adapter/z-stack/structs/entries/address-manager-table.js +22 -22
  255. package/dist/adapter/z-stack/structs/entries/aps-link-key-data-entry.d.ts +10 -10
  256. package/dist/adapter/z-stack/structs/entries/aps-link-key-data-entry.js +21 -21
  257. package/dist/adapter/z-stack/structs/entries/aps-link-key-data-table.d.ts +10 -10
  258. package/dist/adapter/z-stack/structs/entries/aps-link-key-data-table.js +23 -23
  259. package/dist/adapter/z-stack/structs/entries/aps-tc-link-key-entry.d.ts +10 -10
  260. package/dist/adapter/z-stack/structs/entries/aps-tc-link-key-entry.js +24 -24
  261. package/dist/adapter/z-stack/structs/entries/aps-tc-link-key-table.d.ts +10 -10
  262. package/dist/adapter/z-stack/structs/entries/aps-tc-link-key-table.js +23 -23
  263. package/dist/adapter/z-stack/structs/entries/channel-list.d.ts +8 -8
  264. package/dist/adapter/z-stack/structs/entries/channel-list.js +15 -15
  265. package/dist/adapter/z-stack/structs/entries/has-configured.d.ts +8 -8
  266. package/dist/adapter/z-stack/structs/entries/has-configured.js +16 -16
  267. package/dist/adapter/z-stack/structs/entries/index.d.ts +16 -16
  268. package/dist/adapter/z-stack/structs/entries/index.js +32 -32
  269. package/dist/adapter/z-stack/structs/entries/nib.d.ts +10 -10
  270. package/dist/adapter/z-stack/structs/entries/nib.js +68 -68
  271. package/dist/adapter/z-stack/structs/entries/nwk-key-descriptor.d.ts +10 -10
  272. package/dist/adapter/z-stack/structs/entries/nwk-key-descriptor.js +18 -18
  273. package/dist/adapter/z-stack/structs/entries/nwk-key.d.ts +8 -8
  274. package/dist/adapter/z-stack/structs/entries/nwk-key.js +15 -15
  275. package/dist/adapter/z-stack/structs/entries/nwk-pan-id.d.ts +8 -8
  276. package/dist/adapter/z-stack/structs/entries/nwk-pan-id.js +15 -15
  277. package/dist/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-entry.d.ts +13 -13
  278. package/dist/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-entry.js +23 -23
  279. package/dist/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-table.d.ts +10 -10
  280. package/dist/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-table.js +22 -22
  281. package/dist/adapter/z-stack/structs/entries/security-manager-entry.d.ts +20 -20
  282. package/dist/adapter/z-stack/structs/entries/security-manager-entry.js +36 -36
  283. package/dist/adapter/z-stack/structs/entries/security-manager-entry.js.map +1 -1
  284. package/dist/adapter/z-stack/structs/entries/security-manager-table.d.ts +10 -10
  285. package/dist/adapter/z-stack/structs/entries/security-manager-table.js +24 -24
  286. package/dist/adapter/z-stack/structs/index.d.ts +4 -4
  287. package/dist/adapter/z-stack/structs/index.js +20 -20
  288. package/dist/adapter/z-stack/structs/serializable-memory-object.d.ts +13 -13
  289. package/dist/adapter/z-stack/structs/serializable-memory-object.js +2 -2
  290. package/dist/adapter/z-stack/structs/struct.d.ts +99 -99
  291. package/dist/adapter/z-stack/structs/struct.js +296 -295
  292. package/dist/adapter/z-stack/structs/struct.js.map +1 -1
  293. package/dist/adapter/z-stack/structs/table.d.ts +94 -94
  294. package/dist/adapter/z-stack/structs/table.js +163 -161
  295. package/dist/adapter/z-stack/structs/table.js.map +1 -1
  296. package/dist/adapter/z-stack/unpi/constants.d.ts +28 -28
  297. package/dist/adapter/z-stack/unpi/constants.js +39 -41
  298. package/dist/adapter/z-stack/unpi/constants.js.map +1 -1
  299. package/dist/adapter/z-stack/unpi/frame.d.ts +16 -16
  300. package/dist/adapter/z-stack/unpi/frame.js +54 -48
  301. package/dist/adapter/z-stack/unpi/frame.js.map +1 -1
  302. package/dist/adapter/z-stack/unpi/index.d.ts +5 -5
  303. package/dist/adapter/z-stack/unpi/index.js +37 -37
  304. package/dist/adapter/z-stack/unpi/parser.d.ts +10 -10
  305. package/dist/adapter/z-stack/unpi/parser.js +75 -74
  306. package/dist/adapter/z-stack/unpi/parser.js.map +1 -1
  307. package/dist/adapter/z-stack/unpi/writer.d.ts +10 -10
  308. package/dist/adapter/z-stack/unpi/writer.js +44 -44
  309. package/dist/adapter/z-stack/utils/channel-list.d.ts +20 -20
  310. package/dist/adapter/z-stack/utils/channel-list.js +40 -40
  311. package/dist/adapter/z-stack/utils/channel-list.js.map +1 -1
  312. package/dist/adapter/z-stack/utils/index.d.ts +2 -2
  313. package/dist/adapter/z-stack/utils/index.js +18 -18
  314. package/dist/adapter/z-stack/utils/network-options.d.ts +8 -8
  315. package/dist/adapter/z-stack/utils/network-options.js +22 -22
  316. package/dist/adapter/z-stack/znp/buffaloZnp.d.ts +11 -11
  317. package/dist/adapter/z-stack/znp/buffaloZnp.js +113 -113
  318. package/dist/adapter/z-stack/znp/buffaloZnp.js.map +1 -1
  319. package/dist/adapter/z-stack/znp/definition.d.ts +5 -5
  320. package/dist/adapter/z-stack/znp/definition.js +3050 -3050
  321. package/dist/adapter/z-stack/znp/index.d.ts +3 -3
  322. package/dist/adapter/z-stack/znp/index.js +10 -10
  323. package/dist/adapter/z-stack/znp/parameterType.d.ts +22 -22
  324. package/dist/adapter/z-stack/znp/parameterType.js +25 -25
  325. package/dist/adapter/z-stack/znp/tstype.d.ts +21 -21
  326. package/dist/adapter/z-stack/znp/tstype.js +2 -2
  327. package/dist/adapter/z-stack/znp/znp.d.ts +44 -43
  328. package/dist/adapter/z-stack/znp/znp.d.ts.map +1 -1
  329. package/dist/adapter/z-stack/znp/znp.js +326 -325
  330. package/dist/adapter/z-stack/znp/znp.js.map +1 -1
  331. package/dist/adapter/z-stack/znp/zpiObject.d.ts +19 -19
  332. package/dist/adapter/z-stack/znp/zpiObject.js +102 -96
  333. package/dist/adapter/z-stack/znp/zpiObject.js.map +1 -1
  334. package/dist/adapter/zigate/adapter/index.d.ts +2 -2
  335. package/dist/adapter/zigate/adapter/index.js +10 -10
  336. package/dist/adapter/zigate/adapter/zigateAdapter.d.ts +70 -70
  337. package/dist/adapter/zigate/adapter/zigateAdapter.js +689 -684
  338. package/dist/adapter/zigate/adapter/zigateAdapter.js.map +1 -1
  339. package/dist/adapter/zigate/debug.d.ts +7 -7
  340. package/dist/adapter/zigate/debug.d.ts.map +1 -1
  341. package/dist/adapter/zigate/debug.js +19 -22
  342. package/dist/adapter/zigate/debug.js.map +1 -1
  343. package/dist/adapter/zigate/driver/buffaloZiGate.d.ts +18 -18
  344. package/dist/adapter/zigate/driver/buffaloZiGate.js +139 -139
  345. package/dist/adapter/zigate/driver/buffaloZiGate.js.map +1 -1
  346. package/dist/adapter/zigate/driver/commandType.d.ts +41 -41
  347. package/dist/adapter/zigate/driver/commandType.js +385 -385
  348. package/dist/adapter/zigate/driver/commandType.js.map +1 -1
  349. package/dist/adapter/zigate/driver/constants.d.ts +276 -276
  350. package/dist/adapter/zigate/driver/constants.d.ts.map +1 -1
  351. package/dist/adapter/zigate/driver/constants.js +371 -371
  352. package/dist/adapter/zigate/driver/constants.js.map +1 -1
  353. package/dist/adapter/zigate/driver/frame.d.ts +26 -26
  354. package/dist/adapter/zigate/driver/frame.js +172 -172
  355. package/dist/adapter/zigate/driver/frame.js.map +1 -1
  356. package/dist/adapter/zigate/driver/messageType.d.ts +11 -11
  357. package/dist/adapter/zigate/driver/messageType.js +278 -278
  358. package/dist/adapter/zigate/driver/messageType.js.map +1 -1
  359. package/dist/adapter/zigate/driver/parameterType.d.ts +20 -20
  360. package/dist/adapter/zigate/driver/parameterType.js +23 -23
  361. package/dist/adapter/zigate/driver/ziGateObject.d.ts +23 -23
  362. package/dist/adapter/zigate/driver/ziGateObject.js +110 -106
  363. package/dist/adapter/zigate/driver/ziGateObject.js.map +1 -1
  364. package/dist/adapter/zigate/driver/zigate.d.ts +49 -49
  365. package/dist/adapter/zigate/driver/zigate.d.ts.map +1 -1
  366. package/dist/adapter/zigate/driver/zigate.js +296 -303
  367. package/dist/adapter/zigate/driver/zigate.js.map +1 -1
  368. package/dist/buffalo/buffalo.d.ts +50 -50
  369. package/dist/buffalo/buffalo.js +324 -322
  370. package/dist/buffalo/buffalo.js.map +1 -1
  371. package/dist/buffalo/index.d.ts +3 -3
  372. package/dist/buffalo/index.js +33 -33
  373. package/dist/buffalo/tstype.d.ts +8 -8
  374. package/dist/buffalo/tstype.js +2 -2
  375. package/dist/controller/controller.d.ts +113 -113
  376. package/dist/controller/controller.d.ts.map +1 -1
  377. package/dist/controller/controller.js +641 -619
  378. package/dist/controller/controller.js.map +1 -1
  379. package/dist/controller/database.d.ts +18 -18
  380. package/dist/controller/database.js +96 -93
  381. package/dist/controller/database.js.map +1 -1
  382. package/dist/controller/events.d.ts +58 -58
  383. package/dist/controller/events.d.ts.map +1 -1
  384. package/dist/controller/events.js +108 -102
  385. package/dist/controller/events.js.map +1 -1
  386. package/dist/controller/greenPower.d.ts +12 -12
  387. package/dist/controller/greenPower.js +221 -220
  388. package/dist/controller/greenPower.js.map +1 -1
  389. package/dist/controller/helpers/index.d.ts +2 -2
  390. package/dist/controller/helpers/index.js +28 -28
  391. package/dist/controller/helpers/request.d.ts +21 -22
  392. package/dist/controller/helpers/request.d.ts.map +1 -1
  393. package/dist/controller/helpers/request.js +77 -71
  394. package/dist/controller/helpers/request.js.map +1 -1
  395. package/dist/controller/helpers/requestQueue.d.ts +13 -0
  396. package/dist/controller/helpers/requestQueue.d.ts.map +1 -0
  397. package/dist/controller/helpers/requestQueue.js +116 -0
  398. package/dist/controller/helpers/requestQueue.js.map +1 -0
  399. package/dist/controller/helpers/zclFrameConverter.d.ts +7 -7
  400. package/dist/controller/helpers/zclFrameConverter.d.ts.map +1 -1
  401. package/dist/controller/helpers/zclFrameConverter.js +50 -31
  402. package/dist/controller/helpers/zclFrameConverter.js.map +1 -1
  403. package/dist/controller/helpers/zclTransactionSequenceNumber.d.ts +5 -5
  404. package/dist/controller/helpers/zclTransactionSequenceNumber.js +13 -13
  405. package/dist/controller/helpers/zclTransactionSequenceNumber.js.map +1 -1
  406. package/dist/controller/index.d.ts +5 -5
  407. package/dist/controller/index.js +8 -8
  408. package/dist/controller/logger-stub.d.ts +6 -6
  409. package/dist/controller/logger-stub.js +2 -2
  410. package/dist/controller/model/device.d.ts +132 -133
  411. package/dist/controller/model/device.d.ts.map +1 -1
  412. package/dist/controller/model/device.js +726 -717
  413. package/dist/controller/model/device.js.map +1 -1
  414. package/dist/controller/model/endpoint.d.ts +128 -131
  415. package/dist/controller/model/endpoint.d.ts.map +1 -1
  416. package/dist/controller/model/endpoint.js +755 -821
  417. package/dist/controller/model/endpoint.js.map +1 -1
  418. package/dist/controller/model/entity.d.ts +14 -14
  419. package/dist/controller/model/entity.js +26 -26
  420. package/dist/controller/model/entity.js.map +1 -1
  421. package/dist/controller/model/group.d.ts +38 -38
  422. package/dist/controller/model/group.d.ts.map +1 -1
  423. package/dist/controller/model/group.js +225 -221
  424. package/dist/controller/model/group.js.map +1 -1
  425. package/dist/controller/model/index.d.ts +5 -5
  426. package/dist/controller/model/index.js +14 -14
  427. package/dist/controller/touchlink.d.ts +19 -19
  428. package/dist/controller/touchlink.js +159 -157
  429. package/dist/controller/touchlink.js.map +1 -1
  430. package/dist/controller/tstype.d.ts +20 -21
  431. package/dist/controller/tstype.d.ts.map +1 -1
  432. package/dist/controller/tstype.js +8 -9
  433. package/dist/controller/tstype.js.map +1 -1
  434. package/dist/index.d.ts +3 -3
  435. package/dist/index.js +33 -33
  436. package/dist/models/backup-storage-legacy.d.ts +26 -26
  437. package/dist/models/backup-storage-legacy.js +2 -2
  438. package/dist/models/backup-storage-unified.d.ts +49 -49
  439. package/dist/models/backup-storage-unified.js +2 -2
  440. package/dist/models/backup.d.ts +37 -37
  441. package/dist/models/backup.js +2 -2
  442. package/dist/models/index.d.ts +4 -4
  443. package/dist/models/index.js +20 -20
  444. package/dist/models/network-options.d.ts +12 -12
  445. package/dist/models/network-options.js +2 -2
  446. package/dist/utils/assertString.d.ts +2 -2
  447. package/dist/utils/assertString.js +8 -8
  448. package/dist/utils/assertString.js.map +1 -1
  449. package/dist/utils/backup.d.ts +20 -20
  450. package/dist/utils/backup.d.ts.map +1 -1
  451. package/dist/utils/backup.js +189 -187
  452. package/dist/utils/backup.js.map +1 -1
  453. package/dist/utils/equalsPartial.d.ts +2 -2
  454. package/dist/utils/equalsPartial.js +11 -11
  455. package/dist/utils/index.d.ts +9 -9
  456. package/dist/utils/index.js +45 -45
  457. package/dist/utils/isNumberArray.d.ts +2 -2
  458. package/dist/utils/isNumberArray.js +6 -6
  459. package/dist/utils/queue.d.ts +11 -11
  460. package/dist/utils/queue.d.ts.map +1 -1
  461. package/dist/utils/queue.js +61 -50
  462. package/dist/utils/queue.js.map +1 -1
  463. package/dist/utils/realpathSync.d.ts +2 -2
  464. package/dist/utils/realpathSync.js +12 -12
  465. package/dist/utils/wait.d.ts +2 -2
  466. package/dist/utils/wait.js +8 -8
  467. package/dist/utils/waitress.d.ts +21 -21
  468. package/dist/utils/waitress.d.ts.map +1 -1
  469. package/dist/utils/waitress.js +68 -61
  470. package/dist/utils/waitress.js.map +1 -1
  471. package/dist/zcl/buffaloZcl.d.ts +41 -41
  472. package/dist/zcl/buffaloZcl.d.ts.map +1 -1
  473. package/dist/zcl/buffaloZcl.js +594 -591
  474. package/dist/zcl/buffaloZcl.js.map +1 -1
  475. package/dist/zcl/definition/buffaloZclDataType.d.ts +17 -17
  476. package/dist/zcl/definition/buffaloZclDataType.js +20 -20
  477. package/dist/zcl/definition/cluster.d.ts +29 -29
  478. package/dist/zcl/definition/cluster.d.ts.map +1 -1
  479. package/dist/zcl/definition/cluster.js +5530 -5335
  480. package/dist/zcl/definition/cluster.js.map +1 -1
  481. package/dist/zcl/definition/dataType.d.ts +59 -59
  482. package/dist/zcl/definition/dataType.js +64 -64
  483. package/dist/zcl/definition/direction.d.ts +5 -5
  484. package/dist/zcl/definition/direction.js +8 -8
  485. package/dist/zcl/definition/endpointDeviceType.d.ts +4 -4
  486. package/dist/zcl/definition/endpointDeviceType.js +15 -15
  487. package/dist/zcl/definition/foundation.d.ts +11 -11
  488. package/dist/zcl/definition/foundation.js +167 -167
  489. package/dist/zcl/definition/frameControl.d.ts +10 -10
  490. package/dist/zcl/definition/frameControl.js +2 -2
  491. package/dist/zcl/definition/frameType.d.ts +5 -5
  492. package/dist/zcl/definition/frameType.js +8 -8
  493. package/dist/zcl/definition/index.d.ts +13 -13
  494. package/dist/zcl/definition/index.js +51 -51
  495. package/dist/zcl/definition/manufacturerCode.d.ts +1077 -1074
  496. package/dist/zcl/definition/manufacturerCode.d.ts.map +1 -1
  497. package/dist/zcl/definition/manufacturerCode.js +1082 -1079
  498. package/dist/zcl/definition/manufacturerCode.js.map +1 -1
  499. package/dist/zcl/definition/powerSource.d.ts +4 -4
  500. package/dist/zcl/definition/powerSource.js +12 -12
  501. package/dist/zcl/definition/status.d.ts +38 -38
  502. package/dist/zcl/definition/status.js +41 -41
  503. package/dist/zcl/definition/tstype.d.ts +16 -16
  504. package/dist/zcl/definition/tstype.js +2 -2
  505. package/dist/zcl/index.d.ts +16 -16
  506. package/dist/zcl/index.js +55 -55
  507. package/dist/zcl/tstype.d.ts +56 -56
  508. package/dist/zcl/tstype.js +9 -10
  509. package/dist/zcl/tstype.js.map +1 -1
  510. package/dist/zcl/utils.d.ts +6 -6
  511. package/dist/zcl/utils.js +164 -165
  512. package/dist/zcl/utils.js.map +1 -1
  513. package/dist/zcl/zclFrame.d.ts +40 -40
  514. package/dist/zcl/zclFrame.js +351 -347
  515. package/dist/zcl/zclFrame.js.map +1 -1
  516. package/dist/zcl/zclHeader.d.ts +8 -8
  517. package/dist/zcl/zclHeader.js +2 -2
  518. package/dist/zcl/zclStatusError.d.ts +5 -5
  519. package/dist/zcl/zclStatusError.js +14 -13
  520. package/dist/zcl/zclStatusError.js.map +1 -1
  521. package/package.json +11 -11
  522. package/release-please-config.json +1 -5
  523. package/tsconfig.json +4 -2
@@ -1,462 +1,463 @@
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.AdapterBackup = void 0;
30
- /* eslint-disable max-len */
31
- const debug_1 = __importDefault(require("debug"));
32
- const Structs = __importStar(require("../structs"));
33
- const Utils = __importStar(require("../utils"));
34
- const utils_1 = require("../../../utils");
35
- const mz_1 = require("mz");
36
- const common_1 = require("../constants/common");
37
- const constants_1 = require("../unpi/constants");
38
- const tstype_1 = require("./tstype");
39
- const structs_1 = require("../structs");
40
- /**
41
- * Class providing ZNP adapter backup and restore procedures based mostly on NV memory manipulation.
42
- */
43
- class AdapterBackup {
44
- constructor(znp, nv, path) {
45
- this.debug = (0, debug_1.default)("zigbee-herdsman:adapter:zStack:startup:backup");
46
- this.znp = znp;
47
- this.nv = nv;
48
- this.defaultPath = path;
49
- }
50
- /**
51
- * Loads currently stored backup and returns it in internal backup model.
52
- */
53
- async getStoredBackup() {
54
- var _a, _b, _c, _d;
55
- try {
56
- await mz_1.fs.access(this.defaultPath);
57
- }
58
- catch (error) {
59
- return null;
60
- }
61
- let data;
62
- try {
63
- data = JSON.parse((await mz_1.fs.readFile(this.defaultPath)).toString());
64
- }
65
- catch (error) {
66
- throw new Error('Coordinator backup is corrupted');
67
- }
68
- if (((_a = data.metadata) === null || _a === void 0 ? void 0 : _a.format) === "zigpy/open-coordinator-backup" && ((_b = data.metadata) === null || _b === void 0 ? void 0 : _b.version)) {
69
- if (((_c = data.metadata) === null || _c === void 0 ? void 0 : _c.version) !== 1) {
70
- throw new Error(`Unsupported open coordinator backup version (version=${(_d = data.metadata) === null || _d === void 0 ? void 0 : _d.version})`);
71
- }
72
- return utils_1.BackupUtils.fromUnifiedBackup(data);
73
- }
74
- else if (data.adapterType === "zStack") {
75
- return utils_1.BackupUtils.fromLegacyBackup(data);
76
- }
77
- else {
78
- throw new Error("Unknown backup format");
79
- }
80
- }
81
- /**
82
- * Creates a new backup from connected ZNP adapter and returns it in internal backup model format.
83
- */
84
- async createBackup(ieeeAddressesInDatabase) {
85
- this.debug("creating backup");
86
- const version = await this.getAdapterVersion();
87
- /* get adapter ieee address */
88
- const ieeeAddressResponse = await this.znp.request(constants_1.Subsystem.SYS, "getExtAddr", {});
89
- if (!ieeeAddressResponse || !ieeeAddressResponse.payload.extaddress || !ieeeAddressResponse.payload.extaddress.startsWith("0x")) {
90
- throw new Error("Failed to read adapter IEEE address");
91
- }
92
- const ieeeAddress = Buffer.from(ieeeAddressResponse.payload.extaddress.split("0x")[1], "hex");
93
- this.debug("fetched adapter ieee address");
94
- /* get adapter nib */
95
- const nib = await this.nv.readItem(common_1.NvItemsIds.NIB, 0, Structs.nib);
96
- if (!nib) {
97
- throw new Error("Cannot backup - adapter not commissioned");
98
- }
99
- this.debug("fetched adapter nib");
100
- /* get adapter active key information */
101
- let activeKeyInfo;
102
- if (version === tstype_1.ZnpVersion.zStack12) {
103
- const key = Structs.nwkKey((await this.znp.request(constants_1.Subsystem.SAPI, "readConfiguration", { configid: common_1.NvItemsIds.PRECFGKEY })).payload.value);
104
- activeKeyInfo = Structs.nwkKeyDescriptor();
105
- activeKeyInfo.key = key.key;
106
- }
107
- else {
108
- activeKeyInfo = await this.nv.readItem(common_1.NvItemsIds.NWK_ACTIVE_KEY_INFO, 0, Structs.nwkKeyDescriptor);
109
- }
110
- if (!activeKeyInfo) {
111
- throw new Error("Cannot backup - missing active key info");
112
- }
113
- this.debug("fetched adapter active key information");
114
- /* get adapter security data */
115
- const preconfiguredKeyEnabled = await this.nv.readItem(common_1.NvItemsIds.PRECFGKEYS_ENABLE, 0);
116
- this.debug("fetched adapter pre-configured key");
117
- const addressManagerTable = await this.getAddressManagerTable(version);
118
- this.debug(`fetched adapter address manager table (capacity=${(addressManagerTable === null || addressManagerTable === void 0 ? void 0 : addressManagerTable.capacity) || 0}, used=${(addressManagerTable === null || addressManagerTable === void 0 ? void 0 : addressManagerTable.usedCount) || 0})`);
119
- const securityManagerTable = await this.getSecurityManagerTable();
120
- this.debug(`fetched adapter security manager table (capacity=${(securityManagerTable === null || securityManagerTable === void 0 ? void 0 : securityManagerTable.usedCount) || 0}, used=${(securityManagerTable === null || securityManagerTable === void 0 ? void 0 : securityManagerTable.usedCount) || 0})`);
121
- const apsLinkKeyDataTable = await this.getApsLinkKeyDataTable(version);
122
- this.debug(`fetched adapter aps link key data table (capacity=${(apsLinkKeyDataTable === null || apsLinkKeyDataTable === void 0 ? void 0 : apsLinkKeyDataTable.usedCount) || 0}, used=${(apsLinkKeyDataTable === null || apsLinkKeyDataTable === void 0 ? void 0 : apsLinkKeyDataTable.usedCount) || 0})`);
123
- const tclkSeed = version === tstype_1.ZnpVersion.zStack12 ? null : await this.nv.readItem(common_1.NvItemsIds.TCLK_SEED, 0, Structs.nwkKey);
124
- this.debug("fetched adapter tclk seed");
125
- const tclkTable = await this.getTclkTable(version);
126
- this.debug(`fetched adapter tclk table (capacity=${(tclkTable === null || tclkTable === void 0 ? void 0 : tclkTable.usedCount) || 0}, used=${(tclkTable === null || tclkTable === void 0 ? void 0 : tclkTable.usedCount) || 0})`);
127
- const secMaterialTable = await this.getNetworkSecurityMaterialTable(version);
128
- this.debug(`fetched adapter network security material table (capacity=${(secMaterialTable === null || secMaterialTable === void 0 ? void 0 : secMaterialTable.usedCount) || 0}, used=${(secMaterialTable === null || secMaterialTable === void 0 ? void 0 : secMaterialTable.usedCount) || 0})`);
129
- /* examine network security material table */
130
- const genericExtendedPanId = Buffer.alloc(8, 0xff);
131
- let secMaterialDescriptor = null;
132
- /* istanbul ignore next */
133
- for (const entry of secMaterialTable.used) {
134
- if (entry.extendedPanID.equals(nib.extendedPANID)) {
135
- secMaterialDescriptor = entry;
136
- break;
137
- }
138
- else if (!secMaterialDescriptor && entry.extendedPanID.equals(genericExtendedPanId)) {
139
- secMaterialDescriptor = entry;
140
- }
141
- }
142
- if (!secMaterialDescriptor) {
143
- secMaterialDescriptor = Structs.nwkSecMaterialDescriptorEntry();
144
- secMaterialDescriptor.extendedPanID = nib.extendedPANID;
145
- secMaterialDescriptor.FrameCounter = version === tstype_1.ZnpVersion.zStack12 ? 0 : 1250;
146
- }
147
- /* return backup structure */
148
- /* istanbul ignore next */
149
- const backup = {
150
- znp: {
151
- version: version,
152
- trustCenterLinkKeySeed: (tclkSeed === null || tclkSeed === void 0 ? void 0 : tclkSeed.key) || undefined
153
- },
154
- networkOptions: {
155
- panId: nib.nwkPanId,
156
- extendedPanId: nib.extendedPANID,
157
- channelList: Utils.unpackChannelList(nib.channelList),
158
- networkKey: activeKeyInfo.key,
159
- networkKeyDistribute: preconfiguredKeyEnabled && preconfiguredKeyEnabled[0] === 0x01
160
- },
161
- logicalChannel: nib.nwkLogicalChannel,
162
- networkKeyInfo: {
163
- sequenceNumber: activeKeyInfo.keySeqNum,
164
- frameCounter: secMaterialDescriptor.FrameCounter
165
- },
166
- securityLevel: nib.SecurityLevel,
167
- networkUpdateId: nib.nwkUpdateId,
168
- coordinatorIeeeAddress: ieeeAddress,
169
- devices: addressManagerTable && addressManagerTable.used.map((ame, ami) => {
170
- /* take all entries of assoc and/or security type */
171
- if (!ame.isSet() || (ame.user & (structs_1.AddressManagerUser.Assoc | structs_1.AddressManagerUser.Security)) === 0) {
172
- /* istanbul ignore next */
173
- return null;
174
- }
175
- let linkKeyInfo = null;
176
- const sme = securityManagerTable.used.find(e => e.ami === ami);
177
- if (sme) {
178
- const apsKeyDataIndex = version === tstype_1.ZnpVersion.zStack30x ? sme.keyNvId - common_1.NvItemsIds.APS_LINK_KEY_DATA_START : sme.keyNvId;
179
- const apsKeyData = apsLinkKeyDataTable.used[apsKeyDataIndex] || null;
180
- if (apsKeyData) {
181
- linkKeyInfo = {
182
- key: apsKeyData.key,
183
- rxCounter: apsKeyData.rxFrmCntr,
184
- txCounter: apsKeyData.txFrmCntr
185
- };
186
- }
187
- }
188
- else {
189
- const tclkTableEntry = tclkTable.used.find(e => e.extAddr.equals(ame.extAddr));
190
- if (tclkTableEntry) {
191
- const rotatedSeed = Buffer.concat([tclkSeed.key.slice(tclkTableEntry.SeedShift_IcIndex), tclkSeed.key.slice(0, tclkTableEntry.SeedShift_IcIndex)]);
192
- const extAddrReversed = Buffer.from(ame.extAddr).reverse();
193
- const extAddrRepeated = Buffer.concat([extAddrReversed, extAddrReversed]);
194
- const derivedKey = Buffer.alloc(16);
195
- for (let i = 0; i < 16; i++) {
196
- derivedKey[i] = rotatedSeed[i] ^ extAddrRepeated[i];
197
- }
198
- linkKeyInfo = {
199
- key: derivedKey,
200
- rxCounter: tclkTableEntry.rxFrmCntr,
201
- txCounter: tclkTableEntry.txFrmCntr
202
- };
203
- }
204
- }
205
- return {
206
- networkAddress: ame.nwkAddr,
207
- ieeeAddress: ame.extAddr,
208
- isDirectChild: (ame.user & structs_1.AddressManagerUser.Assoc) > 0,
209
- linkKey: !linkKeyInfo ? undefined : linkKeyInfo
210
- };
211
- }).filter(e => e) || []
212
- };
213
- try {
214
- /**
215
- * Due to a bug in ZStack, some devices go missing from the backed-up device tables which makes them disappear from the backup.
216
- * This causes the devices not to be restored when e.g. re-flashing the adapter.
217
- * If you then try to join a new device via a Zigbee 3.0 router that went missing (those with a linkkey), joining fails as the coordinator
218
- * does not have the linkKey anymore.
219
- * Below we don't remove any devices from the backup which have a linkkey and are still in the database (=ieeeAddressesInDatabase)
220
- */
221
- const oldBackup = await this.getStoredBackup();
222
- const missing = oldBackup.devices.filter((d) => d.linkKey && ieeeAddressesInDatabase.includes(`0x${d.ieeeAddress.toString("hex")}`) &&
223
- !backup.devices.find((dd) => d.ieeeAddress.equals(dd.ieeeAddress)));
224
- const missingStr = missing.map((d) => `0x${d.ieeeAddress.toString('hex')}`).join(', ');
225
- this.debug(`Following devices with link key are missing from new backup but present in old backup and database, ` +
226
- `adding them back: ${missingStr}`);
227
- backup.devices = [...backup.devices, ...missing];
228
- }
229
- catch (error) {
230
- this.debug(`Failed to read old backup, not checking for missing routers: ${error}`);
231
- }
232
- return backup;
233
- }
234
- /**
235
- * Restores a structure in internal backup format to connected ZNP adapter.
236
- *
237
- * @param backup Backup to restore to connected adapter.
238
- */
239
- async restoreBackup(backup) {
240
- var _a, _b;
241
- this.debug("restoring backup");
242
- const version = await this.getAdapterVersion();
243
- /* istanbul ignore next */
244
- if (version === tstype_1.ZnpVersion.zStack12) {
245
- throw new Error("backup cannot be restored on Z-Stack 1.2 adapter");
246
- }
247
- /* fetch provisional NIB */
248
- const nib = await this.nv.readItem(common_1.NvItemsIds.NIB, 0, Structs.nib);
249
- /* update NIB with desired nwk config */
250
- nib.nwkPanId = backup.networkOptions.panId;
251
- nib.channelList = Utils.packChannelList(backup.networkOptions.channelList);
252
- nib.nwkLogicalChannel = backup.networkOptions.channelList[0];
253
- nib.extendedPANID = backup.networkOptions.extendedPanId;
254
- nib.SecurityLevel = backup.securityLevel;
255
- nib.nwkUpdateId = backup.networkUpdateId;
256
- /* prepare key info */
257
- const keyDescriptor = Structs.nwkKeyDescriptor();
258
- keyDescriptor.keySeqNum = backup.networkKeyInfo.sequenceNumber || 0;
259
- keyDescriptor.key = backup.networkOptions.networkKey;
260
- /* determine table sizes */
261
- const currentAddressManagerTable = await this.getAddressManagerTable(version);
262
- const currentSecurityManagerTable = await this.getSecurityManagerTable();
263
- const currentApsLinkKeyDataTable = await this.getApsLinkKeyDataTable(version);
264
- const currentTclkTable = await this.getTclkTable(version);
265
- const currentNwkSecMaterialTable = await this.getNetworkSecurityMaterialTable(version);
266
- this.debug(`got target adapter table sizes:`);
267
- this.debug(` - address manager table: ${currentAddressManagerTable.capacity}`);
268
- this.debug(` - security manager table: ${currentSecurityManagerTable.capacity}`);
269
- this.debug(` - aps link key data table: ${currentApsLinkKeyDataTable.capacity}`);
270
- this.debug(` - tclk table: ${currentTclkTable.capacity}`);
271
- this.debug(` - network security material table: ${currentNwkSecMaterialTable.capacity}`);
272
- /* prepare table structures */
273
- const addressManagerTable = Structs.addressManagerTable(currentAddressManagerTable.capacity);
274
- const securityManagerTable = Structs.securityManagerTable(currentSecurityManagerTable.capacity);
275
- const apsLinkKeyDataTable = Structs.apsLinkKeyDataTable(currentApsLinkKeyDataTable.capacity);
276
- const tclkTable = Structs.apsTcLinkKeyTable(currentTclkTable.capacity);
277
- const nwkSecurityMaterialTable = Structs.nwkSecMaterialDescriptorTable(currentNwkSecMaterialTable.capacity);
278
- /* prepare security material table (nwk frame counters) */
279
- const mwkSecMaterialEntry = nwkSecurityMaterialTable.entries[0];
280
- mwkSecMaterialEntry.extendedPanID = backup.networkOptions.extendedPanId;
281
- mwkSecMaterialEntry.FrameCounter = backup.networkKeyInfo.frameCounter + 2500;
282
- const genericNwkSecMaterialEntry = nwkSecurityMaterialTable.entries[nwkSecurityMaterialTable.capacity - 1];
283
- genericNwkSecMaterialEntry.extendedPanID = Buffer.alloc(8, 0xff);
284
- genericNwkSecMaterialEntry.FrameCounter = backup.networkKeyInfo.frameCounter + 2500;
285
- /* populate device & security tables and write them */
286
- for (const device of backup.devices) {
287
- const ame = addressManagerTable.getNextFree();
288
- ame.nwkAddr = device.networkAddress;
289
- ame.extAddr = device.ieeeAddress;
290
- ame.user = device.isDirectChild ? structs_1.AddressManagerUser.Assoc : structs_1.AddressManagerUser.Default;
291
- if (device.linkKey) {
292
- let linkKeyProcessed = false;
293
- /* attempt to recover tclk seed parameters (if available) */
294
- if ((_a = backup.znp) === null || _a === void 0 ? void 0 : _a.trustCenterLinkKeySeed) {
295
- const tclkSeed = backup.znp.trustCenterLinkKeySeed;
296
- const extAddrReversed = Buffer.from(ame.extAddr).reverse();
297
- const extAddrRepeated = Buffer.concat([extAddrReversed, extAddrReversed]);
298
- const recoveredKey = Buffer.alloc(16);
299
- for (let i = 0; i < 16; i++) {
300
- recoveredKey[i] = device.linkKey.key[i] ^ extAddrRepeated[i];
301
- }
302
- let recoveredSeedShift = null;
303
- for (let i = 0; i < 16; i++) {
304
- const rotated = Buffer.concat([recoveredKey.slice(recoveredKey.length - i, recoveredKey.length), recoveredKey.slice(0, recoveredKey.length - i)]);
305
- if (rotated.equals(tclkSeed)) {
306
- recoveredSeedShift = i;
307
- break;
308
- }
309
- }
310
- if (recoveredSeedShift !== null) {
311
- ame.user |= structs_1.AddressManagerUser.Security;
312
- const tclkEntry = tclkTable.getNextFree();
313
- if (!tclkEntry) {
314
- throw new Error(`target adapter tclk table size insufficient (size=${tclkTable.capacity})`);
315
- }
316
- tclkEntry.extAddr = ame.extAddr;
317
- tclkEntry.SeedShift_IcIndex = recoveredSeedShift;
318
- tclkEntry.keyAttributes = 2;
319
- tclkEntry.keyType = 0;
320
- tclkEntry.rxFrmCntr = device.linkKey.rxCounter;
321
- tclkEntry.txFrmCntr = device.linkKey.txCounter + 2500;
322
- linkKeyProcessed = true;
323
- this.debug(`successfully recovered link key for ${device.ieeeAddress.toString("hex")} using tclk seed (shift=${recoveredSeedShift})`);
324
- }
325
- }
326
- /* attempt to create aps link key data entry */
327
- if (!linkKeyProcessed) {
328
- ame.user |= structs_1.AddressManagerUser.Security;
329
- const apsKeyDataEntry = apsLinkKeyDataTable.getNextFree();
330
- if (!apsKeyDataEntry) {
331
- throw new Error(`target adapter aps link key data table size insufficient (size=${apsLinkKeyDataTable.capacity})`);
332
- }
333
- apsKeyDataEntry.key = device.linkKey.key;
334
- apsKeyDataEntry.rxFrmCntr = device.linkKey.rxCounter;
335
- apsKeyDataEntry.txFrmCntr = device.linkKey.txCounter + 2500;
336
- const sme = securityManagerTable.getNextFree();
337
- if (!sme) {
338
- throw new Error(`target adapter security manager table size insufficient (size=${securityManagerTable.capacity})`);
339
- }
340
- sme.ami = addressManagerTable.indexOf(ame);
341
- sme.keyNvId = version === tstype_1.ZnpVersion.zStack3x0 ? apsLinkKeyDataTable.indexOf(apsKeyDataEntry) : common_1.NvItemsIds.APS_LINK_KEY_DATA_START + apsLinkKeyDataTable.indexOf(apsKeyDataEntry);
342
- sme.authenticationOption = structs_1.SecurityManagerAuthenticationOption.AuthenticatedCBCK;
343
- linkKeyProcessed = true;
344
- this.debug(`successfully recovered link key for ${device.ieeeAddress.toString("hex")} using aps key data table`);
345
- }
346
- }
347
- }
348
- /* recover coordinator ieee address */
349
- const reversedAdapterIeee = Buffer.from(backup.coordinatorIeeeAddress).reverse();
350
- await this.nv.writeItem(common_1.NvItemsIds.EXTADDR, reversedAdapterIeee);
351
- /* write updated nib */
352
- await this.nv.writeItem(common_1.NvItemsIds.NIB, nib);
353
- /* write network key info */
354
- await this.nv.updateItem(common_1.NvItemsIds.NWK_ACTIVE_KEY_INFO, keyDescriptor.serialize());
355
- await this.nv.updateItem(common_1.NvItemsIds.NWK_ALTERN_KEY_INFO, keyDescriptor.serialize());
356
- /* write tclk seed if present */
357
- if ((_b = backup.znp) === null || _b === void 0 ? void 0 : _b.trustCenterLinkKeySeed) {
358
- await this.nv.writeItem(common_1.NvItemsIds.TCLK_SEED, backup.znp.trustCenterLinkKeySeed);
359
- }
360
- /* write network security material table (nwk frame counters) */
361
- if (version === tstype_1.ZnpVersion.zStack3x0) {
362
- await this.nv.writeTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.EX_NWK_SEC_MATERIAL_TABLE, nwkSecurityMaterialTable);
363
- }
364
- else {
365
- await this.nv.writeTable("legacy", common_1.NvItemsIds.LEGACY_NWK_SEC_MATERIAL_TABLE_START, nwkSecurityMaterialTable);
366
- }
367
- /* write address manager table */
368
- if (version === tstype_1.ZnpVersion.zStack3x0) {
369
- await this.nv.writeTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.ZCD_NV_EX_ADDRMGR, addressManagerTable);
370
- }
371
- else {
372
- await this.nv.writeItem(common_1.NvItemsIds.ADDRMGR, addressManagerTable);
373
- }
374
- /* write security manager table */
375
- await this.nv.writeItem(common_1.NvItemsIds.APS_LINK_KEY_TABLE, securityManagerTable);
376
- /* write aps link key data table */
377
- if (version === tstype_1.ZnpVersion.zStack3x0) {
378
- await this.nv.writeTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.ZCD_NV_EX_APS_KEY_DATA_TABLE, apsLinkKeyDataTable);
379
- }
380
- else {
381
- await this.nv.writeTable("legacy", common_1.NvItemsIds.APS_LINK_KEY_DATA_START, apsLinkKeyDataTable);
382
- }
383
- /* write tclk table */
384
- if (version === tstype_1.ZnpVersion.zStack3x0) {
385
- await this.nv.writeTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.EX_TCLK_TABLE, tclkTable);
386
- }
387
- else {
388
- await this.nv.writeTable("legacy", common_1.NvItemsIds.LEGACY_TCLK_TABLE_START, tclkTable);
389
- }
390
- }
391
- /**
392
- * Acquires ZNP version internal to `zigbee-herdsman` from controller.
393
- *
394
- * *If Z-Stack 1.2 controller is detected an error is thrown, since Z-Stack 1.2 backup
395
- * and restore procedures are not supported.*
396
- */
397
- async getAdapterVersion() {
398
- const versionResponse = await this.znp.request(constants_1.Subsystem.SYS, "version", {});
399
- const version = versionResponse.payload.product;
400
- return version;
401
- }
402
- /**
403
- * Internal method to retrieve address manager table.
404
- *
405
- * @param version ZNP stack version the adapter is running.
406
- */
407
- async getAddressManagerTable(version) {
408
- if (version === tstype_1.ZnpVersion.zStack3x0) {
409
- return this.nv.readTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.ZCD_NV_EX_ADDRMGR, undefined, Structs.addressManagerTable);
410
- }
411
- else {
412
- return this.nv.readItem(common_1.NvItemsIds.ADDRMGR, 0, Structs.addressManagerTable);
413
- }
414
- }
415
- /**
416
- * Internal method to retrieve security manager table. Also referred to as APS Link Key Table.
417
- */
418
- async getSecurityManagerTable() {
419
- return this.nv.readItem(common_1.NvItemsIds.APS_LINK_KEY_TABLE, 0, Structs.securityManagerTable);
420
- }
421
- /**
422
- * Internal method to retrieve APS Link Key Data Table containing arbitrary APS link keys.
423
- *
424
- * @param version ZNP stack version the adapter is running.
425
- */
426
- async getApsLinkKeyDataTable(version) {
427
- if (version === tstype_1.ZnpVersion.zStack3x0) {
428
- return this.nv.readTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.ZCD_NV_EX_APS_KEY_DATA_TABLE, undefined, Structs.apsLinkKeyDataTable);
429
- }
430
- else {
431
- return this.nv.readTable("legacy", common_1.NvItemsIds.APS_LINK_KEY_DATA_START, 255, Structs.apsLinkKeyDataTable);
432
- }
433
- }
434
- /**
435
- * Internal method to retrieve Trust Center Link Key table which describes seed-based APS link keys for devices.
436
- *
437
- * @param version ZNP stack version the adapter is running.
438
- */
439
- async getTclkTable(version) {
440
- if (version === tstype_1.ZnpVersion.zStack3x0) {
441
- return this.nv.readTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.EX_TCLK_TABLE, undefined, Structs.apsTcLinkKeyTable);
442
- }
443
- else {
444
- return this.nv.readTable("legacy", common_1.NvItemsIds.LEGACY_TCLK_TABLE_START, 239, Structs.apsTcLinkKeyTable);
445
- }
446
- }
447
- /**
448
- * Internal method to retrieve network security material table, which contains network key frame counter.
449
- *
450
- * @param version ZNP stack version the adapter is running.
451
- */
452
- async getNetworkSecurityMaterialTable(version) {
453
- if (version === tstype_1.ZnpVersion.zStack3x0) {
454
- return this.nv.readTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.EX_NWK_SEC_MATERIAL_TABLE, undefined, Structs.nwkSecMaterialDescriptorTable);
455
- }
456
- else {
457
- return this.nv.readTable("legacy", common_1.NvItemsIds.LEGACY_NWK_SEC_MATERIAL_TABLE_START, 12, Structs.nwkSecMaterialDescriptorTable);
458
- }
459
- }
460
- }
461
- exports.AdapterBackup = AdapterBackup;
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.AdapterBackup = void 0;
30
+ /* eslint-disable max-len */
31
+ const debug_1 = __importDefault(require("debug"));
32
+ const Structs = __importStar(require("../structs"));
33
+ const Utils = __importStar(require("../utils"));
34
+ const utils_1 = require("../../../utils");
35
+ const mz_1 = require("mz");
36
+ const common_1 = require("../constants/common");
37
+ const constants_1 = require("../unpi/constants");
38
+ const tstype_1 = require("./tstype");
39
+ const structs_1 = require("../structs");
40
+ /**
41
+ * Class providing ZNP adapter backup and restore procedures based mostly on NV memory manipulation.
42
+ */
43
+ class AdapterBackup {
44
+ znp;
45
+ nv;
46
+ defaultPath;
47
+ debug = (0, debug_1.default)("zigbee-herdsman:adapter:zStack:startup:backup");
48
+ constructor(znp, nv, path) {
49
+ this.znp = znp;
50
+ this.nv = nv;
51
+ this.defaultPath = path;
52
+ }
53
+ /**
54
+ * Loads currently stored backup and returns it in internal backup model.
55
+ */
56
+ async getStoredBackup() {
57
+ try {
58
+ await mz_1.fs.access(this.defaultPath);
59
+ }
60
+ catch (error) {
61
+ return null;
62
+ }
63
+ let data;
64
+ try {
65
+ data = JSON.parse((await mz_1.fs.readFile(this.defaultPath)).toString());
66
+ }
67
+ catch (error) {
68
+ throw new Error('Coordinator backup is corrupted');
69
+ }
70
+ if (data.metadata?.format === "zigpy/open-coordinator-backup" && data.metadata?.version) {
71
+ if (data.metadata?.version !== 1) {
72
+ throw new Error(`Unsupported open coordinator backup version (version=${data.metadata?.version})`);
73
+ }
74
+ return utils_1.BackupUtils.fromUnifiedBackup(data);
75
+ }
76
+ else if (data.adapterType === "zStack") {
77
+ return utils_1.BackupUtils.fromLegacyBackup(data);
78
+ }
79
+ else {
80
+ throw new Error("Unknown backup format");
81
+ }
82
+ }
83
+ /**
84
+ * Creates a new backup from connected ZNP adapter and returns it in internal backup model format.
85
+ */
86
+ async createBackup(ieeeAddressesInDatabase) {
87
+ this.debug("creating backup");
88
+ const version = await this.getAdapterVersion();
89
+ /* get adapter ieee address */
90
+ const ieeeAddressResponse = await this.znp.request(constants_1.Subsystem.SYS, "getExtAddr", {});
91
+ if (!ieeeAddressResponse || !ieeeAddressResponse.payload.extaddress || !ieeeAddressResponse.payload.extaddress.startsWith("0x")) {
92
+ throw new Error("Failed to read adapter IEEE address");
93
+ }
94
+ const ieeeAddress = Buffer.from(ieeeAddressResponse.payload.extaddress.split("0x")[1], "hex");
95
+ this.debug("fetched adapter ieee address");
96
+ /* get adapter nib */
97
+ const nib = await this.nv.readItem(common_1.NvItemsIds.NIB, 0, Structs.nib);
98
+ if (!nib) {
99
+ throw new Error("Cannot backup - adapter not commissioned");
100
+ }
101
+ this.debug("fetched adapter nib");
102
+ /* get adapter active key information */
103
+ let activeKeyInfo;
104
+ if (version === tstype_1.ZnpVersion.zStack12) {
105
+ const key = Structs.nwkKey((await this.znp.request(constants_1.Subsystem.SAPI, "readConfiguration", { configid: common_1.NvItemsIds.PRECFGKEY })).payload.value);
106
+ activeKeyInfo = Structs.nwkKeyDescriptor();
107
+ activeKeyInfo.key = key.key;
108
+ }
109
+ else {
110
+ activeKeyInfo = await this.nv.readItem(common_1.NvItemsIds.NWK_ACTIVE_KEY_INFO, 0, Structs.nwkKeyDescriptor);
111
+ }
112
+ if (!activeKeyInfo) {
113
+ throw new Error("Cannot backup - missing active key info");
114
+ }
115
+ this.debug("fetched adapter active key information");
116
+ /* get adapter security data */
117
+ const preconfiguredKeyEnabled = await this.nv.readItem(common_1.NvItemsIds.PRECFGKEYS_ENABLE, 0);
118
+ this.debug("fetched adapter pre-configured key");
119
+ const addressManagerTable = await this.getAddressManagerTable(version);
120
+ this.debug(`fetched adapter address manager table (capacity=${addressManagerTable?.capacity || 0}, used=${addressManagerTable?.usedCount || 0})`);
121
+ const securityManagerTable = await this.getSecurityManagerTable();
122
+ this.debug(`fetched adapter security manager table (capacity=${securityManagerTable?.usedCount || 0}, used=${securityManagerTable?.usedCount || 0})`);
123
+ const apsLinkKeyDataTable = await this.getApsLinkKeyDataTable(version);
124
+ this.debug(`fetched adapter aps link key data table (capacity=${apsLinkKeyDataTable?.usedCount || 0}, used=${apsLinkKeyDataTable?.usedCount || 0})`);
125
+ const tclkSeed = version === tstype_1.ZnpVersion.zStack12 ? null : await this.nv.readItem(common_1.NvItemsIds.TCLK_SEED, 0, Structs.nwkKey);
126
+ this.debug("fetched adapter tclk seed");
127
+ const tclkTable = await this.getTclkTable(version);
128
+ this.debug(`fetched adapter tclk table (capacity=${tclkTable?.usedCount || 0}, used=${tclkTable?.usedCount || 0})`);
129
+ const secMaterialTable = await this.getNetworkSecurityMaterialTable(version);
130
+ this.debug(`fetched adapter network security material table (capacity=${secMaterialTable?.usedCount || 0}, used=${secMaterialTable?.usedCount || 0})`);
131
+ /* examine network security material table */
132
+ const genericExtendedPanId = Buffer.alloc(8, 0xff);
133
+ let secMaterialDescriptor = null;
134
+ /* istanbul ignore next */
135
+ for (const entry of secMaterialTable.used) {
136
+ if (entry.extendedPanID.equals(nib.extendedPANID)) {
137
+ secMaterialDescriptor = entry;
138
+ break;
139
+ }
140
+ else if (!secMaterialDescriptor && entry.extendedPanID.equals(genericExtendedPanId)) {
141
+ secMaterialDescriptor = entry;
142
+ }
143
+ }
144
+ if (!secMaterialDescriptor) {
145
+ secMaterialDescriptor = Structs.nwkSecMaterialDescriptorEntry();
146
+ secMaterialDescriptor.extendedPanID = nib.extendedPANID;
147
+ secMaterialDescriptor.FrameCounter = version === tstype_1.ZnpVersion.zStack12 ? 0 : 1250;
148
+ }
149
+ /* return backup structure */
150
+ /* istanbul ignore next */
151
+ const backup = {
152
+ znp: {
153
+ version: version,
154
+ trustCenterLinkKeySeed: tclkSeed?.key || undefined
155
+ },
156
+ networkOptions: {
157
+ panId: nib.nwkPanId,
158
+ extendedPanId: nib.extendedPANID,
159
+ channelList: Utils.unpackChannelList(nib.channelList),
160
+ networkKey: activeKeyInfo.key,
161
+ networkKeyDistribute: preconfiguredKeyEnabled && preconfiguredKeyEnabled[0] === 0x01
162
+ },
163
+ logicalChannel: nib.nwkLogicalChannel,
164
+ networkKeyInfo: {
165
+ sequenceNumber: activeKeyInfo.keySeqNum,
166
+ frameCounter: secMaterialDescriptor.FrameCounter
167
+ },
168
+ securityLevel: nib.SecurityLevel,
169
+ networkUpdateId: nib.nwkUpdateId,
170
+ coordinatorIeeeAddress: ieeeAddress,
171
+ devices: addressManagerTable && addressManagerTable.used.map((ame, ami) => {
172
+ /* take all entries of assoc and/or security type */
173
+ if (!ame.isSet() || (ame.user & (structs_1.AddressManagerUser.Assoc | structs_1.AddressManagerUser.Security)) === 0) {
174
+ /* istanbul ignore next */
175
+ return null;
176
+ }
177
+ let linkKeyInfo = null;
178
+ const sme = securityManagerTable.used.find(e => e.ami === ami);
179
+ if (sme) {
180
+ const apsKeyDataIndex = version === tstype_1.ZnpVersion.zStack30x ? sme.keyNvId - common_1.NvItemsIds.APS_LINK_KEY_DATA_START : sme.keyNvId;
181
+ const apsKeyData = apsLinkKeyDataTable.used[apsKeyDataIndex] || null;
182
+ if (apsKeyData) {
183
+ linkKeyInfo = {
184
+ key: apsKeyData.key,
185
+ rxCounter: apsKeyData.rxFrmCntr,
186
+ txCounter: apsKeyData.txFrmCntr
187
+ };
188
+ }
189
+ }
190
+ else {
191
+ const tclkTableEntry = tclkTable.used.find(e => e.extAddr.equals(ame.extAddr));
192
+ if (tclkTableEntry) {
193
+ const rotatedSeed = Buffer.concat([tclkSeed.key.slice(tclkTableEntry.SeedShift_IcIndex), tclkSeed.key.slice(0, tclkTableEntry.SeedShift_IcIndex)]);
194
+ const extAddrReversed = Buffer.from(ame.extAddr).reverse();
195
+ const extAddrRepeated = Buffer.concat([extAddrReversed, extAddrReversed]);
196
+ const derivedKey = Buffer.alloc(16);
197
+ for (let i = 0; i < 16; i++) {
198
+ derivedKey[i] = rotatedSeed[i] ^ extAddrRepeated[i];
199
+ }
200
+ linkKeyInfo = {
201
+ key: derivedKey,
202
+ rxCounter: tclkTableEntry.rxFrmCntr,
203
+ txCounter: tclkTableEntry.txFrmCntr
204
+ };
205
+ }
206
+ }
207
+ return {
208
+ networkAddress: ame.nwkAddr,
209
+ ieeeAddress: ame.extAddr,
210
+ isDirectChild: (ame.user & structs_1.AddressManagerUser.Assoc) > 0,
211
+ linkKey: !linkKeyInfo ? undefined : linkKeyInfo
212
+ };
213
+ }).filter(e => e) || []
214
+ };
215
+ try {
216
+ /**
217
+ * Due to a bug in ZStack, some devices go missing from the backed-up device tables which makes them disappear from the backup.
218
+ * This causes the devices not to be restored when e.g. re-flashing the adapter.
219
+ * If you then try to join a new device via a Zigbee 3.0 router that went missing (those with a linkkey), joining fails as the coordinator
220
+ * does not have the linkKey anymore.
221
+ * Below we don't remove any devices from the backup which have a linkkey and are still in the database (=ieeeAddressesInDatabase)
222
+ */
223
+ const oldBackup = await this.getStoredBackup();
224
+ const missing = oldBackup.devices.filter((d) => d.linkKey && ieeeAddressesInDatabase.includes(`0x${d.ieeeAddress.toString("hex")}`) &&
225
+ !backup.devices.find((dd) => d.ieeeAddress.equals(dd.ieeeAddress)));
226
+ const missingStr = missing.map((d) => `0x${d.ieeeAddress.toString('hex')}`).join(', ');
227
+ this.debug(`Following devices with link key are missing from new backup but present in old backup and database, ` +
228
+ `adding them back: ${missingStr}`);
229
+ backup.devices = [...backup.devices, ...missing];
230
+ }
231
+ catch (error) {
232
+ this.debug(`Failed to read old backup, not checking for missing routers: ${error}`);
233
+ }
234
+ return backup;
235
+ }
236
+ /**
237
+ * Restores a structure in internal backup format to connected ZNP adapter.
238
+ *
239
+ * @param backup Backup to restore to connected adapter.
240
+ */
241
+ async restoreBackup(backup) {
242
+ this.debug("restoring backup");
243
+ const version = await this.getAdapterVersion();
244
+ /* istanbul ignore next */
245
+ if (version === tstype_1.ZnpVersion.zStack12) {
246
+ throw new Error("backup cannot be restored on Z-Stack 1.2 adapter");
247
+ }
248
+ /* fetch provisional NIB */
249
+ const nib = await this.nv.readItem(common_1.NvItemsIds.NIB, 0, Structs.nib);
250
+ /* update NIB with desired nwk config */
251
+ nib.nwkPanId = backup.networkOptions.panId;
252
+ nib.channelList = Utils.packChannelList(backup.networkOptions.channelList);
253
+ nib.nwkLogicalChannel = backup.networkOptions.channelList[0];
254
+ nib.extendedPANID = backup.networkOptions.extendedPanId;
255
+ nib.SecurityLevel = backup.securityLevel;
256
+ nib.nwkUpdateId = backup.networkUpdateId;
257
+ /* prepare key info */
258
+ const keyDescriptor = Structs.nwkKeyDescriptor();
259
+ keyDescriptor.keySeqNum = backup.networkKeyInfo.sequenceNumber || 0;
260
+ keyDescriptor.key = backup.networkOptions.networkKey;
261
+ /* determine table sizes */
262
+ const currentAddressManagerTable = await this.getAddressManagerTable(version);
263
+ const currentSecurityManagerTable = await this.getSecurityManagerTable();
264
+ const currentApsLinkKeyDataTable = await this.getApsLinkKeyDataTable(version);
265
+ const currentTclkTable = await this.getTclkTable(version);
266
+ const currentNwkSecMaterialTable = await this.getNetworkSecurityMaterialTable(version);
267
+ this.debug(`got target adapter table sizes:`);
268
+ this.debug(` - address manager table: ${currentAddressManagerTable.capacity}`);
269
+ this.debug(` - security manager table: ${currentSecurityManagerTable.capacity}`);
270
+ this.debug(` - aps link key data table: ${currentApsLinkKeyDataTable.capacity}`);
271
+ this.debug(` - tclk table: ${currentTclkTable.capacity}`);
272
+ this.debug(` - network security material table: ${currentNwkSecMaterialTable.capacity}`);
273
+ /* prepare table structures */
274
+ const addressManagerTable = Structs.addressManagerTable(currentAddressManagerTable.capacity);
275
+ const securityManagerTable = Structs.securityManagerTable(currentSecurityManagerTable.capacity);
276
+ const apsLinkKeyDataTable = Structs.apsLinkKeyDataTable(currentApsLinkKeyDataTable.capacity);
277
+ const tclkTable = Structs.apsTcLinkKeyTable(currentTclkTable.capacity);
278
+ const nwkSecurityMaterialTable = Structs.nwkSecMaterialDescriptorTable(currentNwkSecMaterialTable.capacity);
279
+ /* prepare security material table (nwk frame counters) */
280
+ const mwkSecMaterialEntry = nwkSecurityMaterialTable.entries[0];
281
+ mwkSecMaterialEntry.extendedPanID = backup.networkOptions.extendedPanId;
282
+ mwkSecMaterialEntry.FrameCounter = backup.networkKeyInfo.frameCounter + 2500;
283
+ const genericNwkSecMaterialEntry = nwkSecurityMaterialTable.entries[nwkSecurityMaterialTable.capacity - 1];
284
+ genericNwkSecMaterialEntry.extendedPanID = Buffer.alloc(8, 0xff);
285
+ genericNwkSecMaterialEntry.FrameCounter = backup.networkKeyInfo.frameCounter + 2500;
286
+ /* populate device & security tables and write them */
287
+ for (const device of backup.devices) {
288
+ const ame = addressManagerTable.getNextFree();
289
+ ame.nwkAddr = device.networkAddress;
290
+ ame.extAddr = device.ieeeAddress;
291
+ ame.user = device.isDirectChild ? structs_1.AddressManagerUser.Assoc : structs_1.AddressManagerUser.Default;
292
+ if (device.linkKey) {
293
+ let linkKeyProcessed = false;
294
+ /* attempt to recover tclk seed parameters (if available) */
295
+ if (backup.znp?.trustCenterLinkKeySeed) {
296
+ const tclkSeed = backup.znp.trustCenterLinkKeySeed;
297
+ const extAddrReversed = Buffer.from(ame.extAddr).reverse();
298
+ const extAddrRepeated = Buffer.concat([extAddrReversed, extAddrReversed]);
299
+ const recoveredKey = Buffer.alloc(16);
300
+ for (let i = 0; i < 16; i++) {
301
+ recoveredKey[i] = device.linkKey.key[i] ^ extAddrRepeated[i];
302
+ }
303
+ let recoveredSeedShift = null;
304
+ for (let i = 0; i < 16; i++) {
305
+ const rotated = Buffer.concat([recoveredKey.slice(recoveredKey.length - i, recoveredKey.length), recoveredKey.slice(0, recoveredKey.length - i)]);
306
+ if (rotated.equals(tclkSeed)) {
307
+ recoveredSeedShift = i;
308
+ break;
309
+ }
310
+ }
311
+ if (recoveredSeedShift !== null) {
312
+ ame.user |= structs_1.AddressManagerUser.Security;
313
+ const tclkEntry = tclkTable.getNextFree();
314
+ if (!tclkEntry) {
315
+ throw new Error(`target adapter tclk table size insufficient (size=${tclkTable.capacity})`);
316
+ }
317
+ tclkEntry.extAddr = ame.extAddr;
318
+ tclkEntry.SeedShift_IcIndex = recoveredSeedShift;
319
+ tclkEntry.keyAttributes = 2;
320
+ tclkEntry.keyType = 0;
321
+ tclkEntry.rxFrmCntr = device.linkKey.rxCounter;
322
+ tclkEntry.txFrmCntr = device.linkKey.txCounter + 2500;
323
+ linkKeyProcessed = true;
324
+ this.debug(`successfully recovered link key for ${device.ieeeAddress.toString("hex")} using tclk seed (shift=${recoveredSeedShift})`);
325
+ }
326
+ }
327
+ /* attempt to create aps link key data entry */
328
+ if (!linkKeyProcessed) {
329
+ ame.user |= structs_1.AddressManagerUser.Security;
330
+ const apsKeyDataEntry = apsLinkKeyDataTable.getNextFree();
331
+ if (!apsKeyDataEntry) {
332
+ throw new Error(`target adapter aps link key data table size insufficient (size=${apsLinkKeyDataTable.capacity})`);
333
+ }
334
+ apsKeyDataEntry.key = device.linkKey.key;
335
+ apsKeyDataEntry.rxFrmCntr = device.linkKey.rxCounter;
336
+ apsKeyDataEntry.txFrmCntr = device.linkKey.txCounter + 2500;
337
+ const sme = securityManagerTable.getNextFree();
338
+ if (!sme) {
339
+ throw new Error(`target adapter security manager table size insufficient (size=${securityManagerTable.capacity})`);
340
+ }
341
+ sme.ami = addressManagerTable.indexOf(ame);
342
+ sme.keyNvId = version === tstype_1.ZnpVersion.zStack3x0 ? apsLinkKeyDataTable.indexOf(apsKeyDataEntry) : common_1.NvItemsIds.APS_LINK_KEY_DATA_START + apsLinkKeyDataTable.indexOf(apsKeyDataEntry);
343
+ sme.authenticationOption = structs_1.SecurityManagerAuthenticationOption.AuthenticatedCBCK;
344
+ linkKeyProcessed = true;
345
+ this.debug(`successfully recovered link key for ${device.ieeeAddress.toString("hex")} using aps key data table`);
346
+ }
347
+ }
348
+ }
349
+ /* recover coordinator ieee address */
350
+ const reversedAdapterIeee = Buffer.from(backup.coordinatorIeeeAddress).reverse();
351
+ await this.nv.writeItem(common_1.NvItemsIds.EXTADDR, reversedAdapterIeee);
352
+ /* write updated nib */
353
+ await this.nv.writeItem(common_1.NvItemsIds.NIB, nib);
354
+ /* write network key info */
355
+ await this.nv.updateItem(common_1.NvItemsIds.NWK_ACTIVE_KEY_INFO, keyDescriptor.serialize());
356
+ await this.nv.updateItem(common_1.NvItemsIds.NWK_ALTERN_KEY_INFO, keyDescriptor.serialize());
357
+ /* write tclk seed if present */
358
+ if (backup.znp?.trustCenterLinkKeySeed) {
359
+ await this.nv.writeItem(common_1.NvItemsIds.TCLK_SEED, backup.znp.trustCenterLinkKeySeed);
360
+ }
361
+ /* write network security material table (nwk frame counters) */
362
+ if (version === tstype_1.ZnpVersion.zStack3x0) {
363
+ await this.nv.writeTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.EX_NWK_SEC_MATERIAL_TABLE, nwkSecurityMaterialTable);
364
+ }
365
+ else {
366
+ await this.nv.writeTable("legacy", common_1.NvItemsIds.LEGACY_NWK_SEC_MATERIAL_TABLE_START, nwkSecurityMaterialTable);
367
+ }
368
+ /* write address manager table */
369
+ if (version === tstype_1.ZnpVersion.zStack3x0) {
370
+ await this.nv.writeTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.ZCD_NV_EX_ADDRMGR, addressManagerTable);
371
+ }
372
+ else {
373
+ await this.nv.writeItem(common_1.NvItemsIds.ADDRMGR, addressManagerTable);
374
+ }
375
+ /* write security manager table */
376
+ await this.nv.writeItem(common_1.NvItemsIds.APS_LINK_KEY_TABLE, securityManagerTable);
377
+ /* write aps link key data table */
378
+ if (version === tstype_1.ZnpVersion.zStack3x0) {
379
+ await this.nv.writeTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.ZCD_NV_EX_APS_KEY_DATA_TABLE, apsLinkKeyDataTable);
380
+ }
381
+ else {
382
+ await this.nv.writeTable("legacy", common_1.NvItemsIds.APS_LINK_KEY_DATA_START, apsLinkKeyDataTable);
383
+ }
384
+ /* write tclk table */
385
+ if (version === tstype_1.ZnpVersion.zStack3x0) {
386
+ await this.nv.writeTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.EX_TCLK_TABLE, tclkTable);
387
+ }
388
+ else {
389
+ await this.nv.writeTable("legacy", common_1.NvItemsIds.LEGACY_TCLK_TABLE_START, tclkTable);
390
+ }
391
+ }
392
+ /**
393
+ * Acquires ZNP version internal to `zigbee-herdsman` from controller.
394
+ *
395
+ * *If Z-Stack 1.2 controller is detected an error is thrown, since Z-Stack 1.2 backup
396
+ * and restore procedures are not supported.*
397
+ */
398
+ async getAdapterVersion() {
399
+ const versionResponse = await this.znp.request(constants_1.Subsystem.SYS, "version", {});
400
+ const version = versionResponse.payload.product;
401
+ return version;
402
+ }
403
+ /**
404
+ * Internal method to retrieve address manager table.
405
+ *
406
+ * @param version ZNP stack version the adapter is running.
407
+ */
408
+ async getAddressManagerTable(version) {
409
+ if (version === tstype_1.ZnpVersion.zStack3x0) {
410
+ return this.nv.readTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.ZCD_NV_EX_ADDRMGR, undefined, Structs.addressManagerTable);
411
+ }
412
+ else {
413
+ return this.nv.readItem(common_1.NvItemsIds.ADDRMGR, 0, Structs.addressManagerTable);
414
+ }
415
+ }
416
+ /**
417
+ * Internal method to retrieve security manager table. Also referred to as APS Link Key Table.
418
+ */
419
+ async getSecurityManagerTable() {
420
+ return this.nv.readItem(common_1.NvItemsIds.APS_LINK_KEY_TABLE, 0, Structs.securityManagerTable);
421
+ }
422
+ /**
423
+ * Internal method to retrieve APS Link Key Data Table containing arbitrary APS link keys.
424
+ *
425
+ * @param version ZNP stack version the adapter is running.
426
+ */
427
+ async getApsLinkKeyDataTable(version) {
428
+ if (version === tstype_1.ZnpVersion.zStack3x0) {
429
+ return this.nv.readTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.ZCD_NV_EX_APS_KEY_DATA_TABLE, undefined, Structs.apsLinkKeyDataTable);
430
+ }
431
+ else {
432
+ return this.nv.readTable("legacy", common_1.NvItemsIds.APS_LINK_KEY_DATA_START, 255, Structs.apsLinkKeyDataTable);
433
+ }
434
+ }
435
+ /**
436
+ * Internal method to retrieve Trust Center Link Key table which describes seed-based APS link keys for devices.
437
+ *
438
+ * @param version ZNP stack version the adapter is running.
439
+ */
440
+ async getTclkTable(version) {
441
+ if (version === tstype_1.ZnpVersion.zStack3x0) {
442
+ return this.nv.readTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.EX_TCLK_TABLE, undefined, Structs.apsTcLinkKeyTable);
443
+ }
444
+ else {
445
+ return this.nv.readTable("legacy", common_1.NvItemsIds.LEGACY_TCLK_TABLE_START, 239, Structs.apsTcLinkKeyTable);
446
+ }
447
+ }
448
+ /**
449
+ * Internal method to retrieve network security material table, which contains network key frame counter.
450
+ *
451
+ * @param version ZNP stack version the adapter is running.
452
+ */
453
+ async getNetworkSecurityMaterialTable(version) {
454
+ if (version === tstype_1.ZnpVersion.zStack3x0) {
455
+ return this.nv.readTable("extended", common_1.NvSystemIds.ZSTACK, common_1.NvItemsIds.EX_NWK_SEC_MATERIAL_TABLE, undefined, Structs.nwkSecMaterialDescriptorTable);
456
+ }
457
+ else {
458
+ return this.nv.readTable("legacy", common_1.NvItemsIds.LEGACY_NWK_SEC_MATERIAL_TABLE_START, 12, Structs.nwkSecMaterialDescriptorTable);
459
+ }
460
+ }
461
+ }
462
+ exports.AdapterBackup = AdapterBackup;
462
463
  //# sourceMappingURL=adapter-backup.js.map