matterbridge 3.3.0 → 3.3.1-dev-20251007-4e5eaac

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 (289) hide show
  1. package/CHANGELOG.md +29 -3
  2. package/README.md +9 -1
  3. package/dist/broadcastServer.js +73 -0
  4. package/dist/broadcastServerTypes.js +1 -0
  5. package/dist/cli.js +2 -91
  6. package/dist/cliEmitter.js +0 -30
  7. package/dist/clusters/export.js +0 -2
  8. package/dist/defaultConfigSchema.js +0 -24
  9. package/dist/deviceManager.js +44 -98
  10. package/dist/devices/airConditioner.js +0 -57
  11. package/dist/devices/batteryStorage.js +1 -48
  12. package/dist/devices/cooktop.js +0 -55
  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 -42
  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 -25
  27. package/dist/devices/waterHeater.js +2 -82
  28. package/dist/dgram/coap.js +13 -126
  29. package/dist/dgram/dgram.js +2 -114
  30. package/dist/dgram/mb_coap.js +3 -41
  31. package/dist/dgram/mb_mdns.js +15 -80
  32. package/dist/dgram/mdns.js +137 -299
  33. package/dist/dgram/multicast.js +1 -62
  34. package/dist/dgram/unicast.js +0 -54
  35. package/dist/frontend.js +172 -604
  36. package/dist/frontendTypes.js +0 -45
  37. package/dist/helpers.js +4 -57
  38. package/dist/index.js +0 -41
  39. package/dist/logger/export.js +0 -1
  40. package/dist/matter/behaviors.js +0 -2
  41. package/dist/matter/clusters.js +0 -2
  42. package/dist/matter/devices.js +0 -2
  43. package/dist/matter/endpoints.js +0 -2
  44. package/dist/matter/export.js +0 -3
  45. package/dist/matter/types.js +0 -3
  46. package/dist/matterbridge.js +148 -877
  47. package/dist/matterbridgeAccessoryPlatform.js +0 -36
  48. package/dist/matterbridgeBehaviors.js +5 -65
  49. package/dist/matterbridgeDeviceTypes.js +17 -630
  50. package/dist/matterbridgeDynamicPlatform.js +0 -36
  51. package/dist/matterbridgeEndpoint.js +58 -1398
  52. package/dist/matterbridgeEndpointHelpers.js +12 -345
  53. package/dist/matterbridgePlatform.js +2 -341
  54. package/dist/matterbridgeTypes.js +0 -26
  55. package/dist/pluginManager.js +133 -254
  56. package/dist/shelly.js +11 -172
  57. package/dist/storage/export.js +0 -1
  58. package/dist/update.js +0 -71
  59. package/dist/utils/colorUtils.js +2 -97
  60. package/dist/utils/commandLine.js +0 -54
  61. package/dist/utils/copyDirectory.js +1 -38
  62. package/dist/utils/createDirectory.js +0 -33
  63. package/dist/utils/createZip.js +2 -47
  64. package/dist/utils/deepCopy.js +0 -39
  65. package/dist/utils/deepEqual.js +1 -72
  66. package/dist/utils/error.js +0 -41
  67. package/dist/utils/export.js +0 -1
  68. package/dist/utils/hex.js +0 -124
  69. package/dist/utils/isvalid.js +0 -101
  70. package/dist/utils/jestHelpers.js +3 -153
  71. package/dist/utils/network.js +76 -129
  72. package/dist/utils/spawn.js +5 -75
  73. package/dist/utils/wait.js +8 -60
  74. package/frontend/build/assets/index.js +4 -7
  75. package/frontend/build/assets/vendor_mui.js +1 -1
  76. package/frontend/package.json +1 -1
  77. package/npm-shrinkwrap.json +44 -44
  78. package/package.json +2 -3
  79. package/dist/cli.d.ts +0 -26
  80. package/dist/cli.d.ts.map +0 -1
  81. package/dist/cli.js.map +0 -1
  82. package/dist/cliEmitter.d.ts +0 -34
  83. package/dist/cliEmitter.d.ts.map +0 -1
  84. package/dist/cliEmitter.js.map +0 -1
  85. package/dist/clusters/export.d.ts +0 -2
  86. package/dist/clusters/export.d.ts.map +0 -1
  87. package/dist/clusters/export.js.map +0 -1
  88. package/dist/defaultConfigSchema.d.ts +0 -28
  89. package/dist/defaultConfigSchema.d.ts.map +0 -1
  90. package/dist/defaultConfigSchema.js.map +0 -1
  91. package/dist/deviceManager.d.ts +0 -112
  92. package/dist/deviceManager.d.ts.map +0 -1
  93. package/dist/deviceManager.js.map +0 -1
  94. package/dist/devices/airConditioner.d.ts +0 -98
  95. package/dist/devices/airConditioner.d.ts.map +0 -1
  96. package/dist/devices/airConditioner.js.map +0 -1
  97. package/dist/devices/batteryStorage.d.ts +0 -48
  98. package/dist/devices/batteryStorage.d.ts.map +0 -1
  99. package/dist/devices/batteryStorage.js.map +0 -1
  100. package/dist/devices/cooktop.d.ts +0 -60
  101. package/dist/devices/cooktop.d.ts.map +0 -1
  102. package/dist/devices/cooktop.js.map +0 -1
  103. package/dist/devices/dishwasher.d.ts +0 -71
  104. package/dist/devices/dishwasher.d.ts.map +0 -1
  105. package/dist/devices/dishwasher.js.map +0 -1
  106. package/dist/devices/evse.d.ts +0 -75
  107. package/dist/devices/evse.d.ts.map +0 -1
  108. package/dist/devices/evse.js.map +0 -1
  109. package/dist/devices/export.d.ts +0 -17
  110. package/dist/devices/export.d.ts.map +0 -1
  111. package/dist/devices/export.js.map +0 -1
  112. package/dist/devices/extractorHood.d.ts +0 -46
  113. package/dist/devices/extractorHood.d.ts.map +0 -1
  114. package/dist/devices/extractorHood.js.map +0 -1
  115. package/dist/devices/heatPump.d.ts +0 -47
  116. package/dist/devices/heatPump.d.ts.map +0 -1
  117. package/dist/devices/heatPump.js.map +0 -1
  118. package/dist/devices/laundryDryer.d.ts +0 -67
  119. package/dist/devices/laundryDryer.d.ts.map +0 -1
  120. package/dist/devices/laundryDryer.js.map +0 -1
  121. package/dist/devices/laundryWasher.d.ts +0 -81
  122. package/dist/devices/laundryWasher.d.ts.map +0 -1
  123. package/dist/devices/laundryWasher.js.map +0 -1
  124. package/dist/devices/microwaveOven.d.ts +0 -168
  125. package/dist/devices/microwaveOven.d.ts.map +0 -1
  126. package/dist/devices/microwaveOven.js.map +0 -1
  127. package/dist/devices/oven.d.ts +0 -105
  128. package/dist/devices/oven.d.ts.map +0 -1
  129. package/dist/devices/oven.js.map +0 -1
  130. package/dist/devices/refrigerator.d.ts +0 -118
  131. package/dist/devices/refrigerator.d.ts.map +0 -1
  132. package/dist/devices/refrigerator.js.map +0 -1
  133. package/dist/devices/roboticVacuumCleaner.d.ts +0 -112
  134. package/dist/devices/roboticVacuumCleaner.d.ts.map +0 -1
  135. package/dist/devices/roboticVacuumCleaner.js.map +0 -1
  136. package/dist/devices/solarPower.d.ts +0 -40
  137. package/dist/devices/solarPower.d.ts.map +0 -1
  138. package/dist/devices/solarPower.js.map +0 -1
  139. package/dist/devices/speaker.d.ts +0 -87
  140. package/dist/devices/speaker.d.ts.map +0 -1
  141. package/dist/devices/speaker.js.map +0 -1
  142. package/dist/devices/temperatureControl.d.ts +0 -166
  143. package/dist/devices/temperatureControl.d.ts.map +0 -1
  144. package/dist/devices/temperatureControl.js.map +0 -1
  145. package/dist/devices/waterHeater.d.ts +0 -111
  146. package/dist/devices/waterHeater.d.ts.map +0 -1
  147. package/dist/devices/waterHeater.js.map +0 -1
  148. package/dist/dgram/coap.d.ts +0 -205
  149. package/dist/dgram/coap.d.ts.map +0 -1
  150. package/dist/dgram/coap.js.map +0 -1
  151. package/dist/dgram/dgram.d.ts +0 -141
  152. package/dist/dgram/dgram.d.ts.map +0 -1
  153. package/dist/dgram/dgram.js.map +0 -1
  154. package/dist/dgram/mb_coap.d.ts +0 -24
  155. package/dist/dgram/mb_coap.d.ts.map +0 -1
  156. package/dist/dgram/mb_coap.js.map +0 -1
  157. package/dist/dgram/mb_mdns.d.ts +0 -24
  158. package/dist/dgram/mb_mdns.d.ts.map +0 -1
  159. package/dist/dgram/mb_mdns.js.map +0 -1
  160. package/dist/dgram/mdns.d.ts +0 -290
  161. package/dist/dgram/mdns.d.ts.map +0 -1
  162. package/dist/dgram/mdns.js.map +0 -1
  163. package/dist/dgram/multicast.d.ts +0 -67
  164. package/dist/dgram/multicast.d.ts.map +0 -1
  165. package/dist/dgram/multicast.js.map +0 -1
  166. package/dist/dgram/unicast.d.ts +0 -56
  167. package/dist/dgram/unicast.d.ts.map +0 -1
  168. package/dist/dgram/unicast.js.map +0 -1
  169. package/dist/frontend.d.ts +0 -232
  170. package/dist/frontend.d.ts.map +0 -1
  171. package/dist/frontend.js.map +0 -1
  172. package/dist/frontendTypes.d.ts +0 -514
  173. package/dist/frontendTypes.d.ts.map +0 -1
  174. package/dist/frontendTypes.js.map +0 -1
  175. package/dist/globalMatterbridge.d.ts +0 -59
  176. package/dist/globalMatterbridge.d.ts.map +0 -1
  177. package/dist/globalMatterbridge.js +0 -70
  178. package/dist/globalMatterbridge.js.map +0 -1
  179. package/dist/helpers.d.ts +0 -48
  180. package/dist/helpers.d.ts.map +0 -1
  181. package/dist/helpers.js.map +0 -1
  182. package/dist/index.d.ts +0 -33
  183. package/dist/index.d.ts.map +0 -1
  184. package/dist/index.js.map +0 -1
  185. package/dist/logger/export.d.ts +0 -2
  186. package/dist/logger/export.d.ts.map +0 -1
  187. package/dist/logger/export.js.map +0 -1
  188. package/dist/matter/behaviors.d.ts +0 -2
  189. package/dist/matter/behaviors.d.ts.map +0 -1
  190. package/dist/matter/behaviors.js.map +0 -1
  191. package/dist/matter/clusters.d.ts +0 -2
  192. package/dist/matter/clusters.d.ts.map +0 -1
  193. package/dist/matter/clusters.js.map +0 -1
  194. package/dist/matter/devices.d.ts +0 -2
  195. package/dist/matter/devices.d.ts.map +0 -1
  196. package/dist/matter/devices.js.map +0 -1
  197. package/dist/matter/endpoints.d.ts +0 -2
  198. package/dist/matter/endpoints.d.ts.map +0 -1
  199. package/dist/matter/endpoints.js.map +0 -1
  200. package/dist/matter/export.d.ts +0 -5
  201. package/dist/matter/export.d.ts.map +0 -1
  202. package/dist/matter/export.js.map +0 -1
  203. package/dist/matter/types.d.ts +0 -3
  204. package/dist/matter/types.d.ts.map +0 -1
  205. package/dist/matter/types.js.map +0 -1
  206. package/dist/matterbridge.d.ts +0 -430
  207. package/dist/matterbridge.d.ts.map +0 -1
  208. package/dist/matterbridge.js.map +0 -1
  209. package/dist/matterbridgeAccessoryPlatform.d.ts +0 -42
  210. package/dist/matterbridgeAccessoryPlatform.d.ts.map +0 -1
  211. package/dist/matterbridgeAccessoryPlatform.js.map +0 -1
  212. package/dist/matterbridgeBehaviors.d.ts +0 -1747
  213. package/dist/matterbridgeBehaviors.d.ts.map +0 -1
  214. package/dist/matterbridgeBehaviors.js.map +0 -1
  215. package/dist/matterbridgeDeviceTypes.d.ts +0 -761
  216. package/dist/matterbridgeDeviceTypes.d.ts.map +0 -1
  217. package/dist/matterbridgeDeviceTypes.js.map +0 -1
  218. package/dist/matterbridgeDynamicPlatform.d.ts +0 -42
  219. package/dist/matterbridgeDynamicPlatform.d.ts.map +0 -1
  220. package/dist/matterbridgeDynamicPlatform.js.map +0 -1
  221. package/dist/matterbridgeEndpoint.d.ts +0 -1534
  222. package/dist/matterbridgeEndpoint.d.ts.map +0 -1
  223. package/dist/matterbridgeEndpoint.js.map +0 -1
  224. package/dist/matterbridgeEndpointHelpers.d.ts +0 -407
  225. package/dist/matterbridgeEndpointHelpers.d.ts.map +0 -1
  226. package/dist/matterbridgeEndpointHelpers.js.map +0 -1
  227. package/dist/matterbridgePlatform.d.ts +0 -402
  228. package/dist/matterbridgePlatform.d.ts.map +0 -1
  229. package/dist/matterbridgePlatform.js.map +0 -1
  230. package/dist/matterbridgeTypes.d.ts +0 -201
  231. package/dist/matterbridgeTypes.d.ts.map +0 -1
  232. package/dist/matterbridgeTypes.js.map +0 -1
  233. package/dist/pluginManager.d.ts +0 -270
  234. package/dist/pluginManager.d.ts.map +0 -1
  235. package/dist/pluginManager.js.map +0 -1
  236. package/dist/shelly.d.ts +0 -174
  237. package/dist/shelly.d.ts.map +0 -1
  238. package/dist/shelly.js.map +0 -1
  239. package/dist/storage/export.d.ts +0 -2
  240. package/dist/storage/export.d.ts.map +0 -1
  241. package/dist/storage/export.js.map +0 -1
  242. package/dist/update.d.ts +0 -75
  243. package/dist/update.d.ts.map +0 -1
  244. package/dist/update.js.map +0 -1
  245. package/dist/utils/colorUtils.d.ts +0 -99
  246. package/dist/utils/colorUtils.d.ts.map +0 -1
  247. package/dist/utils/colorUtils.js.map +0 -1
  248. package/dist/utils/commandLine.d.ts +0 -59
  249. package/dist/utils/commandLine.d.ts.map +0 -1
  250. package/dist/utils/commandLine.js.map +0 -1
  251. package/dist/utils/copyDirectory.d.ts +0 -33
  252. package/dist/utils/copyDirectory.d.ts.map +0 -1
  253. package/dist/utils/copyDirectory.js.map +0 -1
  254. package/dist/utils/createDirectory.d.ts +0 -34
  255. package/dist/utils/createDirectory.d.ts.map +0 -1
  256. package/dist/utils/createDirectory.js.map +0 -1
  257. package/dist/utils/createZip.d.ts +0 -39
  258. package/dist/utils/createZip.d.ts.map +0 -1
  259. package/dist/utils/createZip.js.map +0 -1
  260. package/dist/utils/deepCopy.d.ts +0 -32
  261. package/dist/utils/deepCopy.d.ts.map +0 -1
  262. package/dist/utils/deepCopy.js.map +0 -1
  263. package/dist/utils/deepEqual.d.ts +0 -54
  264. package/dist/utils/deepEqual.d.ts.map +0 -1
  265. package/dist/utils/deepEqual.js.map +0 -1
  266. package/dist/utils/error.d.ts +0 -44
  267. package/dist/utils/error.d.ts.map +0 -1
  268. package/dist/utils/error.js.map +0 -1
  269. package/dist/utils/export.d.ts +0 -13
  270. package/dist/utils/export.d.ts.map +0 -1
  271. package/dist/utils/export.js.map +0 -1
  272. package/dist/utils/hex.d.ts +0 -89
  273. package/dist/utils/hex.d.ts.map +0 -1
  274. package/dist/utils/hex.js.map +0 -1
  275. package/dist/utils/isvalid.d.ts +0 -103
  276. package/dist/utils/isvalid.d.ts.map +0 -1
  277. package/dist/utils/isvalid.js.map +0 -1
  278. package/dist/utils/jestHelpers.d.ts +0 -137
  279. package/dist/utils/jestHelpers.d.ts.map +0 -1
  280. package/dist/utils/jestHelpers.js.map +0 -1
  281. package/dist/utils/network.d.ts +0 -84
  282. package/dist/utils/network.d.ts.map +0 -1
  283. package/dist/utils/network.js.map +0 -1
  284. package/dist/utils/spawn.d.ts +0 -34
  285. package/dist/utils/spawn.d.ts.map +0 -1
  286. package/dist/utils/spawn.js.map +0 -1
  287. package/dist/utils/wait.d.ts +0 -54
  288. package/dist/utils/wait.d.ts.map +0 -1
  289. package/dist/utils/wait.js.map +0 -1
