matterbridge 3.4.7 → 3.5.0-dev-20260113-29ad318

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 (449) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/broadcastServer.d.ts +0 -115
  3. package/dist/broadcastServer.js +0 -117
  4. package/dist/broadcastServerTypes.d.ts +0 -43
  5. package/dist/broadcastServerTypes.js +0 -24
  6. package/dist/cli.d.ts +0 -24
  7. package/dist/cli.js +1 -97
  8. package/dist/cliEmitter.d.ts +0 -36
  9. package/dist/cliEmitter.js +0 -37
  10. package/dist/cliHistory.d.ts +0 -42
  11. package/dist/cliHistory.js +0 -38
  12. package/dist/clusters/export.d.ts +0 -1
  13. package/dist/clusters/export.js +0 -2
  14. package/dist/deviceManager.d.ts +0 -108
  15. package/dist/deviceManager.js +1 -113
  16. package/dist/devices/airConditioner.d.ts +0 -75
  17. package/dist/devices/airConditioner.js +0 -57
  18. package/dist/devices/batteryStorage.d.ts +0 -43
  19. package/dist/devices/batteryStorage.js +1 -48
  20. package/dist/devices/cooktop.d.ts +0 -55
  21. package/dist/devices/cooktop.js +0 -56
  22. package/dist/devices/dishwasher.d.ts +0 -55
  23. package/dist/devices/dishwasher.js +0 -57
  24. package/dist/devices/evse.d.ts +0 -57
  25. package/dist/devices/evse.js +10 -74
  26. package/dist/devices/export.d.ts +0 -1
  27. package/dist/devices/export.js +0 -5
  28. package/dist/devices/extractorHood.d.ts +0 -41
  29. package/dist/devices/extractorHood.js +0 -43
  30. package/dist/devices/heatPump.d.ts +0 -43
  31. package/dist/devices/heatPump.js +2 -50
  32. package/dist/devices/laundryDryer.d.ts +0 -58
  33. package/dist/devices/laundryDryer.js +3 -62
  34. package/dist/devices/laundryWasher.d.ts +0 -64
  35. package/dist/devices/laundryWasher.js +4 -70
  36. package/dist/devices/microwaveOven.d.ts +1 -77
  37. package/dist/devices/microwaveOven.js +5 -88
  38. package/dist/devices/oven.d.ts +0 -82
  39. package/dist/devices/oven.js +0 -85
  40. package/dist/devices/refrigerator.d.ts +0 -100
  41. package/dist/devices/refrigerator.js +0 -102
  42. package/dist/devices/roboticVacuumCleaner.d.ts +0 -83
  43. package/dist/devices/roboticVacuumCleaner.js +9 -100
  44. package/dist/devices/solarPower.d.ts +0 -36
  45. package/dist/devices/solarPower.js +0 -38
  46. package/dist/devices/speaker.d.ts +0 -79
  47. package/dist/devices/speaker.js +0 -84
  48. package/dist/devices/temperatureControl.d.ts +0 -21
  49. package/dist/devices/temperatureControl.js +3 -24
  50. package/dist/devices/waterHeater.d.ts +0 -74
  51. package/dist/devices/waterHeater.js +2 -82
  52. package/dist/dgram/coap.d.ts +0 -171
  53. package/dist/dgram/coap.js +13 -126
  54. package/dist/dgram/dgram.d.ts +0 -99
  55. package/dist/dgram/dgram.js +2 -114
  56. package/dist/dgram/mb_coap.d.ts +0 -23
  57. package/dist/dgram/mb_coap.js +3 -41
  58. package/dist/dgram/mb_mdns.d.ts +0 -23
  59. package/dist/dgram/mb_mdns.js +24 -80
  60. package/dist/dgram/mdns.d.ts +4 -187
  61. package/dist/dgram/mdns.js +139 -371
  62. package/dist/dgram/multicast.d.ts +0 -49
  63. package/dist/dgram/multicast.js +1 -62
  64. package/dist/dgram/unicast.d.ts +0 -53
  65. package/dist/dgram/unicast.js +0 -60
  66. package/dist/frontend.d.ts +0 -187
  67. package/dist/frontend.js +38 -485
  68. package/dist/frontendTypes.d.ts +0 -57
  69. package/dist/frontendTypes.js +0 -45
  70. package/dist/helpers.d.ts +0 -43
  71. package/dist/helpers.js +0 -53
  72. package/dist/index.d.ts +0 -23
  73. package/dist/index.js +0 -25
  74. package/dist/jestutils/export.d.ts +0 -1
  75. package/dist/jestutils/export.js +0 -1
  76. package/dist/jestutils/jestHelpers.d.ts +0 -255
  77. package/dist/jestutils/jestHelpers.js +14 -371
  78. package/dist/logger/export.d.ts +0 -1
  79. package/dist/logger/export.js +0 -1
  80. package/dist/matter/behaviors.d.ts +0 -1
  81. package/dist/matter/behaviors.js +0 -2
  82. package/dist/matter/clusters.d.ts +0 -1
  83. package/dist/matter/clusters.js +0 -2
  84. package/dist/matter/devices.d.ts +0 -1
  85. package/dist/matter/devices.js +0 -2
  86. package/dist/matter/endpoints.d.ts +0 -1
  87. package/dist/matter/endpoints.js +0 -2
  88. package/dist/matter/export.d.ts +0 -1
  89. package/dist/matter/export.js +0 -3
  90. package/dist/matter/types.d.ts +0 -1
  91. package/dist/matter/types.js +0 -3
  92. package/dist/matterNode.d.ts +0 -258
  93. package/dist/matterNode.js +8 -369
  94. package/dist/matterbridge.d.ts +0 -353
  95. package/dist/matterbridge.js +46 -824
  96. package/dist/matterbridgeAccessoryPlatform.d.ts +0 -36
  97. package/dist/matterbridgeAccessoryPlatform.js +0 -38
  98. package/dist/matterbridgeBehaviors.d.ts +0 -24
  99. package/dist/matterbridgeBehaviors.js +5 -68
  100. package/dist/matterbridgeDeviceTypes.d.ts +0 -603
  101. package/dist/matterbridgeDeviceTypes.js +14 -635
  102. package/dist/matterbridgeDynamicPlatform.d.ts +0 -36
  103. package/dist/matterbridgeDynamicPlatform.js +0 -38
  104. package/dist/matterbridgeEndpoint.d.ts +0 -1332
  105. package/dist/matterbridgeEndpoint.js +53 -1457
  106. package/dist/matterbridgeEndpointHelpers.d.ts +0 -425
  107. package/dist/matterbridgeEndpointHelpers.js +20 -483
  108. package/dist/matterbridgeEndpointTypes.d.ts +0 -70
  109. package/dist/matterbridgeEndpointTypes.js +0 -25
  110. package/dist/matterbridgePlatform.d.ts +0 -425
  111. package/dist/matterbridgePlatform.js +1 -451
  112. package/dist/matterbridgeTypes.d.ts +0 -46
  113. package/dist/matterbridgeTypes.js +0 -26
  114. package/dist/pluginManager.d.ts +0 -305
  115. package/dist/pluginManager.js +5 -341
  116. package/dist/shelly.d.ts +0 -157
  117. package/dist/shelly.js +7 -178
  118. package/dist/storage/export.d.ts +0 -1
  119. package/dist/storage/export.js +0 -1
  120. package/dist/update.d.ts +0 -75
  121. package/dist/update.js +1 -93
  122. package/dist/utils/colorUtils.d.ts +0 -77
  123. package/dist/utils/colorUtils.js +2 -97
  124. package/dist/utils/commandLine.d.ts +0 -60
  125. package/dist/utils/commandLine.js +0 -60
  126. package/dist/utils/copyDirectory.d.ts +0 -33
  127. package/dist/utils/copyDirectory.js +0 -37
  128. package/dist/utils/createDirectory.d.ts +0 -32
  129. package/dist/utils/createDirectory.js +0 -33
  130. package/dist/utils/createZip.d.ts +0 -38
  131. package/dist/utils/createZip.js +2 -47
  132. package/dist/utils/deepCopy.d.ts +0 -31
  133. package/dist/utils/deepCopy.js +0 -39
  134. package/dist/utils/deepEqual.d.ts +0 -53
  135. package/dist/utils/deepEqual.js +1 -72
  136. package/dist/utils/error.d.ts +0 -42
  137. package/dist/utils/error.js +0 -42
  138. package/dist/utils/export.d.ts +0 -1
  139. package/dist/utils/export.js +0 -1
  140. package/dist/utils/format.d.ts +0 -49
  141. package/dist/utils/format.js +0 -49
  142. package/dist/utils/hex.d.ts +0 -85
  143. package/dist/utils/hex.js +0 -124
  144. package/dist/utils/inspector.d.ts +0 -63
  145. package/dist/utils/inspector.js +1 -69
  146. package/dist/utils/isValid.d.ts +0 -93
  147. package/dist/utils/isValid.js +0 -93
  148. package/dist/utils/network.d.ts +0 -116
  149. package/dist/utils/network.js +5 -126
  150. package/dist/utils/spawn.d.ts +0 -32
  151. package/dist/utils/spawn.js +1 -71
  152. package/dist/utils/tracker.d.ts +0 -56
  153. package/dist/utils/tracker.js +1 -64
  154. package/dist/utils/wait.d.ts +0 -51
  155. package/dist/utils/wait.js +8 -60
  156. package/dist/workerGlobalPrefix.d.ts +0 -24
  157. package/dist/workerGlobalPrefix.js +5 -37
  158. package/dist/workerTypes.d.ts +0 -25
  159. package/dist/workerTypes.js +0 -24
  160. package/dist/workers.d.ts +0 -61
  161. package/dist/workers.js +4 -68
  162. package/npm-shrinkwrap.json +1500 -11420
  163. package/package.json +10 -7
  164. package/dist/broadcastServer.d.ts.map +0 -1
  165. package/dist/broadcastServer.js.map +0 -1
  166. package/dist/broadcastServerTypes.d.ts.map +0 -1
  167. package/dist/broadcastServerTypes.js.map +0 -1
  168. package/dist/cli.d.ts.map +0 -1
  169. package/dist/cli.js.map +0 -1
  170. package/dist/cliEmitter.d.ts.map +0 -1
  171. package/dist/cliEmitter.js.map +0 -1
  172. package/dist/cliHistory.d.ts.map +0 -1
  173. package/dist/cliHistory.js.map +0 -1
  174. package/dist/clusters/export.d.ts.map +0 -1
  175. package/dist/clusters/export.js.map +0 -1
  176. package/dist/deviceManager.d.ts.map +0 -1
  177. package/dist/deviceManager.js.map +0 -1
  178. package/dist/devices/airConditioner.d.ts.map +0 -1
  179. package/dist/devices/airConditioner.js.map +0 -1
  180. package/dist/devices/batteryStorage.d.ts.map +0 -1
  181. package/dist/devices/batteryStorage.js.map +0 -1
  182. package/dist/devices/cooktop.d.ts.map +0 -1
  183. package/dist/devices/cooktop.js.map +0 -1
  184. package/dist/devices/dishwasher.d.ts.map +0 -1
  185. package/dist/devices/dishwasher.js.map +0 -1
  186. package/dist/devices/evse.d.ts.map +0 -1
  187. package/dist/devices/evse.js.map +0 -1
  188. package/dist/devices/export.d.ts.map +0 -1
  189. package/dist/devices/export.js.map +0 -1
  190. package/dist/devices/extractorHood.d.ts.map +0 -1
  191. package/dist/devices/extractorHood.js.map +0 -1
  192. package/dist/devices/heatPump.d.ts.map +0 -1
  193. package/dist/devices/heatPump.js.map +0 -1
  194. package/dist/devices/laundryDryer.d.ts.map +0 -1
  195. package/dist/devices/laundryDryer.js.map +0 -1
  196. package/dist/devices/laundryWasher.d.ts.map +0 -1
  197. package/dist/devices/laundryWasher.js.map +0 -1
  198. package/dist/devices/microwaveOven.d.ts.map +0 -1
  199. package/dist/devices/microwaveOven.js.map +0 -1
  200. package/dist/devices/oven.d.ts.map +0 -1
  201. package/dist/devices/oven.js.map +0 -1
  202. package/dist/devices/refrigerator.d.ts.map +0 -1
  203. package/dist/devices/refrigerator.js.map +0 -1
  204. package/dist/devices/roboticVacuumCleaner.d.ts.map +0 -1
  205. package/dist/devices/roboticVacuumCleaner.js.map +0 -1
  206. package/dist/devices/solarPower.d.ts.map +0 -1
  207. package/dist/devices/solarPower.js.map +0 -1
  208. package/dist/devices/speaker.d.ts.map +0 -1
  209. package/dist/devices/speaker.js.map +0 -1
  210. package/dist/devices/temperatureControl.d.ts.map +0 -1
  211. package/dist/devices/temperatureControl.js.map +0 -1
  212. package/dist/devices/waterHeater.d.ts.map +0 -1
  213. package/dist/devices/waterHeater.js.map +0 -1
  214. package/dist/dgram/coap.d.ts.map +0 -1
  215. package/dist/dgram/coap.js.map +0 -1
  216. package/dist/dgram/dgram.d.ts.map +0 -1
  217. package/dist/dgram/dgram.js.map +0 -1
  218. package/dist/dgram/mb_coap.d.ts.map +0 -1
  219. package/dist/dgram/mb_coap.js.map +0 -1
  220. package/dist/dgram/mb_mdns.d.ts.map +0 -1
  221. package/dist/dgram/mb_mdns.js.map +0 -1
  222. package/dist/dgram/mdns.d.ts.map +0 -1
  223. package/dist/dgram/mdns.js.map +0 -1
  224. package/dist/dgram/multicast.d.ts.map +0 -1
  225. package/dist/dgram/multicast.js.map +0 -1
  226. package/dist/dgram/unicast.d.ts.map +0 -1
  227. package/dist/dgram/unicast.js.map +0 -1
  228. package/dist/frontend.d.ts.map +0 -1
  229. package/dist/frontend.js.map +0 -1
  230. package/dist/frontendTypes.d.ts.map +0 -1
  231. package/dist/frontendTypes.js.map +0 -1
  232. package/dist/helpers.d.ts.map +0 -1
  233. package/dist/helpers.js.map +0 -1
  234. package/dist/index.d.ts.map +0 -1
  235. package/dist/index.js.map +0 -1
  236. package/dist/jestutils/export.d.ts.map +0 -1
  237. package/dist/jestutils/export.js.map +0 -1
  238. package/dist/jestutils/jestHelpers.d.ts.map +0 -1
  239. package/dist/jestutils/jestHelpers.js.map +0 -1
  240. package/dist/logger/export.d.ts.map +0 -1
  241. package/dist/logger/export.js.map +0 -1
  242. package/dist/matter/behaviors.d.ts.map +0 -1
  243. package/dist/matter/behaviors.js.map +0 -1
  244. package/dist/matter/clusters.d.ts.map +0 -1
  245. package/dist/matter/clusters.js.map +0 -1
  246. package/dist/matter/devices.d.ts.map +0 -1
  247. package/dist/matter/devices.js.map +0 -1
  248. package/dist/matter/endpoints.d.ts.map +0 -1
  249. package/dist/matter/endpoints.js.map +0 -1
  250. package/dist/matter/export.d.ts.map +0 -1
  251. package/dist/matter/export.js.map +0 -1
  252. package/dist/matter/types.d.ts.map +0 -1
  253. package/dist/matter/types.js.map +0 -1
  254. package/dist/matterNode.d.ts.map +0 -1
  255. package/dist/matterNode.js.map +0 -1
  256. package/dist/matterbridge.d.ts.map +0 -1
  257. package/dist/matterbridge.js.map +0 -1
  258. package/dist/matterbridgeAccessoryPlatform.d.ts.map +0 -1
  259. package/dist/matterbridgeAccessoryPlatform.js.map +0 -1
  260. package/dist/matterbridgeBehaviors.d.ts.map +0 -1
  261. package/dist/matterbridgeBehaviors.js.map +0 -1
  262. package/dist/matterbridgeDeviceTypes.d.ts.map +0 -1
  263. package/dist/matterbridgeDeviceTypes.js.map +0 -1
  264. package/dist/matterbridgeDynamicPlatform.d.ts.map +0 -1
  265. package/dist/matterbridgeDynamicPlatform.js.map +0 -1
  266. package/dist/matterbridgeEndpoint.d.ts.map +0 -1
  267. package/dist/matterbridgeEndpoint.js.map +0 -1
  268. package/dist/matterbridgeEndpointHelpers.d.ts.map +0 -1
  269. package/dist/matterbridgeEndpointHelpers.js.map +0 -1
  270. package/dist/matterbridgeEndpointTypes.d.ts.map +0 -1
  271. package/dist/matterbridgeEndpointTypes.js.map +0 -1
  272. package/dist/matterbridgePlatform.d.ts.map +0 -1
  273. package/dist/matterbridgePlatform.js.map +0 -1
  274. package/dist/matterbridgeTypes.d.ts.map +0 -1
  275. package/dist/matterbridgeTypes.js.map +0 -1
  276. package/dist/pluginManager.d.ts.map +0 -1
  277. package/dist/pluginManager.js.map +0 -1
  278. package/dist/shelly.d.ts.map +0 -1
  279. package/dist/shelly.js.map +0 -1
  280. package/dist/storage/export.d.ts.map +0 -1
  281. package/dist/storage/export.js.map +0 -1
  282. package/dist/update.d.ts.map +0 -1
  283. package/dist/update.js.map +0 -1
  284. package/dist/utils/colorUtils.d.ts.map +0 -1
  285. package/dist/utils/colorUtils.js.map +0 -1
  286. package/dist/utils/commandLine.d.ts.map +0 -1
  287. package/dist/utils/commandLine.js.map +0 -1
  288. package/dist/utils/copyDirectory.d.ts.map +0 -1
  289. package/dist/utils/copyDirectory.js.map +0 -1
  290. package/dist/utils/createDirectory.d.ts.map +0 -1
  291. package/dist/utils/createDirectory.js.map +0 -1
  292. package/dist/utils/createZip.d.ts.map +0 -1
  293. package/dist/utils/createZip.js.map +0 -1
  294. package/dist/utils/deepCopy.d.ts.map +0 -1
  295. package/dist/utils/deepCopy.js.map +0 -1
  296. package/dist/utils/deepEqual.d.ts.map +0 -1
  297. package/dist/utils/deepEqual.js.map +0 -1
  298. package/dist/utils/error.d.ts.map +0 -1
  299. package/dist/utils/error.js.map +0 -1
  300. package/dist/utils/export.d.ts.map +0 -1
  301. package/dist/utils/export.js.map +0 -1
  302. package/dist/utils/format.d.ts.map +0 -1
  303. package/dist/utils/format.js.map +0 -1
  304. package/dist/utils/hex.d.ts.map +0 -1
  305. package/dist/utils/hex.js.map +0 -1
  306. package/dist/utils/inspector.d.ts.map +0 -1
  307. package/dist/utils/inspector.js.map +0 -1
  308. package/dist/utils/isValid.d.ts.map +0 -1
  309. package/dist/utils/isValid.js.map +0 -1
  310. package/dist/utils/network.d.ts.map +0 -1
  311. package/dist/utils/network.js.map +0 -1
  312. package/dist/utils/spawn.d.ts.map +0 -1
  313. package/dist/utils/spawn.js.map +0 -1
  314. package/dist/utils/tracker.d.ts.map +0 -1
  315. package/dist/utils/tracker.js.map +0 -1
  316. package/dist/utils/wait.d.ts.map +0 -1
  317. package/dist/utils/wait.js.map +0 -1
  318. package/dist/workerGlobalPrefix.d.ts.map +0 -1
  319. package/dist/workerGlobalPrefix.js.map +0 -1
  320. package/dist/workerTypes.d.ts.map +0 -1
  321. package/dist/workerTypes.js.map +0 -1
  322. package/dist/workers.d.ts.map +0 -1
  323. package/dist/workers.js.map +0 -1
  324. package/frontend/index.html +0 -15
  325. package/frontend/package-lock.json +0 -7553
  326. package/packages/dgram/LICENSE +0 -202
  327. package/packages/dgram/dist/coap.d.ts +0 -205
  328. package/packages/dgram/dist/coap.d.ts.map +0 -1
  329. package/packages/dgram/dist/coap.js +0 -365
  330. package/packages/dgram/dist/coap.js.map +0 -1
  331. package/packages/dgram/dist/dgram.d.ts +0 -144
  332. package/packages/dgram/dist/dgram.d.ts.map +0 -1
  333. package/packages/dgram/dist/dgram.js +0 -367
  334. package/packages/dgram/dist/dgram.js.map +0 -1
  335. package/packages/dgram/dist/export.d.ts +0 -6
  336. package/packages/dgram/dist/export.d.ts.map +0 -1
  337. package/packages/dgram/dist/export.js +0 -6
  338. package/packages/dgram/dist/export.js.map +0 -1
  339. package/packages/dgram/dist/mdns.d.ts +0 -371
  340. package/packages/dgram/dist/mdns.d.ts.map +0 -1
  341. package/packages/dgram/dist/mdns.js +0 -934
  342. package/packages/dgram/dist/mdns.js.map +0 -1
  343. package/packages/dgram/dist/multicast.d.ts +0 -67
  344. package/packages/dgram/dist/multicast.d.ts.map +0 -1
  345. package/packages/dgram/dist/multicast.js +0 -180
  346. package/packages/dgram/dist/multicast.js.map +0 -1
  347. package/packages/dgram/dist/unicast.d.ts +0 -64
  348. package/packages/dgram/dist/unicast.d.ts.map +0 -1
  349. package/packages/dgram/dist/unicast.js +0 -100
  350. package/packages/dgram/dist/unicast.js.map +0 -1
  351. package/packages/dgram/package.json +0 -110
  352. package/packages/jest-utils/LICENSE +0 -202
  353. package/packages/jest-utils/dist/export.d.ts +0 -2
  354. package/packages/jest-utils/dist/export.d.ts.map +0 -1
  355. package/packages/jest-utils/dist/export.js +0 -2
  356. package/packages/jest-utils/dist/export.js.map +0 -1
  357. package/packages/jest-utils/dist/jestHelpers.d.ts +0 -77
  358. package/packages/jest-utils/dist/jestHelpers.d.ts.map +0 -1
  359. package/packages/jest-utils/dist/jestHelpers.js +0 -138
  360. package/packages/jest-utils/dist/jestHelpers.js.map +0 -1
  361. package/packages/jest-utils/package.json +0 -109
  362. package/packages/utils/LICENSE +0 -202
  363. package/packages/utils/dist/colorUtils.d.ts +0 -101
  364. package/packages/utils/dist/colorUtils.d.ts.map +0 -1
  365. package/packages/utils/dist/colorUtils.js +0 -282
  366. package/packages/utils/dist/colorUtils.js.map +0 -1
  367. package/packages/utils/dist/commandLine.d.ts +0 -66
  368. package/packages/utils/dist/commandLine.d.ts.map +0 -1
  369. package/packages/utils/dist/commandLine.js +0 -123
  370. package/packages/utils/dist/commandLine.js.map +0 -1
  371. package/packages/utils/dist/copyDirectory.d.ts +0 -35
  372. package/packages/utils/dist/copyDirectory.d.ts.map +0 -1
  373. package/packages/utils/dist/copyDirectory.js +0 -76
  374. package/packages/utils/dist/copyDirectory.js.map +0 -1
  375. package/packages/utils/dist/createDirectory.d.ts +0 -34
  376. package/packages/utils/dist/createDirectory.d.ts.map +0 -1
  377. package/packages/utils/dist/createDirectory.js +0 -54
  378. package/packages/utils/dist/createDirectory.js.map +0 -1
  379. package/packages/utils/dist/createZip.d.ts +0 -39
  380. package/packages/utils/dist/createZip.d.ts.map +0 -1
  381. package/packages/utils/dist/createZip.js +0 -114
  382. package/packages/utils/dist/createZip.js.map +0 -1
  383. package/packages/utils/dist/deepCopy.d.ts +0 -32
  384. package/packages/utils/dist/deepCopy.d.ts.map +0 -1
  385. package/packages/utils/dist/deepCopy.js +0 -79
  386. package/packages/utils/dist/deepCopy.js.map +0 -1
  387. package/packages/utils/dist/deepEqual.d.ts +0 -54
  388. package/packages/utils/dist/deepEqual.d.ts.map +0 -1
  389. package/packages/utils/dist/deepEqual.js +0 -130
  390. package/packages/utils/dist/deepEqual.js.map +0 -1
  391. package/packages/utils/dist/error.d.ts +0 -45
  392. package/packages/utils/dist/error.d.ts.map +0 -1
  393. package/packages/utils/dist/error.js +0 -54
  394. package/packages/utils/dist/error.js.map +0 -1
  395. package/packages/utils/dist/export.d.ts +0 -16
  396. package/packages/utils/dist/export.d.ts.map +0 -1
  397. package/packages/utils/dist/export.js +0 -16
  398. package/packages/utils/dist/export.js.map +0 -1
  399. package/packages/utils/dist/format.d.ts +0 -53
  400. package/packages/utils/dist/format.d.ts.map +0 -1
  401. package/packages/utils/dist/format.js +0 -78
  402. package/packages/utils/dist/format.js.map +0 -1
  403. package/packages/utils/dist/githubVersion.d.ts +0 -43
  404. package/packages/utils/dist/githubVersion.d.ts.map +0 -1
  405. package/packages/utils/dist/githubVersion.js +0 -70
  406. package/packages/utils/dist/githubVersion.js.map +0 -1
  407. package/packages/utils/dist/hex.d.ts +0 -89
  408. package/packages/utils/dist/hex.d.ts.map +0 -1
  409. package/packages/utils/dist/hex.js +0 -242
  410. package/packages/utils/dist/hex.js.map +0 -1
  411. package/packages/utils/dist/inspector.d.ts +0 -87
  412. package/packages/utils/dist/inspector.d.ts.map +0 -1
  413. package/packages/utils/dist/inspector.js +0 -268
  414. package/packages/utils/dist/inspector.js.map +0 -1
  415. package/packages/utils/dist/isValid.d.ts +0 -103
  416. package/packages/utils/dist/isValid.d.ts.map +0 -1
  417. package/packages/utils/dist/isValid.js +0 -162
  418. package/packages/utils/dist/isValid.js.map +0 -1
  419. package/packages/utils/dist/network.d.ts +0 -105
  420. package/packages/utils/dist/network.d.ts.map +0 -1
  421. package/packages/utils/dist/network.js +0 -201
  422. package/packages/utils/dist/network.js.map +0 -1
  423. package/packages/utils/dist/npmRoot.d.ts +0 -29
  424. package/packages/utils/dist/npmRoot.d.ts.map +0 -1
  425. package/packages/utils/dist/npmRoot.js +0 -41
  426. package/packages/utils/dist/npmRoot.js.map +0 -1
  427. package/packages/utils/dist/npmVersion.d.ts +0 -33
  428. package/packages/utils/dist/npmVersion.d.ts.map +0 -1
  429. package/packages/utils/dist/npmVersion.js +0 -76
  430. package/packages/utils/dist/npmVersion.js.map +0 -1
  431. package/packages/utils/dist/tracker.d.ts +0 -108
  432. package/packages/utils/dist/tracker.d.ts.map +0 -1
  433. package/packages/utils/dist/tracker.js +0 -264
  434. package/packages/utils/dist/tracker.js.map +0 -1
  435. package/packages/utils/dist/wait.d.ts +0 -54
  436. package/packages/utils/dist/wait.d.ts.map +0 -1
  437. package/packages/utils/dist/wait.js +0 -125
  438. package/packages/utils/dist/wait.js.map +0 -1
  439. package/packages/utils/package.json +0 -110
  440. package/packages/vitest-utils/LICENSE +0 -202
  441. package/packages/vitest-utils/dist/export.d.ts +0 -2
  442. package/packages/vitest-utils/dist/export.d.ts.map +0 -1
  443. package/packages/vitest-utils/dist/export.js +0 -2
  444. package/packages/vitest-utils/dist/export.js.map +0 -1
  445. package/packages/vitest-utils/dist/vitestHelpers.d.ts +0 -58
  446. package/packages/vitest-utils/dist/vitestHelpers.d.ts.map +0 -1
  447. package/packages/vitest-utils/dist/vitestHelpers.js +0 -119
  448. package/packages/vitest-utils/dist/vitestHelpers.js.map +0 -1
  449. package/packages/vitest-utils/package.json +0 -109
