matterbridge 3.4.6 → 3.4.7-dev-20260104-6b10cee

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 (354) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README-DOCKER.md +8 -0
  3. package/dist/broadcastServer.js +0 -117
  4. package/dist/broadcastServerTypes.js +0 -24
  5. package/dist/cli.js +1 -97
  6. package/dist/cliEmitter.js +0 -37
  7. package/dist/cliHistory.js +0 -38
  8. package/dist/clusters/export.js +0 -2
  9. package/dist/deviceManager.js +1 -113
  10. package/dist/devices/airConditioner.js +0 -57
  11. package/dist/devices/batteryStorage.js +1 -48
  12. package/dist/devices/cooktop.js +0 -56
  13. package/dist/devices/dishwasher.js +0 -57
  14. package/dist/devices/evse.js +10 -74
  15. package/dist/devices/export.js +0 -5
  16. package/dist/devices/extractorHood.js +0 -43
  17. package/dist/devices/heatPump.js +2 -50
  18. package/dist/devices/laundryDryer.js +3 -62
  19. package/dist/devices/laundryWasher.js +4 -70
  20. package/dist/devices/microwaveOven.js +5 -88
  21. package/dist/devices/oven.js +0 -85
  22. package/dist/devices/refrigerator.js +0 -102
  23. package/dist/devices/roboticVacuumCleaner.js +9 -100
  24. package/dist/devices/solarPower.js +0 -38
  25. package/dist/devices/speaker.js +0 -84
  26. package/dist/devices/temperatureControl.js +3 -24
  27. package/dist/devices/waterHeater.js +2 -82
  28. package/dist/dgram/coap.js +13 -126
  29. package/dist/dgram/dgram.js +6 -114
  30. package/dist/dgram/mb_coap.js +3 -41
  31. package/dist/dgram/mb_mdns.js +23 -77
  32. package/dist/dgram/mdns.js +139 -371
  33. package/dist/dgram/mdnsReflectorClient.js +5 -71
  34. package/dist/dgram/mdnsReflectorServer.js +8 -73
  35. package/dist/dgram/mdnsReflectorTypes.js +1 -24
  36. package/dist/dgram/multicast.js +1 -62
  37. package/dist/dgram/unicast.js +0 -60
  38. package/dist/frontend.js +38 -485
  39. package/dist/frontendTypes.js +0 -45
  40. package/dist/helpers.js +0 -53
  41. package/dist/index.js +0 -25
  42. package/dist/jestutils/export.js +0 -1
  43. package/dist/jestutils/jestHelpers.js +14 -371
  44. package/dist/logger/export.js +0 -1
  45. package/dist/matter/behaviors.js +0 -2
  46. package/dist/matter/clusters.js +0 -2
  47. package/dist/matter/devices.js +0 -2
  48. package/dist/matter/endpoints.js +0 -2
  49. package/dist/matter/export.js +0 -3
  50. package/dist/matter/types.js +0 -3
  51. package/dist/matterNode.js +8 -369
  52. package/dist/matterbridge.js +46 -824
  53. package/dist/matterbridgeAccessoryPlatform.js +0 -38
  54. package/dist/matterbridgeBehaviors.js +5 -68
  55. package/dist/matterbridgeDeviceTypes.js +14 -635
  56. package/dist/matterbridgeDynamicPlatform.js +0 -38
  57. package/dist/matterbridgeEndpoint.js +53 -1457
  58. package/dist/matterbridgeEndpointHelpers.js +20 -483
  59. package/dist/matterbridgeEndpointTypes.js +0 -25
  60. package/dist/matterbridgePlatform.js +1 -451
  61. package/dist/matterbridgeTypes.js +0 -26
  62. package/dist/pluginManager.js +5 -341
  63. package/dist/shelly.js +7 -178
  64. package/dist/storage/export.js +0 -1
  65. package/dist/update.js +1 -93
  66. package/dist/utils/colorUtils.js +2 -97
  67. package/dist/utils/commandLine.js +0 -60
  68. package/dist/utils/copyDirectory.js +0 -37
  69. package/dist/utils/createDirectory.js +0 -33
  70. package/dist/utils/createZip.js +2 -47
  71. package/dist/utils/deepCopy.js +0 -39
  72. package/dist/utils/deepEqual.js +1 -72
  73. package/dist/utils/error.js +0 -42
  74. package/dist/utils/export.js +0 -1
  75. package/dist/utils/format.js +0 -49
  76. package/dist/utils/hex.js +0 -124
  77. package/dist/utils/inspector.js +1 -69
  78. package/dist/utils/isValid.js +0 -93
  79. package/dist/utils/network.js +5 -125
  80. package/dist/utils/spawn.js +1 -71
  81. package/dist/utils/tracker.js +1 -64
  82. package/dist/utils/wait.js +8 -60
  83. package/dist/workerGlobalPrefix.js +5 -37
  84. package/dist/workerTypes.js +0 -24
  85. package/dist/workers.js +4 -68
  86. package/npm-shrinkwrap.json +25 -25
  87. package/package.json +1 -2
  88. package/packages/mb-lib-test/dist/jestutils/jestHelpers.d.ts +21 -0
  89. package/packages/mb-lib-test/dist/jestutils/jestHelpers.js +77 -0
  90. package/packages/mb-lib-test/dist/module.d.ts +2 -0
  91. package/packages/mb-lib-test/dist/module.js +2 -0
  92. package/packages/mb-lib-test/dist/vitestutils/vitestHelpers.d.ts +21 -0
  93. package/packages/mb-lib-test/dist/vitestutils/vitestHelpers.js +77 -0
  94. package/packages/mb-lib-test/package.json +12 -11
  95. package/reflector/DockerDesktopSetup.png +0 -0
  96. package/reflector/Reflector.md +158 -0
  97. package/reflector/ReflectorClient.png +0 -0
  98. package/reflector/ReflectorServer.png +0 -0
  99. package/reflector/docker-compose.yml +32 -0
  100. package/reflector/mDnsPacket.png +0 -0
  101. package/dist/broadcastServer.d.ts +0 -144
  102. package/dist/broadcastServer.d.ts.map +0 -1
  103. package/dist/broadcastServer.js.map +0 -1
  104. package/dist/broadcastServerTypes.d.ts +0 -841
  105. package/dist/broadcastServerTypes.d.ts.map +0 -1
  106. package/dist/broadcastServerTypes.js.map +0 -1
  107. package/dist/cli.d.ts +0 -30
  108. package/dist/cli.d.ts.map +0 -1
  109. package/dist/cli.js.map +0 -1
  110. package/dist/cliEmitter.d.ts +0 -50
  111. package/dist/cliEmitter.d.ts.map +0 -1
  112. package/dist/cliEmitter.js.map +0 -1
  113. package/dist/cliHistory.d.ts +0 -48
  114. package/dist/cliHistory.d.ts.map +0 -1
  115. package/dist/cliHistory.js.map +0 -1
  116. package/dist/clusters/export.d.ts +0 -2
  117. package/dist/clusters/export.d.ts.map +0 -1
  118. package/dist/clusters/export.js.map +0 -1
  119. package/dist/deviceManager.d.ts +0 -135
  120. package/dist/deviceManager.d.ts.map +0 -1
  121. package/dist/deviceManager.js.map +0 -1
  122. package/dist/devices/airConditioner.d.ts +0 -98
  123. package/dist/devices/airConditioner.d.ts.map +0 -1
  124. package/dist/devices/airConditioner.js.map +0 -1
  125. package/dist/devices/batteryStorage.d.ts +0 -48
  126. package/dist/devices/batteryStorage.d.ts.map +0 -1
  127. package/dist/devices/batteryStorage.js.map +0 -1
  128. package/dist/devices/cooktop.d.ts +0 -61
  129. package/dist/devices/cooktop.d.ts.map +0 -1
  130. package/dist/devices/cooktop.js.map +0 -1
  131. package/dist/devices/dishwasher.d.ts +0 -71
  132. package/dist/devices/dishwasher.d.ts.map +0 -1
  133. package/dist/devices/dishwasher.js.map +0 -1
  134. package/dist/devices/evse.d.ts +0 -76
  135. package/dist/devices/evse.d.ts.map +0 -1
  136. package/dist/devices/evse.js.map +0 -1
  137. package/dist/devices/export.d.ts +0 -17
  138. package/dist/devices/export.d.ts.map +0 -1
  139. package/dist/devices/export.js.map +0 -1
  140. package/dist/devices/extractorHood.d.ts +0 -46
  141. package/dist/devices/extractorHood.d.ts.map +0 -1
  142. package/dist/devices/extractorHood.js.map +0 -1
  143. package/dist/devices/heatPump.d.ts +0 -47
  144. package/dist/devices/heatPump.d.ts.map +0 -1
  145. package/dist/devices/heatPump.js.map +0 -1
  146. package/dist/devices/laundryDryer.d.ts +0 -67
  147. package/dist/devices/laundryDryer.d.ts.map +0 -1
  148. package/dist/devices/laundryDryer.js.map +0 -1
  149. package/dist/devices/laundryWasher.d.ts +0 -81
  150. package/dist/devices/laundryWasher.d.ts.map +0 -1
  151. package/dist/devices/laundryWasher.js.map +0 -1
  152. package/dist/devices/microwaveOven.d.ts +0 -168
  153. package/dist/devices/microwaveOven.d.ts.map +0 -1
  154. package/dist/devices/microwaveOven.js.map +0 -1
  155. package/dist/devices/oven.d.ts +0 -105
  156. package/dist/devices/oven.d.ts.map +0 -1
  157. package/dist/devices/oven.js.map +0 -1
  158. package/dist/devices/refrigerator.d.ts +0 -118
  159. package/dist/devices/refrigerator.d.ts.map +0 -1
  160. package/dist/devices/refrigerator.js.map +0 -1
  161. package/dist/devices/roboticVacuumCleaner.d.ts +0 -112
  162. package/dist/devices/roboticVacuumCleaner.d.ts.map +0 -1
  163. package/dist/devices/roboticVacuumCleaner.js.map +0 -1
  164. package/dist/devices/solarPower.d.ts +0 -40
  165. package/dist/devices/solarPower.d.ts.map +0 -1
  166. package/dist/devices/solarPower.js.map +0 -1
  167. package/dist/devices/speaker.d.ts +0 -87
  168. package/dist/devices/speaker.d.ts.map +0 -1
  169. package/dist/devices/speaker.js.map +0 -1
  170. package/dist/devices/temperatureControl.d.ts +0 -166
  171. package/dist/devices/temperatureControl.d.ts.map +0 -1
  172. package/dist/devices/temperatureControl.js.map +0 -1
  173. package/dist/devices/waterHeater.d.ts +0 -111
  174. package/dist/devices/waterHeater.d.ts.map +0 -1
  175. package/dist/devices/waterHeater.js.map +0 -1
  176. package/dist/dgram/coap.d.ts +0 -205
  177. package/dist/dgram/coap.d.ts.map +0 -1
  178. package/dist/dgram/coap.js.map +0 -1
  179. package/dist/dgram/dgram.d.ts +0 -143
  180. package/dist/dgram/dgram.d.ts.map +0 -1
  181. package/dist/dgram/dgram.js.map +0 -1
  182. package/dist/dgram/mb_coap.d.ts +0 -24
  183. package/dist/dgram/mb_coap.d.ts.map +0 -1
  184. package/dist/dgram/mb_coap.js.map +0 -1
  185. package/dist/dgram/mb_mdns.d.ts +0 -24
  186. package/dist/dgram/mb_mdns.d.ts.map +0 -1
  187. package/dist/dgram/mb_mdns.js.map +0 -1
  188. package/dist/dgram/mdns.d.ts +0 -371
  189. package/dist/dgram/mdns.d.ts.map +0 -1
  190. package/dist/dgram/mdns.js.map +0 -1
  191. package/dist/dgram/mdnsReflectorClient.d.ts +0 -88
  192. package/dist/dgram/mdnsReflectorClient.d.ts.map +0 -1
  193. package/dist/dgram/mdnsReflectorClient.js.map +0 -1
  194. package/dist/dgram/mdnsReflectorServer.d.ts +0 -78
  195. package/dist/dgram/mdnsReflectorServer.d.ts.map +0 -1
  196. package/dist/dgram/mdnsReflectorServer.js.map +0 -1
  197. package/dist/dgram/mdnsReflectorTypes.d.ts +0 -28
  198. package/dist/dgram/mdnsReflectorTypes.d.ts.map +0 -1
  199. package/dist/dgram/mdnsReflectorTypes.js.map +0 -1
  200. package/dist/dgram/multicast.d.ts +0 -67
  201. package/dist/dgram/multicast.d.ts.map +0 -1
  202. package/dist/dgram/multicast.js.map +0 -1
  203. package/dist/dgram/unicast.d.ts +0 -64
  204. package/dist/dgram/unicast.d.ts.map +0 -1
  205. package/dist/dgram/unicast.js.map +0 -1
  206. package/dist/frontend.d.ts +0 -245
  207. package/dist/frontend.d.ts.map +0 -1
  208. package/dist/frontend.js.map +0 -1
  209. package/dist/frontendTypes.d.ts +0 -529
  210. package/dist/frontendTypes.d.ts.map +0 -1
  211. package/dist/frontendTypes.js.map +0 -1
  212. package/dist/helpers.d.ts +0 -48
  213. package/dist/helpers.d.ts.map +0 -1
  214. package/dist/helpers.js.map +0 -1
  215. package/dist/index.d.ts +0 -34
  216. package/dist/index.d.ts.map +0 -1
  217. package/dist/index.js.map +0 -1
  218. package/dist/jestutils/export.d.ts +0 -2
  219. package/dist/jestutils/export.d.ts.map +0 -1
  220. package/dist/jestutils/export.js.map +0 -1
  221. package/dist/jestutils/jestHelpers.d.ts +0 -345
  222. package/dist/jestutils/jestHelpers.d.ts.map +0 -1
  223. package/dist/jestutils/jestHelpers.js.map +0 -1
  224. package/dist/logger/export.d.ts +0 -2
  225. package/dist/logger/export.d.ts.map +0 -1
  226. package/dist/logger/export.js.map +0 -1
  227. package/dist/matter/behaviors.d.ts +0 -2
  228. package/dist/matter/behaviors.d.ts.map +0 -1
  229. package/dist/matter/behaviors.js.map +0 -1
  230. package/dist/matter/clusters.d.ts +0 -2
  231. package/dist/matter/clusters.d.ts.map +0 -1
  232. package/dist/matter/clusters.js.map +0 -1
  233. package/dist/matter/devices.d.ts +0 -2
  234. package/dist/matter/devices.d.ts.map +0 -1
  235. package/dist/matter/devices.js.map +0 -1
  236. package/dist/matter/endpoints.d.ts +0 -2
  237. package/dist/matter/endpoints.d.ts.map +0 -1
  238. package/dist/matter/endpoints.js.map +0 -1
  239. package/dist/matter/export.d.ts +0 -5
  240. package/dist/matter/export.d.ts.map +0 -1
  241. package/dist/matter/export.js.map +0 -1
  242. package/dist/matter/types.d.ts +0 -3
  243. package/dist/matter/types.d.ts.map +0 -1
  244. package/dist/matter/types.js.map +0 -1
  245. package/dist/matterNode.d.ts +0 -342
  246. package/dist/matterNode.d.ts.map +0 -1
  247. package/dist/matterNode.js.map +0 -1
  248. package/dist/matterbridge.d.ts +0 -505
  249. package/dist/matterbridge.d.ts.map +0 -1
  250. package/dist/matterbridge.js.map +0 -1
  251. package/dist/matterbridgeAccessoryPlatform.d.ts +0 -41
  252. package/dist/matterbridgeAccessoryPlatform.d.ts.map +0 -1
  253. package/dist/matterbridgeAccessoryPlatform.js.map +0 -1
  254. package/dist/matterbridgeBehaviors.d.ts +0 -2404
  255. package/dist/matterbridgeBehaviors.d.ts.map +0 -1
  256. package/dist/matterbridgeBehaviors.js.map +0 -1
  257. package/dist/matterbridgeDeviceTypes.d.ts +0 -698
  258. package/dist/matterbridgeDeviceTypes.d.ts.map +0 -1
  259. package/dist/matterbridgeDeviceTypes.js.map +0 -1
  260. package/dist/matterbridgeDynamicPlatform.d.ts +0 -41
  261. package/dist/matterbridgeDynamicPlatform.d.ts.map +0 -1
  262. package/dist/matterbridgeDynamicPlatform.js.map +0 -1
  263. package/dist/matterbridgeEndpoint.d.ts +0 -1507
  264. package/dist/matterbridgeEndpoint.d.ts.map +0 -1
  265. package/dist/matterbridgeEndpoint.js.map +0 -1
  266. package/dist/matterbridgeEndpointHelpers.d.ts +0 -787
  267. package/dist/matterbridgeEndpointHelpers.d.ts.map +0 -1
  268. package/dist/matterbridgeEndpointHelpers.js.map +0 -1
  269. package/dist/matterbridgeEndpointTypes.d.ts +0 -166
  270. package/dist/matterbridgeEndpointTypes.d.ts.map +0 -1
  271. package/dist/matterbridgeEndpointTypes.js.map +0 -1
  272. package/dist/matterbridgePlatform.d.ts +0 -539
  273. package/dist/matterbridgePlatform.d.ts.map +0 -1
  274. package/dist/matterbridgePlatform.js.map +0 -1
  275. package/dist/matterbridgeTypes.d.ts +0 -252
  276. package/dist/matterbridgeTypes.d.ts.map +0 -1
  277. package/dist/matterbridgeTypes.js.map +0 -1
  278. package/dist/pluginManager.d.ts +0 -372
  279. package/dist/pluginManager.d.ts.map +0 -1
  280. package/dist/pluginManager.js.map +0 -1
  281. package/dist/shelly.d.ts +0 -181
  282. package/dist/shelly.d.ts.map +0 -1
  283. package/dist/shelly.js.map +0 -1
  284. package/dist/storage/export.d.ts +0 -2
  285. package/dist/storage/export.d.ts.map +0 -1
  286. package/dist/storage/export.js.map +0 -1
  287. package/dist/update.d.ts +0 -84
  288. package/dist/update.d.ts.map +0 -1
  289. package/dist/update.js.map +0 -1
  290. package/dist/utils/colorUtils.d.ts +0 -101
  291. package/dist/utils/colorUtils.d.ts.map +0 -1
  292. package/dist/utils/colorUtils.js.map +0 -1
  293. package/dist/utils/commandLine.d.ts +0 -66
  294. package/dist/utils/commandLine.d.ts.map +0 -1
  295. package/dist/utils/commandLine.js.map +0 -1
  296. package/dist/utils/copyDirectory.d.ts +0 -35
  297. package/dist/utils/copyDirectory.d.ts.map +0 -1
  298. package/dist/utils/copyDirectory.js.map +0 -1
  299. package/dist/utils/createDirectory.d.ts +0 -34
  300. package/dist/utils/createDirectory.d.ts.map +0 -1
  301. package/dist/utils/createDirectory.js.map +0 -1
  302. package/dist/utils/createZip.d.ts +0 -39
  303. package/dist/utils/createZip.d.ts.map +0 -1
  304. package/dist/utils/createZip.js.map +0 -1
  305. package/dist/utils/deepCopy.d.ts +0 -32
  306. package/dist/utils/deepCopy.d.ts.map +0 -1
  307. package/dist/utils/deepCopy.js.map +0 -1
  308. package/dist/utils/deepEqual.d.ts +0 -54
  309. package/dist/utils/deepEqual.d.ts.map +0 -1
  310. package/dist/utils/deepEqual.js.map +0 -1
  311. package/dist/utils/error.d.ts +0 -45
  312. package/dist/utils/error.d.ts.map +0 -1
  313. package/dist/utils/error.js.map +0 -1
  314. package/dist/utils/export.d.ts +0 -13
  315. package/dist/utils/export.d.ts.map +0 -1
  316. package/dist/utils/export.js.map +0 -1
  317. package/dist/utils/format.d.ts +0 -53
  318. package/dist/utils/format.d.ts.map +0 -1
  319. package/dist/utils/format.js.map +0 -1
  320. package/dist/utils/hex.d.ts +0 -89
  321. package/dist/utils/hex.d.ts.map +0 -1
  322. package/dist/utils/hex.js.map +0 -1
  323. package/dist/utils/inspector.d.ts +0 -87
  324. package/dist/utils/inspector.d.ts.map +0 -1
  325. package/dist/utils/inspector.js.map +0 -1
  326. package/dist/utils/isValid.d.ts +0 -103
  327. package/dist/utils/isValid.d.ts.map +0 -1
  328. package/dist/utils/isValid.js.map +0 -1
  329. package/dist/utils/network.d.ts +0 -140
  330. package/dist/utils/network.d.ts.map +0 -1
  331. package/dist/utils/network.js.map +0 -1
  332. package/dist/utils/spawn.d.ts +0 -33
  333. package/dist/utils/spawn.d.ts.map +0 -1
  334. package/dist/utils/spawn.js.map +0 -1
  335. package/dist/utils/tracker.d.ts +0 -108
  336. package/dist/utils/tracker.d.ts.map +0 -1
  337. package/dist/utils/tracker.js.map +0 -1
  338. package/dist/utils/wait.d.ts +0 -54
  339. package/dist/utils/wait.d.ts.map +0 -1
  340. package/dist/utils/wait.js.map +0 -1
  341. package/dist/workerGlobalPrefix.d.ts +0 -25
  342. package/dist/workerGlobalPrefix.d.ts.map +0 -1
  343. package/dist/workerGlobalPrefix.js.map +0 -1
  344. package/dist/workerTypes.d.ts +0 -52
  345. package/dist/workerTypes.d.ts.map +0 -1
  346. package/dist/workerTypes.js.map +0 -1
  347. package/dist/workers.d.ts +0 -69
  348. package/dist/workers.d.ts.map +0 -1
  349. package/dist/workers.js.map +0 -1
  350. package/scripts/data_model.mjs +0 -2058
  351. package/scripts/fetch-chip.mjs +0 -102
  352. package/scripts/marked.mjs +0 -133
  353. package/scripts/markedFooter.html +0 -42
  354. package/scripts/markedHeader.html +0 -78