package/CHANGELOG.md CHANGED
@@ -23,7 +23,35 @@ Advantages:
23
23
  - isolation between threads;
24
24
  - individual plugin isolation in childbridge mode;
25
25
 
26
- ## [3.3.0] - Not released
26
+ ## [3.3.1] - Not released
27
+
28
+ ### Breaking Changes
29
+
30
+ - [frontend]: When a plugin is first installed, it will not be anymore started to allow to configure it before restarting.
31
+ - [index]: Removed old plugin api compatibility since it was changed one year ago.
32
+
33
+ ### Added
34
+
35
+ - [network]: Added getInterfaceDetails() function.
36
+ - [network]: Added getInterfaceName() function.
37
+ - [network]: Optimized code.
38
+ - [matterbridge]: Added SharedMatterbridge readonly type.
39
+ - [thread]: Add BroadcastServer to frontend plugins and devices.
40
+
41
+ ### Changed
42
+
43
+ - [package]: Updated dependencies.
44
+ - [matterbridge]: Removed matterbridgeInformation. It will be recreated when the frontend requires it.
45
+ - [frontend]: Bumped `frontend` version to 3.2.1.
46
+ - [frontend]: Refactored InstallProgressDialog.
47
+ - [spawn]: Refactored spawnCommand for compatibility with InstallProgressDialog.
48
+ - [matter.js]: Bumped `matter.js` to 0.15.5. Thanks matter.js!
49
+
50
+ <a href="https://www.buymeacoffee.com/luligugithub">
51
+ <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
52
+ </a>
53
+
54
+ ## [3.3.0] - 2025-10-03
27
55
 