@@ -1,26 +1,3 @@
1
- /**
2
- * This file contains the helpers for the class MatterbridgeEndpoint.
3
- *
4
- * @file matterbridgeEndpointHelpers.ts
5
- * @author Luca Liguori
6
- * @created 2024-10-01
7
- * @version 2.1.0
8
- * @license Apache-2.0
9
- *
10
- * Copyright 2024, 2025, 2026 Luca Liguori.
11
- *
12
- * Licensed under the Apache License, Version 2.0 (the "License");
13
- * you may not use this file except in compliance with the License.
14
- * You may obtain a copy of the License at
15
- *
16
- * http://www.apache.org/licenses/LICENSE-2.0
17
- *
18
- * Unless required by applicable law or agreed to in writing, software
19
- * distributed under the License is distributed on an "AS IS" BASIS,
20
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21
- * See the License for the specific language governing permissions and
22
- * limitations under the License.
23
- */
24
1
  import { AnsiLogger } from 'node-ansi-logger';
25
2
  import { ActionContext, Behavior, Endpoint } from '@matter/node';
26
3
  import { ClusterId } from '@matter/types/datatype';
@@ -31,254 +8,32 @@ import { DeviceEnergyManagement } from '@matter/types/clusters/device-energy-man
31
8
  import { DeviceEnergyManagementMode } from '@matter/types/clusters/device-energy-management-mode';