@@ -1,54 +1,9 @@
1
- /**
2
- * This file contains the types for WebSocket messages.
3
- *
4
- * @file frontendTypes.ts
5
- * @author Luca Liguori
6
- * @created 2025-09-17
7
- * @version 1.0.0
8
- * @license Apache-2.0
9
- *
10
- * Copyright 2025, 2026, 2027 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
- /**
25
- * Type guard to check if a message is a WsMessageApiRequest.
26
- *
27
- * @param {WsMessage} msg - The message to check.
28
- *
29
- * @returns {msg is WsMessageApiRequest} True if the message is a WsMessageApiRequest, false otherwise.
30
- */
31
1
  export function isApiRequest(msg) {
32
2
  return msg.id !== 0 && msg.src === 'Frontend' && msg.dst === 'Matterbridge';
33
3
  }
34
- /**
35
- * Type guard to check if a message is a WsMessageApiResponse.
36
- *
37
- * @param {WsMessage} msg - The message to check.
38
- *
39
- * @returns {msg is WsMessageApiResponse} True if the message is a WsMessageApiResponse, false otherwise.
40
- */
41
4
  export function isApiResponse(msg) {
42
5
  return msg.id !== 0 && msg.src === 'Matterbridge' && msg.dst === 'Frontend';
43
6
  }