28
56
  ### Development Breaking Changes Notice
29
57
 
@@ -98,8 +126,6 @@ In this phase (matterbridge `3.4.x`) all plugins will not build and will not run
98
126
  - [package]: Updated dependencies.
99
127
  - [frontend]: General improvements and small bug fixes.
100
128
 
101
- ### Fixed
102
-
103
129
  <a href="https://www.buymeacoffee.com/luligugithub">
104
130
  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
105
131
  </a>
package/README.md CHANGED
@@ -78,10 +78,14 @@ After follow the guidelines for the [Docker configurations](README-DOCKER.md).
78
78
 
79
79
  I suggest using Docker for its simplicity.
80
80
 
81
- Since as stated in the Matter specifications "Matter aims to build a universal IPv6-based communication protocol for smart home devices", ipv6 should be enabled in the network.
81
+ Since Matter is designed as "a universal IPv6-based communication protocol for smart home devices" (per the Matter specifications), **IPv6 must be enabled on your local network (LAN)**.
82
+
83
+ **Important:** You only need IPv6 on your local network - it doesn't matter if your internet provider doesn't provide IPv6 on the internet side (WAN).
82
84
 
83
85
  Avoid using VLAN and firewall blocking the communications between the controllers and Matterbridge.
84
86
 
87
+ To pair matterbridge, you need a matter enabled controller (Apple Home, Smart Things, Google Home, Alexa, Hose Assistant etc.).
88
+
85
89
  ## Installation
