matterbridge 3.1.6 → 3.1.7-dev-20250723-8e073ce

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 (241) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/README-DOCKER.md +3 -3
  3. package/bin/mb_coap.js +2 -0
  4. package/bin/mb_mdns.js +2 -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 +1 -94
  10. package/dist/devices/batteryStorage.js +1 -48
  11. package/dist/devices/dishwasher.js +3 -78
  12. package/dist/devices/evse.js +10 -74
  13. package/dist/devices/export.js +0 -2
  14. package/dist/devices/extractorHood.js +0 -42
  15. package/dist/devices/heatPump.js +2 -50
  16. package/dist/devices/laundryDryer.js +6 -83
  17. package/dist/devices/laundryWasher.js +7 -91
  18. package/dist/devices/roboticVacuumCleaner.js +7 -93
  19. package/dist/devices/solarPower.js +0 -38
  20. package/dist/devices/waterHeater.js +2 -82
  21. package/dist/dgram/coap.js +252 -0
  22. package/dist/dgram/dgram.js +2 -113
  23. package/dist/dgram/mb_coap.js +52 -0
  24. package/dist/dgram/mb_mdns.js +60 -0
  25. package/dist/dgram/mdns.js +135 -380
  26. package/dist/dgram/multicast.js +7 -64
  27. package/dist/dgram/unicast.js +0 -54
  28. package/dist/frontend.js +21 -435
  29. package/dist/globalMatterbridge.js +0 -47
  30. package/dist/helpers.js +0 -53
  31. package/dist/index.js +1 -30
  32. package/dist/logger/export.js +0 -1
  33. package/dist/matter/behaviors.js +0 -2
  34. package/dist/matter/clusters.js +0 -2
  35. package/dist/matter/devices.js +0 -2
  36. package/dist/matter/endpoints.js +0 -2
  37. package/dist/matter/export.js +0 -3
  38. package/dist/matter/types.js +0 -3
  39. package/dist/matterbridge.js +50 -804
  40. package/dist/matterbridgeAccessoryPlatform.js +0 -36
  41. package/dist/matterbridgeBehaviors.js +5 -65
  42. package/dist/matterbridgeDeviceTypes.js +15 -579
  43. package/dist/matterbridgeDynamicPlatform.js +0 -36
  44. package/dist/matterbridgeEndpoint.js +51 -1191
  45. package/dist/matterbridgeEndpointHelpers.js +13 -322
  46. package/dist/matterbridgePlatform.js +0 -233
  47. package/dist/matterbridgeTypes.js +0 -25
  48. package/dist/pluginManager.js +3 -249
  49. package/dist/shelly.js +7 -168
  50. package/dist/storage/export.js +0 -1
  51. package/dist/update.js +0 -54
  52. package/dist/utils/colorUtils.js +2 -263
  53. package/dist/utils/commandLine.js +0 -54
  54. package/dist/utils/copyDirectory.js +1 -38
  55. package/dist/utils/createDirectory.js +0 -33
  56. package/dist/utils/createZip.js +2 -47
  57. package/dist/utils/deepCopy.js +0 -39
  58. package/dist/utils/deepEqual.js +1 -72
  59. package/dist/utils/error.js +0 -41
  60. package/dist/utils/export.js +0 -1
  61. package/dist/utils/hex.js +0 -58
  62. package/dist/utils/isvalid.js +0 -101
  63. package/dist/utils/network.js +5 -81
  64. package/dist/utils/spawn.js +0 -40
  65. package/dist/utils/wait.js +9 -62
  66. package/npm-shrinkwrap.json +5 -3
  67. package/package.json +4 -3
  68. package/dist/cli.d.ts +0 -26
  69. package/dist/cli.d.ts.map +0 -1
  70. package/dist/cli.js.map +0 -1
  71. package/dist/cliEmitter.d.ts +0 -34
  72. package/dist/cliEmitter.d.ts.map +0 -1
  73. package/dist/cliEmitter.js.map +0 -1
  74. package/dist/clusters/export.d.ts +0 -2
  75. package/dist/clusters/export.d.ts.map +0 -1
  76. package/dist/clusters/export.js.map +0 -1
  77. package/dist/defaultConfigSchema.d.ts +0 -28
  78. package/dist/defaultConfigSchema.d.ts.map +0 -1
  79. package/dist/defaultConfigSchema.js.map +0 -1
  80. package/dist/deviceManager.d.ts +0 -112
  81. package/dist/deviceManager.d.ts.map +0 -1
  82. package/dist/deviceManager.js.map +0 -1
  83. package/dist/devices/batteryStorage.d.ts +0 -48
  84. package/dist/devices/batteryStorage.d.ts.map +0 -1
  85. package/dist/devices/batteryStorage.js.map +0 -1
  86. package/dist/devices/dishwasher.d.ts +0 -91
  87. package/dist/devices/dishwasher.d.ts.map +0 -1
  88. package/dist/devices/dishwasher.js.map +0 -1
  89. package/dist/devices/evse.d.ts +0 -75
  90. package/dist/devices/evse.d.ts.map +0 -1
  91. package/dist/devices/evse.js.map +0 -1
  92. package/dist/devices/export.d.ts +0 -11
  93. package/dist/devices/export.d.ts.map +0 -1
  94. package/dist/devices/export.js.map +0 -1
  95. package/dist/devices/extractorHood.d.ts +0 -46
  96. package/dist/devices/extractorHood.d.ts.map +0 -1
  97. package/dist/devices/extractorHood.js.map +0 -1
  98. package/dist/devices/heatPump.d.ts +0 -47
  99. package/dist/devices/heatPump.d.ts.map +0 -1
  100. package/dist/devices/heatPump.js.map +0 -1
  101. package/dist/devices/laundryDryer.d.ts +0 -87
  102. package/dist/devices/laundryDryer.d.ts.map +0 -1
  103. package/dist/devices/laundryDryer.js.map +0 -1
  104. package/dist/devices/laundryWasher.d.ts +0 -242
  105. package/dist/devices/laundryWasher.d.ts.map +0 -1
  106. package/dist/devices/laundryWasher.js.map +0 -1
  107. package/dist/devices/roboticVacuumCleaner.d.ts +0 -112
  108. package/dist/devices/roboticVacuumCleaner.d.ts.map +0 -1
  109. package/dist/devices/roboticVacuumCleaner.js.map +0 -1
  110. package/dist/devices/solarPower.d.ts +0 -40
  111. package/dist/devices/solarPower.d.ts.map +0 -1
  112. package/dist/devices/solarPower.js.map +0 -1
  113. package/dist/devices/waterHeater.d.ts +0 -111
  114. package/dist/devices/waterHeater.d.ts.map +0 -1
  115. package/dist/devices/waterHeater.js.map +0 -1
  116. package/dist/dgram/dgram.d.ts +0 -140
  117. package/dist/dgram/dgram.d.ts.map +0 -1
  118. package/dist/dgram/dgram.js.map +0 -1
  119. package/dist/dgram/mdns.d.ts +0 -288
  120. package/dist/dgram/mdns.d.ts.map +0 -1
  121. package/dist/dgram/mdns.js.map +0 -1
  122. package/dist/dgram/multicast.d.ts +0 -65
  123. package/dist/dgram/multicast.d.ts.map +0 -1
  124. package/dist/dgram/multicast.js.map +0 -1
  125. package/dist/dgram/unicast.d.ts +0 -56
  126. package/dist/dgram/unicast.d.ts.map +0 -1
  127. package/dist/dgram/unicast.js.map +0 -1
  128. package/dist/frontend.d.ts +0 -304
  129. package/dist/frontend.d.ts.map +0 -1
  130. package/dist/frontend.js.map +0 -1
  131. package/dist/globalMatterbridge.d.ts +0 -59
  132. package/dist/globalMatterbridge.d.ts.map +0 -1
  133. package/dist/globalMatterbridge.js.map +0 -1
  134. package/dist/helpers.d.ts +0 -48
  135. package/dist/helpers.d.ts.map +0 -1
  136. package/dist/helpers.js.map +0 -1
  137. package/dist/index.d.ts +0 -33
  138. package/dist/index.d.ts.map +0 -1
  139. package/dist/index.js.map +0 -1
  140. package/dist/logger/export.d.ts +0 -2
  141. package/dist/logger/export.d.ts.map +0 -1
  142. package/dist/logger/export.js.map +0 -1
  143. package/dist/matter/behaviors.d.ts +0 -2
  144. package/dist/matter/behaviors.d.ts.map +0 -1
  145. package/dist/matter/behaviors.js.map +0 -1
  146. package/dist/matter/clusters.d.ts +0 -2
  147. package/dist/matter/clusters.d.ts.map +0 -1
  148. package/dist/matter/clusters.js.map +0 -1
  149. package/dist/matter/devices.d.ts +0 -2
  150. package/dist/matter/devices.d.ts.map +0 -1
  151. package/dist/matter/devices.js.map +0 -1
  152. package/dist/matter/endpoints.d.ts +0 -2
  153. package/dist/matter/endpoints.d.ts.map +0 -1
  154. package/dist/matter/endpoints.js.map +0 -1
  155. package/dist/matter/export.d.ts +0 -5
  156. package/dist/matter/export.d.ts.map +0 -1
  157. package/dist/matter/export.js.map +0 -1
  158. package/dist/matter/types.d.ts +0 -3
  159. package/dist/matter/types.d.ts.map +0 -1
  160. package/dist/matter/types.js.map +0 -1
  161. package/dist/matterbridge.d.ts +0 -460
  162. package/dist/matterbridge.d.ts.map +0 -1
  163. package/dist/matterbridge.js.map +0 -1
  164. package/dist/matterbridgeAccessoryPlatform.d.ts +0 -42
  165. package/dist/matterbridgeAccessoryPlatform.d.ts.map +0 -1
  166. package/dist/matterbridgeAccessoryPlatform.js.map +0 -1
  167. package/dist/matterbridgeBehaviors.d.ts +0 -1351
  168. package/dist/matterbridgeBehaviors.d.ts.map +0 -1
  169. package/dist/matterbridgeBehaviors.js.map +0 -1
  170. package/dist/matterbridgeDeviceTypes.d.ts +0 -709
  171. package/dist/matterbridgeDeviceTypes.d.ts.map +0 -1
  172. package/dist/matterbridgeDeviceTypes.js.map +0 -1
  173. package/dist/matterbridgeDynamicPlatform.d.ts +0 -42
  174. package/dist/matterbridgeDynamicPlatform.d.ts.map +0 -1
  175. package/dist/matterbridgeDynamicPlatform.js.map +0 -1
  176. package/dist/matterbridgeEndpoint.d.ts +0 -1328
  177. package/dist/matterbridgeEndpoint.d.ts.map +0 -1
  178. package/dist/matterbridgeEndpoint.js.map +0 -1
  179. package/dist/matterbridgeEndpointHelpers.d.ts +0 -3198
  180. package/dist/matterbridgeEndpointHelpers.d.ts.map +0 -1
  181. package/dist/matterbridgeEndpointHelpers.js.map +0 -1
  182. package/dist/matterbridgePlatform.d.ts +0 -310
  183. package/dist/matterbridgePlatform.d.ts.map +0 -1
  184. package/dist/matterbridgePlatform.js.map +0 -1
  185. package/dist/matterbridgeTypes.d.ts +0 -195
  186. package/dist/matterbridgeTypes.d.ts.map +0 -1
  187. package/dist/matterbridgeTypes.js.map +0 -1
  188. package/dist/pluginManager.d.ts +0 -270
  189. package/dist/pluginManager.d.ts.map +0 -1
  190. package/dist/pluginManager.js.map +0 -1
  191. package/dist/shelly.d.ts +0 -174
  192. package/dist/shelly.d.ts.map +0 -1
  193. package/dist/shelly.js.map +0 -1
  194. package/dist/storage/export.d.ts +0 -2
  195. package/dist/storage/export.d.ts.map +0 -1
  196. package/dist/storage/export.js.map +0 -1
  197. package/dist/update.d.ts +0 -59
  198. package/dist/update.d.ts.map +0 -1
  199. package/dist/update.js.map +0 -1
  200. package/dist/utils/colorUtils.d.ts +0 -117
  201. package/dist/utils/colorUtils.d.ts.map +0 -1
  202. package/dist/utils/colorUtils.js.map +0 -1
  203. package/dist/utils/commandLine.d.ts +0 -59
  204. package/dist/utils/commandLine.d.ts.map +0 -1
  205. package/dist/utils/commandLine.js.map +0 -1
  206. package/dist/utils/copyDirectory.d.ts +0 -33
  207. package/dist/utils/copyDirectory.d.ts.map +0 -1
  208. package/dist/utils/copyDirectory.js.map +0 -1
  209. package/dist/utils/createDirectory.d.ts +0 -34
  210. package/dist/utils/createDirectory.d.ts.map +0 -1
  211. package/dist/utils/createDirectory.js.map +0 -1
  212. package/dist/utils/createZip.d.ts +0 -39
  213. package/dist/utils/createZip.d.ts.map +0 -1
  214. package/dist/utils/createZip.js.map +0 -1
  215. package/dist/utils/deepCopy.d.ts +0 -32
  216. package/dist/utils/deepCopy.d.ts.map +0 -1
  217. package/dist/utils/deepCopy.js.map +0 -1
  218. package/dist/utils/deepEqual.d.ts +0 -54
  219. package/dist/utils/deepEqual.d.ts.map +0 -1
  220. package/dist/utils/deepEqual.js.map +0 -1
  221. package/dist/utils/error.d.ts +0 -44
  222. package/dist/utils/error.d.ts.map +0 -1
  223. package/dist/utils/error.js.map +0 -1
  224. package/dist/utils/export.d.ts +0 -12
  225. package/dist/utils/export.d.ts.map +0 -1
  226. package/dist/utils/export.js.map +0 -1
  227. package/dist/utils/hex.d.ts +0 -49
  228. package/dist/utils/hex.d.ts.map +0 -1
  229. package/dist/utils/hex.js.map +0 -1
  230. package/dist/utils/isvalid.d.ts +0 -103
  231. package/dist/utils/isvalid.d.ts.map +0 -1
  232. package/dist/utils/isvalid.js.map +0 -1
  233. package/dist/utils/network.d.ts +0 -74
  234. package/dist/utils/network.d.ts.map +0 -1
  235. package/dist/utils/network.js.map +0 -1
  236. package/dist/utils/spawn.d.ts +0 -33
  237. package/dist/utils/spawn.d.ts.map +0 -1
  238. package/dist/utils/spawn.js.map +0 -1
  239. package/dist/utils/wait.d.ts +0 -56
  240. package/dist/utils/wait.d.ts.map +0 -1
  241. package/dist/utils/wait.js.map +0 -1