44
- /**
45
- * Type guard to check if a message is a WsMessageBroadcast.
46
- *
47
- * @param {WsMessage} msg - The message to check.
48
- *
49
- * @returns {msg is WsMessageBroadcast} True if the message is a WsMessageBroadcast, false otherwise.
50
- */
51
7
  export function isBroadcast(msg) {
52
8
  return msg.id === 0 && msg.src === 'Matterbridge' && msg.dst === 'Frontend';
53
9
  }
54
- //# sourceMappingURL=frontendTypes.js.map
package/dist/helpers.js CHANGED
@@ -1,27 +1,3 @@
1
- /**
2
- * This file contains the helpers functions of Matterbridge.
3
- *
4
- * @file helpers.ts
5
- * @author Luca Liguori
6
- * @created 2025-05-12
7
- * @version 1.0.0
8
- * @license Apache-2.0
9
- *
10
- * Copyright 2025, 2026, 2027 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
- // @matter module
25
1
  import { OnOff } from '@matter/types/clusters/on-off';
26
2
  import { Endpoint } from '@matter/node';
27
3
  import { BridgedDeviceBasicInformationServer } from '@matter/node/behaviors/bridged-device-basic-information';
@@ -30,24 +6,8 @@ import { OnOffPlugInUnitDevice } from '@matter/node/devices/on-off-plug-in-unit'
30
6
  import { MountedOnOffControlDevice } from '@matter/node/devices/mounted-on-off-control';
31
7
  import { OnOffLightDevice } from '@matter/node/devices/on-off-light';
32
8
  import { OnOffLightSwitchDevice } from '@matter/node/devices/on-off-light-switch';
33
- // Matterbridge
34
9
  import { hasParameter } from './utils/commandLine.js';
35
- /**
36
- * Adds a virtual device to the provided endpoint, sets up an event listener for device state changes,
37
- * and ensures the device is initialized in the off state.
38
- *
39
- * @param {Endpoint<AggregatorEndpoint>} aggregatorEndpoint - The aggragator endpoint to which the virtual device will be added.
40
- * @param {string} name - The name of the virtual device. Spaces in the name are removed to form the device ID.
41
- * @param {'light' | 'outlet' | 'switch' | 'mounted_switch'} type - The type of the virtual device. Can be 'light', 'outlet', 'switch', or 'mounted_switch'.
42
- * @param {() => Promise<void>} callback - A callback function that gets executed when the device's on/off state changes to true.
43
- * @returns {Promise<Endpoint>} A promise that resolves with the created virtual device.
44
- * @remarks The virtual device is created as an instance of `Endpoint` with the `OnOffPlugInUnitDevice` device type.
45
- * The onOff state always reverts to false when the device is turned on.
46
- */
47
10
  export async function addVirtualDevice(aggregatorEndpoint, name, type, callback) {
48
- // Create a new virtual device by instantiating `Endpoint` with device information.
49
- // The device ID is created by replacing all spaces in the name with an empty string.
50
- // The node label of the bridged device basic information is set to the given name.
51
11
  let deviceType;
52
12
  switch (type) {
53
13
  case 'light':
@@ -68,9 +28,7 @@ export async function addVirtualDevice(aggregatorEndpoint, name, type, callback)
68
28
  bridgedDeviceBasicInformation: { nodeLabel: name.slice(0, 32) },
69
29
  onOff: { onOff: false, startUpOnOff: OnOff.StartUpOnOff.Off },
70
30
  });