86
90
 
87
91
  Follow these steps to install Matterbridge:
@@ -574,3 +578,7 @@ Click on the badge below to get started:
574
578
  </a>
575
579
 
576
580
  Thank you for your support!
581
+
582
+ # Licensing
583
+
584
+ Matterbridge is licensed under the [Apache License 2.0](./LICENSE).
@@ -0,0 +1,73 @@
1
+ import { EventEmitter } from 'node:events';
2
+ import { BroadcastChannel } from 'node:worker_threads';
3
+ import { debugStringify } from 'node-ansi-logger';
4
+ export class BroadcastServer extends EventEmitter {
5
+ name;
6
+ log;
7
+ channel;
8
+ broadcastChannel;
9
+ constructor(name, log, channel = 'broadcast-channel') {
10
+ super();
11
+ this.name = name;
12
+ this.log = log;
13
+ this.channel = channel;
14
+ this.broadcastChannel = new BroadcastChannel(this.channel);
15
+ this.broadcastChannel.onmessage = this.broadcastMessageHandler.bind(this);
16
+ }
17
+ close() {
18
+ this.broadcastChannel.onmessage = null;
19
+ this.broadcastChannel.close();
20
+ }
21
+ getUniqueId() {
22
+ return Math.floor(Math.random() * (999999 - 100000 + 1)) + 100000;
23
+ }
24
+ isWorkerRequest(msg, type) {
25
+ return typeof msg === 'object' && msg !== null && 'id' in msg && 'type' in msg && msg.type === type && !('response' in msg) && 'src' in msg && 'dst' in msg;
26
+ }
27
+ isWorkerResponse(msg, type) {
28
+ return typeof msg === 'object' && msg !== null && 'id' in msg && 'type' in msg && msg.type === type && 'response' in msg && 'src' in msg && 'dst' in msg;
29
+ }
30
+ broadcastMessageHandler(event) {
31
+ const data = event.data;
32
+ this.log.debug(`*Received broadcast message: ${debugStringify(data)}`);
33
+ this.emit('broadcast_message', data);
34
+ }
35
+ request(message) {
36
+ if (message.id === undefined) {
37
+ message.id = this.getUniqueId();
38
+ }
39
+ if (!this.isWorkerRequest(message, message.type)) {
40
+ this.log.error(`Invalid request message format for broadcast: ${debugStringify(message)}`);
41
+ return;
42
+ }
43
+ this.log.debug(`*Broadcasting message: ${debugStringify(message)}`);
44
+ this.broadcastChannel.postMessage(message);
45
+ }
46
+ respond(message) {
47
+ if (!this.isWorkerResponse(message, message.type)) {
48
+ this.log.error(`Invalid response message format for broadcast: ${debugStringify(message)}`);
49
+ return;
50
+ }
51
+ this.log.debug(`*Broadcasting message: ${debugStringify(message)}`);
52
+ this.broadcastChannel.postMessage(message);
53
+ }
54
+ async fetch(message) {
55
+ this.log.debug(`*Fetching message: ${debugStringify(message)}`);
56
+ return new Promise((resolve, reject) => {
57
+ const responseHandler = (msg) => {
58
+ if (this.isWorkerResponse(msg, message.type) && msg.id === message.id) {
59
+ clearTimeout(timeoutId);
60
+ this.off('broadcast_message', responseHandler);
61
+ this.log.debug(`*Fetch response: ${debugStringify(msg)}`);
62
+ resolve(msg);
63
+ }
64
+ };
65
+ this.on('broadcast_message', responseHandler);
66
+ this.request(message);
67
+ const timeoutId = setTimeout(() => {
68
+ this.off('broadcast_message', responseHandler);
69
+ reject(new Error(`Fetch timeout after 100ms for message id ${message.id}`));
70
+ }, 100);
71
+ });
72
+ }
73
+ }
@@ -0,0 +1 @@
1
+ export {};
package/dist/cli.js CHANGED
@@ -1,44 +1,17 @@
1
- /**
2
- * This file contains the CLI entry point of Matterbridge.
3
- *
4
- * @file cli.ts
5
- * @author Luca Liguori
6
- * @created 2023-12-29
7
- * @version 2.0.1
8
- * @license Apache-2.0
9
- *
10
- * Copyright 2023, 2024, 2025 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 os from 'node:os';
25
2
  import { inspect } from 'node:util';
26
- // AnsiLogger module
27
3
  import { AnsiLogger, BRIGHT, CYAN, db, YELLOW } from 'node-ansi-logger';
28
- // Matterbridge
29
4
  import { getIntParameter, hasParameter } from './utils/export.js';
30
5
  import { Matterbridge } from './matterbridge.js';
31
6
  import { cliEmitter, lastCpuUsage, setLastCpuUsage } from './cliEmitter.js';
32
7
  export let instance;
33
- // Inspectop
34
8
  let session;
35
9
  let snapshotInterval;
36
- // Cpu and memory check
37
10
  let memoryCheckInterval;
38
11
  let prevCpus;
39
12
  let peakCpu = 0;
40
13
  let peakRss = 0;
41
- const log = new AnsiLogger({ logName: 'Cli', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
14
+ const log = new AnsiLogger({ logName: 'Cli', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
42
15
  const formatMemoryUsage = (bytes) => {
43
16
  if (bytes >= 1024 ** 3) {
44
17
  return `${(bytes / 1024 ** 3).toFixed(2)} GB`;
@@ -65,20 +38,14 @@ const formatOsUpTime = (seconds) => {
65
38
  }
66
39
  return `${seconds} second${seconds !== 1 ? 's' : ''}`;
67
40
  };
68
- /**
69
- * Starts the CPU and memory check interval.
70
- */
71
41
  async function startCpuMemoryCheck() {
72
- // const os = await import('node:os');
73
42
  log.debug(`Cpu memory check started`);
74
43
  prevCpus = os.cpus();
75
44
  clearInterval(memoryCheckInterval);
76
45
  const interval = () => {
77
- // Get the os uptime
78
46
  const systemUptime = formatOsUpTime(Math.floor(os.uptime()));
79
47
  const processUptime = formatOsUpTime(Math.floor(process.uptime()));
80
48
  cliEmitter.emit('uptime', systemUptime, processUptime);
81
- // Get the memory usage
82
49
  const totalMememory = formatMemoryUsage(os.totalmem());
83
50
  const freeMemory = formatMemoryUsage(os.freemem());
84
51
  const memoryUsageRaw = process.memoryUsage();
@@ -90,12 +57,10 @@ async function startCpuMemoryCheck() {
90
57
  if (memoryUsageRaw.rss > peakRss)
91
58
  peakRss = memoryUsageRaw.rss;
92
59
  cliEmitter.emit('memory', totalMememory, freeMemory, rss, heapTotal, heapUsed, external, arrayBuffers);
93
- // Get the cpu usage
94
60
  const currCpus = os.cpus();
95
- // log.debug(`Cpus: ${JSON.stringify(currCpus)}`);
96
61
  let cpuUsageLog;
97
62
  if (currCpus.length !== prevCpus.length) {
98
- prevCpus = currCpus; // Reset the previous cpus
63
+ prevCpus = currCpus;
99
64
  log.debug(`Cpu check length failed, resetting previous cpus`);
100
65
  return;
101
66
  }
@@ -121,29 +86,20 @@ async function startCpuMemoryCheck() {
121
86
  cliEmitter.emit('cpu', lastCpuUsage);
122
87
  }
123
88
  prevCpus = currCpus;
124
- // Show the cpu and memory usage
125
89
  log.debug(`***${YELLOW}${BRIGHT}Cpu usage:${db} ${CYAN}${cpuUsageLog.padStart(6, ' ')} %${db} ${YELLOW}${BRIGHT}Memory usage:${db} rss ${CYAN}${rss}${db} heapTotal ${CYAN}${heapTotal}${db} heapUsed ${CYAN}${heapUsed}${db} external ${external} arrayBuffers ${arrayBuffers}`);
126
90
  };
127
91
  interval();
128
92
  clearInterval(memoryCheckInterval);
129
93
  memoryCheckInterval = setInterval(interval, getIntParameter('memoryinterval') ?? 10 * 1000).unref();
130
94
  }
131
- /**
132
- * Stops the CPU and memory check interval.
133
- */
134
95
  async function stopCpuMemoryCheck() {
135
96
  log.debug(`***Cpu memory check stopped. Peak cpu: ${CYAN}${peakCpu.toFixed(2)} %${db}. Peak rss: ${CYAN}${formatMemoryUsage(peakRss)}${db}.`);
136
97
  clearInterval(memoryCheckInterval);
137
98
  }
138
- /**
139
- * Starts the inspector for heap sampling.
140
- * This function is called when the -inspect parameter is passed.
141
- */
142
99
  async function startInspector() {
143
100
  const { Session } = await import('node:inspector');
144
101
  const { mkdirSync } = await import('node:fs');
145
102
  log.debug(`***Starting heap sampling...`);
146
- // Create the heap snapshots directory if it doesn't exist
147
103
  mkdirSync('heap_profile', { recursive: true });
148
104
  try {
149
105
  session = new Session();
@@ -152,7 +108,6 @@ async function startInspector() {
152
108
  session?.post('HeapProfiler.startSampling', (err) => (err ? reject(err) : resolve()));
153
109
  });
154
110
  log.debug(`***Started heap sampling`);
155
- // Set an interval to take heap snapshots
156
111
  const interval = getIntParameter('snapshotinterval');
157
112
  if (interval && interval >= 30000) {
158
113
  log.debug(`***Started heap snapshot interval of ${CYAN}${interval}${db} ms`);
@@ -170,19 +125,13 @@ async function startInspector() {
170
125
  return;
171
126
  }
172
127
  }
173
- /**
174
- * Stops the heap sampling and saves the profile to a file.
175
- * This function is called when the inspector is stopped.
176
- */
177
128
  async function stopInspector() {
178
129
  const { writeFileSync } = await import('node:fs');
179
130
  const path = await import('node:path');
180
131
  log.debug(`***Stopping heap sampling...`);
181
132
  if (snapshotInterval) {
182
133
  log.debug(`***Clearing heap snapshot interval...`);
183
- // Clear the snapshot interval if it exists
184
134
  clearInterval(snapshotInterval);
185
- // Take a final heap snapshot before stopping
186
135
  await takeHeapSnapshot();
187
136
  }
188
137
  if (!session) {
@@ -190,7 +139,6 @@ async function stopInspector() {
190
139
  return;
191
140
  }
192
141
  try {
193
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
194
142
  const result = await new Promise((resolve, reject) => {
195
143
  session?.post('HeapProfiler.stopSampling', (err, result) => (err ? reject(err) : resolve(result)));
196
144
  });
@@ -208,13 +156,6 @@ async function stopInspector() {
208
156
  log.debug(`***Stopped heap sampling`);
209
157
  }
210
158
  }
211
- /**
212
- * Takes a heap snapshot and saves it to the file name Heap-snapshot-<timestamp>.heapsnapshot.
213
- * This function is called periodically based on the -snapshotinterval parameter.
214
- * The -snapshotinterval parameter must at least 30000 ms.
215
- * The snapshot is saved in the heap_profile directory that is created in the current working directory.
216
- * The snapshot can be analyzed using vscode or Chrome DevTools or other tools that support heap snapshots.
217
- */
218
159
  async function takeHeapSnapshot() {
219
160
  const { writeFileSync } = await import('node:fs');
220
161
  const path = await import('node:path');
@@ -246,10 +187,6 @@ async function takeHeapSnapshot() {
246
187
  });
247
188
  });
248
189
  }
249
- /**
250
- * Triggers a manual garbage collection.
251
- * This function is working only if the process is started with --expose-gc.
252
- */
253
190
  function triggerGarbageCollection() {
254
191
  if (typeof global.gc === 'function') {
255
192
  global.gc();
@@ -259,9 +196,6 @@ function triggerGarbageCollection() {
259
196
  log.debug('Garbage collection is not exposed. Start Node.js with --expose-gc to enable manual GC.');
260
197
  }
261
198
  }
262
- /**
263
- * Registers event handlers for the Matterbridge instance.
264
- */
265
199
  function registerHandlers() {
266
200
  log.debug('Registering event handlers...');
267
201
  if (instance)
@@ -284,52 +218,32 @@ function registerHandlers() {
284
218
  instance.on('triggergarbagecollection', async () => triggerGarbageCollection());
285
219
  log.debug('Registered event handlers');
286
220
  }
287
- /**
288
- * Shuts down the Matterbridge instance and exits the process.
289
- */
290
221
  async function shutdown() {
291
222
  log.debug('Received shutdown event, exiting...');
292
223
  if (hasParameter('inspect'))
293
224
  await stopInspector();
294
225
  await stopCpuMemoryCheck();
295
226
  cliEmitter.emit('shutdown');
296
- // eslint-disable-next-line n/no-process-exit
297
227
  process.exit(0);
298
228
  }
299
- /**
300
- *
301
- */
302
229
  async function restart() {
303
230
  log.debug('Received restart event, loading...');
304
231
  instance = await Matterbridge.loadInstance(true);
305
232
  registerHandlers();
306
233
  }
307
- /**
308
- *
309
- */
310
234
  async function update() {
311
235
  log.debug('Received update event, updating...');
312
- // TODO: Implement update logic outside of matterbridge
313
236
  instance = await Matterbridge.loadInstance(true);
314
237
  registerHandlers();
315
238
  }
316
- /**
317
- * Starts the CPU and memory check when the -startmemorycheck parameter is passed.
318
- */
319
239
  async function start() {
320
240
  log.debug('Received start memory check event');
321
241
  await startCpuMemoryCheck();
322
242
  }
323
- /**
324
- * Stops the CPU and memory check when the -stopmemorycheck parameter is passed.
325
- */
326
243
  async function stop() {
327
244
  log.debug('Received stop memory check event');
328
245
  await stopCpuMemoryCheck();
329
246
  }
330
- /**
331
- * Main function that initializes the Matterbridge instance and starts the CLI.
332
- */
333
247
  async function main() {
334
248
  log.debug(`Cli main() started`);
335
249
  await startCpuMemoryCheck();
@@ -338,7 +252,6 @@ async function main() {
338
252
  log.debug(`***Matterbridge.loadInstance(true) called`);
339
253
  instance = await Matterbridge.loadInstance(true);
340
254
  log.debug(`***Matterbridge.loadInstance(true) exited`);
341
- // Check if the instance needs to shut down from parseCommandLine()
342
255
  if (!instance || instance.shutdown) {
343
256
  shutdown();
344
257
  }
@@ -347,11 +260,9 @@ async function main() {
347
260
  cliEmitter.emit('ready');
348
261
  }
349
262
  }
350
- // Run the main function
351
263
  process.title = 'matterbridge';
352
264
  main().catch((error) => {
353
265
  const errorMessage = error instanceof Error ? error.message : error;
354
266
  const errorInspect = inspect(error, { depth: 10 });
355
267
  log.error(`Matterbridge.loadInstance() failed with error: ${errorMessage}\nstack: ${errorInspect}`);
356
268
  });
357
- //# sourceMappingURL=cli.js.map
@@ -1,36 +1,6 @@
1
- /**
2
- * This file contains the CLI emitter.
3
- *
4
- * @file cliEmitter.ts
5
- * @author Luca Liguori
6
- * @created 2025-07-04
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
1
  import { EventEmitter } from 'node:events';
25
2
  export const cliEmitter = new EventEmitter();
26
3
  export let lastCpuUsage = 0;
27
- /**
28
- * Sets the last CPU usage.
29
- *
30
- * @param {number} val - The CPU usage percentage to set.
31
- * @returns {void}
32
- */
33
4
  export function setLastCpuUsage(val) {
34
5
  lastCpuUsage = val;
35
6
  }
36
- //# sourceMappingURL=cliEmitter.js.map
@@ -1,3 +1 @@
1
1
  export {};
2
- // Nothing to export right now, but this file is here to make it easier to add exports in the future
3
- //# sourceMappingURL=export.js.map
@@ -1,26 +1,3 @@
1
- /**
2
- * This file contains the default config for the plugins.
3
- *
4
- * @file defaultConfigSchema.ts
5
- * @author Luca Liguori
6
- * @created 2024-05-07
7
- * @version 1.0.1
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
  export const zigbee2mqtt_config = {
25
2
  name: 'matterbridge-zigbee2mqtt',
26
3
  type: 'DynamicPlatform',
@@ -82,4 +59,3 @@ export const shelly_config = {
82
59
  debugWs: false,
83
60
  unregisterOnShutdown: false,
84
61
  };
85
- //# sourceMappingURL=defaultConfigSchema.js.map
@@ -1,87 +1,65 @@
1
- /**
2
- * This file contains the DeviceManager class.
3
- *
4
- * @file devices.ts
5
- * @author Luca Liguori
6
- * @created 2024-07-26
7
- * @version 1.0.11
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
- // AnsiLogger module
25
- import { AnsiLogger, BLUE, er } from 'node-ansi-logger';
1
+ import { AnsiLogger, BLUE, CYAN, db, debugStringify, er, wr } from 'node-ansi-logger';
26
2
  import { dev } from './matterbridgeTypes.js';
27
- /**
28
- * Manages Matterbridge devices.
29
- */
3
+ import { BroadcastServer } from './broadcastServer.js';
30
4
  export class DeviceManager {
31
5
  _devices = new Map();
32
- matterbridge;
33
6
  log;
34
- /**
35
- * Creates an instance of DeviceManager.
36
- *
37
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
38
- */
39
- constructor(matterbridge) {
40
- this.matterbridge = matterbridge;
41
- this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: matterbridge.log.logLevel });
7
+ server;
8
+ constructor() {
9
+ this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4, logLevel: "info" });
42
10
  this.log.debug('Matterbridge device manager starting...');
11
+ this.server = new BroadcastServer('devices', this.log);
12
+ this.server.on('broadcast_message', this.msgHandler.bind(this));
13
+ this.log.debug('Matterbridge device manager started');
14
+ }
15
+ destroy() {
16
+ this.server.close();
17
+ }
18
+ async msgHandler(msg) {
19
+ if (!this.server.isWorkerRequest(msg, msg.type))
20
+ return;
21
+ if (!msg.id || (msg.dst !== 'all' && msg.dst !== 'devices'))
22
+ return;
23
+ this.log.debug(`**Received request message ${CYAN}${msg.type}${db} from ${CYAN}${msg.src}${db}: ${debugStringify(msg)}${db}`);
24
+ switch (msg.type) {
25
+ case 'devices_length':
26
+ this.server.respond({ ...msg, id: msg.id, response: { length: this.length } });
27
+ break;
28
+ case 'devices_size':
29
+ this.server.respond({ ...msg, id: msg.id, response: { size: this.size } });
30
+ break;
31
+ case 'devices_has':
32
+ this.server.respond({ ...msg, id: msg.id, response: { has: this.has(msg.params.uniqueId) } });
33
+ break;
34
+ case 'devices_get':
35
+ this.server.respond({ ...msg, id: msg.id, response: { device: this.get(msg.params.uniqueId) } });
36
+ break;
37
+ case 'devices_set':
38
+ this.server.respond({ ...msg, id: msg.id, response: { device: this.set(msg.params.device) } });
39
+ break;
40
+ case 'devices_remove':
41
+ this.server.respond({ ...msg, id: msg.id, response: { success: this.remove(msg.params.device) } });
42
+ break;
43
+ case 'devices_clear':
44
+ this.clear();
45
+ this.server.respond({ ...msg, id: msg.id, response: { success: true } });
46
+ break;
47
+ default:
48
+ this.log.warn(`Unknown broadcast message ${CYAN}${msg.type}${wr} from ${CYAN}${msg.src}${wr}`);
49
+ }
43
50
  }
44
- /**
45
- * Gets the number of devices.
46
- *
47
- * @returns {number} The number of devices.
48
- */
49
51
  get length() {
50
52
  return this._devices.size;
51
53
  }
52
- /**
53
- * Gets the number of devices.
54
- *
55
- * @returns {number} The number of devices.
56
- */
57
54
  get size() {
58
55
  return this._devices.size;
59
56
  }
60
- /**
61
- * Checks if a device with the specified unique ID exists.
62
- *
63
- * @param {string} uniqueId - The unique ID of the device.
64
- * @returns {boolean} True if the device exists, false otherwise.
65
- */
66
57
  has(uniqueId) {
67
58
  return this._devices.has(uniqueId);
68
59
  }
69
- /**
70
- * Gets a device by its unique ID.
71
- *
72
- * @param {string} uniqueId - The unique ID of the device.
73
- * @returns {MatterbridgeEndpoint | undefined} The device, or undefined if not found.
74
- */
75
60
  get(uniqueId) {
76
61
  return this._devices.get(uniqueId);
77
62
  }
78
- /**
79
- * Adds a device to the manager.
80
- *
81
- * @param {MatterbridgeEndpoint} device - The device to add.
82
- * @returns {MatterbridgeEndpoint} The added device.
83
- * @throws {Error} If the device does not have a unique ID.
84
- */
85
63
  set(device) {
86
64
  if (!device.uniqueId)
87
65
  throw new Error(`The device ${dev}${device.deviceName}${er} has not been initialized: uniqueId is required`);
@@ -90,13 +68,6 @@ export class DeviceManager {
90
68
  this._devices.set(device.uniqueId, device);
91
69
  return device;
92
70
  }
93
- /**
94
- * Removes a device from the manager.
95
- *
96
- * @param {MatterbridgeEndpoint} device - The device to remove.
97
- * @returns {boolean} True if the device was removed, false otherwise.
98
- * @throws {Error} If the device does not have a unique ID.
99
- */
100
71
  remove(device) {
101
72
  if (!device.uniqueId)
102
73
  throw new Error(`The device ${dev}${device.deviceName}${er} has not been initialized: uniqueId is required`);
@@ -104,34 +75,15 @@ export class DeviceManager {
104
75
  this.log.error(`The device ${dev}${device.deviceName}${er} with uniqueId ${BLUE}${device.uniqueId}${er} serialNumber ${BLUE}${device.serialNumber}${er} is not registered in the device manager`);
105
76
  return this._devices.delete(device.uniqueId);
106
77
  }
107
- /**
108
- * Clears all devices from the manager.
109
- */
110
78
  clear() {
111
79
  this._devices.clear();
112
80
  }
113
- /**
114
- * Gets an array of all devices.
115
- *
116
- * @returns {MatterbridgeEndpoint[]} An array of all devices.
117
- */
118
81
  array() {
119
82
  return Array.from(this._devices.values());
120
83
  }
121
- /**
122
- * Iterates over all devices.
123
- *
124
- * @returns {IterableIterator<MatterbridgeEndpoint>} An iterator for the devices.
125
- */
126
84
  [Symbol.iterator]() {
127
85
  return this._devices.values();
128
86
  }
129
- /**
130
- * Asynchronously iterates over each device and calls the provided callback function.
131
- *
132
- * @param {(device: MatterbridgeEndpoint) => Promise<void>} callback - The callback function to call with each device.
133
- * @returns {Promise<void>} A promise that resolves when all callbacks have been called.
134
- */
135
87
  async forEach(callback) {
136
88
  if (this.size === 0)
137
89
  return;
@@ -145,13 +97,7 @@ export class DeviceManager {
145
97
  });
146
98
  await Promise.all(tasks);
147
99
  }
148
- /**
149
- * Sets the log level.
150
- *
151
- * @param {LogLevel} logLevel - The log level to set.
152
- */
153
100
  set logLevel(logLevel) {
154
101
  this.log.logLevel = logLevel;
155
102
  }
156
103
  }
157
- //# sourceMappingURL=deviceManager.js.map