32
9
  import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
33
10
  import { MatterbridgeEndpointCommands } from './matterbridgeEndpointTypes.js';
34
- /**
35
- * Capitalizes the first letter of a string.
36
- *
37
- * @param {string} name - The string to capitalize.
38
- * @returns {string} The string with the first letter capitalized.
39
- */
40
11
  export declare function capitalizeFirstLetter(name: string): string;
41
- /**
42
- * Lowercases the first letter of a string.
43
- *
44
- * @param {string} name - The string to lowercase the first letter of.
45
- * @returns {string} The string with the first letter lowercased.
46
- */
47
12
  export declare function lowercaseFirstLetter(name: string): string;
48
- /**
49
- * Checks if the device name contains non-Latin characters.
50
- *
51
- * @param {string} deviceName - The name of the device to check.
52
- * @returns {boolean} Returns true if the device name contains non-Latin characters, false otherwise.
53
- */
54
13
  export declare function checkNotLatinCharacters(deviceName: string): boolean;
55
- /**
56
- * Generates a unique ID based on the device name.
57
- *
58
- * @param {string} deviceName - The name of the device to generate a unique ID for.
59
- * @returns {string} A unique ID generated from the device name using MD5 hashing.
60
- */
61
14
  export declare function generateUniqueId(deviceName: string): string;