71
- // Set up an event listener for when the `onOff` state changes.
72
31
  device.events.onOff.onOff$Changed.on((value) => {
73
- // If the `onOff` state becomes true, turn off the virtual device and execute the callback.
74
32
  if (value) {
75
33
  callback();
76
34
  process.nextTick(async () => {
@@ -78,24 +36,14 @@ export async function addVirtualDevice(aggregatorEndpoint, name, type, callback)
78
36
  await device.setStateOf(OnOffBaseServer, { onOff: false });
79
37
  }
80
38
  catch (_error) {
81
- // Not necessary to handle the error
82
39
  }
83
40
  });
84
41
  }
85
42
  });
86
- // Add the created device to the given endpoint.
87
43
  await aggregatorEndpoint.add(device);
88
- // Initially set the state of the virtual device's `OnOffBaseServer` to false (off).
89
44
  await device.setStateOf(OnOffBaseServer, { onOff: false });
90
45
  return device;
91
46
  }
92
- /**
93
- * Creates and add the virtual devices to the aggregator.
94
- *
95
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
96
- * @param {Endpoint<AggregatorEndpoint>} aggregatorEndpoint - The aggregator node to add the virtual devices to.
97
- * @returns {Promise<void>} A promise that resolves when the virtual devices are added.
98
- */
99
47
  export async function addVirtualDevices(matterbridge, aggregatorEndpoint) {
100
48
  if (matterbridge.virtualMode !== 'disabled' && matterbridge.bridgeMode === 'bridge' && aggregatorEndpoint) {
101
49
  matterbridge.log.notice(`Creating virtual devices for Matterbridge server node...`);
@@ -144,4 +92,3 @@ export async function addVirtualDevices(matterbridge, aggregatorEndpoint) {
144
92
  }
145
93
  }
146
94
  }