@@ -1,43 +1,15 @@
1
- /**
2
- * This file contains the class Matterbridge.
3
- *
4
- * @file matterbridge.ts
5
- * @author Luca Liguori
6
- * @created 2023-12-29
7
- * @version 1.6.0
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
- // Node.js modules
25
1
  import os from 'node:os';
26
2
  import path from 'node:path';
27
3
  import { promises as fs } from 'node:fs';
28
4
  import EventEmitter from 'node:events';
29
5
  import { inspect } from 'node:util';
30
- // AnsiLogger module
31
6
  import { AnsiLogger, UNDERLINE, UNDERLINEOFF, db, debugStringify, BRIGHT, RESET, er, nf, rs, wr, RED, GREEN, zb, CYAN, nt, BLUE } from 'node-ansi-logger';
32
- // NodeStorage module
33
7
  import { NodeStorageManager } from 'node-persist-manager';
34
- // @matter
35
8
  import { DeviceTypeId, Endpoint, Logger, LogLevel as MatterLogLevel, LogFormat as MatterLogFormat, VendorId, StorageService, Environment, ServerNode, UINT32_MAX, UINT16_MAX, Crypto, } from '@matter/main';
36
9
  import { DeviceCommissioner, FabricAction, MdnsService, PaseClient } from '@matter/main/protocol';
37
10
  import { AggregatorEndpoint } from '@matter/main/endpoints';
38
11
  import { BasicInformationServer } from '@matter/main/behaviors/basic-information';
39
12
  import { BridgedDeviceBasicInformationServer } from '@matter/main/behaviors/bridged-device-basic-information';
40
- // Matterbridge
41
13
  import { getParameter, getIntParameter, hasParameter, copyDirectory, isValidString, parseVersionString, isValidNumber, createDirectory } from './utils/export.js';
42
14
  import { withTimeout, waiter, wait } from './utils/wait.js';
43
15
  import { dev, plg, typ } from './matterbridgeTypes.js';
@@ -47,9 +19,6 @@ import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
47
19
  import { bridge } from './matterbridgeDeviceTypes.js';
48
20
  import { Frontend } from './frontend.js';
49
21
  import { addVirtualDevices } from './helpers.js';
50
- /**
51
- * Represents the Matterbridge application.
52
- */
53
22
  export class Matterbridge extends EventEmitter {
54
23
  systemInformation = {
55
24
  interfaceName: '',
@@ -98,7 +67,7 @@ export class Matterbridge extends EventEmitter {
98
67
  shellySysUpdate: false,
99
68
  shellyMainUpdate: false,
100
69
  profile: getParameter('profile'),
101
- loggerLevel: "info" /* LogLevel.INFO */,
70
+ loggerLevel: "info",
102
71
  fileLogger: false,
103
72
  matterLoggerLevel: MatterLogLevel.INFO,
104
73
  matterFileLogger: false,
@@ -124,20 +93,16 @@ export class Matterbridge extends EventEmitter {
124
93
  restartMode = '';
125
94
  profile = getParameter('profile');
126
95
  shutdown = false;
127
- edge = true;
128
96
  failCountLimit = hasParameter('shelly') ? 600 : 120;
129
- // Matterbridge log files
130
- log = new AnsiLogger({ logName: 'Matterbridge', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
97
+ log = new AnsiLogger({ logName: 'Matterbridge', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
131
98
  matterbridgeLoggerFile = 'matterbridge' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.log';
132
99
  matterLoggerFile = 'matter' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.log';
133
100
  plugins = new PluginManager(this);
134
101
  devices = new DeviceManager(this);
135
102
  frontend = new Frontend(this);
136
- // Matterbridge storage
137
103
  nodeStorageName = 'storage' + (getParameter('profile') ? '.' + getParameter('profile') : '');
138
104
  nodeStorage;
139
105
  nodeContext;
140
- // Cleanup
141
106
  hasCleanupStarted = false;
142
107
  initialized = false;
143
108
  execRunningCount = 0;
@@ -152,23 +117,19 @@ export class Matterbridge extends EventEmitter {
152
117
  sigtermHandler;
153
118
  exceptionHandler;
154
119
  rejectionHandler;
155
- // Matter environment
156
120
  environment = Environment.default;
157
- // Matter storage
158
121
  matterStorageName = 'matterstorage' + (getParameter('profile') ? '.' + getParameter('profile') : '');
159
122
  matterStorageService;
160
123
  matterStorageManager;
161
124
  matterbridgeContext;
162
125
  controllerContext;
163
- // Matter parameters
164
- mdnsInterface; // matter server node mdnsInterface: e.g. 'eth0' or 'wlan0' or 'WiFi'
165
- ipv4address; // matter server node listeningAddressIpv4
166
- ipv6address; // matter server node listeningAddressIpv6
167
- port; // first server node port
168
- passcode; // first server node passcode
169
- discriminator; // first server node discriminator
170
- certification; // device certification
171
- // Matter nodes
126
+ mdnsInterface;
127
+ ipv4address;
128
+ ipv6address;
129
+ port;
130
+ passcode;
131
+ discriminator;
132
+ certification;
172
133
  serverNode;
173
134
  aggregatorNode;
174
135
  aggregatorVendorId = VendorId(getIntParameter('vendorId') ?? 0xfff1);
@@ -176,31 +137,15 @@ export class Matterbridge extends EventEmitter {
176
137
  aggregatorProductId = getIntParameter('productId') ?? 0x8000;
177
138
  aggregatorProductName = getParameter('productName') ?? 'Matterbridge aggregator';
178
139
  static instance;
179
- // We load asyncronously so is private
180
140
  constructor() {
181
141
  super();
182
142
  }
183
- /**
184
- * Retrieves the list of Matterbridge devices.
185
- *
186
- * @returns {MatterbridgeEndpoint[]} An array of MatterbridgeDevice objects.
187
- */
188
143
  getDevices() {
189
144
  return this.devices.array();
190
145
  }
191
- /**
192
- * Retrieves the list of registered plugins.
193
- *
194
- * @returns {RegisteredPlugin[]} An array of RegisteredPlugin objects.
195
- */
196
146
  getPlugins() {
197
147
  return this.plugins.array();
198
148
  }
199
- /**
200
- * Set the logger logLevel for the Matterbridge classes and call onChangeLoggerLevel() for each plugin.
201
- *
202
- * @param {LogLevel} logLevel The logger logLevel to set.
203
- */
204
149
  async setLogLevel(logLevel) {
205
150
  if (this.log)
206
151
  this.log.logLevel = logLevel;
@@ -214,31 +159,19 @@ export class Matterbridge extends EventEmitter {
214
159
  for (const plugin of this.plugins) {
215
160
  if (!plugin.platform || !plugin.platform.log || !plugin.platform.config)
216
161
  continue;
217
- plugin.platform.log.logLevel = plugin.platform.config.debug === true ? "debug" /* LogLevel.DEBUG */ : this.log.logLevel;
218
- await plugin.platform.onChangeLoggerLevel(plugin.platform.config.debug === true ? "debug" /* LogLevel.DEBUG */ : this.log.logLevel);
219
- }
220
- // Set the global logger callback for the WebSocketServer to the common minimum logLevel
221
- let callbackLogLevel = "notice" /* LogLevel.NOTICE */;
222
- if (this.matterbridgeInformation.loggerLevel === "info" /* LogLevel.INFO */ || this.matterbridgeInformation.matterLoggerLevel === MatterLogLevel.INFO)
223
- callbackLogLevel = "info" /* LogLevel.INFO */;
224
- if (this.matterbridgeInformation.loggerLevel === "debug" /* LogLevel.DEBUG */ || this.matterbridgeInformation.matterLoggerLevel === MatterLogLevel.DEBUG)
225
- callbackLogLevel = "debug" /* LogLevel.DEBUG */;
162
+ plugin.platform.log.logLevel = plugin.platform.config.debug === true ? "debug" : this.log.logLevel;
163
+ await plugin.platform.onChangeLoggerLevel(plugin.platform.config.debug === true ? "debug" : this.log.logLevel);
164
+ }
165
+ let callbackLogLevel = "notice";
166
+ if (this.matterbridgeInformation.loggerLevel === "info" || this.matterbridgeInformation.matterLoggerLevel === MatterLogLevel.INFO)
167
+ callbackLogLevel = "info";
168
+ if (this.matterbridgeInformation.loggerLevel === "debug" || this.matterbridgeInformation.matterLoggerLevel === MatterLogLevel.DEBUG)
169
+ callbackLogLevel = "debug";
226
170
  AnsiLogger.setGlobalCallback(this.frontend.wssSendMessage.bind(this.frontend), callbackLogLevel);
227
171
  this.log.debug(`WebSocketServer logger global callback set to ${callbackLogLevel}`);
228
172
  }
229
- //* ************************************************************************************************************************************ */
230
- // loadInstance() and cleanup() methods */
231
- //* ************************************************************************************************************************************ */
232
- /**
233
- * Loads an instance of the Matterbridge class.
234
- * If an instance already exists, return that instance.
235
- *
236
- * @param {boolean} initialize - Whether to initialize the Matterbridge instance after loading. Defaults to false.
237
- * @returns {Matterbridge} A promise that resolves to the Matterbridge instance.
238
- */
239
173
  static async loadInstance(initialize = false) {
240
174
  if (!Matterbridge.instance) {
241
- // eslint-disable-next-line no-console
242
175
  if (hasParameter('debug'))
243
176
  console.log(GREEN + 'Creating a new instance of Matterbridge.', initialize ? 'Initializing...' : 'Not initializing...', rs);
244
177
  Matterbridge.instance = new Matterbridge();
@@ -247,17 +180,8 @@ export class Matterbridge extends EventEmitter {
247
180
  }
248
181
  return Matterbridge.instance;
249
182
  }
250
- /**
251
- * Call cleanup() and dispose MdnsService.
252
- *
253
- * @param {number} [timeout] - The timeout duration to wait for the cleanup to complete in milliseconds. Default is 1000.
254
- * @param {number} [pause] - The pause duration after the cleanup in milliseconds. Default is 250.
255
- *
256
- * @deprecated This method is deprecated and is ONLY used for jest tests.
257
- */
258
183
  async destroyInstance(timeout = 1000, pause = 250) {
259
184
  this.log.info(`Destroy instance...`);
260
- // Save server nodes to close
261
185
  const servers = [];
262
186
  if (this.bridgeMode === 'bridge') {
263
187
  if (this.serverNode)
@@ -275,105 +199,72 @@ export class Matterbridge extends EventEmitter {
275
199
  servers.push(device.serverNode);
276
200
  }
277
201
  }
278
- // Let any already‐queued microtasks run first
279
202
  await Promise.resolve();
280
- // Wait for the cleanup to finish
281
203
  await wait(pause, 'destroyInstance start', true);
282
- // Cleanup
283
204
  await this.cleanup('destroying instance...', false, timeout);
284
- // Close servers mdns service
285
205
  this.log.info(`Dispose ${servers.length} MdnsService...`);
286
206
  for (const server of servers) {
287
207
  await server.env.get(MdnsService)[Symbol.asyncDispose]();
288
208
  this.log.info(`Closed ${server.id} MdnsService`);
289
209
  }
290
- // Let any already‐queued microtasks run first
291
210
  await Promise.resolve();
292
- // Wait for the cleanup to finish
293
211
  await wait(pause, 'destroyInstance stop', true);
294
212
  }
295
- /**
296
- * Initializes the Matterbridge application.
297
- *
298
- * @remarks
299
- * This method performs the necessary setup and initialization steps for the Matterbridge application.
300
- * It displays the help information if the 'help' parameter is provided, sets up the logger, checks the
301
- * node version, registers signal handlers, initializes storage, and parses the command line.
302
- *
303
- * @returns {Promise<void>} A Promise that resolves when the initialization is complete.
304
- */
305
213
  async initialize() {
306
- // Emit the initialize_started event
307
214
  this.emit('initialize_started');
308
- // Set the restart mode
309
215
  if (hasParameter('service'))
310
216
  this.restartMode = 'service';
311
217
  if (hasParameter('docker'))
312
218
  this.restartMode = 'docker';
313
- // Set the matterbridge home directory
314
219
  this.homeDirectory = getParameter('homedir') ?? os.homedir();
315
220
  this.matterbridgeInformation.homeDirectory = this.homeDirectory;
316
221
  await createDirectory(this.homeDirectory, 'Matterbridge Home Directory', this.log);
317
- // Set the matterbridge directory
318
222
  this.matterbridgeDirectory = path.join(this.homeDirectory, '.matterbridge');
319
223
  this.matterbridgeInformation.matterbridgeDirectory = this.matterbridgeDirectory;
320
224
  await createDirectory(this.matterbridgeDirectory, 'Matterbridge Directory', this.log);
321
225
  await createDirectory(path.join(this.matterbridgeDirectory, 'certs'), 'Matterbridge Frontend Certificate Directory', this.log);
322
226
  await createDirectory(path.join(this.matterbridgeDirectory, 'uploads'), 'Matterbridge Frontend Uploads Directory', this.log);
323
- // Set the matterbridge plugin directory
324
227
  this.matterbridgePluginDirectory = path.join(this.homeDirectory, 'Matterbridge');
325
228
  this.matterbridgeInformation.matterbridgePluginDirectory = this.matterbridgePluginDirectory;
326
229
  await createDirectory(this.matterbridgePluginDirectory, 'Matterbridge Plugin Directory', this.log);
327
- // Set the matterbridge cert directory
328
230
  this.matterbridgeCertDirectory = path.join(this.homeDirectory, '.mattercert');
329
231
  this.matterbridgeInformation.matterbridgeCertDirectory = this.matterbridgeCertDirectory;
330
232
  await createDirectory(this.matterbridgeCertDirectory, 'Matterbridge Matter Certificate Directory', this.log);
331
- // Set the matterbridge root directory
332
233
  const { fileURLToPath } = await import('node:url');
333
234
  const currentFileDirectory = path.dirname(fileURLToPath(import.meta.url));
334
235
  this.rootDirectory = path.resolve(currentFileDirectory, '../');
335
236
  this.matterbridgeInformation.rootDirectory = this.rootDirectory;
336
- // Setup the matter environment
337
237
  this.environment.vars.set('log.level', MatterLogLevel.INFO);
338
238
  this.environment.vars.set('log.format', MatterLogFormat.ANSI);
339
239
  this.environment.vars.set('path.root', path.join(this.matterbridgeDirectory, this.matterStorageName));
340
240
  this.environment.vars.set('runtime.signals', false);
341
241
  this.environment.vars.set('runtime.exitcode', false);
342
- // Register process handlers
343
242
  this.registerProcessHandlers();
344
- // Initialize nodeStorage and nodeContext
345
243
  try {
346
244
  this.log.debug(`Creating node storage manager: ${CYAN}${this.nodeStorageName}${db}`);
347
245
  this.nodeStorage = new NodeStorageManager({ dir: path.join(this.matterbridgeDirectory, this.nodeStorageName), writeQueue: false, expiredInterval: undefined, logging: false });
348
246
  this.log.debug('Creating node storage context for matterbridge');
349
247
  this.nodeContext = await this.nodeStorage.createStorage('matterbridge');
350
- // TODO: Remove this code when node-persist-manager is updated
351
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
352
248
  const keys = (await this.nodeStorage?.storage.keys());
353
249
  for (const key of keys) {
354
250
  this.log.debug(`Checking node storage manager key: ${CYAN}${key}${db}`);
355
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
356
251
  await this.nodeStorage?.storage.get(key);
357
252
  }
358
253
  const storages = await this.nodeStorage.getStorageNames();
359
254
  for (const storage of storages) {
360
255
  this.log.debug(`Checking storage: ${CYAN}${storage}${db}`);
361
256
  const nodeContext = await this.nodeStorage?.createStorage(storage);
362
- // TODO: Remove this code when node-persist-manager is updated
363
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
364
257
  const keys = (await nodeContext?.storage.keys());
365
258
  keys.forEach(async (key) => {
366
259
  this.log.debug(`Checking key: ${CYAN}${storage}:${key}${db}`);
367
260
  await nodeContext?.get(key);
368
261
  });
369
262
  }
370
- // Creating a backup of the node storage since it is not corrupted
371
263
  this.log.debug('Creating node storage backup...');
372
264
  await copyDirectory(path.join(this.matterbridgeDirectory, this.nodeStorageName), path.join(this.matterbridgeDirectory, this.nodeStorageName + '.backup'));
373
265
  this.log.debug('Created node storage backup');
374
266
  }
375
267
  catch (error) {
376
- // Restoring the backup of the node storage since it is corrupted
377
268
  this.log.error(`Error creating node storage manager and context: ${error instanceof Error ? error.message : error}`);
378
269
  if (hasParameter('norestore')) {
379
270
  this.log.fatal(`The matterbridge storage is corrupted. Found -norestore parameter: exiting...`);
@@ -387,20 +278,14 @@ export class Matterbridge extends EventEmitter {
387
278
  if (!this.nodeStorage || !this.nodeContext) {
388
279
  throw new Error('Fatal error creating node storage manager and context for matterbridge');
389
280
  }
390
- // Set the first port to use for the commissioning server (will be incremented in childbridge mode)
391
281
  this.port = getIntParameter('port') ?? (await this.nodeContext.get('matterport', 5540)) ?? 5540;
392
- // Set the first passcode to use for the commissioning server (will be incremented in childbridge mode)
393
282
  this.passcode = getIntParameter('passcode') ?? (await this.nodeContext.get('matterpasscode')) ?? PaseClient.generateRandomPasscode(this.environment.get(Crypto));
394
- // Set the first discriminator to use for the commissioning server (will be incremented in childbridge mode)
395
283
  this.discriminator = getIntParameter('discriminator') ?? (await this.nodeContext.get('matterdiscriminator')) ?? PaseClient.generateRandomDiscriminator(this.environment.get(Crypto));
396
- // Certificate management
397
284
  const pairingFilePath = path.join(this.matterbridgeCertDirectory, 'pairing.json');
398
285
  try {
399
- // eslint-disable-next-line n/no-unsupported-features/node-builtins
400
286
  await fs.access(pairingFilePath, fs.constants.R_OK);
401
287
  const pairingFileContent = await fs.readFile(pairingFilePath, 'utf8');
402
288
  const pairingFileJson = JSON.parse(pairingFileContent);
403
- // Set the vendorId, vendorName, productId and productName if they are present in the pairing file
404
289
  if (isValidNumber(pairingFileJson.vendorId))
405
290
  this.aggregatorVendorId = VendorId(pairingFileJson.vendorId);
406
291
  if (isValidString(pairingFileJson.vendorName, 3))
@@ -409,14 +294,11 @@ export class Matterbridge extends EventEmitter {
409
294
  this.aggregatorProductId = pairingFileJson.productId;
410
295
  if (isValidString(pairingFileJson.productName, 3))
411
296
  this.aggregatorProductName = pairingFileJson.productName;
412
- // Override the passcode and discriminator if they are present in the pairing file
413
297
  if (isValidNumber(pairingFileJson.passcode) && isValidNumber(pairingFileJson.discriminator)) {
414
298
  this.passcode = pairingFileJson.passcode;
415
299
  this.discriminator = pairingFileJson.discriminator;
416
300
  this.log.info(`Pairing file ${CYAN}${pairingFilePath}${nf} found. Using passcode ${CYAN}${this.passcode}${nf} and discriminator ${CYAN}${this.discriminator}${nf} from pairing file.`);
417
301
  }
418
- // Set the certification if it is present in the pairing file
419
- /* istanbul ignore next if */
420
302
  if (pairingFileJson.privateKey && pairingFileJson.certificate && pairingFileJson.intermediateCertificate && pairingFileJson.declaration) {
421
303
  const hexStringToUint8Array = (hexString) => {
422
304
  const matches = hexString.match(/.{1,2}/g);
@@ -434,44 +316,41 @@ export class Matterbridge extends EventEmitter {
434
316
  catch (error) {
435
317
  this.log.debug(`Pairing file ${CYAN}${pairingFilePath}${db} not found: ${error instanceof Error ? error.message : error}`);
436
318
  }
437
- // Store the passcode, discriminator and port in the node context
438
319
  await this.nodeContext.set('matterport', this.port);
439
320
  await this.nodeContext.set('matterpasscode', this.passcode);
440
321
  await this.nodeContext.set('matterdiscriminator', this.discriminator);
441
322
  this.log.debug(`Initializing server node for Matterbridge on port ${this.port} with passcode ${this.passcode} and discriminator ${this.discriminator}`);
442
- // Set matterbridge logger level (context: matterbridgeLogLevel)
443
323
  if (hasParameter('logger')) {
444
324
  const level = getParameter('logger');
445
325
  if (level === 'debug') {
446
- this.log.logLevel = "debug" /* LogLevel.DEBUG */;
326
+ this.log.logLevel = "debug";
447
327
  }
448
328
  else if (level === 'info') {
449
- this.log.logLevel = "info" /* LogLevel.INFO */;
329
+ this.log.logLevel = "info";
450
330
  }
451
331
  else if (level === 'notice') {
452
- this.log.logLevel = "notice" /* LogLevel.NOTICE */;
332
+ this.log.logLevel = "notice";
453
333
  }
454
334
  else if (level === 'warn') {
455
- this.log.logLevel = "warn" /* LogLevel.WARN */;
335
+ this.log.logLevel = "warn";
456
336
  }
457
337
  else if (level === 'error') {
458
- this.log.logLevel = "error" /* LogLevel.ERROR */;
338
+ this.log.logLevel = "error";
459
339
  }
460
340
  else if (level === 'fatal') {
461
- this.log.logLevel = "fatal" /* LogLevel.FATAL */;
341
+ this.log.logLevel = "fatal";
462
342
  }
463
343
  else {
464
344
  this.log.warn(`Invalid matterbridge logger level: ${level}. Using default level "info".`);
465
- this.log.logLevel = "info" /* LogLevel.INFO */;
345
+ this.log.logLevel = "info";
466
346
  }
467
347
  }
468
348
  else {
469
- this.log.logLevel = await this.nodeContext.get('matterbridgeLogLevel', this.matterbridgeInformation.shellyBoard ? "notice" /* LogLevel.NOTICE */ : "info" /* LogLevel.INFO */);
349
+ this.log.logLevel = await this.nodeContext.get('matterbridgeLogLevel', this.matterbridgeInformation.shellyBoard ? "notice" : "info");
470
350
  }
471
351
  this.frontend.logLevel = this.log.logLevel;
472
352
  MatterbridgeEndpoint.logLevel = this.log.logLevel;
473
353
  this.matterbridgeInformation.loggerLevel = this.log.logLevel;
474
- // Create the file logger for matterbridge (context: matterbridgeFileLog)
475
354
  if (hasParameter('filelogger') || (await this.nodeContext.get('matterbridgeFileLog', false))) {
476
355
  AnsiLogger.setGlobalLogfile(path.join(this.matterbridgeDirectory, this.matterbridgeLoggerFile), this.log.logLevel, true);
477
356
  this.matterbridgeInformation.fileLogger = true;
@@ -480,7 +359,6 @@ export class Matterbridge extends EventEmitter {
480
359
  this.log.debug(`Matterbridge logLevel: ${this.log.logLevel} fileLoger: ${this.matterbridgeInformation.fileLogger}.`);
481
360
  if (this.profile !== undefined)
482
361
  this.log.debug(`Matterbridge profile: ${this.profile}.`);
483
- // Set matter.js logger level, format and logger (context: matterLogLevel)
484
362
  if (hasParameter('matterlogger')) {
485
363
  const level = getParameter('matterlogger');
486
364
  if (level === 'debug') {
@@ -511,9 +389,7 @@ export class Matterbridge extends EventEmitter {
511
389
  }
512
390
  Logger.format = MatterLogFormat.ANSI;
513
391
  Logger.setLogger('default', this.createMatterLogger());
514
- // Logger.destinations.default.write = this.createMatterLogger();
515
392
  this.matterbridgeInformation.matterLoggerLevel = Logger.level;
516
- // Create the file logger for matter.js (context: matterFileLog)
517
393
  if (hasParameter('matterfilelogger') || (await this.nodeContext.get('matterFileLog', false))) {
518
394
  this.matterbridgeInformation.matterFileLogger = true;
519
395
  Logger.addLogger('matterfilelogger', await this.createMatterFileLogger(path.join(this.matterbridgeDirectory, this.matterLoggerFile), true), {
@@ -522,9 +398,7 @@ export class Matterbridge extends EventEmitter {
522
398
  });
523
399
  }
524
400
  this.log.debug(`Matter logLevel: ${Logger.level} fileLoger: ${this.matterbridgeInformation.matterFileLogger}.`);
525
- // Log network interfaces
526
401
  const networkInterfaces = os.networkInterfaces();
527
- // console.log(`Network interfaces:`, networkInterfaces);
528
402
  const availableAddresses = Object.entries(networkInterfaces);
529
403
  const availableInterfaces = Object.keys(networkInterfaces);
530
404
  for (const [ifaceName, ifaces] of availableAddresses) {
@@ -536,7 +410,6 @@ export class Matterbridge extends EventEmitter {
536
410
  });
537
411
  }
538
412
  }
539
- // Set the interface to use for matter server node mdnsInterface
540
413
  if (hasParameter('mdnsinterface')) {
541
414
  this.mdnsInterface = getParameter('mdnsinterface');
542
415
  }
@@ -545,7 +418,6 @@ export class Matterbridge extends EventEmitter {
545
418
  if (this.mdnsInterface === '')
546
419
  this.mdnsInterface = undefined;
547
420
  }
548
- // Validate mdnsInterface
549
421
  if (this.mdnsInterface) {
550
422
  if (!availableInterfaces.includes(this.mdnsInterface)) {
551
423
  this.log.error(`Invalid mdnsinterface: ${this.mdnsInterface}. Available interfaces are: ${availableInterfaces.join(', ')}. Using all available interfaces.`);
@@ -558,7 +430,6 @@ export class Matterbridge extends EventEmitter {
558
430
  }
559
431
  if (this.mdnsInterface)
560
432
  this.environment.vars.set('mdns.networkInterface', this.mdnsInterface);
561
- // Set the listeningAddressIpv4 for the matter commissioning server
562
433
  if (hasParameter('ipv4address')) {
563
434
  this.ipv4address = getParameter('ipv4address');
564
435
  }
@@ -567,7 +438,6 @@ export class Matterbridge extends EventEmitter {
567
438
  if (this.ipv4address === '')
568
439
  this.ipv4address = undefined;
569
440
  }
570
- // Validate ipv4address
571
441
  if (this.ipv4address) {
572
442
  let isValid = false;
573
443
  for (const [ifaceName, ifaces] of availableAddresses) {
@@ -583,7 +453,6 @@ export class Matterbridge extends EventEmitter {
583
453
  await this.nodeContext.remove('matteripv4address');
584
454
  }
585
455
  }
586
- // Set the listeningAddressIpv6 for the matter commissioning server
587
456
  if (hasParameter('ipv6address')) {
588
457
  this.ipv6address = getParameter('ipv6address');
589
458
  }
@@ -592,7 +461,6 @@ export class Matterbridge extends EventEmitter {
592
461
  if (this.ipv6address === '')
593
462
  this.ipv6address = undefined;
594
463
  }
595
- // Validate ipv6address
596
464
  if (this.ipv6address) {
597
465
  let isValid = false;
598
466
  for (const [ifaceName, ifaces] of availableAddresses) {
@@ -601,7 +469,6 @@ export class Matterbridge extends EventEmitter {
601
469
  isValid = true;
602
470
  break;
603
471
  }
604
- /* istanbul ignore next */
605
472
  if (ifaces && ifaces.find((iface) => iface.scopeid && iface.scopeid > 0 && iface.address + '%' + (process.platform === 'win32' ? iface.scopeid : ifaceName) === this.ipv6address)) {
606
473
  this.log.info(`Using ipv6address ${CYAN}${this.ipv6address}${nf} on interface ${CYAN}${ifaceName}${nf} for the Matter server node.`);
607
474
  isValid = true;
@@ -614,7 +481,6 @@ export class Matterbridge extends EventEmitter {
614
481
  await this.nodeContext.remove('matteripv6address');
615
482
  }
616
483
  }
617
- // Initialize the virtual mode
618
484
  if (hasParameter('novirtual')) {
619
485
  this.matterbridgeInformation.virtualMode = 'disabled';
620
486
  await this.nodeContext.set('virtualmode', 'disabled');
@@ -623,17 +489,12 @@ export class Matterbridge extends EventEmitter {
623
489
  this.matterbridgeInformation.virtualMode = (await this.nodeContext.get('virtualmode', 'outlet'));
624
490
  }
625
491
  this.log.debug(`Virtual mode ${this.matterbridgeInformation.virtualMode}.`);
626
- // Initialize PluginManager
627
492
  this.plugins.logLevel = this.log.logLevel;
628
493
  await this.plugins.loadFromStorage();
629
- // Initialize DeviceManager
630
494
  this.devices.logLevel = this.log.logLevel;
631
- // Get the plugins from node storage and create the plugins node storage contexts
632
495
  for (const plugin of this.plugins) {
633
496
  const packageJson = await this.plugins.parse(plugin);
634
497
  if (packageJson === null && !hasParameter('add') && !hasParameter('remove') && !hasParameter('enable') && !hasParameter('disable') && !hasParameter('reset') && !hasParameter('factoryreset')) {
635
- // Try to reinstall the plugin from npm (for Docker pull and external plugins)
636
- // We don't do this when the add and other parameters are set because we shut down the process after adding the plugin
637
498
  this.log.info(`Error parsing plugin ${plg}${plugin.name}${nf}. Trying to reinstall it from npm.`);
638
499
  try {
639
500
  const { spawnCommand } = await import('./utils/spawn.js');
@@ -656,7 +517,6 @@ export class Matterbridge extends EventEmitter {
656
517
  await plugin.nodeContext.set('description', plugin.description);
657
518
  await plugin.nodeContext.set('author', plugin.author);
658
519
  }
659
- // Log system info and create .matterbridge directory
660
520
  await this.logNodeAndSystemInfo();
661
521
  this.log.notice(`Matterbridge version ${this.matterbridgeVersion} ` +
662
522
  `${hasParameter('bridge') || (!hasParameter('childbridge') && (await this.nodeContext?.get('bridgeMode', '')) === 'bridge') ? 'mode bridge ' : ''}` +
@@ -664,7 +524,6 @@ export class Matterbridge extends EventEmitter {
664
524
  `${hasParameter('controller') ? 'mode controller ' : ''}` +
665
525
  `${this.restartMode !== '' ? 'restart mode ' + this.restartMode + ' ' : ''}` +
666
526
  `running on ${this.systemInformation.osType} (v.${this.systemInformation.osRelease}) platform ${this.systemInformation.osPlatform} arch ${this.systemInformation.osArch}`);
667
- // Check node version and throw error
668
527
  const minNodeVersion = 18;
669
528
  const nodeVersion = process.versions.node;
670
529
  const versionMajor = parseInt(nodeVersion.split('.')[0]);
@@ -672,18 +531,10 @@ export class Matterbridge extends EventEmitter {
672
531
  this.log.error(`Node version ${versionMajor} is not supported. Please upgrade to ${minNodeVersion} or above.`);
673
532
  throw new Error(`Node version ${versionMajor} is not supported. Please upgrade to ${minNodeVersion} or above.`);
674
533
  }
675
- // Parse command line
676
534
  await this.parseCommandLine();
677
- // Emit the initialize_completed event
678
535
  this.emit('initialize_completed');
679
536
  this.initialized = true;
680
537
  }
681
- /**
682
- * Parses the command line arguments and performs the corresponding actions.
683
- *
684
- * @private
685
- * @returns {Promise<void>} A promise that resolves when the command line arguments have been processed, or the process exits.
686
- */
687
538
  async parseCommandLine() {
688
539
  if (hasParameter('help')) {
689
540
  this.log.info(`\nUsage: matterbridge [options]\n
@@ -745,19 +596,6 @@ export class Matterbridge extends EventEmitter {
745
596
  }
746
597
  index++;
747
598
  }
748
- /*
749
- const serializedRegisteredDevices = await this.nodeContext?.get<SerializedMatterbridgeEndpoint[]>('devices', []);
750
- this.log.info(`│ Registered devices (${serializedRegisteredDevices?.length})`);
751
- serializedRegisteredDevices?.forEach((device, index) => {
752
- if (index !== serializedRegisteredDevices.length - 1) {
753
- this.log.info(`├─┬─ plugin ${plg}${device.pluginName}${nf} device: ${dev}${device.deviceName}${nf} uniqueId: ${YELLOW}${device.uniqueId}${nf}`);
754
- this.log.info(`│ └─ endpoint ${RED}${device.endpoint}${nf} ${typ}${device.endpointName}${nf} ${debugStringify(device.clusterServersId)}`);
755
- } else {
756
- this.log.info(`└─┬─ plugin ${plg}${device.pluginName}${nf} device: ${dev}${device.deviceName}${nf} uniqueId: ${YELLOW}${device.uniqueId}${nf}`);
757
- this.log.info(` └─ endpoint ${RED}${device.endpoint}${nf} ${typ}${device.endpointName}${nf} ${debugStringify(device.clusterServersId)}`);
758
- }
759
- });
760
- */
761
599
  this.shutdown = true;
762
600
  return;
763
601
  }
@@ -807,7 +645,6 @@ export class Matterbridge extends EventEmitter {
807
645
  this.shutdown = true;
808
646
  return;
809
647
  }
810
- // Start the matter storage and create the matterbridge context
811
648
  try {
812
649
  await this.startMatterStorage();
813
650
  }
@@ -815,21 +652,18 @@ export class Matterbridge extends EventEmitter {
815
652
  this.log.fatal(`Fatal error creating matter storage: ${error instanceof Error ? error.message : error}`);
816
653
  throw new Error(`Fatal error creating matter storage: ${error instanceof Error ? error.message : error}`);
817
654
  }
818
- // Clear the matterbridge context if the reset parameter is set
819
655
  if (hasParameter('reset') && getParameter('reset') === undefined) {
820
656
  this.initialized = true;
821
657
  await this.shutdownProcessAndReset();
822
658
  this.shutdown = true;
823
659
  return;
824
660
  }
825
- // Clear matterbridge plugin context if the reset parameter is set
826
661
  if (hasParameter('reset') && getParameter('reset') !== undefined) {
827
662
  this.log.debug(`Reset plugin ${getParameter('reset')}`);
828
663
  const plugin = this.plugins.get(getParameter('reset'));
829
664
  if (plugin) {
830
665
  const matterStorageManager = await this.matterStorageService?.open(plugin.name);
831
666
  if (!matterStorageManager) {
832
- /* istanbul ignore next */
833
667
  this.log.error(`Plugin ${plg}${plugin.name}${er} storageManager not found`);
834
668
  }
835
669
  else {
@@ -848,39 +682,32 @@ export class Matterbridge extends EventEmitter {
848
682
  this.shutdown = true;
849
683
  return;
850
684
  }
851
- // Initialize frontend
852
685
  if (getIntParameter('frontend') !== 0 || getIntParameter('frontend') === undefined)
853
686
  await this.frontend.start(getIntParameter('frontend'));
854
- // Check in 30 seconds the latest and dev versions of matterbridge and the plugins
855
687
  clearTimeout(this.checkUpdateTimeout);
856
688
  this.checkUpdateTimeout = setTimeout(async () => {
857
689
  const { checkUpdates } = await import('./update.js');
858
690
  checkUpdates(this);
859
691
  }, 30 * 1000).unref();
860
- // Check each 12 hours the latest and dev versions of matterbridge and the plugins
861
692
  clearInterval(this.checkUpdateInterval);
862
693
  this.checkUpdateInterval = setInterval(async () => {
863
694
  const { checkUpdates } = await import('./update.js');
864
695
  checkUpdates(this);
865
696
  }, 12 * 60 * 60 * 1000).unref();
866
- // Start the matterbridge in mode test
867
697
  if (hasParameter('test')) {
868
698
  this.bridgeMode = 'bridge';
869
699
  MatterbridgeEndpoint.bridgeMode = 'bridge';
870
700
  return;
871
701
  }
872
- // Start the matterbridge in mode controller
873
702
  if (hasParameter('controller')) {
874
703
  this.bridgeMode = 'controller';
875
704
  await this.startController();
876
705
  return;
877
706
  }
878
- // Check if the bridge mode is set and start matterbridge in bridge mode if not set
879
707
  if (!hasParameter('bridge') && !hasParameter('childbridge') && (await this.nodeContext?.get('bridgeMode', '')) === '') {
880
708
  this.log.info('Setting default matterbridge start mode to bridge');
881
709
  await this.nodeContext?.set('bridgeMode', 'bridge');
882
710
  }
883
- // Start matterbridge in bridge mode
884
711
  if (hasParameter('bridge') || (!hasParameter('childbridge') && (await this.nodeContext?.get('bridgeMode', '')) === 'bridge')) {
885
712
  this.bridgeMode = 'bridge';
886
713
  MatterbridgeEndpoint.bridgeMode = 'bridge';
@@ -888,7 +715,6 @@ export class Matterbridge extends EventEmitter {
888
715
  await this.startBridge();
889
716
  return;
890
717
  }
891
- // Start matterbridge in childbridge mode
892
718
  if (hasParameter('childbridge') || (!hasParameter('bridge') && (await this.nodeContext?.get('bridgeMode', '')) === 'childbridge')) {
893
719
  this.bridgeMode = 'childbridge';
894
720
  MatterbridgeEndpoint.bridgeMode = 'childbridge';
@@ -897,20 +723,10 @@ export class Matterbridge extends EventEmitter {
897
723
  return;
898
724
  }
899
725
  }
900
- /**
901
- * Asynchronously loads and starts the registered plugins.
902
- *
903
- * This method is responsible for initializing and starting all enabled plugins.
904
- * It ensures that each plugin is properly loaded and started before the bridge starts.
905
- *
906
- * @returns {Promise<void>} A promise that resolves when all plugins have been loaded and started.
907
- */
908
726
  async startPlugins() {
909
- // Check, load and start the plugins
910
727
  for (const plugin of this.plugins) {
911
728
  plugin.configJson = await this.plugins.loadConfig(plugin);
912
729
  plugin.schemaJson = await this.plugins.loadSchema(plugin);
913
- // Check if the plugin is available
914
730
  if (!(await this.plugins.resolve(plugin.path))) {
915
731
  this.log.error(`Plugin ${plg}${plugin.name}${er} not found or not validated. Disabling it.`);
916
732
  plugin.enabled = false;
@@ -928,14 +744,10 @@ export class Matterbridge extends EventEmitter {
928
744
  plugin.configured = false;
929
745
  plugin.registeredDevices = undefined;
930
746
  plugin.addedDevices = undefined;
931
- this.plugins.load(plugin, true, 'Matterbridge is starting'); // No await do it asyncronously
747
+ this.plugins.load(plugin, true, 'Matterbridge is starting');
932
748
  }
933
749
  this.frontend.wssSendRefreshRequired('plugins');
934
750
  }
935
- /**
936
- * Registers the process handlers for uncaughtException, unhandledRejection, SIGINT and SIGTERM.
937
- * When either of these signals are received, the cleanup method is called with an appropriate message.
938
- */
939
751
  registerProcessHandlers() {
940
752
  this.log.debug(`Registering uncaughtException and unhandledRejection handlers...`);
941
753
  process.removeAllListeners('uncaughtException');
@@ -962,9 +774,6 @@ export class Matterbridge extends EventEmitter {
962
774
  };
963
775
  process.on('SIGTERM', this.sigtermHandler);
964
776
  }
965
- /**
966
- * Deregisters the process uncaughtException, unhandledRejection, SIGINT and SIGTERM signal handlers.
967
- */
968
777
  deregisterProcessHandlers() {
969
778
  this.log.debug(`Deregistering uncaughtException and unhandledRejection handlers...`);
970
779
  if (this.exceptionHandler)
@@ -981,17 +790,12 @@ export class Matterbridge extends EventEmitter {
981
790
  process.off('SIGTERM', this.sigtermHandler);
982
791
  this.sigtermHandler = undefined;
983
792
  }
984
- /**
985
- * Logs the node and system information.
986
- */
987
793
  async logNodeAndSystemInfo() {
988
- // IP address information
989
794
  const networkInterfaces = os.networkInterfaces();
990
795
  this.systemInformation.interfaceName = '';
991
796
  this.systemInformation.ipv4Address = '';
992
797
  this.systemInformation.ipv6Address = '';
993
798
  for (const [interfaceName, interfaceDetails] of Object.entries(networkInterfaces)) {
994
- // this.log.debug(`Checking interface: '${interfaceName}' for '${this.mdnsInterface}'`);
995
799
  if (this.mdnsInterface && interfaceName !== this.mdnsInterface)
996
800
  continue;
997
801
  if (!interfaceDetails) {
@@ -1017,22 +821,19 @@ export class Matterbridge extends EventEmitter {
1017
821
  break;
1018
822
  }
1019
823
  }
1020
- // Node information
1021
824
  this.systemInformation.nodeVersion = process.versions.node;
1022
825
  const versionMajor = parseInt(this.systemInformation.nodeVersion.split('.')[0]);
1023
826
  const versionMinor = parseInt(this.systemInformation.nodeVersion.split('.')[1]);
1024
827
  const versionPatch = parseInt(this.systemInformation.nodeVersion.split('.')[2]);
1025
- // Host system information
1026
828
  this.systemInformation.hostname = os.hostname();
1027
829
  this.systemInformation.user = os.userInfo().username;
1028
- this.systemInformation.osType = os.type(); // "Windows_NT", "Darwin", etc.
1029
- this.systemInformation.osRelease = os.release(); // Kernel version
1030
- this.systemInformation.osPlatform = os.platform(); // "win32", "linux", "darwin", etc.
1031
- this.systemInformation.osArch = os.arch(); // "x64", "arm", etc.
1032
- this.systemInformation.totalMemory = (os.totalmem() / 1024 / 1024 / 1024).toFixed(2) + ' GB'; // Convert to GB
1033
- this.systemInformation.freeMemory = (os.freemem() / 1024 / 1024 / 1024).toFixed(2) + ' GB'; // Convert to GB
1034
- this.systemInformation.systemUptime = (os.uptime() / 60 / 60).toFixed(2) + ' hours'; // Convert to hours
1035
- // Log the system information
830
+ this.systemInformation.osType = os.type();
831
+ this.systemInformation.osRelease = os.release();
832
+ this.systemInformation.osPlatform = os.platform();
833
+ this.systemInformation.osArch = os.arch();
834
+ this.systemInformation.totalMemory = (os.totalmem() / 1024 / 1024 / 1024).toFixed(2) + ' GB';
835
+ this.systemInformation.freeMemory = (os.freemem() / 1024 / 1024 / 1024).toFixed(2) + ' GB';
836
+ this.systemInformation.systemUptime = (os.uptime() / 60 / 60).toFixed(2) + ' hours';
1036
837
  this.log.debug('Host System Information:');
1037
838
  this.log.debug(`- Hostname: ${this.systemInformation.hostname}`);
1038
839
  this.log.debug(`- User: ${this.systemInformation.user}`);
@@ -1048,17 +849,14 @@ export class Matterbridge extends EventEmitter {
1048
849
  this.log.debug(`- Total Memory: ${this.systemInformation.totalMemory}`);
1049
850
  this.log.debug(`- Free Memory: ${this.systemInformation.freeMemory}`);
1050
851
  this.log.debug(`- System Uptime: ${this.systemInformation.systemUptime}`);
1051
- // Log directories
1052
852
  this.log.debug(`Root Directory: ${this.rootDirectory}`);
1053
853
  this.log.debug(`Home Directory: ${this.homeDirectory}`);
1054
854
  this.log.debug(`Matterbridge Directory: ${this.matterbridgeDirectory}`);
1055
855
  this.log.debug(`Matterbridge Plugin Directory: ${this.matterbridgePluginDirectory}`);
1056
856
  this.log.debug(`Matterbridge Matter Certificate Directory: ${this.matterbridgeCertDirectory}`);
1057
- // Global node_modules directory
1058
857
  if (this.nodeContext)
1059
858
  this.globalModulesDirectory = this.matterbridgeInformation.globalModulesDirectory = await this.nodeContext.get('globalModulesDirectory', '');
1060
859
  if (this.globalModulesDirectory === '') {
1061
- // First run of Matterbridge so the node storage is empty
1062
860
  try {
1063
861
  const { getGlobalNodeModules } = await import('./utils/network.js');
1064
862
  this.execRunningCount++;
@@ -1068,87 +866,55 @@ export class Matterbridge extends EventEmitter {
1068
866
  await this.nodeContext?.set('globalModulesDirectory', this.globalModulesDirectory);
1069
867
  }
1070
868
  catch (error) {
1071
- // istanbul ignore next
1072
869
  this.log.error(`Error getting global node_modules directory: ${error}`);
1073
870
  }
1074
871
  }
1075
872
  else
1076
873
  this.log.debug(`Global node_modules Directory: ${this.globalModulesDirectory}`);
1077
- /* removed cause is too expensive for the shelly board and not really needed. Why should the globalModulesDirectory change?
1078
- else {
1079
- this.getGlobalNodeModules()
1080
- .then(async (globalModulesDirectory) => {
1081
- this.globalModulesDirectory = globalModulesDirectory;
1082
- this.matterbridgeInformation.globalModulesDirectory = this.globalModulesDirectory;
1083
- this.log.debug(`Global node_modules Directory: ${this.globalModulesDirectory}`);
1084
- await this.nodeContext?.set<string>('globalModulesDirectory', this.globalModulesDirectory);
1085
- })
1086
- .catch((error) => {
1087
- this.log.error(`Error getting global node_modules directory: ${error}`);
1088
- });
1089
- }*/
1090
- // Matterbridge version
1091
874
  const packageJson = JSON.parse(await fs.readFile(path.join(this.rootDirectory, 'package.json'), 'utf-8'));
1092
875
  this.matterbridgeVersion = this.matterbridgeLatestVersion = this.matterbridgeDevVersion = packageJson.version;
1093
876
  this.matterbridgeInformation.matterbridgeVersion = this.matterbridgeInformation.matterbridgeLatestVersion = this.matterbridgeInformation.matterbridgeDevVersion = packageJson.version;
1094
877
  this.log.debug(`Matterbridge Version: ${this.matterbridgeVersion}`);
1095
- // Matterbridge latest version (will be set in the checkUpdate function)
1096
878
  if (this.nodeContext)
1097
879
  this.matterbridgeLatestVersion = this.matterbridgeInformation.matterbridgeLatestVersion = await this.nodeContext.get('matterbridgeLatestVersion', this.matterbridgeVersion);
1098
880
  this.log.debug(`Matterbridge Latest Version: ${this.matterbridgeLatestVersion}`);
1099
- // Matterbridge dev version (will be set in the checkUpdate function)
1100
881
  if (this.nodeContext)
1101
882
  this.matterbridgeDevVersion = this.matterbridgeInformation.matterbridgeDevVersion = await this.nodeContext.get('matterbridgeDevVersion', this.matterbridgeVersion);
1102
883
  this.log.debug(`Matterbridge Dev Version: ${this.matterbridgeDevVersion}`);
1103
- // Current working directory
1104
884
  const currentDir = process.cwd();
1105
885
  this.log.debug(`Current Working Directory: ${currentDir}`);
1106
- // Command line arguments (excluding 'node' and the script name)
1107
886
  const cmdArgs = process.argv.slice(2).join(' ');
1108
887
  this.log.debug(`Command Line Arguments: ${cmdArgs}`);
1109
888
  }
1110
- /**
1111
- * Creates a MatterLogger function to show the matter.js log messages in AnsiLogger (for the frontend).
1112
- *
1113
- * @returns {Function} The MatterLogger function.
1114
- */
1115
889
  createMatterLogger() {
1116
- const matterLogger = new AnsiLogger({ logName: 'Matter', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "debug" /* LogLevel.DEBUG */ });
890
+ const matterLogger = new AnsiLogger({ logName: 'Matter', logTimestampFormat: 4, logLevel: "debug" });
1117
891
  return (level, formattedLog) => {
1118
892
  const logger = formattedLog.slice(44, 44 + 20).trim();
1119
893
  const message = formattedLog.slice(65);
1120
894
  matterLogger.logName = logger;
1121
895
  switch (level) {
1122
896
  case MatterLogLevel.DEBUG:
1123
- matterLogger.log("debug" /* LogLevel.DEBUG */, message);
897
+ matterLogger.log("debug", message);
1124
898
  break;
1125
899
  case MatterLogLevel.INFO:
1126
- matterLogger.log("info" /* LogLevel.INFO */, message);
900
+ matterLogger.log("info", message);
1127
901
  break;
1128
902
  case MatterLogLevel.NOTICE:
1129
- matterLogger.log("notice" /* LogLevel.NOTICE */, message);
903
+ matterLogger.log("notice", message);
1130
904
  break;
1131
905
  case MatterLogLevel.WARN:
1132
- matterLogger.log("warn" /* LogLevel.WARN */, message);
906
+ matterLogger.log("warn", message);
1133
907
  break;
1134
908
  case MatterLogLevel.ERROR:
1135
- matterLogger.log("error" /* LogLevel.ERROR */, message);
909
+ matterLogger.log("error", message);
1136
910
  break;
1137
911
  case MatterLogLevel.FATAL:
1138
- matterLogger.log("fatal" /* LogLevel.FATAL */, message);
912
+ matterLogger.log("fatal", message);
1139
913
  break;
1140
914
  }
1141
915
  };
1142
916
  }
1143
- /**
1144
- * Creates a Matter File Logger.
1145
- *
1146
- * @param {string} filePath - The path to the log file.
1147
- * @param {boolean} [unlink] - Whether to unlink the log file before creating a new one.
1148
- * @returns {Function} - A function that logs formatted messages to the log file.
1149
- */
1150
917
  async createMatterFileLogger(filePath, unlink = false) {
1151
- // 2024-08-21 08:55:19.488 DEBUG InteractionMessenger Sending DataReport chunk with 28 attributes and 0 events: 1004 bytes
1152
918
  let fileSize = 0;
1153
919
  if (unlink) {
1154
920
  try {
@@ -1159,12 +925,10 @@ export class Matterbridge extends EventEmitter {
1159
925
  }
1160
926
  }
1161
927
  return async (level, formattedLog) => {
1162
- /* istanbul ignore if */
1163
928
  if (fileSize > 100000000) {
1164
- return; // Stop logging if the file size is greater than 100MB
929
+ return;
1165
930
  }
1166
931
  fileSize += formattedLog.length;
1167
- /* istanbul ignore if */
1168
932
  if (fileSize > 100000000) {
1169
933
  await fs.appendFile(filePath, `Logging on file has been stopped because the file size is greater than 100MB.` + os.EOL);
1170
934
  return;
@@ -1197,27 +961,12 @@ export class Matterbridge extends EventEmitter {
1197
961
  }
1198
962
  };
1199
963
  }
1200
- /**
1201
- * Restarts the process by exiting the current instance and loading a new instance (/api/restart).
1202
- *
1203
- * @returns {Promise<void>} A promise that resolves when the restart is completed.
1204
- */
1205
964
  async restartProcess() {
1206
965
  await this.cleanup('restarting...', true);
1207
966
  }
1208
- /**
1209
- * Shut down the process (/api/shutdown).
1210
- *
1211
- * @returns {Promise<void>} A promise that resolves when the shutdown is completed.
1212
- */
1213
967
  async shutdownProcess() {
1214
968
  await this.cleanup('shutting down...', false);
1215
969
  }
1216
- /**
1217
- * Update matterbridge and shut down the process (virtual device 'Update Matterbridge').
1218
- *
1219
- * @returns {Promise<void>} A promise that resolves when the update is completed.
1220
- */
1221
970
  async updateProcess() {
1222
971
  this.log.info('Updating matterbridge...');
1223
972
  try {
@@ -1231,13 +980,6 @@ export class Matterbridge extends EventEmitter {
1231
980
  this.frontend.wssSendRestartRequired();
1232
981
  await this.cleanup('updating...', false);
1233
982
  }
1234
- /**
1235
- * Unregister all devices and shut down the process (/api/unregister).
1236
- *
1237
- * @param {number} [timeout] - The timeout duration to wait for the message exchange to complete in milliseconds. Default is 1000.
1238
- *
1239
- * @returns {Promise<void>} A promise that resolves when the cleanup is completed.
1240
- */
1241
983
  async unregisterAndShutdownProcess(timeout = 1000) {
1242
984
  this.log.info('Unregistering all devices and shutting down...');
1243
985
  for (const plugin of this.plugins.array()) {
@@ -1251,71 +993,46 @@ export class Matterbridge extends EventEmitter {
1251
993
  await this.removeAllBridgedEndpoints(plugin.name, 100);
1252
994
  }
1253
995
  this.log.debug('Waiting for the MessageExchange to finish...');
1254
- await wait(timeout); // Wait for MessageExchange to finish
996
+ await wait(timeout);
1255
997
  this.log.debug('Cleaning up and shutting down...');
1256
998
  await this.cleanup('unregistered all devices and shutting down...', false, timeout);
1257
999
  }
1258
- /**
1259
- * Reset commissioning and shut down the process (/api/reset).
1260
- *
1261
- * @returns {Promise<void>} A promise that resolves when the cleanup is completed.
1262
- */
1263
1000
  async shutdownProcessAndReset() {
1264
1001
  await this.cleanup('shutting down with reset...', false);
1265
1002
  }
1266
- /**
1267
- * Factory reset and shut down the process (/api/factory-reset).
1268
- *
1269
- * @returns {Promise<void>} A promise that resolves when the cleanup is completed.
1270
- */
1271
1003
  async shutdownProcessAndFactoryReset() {
1272
1004
  await this.cleanup('shutting down with factory reset...', false);
1273
1005
  }
1274
- /**
1275
- * Cleans up the Matterbridge instance.
1276
- *
1277
- * @param {string} message - The cleanup message.
1278
- * @param {boolean} [restart] - Indicates whether to restart the instance after cleanup. Default is `false`.
1279
- * @param {number} [timeout] - The timeout duration to wait for the message exchange to complete in milliseconds. Default is 1000.
1280
- *
1281
- * @returns {Promise<void>} A promise that resolves when the cleanup is completed.
1282
- */
1283
1006
  async cleanup(message, restart = false, timeout = 1000) {
1284
1007
  if (this.initialized && !this.hasCleanupStarted) {
1285
1008
  this.emit('cleanup_started');
1286
1009
  this.hasCleanupStarted = true;
1287
1010
  this.log.info(message);
1288
- // Clear the start matter interval
1289
1011
  if (this.startMatterInterval) {
1290
1012
  clearInterval(this.startMatterInterval);
1291
1013
  this.startMatterInterval = undefined;
1292
1014
  this.log.debug('Start matter interval cleared');
1293
1015
  }
1294
- // Clear the check update timeout
1295
1016
  if (this.checkUpdateTimeout) {
1296
1017
  clearTimeout(this.checkUpdateTimeout);
1297
1018
  this.checkUpdateTimeout = undefined;
1298
1019
  this.log.debug('Check update timeout cleared');
1299
1020
  }
1300
- // Clear the check update interval
1301
1021
  if (this.checkUpdateInterval) {
1302
1022
  clearInterval(this.checkUpdateInterval);
1303
1023
  this.checkUpdateInterval = undefined;
1304
1024
  this.log.debug('Check update interval cleared');
1305
1025
  }
1306
- // Clear the configure timeout
1307
1026
  if (this.configureTimeout) {
1308
1027
  clearTimeout(this.configureTimeout);
1309
1028
  this.configureTimeout = undefined;
1310
1029
  this.log.debug('Matterbridge configure timeout cleared');
1311
1030
  }
1312
- // Clear the reachability timeout
1313
1031
  if (this.reachabilityTimeout) {
1314
1032
  clearTimeout(this.reachabilityTimeout);
1315
1033
  this.reachabilityTimeout = undefined;
1316
1034
  this.log.debug('Matterbridge reachability timeout cleared');
1317
1035
  }
1318
- // Call the shutdown method of each plugin and clear the plugins reachability timeout
1319
1036
  for (const plugin of this.plugins) {
1320
1037
  if (!plugin.enabled || plugin.error)
1321
1038
  continue;
@@ -1326,7 +1043,6 @@ export class Matterbridge extends EventEmitter {
1326
1043
  this.log.debug(`Plugin ${plg}${plugin.name}${db} reachability timeout cleared`);
1327
1044
  }
1328
1045
  }
1329
- // Stop matter server nodes
1330
1046
  this.log.notice(`Stopping matter server nodes in ${this.bridgeMode} mode...`);
1331
1047
  this.log.debug('Waiting for the MessageExchange to finish...');
1332
1048
  await wait(timeout, 'Waiting for the MessageExchange to finish...', true);
@@ -1351,7 +1067,6 @@ export class Matterbridge extends EventEmitter {
1351
1067
  }
1352
1068
  }
1353
1069
  this.log.notice('Stopped matter server nodes');
1354
- // Matter commisioning reset
1355
1070
  if (message === 'shutting down with reset...') {
1356
1071
  this.log.info('Resetting Matterbridge commissioning information...');
1357
1072
  await this.matterStorageManager?.createContext('events')?.clearAll();
@@ -1361,7 +1076,6 @@ export class Matterbridge extends EventEmitter {
1361
1076
  await this.matterbridgeContext?.clearAll();
1362
1077
  this.log.info('Matter storage reset done! Remove the bridge from the controller.');
1363
1078
  }
1364
- // Unregister all devices
1365
1079
  if (message === 'unregistered all devices and shutting down...') {
1366
1080
  if (this.bridgeMode === 'bridge') {
1367
1081
  await this.matterStorageManager?.createContext('root')?.createContext('parts')?.createContext('Matterbridge')?.createContext('parts')?.clearAll();
@@ -1379,36 +1093,18 @@ export class Matterbridge extends EventEmitter {
1379
1093
  }
1380
1094
  this.log.info('Matter storage reset done!');
1381
1095
  }
1382
- // Stop matter storage
1383
1096
  await this.stopMatterStorage();
1384
- // Stop the frontend
1385
1097
  await this.frontend.stop();
1386
- // Remove the matterfilelogger
1387
1098
  try {
1388
1099
  Logger.removeLogger('matterfilelogger');
1389
1100
  }
1390
1101
  catch (error) {
1391
1102
  this.log.debug(`Error removing the matterfilelogger for file ${CYAN}${path.join(this.matterbridgeDirectory, this.matterLoggerFile)}${db}: ${error instanceof Error ? error.message : String(error)}`);
1392
1103
  }
1393
- // Close the matterbridge node storage and context
1394
1104
  if (this.nodeStorage && this.nodeContext) {
1395
- /*
1396
- TODO: Implement serialization of registered devices in edge mode
1397
- this.log.info('Saving registered devices...');
1398
- const serializedRegisteredDevices: SerializedMatterbridgeEndpoint[] = [];
1399
- this.devices.forEach(async (device) => {
1400
- const serializedMatterbridgeDevice = MatterbridgeEndpoint.serialize(device);
1401
- // this.log.info(`- ${serializedMatterbridgeDevice.deviceName}${rs}\n`, serializedMatterbridgeDevice);
1402
- if (serializedMatterbridgeDevice) serializedRegisteredDevices.push(serializedMatterbridgeDevice);
1403
- });
1404
- await this.nodeContext.set<SerializedMatterbridgeEndpoint[]>('devices', serializedRegisteredDevices);
1405
- this.log.info(`Saved registered devices (${serializedRegisteredDevices?.length})`);
1406
- */
1407
- // Clear nodeContext and nodeStorage (they just need 1000ms to write the data to disk)
1408
1105
  this.log.debug(`Closing node storage context for ${plg}Matterbridge${db}...`);
1409
1106
  await this.nodeContext.close();
1410
1107
  this.nodeContext = undefined;
1411
- // Clear nodeContext for each plugin (they just need 1000ms to write the data to disk)
1412
1108
  for (const plugin of this.plugins) {
1413
1109
  if (plugin.nodeContext) {
1414
1110
  this.log.debug(`Closing node storage context for plugin ${plg}${plugin.name}${db}...`);
@@ -1425,10 +1121,8 @@ export class Matterbridge extends EventEmitter {
1425
1121
  }
1426
1122
  this.plugins.clear();
1427
1123
  this.devices.clear();
1428
- // Factory reset
1429
1124
  if (message === 'shutting down with factory reset...') {
1430
1125
  try {
1431
- // Delete matter storage directory with its subdirectories and backup
1432
1126
  const dir = path.join(this.matterbridgeDirectory, this.matterStorageName);
1433
1127
  this.log.info(`Removing matter storage directory: ${dir}`);
1434
1128
  await fs.rm(dir, { recursive: true });
@@ -1437,13 +1131,11 @@ export class Matterbridge extends EventEmitter {
1437
1131
  await fs.rm(backup, { recursive: true });
1438
1132
  }
1439
1133
  catch (error) {
1440
- // istanbul ignore next if
1441
1134
  if (error instanceof Error && error.code !== 'ENOENT') {
1442
1135
  this.log.error(`Error removing matter storage directory: ${error}`);
1443
1136
  }
1444
1137
  }
1445
1138
  try {
1446
- // Delete matterbridge storage directory with its subdirectories and backup
1447
1139
  const dir = path.join(this.matterbridgeDirectory, this.nodeStorageName);
1448
1140
  this.log.info(`Removing matterbridge storage directory: ${dir}`);
1449
1141
  await fs.rm(dir, { recursive: true });
@@ -1452,20 +1144,18 @@ export class Matterbridge extends EventEmitter {
1452
1144
  await fs.rm(backup, { recursive: true });
1453
1145
  }
1454
1146
  catch (error) {
1455
- // istanbul ignore next if
1456
1147
  if (error instanceof Error && error.code !== 'ENOENT') {
1457
1148
  this.log.error(`Error removing matterbridge storage directory: ${error}`);
1458
1149
  }
1459
1150
  }
1460
1151
  this.log.info('Factory reset done! Remove all paired fabrics from the controllers.');
1461
1152
  }
1462
- // Deregisters the process handlers
1463
1153
  this.deregisterProcessHandlers();
1464
1154
  if (restart) {
1465
1155
  if (message === 'updating...') {
1466
1156
  this.log.info('Cleanup completed. Updating...');
1467
1157
  Matterbridge.instance = undefined;
1468
- this.emit('update'); // Restart the process but the update has been done before. TODO move all updates to the cli
1158
+ this.emit('update');
1469
1159
  }
1470
1160
  else if (message === 'restarting...') {
1471
1161
  this.log.info('Cleanup completed. Restarting...');
@@ -1486,13 +1176,6 @@ export class Matterbridge extends EventEmitter {
1486
1176
  this.log.debug('Cleanup already started...');
1487
1177
  }
1488
1178
  }
1489
- /**
1490
- * Creates and configures the server node for a single not bridged device.
1491
- *
1492
- * @param {RegisteredPlugin} plugin - The plugin to configure.
1493
- * @param {MatterbridgeEndpoint} device - The device to associate with the plugin.
1494
- * @returns {Promise<void>} A promise that resolves when the server node for the accessory plugin is created and configured.
1495
- */
1496
1179
  async createDeviceServerNode(plugin, device) {
1497
1180
  if (device.mode === 'server' && !device.serverNode && device.deviceType && device.deviceName && device.vendorId && device.vendorName && device.productId && device.productName) {
1498
1181
  this.log.debug(`Creating device ${plg}${plugin.name}${db}:${dev}${device.deviceName}${db} server node...`);
@@ -1503,13 +1186,6 @@ export class Matterbridge extends EventEmitter {
1503
1186
  this.log.debug(`Added ${plg}${plugin.name}${db}:${dev}${device.deviceName}${db} to server node`);
1504
1187
  }
1505
1188
  }
1506
- /**
1507
- * Creates and configures the server node for an accessory plugin for a given device.
1508
- *
1509
- * @param {RegisteredPlugin} plugin - The plugin to configure.
1510
- * @param {MatterbridgeEndpoint} device - The device to associate with the plugin.
1511
- * @returns {Promise<void>} A promise that resolves when the server node for the accessory plugin is created and configured.
1512
- */
1513
1189
  async createAccessoryPlugin(plugin, device) {
1514
1190
  if (!plugin.locked && device.deviceType && device.deviceName && device.vendorId && device.productId && device.vendorName && device.productName) {
1515
1191
  plugin.locked = true;
@@ -1521,12 +1197,6 @@ export class Matterbridge extends EventEmitter {
1521
1197
  await plugin.serverNode.add(device);
1522
1198
  }
1523
1199
  }
1524
- /**
1525
- * Creates and configures the server node and the aggregator node for a dynamic plugin.
1526
- *
1527
- * @param {RegisteredPlugin} plugin - The plugin to configure.
1528
- * @returns {Promise<void>} A promise that resolves when the server node and the aggregator node for the dynamic plugin is created and configured.
1529
- */
1530
1200
  async createDynamicPlugin(plugin) {
1531
1201
  if (!plugin.locked) {
1532
1202
  plugin.locked = true;
@@ -1537,14 +1207,7 @@ export class Matterbridge extends EventEmitter {
1537
1207
  await plugin.serverNode.add(plugin.aggregatorNode);
1538
1208
  }
1539
1209
  }
1540
- /**
1541
- * Starts the Matterbridge in bridge mode.
1542
- *
1543
- * @private
1544
- * @returns {Promise<void>} A promise that resolves when the Matterbridge is started.
1545
- */
1546
1210
  async startBridge() {
1547
- // Plugins are configured by a timer when matter server is started and plugin.configured is set to true
1548
1211
  if (!this.matterStorageManager)
1549
1212
  throw new Error('No storage manager initialized');
1550
1213
  if (!this.matterbridgeContext)
@@ -1583,16 +1246,13 @@ export class Matterbridge extends EventEmitter {
1583
1246
  clearInterval(this.startMatterInterval);
1584
1247
  this.startMatterInterval = undefined;
1585
1248
  this.log.debug('Cleared startMatterInterval interval for Matterbridge');
1586
- // Start the Matter server node
1587
- this.startServerNode(this.serverNode); // We don't await this, because the server node is started in the background
1588
- // Start the Matter server node of single devices in mode 'server'
1249
+ this.startServerNode(this.serverNode);
1589
1250
  for (const device of this.devices.array()) {
1590
1251
  if (device.mode === 'server' && device.serverNode) {
1591
1252
  this.log.debug(`Starting server node for device ${dev}${device.deviceName}${db} in server mode...`);
1592
- this.startServerNode(device.serverNode); // We don't await this, because the server node is started in the background
1253
+ this.startServerNode(device.serverNode);
1593
1254
  }
1594
1255
  }
1595
- // Configure the plugins
1596
1256
  this.configureTimeout = setTimeout(async () => {
1597
1257
  for (const plugin of this.plugins.array()) {
1598
1258
  if (!plugin.enabled || !plugin.loaded || !plugin.started || plugin.error)
@@ -1610,25 +1270,16 @@ export class Matterbridge extends EventEmitter {
1610
1270
  }
1611
1271
  this.frontend.wssSendRefreshRequired('plugins');
1612
1272
  }, 30 * 1000).unref();
1613
- // Setting reachability to true
1614
1273
  this.reachabilityTimeout = setTimeout(() => {
1615
1274
  this.log.info(`Setting reachability to true for ${plg}Matterbridge${db}`);
1616
1275
  if (this.aggregatorNode)
1617
1276
  this.setAggregatorReachability(this.aggregatorNode, true);
1618
1277
  this.frontend.wssSendRefreshRequired('reachability');
1619
1278
  }, 60 * 1000).unref();
1620
- // Logger.get('LogServerNode').info(this.serverNode);
1621
1279
  this.emit('bridge_started');
1622
1280
  this.log.notice('Matterbridge bridge started successfully');
1623
1281
  }, this.startMatterIntervalMs);
1624
1282
  }
1625
- /**
1626
- * Starts the Matterbridge in childbridge mode.
1627
- *
1628
- * @param {number} [delay] - The delay before starting the childbridge. Default is 1000 milliseconds.
1629
- *
1630
- * @returns {Promise<void>} A promise that resolves when the Matterbridge is started.
1631
- */
1632
1283
  async startChildbridge(delay = 1000) {
1633
1284
  if (!this.matterStorageManager)
1634
1285
  throw new Error('No storage manager initialized');
@@ -1666,9 +1317,8 @@ export class Matterbridge extends EventEmitter {
1666
1317
  clearInterval(this.startMatterInterval);
1667
1318
  this.startMatterInterval = undefined;
1668
1319
  if (delay > 0)
1669
- await wait(delay); // Wait for the specified delay to ensure all plugins server nodes are ready
1320
+ await wait(delay);
1670
1321
  this.log.debug('Cleared startMatterInterval interval in childbridge mode');
1671
- // Configure the plugins
1672
1322
  this.configureTimeout = setTimeout(async () => {
1673
1323
  for (const plugin of this.plugins.array()) {
1674
1324
  if (!plugin.enabled || !plugin.loaded || !plugin.started || plugin.error)
@@ -1705,9 +1355,7 @@ export class Matterbridge extends EventEmitter {
1705
1355
  this.log.error(`Node storage context not found for plugin ${plg}${plugin.name}${er}`);
1706
1356
  continue;
1707
1357
  }
1708
- // Start the Matter server node
1709
- this.startServerNode(plugin.serverNode); // We don't await this, because the server node is started in the background
1710
- // Setting reachability to true
1358
+ this.startServerNode(plugin.serverNode);
1711
1359
  plugin.reachabilityTimeout = setTimeout(() => {
1712
1360
  this.log.info(`Setting reachability to true for ${plg}${plugin.name}${nf} type ${plugin.type} server node ${plugin.serverNode !== undefined} aggregator node ${plugin.aggregatorNode !== undefined} device ${plugin.device !== undefined}`);
1713
1361
  if (plugin.type === 'DynamicPlatform' && plugin.aggregatorNode)
@@ -1715,241 +1363,19 @@ export class Matterbridge extends EventEmitter {
1715
1363
  this.frontend.wssSendRefreshRequired('reachability');
1716
1364
  }, 60 * 1000).unref();
1717
1365
  }
1718
- // Start the Matter server node of single devices in mode 'server'
1719
1366
  for (const device of this.devices.array()) {
1720
1367
  if (device.mode === 'server' && device.serverNode) {
1721
1368
  this.log.debug(`Starting server node for device ${dev}${device.deviceName}${db} in server mode...`);
1722
- this.startServerNode(device.serverNode); // We don't await this, because the server node is started in the background
1369
+ this.startServerNode(device.serverNode);
1723
1370
  }
1724
1371
  }
1725
- // Logger.get('LogServerNode').info(this.serverNode);
1726
1372
  this.emit('childbridge_started');
1727
1373
  this.log.notice('Matterbridge childbridge started successfully');
1728
1374
  }, this.startMatterIntervalMs);
1729
1375
  }
1730
- /**
1731
- * Starts the Matterbridge controller.
1732
- *
1733
- * @private
1734
- * @returns {Promise<void>} A promise that resolves when the Matterbridge is started.
1735
- */
1736
1376
  async startController() {
1737
- /*
1738
- if (!this.matterStorageManager) {
1739
- this.log.error('No storage manager initialized');
1740
- await this.cleanup('No storage manager initialized');
1741
- return;
1742
- }
1743
- this.log.info('Creating context: mattercontrollerContext');
1744
- this.controllerContext = this.matterStorageManager.createContext('mattercontrollerContext');
1745
- if (!this.controllerContext) {
1746
- this.log.error('No storage context mattercontrollerContext initialized');
1747
- await this.cleanup('No storage context mattercontrollerContext initialized');
1748
- return;
1749
- }
1750
-
1751
- this.log.debug('Starting matterbridge in mode', this.bridgeMode);
1752
- this.matterServer = await this.createMatterServer(this.storageManager);
1753
- this.log.info('Creating matter commissioning controller');
1754
- this.commissioningController = new CommissioningController({
1755
- autoConnect: false,
1756
- });
1757
- this.log.info('Adding matter commissioning controller to matter server');
1758
- await this.matterServer.addCommissioningController(this.commissioningController);
1759
-
1760
- this.log.info('Starting matter server');
1761
- await this.matterServer.start();
1762
- this.log.info('Matter server started');
1763
- const commissioningOptions: ControllerCommissioningFlowOptions = {
1764
- regulatoryLocation: GeneralCommissioning.RegulatoryLocationType.IndoorOutdoor,
1765
- regulatoryCountryCode: 'XX',
1766
- };
1767
- const commissioningController = new CommissioningController({
1768
- environment: {
1769
- environment,
1770
- id: uniqueId,
1771
- },
1772
- autoConnect: false, // Do not auto connect to the commissioned nodes
1773
- adminFabricLabel,
1774
- });
1775
-
1776
- if (hasParameter('pairingcode')) {
1777
- this.log.info('Pairing device with pairingcode:', getParameter('pairingcode'));
1778
- const pairingCode = getParameter('pairingcode');
1779
- const ip = this.controllerContext.has('ip') ? this.controllerContext.get<string>('ip') : undefined;
1780
- const port = this.controllerContext.has('port') ? this.controllerContext.get<number>('port') : undefined;
1781
-
1782
- let longDiscriminator, setupPin, shortDiscriminator;
1783
- if (pairingCode !== undefined) {
1784
- const pairingCodeCodec = ManualPairingCodeCodec.decode(pairingCode);
1785
- shortDiscriminator = pairingCodeCodec.shortDiscriminator;
1786
- longDiscriminator = undefined;
1787
- setupPin = pairingCodeCodec.passcode;
1788
- this.log.info(`Data extracted from pairing code: ${Logger.toJSON(pairingCodeCodec)}`);
1789
- } else {
1790
- longDiscriminator = await this.controllerContext.get('longDiscriminator', 3840);
1791
- if (longDiscriminator > 4095) throw new Error('Discriminator value must be less than 4096');
1792
- setupPin = this.controllerContext.get('pin', 20202021);
1793
- }
1794
- if ((shortDiscriminator === undefined && longDiscriminator === undefined) || setupPin === undefined) {
1795
- throw new Error('Please specify the longDiscriminator of the device to commission with -longDiscriminator or provide a valid passcode with -passcode');
1796
- }
1797
-
1798
- const options = {
1799
- commissioning: commissioningOptions,
1800
- discovery: {
1801
- knownAddress: ip !== undefined && port !== undefined ? { ip, port, type: 'udp' } : undefined,
1802
- identifierData: longDiscriminator !== undefined ? { longDiscriminator } : shortDiscriminator !== undefined ? { shortDiscriminator } : {},
1803
- },
1804
- passcode: setupPin,
1805
- } as NodeCommissioningOptions;
1806
- this.log.info('Commissioning with options:', options);
1807
- const nodeId = await this.commissioningController.commissionNode(options);
1808
- this.log.info(`Commissioning successfully done with nodeId: ${nodeId}`);
1809
- this.log.info('ActiveSessionInformation:', this.commissioningController.getActiveSessionInformation());
1810
- } // (hasParameter('pairingcode'))
1811
-
1812
- if (hasParameter('unpairall')) {
1813
- this.log.info('***Commissioning controller unpairing all nodes...');
1814
- const nodeIds = this.commissioningController.getCommissionedNodes();
1815
- for (const nodeId of nodeIds) {
1816
- this.log.info('***Commissioning controller unpairing node:', nodeId);
1817
- await this.commissioningController.removeNode(nodeId);
1818
- }
1819
- return;
1820
- }
1821
-
1822
- if (hasParameter('discover')) {
1823
- // const discover = await this.commissioningController.discoverCommissionableDevices({ productId: 0x8000, deviceType: 0xfff1 });
1824
- // console.log(discover);
1825
- }
1826
-
1827
- if (!this.commissioningController.isCommissioned()) {
1828
- this.log.info('***Commissioning controller is not commissioned: use matterbridge -controller -pairingcode [pairingcode] to commission a device');
1829
- return;
1830
- }
1831
-
1832
- const nodeIds = this.commissioningController.getCommissionedNodes();
1833
- this.log.info(`***Commissioning controller is commissioned ${this.commissioningController.isCommissioned()} and has ${nodeIds.length} nodes commisioned: `);
1834
- for (const nodeId of nodeIds) {
1835
- this.log.info(`***Connecting to commissioned node: ${nodeId}`);
1836
-
1837
- const node = await this.commissioningController.connectNode(nodeId, {
1838
- autoSubscribe: false,
1839
- attributeChangedCallback: (peerNodeId, { path: { nodeId, clusterId, endpointId, attributeName }, value }) =>
1840
- this.log.info(`***Commissioning controller attributeChangedCallback ${peerNodeId}: attribute ${nodeId}/${endpointId}/${clusterId}/${attributeName} changed to ${Logger.toJSON(value)}`),
1841
- eventTriggeredCallback: (peerNodeId, { path: { nodeId, clusterId, endpointId, eventName }, events }) =>
1842
- this.log.info(`***Commissioning controller eventTriggeredCallback ${peerNodeId}: Event ${nodeId}/${endpointId}/${clusterId}/${eventName} triggered with ${Logger.toJSON(events)}`),
1843
- stateInformationCallback: (peerNodeId, info) => {
1844
- switch (info) {
1845
- case NodeStateInformation.Connected:
1846
- this.log.info(`***Commissioning controller stateInformationCallback ${peerNodeId}: Node ${nodeId} connected`);
1847
- break;
1848
- case NodeStateInformation.Disconnected:
1849
- this.log.info(`***Commissioning controller stateInformationCallback ${peerNodeId}: Node ${nodeId} disconnected`);
1850
- break;
1851
- case NodeStateInformation.Reconnecting:
1852
- this.log.info(`***Commissioning controller stateInformationCallback ${peerNodeId}: Node ${nodeId} reconnecting`);
1853
- break;
1854
- case NodeStateInformation.WaitingForDeviceDiscovery:
1855
- this.log.info(`***Commissioning controller stateInformationCallback ${peerNodeId}: Node ${nodeId} waiting for device discovery`);
1856
- break;
1857
- case NodeStateInformation.StructureChanged:
1858
- this.log.info(`***Commissioning controller stateInformationCallback ${peerNodeId}: Node ${nodeId} structure changed`);
1859
- break;
1860
- case NodeStateInformation.Decommissioned:
1861
- this.log.info(`***Commissioning controller stateInformationCallback ${peerNodeId}: Node ${nodeId} decommissioned`);
1862
- break;
1863
- default:
1864
- this.log.info(`***Commissioning controller stateInformationCallback ${peerNodeId}: Node ${nodeId} NodeStateInformation.${info}`);
1865
- break;
1866
- }
1867
- },
1868
- });
1869
-
1870
- node.logStructure();
1871
-
1872
- // Get the interaction client
1873
- this.log.info('Getting the interaction client');
1874
- const interactionClient = await node.getInteractionClient();
1875
- let cluster;
1876
- let attributes;
1877
-
1878
- // Log BasicInformationCluster
1879
- cluster = BasicInformationCluster;
1880
- attributes = await interactionClient.getMultipleAttributes({
1881
- attributes: [{ clusterId: cluster.id }],
1882
- });
1883
- if (attributes.length > 0) this.log.info(`Cluster: ${idn}${cluster.name}${rs}${nf} attributes:`);
1884
- attributes.forEach((attribute) => {
1885
- this.log.info(
1886
- `- endpoint ${or}${attribute.path.endpointId}${nf} cluster ${hk}${getClusterNameById(attribute.path.clusterId)}${nf} (${hk}0x${attribute.path.clusterId.toString(16)}${nf}) attribute ${zb}${attribute.path.attributeName}${nf} (${zb}0x${attribute.path.attributeId.toString(16)}${nf}): ${typeof attribute.value === 'object' ? stringify(attribute.value) : attribute.value}`,
1887
- );
1888
- });
1889
-
1890
- // Log PowerSourceCluster
1891
- cluster = PowerSourceCluster;
1892
- attributes = await interactionClient.getMultipleAttributes({
1893
- attributes: [{ clusterId: cluster.id }],
1894
- });
1895
- if (attributes.length > 0) this.log.info(`Cluster: ${idn}${cluster.name}${rs}${nf} attributes:`);
1896
- attributes.forEach((attribute) => {
1897
- this.log.info(
1898
- `- endpoint ${or}${attribute.path.endpointId}${nf} cluster ${hk}${getClusterNameById(attribute.path.clusterId)}${nf} (${hk}0x${attribute.path.clusterId.toString(16)}${nf}) attribute ${zb}${attribute.path.attributeName}${nf} (${zb}0x${attribute.path.attributeId.toString(16)}${nf}): ${typeof attribute.value === 'object' ? stringify(attribute.value) : attribute.value}`,
1899
- );
1900
- });
1901
-
1902
- // Log ThreadNetworkDiagnostics
1903
- cluster = ThreadNetworkDiagnosticsCluster;
1904
- attributes = await interactionClient.getMultipleAttributes({
1905
- attributes: [{ clusterId: cluster.id }],
1906
- });
1907
- if (attributes.length > 0) this.log.info(`Cluster: ${idn}${cluster.name}${rs}${nf} attributes:`);
1908
- attributes.forEach((attribute) => {
1909
- this.log.info(
1910
- `- endpoint ${or}${attribute.path.endpointId}${nf} cluster ${hk}${getClusterNameById(attribute.path.clusterId)}${nf} (${hk}0x${attribute.path.clusterId.toString(16)}${nf}) attribute ${zb}${attribute.path.attributeName}${nf} (${zb}0x${attribute.path.attributeId.toString(16)}${nf}): ${typeof attribute.value === 'object' ? stringify(attribute.value) : attribute.value}`,
1911
- );
1912
- });
1913
-
1914
- // Log SwitchCluster
1915
- cluster = SwitchCluster;
1916
- attributes = await interactionClient.getMultipleAttributes({
1917
- attributes: [{ clusterId: cluster.id }],
1918
- });
1919
- if (attributes.length > 0) this.log.info(`Cluster: ${idn}${cluster.name}${rs}${nf} attributes:`);
1920
- attributes.forEach((attribute) => {
1921
- this.log.info(
1922
- `- endpoint ${or}${attribute.path.endpointId}${nf} cluster ${hk}${getClusterNameById(attribute.path.clusterId)}${nf} (${hk}0x${attribute.path.clusterId.toString(16)}${nf}) attribute ${zb}${attribute.path.attributeName}${nf} (${zb}0x${attribute.path.attributeId.toString(16)}${nf}): ${typeof attribute.value === 'object' ? stringify(attribute.value) : attribute.value}`,
1923
- );
1924
- });
1925
-
1926
- this.log.info('Subscribing to all attributes and events');
1927
- await node.subscribeAllAttributesAndEvents({
1928
- ignoreInitialTriggers: false,
1929
- attributeChangedCallback: ({ path: { nodeId, clusterId, endpointId, attributeName }, version, value }) =>
1930
- this.log.info(
1931
- `***${db}Commissioning controller attributeChangedCallback version ${version}: attribute ${BLUE}${nodeId}${db}/${or}${endpointId}${db}/${hk}${getClusterNameById(clusterId)}${db}/${zb}${attributeName}${db} changed to ${typeof value === 'object' ? debugStringify(value ?? { none: true }) : value}`,
1932
- ),
1933
- eventTriggeredCallback: ({ path: { nodeId, clusterId, endpointId, eventName }, events }) => {
1934
- this.log.info(
1935
- `***${db}Commissioning controller eventTriggeredCallback: event ${BLUE}${nodeId}${db}/${or}${endpointId}${db}/${hk}${getClusterNameById(clusterId)}${db}/${zb}${eventName}${db} triggered with ${debugStringify(events ?? { none: true })}`,
1936
- );
1937
- },
1938
- });
1939
- this.log.info('Subscribed to all attributes and events');
1940
- }
1941
- */
1942
1377
  }
1943
- /** */
1944
- /** Matter.js methods */
1945
- /** */
1946
- /**
1947
- * Starts the matter storage with name Matterbridge, create the matterbridge context and performs a backup.
1948
- *
1949
- * @returns {Promise<void>} - A promise that resolves when the storage is started.
1950
- */
1951
1378
  async startMatterStorage() {
1952
- // Setup Matter storage
1953
1379
  this.log.info(`Starting matter node storage...`);
1954
1380
  this.matterStorageService = this.environment.get(StorageService);
1955
1381
  this.log.info(`Matter node storage service created: ${this.matterStorageService.location}`);
@@ -1958,17 +1384,8 @@ export class Matterbridge extends EventEmitter {
1958
1384
  this.matterbridgeContext = await this.createServerNodeContext('Matterbridge', 'Matterbridge', bridge.code, this.aggregatorVendorId, this.aggregatorVendorName, this.aggregatorProductId, this.aggregatorProductName);
1959
1385
  this.matterbridgeInformation.matterbridgeSerialNumber = await this.matterbridgeContext.get('serialNumber', '');
1960
1386
  this.log.info('Matter node storage started');
1961
- // Backup matter storage since it is created/opened correctly
1962
1387
  await this.backupMatterStorage(path.join(this.matterbridgeDirectory, this.matterStorageName), path.join(this.matterbridgeDirectory, this.matterStorageName + '.backup'));
1963
1388
  }
1964
- /**
1965
- * Makes a backup copy of the specified matter storage directory.
1966
- *
1967
- * @param {string} storageName - The name of the storage directory to be backed up.
1968
- * @param {string} backupName - The name of the backup directory to be created.
1969
- * @private
1970
- * @returns {Promise<void>} A promise that resolves when the has been done.
1971
- */
1972
1389
  async backupMatterStorage(storageName, backupName) {
1973
1390
  this.log.info('Creating matter node storage backup...');
1974
1391
  try {
@@ -1979,11 +1396,6 @@ export class Matterbridge extends EventEmitter {
1979
1396
  this.log.error(`Error creating matter node storage backup from ${storageName} to ${backupName}:`, error);
1980
1397
  }
1981
1398
  }
1982
- /**
1983
- * Stops the matter storage.
1984
- *
1985
- * @returns {Promise<void>} A promise that resolves when the storage is stopped.
1986
- */
1987
1399
  async stopMatterStorage() {
1988
1400
  this.log.info('Closing matter node storage...');
1989
1401
  await this.matterStorageManager?.close();
@@ -1992,19 +1404,6 @@ export class Matterbridge extends EventEmitter {
1992
1404
  this.matterbridgeContext = undefined;
1993
1405
  this.log.info('Matter node storage closed');
1994
1406
  }
1995
- /**
1996
- * Creates a server node storage context.
1997
- *
1998
- * @param {string} pluginName - The name of the plugin.
1999
- * @param {string} deviceName - The name of the device.
2000
- * @param {DeviceTypeId} deviceType - The device type of the device.
2001
- * @param {number} vendorId - The vendor ID.
2002
- * @param {string} vendorName - The vendor name.
2003
- * @param {number} productId - The product ID.
2004
- * @param {string} productName - The product name.
2005
- * @param {string} [serialNumber] - The serial number of the device (optional).
2006
- * @returns {Promise<StorageContext>} The storage context for the commissioning server.
2007
- */
2008
1407
  async createServerNodeContext(pluginName, deviceName, deviceType, vendorId, vendorName, productId, productName, serialNumber) {
2009
1408
  const { randomBytes } = await import('node:crypto');
2010
1409
  if (!this.matterStorageService)
@@ -2038,15 +1437,6 @@ export class Matterbridge extends EventEmitter {
2038
1437
  this.log.debug(`- hardwareVersion: ${await storageContext.get('hardwareVersion')} hardwareVersionString: ${await storageContext.get('hardwareVersionString')}`);
2039
1438
  return storageContext;
2040
1439
  }
2041
- /**
2042
- * Creates a server node.
2043
- *
2044
- * @param {StorageContext} storageContext - The storage context for the server node.
2045
- * @param {number} [port] - The port number for the server node. Defaults to 5540.
2046
- * @param {number} [passcode] - The passcode for the server node. Defaults to 20242025.
2047
- * @param {number} [discriminator] - The discriminator for the server node. Defaults to 3850.
2048
- * @returns {Promise<ServerNode<ServerNode.RootEndpoint>>} A promise that resolves to the created server node.
2049
- */
2050
1440
  async createServerNode(storageContext, port = 5540, passcode = 20242025, discriminator = 3850) {
2051
1441
  const storeId = await storageContext.get('storeId');
2052
1442
  this.log.notice(`Creating server node for ${storeId} on port ${port} with passcode ${passcode} and discriminator ${discriminator}...`);
@@ -2056,37 +1446,24 @@ export class Matterbridge extends EventEmitter {
2056
1446
  this.log.debug(`- uniqueId: ${await storageContext.get('uniqueId')}`);
2057
1447
  this.log.debug(`- softwareVersion: ${await storageContext.get('softwareVersion')} softwareVersionString: ${await storageContext.get('softwareVersionString')}`);
2058
1448
  this.log.debug(`- hardwareVersion: ${await storageContext.get('hardwareVersion')} hardwareVersionString: ${await storageContext.get('hardwareVersionString')}`);
2059
- /**
2060
- * Create a Matter ServerNode, which contains the Root Endpoint and all relevant data and configuration
2061
- */
2062
1449
  const serverNode = await ServerNode.create({
2063
- // Required: Give the Node a unique ID which is used to store the state of this node
2064
1450
  id: storeId,
2065
- // Provide Network relevant configuration like the port
2066
- // Optional when operating only one device on a host, Default port is 5540
2067
1451
  network: {
2068
1452
  listeningAddressIpv4: this.ipv4address,
2069
1453
  listeningAddressIpv6: this.ipv6address,
2070
1454
  port,
2071
1455
  },
2072
- // Provide the certificate for the device
2073
1456
  operationalCredentials: {
2074
1457
  certification: this.certification,
2075
1458
  },
2076
- // Provide Commissioning relevant settings
2077
- // Optional for development/testing purposes
2078
1459
  commissioning: {
2079
1460
  passcode,
2080
1461
  discriminator,
2081
1462
  },
2082
- // Provide Node announcement settings
2083
- // Optional: If Ommitted some development defaults are used
2084
1463
  productDescription: {
2085
1464
  name: await storageContext.get('deviceName'),
2086
1465
  deviceType: DeviceTypeId(await storageContext.get('deviceType')),
2087
1466
  },
2088
- // Provide defaults for the BasicInformation cluster on the Root endpoint
2089
- // Optional: If Omitted some development defaults are used
2090
1467
  basicInformation: {
2091
1468
  vendorId: VendorId(await storageContext.get('vendorId')),
2092
1469
  vendorName: await storageContext.get('vendorName'),
@@ -2103,20 +1480,14 @@ export class Matterbridge extends EventEmitter {
2103
1480
  reachable: true,
2104
1481
  },
2105
1482
  });
2106
- /**
2107
- * This event is triggered when the device is initially commissioned successfully.
2108
- * This means: It is added to the first fabric.
2109
- */
2110
1483
  serverNode.lifecycle.commissioned.on(() => {
2111
1484
  this.log.notice(`Server node for ${storeId} was initially commissioned successfully!`);
2112
1485
  clearTimeout(this.endAdvertiseTimeout);
2113
1486
  });
2114
- /** This event is triggered when all fabrics are removed from the device, usually it also does a factory reset then. */
2115
1487
  serverNode.lifecycle.decommissioned.on(() => {
2116
1488
  this.log.notice(`Server node for ${storeId} was fully decommissioned successfully!`);
2117
1489
  clearTimeout(this.endAdvertiseTimeout);
2118
1490
  });
2119
- /** This event is triggered when the device went online. This means that it is discoverable in the network. */
2120
1491
  serverNode.lifecycle.online.on(async () => {
2121
1492
  this.log.notice(`Server node for ${storeId} is online`);
2122
1493
  if (!serverNode.lifecycle.isCommissioned) {
@@ -2124,11 +1495,9 @@ export class Matterbridge extends EventEmitter {
2124
1495
  const { qrPairingCode, manualPairingCode } = serverNode.state.commissioning.pairingCodes;
2125
1496
  this.log.notice(`QR Code URL: https://project-chip.github.io/connectedhomeip/qrcode.html?data=${qrPairingCode}`);
2126
1497
  this.log.notice(`Manual pairing code: ${manualPairingCode}`);
2127
- // Set a timeout to show that advertising stops after 15 minutes if not commissioned
2128
1498
  this.startEndAdvertiseTimer(serverNode);
2129
1499
  }
2130
1500
  else {
2131
- // istanbul ignore next
2132
1501
  this.log.notice(`Server node for ${storeId} is already commissioned. Waiting for controllers to connect ...`);
2133
1502
  }
2134
1503
  this.frontend.wssSendRefreshRequired('plugins');
@@ -2136,19 +1505,14 @@ export class Matterbridge extends EventEmitter {
2136
1505
  this.frontend.wssSendSnackbarMessage(`${storeId} is online`, 5, 'success');
2137
1506
  this.emit('online', storeId);
2138
1507
  });
2139
- /** This event is triggered when the device went offline. it is not longer discoverable or connectable in the network. */
2140
1508
  serverNode.lifecycle.offline.on(() => {
2141
1509
  this.log.notice(`Server node for ${storeId} is offline`);
2142
- this.matterbridgeInformation.matterbridgeEndAdvertise = true; // Set the end advertise flag to true, so the frontend won't show the QR code anymore
1510
+ this.matterbridgeInformation.matterbridgeEndAdvertise = true;
2143
1511
  this.frontend.wssSendRefreshRequired('plugins');
2144
1512
  this.frontend.wssSendRefreshRequired('settings');
2145
1513
  this.frontend.wssSendSnackbarMessage(`${storeId} is offline`, 5, 'warning');
2146
1514
  this.emit('offline', storeId);
2147
1515
  });
2148
- /**
2149
- * This event is triggered when a fabric is added, removed or updated on the device. Use this if more granular
2150
- * information is needed.
2151
- */
2152
1516
  serverNode.events.commissioning.fabricsChanged.on((fabricIndex, fabricAction) => {
2153
1517
  let action = '';
2154
1518
  switch (fabricAction) {
@@ -2165,22 +1529,14 @@ export class Matterbridge extends EventEmitter {
2165
1529
  this.log.notice(`Commissioned fabric index ${fabricIndex} ${action} on server node for ${storeId}: ${debugStringify(serverNode.state.commissioning.fabrics[fabricIndex])}`);
2166
1530
  this.frontend.wssSendRefreshRequired('fabrics');
2167
1531
  });
2168
- /**
2169
- * This event is triggered when an operative new session was opened by a Controller.
2170
- * It is not triggered for the initial commissioning process, just afterwards for real connections.
2171
- */
2172
1532
  serverNode.events.sessions.opened.on((session) => {
2173
1533
  this.log.notice(`Session opened on server node for ${storeId}: ${debugStringify(session)}`);
2174
1534
  this.frontend.wssSendRefreshRequired('sessions');
2175
1535
  });
2176
- /**
2177
- * This event is triggered when an operative session is closed by a Controller or because the Device goes offline.
2178
- */
2179
1536
  serverNode.events.sessions.closed.on((session) => {
2180
1537
  this.log.notice(`Session closed on server node for ${storeId}: ${debugStringify(session)}`);
2181
1538
  this.frontend.wssSendRefreshRequired('sessions');
2182
1539
  });
2183
- /** This event is triggered when a subscription gets added or removed on an operative session. */
2184
1540
  serverNode.events.sessions.subscriptionsChanged.on((session) => {
2185
1541
  this.log.notice(`Session subscriptions changed on server node for ${storeId}: ${debugStringify(session)}`);
2186
1542
  this.frontend.wssSendRefreshRequired('sessions');
@@ -2188,11 +1544,6 @@ export class Matterbridge extends EventEmitter {
2188
1544
  this.log.info(`Created server node for ${storeId}`);
2189
1545
  return serverNode;
2190
1546
  }
2191
- /**
2192
- * Starts the 15 minutes timer to advice that advertising for the specified server node is ended.
2193
- *
2194
- * @param {ServerNode} [matterServerNode] - The server node to start.
2195
- */
2196
1547
  startEndAdvertiseTimer(matterServerNode) {
2197
1548
  if (this.endAdvertiseTimeout) {
2198
1549
  this.log.debug(`Clear ${matterServerNode.id} server node end advertise timer`);
@@ -2211,25 +1562,12 @@ export class Matterbridge extends EventEmitter {
2211
1562
  this.log.notice(`Advertising on server node for ${matterServerNode.id} stopped. Restart to commission.`);
2212
1563
  }, 15 * 60 * 1000).unref();
2213
1564
  }
2214
- /**
2215
- * Starts the specified server node.
2216
- *
2217
- * @param {ServerNode} [matterServerNode] - The server node to start.
2218
- * @returns {Promise<void>} A promise that resolves when the server node has started.
2219
- */
2220
1565
  async startServerNode(matterServerNode) {
2221
1566
  if (!matterServerNode)
2222
1567
  return;
2223
1568
  this.log.notice(`Starting ${matterServerNode.id} server node`);
2224
1569
  await matterServerNode.start();
2225
1570
  }
2226
- /**
2227
- * Stops the specified server node.
2228
- *
2229
- * @param {ServerNode} matterServerNode - The server node to stop.
2230
- * @param {number} [timeout] - The timeout in milliseconds for stopping the server node. Defaults to 30 seconds.
2231
- * @returns {Promise<void>} A promise that resolves when the server node has stopped.
2232
- */
2233
1571
  async stopServerNode(matterServerNode, timeout = 30000) {
2234
1572
  if (!matterServerNode)
2235
1573
  return;
@@ -2242,12 +1580,6 @@ export class Matterbridge extends EventEmitter {
2242
1580
  this.log.error(`Failed to close ${matterServerNode.id} server node: ${error instanceof Error ? error.message : error}`);
2243
1581
  }
2244
1582
  }
2245
- /**
2246
- * Advertises the specified server node.
2247
- *
2248
- * @param {ServerNode} [matterServerNode] - The server node to advertise.
2249
- * @returns {Promise<{ qrPairingCode: string, manualPairingCode: string } | undefined>} A promise that resolves to the pairing codes if the server node is advertised, or undefined if not.
2250
- */
2251
1583
  async advertiseServerNode(matterServerNode) {
2252
1584
  if (matterServerNode) {
2253
1585
  await matterServerNode.env.get(DeviceCommissioner)?.allowBasicCommissioning();
@@ -2256,39 +1588,19 @@ export class Matterbridge extends EventEmitter {
2256
1588
  return { qrPairingCode, manualPairingCode };
2257
1589
  }
2258
1590
  }
2259
- /**
2260
- * Stop advertise the specified server node.
2261
- *
2262
- * @param {ServerNode} [matterServerNode] - The server node to advertise.
2263
- * @returns {Promise<void>} A promise that resolves when the server node has stopped advertising.
2264
- */
2265
1591
  async stopAdvertiseServerNode(matterServerNode) {
2266
1592
  if (matterServerNode && matterServerNode.lifecycle.isOnline) {
2267
1593
  await matterServerNode.env.get(DeviceCommissioner)?.endCommissioning();
2268
1594
  this.log.notice(`Stopped advertising for ${matterServerNode.id}`);
2269
1595
  }
2270
1596
  }
2271
- /**
2272
- * Creates an aggregator node with the specified storage context.
2273
- *
2274
- * @param {StorageContext} storageContext - The storage context for the aggregator node.
2275
- * @returns {Promise<Endpoint<AggregatorEndpoint>>} A promise that resolves to the created aggregator node.
2276
- */
2277
1597
  async createAggregatorNode(storageContext) {
2278
1598
  this.log.notice(`Creating ${await storageContext.get('storeId')} aggregator...`);
2279
1599
  const aggregatorNode = new Endpoint(AggregatorEndpoint, { id: `${await storageContext.get('storeId')}` });
2280
1600
  this.log.info(`Created ${await storageContext.get('storeId')} aggregator`);
2281
1601
  return aggregatorNode;
2282
1602
  }
2283
- /**
2284
- * Adds a MatterbridgeEndpoint to the specified plugin.
2285
- *
2286
- * @param {string} pluginName - The name of the plugin.
2287
- * @param {MatterbridgeEndpoint} device - The device to add as a bridged endpoint.
2288
- * @returns {Promise<void>} A promise that resolves when the bridged endpoint has been added.
2289
- */
2290
1603
  async addBridgedEndpoint(pluginName, device) {
2291
- // Check if the plugin is registered
2292
1604
  const plugin = this.plugins.get(pluginName);
2293
1605
  if (!plugin) {
2294
1606
  this.log.error(`Error adding bridged endpoint ${dev}${device.deviceName}${er} (${zb}${device.id}${er}) plugin ${plg}${pluginName}${er} not found`);
@@ -2308,7 +1620,6 @@ export class Matterbridge extends EventEmitter {
2308
1620
  }
2309
1621
  else if (this.bridgeMode === 'bridge') {
2310
1622
  if (device.mode === 'matter') {
2311
- // Register and add the device to the matterbridge server node
2312
1623
  this.log.debug(`Adding matter endpoint ${plg}${pluginName}${db}:${dev}${device.deviceName}${db} to Matterbridge server node...`);
2313
1624
  if (!this.serverNode) {
2314
1625
  this.log.error('Server node not found for Matterbridge');
@@ -2325,7 +1636,6 @@ export class Matterbridge extends EventEmitter {
2325
1636
  }
2326
1637
  }
2327
1638
  else {
2328
- // Register and add the device to the matterbridge aggregator node
2329
1639
  this.log.debug(`Adding bridged endpoint ${plg}${pluginName}${db}:${dev}${device.deviceName}${db} to Matterbridge aggregator node`);
2330
1640
  if (!this.aggregatorNode) {
2331
1641
  this.log.error('Aggregator node not found for Matterbridge');
@@ -2343,7 +1653,6 @@ export class Matterbridge extends EventEmitter {
2343
1653
  }
2344
1654
  }
2345
1655
  else if (this.bridgeMode === 'childbridge') {
2346
- // Register and add the device to the plugin server node
2347
1656
  if (plugin.type === 'AccessoryPlatform') {
2348
1657
  try {
2349
1658
  this.log.debug(`Creating endpoint ${dev}${device.deviceName}${db} for AccessoryPlatform plugin ${plg}${plugin.name}${db} server node`);
@@ -2367,12 +1676,10 @@ export class Matterbridge extends EventEmitter {
2367
1676
  return;
2368
1677
  }
2369
1678
  }
2370
- // Register and add the device to the plugin aggregator node
2371
1679
  if (plugin.type === 'DynamicPlatform') {
2372
1680
  try {
2373
1681
  this.log.debug(`Adding bridged endpoint ${dev}${device.deviceName}${db} for DynamicPlatform plugin ${plg}${plugin.name}${db} aggregator node`);
2374
1682
  await this.createDynamicPlugin(plugin);
2375
- // Fast plugins can add another device before the server node is ready, so we wait for the server node to be ready
2376
1683
  await waiter(`createDynamicPlugin(${plugin.name})`, () => plugin.serverNode?.hasParts === true);
2377
1684
  if (!plugin.aggregatorNode) {
2378
1685
  this.log.error(`Aggregator node not found for plugin ${plg}${plugin.name}${er}`);
@@ -2395,28 +1702,17 @@ export class Matterbridge extends EventEmitter {
2395
1702
  plugin.registeredDevices++;
2396
1703
  if (plugin.addedDevices !== undefined)
2397
1704
  plugin.addedDevices++;
2398
- // Add the device to the DeviceManager
2399
1705
  this.devices.set(device);
2400
- // Subscribe to the reachable$Changed event
2401
1706
  await this.subscribeAttributeChanged(plugin, device);
2402
1707
  this.log.info(`Added and registered bridged endpoint (${plugin.registeredDevices}/${plugin.addedDevices}) ${dev}${device.deviceName}${nf} (${dev}${device.id}${nf}) for plugin ${plg}${pluginName}${nf}`);
2403
1708
  }
2404
- /**
2405
- * Removes a MatterbridgeEndpoint from the specified plugin.
2406
- *
2407
- * @param {string} pluginName - The name of the plugin.
2408
- * @param {MatterbridgeEndpoint} device - The device to remove as a bridged endpoint.
2409
- * @returns {Promise<void>} A promise that resolves when the bridged endpoint has been removed.
2410
- */
2411
1709
  async removeBridgedEndpoint(pluginName, device) {
2412
1710
  this.log.debug(`Removing bridged endpoint ${plg}${pluginName}${db}:${dev}${device.deviceName}${db} (${zb}${device.name}${db}) for plugin ${plg}${pluginName}${db}`);
2413
- // Check if the plugin is registered
2414
1711
  const plugin = this.plugins.get(pluginName);
2415
1712
  if (!plugin) {
2416
1713
  this.log.error(`Error removing bridged endpoint ${dev}${device.deviceName}${er} (${zb}${device.name}${er}) for plugin ${plg}${pluginName}${er}: plugin not found`);
2417
1714
  return;
2418
1715
  }
2419
- // Register and add the device to the matterbridge aggregator node
2420
1716
  if (this.bridgeMode === 'bridge') {
2421
1717
  if (!this.aggregatorNode) {
2422
1718
  this.log.error(`Error removing bridged endpoint ${dev}${device.deviceName}${er} (${zb}${device.name}${er}) for plugin ${plg}${pluginName}${er}: aggregator node not found`);
@@ -2431,7 +1727,6 @@ export class Matterbridge extends EventEmitter {
2431
1727
  }
2432
1728
  else if (this.bridgeMode === 'childbridge') {
2433
1729
  if (plugin.type === 'AccessoryPlatform') {
2434
- // Nothing to do here since the server node has no aggregator node but only the device itself
2435
1730
  }
2436
1731
  else if (plugin.type === 'DynamicPlatform') {
2437
1732
  if (!plugin.aggregatorNode) {
@@ -2446,21 +1741,8 @@ export class Matterbridge extends EventEmitter {
2446
1741
  if (plugin.addedDevices !== undefined)
2447
1742
  plugin.addedDevices--;
2448
1743
  }
2449
- // Remove the device from the DeviceManager
2450
1744
  this.devices.remove(device);
2451
1745
  }
2452
- /**
2453
- * Removes all bridged endpoints from the specified plugin.
2454
- *
2455
- * @param {string} pluginName - The name of the plugin.
2456
- * @param {number} [delay] - The delay in milliseconds between removing each bridged endpoint (default: 0).
2457
- * @returns {Promise<void>} A promise that resolves when all bridged endpoints have been removed.
2458
- *
2459
- * @remarks
2460
- * This method iterates through all devices in the DeviceManager and removes each bridged endpoint associated with the specified plugin.
2461
- * It also applies a delay between each removal if specified.
2462
- * The delay is useful to allow the controllers to receive a single subscription for each device removed.
2463
- */
2464
1746
  async removeAllBridgedEndpoints(pluginName, delay = 0) {
2465
1747
  this.log.debug(`Removing all bridged endpoints for plugin ${plg}${pluginName}${db}${delay > 0 ? ` with delay ${delay} ms` : ''}`);
2466
1748
  for (const device of this.devices.array().filter((device) => device.plugin === pluginName)) {
@@ -2471,15 +1753,6 @@ export class Matterbridge extends EventEmitter {
2471
1753
  if (delay > 0)
2472
1754
  await wait(2000);
2473
1755
  }
2474
- /**
2475
- * Subscribes to the attribute change event for the given device and plugin.
2476
- * Specifically, it listens for changes in the 'reachable' attribute of the
2477
- * BridgedDeviceBasicInformationServer cluster server of the bridged device or BasicInformationServer cluster server of server node.
2478
- *
2479
- * @param {RegisteredPlugin} plugin - The plugin associated with the device.
2480
- * @param {MatterbridgeEndpoint} device - The device to subscribe to attribute changes for.
2481
- * @returns {Promise<void>} A promise that resolves when the subscription is set up.
2482
- */
2483
1756
  async subscribeAttributeChanged(plugin, device) {
2484
1757
  this.log.info(`Subscribing attributes for endpoint ${dev}${device.deviceName}${nf} (${dev}${device.id}${nf}) plugin ${plg}${plugin.name}${nf}`);
2485
1758
  if (this.bridgeMode === 'childbridge' && plugin.type === 'AccessoryPlatform' && plugin.serverNode) {
@@ -2495,12 +1768,6 @@ export class Matterbridge extends EventEmitter {
2495
1768
  });
2496
1769
  }
2497
1770
  }
2498
- /**
2499
- * Sanitizes the fabric information by converting bigint properties to strings because `res.json` doesn't support bigint.
2500
- *
2501
- * @param {ExposedFabricInformation[]} fabricInfo - The array of exposed fabric information objects.
2502
- * @returns {SanitizedExposedFabricInformation[]} An array of sanitized exposed fabric information objects.
2503
- */
2504
1771
  sanitizeFabricInformations(fabricInfo) {
2505
1772
  return fabricInfo.map((info) => {
2506
1773
  return {
@@ -2514,12 +1781,6 @@ export class Matterbridge extends EventEmitter {
2514
1781
  };
2515
1782
  });
2516
1783
  }
2517
- /**
2518
- * Sanitizes the session information by converting bigint properties to strings because `res.json` doesn't support bigint.
2519
- *
2520
- * @param {SessionsBehavior.Session[]} sessions - The array of session information objects.
2521
- * @returns {SanitizedSession[]} An array of sanitized session information objects.
2522
- */
2523
1784
  sanitizeSessionInformation(sessions) {
2524
1785
  return sessions
2525
1786
  .filter((session) => session.isPeerActive)
@@ -2546,21 +1807,7 @@ export class Matterbridge extends EventEmitter {
2546
1807
  };
2547
1808
  });
2548
1809
  }
2549
- /**
2550
- * Sets the reachability of the specified aggregator node bridged devices and trigger.
2551
- *
2552
- * @param {Endpoint<AggregatorEndpoint>} aggregatorNode - The aggregator node to set the reachability for.
2553
- * @param {boolean} reachable - A boolean indicating the reachability status to set.
2554
- */
2555
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
2556
1810
  async setAggregatorReachability(aggregatorNode, reachable) {
2557
- /*
2558
- for (const child of aggregatorNode.parts) {
2559
- this.log.debug(`Setting reachability of ${(child as unknown as MatterbridgeEndpoint)?.deviceName} to ${reachable}`);
2560
- await child.setStateOf(BridgedDeviceBasicInformationServer, { reachable });
2561
- child.act((agent) => child.eventsOf(BridgedDeviceBasicInformationServer).reachableChanged.emit({ reachableNewValue: true }, agent.context));
2562
- }
2563
- */
2564
1811
  }
2565
1812
  getVendorIdName = (vendorId) => {
2566
1813
  if (!vendorId)
@@ -2600,11 +1847,10 @@ export class Matterbridge extends EventEmitter {
2600
1847
  case 0x1488:
2601
1848
  vendorName = '(ShortcutLabsFlic)';
2602
1849
  break;
2603
- case 65521: // 0xFFF1
1850
+ case 65521:
2604
1851
  vendorName = '(MatterTest)';
2605
1852
  break;
2606
1853
  }
2607
1854
  return vendorName;
2608
1855
  };
2609
1856
  }
2610
- //# sourceMappingURL=matterbridge.js.map