62
- /**
63
- * Generates a unique ID based on four parameters.
64
- *
65
- * @param {string} param1 - The first parameter.
66
- * @param {string} param2 - The second parameter.
67
- * @param {string} param3 - The third parameter.
68
- * @param {string} param4 - The fourth parameter.
69
- * @returns {string} A unique ID generated from the concatenation of the parameters using MD5 hashing.
70
- */
71
15
  export declare function createUniqueId(param1: string, param2: string, param3: string, param4: string): string;
72
- /**
73
- * Retrieves the features for a specific behavior.
74
- *
75
- * @param {Endpoint} endpoint - The endpoint to retrieve the features from.
76
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to retrieve the features for.
77
- *
78
- * @returns {Record<string, boolean | undefined>} The features for the specified behavior.
79
- *
80
- * @remarks Use with:
81
- * ```typescript
82
- * expect(featuresFor(device, 'powerSource').wired).toBe(true);
83
- * ```
84
- */
85
16
  export declare function featuresFor(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string): Record<string, boolean | undefined>;
86
- /**
87
- * Maps a list of ClusterId to Behavior.Type for server clusters.
88
- *
89
- * @param {ClusterId[]} clusterServerList - The list of ClusterId to map.
90
- * @returns {Behavior.Type[]} An array of Behavior.Type corresponding to the ClusterId in the server list.
91
- */
92
17
  export declare function getBehaviourTypesFromClusterServerIds(clusterServerList: ClusterId[]): Behavior.Type[];