147
- //# sourceMappingURL=helpers.js.map
package/dist/index.js CHANGED
@@ -1,29 +1,5 @@
1
- /**
2
- * @description This file contains the entry point of Matterbridge.
3
- * @file index.ts
4
- * @author Luca Liguori
5
- * @created 2023-12-29
6
- * @version 1.0.9
7
- * @license Apache-2.0
8
- *
9
- * Copyright 2023, 2024, 2025 Luca Liguori.
10
- *
11
- * Licensed under the Apache License, Version 2.0 (the "License");
12
- * you may not use this file except in compliance with the License.
13
- * You may obtain a copy of the License at
14
- *
15
- * http://www.apache.org/licenses/LICENSE-2.0
16
- *
17
- * Unless required by applicable law or agreed to in writing, software
18
- * distributed under the License is distributed on an "AS IS" BASIS,
19
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20
- * See the License for the specific language governing permissions and
21
- * limitations under the License.
22
- */
23
- // eslint-disable-next-line no-console
24
1
  if (process.argv.includes('--loader') || process.argv.includes('-loader'))
25
2
  console.log('\u001B[32mIndex loaded.\u001B[40;0m');
26
- // Matterbridge
27
3
  export * from './matterbridge.js';
28
4
  export * from './matterbridgeTypes.js';
29
5
  export * from './matterbridgeEndpoint.js';
@@ -35,4 +11,3 @@ export * from './matterbridgePlatform.js';
35
11
  export * from './matterbridgeAccessoryPlatform.js';
36
12
  export * from './matterbridgeDynamicPlatform.js';
37
13
  export { addVirtualDevice } from './helpers.js';
38
- //# sourceMappingURL=index.js.map
@@ -1,2 +1 @@
1
1
  export * from './jestHelpers.js';
2
- //# sourceMappingURL=export.js.map