matterbridge 3.4.1-dev-20251130-cfb291e → 3.4.1
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.
- package/CHANGELOG.md +10 -9
- package/README-SERVICE-OPT.md +1 -0
- package/dist/broadcastServer.d.ts +136 -0
- package/dist/broadcastServer.d.ts.map +1 -0
- package/dist/broadcastServer.js +112 -1
- package/dist/broadcastServer.js.map +1 -0
- package/dist/broadcastServerTypes.d.ts +841 -0
- package/dist/broadcastServerTypes.d.ts.map +1 -0
- package/dist/broadcastServerTypes.js +24 -0
- package/dist/broadcastServerTypes.js.map +1 -0
- package/dist/cli.d.ts +30 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +97 -1
- package/dist/cli.js.map +1 -0
- package/dist/cliEmitter.d.ts +50 -0
- package/dist/cliEmitter.d.ts.map +1 -0
- package/dist/cliEmitter.js +37 -0
- package/dist/cliEmitter.js.map +1 -0
- package/dist/cliHistory.d.ts +48 -0
- package/dist/cliHistory.d.ts.map +1 -0
- package/dist/cliHistory.js +38 -0
- package/dist/cliHistory.js.map +1 -0
- package/dist/clusters/export.d.ts +2 -0
- package/dist/clusters/export.d.ts.map +1 -0
- package/dist/clusters/export.js +2 -0
- package/dist/clusters/export.js.map +1 -0
- package/dist/deviceManager.d.ts +135 -0
- package/dist/deviceManager.d.ts.map +1 -0
- package/dist/deviceManager.js +113 -1
- package/dist/deviceManager.js.map +1 -0
- package/dist/devices/airConditioner.d.ts +98 -0
- package/dist/devices/airConditioner.d.ts.map +1 -0
- package/dist/devices/airConditioner.js +57 -0
- package/dist/devices/airConditioner.js.map +1 -0
- package/dist/devices/batteryStorage.d.ts +48 -0
- package/dist/devices/batteryStorage.d.ts.map +1 -0
- package/dist/devices/batteryStorage.js +48 -1
- package/dist/devices/batteryStorage.js.map +1 -0
- package/dist/devices/cooktop.d.ts +61 -0
- package/dist/devices/cooktop.d.ts.map +1 -0
- package/dist/devices/cooktop.js +56 -0
- package/dist/devices/cooktop.js.map +1 -0
- package/dist/devices/dishwasher.d.ts +71 -0
- package/dist/devices/dishwasher.d.ts.map +1 -0
- package/dist/devices/dishwasher.js +57 -0
- package/dist/devices/dishwasher.js.map +1 -0
- package/dist/devices/evse.d.ts +76 -0
- package/dist/devices/evse.d.ts.map +1 -0
- package/dist/devices/evse.js +74 -10
- package/dist/devices/evse.js.map +1 -0
- package/dist/devices/export.d.ts +17 -0
- package/dist/devices/export.d.ts.map +1 -0
- package/dist/devices/export.js +5 -0
- package/dist/devices/export.js.map +1 -0
- package/dist/devices/extractorHood.d.ts +46 -0
- package/dist/devices/extractorHood.d.ts.map +1 -0
- package/dist/devices/extractorHood.js +43 -0
- package/dist/devices/extractorHood.js.map +1 -0
- package/dist/devices/heatPump.d.ts +47 -0
- package/dist/devices/heatPump.d.ts.map +1 -0
- package/dist/devices/heatPump.js +50 -2
- package/dist/devices/heatPump.js.map +1 -0
- package/dist/devices/laundryDryer.d.ts +67 -0
- package/dist/devices/laundryDryer.d.ts.map +1 -0
- package/dist/devices/laundryDryer.js +62 -3
- package/dist/devices/laundryDryer.js.map +1 -0
- package/dist/devices/laundryWasher.d.ts +81 -0
- package/dist/devices/laundryWasher.d.ts.map +1 -0
- package/dist/devices/laundryWasher.js +70 -4
- package/dist/devices/laundryWasher.js.map +1 -0
- package/dist/devices/microwaveOven.d.ts +168 -0
- package/dist/devices/microwaveOven.d.ts.map +1 -0
- package/dist/devices/microwaveOven.js +88 -5
- package/dist/devices/microwaveOven.js.map +1 -0
- package/dist/devices/oven.d.ts +105 -0
- package/dist/devices/oven.d.ts.map +1 -0
- package/dist/devices/oven.js +85 -0
- package/dist/devices/oven.js.map +1 -0
- package/dist/devices/refrigerator.d.ts +118 -0
- package/dist/devices/refrigerator.d.ts.map +1 -0
- package/dist/devices/refrigerator.js +102 -0
- package/dist/devices/refrigerator.js.map +1 -0
- package/dist/devices/roboticVacuumCleaner.d.ts +112 -0
- package/dist/devices/roboticVacuumCleaner.d.ts.map +1 -0
- package/dist/devices/roboticVacuumCleaner.js +100 -9
- package/dist/devices/roboticVacuumCleaner.js.map +1 -0
- package/dist/devices/solarPower.d.ts +40 -0
- package/dist/devices/solarPower.d.ts.map +1 -0
- package/dist/devices/solarPower.js +38 -0
- package/dist/devices/solarPower.js.map +1 -0
- package/dist/devices/speaker.d.ts +87 -0
- package/dist/devices/speaker.d.ts.map +1 -0
- package/dist/devices/speaker.js +84 -0
- package/dist/devices/speaker.js.map +1 -0
- package/dist/devices/temperatureControl.d.ts +166 -0
- package/dist/devices/temperatureControl.d.ts.map +1 -0
- package/dist/devices/temperatureControl.js +24 -3
- package/dist/devices/temperatureControl.js.map +1 -0
- package/dist/devices/waterHeater.d.ts +111 -0
- package/dist/devices/waterHeater.d.ts.map +1 -0
- package/dist/devices/waterHeater.js +82 -2
- package/dist/devices/waterHeater.js.map +1 -0
- package/dist/dgram/coap.d.ts +205 -0
- package/dist/dgram/coap.d.ts.map +1 -0
- package/dist/dgram/coap.js +126 -13
- package/dist/dgram/coap.js.map +1 -0
- package/dist/dgram/dgram.d.ts +141 -0
- package/dist/dgram/dgram.d.ts.map +1 -0
- package/dist/dgram/dgram.js +114 -2
- package/dist/dgram/dgram.js.map +1 -0
- package/dist/dgram/mb_coap.d.ts +24 -0
- package/dist/dgram/mb_coap.d.ts.map +1 -0
- package/dist/dgram/mb_coap.js +41 -3
- package/dist/dgram/mb_coap.js.map +1 -0
- package/dist/dgram/mb_mdns.d.ts +24 -0
- package/dist/dgram/mb_mdns.d.ts.map +1 -0
- package/dist/dgram/mb_mdns.js +80 -15
- package/dist/dgram/mb_mdns.js.map +1 -0
- package/dist/dgram/mdns.d.ts +290 -0
- package/dist/dgram/mdns.d.ts.map +1 -0
- package/dist/dgram/mdns.js +299 -137
- package/dist/dgram/mdns.js.map +1 -0
- package/dist/dgram/multicast.d.ts +67 -0
- package/dist/dgram/multicast.d.ts.map +1 -0
- package/dist/dgram/multicast.js +62 -1
- package/dist/dgram/multicast.js.map +1 -0
- package/dist/dgram/unicast.d.ts +56 -0
- package/dist/dgram/unicast.d.ts.map +1 -0
- package/dist/dgram/unicast.js +54 -0
- package/dist/dgram/unicast.js.map +1 -0
- package/dist/frontend.d.ts +238 -0
- package/dist/frontend.d.ts.map +1 -0
- package/dist/frontend.js +455 -35
- package/dist/frontend.js.map +1 -0
- package/dist/frontendTypes.d.ts +529 -0
- package/dist/frontendTypes.d.ts.map +1 -0
- package/dist/frontendTypes.js +45 -0
- package/dist/frontendTypes.js.map +1 -0
- package/dist/helpers.d.ts +48 -0
- package/dist/helpers.d.ts.map +1 -0
- package/dist/helpers.js +53 -0
- package/dist/helpers.js.map +1 -0
- package/dist/index.d.ts +34 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +25 -0
- package/dist/index.js.map +1 -0
- package/dist/jestutils/export.d.ts +2 -0
- package/dist/jestutils/export.d.ts.map +1 -0
- package/dist/jestutils/export.js +1 -0
- package/dist/jestutils/export.js.map +1 -0
- package/dist/jestutils/jestHelpers.d.ts +340 -0
- package/dist/jestutils/jestHelpers.d.ts.map +1 -0
- package/dist/jestutils/jestHelpers.js +373 -13
- package/dist/jestutils/jestHelpers.js.map +1 -0
- package/dist/logger/export.d.ts +2 -0
- package/dist/logger/export.d.ts.map +1 -0
- package/dist/logger/export.js +1 -0
- package/dist/logger/export.js.map +1 -0
- package/dist/matter/behaviors.d.ts +2 -0
- package/dist/matter/behaviors.d.ts.map +1 -0
- package/dist/matter/behaviors.js +2 -0
- package/dist/matter/behaviors.js.map +1 -0
- package/dist/matter/clusters.d.ts +2 -0
- package/dist/matter/clusters.d.ts.map +1 -0
- package/dist/matter/clusters.js +2 -0
- package/dist/matter/clusters.js.map +1 -0
- package/dist/matter/devices.d.ts +2 -0
- package/dist/matter/devices.d.ts.map +1 -0
- package/dist/matter/devices.js +2 -0
- package/dist/matter/devices.js.map +1 -0
- package/dist/matter/endpoints.d.ts +2 -0
- package/dist/matter/endpoints.d.ts.map +1 -0
- package/dist/matter/endpoints.js +2 -0
- package/dist/matter/endpoints.js.map +1 -0
- package/dist/matter/export.d.ts +5 -0
- package/dist/matter/export.d.ts.map +1 -0
- package/dist/matter/export.js +3 -0
- package/dist/matter/export.js.map +1 -0
- package/dist/matter/types.d.ts +3 -0
- package/dist/matter/types.d.ts.map +1 -0
- package/dist/matter/types.js +3 -0
- package/dist/matter/types.js.map +1 -0
- package/dist/matterNode.d.ts +342 -0
- package/dist/matterNode.d.ts.map +1 -0
- package/dist/matterNode.js +369 -8
- package/dist/matterNode.js.map +1 -0
- package/dist/matterbridge.d.ts +493 -0
- package/dist/matterbridge.d.ts.map +1 -0
- package/dist/matterbridge.js +807 -46
- package/dist/matterbridge.js.map +1 -0
- package/dist/matterbridgeAccessoryPlatform.d.ts +41 -0
- package/dist/matterbridgeAccessoryPlatform.d.ts.map +1 -0
- package/dist/matterbridgeAccessoryPlatform.js +38 -0
- package/dist/matterbridgeAccessoryPlatform.js.map +1 -0
- package/dist/matterbridgeBehaviors.d.ts +2404 -0
- package/dist/matterbridgeBehaviors.d.ts.map +1 -0
- package/dist/matterbridgeBehaviors.js +68 -5
- package/dist/matterbridgeBehaviors.js.map +1 -0
- package/dist/matterbridgeDeviceTypes.d.ts +698 -0
- package/dist/matterbridgeDeviceTypes.d.ts.map +1 -0
- package/dist/matterbridgeDeviceTypes.js +635 -14
- package/dist/matterbridgeDeviceTypes.js.map +1 -0
- package/dist/matterbridgeDynamicPlatform.d.ts +41 -0
- package/dist/matterbridgeDynamicPlatform.d.ts.map +1 -0
- package/dist/matterbridgeDynamicPlatform.js +38 -0
- package/dist/matterbridgeDynamicPlatform.js.map +1 -0
- package/dist/matterbridgeEndpoint.d.ts +1507 -0
- package/dist/matterbridgeEndpoint.d.ts.map +1 -0
- package/dist/matterbridgeEndpoint.js +1444 -53
- package/dist/matterbridgeEndpoint.js.map +1 -0
- package/dist/matterbridgeEndpointHelpers.d.ts +787 -0
- package/dist/matterbridgeEndpointHelpers.d.ts.map +1 -0
- package/dist/matterbridgeEndpointHelpers.js +483 -20
- package/dist/matterbridgeEndpointHelpers.js.map +1 -0
- package/dist/matterbridgeEndpointTypes.d.ts +166 -0
- package/dist/matterbridgeEndpointTypes.d.ts.map +1 -0
- package/dist/matterbridgeEndpointTypes.js +25 -0
- package/dist/matterbridgeEndpointTypes.js.map +1 -0
- package/dist/matterbridgePlatform.d.ts +537 -0
- package/dist/matterbridgePlatform.d.ts.map +1 -0
- package/dist/matterbridgePlatform.js +450 -1
- package/dist/matterbridgePlatform.js.map +1 -0
- package/dist/matterbridgeTypes.d.ts +251 -0
- package/dist/matterbridgeTypes.d.ts.map +1 -0
- package/dist/matterbridgeTypes.js +26 -0
- package/dist/matterbridgeTypes.js.map +1 -0
- package/dist/pluginManager.d.ts +372 -0
- package/dist/pluginManager.d.ts.map +1 -0
- package/dist/pluginManager.js +341 -5
- package/dist/pluginManager.js.map +1 -0
- package/dist/shelly.d.ts +181 -0
- package/dist/shelly.d.ts.map +1 -0
- package/dist/shelly.js +178 -7
- package/dist/shelly.js.map +1 -0
- package/dist/storage/export.d.ts +2 -0
- package/dist/storage/export.d.ts.map +1 -0
- package/dist/storage/export.js +1 -0
- package/dist/storage/export.js.map +1 -0
- package/dist/update.d.ts +84 -0
- package/dist/update.d.ts.map +1 -0
- package/dist/update.js +93 -1
- package/dist/update.js.map +1 -0
- package/dist/utils/colorUtils.d.ts +101 -0
- package/dist/utils/colorUtils.d.ts.map +1 -0
- package/dist/utils/colorUtils.js +97 -2
- package/dist/utils/colorUtils.js.map +1 -0
- package/dist/utils/commandLine.d.ts +66 -0
- package/dist/utils/commandLine.d.ts.map +1 -0
- package/dist/utils/commandLine.js +60 -0
- package/dist/utils/commandLine.js.map +1 -0
- package/dist/utils/copyDirectory.d.ts +35 -0
- package/dist/utils/copyDirectory.d.ts.map +1 -0
- package/dist/utils/copyDirectory.js +37 -0
- package/dist/utils/copyDirectory.js.map +1 -0
- package/dist/utils/createDirectory.d.ts +34 -0
- package/dist/utils/createDirectory.d.ts.map +1 -0
- package/dist/utils/createDirectory.js +33 -0
- package/dist/utils/createDirectory.js.map +1 -0
- package/dist/utils/createZip.d.ts +39 -0
- package/dist/utils/createZip.d.ts.map +1 -0
- package/dist/utils/createZip.js +47 -2
- package/dist/utils/createZip.js.map +1 -0
- package/dist/utils/deepCopy.d.ts +32 -0
- package/dist/utils/deepCopy.d.ts.map +1 -0
- package/dist/utils/deepCopy.js +39 -0
- package/dist/utils/deepCopy.js.map +1 -0
- package/dist/utils/deepEqual.d.ts +54 -0
- package/dist/utils/deepEqual.d.ts.map +1 -0
- package/dist/utils/deepEqual.js +72 -1
- package/dist/utils/deepEqual.js.map +1 -0
- package/dist/utils/error.d.ts +45 -0
- package/dist/utils/error.d.ts.map +1 -0
- package/dist/utils/error.js +42 -0
- package/dist/utils/error.js.map +1 -0
- package/dist/utils/export.d.ts +13 -0
- package/dist/utils/export.d.ts.map +1 -0
- package/dist/utils/export.js +1 -0
- package/dist/utils/export.js.map +1 -0
- package/dist/utils/format.d.ts +53 -0
- package/dist/utils/format.d.ts.map +1 -0
- package/dist/utils/format.js +49 -0
- package/dist/utils/format.js.map +1 -0
- package/dist/utils/hex.d.ts +89 -0
- package/dist/utils/hex.d.ts.map +1 -0
- package/dist/utils/hex.js +124 -0
- package/dist/utils/hex.js.map +1 -0
- package/dist/utils/inspector.d.ts +87 -0
- package/dist/utils/inspector.d.ts.map +1 -0
- package/dist/utils/inspector.js +69 -1
- package/dist/utils/inspector.js.map +1 -0
- package/dist/utils/isvalid.d.ts +103 -0
- package/dist/utils/isvalid.d.ts.map +1 -0
- package/dist/utils/isvalid.js +101 -0
- package/dist/utils/isvalid.js.map +1 -0
- package/dist/utils/network.d.ts +111 -0
- package/dist/utils/network.d.ts.map +1 -0
- package/dist/utils/network.js +96 -5
- package/dist/utils/network.js.map +1 -0
- package/dist/utils/spawn.d.ts +33 -0
- package/dist/utils/spawn.d.ts.map +1 -0
- package/dist/utils/spawn.js +71 -1
- package/dist/utils/spawn.js.map +1 -0
- package/dist/utils/tracker.d.ts +108 -0
- package/dist/utils/tracker.d.ts.map +1 -0
- package/dist/utils/tracker.js +64 -1
- package/dist/utils/tracker.js.map +1 -0
- package/dist/utils/wait.d.ts +54 -0
- package/dist/utils/wait.d.ts.map +1 -0
- package/dist/utils/wait.js +60 -8
- package/dist/utils/wait.js.map +1 -0
- package/dist/workerGlobalPrefix.d.ts +25 -0
- package/dist/workerGlobalPrefix.d.ts.map +1 -0
- package/dist/workerGlobalPrefix.js +37 -5
- package/dist/workerGlobalPrefix.js.map +1 -0
- package/dist/workerTypes.d.ts +52 -0
- package/dist/workerTypes.d.ts.map +1 -0
- package/dist/workerTypes.js +24 -0
- package/dist/workerTypes.js.map +1 -0
- package/dist/workers.d.ts +69 -0
- package/dist/workers.d.ts.map +1 -0
- package/dist/workers.js +68 -4
- package/dist/workers.js.map +1 -0
- package/npm-shrinkwrap.json +2 -2
- package/package.json +2 -1
package/dist/matterbridge.js
CHANGED
|
@@ -1,19 +1,48 @@
|
|
|
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.2
|
|
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
|
+
// eslint-disable-next-line no-console
|
|
1
25
|
if (process.argv.includes('--loader') || process.argv.includes('-loader'))
|
|
2
26
|
console.log('\u001B[32mMatterbridge loaded.\u001B[40;0m');
|
|
27
|
+
// Node.js modules
|
|
3
28
|
import os from 'node:os';
|
|
4
29
|
import path from 'node:path';
|
|
5
30
|
import fs from 'node:fs';
|
|
6
31
|
import EventEmitter from 'node:events';
|
|
7
32
|
import { inspect } from 'node:util';
|
|
33
|
+
// AnsiLogger module
|
|
8
34
|
import { AnsiLogger, UNDERLINE, UNDERLINEOFF, db, debugStringify, BRIGHT, RESET, er, nf, rs, wr, RED, GREEN, zb, CYAN, nt, BLUE, or } from 'node-ansi-logger';
|
|
35
|
+
// NodeStorage module
|
|
9
36
|
import { NodeStorageManager } from 'node-persist-manager';
|
|
10
|
-
|
|
37
|
+
// @matter
|
|
38
|
+
import '@matter/nodejs'; // Set up Node.js environment for matter.js
|
|
11
39
|
import { Logger, LogLevel as MatterLogLevel, LogFormat as MatterLogFormat, UINT32_MAX, UINT16_MAX, Crypto, Environment, StorageService } from '@matter/general';
|
|
12
40
|
import { FabricAction, PaseClient } from '@matter/protocol';
|
|
13
41
|
import { Endpoint, ServerNode } from '@matter/node';
|
|
14
42
|
import { DeviceTypeId, VendorId } from '@matter/types/datatype';
|
|
15
43
|
import { AggregatorEndpoint } from '@matter/node/endpoints';
|
|
16
44
|
import { BasicInformationServer } from '@matter/node/behaviors/basic-information';
|
|
45
|
+
// Matterbridge
|
|
17
46
|
import { getParameter, getIntParameter, hasParameter } from './utils/commandLine.js';
|
|
18
47
|
import { copyDirectory } from './utils/copyDirectory.js';
|
|
19
48
|
import { createDirectory } from './utils/createDirectory.js';
|
|
@@ -28,19 +57,27 @@ import { bridge } from './matterbridgeDeviceTypes.js';
|
|
|
28
57
|
import { Frontend } from './frontend.js';
|
|
29
58
|
import { addVirtualDevice, addVirtualDevices } from './helpers.js';
|
|
30
59
|
import { BroadcastServer } from './broadcastServer.js';
|
|
60
|
+
/**
|
|
61
|
+
* Represents the Matterbridge application.
|
|
62
|
+
*/
|
|
31
63
|
export class Matterbridge extends EventEmitter {
|
|
64
|
+
/** Matterbridge system information */
|
|
32
65
|
systemInformation = {
|
|
66
|
+
// Network properties
|
|
33
67
|
interfaceName: '',
|
|
34
68
|
macAddress: '',
|
|
35
69
|
ipv4Address: '',
|
|
36
70
|
ipv6Address: '',
|
|
71
|
+
// Node.js properties
|
|
37
72
|
nodeVersion: '',
|
|
73
|
+
// Fixed system properties
|
|
38
74
|
hostname: '',
|
|
39
75
|
user: '',
|
|
40
76
|
osType: '',
|
|
41
77
|
osRelease: '',
|
|
42
78
|
osPlatform: '',
|
|
43
79
|
osArch: '',
|
|
80
|
+
// Cpu and memory properties
|
|
44
81
|
totalMemory: '',
|
|
45
82
|
freeMemory: '',
|
|
46
83
|
systemUptime: '',
|
|
@@ -51,6 +88,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
51
88
|
heapTotal: '',
|
|
52
89
|
heapUsed: '',
|
|
53
90
|
};
|
|
91
|
+
// Matterbridge settings
|
|
54
92
|
homeDirectory = '';
|
|
55
93
|
rootDirectory = '';
|
|
56
94
|
matterbridgeDirectory = '';
|
|
@@ -65,12 +103,19 @@ export class Matterbridge extends EventEmitter {
|
|
|
65
103
|
restartMode = '';
|
|
66
104
|
virtualMode = 'outlet';
|
|
67
105
|
profile = getParameter('profile');
|
|
68
|
-
|
|
106
|
+
/** Matterbridge logger */
|
|
107
|
+
log = new AnsiLogger({ logName: 'Matterbridge', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
|
|
108
|
+
/** Matterbridge logger level */
|
|
69
109
|
logLevel = this.log.logLevel;
|
|
110
|
+
/** Whether to log to a file */
|
|
70
111
|
fileLogger = false;
|
|
71
|
-
|
|
112
|
+
/** Matter logger */
|
|
113
|
+
matterLog = new AnsiLogger({ logName: 'Matter', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
|
|
114
|
+
/** Matter logger level */
|
|
72
115
|
matterLogLevel = this.matterLog.logLevel;
|
|
116
|
+
/** Whether to log Matter to a file */
|
|
73
117
|
matterFileLogger = false;
|
|
118
|
+
// Frontend settings
|
|
74
119
|
readOnly = hasParameter('readonly') || hasParameter('shelly');
|
|
75
120
|
shellyBoard = hasParameter('shelly');
|
|
76
121
|
shellySysUpdate = false;
|
|
@@ -78,12 +123,18 @@ export class Matterbridge extends EventEmitter {
|
|
|
78
123
|
restartRequired = false;
|
|
79
124
|
fixedRestartRequired = false;
|
|
80
125
|
updateRequired = false;
|
|
126
|
+
// Managers
|
|
81
127
|
plugins = new PluginManager(this);
|
|
82
128
|
devices = new DeviceManager();
|
|
129
|
+
// Frontend
|
|
83
130
|
frontend = new Frontend(this);
|
|
131
|
+
/** Matterbridge node storage manager created in the directory 'storage' in matterbridgeDirectory */
|
|
84
132
|
nodeStorage;
|
|
133
|
+
/** Matterbridge node context created with name 'matterbridge' */
|
|
85
134
|
nodeContext;
|
|
135
|
+
/** The main instance of the Matterbridge class (singleton) */
|
|
86
136
|
static instance;
|
|
137
|
+
// Instance properties
|
|
87
138
|
shutdown = false;
|
|
88
139
|
failCountLimit = hasParameter('shelly') ? 600 : 120;
|
|
89
140
|
hasCleanupStarted = false;
|
|
@@ -98,19 +149,32 @@ export class Matterbridge extends EventEmitter {
|
|
|
98
149
|
sigtermHandler;
|
|
99
150
|
exceptionHandler;
|
|
100
151
|
rejectionHandler;
|
|
152
|
+
/** Matter environment default */
|
|
101
153
|
environment = Environment.default;
|
|
154
|
+
/** Matter storage service from environment default */
|
|
102
155
|
matterStorageService;
|
|
156
|
+
/** Matter storage manager created with name 'Matterbridge' */
|
|
103
157
|
matterStorageManager;
|
|
158
|
+
/** Matter matterbridge storage context created in the storage manager with name 'persist' */
|
|
104
159
|
matterbridgeContext;
|
|
105
160
|
controllerContext;
|
|
161
|
+
/** Matter mdns interface e.g. 'eth0' or 'wlan0' or 'Wi-Fi' */
|
|
106
162
|
mdnsInterface;
|
|
163
|
+
/** Matter listeningAddressIpv4 address */
|
|
107
164
|
ipv4Address;
|
|
165
|
+
/** Matter listeningAddressIpv6 address */
|
|
108
166
|
ipv6Address;
|
|
109
|
-
port
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
167
|
+
/** Matter commissioning port */
|
|
168
|
+
port; // first server node port
|
|
169
|
+
/** Matter commissioning passcode */
|
|
170
|
+
passcode; // first server node passcode
|
|
171
|
+
/** Matter commissioning discriminator */
|
|
172
|
+
discriminator; // first server node discriminator
|
|
173
|
+
/** Matter device certification */
|
|
174
|
+
certification; // device certification
|
|
175
|
+
/** Matter server node in bridge mode */
|
|
113
176
|
serverNode;
|
|
177
|
+
/** Matter aggregator node in bridge mode */
|
|
114
178
|
aggregatorNode;
|
|
115
179
|
aggregatorVendorId = VendorId(getIntParameter('vendorId') ?? 0xfff1);
|
|
116
180
|
aggregatorVendorName = getParameter('vendorName') ?? 'Matterbridge';
|
|
@@ -119,10 +183,13 @@ export class Matterbridge extends EventEmitter {
|
|
|
119
183
|
aggregatorDeviceType = DeviceTypeId(getIntParameter('deviceType') ?? bridge.code);
|
|
120
184
|
aggregatorSerialNumber = getParameter('serialNumber');
|
|
121
185
|
aggregatorUniqueId = getParameter('uniqueId');
|
|
186
|
+
/** Advertising nodes map: time advertising started keyed by storeId */
|
|
122
187
|
advertisingNodes = new Map();
|
|
188
|
+
/** Broadcast server */
|
|
123
189
|
server;
|
|
124
190
|
debug = hasParameter('debug') || hasParameter('verbose');
|
|
125
191
|
verbose = hasParameter('verbose');
|
|
192
|
+
/** We load asyncronously so is private */
|
|
126
193
|
constructor() {
|
|
127
194
|
super();
|
|
128
195
|
this.log.logNameColor = '\x1b[38;5;115m';
|
|
@@ -173,8 +240,19 @@ export class Matterbridge extends EventEmitter {
|
|
|
173
240
|
}
|
|
174
241
|
}
|
|
175
242
|
}
|
|
243
|
+
//* ************************************************************************************************************************************ */
|
|
244
|
+
// loadInstance() and cleanup() methods */
|
|
245
|
+
//* ************************************************************************************************************************************ */
|
|
246
|
+
/**
|
|
247
|
+
* Loads an instance of the Matterbridge class.
|
|
248
|
+
* If an instance already exists, return that instance.
|
|
249
|
+
*
|
|
250
|
+
* @param {boolean} initialize - Whether to initialize the Matterbridge instance after loading. Defaults to false.
|
|
251
|
+
* @returns {Matterbridge} A promise that resolves to the Matterbridge instance.
|
|
252
|
+
*/
|
|
176
253
|
static async loadInstance(initialize = false) {
|
|
177
254
|
if (!Matterbridge.instance) {
|
|
255
|
+
// eslint-disable-next-line no-console
|
|
178
256
|
if (hasParameter('debug'))
|
|
179
257
|
console.log(GREEN + 'Creating a new instance of Matterbridge.', initialize ? 'Initializing...' : 'Not initializing...', rs);
|
|
180
258
|
Matterbridge.instance = new Matterbridge();
|
|
@@ -183,56 +261,84 @@ export class Matterbridge extends EventEmitter {
|
|
|
183
261
|
}
|
|
184
262
|
return Matterbridge.instance;
|
|
185
263
|
}
|
|
264
|
+
/**
|
|
265
|
+
* Initializes the Matterbridge application.
|
|
266
|
+
*
|
|
267
|
+
* @remarks
|
|
268
|
+
* This method performs the necessary setup and initialization steps for the Matterbridge application.
|
|
269
|
+
* It displays the help information if the 'help' parameter is provided, sets up the logger, checks the
|
|
270
|
+
* node version, registers signal handlers, initializes storage, and parses the command line.
|
|
271
|
+
*
|
|
272
|
+
* @returns {Promise<void>} A Promise that resolves when the initialization is complete.
|
|
273
|
+
*/
|
|
186
274
|
async initialize() {
|
|
275
|
+
// for (let i = 1; i <= 255; i++) console.log(`\x1b[38;5;${i}mColor: ${i}`);
|
|
276
|
+
// Emit the initialize_started event
|
|
187
277
|
this.emit('initialize_started');
|
|
278
|
+
// Set the restart mode
|
|
188
279
|
if (hasParameter('service'))
|
|
189
280
|
this.restartMode = 'service';
|
|
190
281
|
if (hasParameter('docker'))
|
|
191
282
|
this.restartMode = 'docker';
|
|
283
|
+
// Set the matterbridge home directory
|
|
192
284
|
this.homeDirectory = getParameter('homedir') ?? os.homedir();
|
|
193
285
|
await createDirectory(this.homeDirectory, 'Matterbridge Home Directory', this.log);
|
|
286
|
+
// Set the matterbridge directory
|
|
194
287
|
this.matterbridgeDirectory = this.profile ? path.join(this.homeDirectory, '.matterbridge', 'profiles', this.profile) : path.join(this.homeDirectory, '.matterbridge');
|
|
195
288
|
await createDirectory(this.matterbridgeDirectory, 'Matterbridge Directory', this.log);
|
|
196
289
|
await createDirectory(path.join(this.matterbridgeDirectory, 'certs'), 'Matterbridge Frontend Certificate Directory', this.log);
|
|
197
290
|
await createDirectory(path.join(this.matterbridgeDirectory, 'uploads'), 'Matterbridge Frontend Uploads Directory', this.log);
|
|
291
|
+
// Set the matterbridge plugin directory
|
|
198
292
|
this.matterbridgePluginDirectory = this.profile ? path.join(this.homeDirectory, 'Matterbridge', 'profiles', this.profile) : path.join(this.homeDirectory, 'Matterbridge');
|
|
199
293
|
await createDirectory(this.matterbridgePluginDirectory, 'Matterbridge Plugin Directory', this.log);
|
|
294
|
+
// Set the matterbridge cert directory
|
|
200
295
|
this.matterbridgeCertDirectory = this.profile ? path.join(this.homeDirectory, '.mattercert', 'profiles', this.profile) : path.join(this.homeDirectory, '.mattercert');
|
|
201
296
|
await createDirectory(this.matterbridgeCertDirectory, 'Matterbridge Matter Certificate Directory', this.log);
|
|
297
|
+
// Set the matterbridge root directory
|
|
202
298
|
const { fileURLToPath } = await import('node:url');
|
|
203
299
|
const currentFileDirectory = path.dirname(fileURLToPath(import.meta.url));
|
|
204
|
-
this.rootDirectory = path.resolve(currentFileDirectory, '../');
|
|
300
|
+
this.rootDirectory = path.resolve(currentFileDirectory, '../'); // Adjust the path for dist directory
|
|
301
|
+
// Setup the matter environment with default values
|
|
205
302
|
this.environment.vars.set('log.level', MatterLogLevel.INFO);
|
|
206
303
|
this.environment.vars.set('log.format', MatterLogFormat.ANSI);
|
|
207
304
|
this.environment.vars.set('path.root', path.join(this.matterbridgeDirectory, MATTER_STORAGE_NAME));
|
|
208
305
|
this.environment.vars.set('runtime.signals', false);
|
|
209
306
|
this.environment.vars.set('runtime.exitcode', false);
|
|
307
|
+
// Register process handlers
|
|
210
308
|
this.registerProcessHandlers();
|
|
309
|
+
// Initialize nodeStorage and nodeContext
|
|
211
310
|
try {
|
|
212
311
|
this.log.debug(`Creating node storage manager: ${CYAN}${NODE_STORAGE_DIR}${db}`);
|
|
213
312
|
this.nodeStorage = new NodeStorageManager({ dir: path.join(this.matterbridgeDirectory, NODE_STORAGE_DIR), writeQueue: false, expiredInterval: undefined, logging: false });
|
|
214
313
|
this.log.debug('Creating node storage context for matterbridge');
|
|
215
314
|
this.nodeContext = await this.nodeStorage.createStorage('matterbridge');
|
|
315
|
+
// TODO: Remove this code when node-persist-manager is updated
|
|
316
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
216
317
|
const keys = (await this.nodeStorage?.storage.keys());
|
|
217
318
|
for (const key of keys) {
|
|
218
319
|
this.log.debug(`Checking node storage manager key: ${CYAN}${key}${db}`);
|
|
320
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
219
321
|
await this.nodeStorage?.storage.get(key);
|
|
220
322
|
}
|
|
221
323
|
const storages = await this.nodeStorage.getStorageNames();
|
|
222
324
|
for (const storage of storages) {
|
|
223
325
|
this.log.debug(`Checking storage: ${CYAN}${storage}${db}`);
|
|
224
326
|
const nodeContext = await this.nodeStorage?.createStorage(storage);
|
|
327
|
+
// TODO: Remove this code when node-persist-manager is updated
|
|
328
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
225
329
|
const keys = (await nodeContext?.storage.keys());
|
|
226
330
|
keys.forEach(async (key) => {
|
|
227
331
|
this.log.debug(`Checking key: ${CYAN}${storage}:${key}${db}`);
|
|
228
332
|
await nodeContext?.get(key);
|
|
229
333
|
});
|
|
230
334
|
}
|
|
335
|
+
// Creating a backup of the node storage since it is not corrupted
|
|
231
336
|
this.log.debug('Creating node storage backup...');
|
|
232
337
|
await copyDirectory(path.join(this.matterbridgeDirectory, NODE_STORAGE_DIR), path.join(this.matterbridgeDirectory, NODE_STORAGE_DIR + '.backup'));
|
|
233
338
|
this.log.debug('Created node storage backup');
|
|
234
339
|
}
|
|
235
340
|
catch (error) {
|
|
341
|
+
// Restoring the backup of the node storage since it is corrupted
|
|
236
342
|
this.log.error(`Error creating node storage manager and context: ${error instanceof Error ? error.message : error}`);
|
|
237
343
|
if (hasParameter('norestore')) {
|
|
238
344
|
this.log.fatal(`The matterbridge storage is corrupted. Found -norestore parameter: exiting...`);
|
|
@@ -246,14 +352,19 @@ export class Matterbridge extends EventEmitter {
|
|
|
246
352
|
if (!this.nodeStorage || !this.nodeContext) {
|
|
247
353
|
throw new Error('Fatal error creating node storage manager and context for matterbridge');
|
|
248
354
|
}
|
|
355
|
+
// Set the first port to use for the commissioning server (will be incremented in childbridge mode)
|
|
249
356
|
this.port = getIntParameter('port') ?? (await this.nodeContext.get('matterport', 5540)) ?? 5540;
|
|
357
|
+
// Set the first passcode to use for the commissioning server (will be incremented in childbridge mode)
|
|
250
358
|
this.passcode = getIntParameter('passcode') ?? (await this.nodeContext.get('matterpasscode')) ?? PaseClient.generateRandomPasscode(this.environment.get(Crypto));
|
|
359
|
+
// Set the first discriminator to use for the commissioning server (will be incremented in childbridge mode)
|
|
251
360
|
this.discriminator = getIntParameter('discriminator') ?? (await this.nodeContext.get('matterdiscriminator')) ?? PaseClient.generateRandomDiscriminator(this.environment.get(Crypto));
|
|
361
|
+
// Certificate management
|
|
252
362
|
const pairingFilePath = path.join(this.matterbridgeCertDirectory, 'pairing.json');
|
|
253
363
|
try {
|
|
254
364
|
await fs.promises.access(pairingFilePath, fs.constants.R_OK);
|
|
255
365
|
const pairingFileContent = await fs.promises.readFile(pairingFilePath, 'utf8');
|
|
256
366
|
const pairingFileJson = JSON.parse(pairingFileContent);
|
|
367
|
+
// Set the vendorId, vendorName, productId, productName, deviceType, serialNumber, uniqueId if they are present in the pairing file
|
|
257
368
|
if (isValidNumber(pairingFileJson.vendorId)) {
|
|
258
369
|
this.aggregatorVendorId = VendorId(pairingFileJson.vendorId);
|
|
259
370
|
this.log.info(`Pairing file ${CYAN}${pairingFilePath}${nf} found. Using vendorId ${CYAN}${this.aggregatorVendorId}${nf} from pairing file.`);
|
|
@@ -282,11 +393,13 @@ export class Matterbridge extends EventEmitter {
|
|
|
282
393
|
this.aggregatorUniqueId = pairingFileJson.uniqueId;
|
|
283
394
|
this.log.info(`Pairing file ${CYAN}${pairingFilePath}${nf} found. Using uniqueId ${CYAN}${this.aggregatorUniqueId}${nf} from pairing file.`);
|
|
284
395
|
}
|
|
396
|
+
// Override the passcode and discriminator if they are present in the pairing file
|
|
285
397
|
if (isValidNumber(pairingFileJson.passcode) && isValidNumber(pairingFileJson.discriminator)) {
|
|
286
398
|
this.passcode = pairingFileJson.passcode;
|
|
287
399
|
this.discriminator = pairingFileJson.discriminator;
|
|
288
400
|
this.log.info(`Pairing file ${CYAN}${pairingFilePath}${nf} found. Using passcode ${CYAN}${this.passcode}${nf} and discriminator ${CYAN}${this.discriminator}${nf} from pairing file.`);
|
|
289
401
|
}
|
|
402
|
+
// Set the certification for matter.js if it is present in the pairing file
|
|
290
403
|
if (pairingFileJson.privateKey && pairingFileJson.certificate && pairingFileJson.intermediateCertificate && pairingFileJson.declaration) {
|
|
291
404
|
const { hexToBuffer } = await import('./utils/hex.js');
|
|
292
405
|
this.certification = {
|
|
@@ -301,41 +414,44 @@ export class Matterbridge extends EventEmitter {
|
|
|
301
414
|
catch (error) {
|
|
302
415
|
this.log.debug(`Pairing file ${CYAN}${pairingFilePath}${db} not found: ${error instanceof Error ? error.message : error}`);
|
|
303
416
|
}
|
|
417
|
+
// Store the passcode, discriminator and port in the node context
|
|
304
418
|
await this.nodeContext.set('matterport', this.port);
|
|
305
419
|
await this.nodeContext.set('matterpasscode', this.passcode);
|
|
306
420
|
await this.nodeContext.set('matterdiscriminator', this.discriminator);
|
|
307
421
|
this.log.debug(`Initializing server node for Matterbridge on port ${this.port} with passcode ${this.passcode} and discriminator ${this.discriminator}`);
|
|
422
|
+
// Set matterbridge logger level (context: matterbridgeLogLevel)
|
|
308
423
|
if (hasParameter('logger')) {
|
|
309
424
|
const level = getParameter('logger');
|
|
310
425
|
if (level === 'debug') {
|
|
311
|
-
this.log.logLevel = "debug"
|
|
426
|
+
this.log.logLevel = "debug" /* LogLevel.DEBUG */;
|
|
312
427
|
}
|
|
313
428
|
else if (level === 'info') {
|
|
314
|
-
this.log.logLevel = "info"
|
|
429
|
+
this.log.logLevel = "info" /* LogLevel.INFO */;
|
|
315
430
|
}
|
|
316
431
|
else if (level === 'notice') {
|
|
317
|
-
this.log.logLevel = "notice"
|
|
432
|
+
this.log.logLevel = "notice" /* LogLevel.NOTICE */;
|
|
318
433
|
}
|
|
319
434
|
else if (level === 'warn') {
|
|
320
|
-
this.log.logLevel = "warn"
|
|
435
|
+
this.log.logLevel = "warn" /* LogLevel.WARN */;
|
|
321
436
|
}
|
|
322
437
|
else if (level === 'error') {
|
|
323
|
-
this.log.logLevel = "error"
|
|
438
|
+
this.log.logLevel = "error" /* LogLevel.ERROR */;
|
|
324
439
|
}
|
|
325
440
|
else if (level === 'fatal') {
|
|
326
|
-
this.log.logLevel = "fatal"
|
|
441
|
+
this.log.logLevel = "fatal" /* LogLevel.FATAL */;
|
|
327
442
|
}
|
|
328
443
|
else {
|
|
329
444
|
this.log.warn(`Invalid matterbridge logger level: ${level}. Using default level "info".`);
|
|
330
|
-
this.log.logLevel = "info"
|
|
445
|
+
this.log.logLevel = "info" /* LogLevel.INFO */;
|
|
331
446
|
}
|
|
332
447
|
}
|
|
333
448
|
else {
|
|
334
|
-
this.log.logLevel = await this.nodeContext.get('matterbridgeLogLevel', this.shellyBoard ? "notice" : "info");
|
|
449
|
+
this.log.logLevel = await this.nodeContext.get('matterbridgeLogLevel', this.shellyBoard ? "notice" /* LogLevel.NOTICE */ : "info" /* LogLevel.INFO */);
|
|
335
450
|
}
|
|
336
451
|
this.logLevel = this.log.logLevel;
|
|
337
452
|
this.frontend.logLevel = this.log.logLevel;
|
|
338
453
|
MatterbridgeEndpoint.logLevel = this.log.logLevel;
|
|
454
|
+
// Create the file logger for matterbridge (context: matterbridgeFileLog)
|
|
339
455
|
if (hasParameter('filelogger') || (await this.nodeContext.get('matterbridgeFileLog', false))) {
|
|
340
456
|
AnsiLogger.setGlobalLogfile(path.join(this.matterbridgeDirectory, MATTERBRIDGE_LOGGER_FILE), this.log.logLevel, true);
|
|
341
457
|
this.fileLogger = true;
|
|
@@ -344,6 +460,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
344
460
|
this.log.debug(`Matterbridge logLevel: ${this.log.logLevel} fileLoger: ${this.fileLogger}.`);
|
|
345
461
|
if (this.profile !== undefined)
|
|
346
462
|
this.log.debug(`Matterbridge profile: ${this.profile}.`);
|
|
463
|
+
// Set matter.js logger level, format and logger (context: matterLogLevel)
|
|
347
464
|
if (hasParameter('matterlogger')) {
|
|
348
465
|
const level = getParameter('matterlogger');
|
|
349
466
|
if (level === 'debug') {
|
|
@@ -374,11 +491,13 @@ export class Matterbridge extends EventEmitter {
|
|
|
374
491
|
}
|
|
375
492
|
Logger.format = MatterLogFormat.ANSI;
|
|
376
493
|
this.matterLogLevel = MatterLogLevel.names[Logger.level];
|
|
494
|
+
// Create the logger for matter.js with file logging (context: matterFileLog)
|
|
377
495
|
if (hasParameter('matterfilelogger') || (await this.nodeContext.get('matterFileLog', false))) {
|
|
378
496
|
this.matterFileLogger = true;
|
|
379
497
|
}
|
|
380
498
|
Logger.destinations.default.write = this.createDestinationMatterLogger(this.matterFileLogger);
|
|
381
499
|
this.log.debug(`Matter logLevel: ${this.matterLogLevel} fileLoger: ${this.matterFileLogger}.`);
|
|
500
|
+
// Log network interfaces
|
|
382
501
|
const networkInterfaces = os.networkInterfaces();
|
|
383
502
|
const availableAddresses = Object.entries(networkInterfaces);
|
|
384
503
|
const availableInterfaceNames = Object.keys(networkInterfaces);
|
|
@@ -391,6 +510,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
391
510
|
});
|
|
392
511
|
}
|
|
393
512
|
}
|
|
513
|
+
// Set the interface to use for matter server node mdnsInterface
|
|
394
514
|
if (hasParameter('mdnsinterface')) {
|
|
395
515
|
this.mdnsInterface = getParameter('mdnsinterface');
|
|
396
516
|
}
|
|
@@ -399,6 +519,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
399
519
|
if (this.mdnsInterface === '')
|
|
400
520
|
this.mdnsInterface = undefined;
|
|
401
521
|
}
|
|
522
|
+
// Validate mdnsInterface
|
|
402
523
|
if (this.mdnsInterface) {
|
|
403
524
|
if (!availableInterfaceNames.includes(this.mdnsInterface)) {
|
|
404
525
|
this.log.error(`Invalid mdnsinterface: ${this.mdnsInterface}. Available interfaces are: ${availableInterfaceNames.join(', ')}. Using all available interfaces.`);
|
|
@@ -411,6 +532,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
411
532
|
}
|
|
412
533
|
if (this.mdnsInterface)
|
|
413
534
|
this.environment.vars.set('mdns.networkInterface', this.mdnsInterface);
|
|
535
|
+
// Set the listeningAddressIpv4 for the matter commissioning server
|
|
414
536
|
if (hasParameter('ipv4address')) {
|
|
415
537
|
this.ipv4Address = getParameter('ipv4address');
|
|
416
538
|
}
|
|
@@ -419,6 +541,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
419
541
|
if (this.ipv4Address === '')
|
|
420
542
|
this.ipv4Address = undefined;
|
|
421
543
|
}
|
|
544
|
+
// Validate ipv4address
|
|
422
545
|
if (this.ipv4Address) {
|
|
423
546
|
let isValid = false;
|
|
424
547
|
for (const [ifaceName, ifaces] of availableAddresses) {
|
|
@@ -434,6 +557,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
434
557
|
await this.nodeContext.remove('matteripv4address');
|
|
435
558
|
}
|
|
436
559
|
}
|
|
560
|
+
// Set the listeningAddressIpv6 for the matter commissioning server
|
|
437
561
|
if (hasParameter('ipv6address')) {
|
|
438
562
|
this.ipv6Address = getParameter('ipv6address');
|
|
439
563
|
}
|
|
@@ -442,6 +566,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
442
566
|
if (this.ipv6Address === '')
|
|
443
567
|
this.ipv6Address = undefined;
|
|
444
568
|
}
|
|
569
|
+
// Validate ipv6address
|
|
445
570
|
if (this.ipv6Address) {
|
|
446
571
|
let isValid = false;
|
|
447
572
|
for (const [ifaceName, ifaces] of availableAddresses) {
|
|
@@ -450,6 +575,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
450
575
|
isValid = true;
|
|
451
576
|
break;
|
|
452
577
|
}
|
|
578
|
+
/* istanbul ignore next */
|
|
453
579
|
if (ifaces && ifaces.find((iface) => iface.scopeid && iface.scopeid > 0 && iface.address + '%' + (process.platform === 'win32' ? iface.scopeid : ifaceName) === this.ipv6Address)) {
|
|
454
580
|
this.log.info(`Using ipv6address ${CYAN}${this.ipv6Address}${nf} on interface ${CYAN}${ifaceName}${nf} for the Matter server node.`);
|
|
455
581
|
isValid = true;
|
|
@@ -462,6 +588,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
462
588
|
await this.nodeContext.remove('matteripv6address');
|
|
463
589
|
}
|
|
464
590
|
}
|
|
591
|
+
// Initialize the virtual mode
|
|
465
592
|
if (hasParameter('novirtual')) {
|
|
466
593
|
this.virtualMode = 'disabled';
|
|
467
594
|
await this.nodeContext.set('virtualmode', 'disabled');
|
|
@@ -470,10 +597,15 @@ export class Matterbridge extends EventEmitter {
|
|
|
470
597
|
this.virtualMode = (await this.nodeContext.get('virtualmode', 'outlet'));
|
|
471
598
|
}
|
|
472
599
|
this.log.debug(`Virtual mode ${this.virtualMode}.`);
|
|
600
|
+
// Initialize PluginManager
|
|
473
601
|
this.plugins.logLevel = this.log.logLevel;
|
|
474
602
|
await this.plugins.loadFromStorage();
|
|
603
|
+
// Initialize DeviceManager
|
|
475
604
|
this.devices.logLevel = this.log.logLevel;
|
|
605
|
+
// Get the plugins from node storage and create the plugins node storage contexts
|
|
476
606
|
for (const plugin of this.plugins) {
|
|
607
|
+
// Try to reinstall the plugin from npm (for Docker pull and external plugins)
|
|
608
|
+
// We don't do this when the add and other shutdown parameters are set because we shut down the process after adding the plugin
|
|
477
609
|
if (!fs.existsSync(plugin.path) && !hasParameter('add') && !hasParameter('remove') && !hasParameter('enable') && !hasParameter('disable') && !hasParameter('reset') && !hasParameter('factoryreset')) {
|
|
478
610
|
this.log.info(`Error parsing plugin ${plg}${plugin.name}${nf}. Trying to reinstall it from npm...`);
|
|
479
611
|
const { spawnCommand } = await import('./utils/spawn.js');
|
|
@@ -503,6 +635,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
503
635
|
await plugin.nodeContext.set('description', plugin.description);
|
|
504
636
|
await plugin.nodeContext.set('author', plugin.author);
|
|
505
637
|
}
|
|
638
|
+
// Log system info and create .matterbridge directory
|
|
506
639
|
await this.logNodeAndSystemInfo();
|
|
507
640
|
this.log.notice(`Matterbridge version ${this.matterbridgeVersion} ` +
|
|
508
641
|
`${hasParameter('bridge') || (!hasParameter('childbridge') && (await this.nodeContext?.get('bridgeMode', '')) === 'bridge') ? 'mode bridge ' : ''}` +
|
|
@@ -510,6 +643,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
510
643
|
`${hasParameter('controller') ? 'mode controller ' : ''}` +
|
|
511
644
|
`${this.restartMode !== '' ? 'restart mode ' + this.restartMode + ' ' : ''}` +
|
|
512
645
|
`running on ${this.systemInformation.osType} (v.${this.systemInformation.osRelease}) platform ${this.systemInformation.osPlatform} arch ${this.systemInformation.osArch}`);
|
|
646
|
+
// Check node version and throw error
|
|
513
647
|
const minNodeVersion = 20;
|
|
514
648
|
const nodeVersion = process.versions.node;
|
|
515
649
|
const versionMajor = parseInt(nodeVersion.split('.')[0]);
|
|
@@ -517,10 +651,18 @@ export class Matterbridge extends EventEmitter {
|
|
|
517
651
|
this.log.error(`Node version ${versionMajor} is not supported. Please upgrade to ${minNodeVersion} or above.`);
|
|
518
652
|
throw new Error(`Node version ${versionMajor} is not supported. Please upgrade to ${minNodeVersion} or above.`);
|
|
519
653
|
}
|
|
654
|
+
// Parse command line
|
|
520
655
|
await this.parseCommandLine();
|
|
656
|
+
// Emit the initialize_completed event
|
|
521
657
|
this.emit('initialize_completed');
|
|
522
658
|
this.initialized = true;
|
|
523
659
|
}
|
|
660
|
+
/**
|
|
661
|
+
* Parses the command line arguments and performs the corresponding actions.
|
|
662
|
+
*
|
|
663
|
+
* @private
|
|
664
|
+
* @returns {Promise<void>} A promise that resolves when the command line arguments have been processed, or the process exits.
|
|
665
|
+
*/
|
|
524
666
|
async parseCommandLine() {
|
|
525
667
|
if (hasParameter('list')) {
|
|
526
668
|
this.log.info(`│ Registered plugins (${this.plugins.length})`);
|
|
@@ -536,6 +678,19 @@ export class Matterbridge extends EventEmitter {
|
|
|
536
678
|
}
|
|
537
679
|
index++;
|
|
538
680
|
}
|
|
681
|
+
/*
|
|
682
|
+
const serializedRegisteredDevices = await this.nodeContext?.get<SerializedMatterbridgeEndpoint[]>('devices', []);
|
|
683
|
+
this.log.info(`│ Registered devices (${serializedRegisteredDevices?.length})`);
|
|
684
|
+
serializedRegisteredDevices?.forEach((device, index) => {
|
|
685
|
+
if (index !== serializedRegisteredDevices.length - 1) {
|
|
686
|
+
this.log.info(`├─┬─ plugin ${plg}${device.pluginName}${nf} device: ${dev}${device.deviceName}${nf} uniqueId: ${YELLOW}${device.uniqueId}${nf}`);
|
|
687
|
+
this.log.info(`│ └─ endpoint ${RED}${device.endpoint}${nf} ${typ}${device.endpointName}${nf} ${debugStringify(device.clusterServersId)}`);
|
|
688
|
+
} else {
|
|
689
|
+
this.log.info(`└─┬─ plugin ${plg}${device.pluginName}${nf} device: ${dev}${device.deviceName}${nf} uniqueId: ${YELLOW}${device.uniqueId}${nf}`);
|
|
690
|
+
this.log.info(` └─ endpoint ${RED}${device.endpoint}${nf} ${typ}${device.endpointName}${nf} ${debugStringify(device.clusterServersId)}`);
|
|
691
|
+
}
|
|
692
|
+
});
|
|
693
|
+
*/
|
|
539
694
|
this.shutdown = true;
|
|
540
695
|
return;
|
|
541
696
|
}
|
|
@@ -585,8 +740,10 @@ export class Matterbridge extends EventEmitter {
|
|
|
585
740
|
this.shutdown = true;
|
|
586
741
|
return;
|
|
587
742
|
}
|
|
743
|
+
// Initialize frontend
|
|
588
744
|
if (getIntParameter('frontend') !== 0 || getIntParameter('frontend') === undefined)
|
|
589
745
|
await this.frontend.start(getIntParameter('frontend'));
|
|
746
|
+
// Start the matter storage and create the matterbridge context
|
|
590
747
|
try {
|
|
591
748
|
await this.startMatterStorage();
|
|
592
749
|
if (this.aggregatorSerialNumber && this.aggregatorUniqueId && this.matterStorageService) {
|
|
@@ -600,18 +757,21 @@ export class Matterbridge extends EventEmitter {
|
|
|
600
757
|
this.log.fatal(`Fatal error creating matter storage: ${error instanceof Error ? error.message : error}`);
|
|
601
758
|
throw new Error(`Fatal error creating matter storage: ${error instanceof Error ? error.message : error}`);
|
|
602
759
|
}
|
|
760
|
+
// Clear the matterbridge context if the reset parameter is set (bridge mode)
|
|
603
761
|
if (hasParameter('reset') && getParameter('reset') === undefined) {
|
|
604
762
|
this.initialized = true;
|
|
605
763
|
await this.shutdownProcessAndReset();
|
|
606
764
|
this.shutdown = true;
|
|
607
765
|
return;
|
|
608
766
|
}
|
|
767
|
+
// Clear matterbridge plugin context if the reset parameter is set (childbridge mode)
|
|
609
768
|
if (hasParameter('reset') && getParameter('reset') !== undefined) {
|
|
610
769
|
this.log.debug(`Reset plugin ${getParameter('reset')}`);
|
|
611
770
|
const plugin = this.plugins.get(getParameter('reset'));
|
|
612
771
|
if (plugin) {
|
|
613
772
|
const matterStorageManager = await this.matterStorageService?.open(plugin.name);
|
|
614
773
|
if (!matterStorageManager) {
|
|
774
|
+
/* istanbul ignore next */
|
|
615
775
|
this.log.error(`Plugin ${plg}${plugin.name}${er} storageManager not found`);
|
|
616
776
|
}
|
|
617
777
|
else {
|
|
@@ -630,35 +790,42 @@ export class Matterbridge extends EventEmitter {
|
|
|
630
790
|
this.shutdown = true;
|
|
631
791
|
return;
|
|
632
792
|
}
|
|
793
|
+
// Check in 5 minutes the latest and dev versions of matterbridge and the plugins
|
|
633
794
|
clearTimeout(this.checkUpdateTimeout);
|
|
634
795
|
this.checkUpdateTimeout = setTimeout(async () => {
|
|
635
796
|
const { checkUpdates } = await import('./update.js');
|
|
636
797
|
checkUpdates(this);
|
|
637
798
|
}, 300 * 1000).unref();
|
|
799
|
+
// Check each 12 hours the latest and dev versions of matterbridge and the plugins
|
|
638
800
|
clearInterval(this.checkUpdateInterval);
|
|
639
801
|
this.checkUpdateInterval = setInterval(async () => {
|
|
640
802
|
const { checkUpdates } = await import('./update.js');
|
|
641
803
|
checkUpdates(this);
|
|
642
804
|
}, 12 * 60 * 60 * 1000).unref();
|
|
805
|
+
// Start the matterbridge in mode test
|
|
643
806
|
if (hasParameter('test')) {
|
|
644
807
|
this.bridgeMode = 'bridge';
|
|
645
808
|
return;
|
|
646
809
|
}
|
|
810
|
+
// Start the matterbridge in mode controller
|
|
647
811
|
if (hasParameter('controller')) {
|
|
648
812
|
this.bridgeMode = 'controller';
|
|
649
813
|
await this.startController();
|
|
650
814
|
return;
|
|
651
815
|
}
|
|
816
|
+
// Check if the bridge mode is set and start matterbridge in bridge mode if not set
|
|
652
817
|
if (!hasParameter('bridge') && !hasParameter('childbridge') && (await this.nodeContext?.get('bridgeMode', '')) === '') {
|
|
653
818
|
this.log.info('Setting default matterbridge start mode to bridge');
|
|
654
819
|
await this.nodeContext?.set('bridgeMode', 'bridge');
|
|
655
820
|
}
|
|
821
|
+
// Start matterbridge in bridge mode
|
|
656
822
|
if (hasParameter('bridge') || (!hasParameter('childbridge') && (await this.nodeContext?.get('bridgeMode', '')) === 'bridge')) {
|
|
657
823
|
this.bridgeMode = 'bridge';
|
|
658
824
|
this.log.debug(`Starting matterbridge in mode ${this.bridgeMode}`);
|
|
659
825
|
await this.startBridge();
|
|
660
826
|
return;
|
|
661
827
|
}
|
|
828
|
+
// Start matterbridge in childbridge mode
|
|
662
829
|
if (hasParameter('childbridge') || (!hasParameter('bridge') && (await this.nodeContext?.get('bridgeMode', '')) === 'childbridge')) {
|
|
663
830
|
this.bridgeMode = 'childbridge';
|
|
664
831
|
this.log.debug(`Starting matterbridge in mode ${this.bridgeMode}`);
|
|
@@ -666,10 +833,22 @@ export class Matterbridge extends EventEmitter {
|
|
|
666
833
|
return;
|
|
667
834
|
}
|
|
668
835
|
}
|
|
836
|
+
/**
|
|
837
|
+
* Asynchronously loads and starts the registered plugins.
|
|
838
|
+
*
|
|
839
|
+
* This method is responsible for initializing and starting all enabled plugins.
|
|
840
|
+
* It ensures that each plugin is properly loaded and started before the bridge starts.
|
|
841
|
+
*
|
|
842
|
+
* @param {boolean} [wait] - If true, the method will wait for all plugins to be fully loaded and started before resolving. Defaults to false.
|
|
843
|
+
* @param {boolean} [start] - If true, the method will start the plugins after loading them. Defaults to true.
|
|
844
|
+
* @returns {Promise<void>} A promise that resolves when all plugins have been loaded and started.
|
|
845
|
+
*/
|
|
669
846
|
async startPlugins(wait = false, start = true) {
|
|
847
|
+
// Check, load and start the plugins
|
|
670
848
|
for (const plugin of this.plugins) {
|
|
671
849
|
plugin.configJson = await this.plugins.loadConfig(plugin);
|
|
672
850
|
plugin.schemaJson = await this.plugins.loadSchema(plugin);
|
|
851
|
+
// Check if the plugin is available
|
|
673
852
|
if (!(await this.plugins.resolve(plugin.path))) {
|
|
674
853
|
this.log.error(`Plugin ${plg}${plugin.name}${er} not found or not validated. Disabling it.`);
|
|
675
854
|
plugin.enabled = false;
|
|
@@ -689,10 +868,16 @@ export class Matterbridge extends EventEmitter {
|
|
|
689
868
|
if (wait)
|
|
690
869
|
await this.plugins.load(plugin, start, 'Matterbridge is starting');
|
|
691
870
|
else
|
|
692
|
-
this.plugins.load(plugin, start, 'Matterbridge is starting');
|
|
871
|
+
this.plugins.load(plugin, start, 'Matterbridge is starting'); // No await do it asyncronously
|
|
693
872
|
}
|
|
694
873
|
this.frontend.wssSendRefreshRequired('plugins');
|
|
695
874
|
}
|
|
875
|
+
/**
|
|
876
|
+
* Registers the process handlers for uncaughtException, unhandledRejection, SIGINT and SIGTERM.
|
|
877
|
+
* - When an uncaught exception occurs, the exceptionHandler logs the error message and stack trace.
|
|
878
|
+
* - When an unhandled promise rejection occurs, the rejectionHandler logs the reason and stack trace.
|
|
879
|
+
* - When either of SIGINT and SIGTERM signals are received, the cleanup method is called with an appropriate message.
|
|
880
|
+
*/
|
|
696
881
|
registerProcessHandlers() {
|
|
697
882
|
this.log.debug(`Registering uncaughtException and unhandledRejection handlers...`);
|
|
698
883
|
process.removeAllListeners('uncaughtException');
|
|
@@ -719,6 +904,9 @@ export class Matterbridge extends EventEmitter {
|
|
|
719
904
|
};
|
|
720
905
|
process.on('SIGTERM', this.sigtermHandler);
|
|
721
906
|
}
|
|
907
|
+
/**
|
|
908
|
+
* Deregisters the process uncaughtException, unhandledRejection, SIGINT and SIGTERM signal handlers.
|
|
909
|
+
*/
|
|
722
910
|
deregisterProcessHandlers() {
|
|
723
911
|
this.log.debug(`Deregistering uncaughtException and unhandledRejection handlers...`);
|
|
724
912
|
if (this.exceptionHandler)
|
|
@@ -735,13 +923,18 @@ export class Matterbridge extends EventEmitter {
|
|
|
735
923
|
process.off('SIGTERM', this.sigtermHandler);
|
|
736
924
|
this.sigtermHandler = undefined;
|
|
737
925
|
}
|
|
926
|
+
/**
|
|
927
|
+
* Logs the node and system information.
|
|
928
|
+
*/
|
|
738
929
|
async logNodeAndSystemInfo() {
|
|
930
|
+
// IP address information
|
|
739
931
|
const networkInterfaces = os.networkInterfaces();
|
|
740
932
|
this.systemInformation.interfaceName = '';
|
|
741
933
|
this.systemInformation.ipv4Address = '';
|
|
742
934
|
this.systemInformation.ipv6Address = '';
|
|
743
935
|
this.systemInformation.macAddress = '';
|
|
744
936
|
for (const [interfaceName, interfaceDetails] of Object.entries(networkInterfaces)) {
|
|
937
|
+
// this.log.debug(`Checking interface: '${interfaceName}' for '${this.mdnsInterface}'`);
|
|
745
938
|
if (this.mdnsInterface && interfaceName !== this.mdnsInterface)
|
|
746
939
|
continue;
|
|
747
940
|
if (!interfaceDetails) {
|
|
@@ -767,16 +960,18 @@ export class Matterbridge extends EventEmitter {
|
|
|
767
960
|
break;
|
|
768
961
|
}
|
|
769
962
|
}
|
|
963
|
+
// Node information
|
|
770
964
|
this.systemInformation.nodeVersion = process.versions.node;
|
|
771
965
|
const versionMajor = parseInt(this.systemInformation.nodeVersion.split('.')[0]);
|
|
772
966
|
const versionMinor = parseInt(this.systemInformation.nodeVersion.split('.')[1]);
|
|
773
967
|
const versionPatch = parseInt(this.systemInformation.nodeVersion.split('.')[2]);
|
|
968
|
+
// Host system information
|
|
774
969
|
this.systemInformation.hostname = os.hostname();
|
|
775
970
|
this.systemInformation.user = os.userInfo().username;
|
|
776
|
-
this.systemInformation.osType = os.type();
|
|
777
|
-
this.systemInformation.osRelease = os.release();
|
|
778
|
-
this.systemInformation.osPlatform = os.platform();
|
|
779
|
-
this.systemInformation.osArch = os.arch();
|
|
971
|
+
this.systemInformation.osType = os.type(); // "Windows_NT", "Darwin", etc.
|
|
972
|
+
this.systemInformation.osRelease = os.release(); // Kernel version
|
|
973
|
+
this.systemInformation.osPlatform = os.platform(); // "win32", "linux", "darwin", etc.
|
|
974
|
+
this.systemInformation.osArch = os.arch(); // "x64", "arm", etc.
|
|
780
975
|
this.systemInformation.totalMemory = formatBytes(os.totalmem());
|
|
781
976
|
this.systemInformation.freeMemory = formatBytes(os.freemem());
|
|
782
977
|
this.systemInformation.systemUptime = formatUptime(os.uptime());
|
|
@@ -786,6 +981,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
786
981
|
this.systemInformation.rss = formatBytes(process.memoryUsage().rss);
|
|
787
982
|
this.systemInformation.heapTotal = formatBytes(process.memoryUsage().heapTotal);
|
|
788
983
|
this.systemInformation.heapUsed = formatBytes(process.memoryUsage().heapUsed);
|
|
984
|
+
// Log the system information
|
|
789
985
|
this.log.debug('Host System Information:');
|
|
790
986
|
this.log.debug(`- Hostname: ${this.systemInformation.hostname}`);
|
|
791
987
|
this.log.debug(`- User: ${this.systemInformation.user}`);
|
|
@@ -805,14 +1001,17 @@ export class Matterbridge extends EventEmitter {
|
|
|
805
1001
|
this.log.debug(`- RSS: ${this.systemInformation.rss}`);
|
|
806
1002
|
this.log.debug(`- Heap Total: ${this.systemInformation.heapTotal}`);
|
|
807
1003
|
this.log.debug(`- Heap Used: ${this.systemInformation.heapUsed}`);
|
|
1004
|
+
// Log directories
|
|
808
1005
|
this.log.debug(`Root Directory: ${this.rootDirectory}`);
|
|
809
1006
|
this.log.debug(`Home Directory: ${this.homeDirectory}`);
|
|
810
1007
|
this.log.debug(`Matterbridge Directory: ${this.matterbridgeDirectory}`);
|
|
811
1008
|
this.log.debug(`Matterbridge Plugin Directory: ${this.matterbridgePluginDirectory}`);
|
|
812
1009
|
this.log.debug(`Matterbridge Matter Certificate Directory: ${this.matterbridgeCertDirectory}`);
|
|
1010
|
+
// Global node_modules directory
|
|
813
1011
|
if (this.nodeContext)
|
|
814
1012
|
this.globalModulesDirectory = await this.nodeContext.get('globalModulesDirectory', '');
|
|
815
1013
|
if (this.globalModulesDirectory === '') {
|
|
1014
|
+
// First run of Matterbridge so the node storage is empty
|
|
816
1015
|
this.log.debug(`Getting global node_modules directory...`);
|
|
817
1016
|
try {
|
|
818
1017
|
const { getGlobalNodeModules } = await import('./utils/network.js');
|
|
@@ -825,29 +1024,42 @@ export class Matterbridge extends EventEmitter {
|
|
|
825
1024
|
}
|
|
826
1025
|
}
|
|
827
1026
|
else {
|
|
1027
|
+
// The global node_modules directory is already set in the node storage and we check if it is still valid
|
|
828
1028
|
this.log.debug(`Global node_modules Directory: ${this.globalModulesDirectory}`);
|
|
829
1029
|
const { createESMWorker } = await import('./workers.js');
|
|
830
1030
|
createESMWorker('NpmGlobalPrefix', path.join(this.rootDirectory, 'dist/workerGlobalPrefix.js'));
|
|
831
1031
|
}
|
|
1032
|
+
// Matterbridge version
|
|
832
1033
|
this.log.debug(`Reading matterbridge package.json...`);
|
|
833
1034
|
const packageJson = JSON.parse(await fs.promises.readFile(path.join(this.rootDirectory, 'package.json'), 'utf-8'));
|
|
834
1035
|
this.matterbridgeVersion = this.matterbridgeLatestVersion = this.matterbridgeDevVersion = packageJson.version;
|
|
835
1036
|
this.log.debug(`Matterbridge Version: ${this.matterbridgeVersion}`);
|
|
1037
|
+
// Matterbridge latest version (will be set in the checkUpdate function)
|
|
836
1038
|
if (this.nodeContext)
|
|
837
1039
|
this.matterbridgeLatestVersion = await this.nodeContext.get('matterbridgeLatestVersion', this.matterbridgeVersion);
|
|
838
1040
|
this.log.debug(`Matterbridge Latest Version: ${this.matterbridgeLatestVersion}`);
|
|
1041
|
+
// Matterbridge dev version (will be set in the checkUpdate function)
|
|
839
1042
|
if (this.nodeContext)
|
|
840
1043
|
this.matterbridgeDevVersion = await this.nodeContext.get('matterbridgeDevVersion', this.matterbridgeVersion);
|
|
841
1044
|
this.log.debug(`Matterbridge Dev Version: ${this.matterbridgeDevVersion}`);
|
|
1045
|
+
// Frontend version
|
|
842
1046
|
this.log.debug(`Reading frontend package.json...`);
|
|
843
1047
|
const frontendPackageJson = JSON.parse(await fs.promises.readFile(path.join(this.rootDirectory, 'frontend/package.json'), 'utf8'));
|
|
844
1048
|
this.frontendVersion = frontendPackageJson.version;
|
|
845
1049
|
this.log.debug(`Frontend version ${CYAN}${this.frontendVersion}${db}`);
|
|
1050
|
+
// Current working directory
|
|
846
1051
|
const currentDir = process.cwd();
|
|
847
1052
|
this.log.debug(`Current Working Directory: ${currentDir}`);
|
|
1053
|
+
// Command line arguments (excluding 'node' and the script name)
|
|
848
1054
|
const cmdArgs = process.argv.slice(2).join(' ');
|
|
849
1055
|
this.log.debug(`Command Line Arguments: ${cmdArgs}`);
|
|
850
1056
|
}
|
|
1057
|
+
/**
|
|
1058
|
+
* Set the logger logLevel for the Matterbridge classes and call onChangeLoggerLevel() for each plugin.
|
|
1059
|
+
*
|
|
1060
|
+
* @param {LogLevel} logLevel The logger logLevel to set.
|
|
1061
|
+
* @returns {Promise<LogLevel>} A promise that resolves when the logLevel has been set.
|
|
1062
|
+
*/
|
|
851
1063
|
async setLogLevel(logLevel) {
|
|
852
1064
|
this.logLevel = logLevel;
|
|
853
1065
|
this.log.logLevel = logLevel;
|
|
@@ -858,58 +1070,87 @@ export class Matterbridge extends EventEmitter {
|
|
|
858
1070
|
for (const plugin of this.plugins) {
|
|
859
1071
|
if (!plugin.platform || !plugin.platform.log || !plugin.platform.config)
|
|
860
1072
|
continue;
|
|
861
|
-
plugin.platform.log.logLevel = plugin.platform.config.debug === true ? "debug" : logLevel;
|
|
862
|
-
await plugin.platform.onChangeLoggerLevel(plugin.platform.config.debug === true ? "debug" : logLevel);
|
|
863
|
-
}
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
1073
|
+
plugin.platform.log.logLevel = plugin.platform.config.debug === true ? "debug" /* LogLevel.DEBUG */ : logLevel;
|
|
1074
|
+
await plugin.platform.onChangeLoggerLevel(plugin.platform.config.debug === true ? "debug" /* LogLevel.DEBUG */ : logLevel);
|
|
1075
|
+
}
|
|
1076
|
+
// Set the global logger callback for the WebSocketServer to the common minimum logLevel
|
|
1077
|
+
let callbackLogLevel = "notice" /* LogLevel.NOTICE */;
|
|
1078
|
+
if (logLevel === "info" /* LogLevel.INFO */ || Logger.level === MatterLogLevel.INFO)
|
|
1079
|
+
callbackLogLevel = "info" /* LogLevel.INFO */;
|
|
1080
|
+
if (logLevel === "debug" /* LogLevel.DEBUG */ || Logger.level === MatterLogLevel.DEBUG)
|
|
1081
|
+
callbackLogLevel = "debug" /* LogLevel.DEBUG */;
|
|
869
1082
|
AnsiLogger.setGlobalCallbackLevel(callbackLogLevel);
|
|
870
1083
|
this.log.debug(`WebSocketServer logger global callback set to ${callbackLogLevel}`);
|
|
871
1084
|
return logLevel;
|
|
872
1085
|
}
|
|
1086
|
+
/**
|
|
1087
|
+
* Get the current logger logLevel.
|
|
1088
|
+
*
|
|
1089
|
+
* @returns {LogLevel} The current logger logLevel.
|
|
1090
|
+
*/
|
|
873
1091
|
getLogLevel() {
|
|
874
1092
|
return this.log.logLevel;
|
|
875
1093
|
}
|
|
1094
|
+
/**
|
|
1095
|
+
* Creates a MatterLogger function to show the matter.js log messages in AnsiLogger (for the frontend).
|
|
1096
|
+
* It also logs to file (matter.log) if fileLogger is true.
|
|
1097
|
+
*
|
|
1098
|
+
* @param {boolean} fileLogger - Whether to log to file or not.
|
|
1099
|
+
* @returns {Function} The MatterLogger function. \x1b[35m for violet \x1b[34m is blue
|
|
1100
|
+
*/
|
|
876
1101
|
createDestinationMatterLogger(fileLogger) {
|
|
877
|
-
this.matterLog.logNameColor = '\x1b[34m';
|
|
1102
|
+
this.matterLog.logNameColor = '\x1b[34m'; // Blue matter.js Logger
|
|
878
1103
|
if (fileLogger) {
|
|
879
1104
|
this.matterLog.logFilePath = path.join(this.matterbridgeDirectory, MATTER_LOGGER_FILE);
|
|
880
1105
|
}
|
|
881
1106
|
return (text, message) => {
|
|
1107
|
+
// 2024-08-21 08:55:19.488 DEBUG InteractionMessenger Sending DataReport chunk with 28 attributes and 0 events: 1004 bytes
|
|
882
1108
|
const logger = text.slice(44, 44 + 20).trim();
|
|
883
1109
|
const msg = text.slice(65);
|
|
884
1110
|
this.matterLog.logName = logger;
|
|
885
1111
|
switch (message.level) {
|
|
886
1112
|
case MatterLogLevel.DEBUG:
|
|
887
|
-
this.matterLog.log("debug"
|
|
1113
|
+
this.matterLog.log("debug" /* LogLevel.DEBUG */, msg);
|
|
888
1114
|
break;
|
|
889
1115
|
case MatterLogLevel.INFO:
|
|
890
|
-
this.matterLog.log("info"
|
|
1116
|
+
this.matterLog.log("info" /* LogLevel.INFO */, msg);
|
|
891
1117
|
break;
|
|
892
1118
|
case MatterLogLevel.NOTICE:
|
|
893
|
-
this.matterLog.log("notice"
|
|
1119
|
+
this.matterLog.log("notice" /* LogLevel.NOTICE */, msg);
|
|
894
1120
|
break;
|
|
895
1121
|
case MatterLogLevel.WARN:
|
|
896
|
-
this.matterLog.log("warn"
|
|
1122
|
+
this.matterLog.log("warn" /* LogLevel.WARN */, msg);
|
|
897
1123
|
break;
|
|
898
1124
|
case MatterLogLevel.ERROR:
|
|
899
|
-
this.matterLog.log("error"
|
|
1125
|
+
this.matterLog.log("error" /* LogLevel.ERROR */, msg);
|
|
900
1126
|
break;
|
|
901
1127
|
case MatterLogLevel.FATAL:
|
|
902
|
-
this.matterLog.log("fatal"
|
|
1128
|
+
this.matterLog.log("fatal" /* LogLevel.FATAL */, msg);
|
|
903
1129
|
break;
|
|
904
1130
|
}
|
|
905
1131
|
};
|
|
906
1132
|
}
|
|
1133
|
+
/**
|
|
1134
|
+
* Restarts the process by exiting the current instance and loading a new instance (/api/restart).
|
|
1135
|
+
*
|
|
1136
|
+
* @returns {Promise<void>} A promise that resolves when the restart is completed.
|
|
1137
|
+
*/
|
|
907
1138
|
async restartProcess() {
|
|
908
1139
|
await this.cleanup('restarting...', true);
|
|
909
1140
|
}
|
|
1141
|
+
/**
|
|
1142
|
+
* Shut down the process (/api/shutdown).
|
|
1143
|
+
*
|
|
1144
|
+
* @returns {Promise<void>} A promise that resolves when the shutdown is completed.
|
|
1145
|
+
*/
|
|
910
1146
|
async shutdownProcess() {
|
|
911
1147
|
await this.cleanup('shutting down...', false);
|
|
912
1148
|
}
|
|
1149
|
+
/**
|
|
1150
|
+
* Update matterbridge and shut down the process (virtual device 'Update Matterbridge').
|
|
1151
|
+
*
|
|
1152
|
+
* @returns {Promise<void>} A promise that resolves when the update is completed.
|
|
1153
|
+
*/
|
|
913
1154
|
async updateProcess() {
|
|
914
1155
|
this.log.info('Updating matterbridge...');
|
|
915
1156
|
const { spawnCommand } = await import('./utils/spawn.js');
|
|
@@ -922,6 +1163,13 @@ export class Matterbridge extends EventEmitter {
|
|
|
922
1163
|
this.frontend.wssSendRestartRequired();
|
|
923
1164
|
await this.cleanup('updating...', false);
|
|
924
1165
|
}
|
|
1166
|
+
/**
|
|
1167
|
+
* Unregister all devices and shut down the process (/api/unregister).
|
|
1168
|
+
*
|
|
1169
|
+
* @param {number} [timeout] - The timeout duration to wait for the message exchange to complete in milliseconds. Default is 1000.
|
|
1170
|
+
*
|
|
1171
|
+
* @returns {Promise<void>} A promise that resolves when the cleanup is completed.
|
|
1172
|
+
*/
|
|
925
1173
|
async unregisterAndShutdownProcess(timeout = 1000) {
|
|
926
1174
|
this.log.info('Unregistering all devices and shutting down...');
|
|
927
1175
|
for (const plugin of this.plugins.array()) {
|
|
@@ -933,46 +1181,71 @@ export class Matterbridge extends EventEmitter {
|
|
|
933
1181
|
await this.removeAllBridgedEndpoints(plugin.name, 100);
|
|
934
1182
|
}
|
|
935
1183
|
this.log.debug('Waiting for the MessageExchange to finish...');
|
|
936
|
-
await wait(timeout);
|
|
1184
|
+
await wait(timeout); // Wait for MessageExchange to finish
|
|
937
1185
|
this.log.debug('Cleaning up and shutting down...');
|
|
938
1186
|
await this.cleanup('unregistered all devices and shutting down...', false, timeout);
|
|
939
1187
|
}
|
|
1188
|
+
/**
|
|
1189
|
+
* Reset commissioning and shut down the process (/api/reset).
|
|
1190
|
+
*
|
|
1191
|
+
* @returns {Promise<void>} A promise that resolves when the cleanup is completed.
|
|
1192
|
+
*/
|
|
940
1193
|
async shutdownProcessAndReset() {
|
|
941
1194
|
await this.cleanup('shutting down with reset...', false);
|
|
942
1195
|
}
|
|
1196
|
+
/**
|
|
1197
|
+
* Factory reset and shut down the process (/api/factory-reset).
|
|
1198
|
+
*
|
|
1199
|
+
* @returns {Promise<void>} A promise that resolves when the cleanup is completed.
|
|
1200
|
+
*/
|
|
943
1201
|
async shutdownProcessAndFactoryReset() {
|
|
944
1202
|
await this.cleanup('shutting down with factory reset...', false);
|
|
945
1203
|
}
|
|
1204
|
+
/**
|
|
1205
|
+
* Cleans up the Matterbridge instance.
|
|
1206
|
+
*
|
|
1207
|
+
* @param {string} message - The cleanup message.
|
|
1208
|
+
* @param {boolean} [restart] - Indicates whether to restart the instance after cleanup. Default is `false`.
|
|
1209
|
+
* @param {number} [pause] - The pause in ms to wait for the message exchange to complete in milliseconds. Default is 1000.
|
|
1210
|
+
*
|
|
1211
|
+
* @returns {Promise<void>} A promise that resolves when the cleanup is completed.
|
|
1212
|
+
*/
|
|
946
1213
|
async cleanup(message, restart = false, pause = 1000) {
|
|
947
1214
|
if (this.initialized && !this.hasCleanupStarted) {
|
|
948
1215
|
this.emit('cleanup_started');
|
|
949
1216
|
this.hasCleanupStarted = true;
|
|
950
1217
|
this.log.info(message);
|
|
1218
|
+
// Clear the start matter interval
|
|
951
1219
|
if (this.startMatterInterval) {
|
|
952
1220
|
clearInterval(this.startMatterInterval);
|
|
953
1221
|
this.startMatterInterval = undefined;
|
|
954
1222
|
this.log.debug('Start matter interval cleared');
|
|
955
1223
|
}
|
|
1224
|
+
// Clear the check update timeout
|
|
956
1225
|
if (this.checkUpdateTimeout) {
|
|
957
1226
|
clearTimeout(this.checkUpdateTimeout);
|
|
958
1227
|
this.checkUpdateTimeout = undefined;
|
|
959
1228
|
this.log.debug('Check update timeout cleared');
|
|
960
1229
|
}
|
|
1230
|
+
// Clear the check update interval
|
|
961
1231
|
if (this.checkUpdateInterval) {
|
|
962
1232
|
clearInterval(this.checkUpdateInterval);
|
|
963
1233
|
this.checkUpdateInterval = undefined;
|
|
964
1234
|
this.log.debug('Check update interval cleared');
|
|
965
1235
|
}
|
|
1236
|
+
// Clear the configure timeout
|
|
966
1237
|
if (this.configureTimeout) {
|
|
967
1238
|
clearTimeout(this.configureTimeout);
|
|
968
1239
|
this.configureTimeout = undefined;
|
|
969
1240
|
this.log.debug('Matterbridge configure timeout cleared');
|
|
970
1241
|
}
|
|
1242
|
+
// Clear the reachability timeout
|
|
971
1243
|
if (this.reachabilityTimeout) {
|
|
972
1244
|
clearTimeout(this.reachabilityTimeout);
|
|
973
1245
|
this.reachabilityTimeout = undefined;
|
|
974
1246
|
this.log.debug('Matterbridge reachability timeout cleared');
|
|
975
1247
|
}
|
|
1248
|
+
// Call the shutdown method of each plugin and clear the plugins reachability timeout
|
|
976
1249
|
for (const plugin of this.plugins) {
|
|
977
1250
|
if (!plugin.enabled || plugin.error)
|
|
978
1251
|
continue;
|
|
@@ -983,6 +1256,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
983
1256
|
this.log.debug(`Plugin ${plg}${plugin.name}${db} reachability timeout cleared`);
|
|
984
1257
|
}
|
|
985
1258
|
}
|
|
1259
|
+
// Stop matter server nodes
|
|
986
1260
|
this.log.notice(`Stopping matter server nodes in ${this.bridgeMode} mode...`);
|
|
987
1261
|
if (pause > 0) {
|
|
988
1262
|
this.log.debug(`Waiting ${pause}ms for the MessageExchange to finish...`);
|
|
@@ -1009,6 +1283,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
1009
1283
|
}
|
|
1010
1284
|
}
|
|
1011
1285
|
this.log.notice('Stopped matter server nodes');
|
|
1286
|
+
// Matter commisioning reset
|
|
1012
1287
|
if (message === 'shutting down with reset...') {
|
|
1013
1288
|
this.log.info('Resetting Matterbridge commissioning information...');
|
|
1014
1289
|
await this.matterStorageManager?.createContext('events')?.clearAll();
|
|
@@ -1018,6 +1293,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
1018
1293
|
await this.matterbridgeContext?.clearAll();
|
|
1019
1294
|
this.log.info('Matter storage reset done! Remove the bridge from the controller.');
|
|
1020
1295
|
}
|
|
1296
|
+
// Unregister all devices
|
|
1021
1297
|
if (message === 'unregistered all devices and shutting down...') {
|
|
1022
1298
|
if (this.bridgeMode === 'bridge') {
|
|
1023
1299
|
await this.matterStorageManager?.createContext('root')?.createContext('parts')?.createContext('Matterbridge')?.createContext('parts')?.clearAll();
|
|
@@ -1035,16 +1311,35 @@ export class Matterbridge extends EventEmitter {
|
|
|
1035
1311
|
}
|
|
1036
1312
|
this.log.info('Matter storage reset done!');
|
|
1037
1313
|
}
|
|
1314
|
+
// Stop matter storage
|
|
1038
1315
|
await this.stopMatterStorage();
|
|
1316
|
+
// Stop the frontend
|
|
1039
1317
|
await this.frontend.stop();
|
|
1040
1318
|
this.frontend.destroy();
|
|
1319
|
+
// Close PluginManager and DeviceManager
|
|
1041
1320
|
this.plugins.destroy();
|
|
1042
1321
|
this.devices.destroy();
|
|
1322
|
+
// Stop thread messaging server
|
|
1043
1323
|
this.server.close();
|
|
1324
|
+
// Close the matterbridge node storage and context
|
|
1044
1325
|
if (this.nodeStorage && this.nodeContext) {
|
|
1326
|
+
/*
|
|
1327
|
+
TODO: Implement serialization of registered devices
|
|
1328
|
+
this.log.info('Saving registered devices...');
|
|
1329
|
+
const serializedRegisteredDevices: SerializedMatterbridgeEndpoint[] = [];
|
|
1330
|
+
this.devices.forEach(async (device) => {
|
|
1331
|
+
const serializedMatterbridgeDevice = MatterbridgeEndpoint.serialize(device);
|
|
1332
|
+
this.log.info(`- ${serializedMatterbridgeDevice.deviceName}${rs}\n`, serializedMatterbridgeDevice);
|
|
1333
|
+
if (serializedMatterbridgeDevice) serializedRegisteredDevices.push(serializedMatterbridgeDevice);
|
|
1334
|
+
});
|
|
1335
|
+
await this.nodeContext.set<SerializedMatterbridgeEndpoint[]>('devices', serializedRegisteredDevices);
|
|
1336
|
+
this.log.info(`Saved registered devices (${serializedRegisteredDevices?.length})`);
|
|
1337
|
+
*/
|
|
1338
|
+
// Clear nodeContext and nodeStorage (they just need 1000ms to write the data to disk)
|
|
1045
1339
|
this.log.debug(`Closing node storage context for ${plg}Matterbridge${db}...`);
|
|
1046
1340
|
await this.nodeContext.close();
|
|
1047
1341
|
this.nodeContext = undefined;
|
|
1342
|
+
// Clear nodeContext for each plugin (they just need 1000ms to write the data to disk)
|
|
1048
1343
|
for (const plugin of this.plugins) {
|
|
1049
1344
|
if (plugin.nodeContext) {
|
|
1050
1345
|
this.log.debug(`Closing node storage context for plugin ${plg}${plugin.name}${db}...`);
|
|
@@ -1061,8 +1356,10 @@ export class Matterbridge extends EventEmitter {
|
|
|
1061
1356
|
}
|
|
1062
1357
|
this.plugins.clear();
|
|
1063
1358
|
this.devices.clear();
|
|
1359
|
+
// Factory reset
|
|
1064
1360
|
if (message === 'shutting down with factory reset...') {
|
|
1065
1361
|
try {
|
|
1362
|
+
// Delete matter storage directory with its subdirectories and backup
|
|
1066
1363
|
const dir = path.join(this.matterbridgeDirectory, MATTER_STORAGE_NAME);
|
|
1067
1364
|
this.log.info(`Removing matter storage directory: ${dir}`);
|
|
1068
1365
|
await fs.promises.rm(dir, { recursive: true });
|
|
@@ -1071,11 +1368,13 @@ export class Matterbridge extends EventEmitter {
|
|
|
1071
1368
|
await fs.promises.rm(backup, { recursive: true });
|
|
1072
1369
|
}
|
|
1073
1370
|
catch (error) {
|
|
1371
|
+
// istanbul ignore next if
|
|
1074
1372
|
if (error instanceof Error && error.code !== 'ENOENT') {
|
|
1075
1373
|
this.log.error(`Error removing matter storage directory: ${error}`);
|
|
1076
1374
|
}
|
|
1077
1375
|
}
|
|
1078
1376
|
try {
|
|
1377
|
+
// Delete matterbridge storage directory with its subdirectories and backup
|
|
1079
1378
|
const dir = path.join(this.matterbridgeDirectory, NODE_STORAGE_DIR);
|
|
1080
1379
|
this.log.info(`Removing matterbridge storage directory: ${dir}`);
|
|
1081
1380
|
await fs.promises.rm(dir, { recursive: true });
|
|
@@ -1084,18 +1383,20 @@ export class Matterbridge extends EventEmitter {
|
|
|
1084
1383
|
await fs.promises.rm(backup, { recursive: true });
|
|
1085
1384
|
}
|
|
1086
1385
|
catch (error) {
|
|
1386
|
+
// istanbul ignore next if
|
|
1087
1387
|
if (error instanceof Error && error.code !== 'ENOENT') {
|
|
1088
1388
|
this.log.error(`Error removing matterbridge storage directory: ${error}`);
|
|
1089
1389
|
}
|
|
1090
1390
|
}
|
|
1091
1391
|
this.log.info('Factory reset done! Remove all paired fabrics from the controllers.');
|
|
1092
1392
|
}
|
|
1393
|
+
// Deregisters the process handlers
|
|
1093
1394
|
this.deregisterProcessHandlers();
|
|
1094
1395
|
if (restart) {
|
|
1095
1396
|
if (message === 'updating...') {
|
|
1096
1397
|
this.log.info('Cleanup completed. Updating...');
|
|
1097
1398
|
Matterbridge.instance = undefined;
|
|
1098
|
-
this.emit('update');
|
|
1399
|
+
this.emit('update'); // Restart the process but the update has been done before. TODO move all updates to the cli
|
|
1099
1400
|
}
|
|
1100
1401
|
else if (message === 'restarting...') {
|
|
1101
1402
|
this.log.info('Cleanup completed. Restarting...');
|
|
@@ -1124,7 +1425,14 @@ export class Matterbridge extends EventEmitter {
|
|
|
1124
1425
|
this.log.debug('Cleanup already started...');
|
|
1125
1426
|
}
|
|
1126
1427
|
}
|
|
1428
|
+
/**
|
|
1429
|
+
* Starts the Matterbridge in bridge mode.
|
|
1430
|
+
*
|
|
1431
|
+
* @private
|
|
1432
|
+
* @returns {Promise<void>} A promise that resolves when the Matterbridge is started.
|
|
1433
|
+
*/
|
|
1127
1434
|
async startBridge() {
|
|
1435
|
+
// Plugins are configured by a timer when matter server is started and plugin.configured is set to true
|
|
1128
1436
|
if (!this.matterStorageManager)
|
|
1129
1437
|
throw new Error('No storage manager initialized');
|
|
1130
1438
|
if (!this.matterbridgeContext)
|
|
@@ -1163,13 +1471,16 @@ export class Matterbridge extends EventEmitter {
|
|
|
1163
1471
|
clearInterval(this.startMatterInterval);
|
|
1164
1472
|
this.startMatterInterval = undefined;
|
|
1165
1473
|
this.log.debug('Cleared startMatterInterval interval in bridge mode');
|
|
1166
|
-
|
|
1474
|
+
// Start the Matter server node
|
|
1475
|
+
this.startServerNode(this.serverNode); // We don't await this, because the server node is started in the background
|
|
1476
|
+
// Start the Matter server node of single devices in mode 'server'
|
|
1167
1477
|
for (const device of this.devices.array()) {
|
|
1168
1478
|
if (device.mode === 'server' && device.serverNode) {
|
|
1169
1479
|
this.log.debug(`Starting server node for device ${dev}${device.deviceName}${db} in server mode...`);
|
|
1170
|
-
this.startServerNode(device.serverNode);
|
|
1480
|
+
this.startServerNode(device.serverNode); // We don't await this, because the server node is started in the background
|
|
1171
1481
|
}
|
|
1172
1482
|
}
|
|
1483
|
+
// Configure the plugins
|
|
1173
1484
|
this.configureTimeout = setTimeout(async () => {
|
|
1174
1485
|
for (const plugin of this.plugins.array()) {
|
|
1175
1486
|
if (!plugin.enabled || !plugin.loaded || !plugin.started || plugin.error)
|
|
@@ -1187,28 +1498,40 @@ export class Matterbridge extends EventEmitter {
|
|
|
1187
1498
|
}
|
|
1188
1499
|
this.frontend.wssSendRefreshRequired('plugins');
|
|
1189
1500
|
}, 30 * 1000).unref();
|
|
1501
|
+
// Setting reachability to true
|
|
1190
1502
|
this.reachabilityTimeout = setTimeout(() => {
|
|
1191
1503
|
this.log.info(`Setting reachability to true for ${plg}Matterbridge${db}`);
|
|
1192
1504
|
if (this.aggregatorNode)
|
|
1193
1505
|
this.setAggregatorReachability(this.aggregatorNode, true);
|
|
1194
1506
|
}, 60 * 1000).unref();
|
|
1507
|
+
// Logger.get('LogServerNode').info(this.serverNode);
|
|
1195
1508
|
this.emit('bridge_started');
|
|
1196
1509
|
this.log.notice('Matterbridge bridge started successfully');
|
|
1197
1510
|
this.frontend.wssSendRefreshRequired('settings');
|
|
1198
1511
|
this.frontend.wssSendRefreshRequired('plugins');
|
|
1199
1512
|
}, Number(process.env['MATTERBRIDGE_START_MATTER_INTERVAL_MS']) || this.startMatterIntervalMs);
|
|
1200
1513
|
}
|
|
1514
|
+
/**
|
|
1515
|
+
* Starts the Matterbridge in childbridge mode.
|
|
1516
|
+
*
|
|
1517
|
+
* @param {number} [delay] - The delay before starting the childbridge. Default is 1000 milliseconds.
|
|
1518
|
+
*
|
|
1519
|
+
* @returns {Promise<void>} A promise that resolves when the Matterbridge is started.
|
|
1520
|
+
*/
|
|
1201
1521
|
async startChildbridge(delay = 1000) {
|
|
1202
1522
|
if (!this.matterStorageManager)
|
|
1203
1523
|
throw new Error('No storage manager initialized');
|
|
1524
|
+
// Load with await all plugins but don't start them. We get the platform.type to pre-create server nodes for DynamicPlatform plugins
|
|
1204
1525
|
this.log.debug('Loading all plugins in childbridge mode...');
|
|
1205
1526
|
await this.startPlugins(true, false);
|
|
1527
|
+
// Create server nodes for DynamicPlatform plugins and start all plugins in the background
|
|
1206
1528
|
this.log.debug('Creating server nodes for DynamicPlatform plugins and starting all plugins in childbridge mode...');
|
|
1207
1529
|
for (const plugin of this.plugins.array().filter((p) => p.enabled && !p.error)) {
|
|
1208
1530
|
if (plugin.type === 'DynamicPlatform')
|
|
1209
1531
|
await this.createDynamicPlugin(plugin);
|
|
1210
|
-
this.plugins.start(plugin, 'Matterbridge is starting');
|
|
1532
|
+
this.plugins.start(plugin, 'Matterbridge is starting'); // Start the plugin in the background
|
|
1211
1533
|
}
|
|
1534
|
+
// Start the Matterbridge in childbridge mode when all plugins are loaded and started
|
|
1212
1535
|
this.log.debug('Starting start matter interval in childbridge mode...');
|
|
1213
1536
|
let failCount = 0;
|
|
1214
1537
|
this.startMatterInterval = setInterval(async () => {
|
|
@@ -1242,8 +1565,9 @@ export class Matterbridge extends EventEmitter {
|
|
|
1242
1565
|
clearInterval(this.startMatterInterval);
|
|
1243
1566
|
this.startMatterInterval = undefined;
|
|
1244
1567
|
if (delay > 0)
|
|
1245
|
-
await wait(Number(process.env['MATTERBRIDGE_PAUSE_MATTER_INTERVAL_MS']) || delay);
|
|
1568
|
+
await wait(Number(process.env['MATTERBRIDGE_PAUSE_MATTER_INTERVAL_MS']) || delay); // Wait for the specified delay to ensure all plugins server nodes are ready
|
|
1246
1569
|
this.log.debug('Cleared startMatterInterval interval in childbridge mode');
|
|
1570
|
+
// Configure the plugins
|
|
1247
1571
|
this.configureTimeout = setTimeout(async () => {
|
|
1248
1572
|
for (const plugin of this.plugins.array()) {
|
|
1249
1573
|
if (!plugin.enabled || !plugin.loaded || !plugin.started || plugin.error)
|
|
@@ -1268,6 +1592,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
1268
1592
|
this.log.error(`Plugin ${plg}${plugin.name}${er} didn't register any devices to Matterbridge. Verify the plugin configuration.`);
|
|
1269
1593
|
continue;
|
|
1270
1594
|
}
|
|
1595
|
+
// istanbul ignore next if cause is just a safety check
|
|
1271
1596
|
if (!plugin.serverNode) {
|
|
1272
1597
|
this.log.error(`Server node not found for plugin ${plg}${plugin.name}${er}`);
|
|
1273
1598
|
continue;
|
|
@@ -1280,28 +1605,252 @@ export class Matterbridge extends EventEmitter {
|
|
|
1280
1605
|
this.log.error(`Node storage context not found for plugin ${plg}${plugin.name}${er}`);
|
|
1281
1606
|
continue;
|
|
1282
1607
|
}
|
|
1283
|
-
|
|
1608
|
+
// Start the Matter server node
|
|
1609
|
+
this.startServerNode(plugin.serverNode); // We don't await this, because the server node is started in the background
|
|
1610
|
+
// Setting reachability to true
|
|
1284
1611
|
plugin.reachabilityTimeout = setTimeout(() => {
|
|
1285
1612
|
this.log.info(`Setting reachability to true for ${plg}${plugin.name}${nf}`);
|
|
1286
1613
|
if (plugin.type === 'DynamicPlatform' && plugin.aggregatorNode)
|
|
1287
1614
|
this.setAggregatorReachability(plugin.aggregatorNode, true);
|
|
1288
1615
|
}, 60 * 1000).unref();
|
|
1289
1616
|
}
|
|
1617
|
+
// Start the Matter server node of single devices in mode 'server'
|
|
1290
1618
|
for (const device of this.devices.array()) {
|
|
1291
1619
|
if (device.mode === 'server' && device.serverNode) {
|
|
1292
1620
|
this.log.debug(`Starting server node for device ${dev}${device.deviceName}${db} in server mode...`);
|
|
1293
|
-
this.startServerNode(device.serverNode);
|
|
1621
|
+
this.startServerNode(device.serverNode); // We don't await this, because the server node is started in the background
|
|
1294
1622
|
}
|
|
1295
1623
|
}
|
|
1624
|
+
// Logger.get('LogServerNode').info(this.serverNode);
|
|
1296
1625
|
this.emit('childbridge_started');
|
|
1297
1626
|
this.log.notice('Matterbridge childbridge started successfully');
|
|
1298
1627
|
this.frontend.wssSendRefreshRequired('settings');
|
|
1299
1628
|
this.frontend.wssSendRefreshRequired('plugins');
|
|
1300
1629
|
}, Number(process.env['MATTERBRIDGE_START_MATTER_INTERVAL_MS']) || this.startMatterIntervalMs);
|
|
1301
1630
|
}
|
|
1631
|
+
/**
|
|
1632
|
+
* Starts the Matterbridge controller.
|
|
1633
|
+
*
|
|
1634
|
+
* @private
|
|
1635
|
+
* @returns {Promise<void>} A promise that resolves when the Matterbridge is started.
|
|
1636
|
+
*/
|
|
1302
1637
|
async startController() {
|
|
1638
|
+
/*
|
|
1639
|
+
if (!this.matterStorageManager) {
|
|
1640
|
+
this.log.error('No storage manager initialized');
|
|
1641
|
+
await this.cleanup('No storage manager initialized');
|
|
1642
|
+
return;
|
|
1643
|
+
}
|
|
1644
|
+
this.log.info('Creating context: mattercontrollerContext');
|
|
1645
|
+
this.controllerContext = this.matterStorageManager.createContext('mattercontrollerContext');
|
|
1646
|
+
if (!this.controllerContext) {
|
|
1647
|
+
this.log.error('No storage context mattercontrollerContext initialized');
|
|
1648
|
+
await this.cleanup('No storage context mattercontrollerContext initialized');
|
|
1649
|
+
return;
|
|
1650
|
+
}
|
|
1651
|
+
|
|
1652
|
+
this.log.debug('Starting matterbridge in mode', this.bridgeMode);
|
|
1653
|
+
this.matterServer = await this.createMatterServer(this.storageManager);
|
|
1654
|
+
this.log.info('Creating matter commissioning controller');
|
|
1655
|
+
this.commissioningController = new CommissioningController({
|
|
1656
|
+
autoConnect: false,
|
|
1657
|
+
});
|
|
1658
|
+
this.log.info('Adding matter commissioning controller to matter server');
|
|
1659
|
+
await this.matterServer.addCommissioningController(this.commissioningController);
|
|
1660
|
+
|
|
1661
|
+
this.log.info('Starting matter server');
|
|
1662
|
+
await this.matterServer.start();
|
|
1663
|
+
this.log.info('Matter server started');
|
|
1664
|
+
const commissioningOptions: ControllerCommissioningFlowOptions = {
|
|
1665
|
+
regulatoryLocation: GeneralCommissioning.RegulatoryLocationType.IndoorOutdoor,
|
|
1666
|
+
regulatoryCountryCode: 'XX',
|
|
1667
|
+
};
|
|
1668
|
+
const commissioningController = new CommissioningController({
|
|
1669
|
+
environment: {
|
|
1670
|
+
environment,
|
|
1671
|
+
id: uniqueId,
|
|
1672
|
+
},
|
|
1673
|
+
autoConnect: false, // Do not auto connect to the commissioned nodes
|
|
1674
|
+
adminFabricLabel,
|
|
1675
|
+
});
|
|
1676
|
+
|
|
1677
|
+
if (hasParameter('pairingcode')) {
|
|
1678
|
+
this.log.info('Pairing device with pairingcode:', getParameter('pairingcode'));
|
|
1679
|
+
const pairingCode = getParameter('pairingcode');
|
|
1680
|
+
const ip = this.controllerContext.has('ip') ? this.controllerContext.get<string>('ip') : undefined;
|
|
1681
|
+
const port = this.controllerContext.has('port') ? this.controllerContext.get<number>('port') : undefined;
|
|
1682
|
+
|
|
1683
|
+
let longDiscriminator, setupPin, shortDiscriminator;
|
|
1684
|
+
if (pairingCode !== undefined) {
|
|
1685
|
+
const pairingCodeCodec = ManualPairingCodeCodec.decode(pairingCode);
|
|
1686
|
+
shortDiscriminator = pairingCodeCodec.shortDiscriminator;
|
|
1687
|
+
longDiscriminator = undefined;
|
|
1688
|
+
setupPin = pairingCodeCodec.passcode;
|
|
1689
|
+
this.log.info(`Data extracted from pairing code: ${Logger.toJSON(pairingCodeCodec)}`);
|
|
1690
|
+
} else {
|
|
1691
|
+
longDiscriminator = await this.controllerContext.get('longDiscriminator', 3840);
|
|
1692
|
+
if (longDiscriminator > 4095) throw new Error('Discriminator value must be less than 4096');
|
|
1693
|
+
setupPin = this.controllerContext.get('pin', 20202021);
|
|
1694
|
+
}
|
|
1695
|
+
if ((shortDiscriminator === undefined && longDiscriminator === undefined) || setupPin === undefined) {
|
|
1696
|
+
throw new Error('Please specify the longDiscriminator of the device to commission with -longDiscriminator or provide a valid passcode with -passcode');
|
|
1697
|
+
}
|
|
1698
|
+
|
|
1699
|
+
const options = {
|
|
1700
|
+
commissioning: commissioningOptions,
|
|
1701
|
+
discovery: {
|
|
1702
|
+
knownAddress: ip !== undefined && port !== undefined ? { ip, port, type: 'udp' } : undefined,
|
|
1703
|
+
identifierData: longDiscriminator !== undefined ? { longDiscriminator } : shortDiscriminator !== undefined ? { shortDiscriminator } : {},
|
|
1704
|
+
},
|
|
1705
|
+
passcode: setupPin,
|
|
1706
|
+
} as NodeCommissioningOptions;
|
|
1707
|
+
this.log.info('Commissioning with options:', options);
|
|
1708
|
+
const nodeId = await this.commissioningController.commissionNode(options);
|
|
1709
|
+
this.log.info(`Commissioning successfully done with nodeId: ${nodeId}`);
|
|
1710
|
+
this.log.info('ActiveSessionInformation:', this.commissioningController.getActiveSessionInformation());
|
|
1711
|
+
} // (hasParameter('pairingcode'))
|
|
1712
|
+
|
|
1713
|
+
if (hasParameter('unpairall')) {
|
|
1714
|
+
this.log.info('***Commissioning controller unpairing all nodes...');
|
|
1715
|
+
const nodeIds = this.commissioningController.getCommissionedNodes();
|
|
1716
|
+
for (const nodeId of nodeIds) {
|
|
1717
|
+
this.log.info('***Commissioning controller unpairing node:', nodeId);
|
|
1718
|
+
await this.commissioningController.removeNode(nodeId);
|
|
1719
|
+
}
|
|
1720
|
+
return;
|
|
1721
|
+
}
|
|
1722
|
+
|
|
1723
|
+
if (hasParameter('discover')) {
|
|
1724
|
+
// const discover = await this.commissioningController.discoverCommissionableDevices({ productId: 0x8000, deviceType: 0xfff1 });
|
|
1725
|
+
// console.log(discover);
|
|
1726
|
+
}
|
|
1727
|
+
|
|
1728
|
+
if (!this.commissioningController.isCommissioned()) {
|
|
1729
|
+
this.log.info('***Commissioning controller is not commissioned: use matterbridge -controller -pairingcode [pairingcode] to commission a device');
|
|
1730
|
+
return;
|
|
1731
|
+
}
|
|
1732
|
+
|
|
1733
|
+
const nodeIds = this.commissioningController.getCommissionedNodes();
|
|
1734
|
+
this.log.info(`***Commissioning controller is commissioned ${this.commissioningController.isCommissioned()} and has ${nodeIds.length} nodes commisioned: `);
|
|
1735
|
+
for (const nodeId of nodeIds) {
|
|
1736
|
+
this.log.info(`***Connecting to commissioned node: ${nodeId}`);
|
|
1737
|
+
|
|
1738
|
+
const node = await this.commissioningController.connectNode(nodeId, {
|
|
1739
|
+
autoSubscribe: false,
|
|
1740
|
+
attributeChangedCallback: (peerNodeId, { path: { nodeId, clusterId, endpointId, attributeName }, value }) =>
|
|
1741
|
+
this.log.info(`***Commissioning controller attributeChangedCallback ${peerNodeId}: attribute ${nodeId}/${endpointId}/${clusterId}/${attributeName} changed to ${Logger.toJSON(value)}`),
|
|
1742
|
+
eventTriggeredCallback: (peerNodeId, { path: { nodeId, clusterId, endpointId, eventName }, events }) =>
|
|
1743
|
+
this.log.info(`***Commissioning controller eventTriggeredCallback ${peerNodeId}: Event ${nodeId}/${endpointId}/${clusterId}/${eventName} triggered with ${Logger.toJSON(events)}`),
|
|
1744
|
+
stateInformationCallback: (peerNodeId, info) => {
|
|
1745
|
+
switch (info) {
|
|
1746
|
+
case NodeStateInformation.Connected:
|
|
1747
|
+
this.log.info(`***Commissioning controller stateInformationCallback ${peerNodeId}: Node ${nodeId} connected`);
|
|
1748
|
+
break;
|
|
1749
|
+
case NodeStateInformation.Disconnected:
|
|
1750
|
+
this.log.info(`***Commissioning controller stateInformationCallback ${peerNodeId}: Node ${nodeId} disconnected`);
|
|
1751
|
+
break;
|
|
1752
|
+
case NodeStateInformation.Reconnecting:
|
|
1753
|
+
this.log.info(`***Commissioning controller stateInformationCallback ${peerNodeId}: Node ${nodeId} reconnecting`);
|
|
1754
|
+
break;
|
|
1755
|
+
case NodeStateInformation.WaitingForDeviceDiscovery:
|
|
1756
|
+
this.log.info(`***Commissioning controller stateInformationCallback ${peerNodeId}: Node ${nodeId} waiting for device discovery`);
|
|
1757
|
+
break;
|
|
1758
|
+
case NodeStateInformation.StructureChanged:
|
|
1759
|
+
this.log.info(`***Commissioning controller stateInformationCallback ${peerNodeId}: Node ${nodeId} structure changed`);
|
|
1760
|
+
break;
|
|
1761
|
+
case NodeStateInformation.Decommissioned:
|
|
1762
|
+
this.log.info(`***Commissioning controller stateInformationCallback ${peerNodeId}: Node ${nodeId} decommissioned`);
|
|
1763
|
+
break;
|
|
1764
|
+
default:
|
|
1765
|
+
this.log.info(`***Commissioning controller stateInformationCallback ${peerNodeId}: Node ${nodeId} NodeStateInformation.${info}`);
|
|
1766
|
+
break;
|
|
1767
|
+
}
|
|
1768
|
+
},
|
|
1769
|
+
});
|
|
1770
|
+
|
|
1771
|
+
node.logStructure();
|
|
1772
|
+
|
|
1773
|
+
// Get the interaction client
|
|
1774
|
+
this.log.info('Getting the interaction client');
|
|
1775
|
+
const interactionClient = await node.getInteractionClient();
|
|
1776
|
+
let cluster;
|
|
1777
|
+
let attributes;
|
|
1778
|
+
|
|
1779
|
+
// Log BasicInformationCluster
|
|
1780
|
+
cluster = BasicInformationCluster;
|
|
1781
|
+
attributes = await interactionClient.getMultipleAttributes({
|
|
1782
|
+
attributes: [{ clusterId: cluster.id }],
|
|
1783
|
+
});
|
|
1784
|
+
if (attributes.length > 0) this.log.info(`Cluster: ${idn}${cluster.name}${rs}${nf} attributes:`);
|
|
1785
|
+
attributes.forEach((attribute) => {
|
|
1786
|
+
this.log.info(
|
|
1787
|
+
`- 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}`,
|
|
1788
|
+
);
|
|
1789
|
+
});
|
|
1790
|
+
|
|
1791
|
+
// Log PowerSourceCluster
|
|
1792
|
+
cluster = PowerSourceCluster;
|
|
1793
|
+
attributes = await interactionClient.getMultipleAttributes({
|
|
1794
|
+
attributes: [{ clusterId: cluster.id }],
|
|
1795
|
+
});
|
|
1796
|
+
if (attributes.length > 0) this.log.info(`Cluster: ${idn}${cluster.name}${rs}${nf} attributes:`);
|
|
1797
|
+
attributes.forEach((attribute) => {
|
|
1798
|
+
this.log.info(
|
|
1799
|
+
`- 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}`,
|
|
1800
|
+
);
|
|
1801
|
+
});
|
|
1802
|
+
|
|
1803
|
+
// Log ThreadNetworkDiagnostics
|
|
1804
|
+
cluster = ThreadNetworkDiagnosticsCluster;
|
|
1805
|
+
attributes = await interactionClient.getMultipleAttributes({
|
|
1806
|
+
attributes: [{ clusterId: cluster.id }],
|
|
1807
|
+
});
|
|
1808
|
+
if (attributes.length > 0) this.log.info(`Cluster: ${idn}${cluster.name}${rs}${nf} attributes:`);
|
|
1809
|
+
attributes.forEach((attribute) => {
|
|
1810
|
+
this.log.info(
|
|
1811
|
+
`- 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}`,
|
|
1812
|
+
);
|
|
1813
|
+
});
|
|
1814
|
+
|
|
1815
|
+
// Log SwitchCluster
|
|
1816
|
+
cluster = SwitchCluster;
|
|
1817
|
+
attributes = await interactionClient.getMultipleAttributes({
|
|
1818
|
+
attributes: [{ clusterId: cluster.id }],
|
|
1819
|
+
});
|
|
1820
|
+
if (attributes.length > 0) this.log.info(`Cluster: ${idn}${cluster.name}${rs}${nf} attributes:`);
|
|
1821
|
+
attributes.forEach((attribute) => {
|
|
1822
|
+
this.log.info(
|
|
1823
|
+
`- 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}`,
|
|
1824
|
+
);
|
|
1825
|
+
});
|
|
1826
|
+
|
|
1827
|
+
this.log.info('Subscribing to all attributes and events');
|
|
1828
|
+
await node.subscribeAllAttributesAndEvents({
|
|
1829
|
+
ignoreInitialTriggers: false,
|
|
1830
|
+
attributeChangedCallback: ({ path: { nodeId, clusterId, endpointId, attributeName }, version, value }) =>
|
|
1831
|
+
this.log.info(
|
|
1832
|
+
`***${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}`,
|
|
1833
|
+
),
|
|
1834
|
+
eventTriggeredCallback: ({ path: { nodeId, clusterId, endpointId, eventName }, events }) => {
|
|
1835
|
+
this.log.info(
|
|
1836
|
+
`***${db}Commissioning controller eventTriggeredCallback: event ${BLUE}${nodeId}${db}/${or}${endpointId}${db}/${hk}${getClusterNameById(clusterId)}${db}/${zb}${eventName}${db} triggered with ${debugStringify(events ?? { none: true })}`,
|
|
1837
|
+
);
|
|
1838
|
+
},
|
|
1839
|
+
});
|
|
1840
|
+
this.log.info('Subscribed to all attributes and events');
|
|
1841
|
+
}
|
|
1842
|
+
*/
|
|
1303
1843
|
}
|
|
1844
|
+
/** */
|
|
1845
|
+
/** Matter.js methods */
|
|
1846
|
+
/** */
|
|
1847
|
+
/**
|
|
1848
|
+
* Starts the matter storage with name Matterbridge, create the matterbridge context and performs a backup.
|
|
1849
|
+
*
|
|
1850
|
+
* @returns {Promise<void>} - A promise that resolves when the storage is started.
|
|
1851
|
+
*/
|
|
1304
1852
|
async startMatterStorage() {
|
|
1853
|
+
// Setup Matter storage
|
|
1305
1854
|
this.log.info(`Starting matter node storage...`);
|
|
1306
1855
|
this.matterStorageService = this.environment.get(StorageService);
|
|
1307
1856
|
this.log.info(`Matter node storage service created: ${this.matterStorageService.location}`);
|
|
@@ -1309,8 +1858,17 @@ export class Matterbridge extends EventEmitter {
|
|
|
1309
1858
|
this.log.info('Matter node storage manager "Matterbridge" created');
|
|
1310
1859
|
this.matterbridgeContext = await this.createServerNodeContext('Matterbridge', 'Matterbridge', this.aggregatorDeviceType, this.aggregatorVendorId, this.aggregatorVendorName, this.aggregatorProductId, this.aggregatorProductName, this.aggregatorSerialNumber, this.aggregatorUniqueId);
|
|
1311
1860
|
this.log.info('Matter node storage started');
|
|
1861
|
+
// Backup matter storage since it is created/opened correctly
|
|
1312
1862
|
await this.backupMatterStorage(path.join(this.matterbridgeDirectory, MATTER_STORAGE_NAME), path.join(this.matterbridgeDirectory, MATTER_STORAGE_NAME + '.backup'));
|
|
1313
1863
|
}
|
|
1864
|
+
/**
|
|
1865
|
+
* Makes a backup copy of the specified matter storage directory.
|
|
1866
|
+
*
|
|
1867
|
+
* @param {string} storageName - The name of the storage directory to be backed up.
|
|
1868
|
+
* @param {string} backupName - The name of the backup directory to be created.
|
|
1869
|
+
* @private
|
|
1870
|
+
* @returns {Promise<void>} A promise that resolves when the has been done.
|
|
1871
|
+
*/
|
|
1314
1872
|
async backupMatterStorage(storageName, backupName) {
|
|
1315
1873
|
this.log.info('Creating matter node storage backup...');
|
|
1316
1874
|
try {
|
|
@@ -1321,6 +1879,11 @@ export class Matterbridge extends EventEmitter {
|
|
|
1321
1879
|
this.log.error(`Error creating matter node storage backup from ${storageName} to ${backupName}:`, error);
|
|
1322
1880
|
}
|
|
1323
1881
|
}
|
|
1882
|
+
/**
|
|
1883
|
+
* Stops the matter storage.
|
|
1884
|
+
*
|
|
1885
|
+
* @returns {Promise<void>} A promise that resolves when the storage is stopped.
|
|
1886
|
+
*/
|
|
1324
1887
|
async stopMatterStorage() {
|
|
1325
1888
|
this.log.info('Closing matter node storage...');
|
|
1326
1889
|
await this.matterStorageManager?.close();
|
|
@@ -1329,6 +1892,20 @@ export class Matterbridge extends EventEmitter {
|
|
|
1329
1892
|
this.matterbridgeContext = undefined;
|
|
1330
1893
|
this.log.info('Matter node storage closed');
|
|
1331
1894
|
}
|
|
1895
|
+
/**
|
|
1896
|
+
* Creates a server node storage context.
|
|
1897
|
+
*
|
|
1898
|
+
* @param {string} storeId - The storeId.
|
|
1899
|
+
* @param {string} deviceName - The name of the device.
|
|
1900
|
+
* @param {DeviceTypeId} deviceType - The device type of the device.
|
|
1901
|
+
* @param {number} vendorId - The vendor ID.
|
|
1902
|
+
* @param {string} vendorName - The vendor name.
|
|
1903
|
+
* @param {number} productId - The product ID.
|
|
1904
|
+
* @param {string} productName - The product name.
|
|
1905
|
+
* @param {string} [serialNumber] - The serial number of the device (optional).
|
|
1906
|
+
* @param {string} [uniqueId] - The unique ID of the device (optional).
|
|
1907
|
+
* @returns {Promise<StorageContext>} The storage context for the commissioning server.
|
|
1908
|
+
*/
|
|
1332
1909
|
async createServerNodeContext(storeId, deviceName, deviceType, vendorId, vendorName, productId, productName, serialNumber, uniqueId) {
|
|
1333
1910
|
const { randomBytes } = await import('node:crypto');
|
|
1334
1911
|
if (!this.matterStorageService)
|
|
@@ -1368,6 +1945,15 @@ export class Matterbridge extends EventEmitter {
|
|
|
1368
1945
|
this.log.debug(`- hardwareVersion: ${await storageContext.get('hardwareVersion')} hardwareVersionString: ${await storageContext.get('hardwareVersionString')}`);
|
|
1369
1946
|
return storageContext;
|
|
1370
1947
|
}
|
|
1948
|
+
/**
|
|
1949
|
+
* Creates a server node.
|
|
1950
|
+
*
|
|
1951
|
+
* @param {StorageContext} storageContext - The storage context for the server node.
|
|
1952
|
+
* @param {number} [port] - The port number for the server node. Defaults to 5540.
|
|
1953
|
+
* @param {number} [passcode] - The passcode for the server node. Defaults to 20242025.
|
|
1954
|
+
* @param {number} [discriminator] - The discriminator for the server node. Defaults to 3850.
|
|
1955
|
+
* @returns {Promise<ServerNode<ServerNode.RootEndpoint>>} A promise that resolves to the created server node.
|
|
1956
|
+
*/
|
|
1371
1957
|
async createServerNode(storageContext, port = 5540, passcode = 20242025, discriminator = 3850) {
|
|
1372
1958
|
const storeId = await storageContext.get('storeId');
|
|
1373
1959
|
this.log.notice(`Creating server node for ${storeId} on port ${port} with passcode ${passcode} and discriminator ${discriminator}...`);
|
|
@@ -1377,25 +1963,35 @@ export class Matterbridge extends EventEmitter {
|
|
|
1377
1963
|
this.log.debug(`- uniqueId: ${await storageContext.get('uniqueId')}`);
|
|
1378
1964
|
this.log.debug(`- softwareVersion: ${await storageContext.get('softwareVersion')} softwareVersionString: ${await storageContext.get('softwareVersionString')}`);
|
|
1379
1965
|
this.log.debug(`- hardwareVersion: ${await storageContext.get('hardwareVersion')} hardwareVersionString: ${await storageContext.get('hardwareVersionString')}`);
|
|
1966
|
+
/**
|
|
1967
|
+
* Create a Matter ServerNode, which contains the Root Endpoint and all relevant data and configuration
|
|
1968
|
+
*/
|
|
1380
1969
|
const serverNode = await ServerNode.create({
|
|
1970
|
+
// Required: Give the Node a unique ID which is used to store the state of this node
|
|
1381
1971
|
id: storeId,
|
|
1972
|
+
// Environment to run the server node in
|
|
1382
1973
|
environment: this.environment,
|
|
1974
|
+
// Provide Network relevant configuration like the port
|
|
1383
1975
|
network: {
|
|
1384
1976
|
listeningAddressIpv4: this.ipv4Address,
|
|
1385
1977
|
listeningAddressIpv6: this.ipv6Address,
|
|
1386
1978
|
port,
|
|
1387
1979
|
},
|
|
1980
|
+
// Provide the certificate for the device
|
|
1388
1981
|
operationalCredentials: {
|
|
1389
1982
|
certification: this.certification,
|
|
1390
1983
|
},
|
|
1984
|
+
// Provide Commissioning relevant settings
|
|
1391
1985
|
commissioning: {
|
|
1392
1986
|
passcode,
|
|
1393
1987
|
discriminator,
|
|
1394
1988
|
},
|
|
1989
|
+
// Provide Node announcement settings
|
|
1395
1990
|
productDescription: {
|
|
1396
1991
|
name: await storageContext.get('deviceName'),
|
|
1397
1992
|
deviceType: DeviceTypeId(await storageContext.get('deviceType')),
|
|
1398
1993
|
},
|
|
1994
|
+
// Provide defaults for the BasicInformation cluster on the Root endpoint
|
|
1399
1995
|
basicInformation: {
|
|
1400
1996
|
vendorId: VendorId(await storageContext.get('vendorId')),
|
|
1401
1997
|
vendorName: await storageContext.get('vendorName'),
|
|
@@ -1412,17 +2008,23 @@ export class Matterbridge extends EventEmitter {
|
|
|
1412
2008
|
reachable: true,
|
|
1413
2009
|
},
|
|
1414
2010
|
});
|
|
2011
|
+
/**
|
|
2012
|
+
* This event is triggered when the device is initially commissioned successfully.
|
|
2013
|
+
* This means: It is added to the first fabric.
|
|
2014
|
+
*/
|
|
1415
2015
|
serverNode.lifecycle.commissioned.on(() => {
|
|
1416
2016
|
this.log.notice(`Server node for ${storeId} was initially commissioned successfully!`);
|
|
1417
2017
|
this.advertisingNodes.delete(storeId);
|
|
1418
2018
|
this.frontend.wssSendRefreshRequired('matter', { matter: { ...this.getServerNodeData(serverNode) } });
|
|
1419
2019
|
});
|
|
2020
|
+
/** This event is triggered when all fabrics are removed from the device, usually it also does a factory reset then. */
|
|
1420
2021
|
serverNode.lifecycle.decommissioned.on(() => {
|
|
1421
2022
|
this.log.notice(`Server node for ${storeId} was fully decommissioned successfully!`);
|
|
1422
2023
|
this.advertisingNodes.delete(storeId);
|
|
1423
2024
|
this.frontend.wssSendRefreshRequired('matter', { matter: { ...this.getServerNodeData(serverNode) } });
|
|
1424
2025
|
this.frontend.wssSendSnackbarMessage(`${storeId} is offline`, 5, 'warning');
|
|
1425
2026
|
});
|
|
2027
|
+
/** This event is triggered when the device went online. This means that it is discoverable in the network. */
|
|
1426
2028
|
serverNode.lifecycle.online.on(async () => {
|
|
1427
2029
|
this.log.notice(`Server node for ${storeId} is online`);
|
|
1428
2030
|
if (!serverNode.lifecycle.isCommissioned) {
|
|
@@ -1433,13 +2035,16 @@ export class Matterbridge extends EventEmitter {
|
|
|
1433
2035
|
this.log.notice(`Manual pairing code: ${manualPairingCode}`);
|
|
1434
2036
|
}
|
|
1435
2037
|
else {
|
|
2038
|
+
// istanbul ignore next
|
|
1436
2039
|
this.log.notice(`Server node for ${storeId} is already commissioned. Waiting for controllers to connect ...`);
|
|
2040
|
+
// istanbul ignore next
|
|
1437
2041
|
this.advertisingNodes.delete(storeId);
|
|
1438
2042
|
}
|
|
1439
2043
|
this.frontend.wssSendRefreshRequired('matter', { matter: { ...this.getServerNodeData(serverNode) } });
|
|
1440
2044
|
this.frontend.wssSendSnackbarMessage(`${storeId} is online`, 5, 'success');
|
|
1441
2045
|
this.emit('online', storeId);
|
|
1442
2046
|
});
|
|
2047
|
+
/** This event is triggered when the device went offline. it is not longer discoverable or connectable in the network. */
|
|
1443
2048
|
serverNode.lifecycle.offline.on(() => {
|
|
1444
2049
|
this.log.notice(`Server node for ${storeId} is offline`);
|
|
1445
2050
|
this.advertisingNodes.delete(storeId);
|
|
@@ -1447,11 +2052,15 @@ export class Matterbridge extends EventEmitter {
|
|
|
1447
2052
|
this.frontend.wssSendSnackbarMessage(`${storeId} is offline`, 5, 'warning');
|
|
1448
2053
|
this.emit('offline', storeId);
|
|
1449
2054
|
});
|
|
2055
|
+
/**
|
|
2056
|
+
* This event is triggered when a fabric is added, removed or updated on the device. Use this if more granular
|
|
2057
|
+
* information is needed.
|
|
2058
|
+
*/
|
|
1450
2059
|
serverNode.events.commissioning.fabricsChanged.on((fabricIndex, fabricAction) => {
|
|
1451
2060
|
let action = '';
|
|
1452
2061
|
switch (fabricAction) {
|
|
1453
2062
|
case FabricAction.Added:
|
|
1454
|
-
this.advertisingNodes.delete(storeId);
|
|
2063
|
+
this.advertisingNodes.delete(storeId); // The advertising stops when a fabric is added
|
|
1455
2064
|
action = 'added';
|
|
1456
2065
|
break;
|
|
1457
2066
|
case FabricAction.Removed:
|
|
@@ -1464,14 +2073,22 @@ export class Matterbridge extends EventEmitter {
|
|
|
1464
2073
|
this.log.notice(`Commissioned fabric index ${fabricIndex} ${action} on server node for ${storeId}: ${debugStringify(serverNode.state.commissioning.fabrics[fabricIndex])}`);
|
|
1465
2074
|
this.frontend.wssSendRefreshRequired('matter', { matter: { ...this.getServerNodeData(serverNode) } });
|
|
1466
2075
|
});
|
|
2076
|
+
/**
|
|
2077
|
+
* This event is triggered when an operative new session was opened by a Controller.
|
|
2078
|
+
* It is not triggered for the initial commissioning process, just afterwards for real connections.
|
|
2079
|
+
*/
|
|
1467
2080
|
serverNode.events.sessions.opened.on((session) => {
|
|
1468
2081
|
this.log.notice(`Session opened on server node for ${storeId}: ${debugStringify(session)}`);
|
|
1469
2082
|
this.frontend.wssSendRefreshRequired('matter', { matter: { ...this.getServerNodeData(serverNode) } });
|
|
1470
2083
|
});
|
|
2084
|
+
/**
|
|
2085
|
+
* This event is triggered when an operative session is closed by a Controller or because the Device goes offline.
|
|
2086
|
+
*/
|
|
1471
2087
|
serverNode.events.sessions.closed.on((session) => {
|
|
1472
2088
|
this.log.notice(`Session closed on server node for ${storeId}: ${debugStringify(session)}`);
|
|
1473
2089
|
this.frontend.wssSendRefreshRequired('matter', { matter: { ...this.getServerNodeData(serverNode) } });
|
|
1474
2090
|
});
|
|
2091
|
+
/** This event is triggered when a subscription gets added or removed on an operative session. */
|
|
1475
2092
|
serverNode.events.sessions.subscriptionsChanged.on((session) => {
|
|
1476
2093
|
this.log.notice(`Session subscriptions changed on server node for ${storeId}: ${debugStringify(session)}`);
|
|
1477
2094
|
this.frontend.wssSendRefreshRequired('matter', { matter: { ...this.getServerNodeData(serverNode) } });
|
|
@@ -1479,6 +2096,12 @@ export class Matterbridge extends EventEmitter {
|
|
|
1479
2096
|
this.log.info(`Created server node for ${storeId}`);
|
|
1480
2097
|
return serverNode;
|
|
1481
2098
|
}
|
|
2099
|
+
/**
|
|
2100
|
+
* Gets the matter sanitized data of the specified server node.
|
|
2101
|
+
*
|
|
2102
|
+
* @param {ServerNode} [serverNode] - The server node to start.
|
|
2103
|
+
* @returns {ApiMatter} The sanitized data of the server node.
|
|
2104
|
+
*/
|
|
1482
2105
|
getServerNodeData(serverNode) {
|
|
1483
2106
|
const advertiseTime = this.advertisingNodes.get(serverNode.id) || 0;
|
|
1484
2107
|
return {
|
|
@@ -1495,12 +2118,25 @@ export class Matterbridge extends EventEmitter {
|
|
|
1495
2118
|
serialNumber: serverNode.state.basicInformation.serialNumber,
|
|
1496
2119
|
};
|
|
1497
2120
|
}
|
|
2121
|
+
/**
|
|
2122
|
+
* Starts the specified server node.
|
|
2123
|
+
*
|
|
2124
|
+
* @param {ServerNode} [matterServerNode] - The server node to start.
|
|
2125
|
+
* @returns {Promise<void>} A promise that resolves when the server node has started.
|
|
2126
|
+
*/
|
|
1498
2127
|
async startServerNode(matterServerNode) {
|
|
1499
2128
|
if (!matterServerNode)
|
|
1500
2129
|
return;
|
|
1501
2130
|
this.log.notice(`Starting ${matterServerNode.id} server node`);
|
|
1502
2131
|
await matterServerNode.start();
|
|
1503
2132
|
}
|
|
2133
|
+
/**
|
|
2134
|
+
* Stops the specified server node.
|
|
2135
|
+
*
|
|
2136
|
+
* @param {ServerNode} matterServerNode - The server node to stop.
|
|
2137
|
+
* @param {number} [timeout] - The timeout in milliseconds for stopping the server node. Defaults to 30 seconds.
|
|
2138
|
+
* @returns {Promise<void>} A promise that resolves when the server node has stopped.
|
|
2139
|
+
*/
|
|
1504
2140
|
async stopServerNode(matterServerNode, timeout = 30000) {
|
|
1505
2141
|
if (!matterServerNode)
|
|
1506
2142
|
return;
|
|
@@ -1513,12 +2149,25 @@ export class Matterbridge extends EventEmitter {
|
|
|
1513
2149
|
this.log.error(`Failed to close ${matterServerNode.id} server node: ${error instanceof Error ? error.message : error}`);
|
|
1514
2150
|
}
|
|
1515
2151
|
}
|
|
2152
|
+
/**
|
|
2153
|
+
* Creates an aggregator node with the specified storage context.
|
|
2154
|
+
*
|
|
2155
|
+
* @param {StorageContext} storageContext - The storage context for the aggregator node.
|
|
2156
|
+
* @returns {Promise<Endpoint<AggregatorEndpoint>>} A promise that resolves to the created aggregator node.
|
|
2157
|
+
*/
|
|
1516
2158
|
async createAggregatorNode(storageContext) {
|
|
1517
2159
|
this.log.notice(`Creating ${await storageContext.get('storeId')} aggregator...`);
|
|
1518
2160
|
const aggregatorNode = new Endpoint(AggregatorEndpoint, { id: `${await storageContext.get('storeId')}` });
|
|
1519
2161
|
this.log.info(`Created ${await storageContext.get('storeId')} aggregator`);
|
|
1520
2162
|
return aggregatorNode;
|
|
1521
2163
|
}
|
|
2164
|
+
/**
|
|
2165
|
+
* Creates and configures the server node for an accessory plugin for a given device.
|
|
2166
|
+
*
|
|
2167
|
+
* @param {Plugin} plugin - The plugin to configure.
|
|
2168
|
+
* @param {MatterbridgeEndpoint} device - The device to associate with the plugin.
|
|
2169
|
+
* @returns {Promise<void>} A promise that resolves when the server node for the accessory plugin is created and configured.
|
|
2170
|
+
*/
|
|
1522
2171
|
async createAccessoryPlugin(plugin, device) {
|
|
1523
2172
|
if (!plugin.locked && device.deviceType && device.deviceName && device.vendorId && device.productId && device.vendorName && device.productName) {
|
|
1524
2173
|
plugin.locked = true;
|
|
@@ -1530,6 +2179,12 @@ export class Matterbridge extends EventEmitter {
|
|
|
1530
2179
|
await plugin.serverNode.add(device);
|
|
1531
2180
|
}
|
|
1532
2181
|
}
|
|
2182
|
+
/**
|
|
2183
|
+
* Creates and configures the server node and the aggregator node for a dynamic plugin.
|
|
2184
|
+
*
|
|
2185
|
+
* @param {Plugin} plugin - The plugin to configure.
|
|
2186
|
+
* @returns {Promise<void>} A promise that resolves when the server node and the aggregator node for the dynamic plugin is created and configured.
|
|
2187
|
+
*/
|
|
1533
2188
|
async createDynamicPlugin(plugin) {
|
|
1534
2189
|
if (!plugin.locked) {
|
|
1535
2190
|
plugin.locked = true;
|
|
@@ -1542,6 +2197,13 @@ export class Matterbridge extends EventEmitter {
|
|
|
1542
2197
|
await plugin.serverNode.add(plugin.aggregatorNode);
|
|
1543
2198
|
}
|
|
1544
2199
|
}
|
|
2200
|
+
/**
|
|
2201
|
+
* Creates and configures the server node for a single not bridged device.
|
|
2202
|
+
*
|
|
2203
|
+
* @param {Plugin} plugin - The plugin to configure.
|
|
2204
|
+
* @param {MatterbridgeEndpoint} device - The device to associate with the plugin.
|
|
2205
|
+
* @returns {Promise<void>} A promise that resolves when the server node for the accessory plugin is created and configured.
|
|
2206
|
+
*/
|
|
1545
2207
|
async createDeviceServerNode(plugin, device) {
|
|
1546
2208
|
if (device.mode === 'server' && !device.serverNode && device.deviceType && device.deviceName && device.vendorId && device.vendorName && device.productId && device.productName) {
|
|
1547
2209
|
this.log.debug(`Creating device ${plg}${plugin.name}${db}:${dev}${device.deviceName}${db} server node...`);
|
|
@@ -1552,7 +2214,15 @@ export class Matterbridge extends EventEmitter {
|
|
|
1552
2214
|
this.log.debug(`Added ${plg}${plugin.name}${db}:${dev}${device.deviceName}${db} to server node`);
|
|
1553
2215
|
}
|
|
1554
2216
|
}
|
|
2217
|
+
/**
|
|
2218
|
+
* Adds a MatterbridgeEndpoint to the specified plugin.
|
|
2219
|
+
*
|
|
2220
|
+
* @param {string} pluginName - The name of the plugin.
|
|
2221
|
+
* @param {MatterbridgeEndpoint} device - The device to add as a bridged endpoint.
|
|
2222
|
+
* @returns {Promise<void>} A promise that resolves when the bridged endpoint has been added.
|
|
2223
|
+
*/
|
|
1555
2224
|
async addBridgedEndpoint(pluginName, device) {
|
|
2225
|
+
// Check if the plugin is registered
|
|
1556
2226
|
const plugin = this.plugins.get(pluginName);
|
|
1557
2227
|
if (!plugin) {
|
|
1558
2228
|
this.log.error(`Error adding bridged endpoint ${dev}${device.deviceName}${er} (${zb}${device.id}${er}) plugin ${plg}${pluginName}${er} not found`);
|
|
@@ -1572,6 +2242,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
1572
2242
|
}
|
|
1573
2243
|
else if (this.bridgeMode === 'bridge') {
|
|
1574
2244
|
if (device.mode === 'matter') {
|
|
2245
|
+
// Register and add the device to the matterbridge server node
|
|
1575
2246
|
this.log.debug(`Adding matter endpoint ${plg}${pluginName}${db}:${dev}${device.deviceName}${db} to Matterbridge server node...`);
|
|
1576
2247
|
if (!this.serverNode) {
|
|
1577
2248
|
this.log.error('Server node not found for Matterbridge');
|
|
@@ -1588,6 +2259,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
1588
2259
|
}
|
|
1589
2260
|
}
|
|
1590
2261
|
else {
|
|
2262
|
+
// Register and add the device to the matterbridge aggregator node
|
|
1591
2263
|
this.log.debug(`Adding bridged endpoint ${plg}${pluginName}${db}:${dev}${device.deviceName}${db} to Matterbridge aggregator node`);
|
|
1592
2264
|
if (!this.aggregatorNode) {
|
|
1593
2265
|
this.log.error('Aggregator node not found for Matterbridge');
|
|
@@ -1605,6 +2277,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
1605
2277
|
}
|
|
1606
2278
|
}
|
|
1607
2279
|
else if (this.bridgeMode === 'childbridge') {
|
|
2280
|
+
// Register and add the device to the plugin server node
|
|
1608
2281
|
if (plugin.type === 'AccessoryPlatform') {
|
|
1609
2282
|
try {
|
|
1610
2283
|
this.log.debug(`Creating endpoint ${dev}${device.deviceName}${db} for AccessoryPlatform plugin ${plg}${plugin.name}${db} server node`);
|
|
@@ -1628,10 +2301,12 @@ export class Matterbridge extends EventEmitter {
|
|
|
1628
2301
|
return;
|
|
1629
2302
|
}
|
|
1630
2303
|
}
|
|
2304
|
+
// Register and add the device to the plugin aggregator node
|
|
1631
2305
|
if (plugin.type === 'DynamicPlatform') {
|
|
1632
2306
|
try {
|
|
1633
2307
|
this.log.debug(`Adding bridged endpoint ${dev}${device.deviceName}${db} for DynamicPlatform plugin ${plg}${plugin.name}${db} aggregator node`);
|
|
1634
2308
|
await this.createDynamicPlugin(plugin);
|
|
2309
|
+
// Fast plugins can add another device before the server node is ready, so we wait for the server node to be ready
|
|
1635
2310
|
await waiter(`createDynamicPlugin(${plugin.name})`, () => plugin.serverNode?.hasParts === true);
|
|
1636
2311
|
if (!plugin.aggregatorNode) {
|
|
1637
2312
|
this.log.error(`Aggregator node not found for plugin ${plg}${plugin.name}${er}`);
|
|
@@ -1652,17 +2327,28 @@ export class Matterbridge extends EventEmitter {
|
|
|
1652
2327
|
}
|
|
1653
2328
|
if (plugin.registeredDevices !== undefined)
|
|
1654
2329
|
plugin.registeredDevices++;
|
|
2330
|
+
// Add the device to the DeviceManager
|
|
1655
2331
|
this.devices.set(device);
|
|
2332
|
+
// Subscribe to the attributes changed event
|
|
1656
2333
|
await this.subscribeAttributeChanged(plugin, device);
|
|
1657
2334
|
this.log.info(`Added and registered bridged endpoint (${plugin.registeredDevices}) ${dev}${device.deviceName}${nf} (${dev}${device.id}${nf}) for plugin ${plg}${pluginName}${nf}`);
|
|
1658
2335
|
}
|
|
2336
|
+
/**
|
|
2337
|
+
* Removes a MatterbridgeEndpoint from the specified plugin.
|
|
2338
|
+
*
|
|
2339
|
+
* @param {string} pluginName - The name of the plugin.
|
|
2340
|
+
* @param {MatterbridgeEndpoint} device - The device to remove as a bridged endpoint.
|
|
2341
|
+
* @returns {Promise<void>} A promise that resolves when the bridged endpoint has been removed.
|
|
2342
|
+
*/
|
|
1659
2343
|
async removeBridgedEndpoint(pluginName, device) {
|
|
1660
2344
|
this.log.debug(`Removing bridged endpoint ${plg}${pluginName}${db}:${dev}${device.deviceName}${db} (${zb}${device.name}${db}) for plugin ${plg}${pluginName}${db}`);
|
|
2345
|
+
// Check if the plugin is registered
|
|
1661
2346
|
const plugin = this.plugins.get(pluginName);
|
|
1662
2347
|
if (!plugin) {
|
|
1663
2348
|
this.log.error(`Error removing bridged endpoint ${dev}${device.deviceName}${er} (${zb}${device.name}${er}) for plugin ${plg}${pluginName}${er}: plugin not found`);
|
|
1664
2349
|
return;
|
|
1665
2350
|
}
|
|
2351
|
+
// Unregister and remove the device from the matterbridge aggregator node
|
|
1666
2352
|
if (this.bridgeMode === 'bridge') {
|
|
1667
2353
|
if (!this.aggregatorNode) {
|
|
1668
2354
|
this.log.error(`Error removing bridged endpoint ${dev}${device.deviceName}${er} (${zb}${device.name}${er}) for plugin ${plg}${pluginName}${er}: aggregator node not found`);
|
|
@@ -1675,8 +2361,10 @@ export class Matterbridge extends EventEmitter {
|
|
|
1675
2361
|
}
|
|
1676
2362
|
else if (this.bridgeMode === 'childbridge') {
|
|
1677
2363
|
if (plugin.type === 'AccessoryPlatform') {
|
|
2364
|
+
// Nothing to do here since the server node has no aggregator node but only the device itself
|
|
1678
2365
|
}
|
|
1679
2366
|
else if (plugin.type === 'DynamicPlatform') {
|
|
2367
|
+
// Unregister and remove the device from the plugin aggregator node
|
|
1680
2368
|
if (!plugin.aggregatorNode) {
|
|
1681
2369
|
this.log.error(`Error removing bridged endpoint ${dev}${device.deviceName}${er} (${zb}${device.name}${er}) for plugin ${plg}${pluginName}${er}: aggregator node not found`);
|
|
1682
2370
|
return;
|
|
@@ -1687,8 +2375,21 @@ export class Matterbridge extends EventEmitter {
|
|
|
1687
2375
|
if (plugin.registeredDevices !== undefined)
|
|
1688
2376
|
plugin.registeredDevices--;
|
|
1689
2377
|
}
|
|
2378
|
+
// Remove the device from the DeviceManager
|
|
1690
2379
|
this.devices.remove(device);
|
|
1691
2380
|
}
|
|
2381
|
+
/**
|
|
2382
|
+
* Removes all bridged endpoints from the specified plugin.
|
|
2383
|
+
*
|
|
2384
|
+
* @param {string} pluginName - The name of the plugin.
|
|
2385
|
+
* @param {number} [delay] - The delay in milliseconds between removing each bridged endpoint (default: 0).
|
|
2386
|
+
* @returns {Promise<void>} A promise that resolves when all bridged endpoints have been removed.
|
|
2387
|
+
*
|
|
2388
|
+
* @remarks
|
|
2389
|
+
* This method iterates through all devices in the DeviceManager and removes each bridged endpoint associated with the specified plugin.
|
|
2390
|
+
* It also applies a delay between each removal if specified.
|
|
2391
|
+
* The delay is useful to allow the controllers to receive a single subscription for each device removed.
|
|
2392
|
+
*/
|
|
1692
2393
|
async removeAllBridgedEndpoints(pluginName, delay = 0) {
|
|
1693
2394
|
this.log.debug(`Removing all bridged endpoints for plugin ${plg}${pluginName}${db}${delay > 0 ? ` with delay ${delay} ms` : ''}`);
|
|
1694
2395
|
for (const device of this.devices.array().filter((device) => device.plugin === pluginName)) {
|
|
@@ -1699,8 +2400,28 @@ export class Matterbridge extends EventEmitter {
|
|
|
1699
2400
|
if (delay > 0)
|
|
1700
2401
|
await wait(2000);
|
|
1701
2402
|
}
|
|
2403
|
+
/**
|
|
2404
|
+
* Registers a virtual device.
|
|
2405
|
+
* Virtual devices are only supported in bridge mode and childbridge mode with a DynamicPlatform.
|
|
2406
|
+
*
|
|
2407
|
+
* The virtual device is created as an instance of `Endpoint` with the provided device type.
|
|
2408
|
+
* When the virtual device is turned on, the provided callback function is executed.
|
|
2409
|
+
* The onOff state of the virtual device always reverts to false when the device is turned on.
|
|
2410
|
+
*
|
|
2411
|
+
* @param { string } pluginName - The name of the plugin to register the virtual device under.
|
|
2412
|
+
* @param { string } name - The name of the virtual device.
|
|
2413
|
+
* @param { 'light' | 'outlet' | 'switch' | 'mounted_switch' } type - The type of the virtual device.
|
|
2414
|
+
* @param { () => Promise<void> } callback - The callback to call when the virtual device is turned on.
|
|
2415
|
+
*
|
|
2416
|
+
* @returns {Promise<boolean>} A promise that resolves to true if the virtual device was successfully registered, false otherwise.
|
|
2417
|
+
*
|
|
2418
|
+
* @remarks
|
|
2419
|
+
* The virtual devices don't show up in the device list of the frontend.
|
|
2420
|
+
* Type 'switch' is not supported by Alexa and 'mounted_switch' is not supported by Apple Home.
|
|
2421
|
+
*/
|
|
1702
2422
|
async addVirtualEndpoint(pluginName, name, type, callback) {
|
|
1703
2423
|
this.log.debug(`Adding virtual endpoint ${plg}${pluginName}${db}:${dev}${name}${db}...`);
|
|
2424
|
+
// Check if the plugin is registered
|
|
1704
2425
|
const plugin = this.plugins.get(pluginName);
|
|
1705
2426
|
if (!plugin) {
|
|
1706
2427
|
this.log.error(`Error adding virtual endpoint ${dev}${name}${er} for plugin ${plg}${pluginName}${er}: plugin not found`);
|
|
@@ -1727,13 +2448,24 @@ export class Matterbridge extends EventEmitter {
|
|
|
1727
2448
|
this.log.error(`Virtual endpoint ${dev}${name}${er} for plugin ${plg}${pluginName}${er} not created. Virtual endpoints are only supported in bridge mode and childbridge mode with a DynamicPlatform.`);
|
|
1728
2449
|
return false;
|
|
1729
2450
|
}
|
|
2451
|
+
/**
|
|
2452
|
+
* Subscribes to the attribute change event for the given device and plugin.
|
|
2453
|
+
* Specifically, it listens for changes in the 'reachable' attribute of the
|
|
2454
|
+
* BridgedDeviceBasicInformationServer cluster server of the bridged device or BasicInformationServer cluster server of server node.
|
|
2455
|
+
*
|
|
2456
|
+
* @param {Plugin} plugin - The plugin associated with the device.
|
|
2457
|
+
* @param {MatterbridgeEndpoint} device - The device to subscribe to attribute changes for.
|
|
2458
|
+
* @returns {Promise<void>} A promise that resolves when the subscription is set up.
|
|
2459
|
+
*/
|
|
1730
2460
|
async subscribeAttributeChanged(plugin, device) {
|
|
1731
2461
|
if (!plugin || !device || !device.plugin || !device.serialNumber || !device.uniqueId || !device.maybeNumber)
|
|
1732
2462
|
return;
|
|
1733
2463
|
this.log.info(`Subscribing attributes for endpoint ${dev}${device.deviceName}${nf} (${dev}${device.id}${nf}) plugin ${plg}${plugin.name}${nf}`);
|
|
2464
|
+
// Subscribe to the reachable$Changed event of the BasicInformationServer cluster server of the server node in childbridge mode
|
|
1734
2465
|
if (this.bridgeMode === 'childbridge' && plugin.type === 'AccessoryPlatform' && plugin.serverNode) {
|
|
1735
2466
|
plugin.serverNode.eventsOf(BasicInformationServer).reachable$Changed?.on((reachable) => {
|
|
1736
2467
|
this.log.info(`Accessory endpoint ${dev}${device.deviceName}${nf} (${dev}${device.id}${nf}) is ${reachable ? 'reachable' : 'unreachable'}`);
|
|
2468
|
+
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
1737
2469
|
this.frontend.wssSendAttributeChangedMessage(device.plugin, device.serialNumber, device.uniqueId, device.number, device.id, 'BasicInformation', 'reachable', reachable);
|
|
1738
2470
|
});
|
|
1739
2471
|
}
|
|
@@ -1783,6 +2515,7 @@ export class Matterbridge extends EventEmitter {
|
|
|
1783
2515
|
this.log.debug(`Subscribing to endpoint ${or}${device.id}${db}:${or}${device.number}${db} attribute ${dev}${sub.cluster}${db}.${dev}${sub.attribute}${db} changes...`);
|
|
1784
2516
|
await device.subscribeAttribute(sub.cluster, sub.attribute, (value) => {
|
|
1785
2517
|
this.log.debug(`Bridged endpoint ${or}${device.id}${db}:${or}${device.number}${db} attribute ${dev}${sub.cluster}${db}.${dev}${sub.attribute}${db} changed to ${CYAN}${isValidObject(value) ? debugStringify(value) : value}${db}`);
|
|
2518
|
+
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
1786
2519
|
this.frontend.wssSendAttributeChangedMessage(device.plugin, device.serialNumber, device.uniqueId, device.number, device.id, sub.cluster, sub.attribute, value);
|
|
1787
2520
|
});
|
|
1788
2521
|
}
|
|
@@ -1791,12 +2524,19 @@ export class Matterbridge extends EventEmitter {
|
|
|
1791
2524
|
this.log.debug(`Subscribing to child endpoint ${or}${child.id}${db}:${or}${child.number}${db} attribute ${dev}${sub.cluster}${db}.${dev}${sub.attribute}${db} changes...`);
|
|
1792
2525
|
await child.subscribeAttribute(sub.cluster, sub.attribute, (value) => {
|
|
1793
2526
|
this.log.debug(`Bridged child endpoint ${or}${child.id}${db}:${or}${child.number}${db} attribute ${dev}${sub.cluster}${db}.${dev}${sub.attribute}${db} changed to ${CYAN}${isValidObject(value) ? debugStringify(value) : value}${db}`);
|
|
2527
|
+
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
1794
2528
|
this.frontend.wssSendAttributeChangedMessage(device.plugin, device.serialNumber, device.uniqueId, child.number, child.id, sub.cluster, sub.attribute, value);
|
|
1795
2529
|
});
|
|
1796
2530
|
}
|
|
1797
2531
|
}
|
|
1798
2532
|
}
|
|
1799
2533
|
}
|
|
2534
|
+
/**
|
|
2535
|
+
* Sanitizes the fabric information by converting bigint properties to strings because `res.json` doesn't support bigint.
|
|
2536
|
+
*
|
|
2537
|
+
* @param {ExposedFabricInformation[]} fabricInfo - The array of exposed fabric information objects.
|
|
2538
|
+
* @returns {SanitizedExposedFabricInformation[]} An array of sanitized exposed fabric information objects.
|
|
2539
|
+
*/
|
|
1800
2540
|
sanitizeFabricInformations(fabricInfo) {
|
|
1801
2541
|
return fabricInfo.map((info) => {
|
|
1802
2542
|
return {
|
|
@@ -1810,6 +2550,12 @@ export class Matterbridge extends EventEmitter {
|
|
|
1810
2550
|
};
|
|
1811
2551
|
});
|
|
1812
2552
|
}
|
|
2553
|
+
/**
|
|
2554
|
+
* Sanitizes the session information by converting bigint properties to strings because `res.json` doesn't support bigint.
|
|
2555
|
+
*
|
|
2556
|
+
* @param {SessionsBehavior.Session[]} sessions - The array of session information objects.
|
|
2557
|
+
* @returns {SanitizedSession[]} An array of sanitized session information objects.
|
|
2558
|
+
*/
|
|
1813
2559
|
sanitizeSessionInformation(sessions) {
|
|
1814
2560
|
return sessions
|
|
1815
2561
|
.filter((session) => session.isPeerActive)
|
|
@@ -1836,7 +2582,21 @@ export class Matterbridge extends EventEmitter {
|
|
|
1836
2582
|
};
|
|
1837
2583
|
});
|
|
1838
2584
|
}
|
|
2585
|
+
/**
|
|
2586
|
+
* Sets the reachability of the specified aggregator node bridged devices and trigger.
|
|
2587
|
+
*
|
|
2588
|
+
* @param {Endpoint<AggregatorEndpoint>} aggregatorNode - The aggregator node to set the reachability for.
|
|
2589
|
+
* @param {boolean} reachable - A boolean indicating the reachability status to set.
|
|
2590
|
+
*/
|
|
2591
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
1839
2592
|
async setAggregatorReachability(aggregatorNode, reachable) {
|
|
2593
|
+
/*
|
|
2594
|
+
for (const child of aggregatorNode.parts) {
|
|
2595
|
+
this.log.debug(`Setting reachability of ${(child as unknown as MatterbridgeEndpoint)?.deviceName} to ${reachable}`);
|
|
2596
|
+
await child.setStateOf(BridgedDeviceBasicInformationServer, { reachable });
|
|
2597
|
+
child.act((agent) => child.eventsOf(BridgedDeviceBasicInformationServer).reachableChanged.emit({ reachableNewValue: true }, agent.context));
|
|
2598
|
+
}
|
|
2599
|
+
*/
|
|
1840
2600
|
}
|
|
1841
2601
|
getVendorIdName = (vendorId) => {
|
|
1842
2602
|
if (!vendorId)
|
|
@@ -1876,10 +2636,11 @@ export class Matterbridge extends EventEmitter {
|
|
|
1876
2636
|
case 0x1488:
|
|
1877
2637
|
vendorName = '(ShortcutLabsFlic)';
|
|
1878
2638
|
break;
|
|
1879
|
-
case 65521:
|
|
2639
|
+
case 65521: // 0xFFF1
|
|
1880
2640
|
vendorName = '(MatterTest)';
|
|
1881
2641
|
break;
|
|
1882
2642
|
}
|
|
1883
2643
|
return vendorName;
|
|
1884
2644
|
};
|
|
1885
2645
|
}
|
|
2646
|
+
//# sourceMappingURL=matterbridge.js.map
|