93
- /**
94
- * Maps a list of ClusterId to Behavior.Type for client clusters.
95
- *
96
- * @param {ClusterId[]} clusterClientList - The list of ClusterId to map.
97
- * @returns {Behavior.Type[]} An array of Behavior.Type corresponding to the ClusterId in the client list.
98
- */
99
18
  export declare function getBehaviourTypesFromClusterClientIds(clusterClientList: ClusterId[]): Behavior.Type[];
100
- /**
101
- * Maps a ClusterId to a Behavior.Type for server clusters.
102
- *
103
- * @param {ClusterId} clusterId - The ClusterId to map.
104
- * @returns {Behavior.Type} The corresponding Behavior.Type for the given ClusterId.
105
- */
106
19
  export declare function getBehaviourTypeFromClusterServerId(clusterId: ClusterId): Behavior.Type;
107
- /**
108
- * Maps a ClusterId to a Behavior.Type for client clusters.
109
- *
110
- * @param {ClusterId} _clusterId - The ClusterId to map.
111
- */
112
20
  export declare function getBehaviourTypeFromClusterClientId(_clusterId: ClusterId): void;
113
- /**
114
- * Retrieves the Behavior.Type for a given cluster from the endpoint's supported behaviors.
115
- *
116
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to retrieve the behavior from.
117
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to retrieve the behavior for.
118
- * @returns {Behavior.Type | undefined} The Behavior.Type for the given cluster, or undefined if not found.
119
- */
120
21
  export declare function getBehavior(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string): Behavior.Type | undefined;
121
- /**
122
- * Invokes a command on the specified behavior of the endpoint. Used ONLY in Jest tests.
123
- *
124
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to invoke the command on.
125
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to invoke the command on.
126
- * @param {keyof MatterbridgeEndpointCommands} command - The command to invoke.
127
- * @param {Record<string, boolean | number | bigint | string | object | null>} [params] - The parameters to pass to the command.
128
- *
129
- * @returns {Promise<boolean>} A promise that resolves to true if the command was invoked successfully, false otherwise.
130
- *
131
- * @deprecated Used ONLY in Jest tests.
132
- */
133
22
  export declare function invokeBehaviorCommand(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string, command: keyof MatterbridgeEndpointCommands, params?: Record<string, boolean | number | bigint | string | object | null>): Promise<boolean>;
134
- /**
135
- * Invokes the subscription handler on the specified cluster and attribute of the endpoint. Used ONLY in Jest tests.
136
- *
137
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to invoke the subscription handler on.
138
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to invoke the subscription handler on.
139
- * @param {string} attribute - The attribute to invoke the subscription handler on.
140
- * @param {unknown} newValue - The new value of the attribute.
141
- * @param {unknown} oldValue - The old value of the attribute.
142
- *
143
- * @returns {Promise<boolean>} A promise that resolves to true if the subscription handler was invoked successfully, false otherwise.
144
- *
145
- * @deprecated Used ONLY in Jest tests.
146
- */
147
23
  export declare function invokeSubscribeHandler(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string, attribute: string, newValue: unknown, oldValue: unknown): Promise<boolean>;
148
- /**
149
- * Adds required cluster servers to the specified endpoint based on the device types.
150
- *
151
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the required cluster servers to.
152
- * @returns {void}
153
- */
154
24
  export declare function addRequiredClusterServers(endpoint: MatterbridgeEndpoint): void;
155
- /**
156
- * Adds optional cluster servers to the specified endpoint based on the device types.
157
- *
158
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the optional cluster servers to.
159
- * @returns {void}
160
- */
161
25
  export declare function addOptionalClusterServers(endpoint: MatterbridgeEndpoint): void;
162
- /**
163
- * Adds cluster servers to the specified endpoint based on the provided server list.
164
- *
165
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the cluster servers to.
166
- * @param {ClusterId[]} serverList - The list of cluster IDs to add.
167
- */
168
26
  export declare function addClusterServers(endpoint: MatterbridgeEndpoint, serverList: ClusterId[]): void;
169
- /**
170
- * Adds a fixed label to the FixedLabel cluster. The FixedLabel cluster is created if it does not exist.
171
- *
172
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the cluster servers to.
173
- * @param {string} label - The label to add. Max 16 characters.
174
- * @param {string} value - The value of the label. Max 16 characters.
175
- */
176
27
  export declare function addFixedLabel(endpoint: MatterbridgeEndpoint, label: string, value: string): Promise<void>;
177
- /**
178
- * Adds a user label to the UserLabel cluster. The UserLabel cluster is created if it does not exist.
179
- *
180
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the cluster servers to.
181
- * @param {string} label - The label to add. Max 16 characters.
182
- * @param {string} value - The value of the label. Max 16 characters.
183
- */
184
28
  export declare function addUserLabel(endpoint: MatterbridgeEndpoint, label: string, value: string): Promise<void>;
185
- /**
186
- * Returns the options for a given behavior type.
187
- *
188
- * @param {T} type - The behavior type.
189
- * @param {Behavior.Options<T>} options - The options for the behavior type.
190
- * @returns {Behavior.Options<T>} The options for the behavior type.
191
- */
192
29
  export declare function optionsFor<T extends Behavior.Type>(type: T, options: Behavior.Options<T>): Behavior.Options<T>;
193
- /**
194
- * Retrieves the cluster ID.
195
- *
196
- * @param {Endpoint} endpoint - The endpoint to retrieve the cluster ID from.
197
- * @param {ClusterId} cluster - The ID of the cluster.
198
- * @returns {number | undefined} The ID of the cluster.
199
- */
200
30
  export declare function getClusterId(endpoint: Endpoint, cluster: string): number | undefined;
201
- /**
202
- * Retrieves the ID of an attribute from a cluster behavior.
203
- *
204
- * @param {Endpoint} endpoint - The endpoint to retrieve the attribute ID from.
205
- * @param {string} cluster - The name of the cluster.
206
- * @param {string} attribute - The name of the attribute.
207
- * @returns {number | undefined} The ID of the attribute, or undefined if not found.
208
- */
209
31
  export declare function getAttributeId(endpoint: Endpoint, cluster: string, attribute: string): number | undefined;
210
- /**
211
- * Retrieves the value of the provided attribute from the given cluster.
212
- *
213
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to retrieve the attribute from.
214
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to retrieve the attribute from.
215
- * @param {string} attribute - The name of the attribute to retrieve.
216
- * @param {AnsiLogger} [log] - (Optional) The logger to use for logging the retrieve. Errors are logged to the endpoint logger.
217
- * @returns {any} The value of the attribute, or undefined if the attribute is not found.
218
- */
219
32
  export declare function getAttribute(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string, attribute: string, log?: AnsiLogger): any;
220
- /**
221
- * Sets the value of an attribute on a cluster server.
222
- *
223
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to set the attribute on.
224
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to set the attribute on.
225
- * @param {string} attribute - The name of the attribute.
226
- * @param {boolean | number | bigint | string | object | null} value - The value to set for the attribute.
227
- * @param {AnsiLogger} [log] - (Optional) The logger to use for logging the set. Errors are logged to the endpoint logger.
228
- * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the attribute was successfully set.
229
- */
230
33
  export declare function setAttribute(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string, attribute: string, value: boolean | number | bigint | string | object | null, log?: AnsiLogger): Promise<boolean>;
231
- /**
232
- * Sets the value of an attribute on a cluster server.
233
- *
234
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to update the attribute on.
235
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to update the attribute on.
236
- * @param {string} attribute - The name of the attribute.
237
- * @param {boolean | number | bigint | string | object | null} value - The value to set for the attribute.
238
- * @param {AnsiLogger} [log] - (Optional) The logger to use for logging the update. Errors are logged to the endpoint logger.
239
- * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the attribute was successfully set.
240
- */
241
34
  export declare function updateAttribute(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string, attribute: string, value: boolean | number | bigint | string | object | null, log?: AnsiLogger): Promise<boolean>;
242
- /**
243
- * Subscribes to the provided attribute on a cluster.
244
- *
245
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to subscribe the attribute to.
246
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to subscribe the attribute to.
247
- * @param {string} attribute - The name of the attribute to subscribe to.
248
- * @param {(newValue: any, oldValue: any, context: ActionContext) => void} listener - A callback function that will be called when the attribute value changes. When context.offline === true then the change is locally generated and not from the controller.
249
- * @param {AnsiLogger} [log] - Optional logger for logging errors and information.
250
- * @returns {boolean} - A boolean indicating whether the subscription was successful.
251
- *
252
- * @remarks The listener function (cannot be async) will receive three parameters:
253
- * - `newValue`: The new value of the attribute.
254
- * - `oldValue`: The old value of the attribute.
255
- * - `context`: The action context, which includes information about the action that triggered the change. When context.offline === true then the change is locally generated and not from the controller.
256
- */
257
35
  export declare function subscribeAttribute(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string, attribute: string, listener: (newValue: any, oldValue: any, context: ActionContext) => void, log?: AnsiLogger): Promise<boolean>;
258
- /**
259
- * Triggers an event on the specified cluster.
260
- *
261
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to trigger the event on.
262
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The ID of the cluster.
263
- * @param {string} event - The name of the event to trigger.
264
- * @param {Record<string, boolean | number | bigint | string | object | undefined | null>} payload - The payload to pass to the event.
265
- * @param {AnsiLogger} [log] - Optional logger for logging information.
266
- *
267
- * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the event was successfully triggered.
268
- */
269
36
  export declare function triggerEvent(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string, event: string, payload: Record<string, boolean | number | bigint | string | object | undefined | null>, log?: AnsiLogger): Promise<boolean>;
270
- /** Utility Cluster Helpers */
271
- /**
272
- * Get the default power source wired cluster server options.
273
- *
274
- * @param {PowerSource.WiredCurrentType} wiredCurrentType - The type of wired current (default: PowerSource.WiredCurrentType.Ac)
275
- * @returns {Behavior.Options<PowerSourceClusterServer>} The options for the power source wired cluster server.
276
- *
277
- * @remarks
278
- * - order: The order of the power source is a persisted attribute that indicates the order in which the power sources are used.
279
- * - description: The description of the power source is a fixed attribute that describes the power source type.
280
- * - wiredCurrentType: The type of wired current is a fixed attribute that indicates the type of wired current used by the power source (AC or DC).
281
- */
282
37
  export declare function getDefaultPowerSourceWiredClusterServer(wiredCurrentType?: PowerSource.WiredCurrentType): Partial<{
283
38
  status: number;
284
39
  order: number;
@@ -293,20 +48,6 @@ export declare function getDefaultPowerSourceWiredClusterServer(wiredCurrentType
293
48
  wiredNominalVoltage?: number | undefined;
294
49
  wiredMaximumCurrent?: number | undefined;
295
50
  }>;
296
- /**
297
- * Get the default power source battery cluster server options.
298
- *
299
- * @param {null | number} batPercentRemaining - The remaining battery percentage (default: null). The attribute is in the range 0-200.
300
- * @param {PowerSource.BatChargeLevel} batChargeLevel - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
301
- * @param {null | number} batVoltage - The battery voltage (default: null).
302
- * @param {PowerSource.BatReplaceability} batReplaceability - The replaceability of the battery (default: PowerSource.BatReplaceability.Unspecified).
303
- * @returns {Behavior.Options<PowerSourceClusterServer>} The options for the power source replaceable battery cluster server.
304
- *
305
- * @remarks
306
- * - order: The order of the power source is a persisted attribute that indicates the order in which the power sources are used.
307
- * - description: The description of the power source is a fixed attribute that describes the power source type.
308
- * - batReplaceability: The replaceability of the battery is a fixed attribute that indicates whether the battery is user-replaceable or not.
309
- */
310
51
  export declare function getDefaultPowerSourceBatteryClusterServer(batPercentRemaining?: null | number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: null | number, batReplaceability?: PowerSource.BatReplaceability): Partial<{
311
52
  status: number;
312
53
  order: number;
@@ -321,24 +62,6 @@ export declare function getDefaultPowerSourceBatteryClusterServer(batPercentRema
321
62
  description: string;
322
63
  batReplaceability: number;
323
64
  }>;
324
- /**
325
- * Get the default power source replaceable battery cluster server options.
326
- *
327
- * @param {number} batPercentRemaining - The remaining battery percentage (default: 100). The attribute is in the range 0-200.
328
- * @param {PowerSource.BatChargeLevel} batChargeLevel - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
329
- * @param {number} batVoltage - The battery voltage (default: 1500).
330
- * @param {string} batReplacementDescription - The description of the battery replacement (default: 'Battery type').
331
- * @param {number} batQuantity - The quantity of the battery (default: 1).
332
- * @param {PowerSource.BatReplaceability} batReplaceability - The replaceability of the battery (default: PowerSource.BatReplaceability.UserReplaceable).
333
- * @returns {Behavior.Options<PowerSourceClusterServer>} The options for the power source replaceable battery cluster server.
334
- *
335
- * @remarks
336
- * - order: The order of the power source is a persisted attribute that indicates the order in which the power sources are used.
337
- * - description: The description of the power source is a fixed attribute that describes the power source type.
338
- * - batReplaceability: The replaceability of the battery is a fixed attribute that indicates whether the battery is user-replaceable or not.
339
- * - batReplacementDescription: The description of the battery replacement is a fixed attribute that describes the battery type.
340
- * - batQuantity: The quantity of the battery is a fixed attribute that indicates how many batteries are present in the device.
341
- */
342
65
  export declare function getDefaultPowerSourceReplaceableBatteryClusterServer(batPercentRemaining?: number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: number, batReplacementDescription?: string, batQuantity?: number, batReplaceability?: PowerSource.BatReplaceability): Partial<{
343
66
  status: number;
344
67
  order: number;
@@ -360,20 +83,6 @@ export declare function getDefaultPowerSourceReplaceableBatteryClusterServer(bat
360
83
  batApprovedChemistry?: number | undefined;
361
84
  batCapacity?: number | undefined;
362
85
  }>;
363
- /**
364
- * Creates a default power source rechargeable battery cluster server.
365
- *
366
- * @param {number} [batPercentRemaining] - The remaining battery percentage (default: 100). The attribute is in the range 0-200.
367
- * @param {PowerSource.BatChargeLevel} [batChargeLevel] - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
368
- * @param {number} [batVoltage] - The battery voltage in mV (default: 1500).
369
- * @param {PowerSource.BatReplaceability} [batReplaceability] - The replaceability of the battery (default: PowerSource.BatReplaceability.Unspecified).
370
- * @returns {Behavior.Options<PowerSourceClusterServer>} The options for the power source rechargeable battery cluster server.
371
- *
372
- * @remarks
373
- * - order: The order of the power source is a persisted attribute that indicates the order in which the power sources are used.
374
- * - description: The description of the power source is a fixed attribute that describes the power source type.
375
- * - batReplaceability: The replaceability of the battery is a fixed attribute that indicates whether the battery is user-replaceable or not.
376
- */
377
86
  export declare function getDefaultPowerSourceRechargeableBatteryClusterServer(batPercentRemaining?: number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: number, batReplaceability?: PowerSource.BatReplaceability): Partial<{
378
87
  status: number;
379
88
  order: number;
@@ -394,13 +103,6 @@ export declare function getDefaultPowerSourceRechargeableBatteryClusterServer(ba
394
103
  batReplaceability: number;
395
104
  batCapacity?: number | undefined;
396
105
  }>;
397
- /**
398
- * Get the default Electrical Energy Measurement Cluster Server options with features ImportedEnergy, ExportedEnergy, and CumulativeEnergy.
399
- *
400
- * @param {number} energyImported - The total consumption value in mW/h.
401
- * @param {number} energyExported - The total production value in mW/h.
402
- * @returns {Behavior.Options<ElectricalEnergyMeasurementServer>} - The default options for the Electrical Energy Measurement Cluster Server.
403
- */
404
106
  export declare function getDefaultElectricalEnergyMeasurementClusterServer(energyImported?: number | bigint | null, energyExported?: number | bigint | null): Partial<{
405
107
  cumulativeEnergyImported: {
406
108
  energy: number | bigint;
@@ -439,15 +141,6 @@ export declare function getDefaultElectricalEnergyMeasurementClusterServer(energ
439
141
  }[];
440
142
  };
441
143
  }>;
442
- /**
443
- * Get the default Electrical Power Measurement Cluster Server options with features AlternatingCurrent.
444
- *
445
- * @param {number} voltage - The voltage value in millivolts.
446
- * @param {number} current - The current value in milliamperes.
447
- * @param {number} power - The power value in milliwatts.
448
- * @param {number} frequency - The frequency value in millihertz.
449
- * @returns {Behavior.Options<ElectricalPowerMeasurementServer>} - The default options for the Electrical Power Measurement Cluster Server.
450
- */
451
144
  export declare function getDefaultElectricalPowerMeasurementClusterServer(voltage?: number | bigint | null, current?: number | bigint | null, power?: number | bigint | null, frequency?: number | bigint | null): Partial<{
452
145
  powerMode: number;
453
146
  activePower: number | bigint | null;
@@ -493,15 +186,6 @@ export declare function getDefaultElectricalPowerMeasurementClusterServer(voltag
493
186
  }[];
494
187
  }[];
495
188
  }>;
496
- /**
497
- * Get the default Electrical Apparent Power Measurement Cluster Server with features AlternatingCurrent.
498
- *
499
- * @param {number} voltage - The voltage value in millivolts.
500
- * @param {number} apparentCurrent - The current value in milliamperes.
501
- * @param {number} apparentPower - The apparent power value in millivoltamperes.
502
- * @param {number} frequency - The frequency value in millihertz.
503
- * @returns {Behavior.Options<ElectricalPowerMeasurementServer>} - The default options for the Electrical Apparent Power Measurement Cluster Server.
504
- */
505
189
  export declare function getApparentElectricalPowerMeasurementClusterServer(voltage?: number | bigint | null, apparentCurrent?: number | bigint | null, apparentPower?: number | bigint | null, frequency?: number | bigint | null): Partial<{
506
190
  powerMode: number;
507
191
  activePower: number | bigint | null;
@@ -547,24 +231,6 @@ export declare function getApparentElectricalPowerMeasurementClusterServer(volta
547
231
  }[];
548
232
  }[];
549
233
  }>;
550
- /**
551
- * Get the default Device Energy Management Cluster Server with feature PowerForecastReporting and with the specified ESA type, ESA canGenerate, ESA state, and power limits.
552
- *
553
- * @param {DeviceEnergyManagement.EsaType} [esaType] - The ESA type. Defaults to `DeviceEnergyManagement.EsaType.Other`.
554
- * @param {boolean} [esaCanGenerate] - Indicates if the ESA can generate energy. Defaults to `false`.
555
- * @param {DeviceEnergyManagement.EsaState} [esaState] - The ESA state. Defaults to `DeviceEnergyManagement.EsaState.Online`.
556
- * @param {number} [absMinPower] - Indicate the minimum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
557
- * @param {number} [absMaxPower] - Indicate the maximum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
558
- * @returns {Behavior.Options<DeviceEnergyManagementClusterServer>} - The default options for the Device Energy Management Cluster Server.
559
- *
560
- * @remarks
561
- * - The forecast attribute is set to null, indicating that there is no forecast currently available.
562
- * - The ESA type and canGenerate attributes are fixed and cannot be changed after creation.
563
- * - The ESA state is set to Online by default.
564
- * - The absolute minimum and maximum power attributes are set to 0 by default.
565
- * - For example, a battery storage inverter that can charge its battery at a maximum power of 2000W and can
566
- * discharge the battery at a maximum power of 3000W, would have a absMinPower: -3000W, absMaxPower: 2000W.
567
- */
568
234
  export declare function getDefaultDeviceEnergyManagementClusterServer(esaType?: DeviceEnergyManagement.EsaType, esaCanGenerate?: boolean, esaState?: DeviceEnergyManagement.EsaState, absMinPower?: number, absMaxPower?: number): Partial<{
569
235
  powerAdjustmentCapability: {
570
236
  powerAdjustCapability: {
@@ -617,21 +283,6 @@ export declare function getDefaultDeviceEnergyManagementClusterServer(esaType?:
617
283
  esaType: number;
618
284
  esaCanGenerate: boolean;
619
285
  }>;
620
- /**
621
- * Get the default EnergyManagementMode Cluster Server.
622
- *
623
- * @param {number} [currentMode] - The current mode of the EnergyManagementMode cluster. Defaults to mode 1 (DeviceEnergyManagementMode.ModeTag.NoOptimization).
624
- * @param {EnergyManagementMode.ModeOption[]} [supportedModes] - The supported modes for the DeviceEnergyManagementMode cluster. The attribute is fixed and defaults to a predefined set of cluster modes.
625
- * @returns {Behavior.Options<DeviceEnergyManagementModeClusterServer>} - The default options for the Device Energy Management Mode cluster server.
626
- *
627
- * @remarks
628
- * A few examples of Device Energy Management modes and their mode tags are provided below.
629
- * - For the "No Energy Management (Forecast reporting only)" mode, tags: 0x4000 (NoOptimization).
630
- * - For the "Device Energy Management" mode, tags: 0x4001 (DeviceOptimization).
631
- * - For the "Home Energy Management" mode, tags: 0x4001 (DeviceOptimization), 0x4002 (LocalOptimization).
632
- * - For the "Grid Energy Management" mode, tags: 0x4003 (GridOptimization).
633
- * - For the "Full Energy Management" mode, tags: 0x4001 (DeviceOptimization), 0x4002 (LocalOptimization), 0x4003 (GridOptimization).
634
- */
635
286
  export declare function getDefaultDeviceEnergyManagementModeClusterServer(currentMode?: number, supportedModes?: DeviceEnergyManagementMode.ModeOption[]): Partial<{
636
287
  currentMode: number;
637
288
  supportedModes: {
@@ -643,20 +294,6 @@ export declare function getDefaultDeviceEnergyManagementModeClusterServer(curren
643
294
  }[];
644
295
  }[];
645
296
  }>;
646
- /** Application Cluster Helpers */
647
- /**
648
- * Get the default OperationalState Cluster Server.
649
- *
650
- * @param {OperationalState.OperationalStateEnum} operationalState - The initial operational state id.
651
- * @returns {Behavior.Options<MatterbridgeOperationalStateServer>} - The default options for the OperationalState cluster server.
652
- *
653
- * @remarks
654
- * This method adds a cluster server with a default operational state configuration:
655
- * - { operationalStateId: OperationalState.OperationalStateEnum.Stopped, operationalStateLabel: 'Stopped' },
656
- * - { operationalStateId: OperationalState.OperationalStateEnum.Running, operationalStateLabel: 'Running' },
657
- * - { operationalStateId: OperationalState.OperationalStateEnum.Paused, operationalStateLabel: 'Paused' },
658
- * - { operationalStateId: OperationalState.OperationalStateEnum.Error, operationalStateLabel: 'Error' },
659
- */
660
297
  export declare function getDefaultOperationalStateClusterServer(operationalState?: OperationalState.OperationalStateEnum): Partial<{
661
298
  phaseList: string[] | null;
662
299
  currentPhase: number | null;
@@ -672,63 +309,24 @@ export declare function getDefaultOperationalStateClusterServer(operationalState
672
309
  };
673
310
  countdownTime?: number | null | undefined;
674
311
  }>;
675
- /**
676
- * Get the default TemperatureMeasurement cluster server options.
677
- *
678
- * @param {number | null} measuredValue - The measured value of the temperature x 100.
679
- * @param {number | null} minMeasuredValue - The minimum measured value of the temperature x 100.
680
- * @param {number | null} maxMeasuredValue - The maximum measured value of the temperature x 100.
681
- * @returns {Behavior.Options<MatterbridgeTemperatureMeasurementServer>} - The default options for the TemperatureMeasurement cluster server.
682
- */
683
312
  export declare function getDefaultTemperatureMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): Partial<{
684
313
  measuredValue: number | null;
685
314
  minMeasuredValue: number | null;
686
315
  maxMeasuredValue: number | null;
687
316
  tolerance?: number | undefined;
688
317
  }>;
689
- /**
690
- * Get the default RelativeHumidityMeasurement cluster server options.
691
- *
692
- * @param {number | null} measuredValue - The measured value of the relative humidity x 100.
693
- * @param {number | null} minMeasuredValue - The minimum measured value of the relative humidity x 100.
694
- * @param {number | null} maxMeasuredValue - The maximum measured value of the relative humidity x 100.
695
- * @returns {Behavior.Options<MatterbridgeRelativeHumidityMeasurementServer>} - The default options for the RelativeHumidityMeasurement cluster server.
696
- */
697
318
  export declare function getDefaultRelativeHumidityMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): Partial<{
698
319
  measuredValue: number | null;
699
320
  minMeasuredValue: number | null;
700
321
  maxMeasuredValue: number | null;
701
322
  tolerance?: number | undefined;
702
323
  }>;
703
- /**
704
- * Get the default PressureMeasurement cluster server options.
705
- *
706
- * @param {number | null} measuredValue - The measured value for the pressure in kPa x 10.
707
- * @param {number | null} minMeasuredValue - The minimum measured value for the pressure in kPa x 10.
708
- * @param {number | null} maxMeasuredValue - The maximum measured value for the pressure in kPa x 10.
709
- * @returns {Behavior.Options<MatterbridgePressureMeasurementServer>} - The default options for the PressureMeasurement cluster server.
710
- */
711
324
  export declare function getDefaultPressureMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): Partial<{
712
325
  measuredValue: number | null;
713
326
  minMeasuredValue: number | null;
714
327
  maxMeasuredValue: number | null;
715
328
  tolerance?: number | undefined;
716
329
  }>;
717
- /**
718
- * Get the default IlluminanceMeasurement cluster server options.
719
- *
720
- * @param {number | null} measuredValue - The measured value of illuminance.
721
- * @param {number | null} minMeasuredValue - The minimum measured value of illuminance.
722
- * @param {number | null} maxMeasuredValue - The maximum measured value of illuminance.
723
- * @returns {Behavior.Options<MatterbridgeIlluminanceMeasurementServer>} - The default options for the IlluminanceMeasurement cluster server.
724
- *
725
- * @remarks The default value for the illuminance measurement is null.
726
- * This attribute SHALL indicate the illuminance in Lux (symbol lx) as follows:
727
- * • MeasuredValue = 10,000 x log10(illuminance) + 1,
728
- * where 1 lx <= illuminance <= 3.576 Mlx, corresponding to a MeasuredValue in the range 1 to 0xFFFE.
729
- * • 0 indicates a value of illuminance that is too low to be measured
730
- * • null indicates that the illuminance measurement is invalid.
731
- */
732
330
  export declare function getDefaultIlluminanceMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): Partial<{
733
331
  measuredValue: number | null;
734
332
  minMeasuredValue: number | null;
@@ -736,34 +334,12 @@ export declare function getDefaultIlluminanceMeasurementClusterServer(measuredVa
736
334
  tolerance?: number | undefined;
737
335
  lightSensorType?: number | null | undefined;
738
336
  }>;
739
- /**
740
- * Get the default FlowMeasurement cluster server options.
741
- *
742
- * @param {number | null} measuredValue - The measured value of the flow in 10 x m3/h.
743
- * @param {number | null} minMeasuredValue - The minimum measured value of the flow in 10 x m3/h.
744
- * @param {number | null} maxMeasuredValue - The maximum measured value of the flow in 10 x m3/h.
745
- * @returns {Behavior.Options<MatterbridgeFlowMeasurementServer>} - The default options for the FlowMeasurement cluster server.
746
- */
747
337
  export declare function getDefaultFlowMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): Partial<{
748
338
  measuredValue: number | null;
749
339
  minMeasuredValue: number | null;
750
340
  maxMeasuredValue: number | null;
751
341
  tolerance?: number | undefined;
752
342
  }>;
753
- /**
754
- * Get the default OccupancySensing cluster server options.
755
- *
756
- * @param {boolean} occupied - A boolean indicating whether the occupancy is occupied or not. Default is false.
757
- * @param {number} holdTime - The hold time in seconds. Default is 30.
758
- * @param {number} holdTimeMin - The minimum hold time in seconds. Default is 1.
759
- * @param {number} holdTimeMax - The maximum hold time in seconds. Default is 300.
760
- * @returns {Behavior.Options<MatterbridgeOccupancySensingServer>} - The default options for the OccupancySensing cluster server.
761
- *
762
- * @remarks The default value for the occupancy sensor type is PIR.
763
- * Servers SHALL set these attributes for backward compatibility with clients implementing a cluster revision <= 4 as
764
- * described in OccupancySensorType and OccupancySensorTypeBitmap Attributes.
765
- * This replaces the 9 legacy attributes PIROccupiedToUnoccupiedDelay through PhysicalContactUnoccupiedToOccupiedThreshold.
766
- */
767
343
  export declare function getDefaultOccupancySensingClusterServer(occupied?: boolean, holdTime?: number, holdTimeMin?: number, holdTimeMax?: number): Partial<{
768
344
  occupancy: {
769
345
  occupied?: boolean | undefined;
@@ -784,4 +360,3 @@ export declare function getDefaultOccupancySensingClusterServer(occupied?: boole
784
360
  holdTimeDefault: number;
785
361
  } | undefined;
786
362
  }>;
787
- //# sourceMappingURL=matterbridgeEndpointHelpers.d.ts.map