@matterbridge/core 3.11.2-dev-20261102-10dec49 → 3.11.2-dev-20261104-98c7a1f
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/dist/backendWsServer.js +12 -0
- package/dist/behaviors/pumpConfigurationAndControlServer.js +11 -0
- package/dist/chipTests.js +16 -0
- package/dist/demoDevices.js +35 -18
- package/dist/devices/dimmablePlugInUnit.d.ts +5 -0
- package/dist/devices/dimmablePlugInUnit.js +7 -0
- package/dist/devices/export.d.ts +7 -0
- package/dist/devices/export.js +7 -0
- package/dist/devices/loadControlBase.d.ts +23 -0
- package/dist/devices/loadControlBase.js +36 -0
- package/dist/devices/mountedDimmableLoadControl.d.ts +7 -0
- package/dist/devices/mountedDimmableLoadControl.js +7 -0
- package/dist/devices/mountedOnOffControl.d.ts +8 -0
- package/dist/devices/mountedOnOffControl.js +7 -0
- package/dist/devices/onOffPlugInUnit.d.ts +7 -0
- package/dist/devices/onOffPlugInUnit.js +7 -0
- package/dist/devices/pump.d.ts +36 -0
- package/dist/devices/pump.js +74 -0
- package/dist/devices/waterValve.d.ts +26 -0
- package/dist/devices/waterValve.js +56 -0
- package/dist/frontend.js +12 -0
- package/dist/matterbridgeEndpoint.d.ts +5 -3
- package/dist/matterbridgeEndpoint.js +19 -6
- package/dist/matterbridgeEndpointHelpers.d.ts +14 -14
- package/dist/matterbridgeEndpointHelpers.js +10 -6
- package/dist/matterbridgePlatform.d.ts +5 -23
- package/dist/matterbridgePlatform.js +96 -4
- package/package.json +5 -5
package/dist/backendWsServer.js
CHANGED
|
@@ -255,6 +255,18 @@ export class BackendWsServer {
|
|
|
255
255
|
sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true, response: matter });
|
|
256
256
|
this.wssSendRefreshRequired('matter', { matter });
|
|
257
257
|
}
|
|
258
|
+
else if (data.method === '/api/unregister-device') {
|
|
259
|
+
this.wssSendSnackbarMessage('Resetting the device...');
|
|
260
|
+
const { pluginName, serialNumber, uniqueId } = data.params;
|
|
261
|
+
this.server.request({ type: 'platform_unregister_device', src: 'frontend', dst: 'platform', params: { pluginName, serialNumber, uniqueId } });
|
|
262
|
+
sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
|
|
263
|
+
}
|
|
264
|
+
else if (data.method === '/api/rename-device') {
|
|
265
|
+
this.wssSendSnackbarMessage('Renaming the device...');
|
|
266
|
+
const { pluginName, serialNumber, uniqueId, label } = data.params;
|
|
267
|
+
this.server.request({ type: 'platform_rename_device', src: 'frontend', dst: 'platform', params: { pluginName, serialNumber, uniqueId, label } });
|
|
268
|
+
sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
|
|
269
|
+
}
|
|
258
270
|
}
|
|
259
271
|
catch (error) {
|
|
260
272
|
inspectError(this.log, `Error parsing message from websocket client`, error);
|
|
@@ -24,6 +24,8 @@ export class MatterbridgePumpConfigurationAndControlServer extends PumpConfigura
|
|
|
24
24
|
}
|
|
25
25
|
this.reactTo(this.events.operationMode$Changing, this.#handleOperationModeChanging);
|
|
26
26
|
this.reactTo(this.events.operationMode$Changed, this.#handleOperationModeChanged);
|
|
27
|
+
if (this.endpoint.behaviors.has(OnOffServer.id) && this.agent.get(OnOffServer).state.onOff)
|
|
28
|
+
this.#applySetpoint(this.internal.lastLevel ?? 254);
|
|
27
29
|
}
|
|
28
30
|
#percentFromLevel(currentLevel) {
|
|
29
31
|
if (currentLevel <= 0)
|
|
@@ -55,13 +57,22 @@ export class MatterbridgePumpConfigurationAndControlServer extends PumpConfigura
|
|
|
55
57
|
this.agent.asLocalActor(() => {
|
|
56
58
|
this.state.speed = speed;
|
|
57
59
|
this.state.capacity = capacity;
|
|
60
|
+
this.#setRunning(speed > 0);
|
|
58
61
|
});
|
|
59
62
|
return { speed, capacity };
|
|
60
63
|
}
|
|
64
|
+
#setRunning(running) {
|
|
65
|
+
if (this.state.pumpStatus === undefined || this.state.pumpStatus.running === running)
|
|
66
|
+
return;
|
|
67
|
+
const pumpStatus = new PumpConfigurationAndControl.PumpStatus(this.state.pumpStatus);
|
|
68
|
+
pumpStatus.running = running;
|
|
69
|
+
this.state.pumpStatus = pumpStatus;
|
|
70
|
+
}
|
|
61
71
|
#stopPump() {
|
|
62
72
|
this.agent.asLocalActor(() => {
|
|
63
73
|
this.state.speed = 0;
|
|
64
74
|
this.state.capacity = 0;
|
|
75
|
+
this.#setRunning(false);
|
|
65
76
|
});
|
|
66
77
|
return { speed: 0, capacity: 0 };
|
|
67
78
|
}
|
package/dist/chipTests.js
CHANGED
|
@@ -823,6 +823,22 @@ async function handleElectricalEnergyTestEventTrigger(eventTrigger) {
|
|
|
823
823
|
const current = endpoint.getAttribute(ElectricalEnergyMeasurement.id, 'cumulativeEnergyExported');
|
|
824
824
|
await endpoint.setCluster(ElectricalEnergyMeasurement, { cumulativeEnergyExported: { energy: (current?.energy ?? 0) + electricalEnergyMeasurementExportedEnergyPerTick } }, log);
|
|
825
825
|
}
|
|
826
|
+
const endTimestamp = Math.floor(Date.now() / 1000);
|
|
827
|
+
const periodic = (energyPerTick) => ({
|
|
828
|
+
energy: energyPerTick + Math.floor(Math.random() * 51),
|
|
829
|
+
startTimestamp: endTimestamp - 1,
|
|
830
|
+
endTimestamp,
|
|
831
|
+
});
|
|
832
|
+
if (isFakeLoad && endpoint.hasAttributeServer(ElectricalEnergyMeasurement.id, 'periodicEnergyImported')) {
|
|
833
|
+
const energyImported = periodic(electricalEnergyMeasurementImportedEnergyPerTick);
|
|
834
|
+
await endpoint.setCluster(ElectricalEnergyMeasurement, { periodicEnergyImported: energyImported }, log);
|
|
835
|
+
await endpoint.triggerEvent(ElectricalEnergyMeasurement, 'periodicEnergyMeasured', { energyImported }, log);
|
|
836
|
+
}
|
|
837
|
+
if (!isFakeLoad && endpoint.hasAttributeServer(ElectricalEnergyMeasurement.id, 'periodicEnergyExported')) {
|
|
838
|
+
const energyExported = periodic(electricalEnergyMeasurementExportedEnergyPerTick);
|
|
839
|
+
await endpoint.setCluster(ElectricalEnergyMeasurement, { periodicEnergyExported: energyExported }, log);
|
|
840
|
+
await endpoint.triggerEvent(ElectricalEnergyMeasurement, 'periodicEnergyMeasured', { energyExported }, log);
|
|
841
|
+
}
|
|
826
842
|
};
|
|
827
843
|
await applyFakeLoadTick();
|
|
828
844
|
electricalPowerMeasurementFakeLoadTimer = Time.getPeriodicTimer('Electrical fake load', Seconds(1), () => {
|
package/dist/demoDevices.js
CHANGED
|
@@ -26,6 +26,7 @@ import { Chime } from './devices/chime.js';
|
|
|
26
26
|
import { Closure } from './devices/closure.js';
|
|
27
27
|
import { ContentApp } from './devices/contentApp.js';
|
|
28
28
|
import { Cooktop } from './devices/cooktop.js';
|
|
29
|
+
import { DimmablePlugInUnit } from './devices/dimmablePlugInUnit.js';
|
|
29
30
|
import { Dishwasher } from './devices/dishwasher.js';
|
|
30
31
|
import { Doorbell } from './devices/doorbell.js';
|
|
31
32
|
import { ElectricalUtilityMeter } from './devices/electricalUtilityMeter.js';
|
|
@@ -38,7 +39,11 @@ import { IrrigationSystem } from './devices/irrigationSystem.js';
|
|
|
38
39
|
import { LaundryDryer } from './devices/laundryDryer.js';
|
|
39
40
|
import { LaundryWasher } from './devices/laundryWasher.js';
|
|
40
41
|
import { MicrowaveOven } from './devices/microwaveOven.js';
|
|
42
|
+
import { MountedDimmableLoadControl } from './devices/mountedDimmableLoadControl.js';
|
|
43
|
+
import { MountedOnOffControl } from './devices/mountedOnOffControl.js';
|
|
44
|
+
import { OnOffPlugInUnit } from './devices/onOffPlugInUnit.js';
|
|
41
45
|
import { Oven } from './devices/oven.js';
|
|
46
|
+
import { Pump } from './devices/pump.js';
|
|
42
47
|
import { Refrigerator } from './devices/refrigerator.js';
|
|
43
48
|
import { RoboticVacuumCleaner } from './devices/roboticVacuumCleaner.js';
|
|
44
49
|
import { SnapshotCamera } from './devices/snapshotCamera.js';
|
|
@@ -47,6 +52,7 @@ import { Speaker } from './devices/speaker.js';
|
|
|
47
52
|
import { VideoDoorbell } from './devices/videoDoorbell.js';
|
|
48
53
|
import { VideoRemoteControl } from './devices/videoRemoteControl.js';
|
|
49
54
|
import { WaterHeater } from './devices/waterHeater.js';
|
|
55
|
+
import { WaterValve } from './devices/waterValve.js';
|
|
50
56
|
import { getSupportedDeviceType } from './matterbridgeDeviceTypes.js';
|
|
51
57
|
import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
|
|
52
58
|
import { getSemtag } from './matterbridgeEndpointHelpers.js';
|
|
@@ -205,6 +211,29 @@ export async function createDemoDevices(matterbridge) {
|
|
|
205
211
|
ep.createDefaultElectricalPowerMeasurementClusterServer(220_000, 1_000, 220_000_000, 50_000);
|
|
206
212
|
ep.createDefaultElectricalEnergyMeasurementClusterServer(100_000_000, 10_000_000);
|
|
207
213
|
await registerDevice(ep, 'Electrical Sensor Dynamic', 'UTILITY-02-06-3');
|
|
214
|
+
ep = new MatterbridgeEndpoint([getSupportedDeviceType('ElectricalSensor'), bridgedNode, powerSource], { id: 'ElectricalSensorPeriodic', number: EndpointNumber(2_06_4) });
|
|
215
|
+
ep.createDefaultPowerTopologyClusterServer(PowerTopology.Feature.NodeTopology);
|
|
216
|
+
ep.createDefaultElectricalPowerMeasurementClusterServer(220_000, 1_000, 220_000_000, 50_000);
|
|
217
|
+
const endTimestamp = Math.floor(Date.now() / 1000);
|
|
218
|
+
const startTimestamp = endTimestamp - 15 * 60;
|
|
219
|
+
ep.createDefaultElectricalEnergyMeasurementClusterServer(100_000_000, 10_000_000, { energy: 55_000, startTimestamp, endTimestamp }, { energy: 5_500, startTimestamp, endTimestamp });
|
|
220
|
+
await registerDevice(ep, 'Electrical Sensor Periodic', 'UTILITY-02-06-4');
|
|
221
|
+
ep = new MatterbridgeEndpoint([getSupportedDeviceType('ElectricalSensor'), bridgedNode, powerSource], {
|
|
222
|
+
id: 'ElectricalSensorPeriodicImported',
|
|
223
|
+
number: EndpointNumber(2_06_5),
|
|
224
|
+
});
|
|
225
|
+
ep.createDefaultPowerTopologyClusterServer(PowerTopology.Feature.NodeTopology);
|
|
226
|
+
ep.createDefaultElectricalPowerMeasurementClusterServer(220_000, 1_000, 220_000_000, 50_000);
|
|
227
|
+
ep.createImportedElectricalEnergyMeasurementClusterServer(200_000_000, { energy: 55_000, startTimestamp, endTimestamp });
|
|
228
|
+
await registerDevice(ep, 'Electrical Sensor Periodic Imported', 'UTILITY-02-06-5');
|
|
229
|
+
ep = new MatterbridgeEndpoint([getSupportedDeviceType('ElectricalSensor'), bridgedNode, powerSource], {
|
|
230
|
+
id: 'ElectricalSensorPeriodicExported',
|
|
231
|
+
number: EndpointNumber(2_06_6),
|
|
232
|
+
});
|
|
233
|
+
ep.createDefaultPowerTopologyClusterServer(PowerTopology.Feature.NodeTopology);
|
|
234
|
+
ep.createDefaultElectricalPowerMeasurementClusterServer(220_000, 1_000, 220_000_000, 50_000);
|
|
235
|
+
ep.createExportedElectricalEnergyMeasurementClusterServer(50_000_000, { energy: 5_500, startTimestamp, endTimestamp });
|
|
236
|
+
await registerDevice(ep, 'Electrical Sensor Periodic Exported', 'UTILITY-02-06-6');
|
|
208
237
|
ep = new MatterbridgeEndpoint([getSupportedDeviceType('DeviceEnergyManagement'), bridgedNode, powerSource], { id: 'DeviceEnergyManagement', number: EndpointNumber(2_07) });
|
|
209
238
|
ep.createDefaultDeviceEnergyManagementClusterServer();
|
|
210
239
|
ep.createDefaultDeviceEnergyManagementModeClusterServer();
|
|
@@ -234,29 +263,17 @@ export async function createDemoDevices(matterbridge) {
|
|
|
234
263
|
ep.createDefaultPowerSourceWiredClusterServer();
|
|
235
264
|
ep.createEnhancedColorControlClusterServer();
|
|
236
265
|
await registerDevice(ep, 'Extended Color Light EHS XY CT', 'LIGHTING-04-04-02');
|
|
237
|
-
ep = new
|
|
238
|
-
ep.createDefaultPowerSourceWiredClusterServer();
|
|
266
|
+
ep = new OnOffPlugInUnit('On/Off Plug-in Unit', 'ACTUATOR-05-01', { id: 'OnOffPlugInUnit', number: EndpointNumber(5_01) });
|
|
239
267
|
await registerDevice(ep, 'On/Off Plug-in Unit', 'ACTUATOR-05-01');
|
|
240
|
-
ep = new
|
|
241
|
-
ep.createDefaultPowerSourceWiredClusterServer();
|
|
268
|
+
ep = new DimmablePlugInUnit('Dimmable Plug-in Unit', 'ACTUATOR-05-02', { id: 'DimmablePlugInUnit', number: EndpointNumber(5_02) });
|
|
242
269
|
await registerDevice(ep, 'Dimmable Plug-in Unit', 'ACTUATOR-05-02');
|
|
243
|
-
ep = new
|
|
244
|
-
ep.createDefaultPowerSourceWiredClusterServer();
|
|
270
|
+
ep = new MountedOnOffControl('Mounted On/Off Control', 'ACTUATOR-05-03', { id: 'MountedOnOffControl', number: EndpointNumber(5_03) });
|
|
245
271
|
await registerDevice(ep, 'Mounted On/Off Control', 'ACTUATOR-05-03');
|
|
246
|
-
ep = new
|
|
247
|
-
id: 'MountedDimmableLoadControl',
|
|
248
|
-
number: EndpointNumber(5_04),
|
|
249
|
-
});
|
|
250
|
-
ep.createDefaultPowerSourceWiredClusterServer();
|
|
272
|
+
ep = new MountedDimmableLoadControl('Mounted Dimmable Load Control', 'ACTUATOR-05-04', { id: 'MountedDimmableLoadControl', number: EndpointNumber(5_04) });
|
|
251
273
|
await registerDevice(ep, 'Mounted Dimmable Load Control', 'ACTUATOR-05-04');
|
|
252
|
-
ep = new
|
|
253
|
-
ep.createDefaultPowerSourceWiredClusterServer();
|
|
254
|
-
ep.createOnOffClusterServer(false);
|
|
255
|
-
ep.createLevelControlClusterServer(0);
|
|
274
|
+
ep = new Pump('Pump', 'ACTUATOR-05-05', { id: 'Pump', number: EndpointNumber(5_05) });
|
|
256
275
|
await registerDevice(ep, 'Pump', 'ACTUATOR-05-05');
|
|
257
|
-
ep = new
|
|
258
|
-
ep.createDefaultPowerSourceWiredClusterServer();
|
|
259
|
-
ep.createDefaultValveConfigurationAndControlClusterServer(undefined, undefined, 5000, true);
|
|
276
|
+
ep = new WaterValve('Water Valve', 'ACTUATOR-05-06', { id: 'WaterValve', number: EndpointNumber(5_06), movementDuration: 5000, autoClose: true });
|
|
260
277
|
await registerDevice(ep, 'Water Valve', 'ACTUATOR-05-06');
|
|
261
278
|
ep = new IrrigationSystem('Irrigation System with 2 zones', 'ACTUATOR-05-07', { id: 'IrrigationSystem', number: EndpointNumber(5_07), autoOpenClose: true });
|
|
262
279
|
ep.addZone(getSemtag(CommonNumberTag.One), 'IrrigationSystemZone1', EndpointNumber(5_07_1), 5000, true);
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { LoadControlBase, type LoadControlOptions } from './loadControlBase.js';
|
|
2
|
+
export type DimmablePlugInUnitOptions = LoadControlOptions;
|
|
3
|
+
export declare class DimmablePlugInUnit extends LoadControlBase {
|
|
4
|
+
constructor(name: string, serial: string, options?: DimmablePlugInUnitOptions);
|
|
5
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { dimmablePlugInUnit, powerSource } from '../matterbridgeDeviceTypes.js';
|
|
2
|
+
import { LoadControlBase } from './loadControlBase.js';
|
|
3
|
+
export class DimmablePlugInUnit extends LoadControlBase {
|
|
4
|
+
constructor(name, serial, options = {}) {
|
|
5
|
+
super([dimmablePlugInUnit, powerSource], name, serial, 'Matterbridge Dimmable Plug-in Unit', true, options);
|
|
6
|
+
}
|
|
7
|
+
}
|
package/dist/devices/export.d.ts
CHANGED
|
@@ -9,6 +9,13 @@ export * from './closure.js';
|
|
|
9
9
|
export * from './closurePanel.js';
|
|
10
10
|
export * from './irrigationSystem.js';
|
|
11
11
|
export * from './soilSensor.js';
|
|
12
|
+
export * from './dimmablePlugInUnit.js';
|
|
13
|
+
export * from './loadControlBase.js';
|
|
14
|
+
export * from './mountedDimmableLoadControl.js';
|
|
15
|
+
export * from './mountedOnOffControl.js';
|
|
16
|
+
export * from './onOffPlugInUnit.js';
|
|
17
|
+
export * from './pump.js';
|
|
18
|
+
export * from './waterValve.js';
|
|
12
19
|
export * from './roboticVacuumCleaner.js';
|
|
13
20
|
export * from './airConditioner.js';
|
|
14
21
|
export * from './cooktop.js';
|
package/dist/devices/export.js
CHANGED
|
@@ -9,6 +9,13 @@ export * from './closure.js';
|
|
|
9
9
|
export * from './closurePanel.js';
|
|
10
10
|
export * from './irrigationSystem.js';
|
|
11
11
|
export * from './soilSensor.js';
|
|
12
|
+
export * from './dimmablePlugInUnit.js';
|
|
13
|
+
export * from './loadControlBase.js';
|
|
14
|
+
export * from './mountedDimmableLoadControl.js';
|
|
15
|
+
export * from './mountedOnOffControl.js';
|
|
16
|
+
export * from './onOffPlugInUnit.js';
|
|
17
|
+
export * from './pump.js';
|
|
18
|
+
export * from './waterValve.js';
|
|
12
19
|
export * from './roboticVacuumCleaner.js';
|
|
13
20
|
export * from './airConditioner.js';
|
|
14
21
|
export * from './cooktop.js';
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { AtLeastOne } from '@matter/general';
|
|
2
|
+
import { OnOff } from '@matter/types/clusters/on-off';
|
|
3
|
+
import type { EndpointNumber } from '@matter/types/datatype';
|
|
4
|
+
import type { Semtag } from '@matter/types/globals';
|
|
5
|
+
import type { DeviceTypeDefinition } from '../matterbridgeDeviceTypes.js';
|
|
6
|
+
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
|
|
7
|
+
export interface LoadControlOptions {
|
|
8
|
+
onOff?: boolean;
|
|
9
|
+
startUpOnOff?: OnOff.StartUpOnOff | null;
|
|
10
|
+
currentLevel?: number;
|
|
11
|
+
onLevel?: number | null;
|
|
12
|
+
startUpCurrentLevel?: number | null;
|
|
13
|
+
tagList?: Semtag[];
|
|
14
|
+
id?: string;
|
|
15
|
+
number?: EndpointNumber;
|
|
16
|
+
}
|
|
17
|
+
export declare abstract class LoadControlBase extends MatterbridgeEndpoint {
|
|
18
|
+
protected constructor(definitions: AtLeastOne<DeviceTypeDefinition>, name: string, serial: string, productName: string, levelControl: boolean, options: LoadControlOptions);
|
|
19
|
+
setOnOff(onOff: boolean): Promise<void>;
|
|
20
|
+
getOnOff(): boolean | undefined;
|
|
21
|
+
setLevel(level: number): Promise<void>;
|
|
22
|
+
getLevel(): number | null | undefined;
|
|
23
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { LevelControl } from '@matter/types/clusters/level-control';
|
|
2
|
+
import { OnOff } from '@matter/types/clusters/on-off';
|
|
3
|
+
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
|
|
4
|
+
function coerceLevel(level) {
|
|
5
|
+
return Math.min(254, Math.max(1, Math.round(level)));
|
|
6
|
+
}
|
|
7
|
+
export class LoadControlBase extends MatterbridgeEndpoint {
|
|
8
|
+
constructor(definitions, name, serial, productName, levelControl, options) {
|
|
9
|
+
super(definitions, { id: options.id ?? `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}`, number: options.number, tagList: options.tagList });
|
|
10
|
+
this.createDefaultIdentifyClusterServer();
|
|
11
|
+
this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, productName);
|
|
12
|
+
this.createDefaultPowerSourceWiredClusterServer();
|
|
13
|
+
this.createDefaultGroupsClusterServer();
|
|
14
|
+
this.createDefaultScenesManagementClusterServer();
|
|
15
|
+
this.createDefaultOnOffClusterServer(options.onOff ?? false, false, 0, 0, options.startUpOnOff ?? null);
|
|
16
|
+
if (levelControl) {
|
|
17
|
+
this.createDefaultLevelControlClusterServer(coerceLevel(options.currentLevel ?? 254), 1, 254, options.onLevel ?? null, options.startUpCurrentLevel ?? null);
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
async setOnOff(onOff) {
|
|
21
|
+
await this.setAttribute(OnOff, 'onOff', onOff);
|
|
22
|
+
}
|
|
23
|
+
getOnOff() {
|
|
24
|
+
return this.getAttribute(OnOff, 'onOff');
|
|
25
|
+
}
|
|
26
|
+
async setLevel(level) {
|
|
27
|
+
if (!this.hasClusterServer(LevelControl) || !Number.isFinite(level))
|
|
28
|
+
return;
|
|
29
|
+
await this.setAttribute(LevelControl, 'currentLevel', coerceLevel(level));
|
|
30
|
+
}
|
|
31
|
+
getLevel() {
|
|
32
|
+
if (!this.hasClusterServer(LevelControl))
|
|
33
|
+
return undefined;
|
|
34
|
+
return this.getAttribute(LevelControl, 'currentLevel');
|
|
35
|
+
}
|
|
36
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { LoadControlBase, type LoadControlOptions } from './loadControlBase.js';
|
|
2
|
+
export interface MountedDimmableLoadControlOptions extends LoadControlOptions {
|
|
3
|
+
plugInUnitDeviceType?: boolean;
|
|
4
|
+
}
|
|
5
|
+
export declare class MountedDimmableLoadControl extends LoadControlBase {
|
|
6
|
+
constructor(name: string, serial: string, options?: MountedDimmableLoadControlOptions);
|
|
7
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { dimmablePlugInUnit, mountedDimmableLoadControl, powerSource } from '../matterbridgeDeviceTypes.js';
|
|
2
|
+
import { LoadControlBase } from './loadControlBase.js';
|
|
3
|
+
export class MountedDimmableLoadControl extends LoadControlBase {
|
|
4
|
+
constructor(name, serial, options = {}) {
|
|
5
|
+
super(options.plugInUnitDeviceType === false ? [mountedDimmableLoadControl, powerSource] : [mountedDimmableLoadControl, dimmablePlugInUnit, powerSource], name, serial, 'Matterbridge Mounted Dimmable Load Control', true, options);
|
|
6
|
+
}
|
|
7
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { LoadControlBase, type LoadControlOptions } from './loadControlBase.js';
|
|
2
|
+
export interface MountedOnOffControlOptions extends LoadControlOptions {
|
|
3
|
+
levelControl?: boolean;
|
|
4
|
+
plugInUnitDeviceType?: boolean;
|
|
5
|
+
}
|
|
6
|
+
export declare class MountedOnOffControl extends LoadControlBase {
|
|
7
|
+
constructor(name: string, serial: string, options?: MountedOnOffControlOptions);
|
|
8
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { mountedOnOffControl, onOffPlugInUnit, powerSource } from '../matterbridgeDeviceTypes.js';
|
|
2
|
+
import { LoadControlBase } from './loadControlBase.js';
|
|
3
|
+
export class MountedOnOffControl extends LoadControlBase {
|
|
4
|
+
constructor(name, serial, options = {}) {
|
|
5
|
+
super(options.plugInUnitDeviceType === false ? [mountedOnOffControl, powerSource] : [mountedOnOffControl, onOffPlugInUnit, powerSource], name, serial, 'Matterbridge Mounted On/Off Control', options.levelControl === true, options);
|
|
6
|
+
}
|
|
7
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { LoadControlBase, type LoadControlOptions } from './loadControlBase.js';
|
|
2
|
+
export interface OnOffPlugInUnitOptions extends LoadControlOptions {
|
|
3
|
+
levelControl?: boolean;
|
|
4
|
+
}
|
|
5
|
+
export declare class OnOffPlugInUnit extends LoadControlBase {
|
|
6
|
+
constructor(name: string, serial: string, options?: OnOffPlugInUnitOptions);
|
|
7
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { onOffPlugInUnit, powerSource } from '../matterbridgeDeviceTypes.js';
|
|
2
|
+
import { LoadControlBase } from './loadControlBase.js';
|
|
3
|
+
export class OnOffPlugInUnit extends LoadControlBase {
|
|
4
|
+
constructor(name, serial, options = {}) {
|
|
5
|
+
super([onOffPlugInUnit, powerSource], name, serial, 'Matterbridge On/Off Plug-in Unit', options.levelControl === true, options);
|
|
6
|
+
}
|
|
7
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { PumpConfigurationAndControl } from '@matter/types/clusters/pump-configuration-and-control';
|
|
2
|
+
import type { EndpointNumber } from '@matter/types/datatype';
|
|
3
|
+
import type { Semtag } from '@matter/types/globals';
|
|
4
|
+
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
|
|
5
|
+
export interface PumpOptions {
|
|
6
|
+
onOff?: boolean;
|
|
7
|
+
levelControl?: boolean;
|
|
8
|
+
currentLevel?: number;
|
|
9
|
+
operationMode?: PumpConfigurationAndControl.OperationMode;
|
|
10
|
+
maxPressure?: number | null;
|
|
11
|
+
maxSpeed?: number | null;
|
|
12
|
+
maxFlow?: number | null;
|
|
13
|
+
minConstSpeed?: number | null;
|
|
14
|
+
maxConstSpeed?: number | null;
|
|
15
|
+
temperatureMeasuredValue?: number | null;
|
|
16
|
+
pressureMeasuredValue?: number | null;
|
|
17
|
+
flowMeasuredValue?: number | null;
|
|
18
|
+
batteryPowered?: boolean;
|
|
19
|
+
tagList?: Semtag[];
|
|
20
|
+
id?: string;
|
|
21
|
+
number?: EndpointNumber;
|
|
22
|
+
}
|
|
23
|
+
export declare class Pump extends MatterbridgeEndpoint {
|
|
24
|
+
constructor(name: string, serial: string, options?: PumpOptions);
|
|
25
|
+
setOnOff(onOff: boolean): Promise<void>;
|
|
26
|
+
getOnOff(): boolean | undefined;
|
|
27
|
+
setLevel(level: number): Promise<void>;
|
|
28
|
+
getLevel(): number | null | undefined;
|
|
29
|
+
setOperationMode(operationMode: PumpConfigurationAndControl.OperationMode): Promise<void>;
|
|
30
|
+
getOperationMode(): PumpConfigurationAndControl.OperationMode | undefined;
|
|
31
|
+
getSpeed(): number | null | undefined;
|
|
32
|
+
getCapacity(): number | null | undefined;
|
|
33
|
+
setTemperatureMeasuredValue(value: number | null): Promise<void>;
|
|
34
|
+
setPressureMeasuredValue(value: number | null): Promise<void>;
|
|
35
|
+
setFlowMeasuredValue(value: number | null): Promise<void>;
|
|
36
|
+
}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
import { FlowMeasurement } from '@matter/types/clusters/flow-measurement';
|
|
2
|
+
import { LevelControl } from '@matter/types/clusters/level-control';
|
|
3
|
+
import { OnOff } from '@matter/types/clusters/on-off';
|
|
4
|
+
import { PressureMeasurement } from '@matter/types/clusters/pressure-measurement';
|
|
5
|
+
import { PumpConfigurationAndControl } from '@matter/types/clusters/pump-configuration-and-control';
|
|
6
|
+
import { TemperatureMeasurement } from '@matter/types/clusters/temperature-measurement';
|
|
7
|
+
import { powerSource, pump } from '../matterbridgeDeviceTypes.js';
|
|
8
|
+
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
|
|
9
|
+
export class Pump extends MatterbridgeEndpoint {
|
|
10
|
+
constructor(name, serial, options = {}) {
|
|
11
|
+
super([pump, powerSource], { id: options.id ?? `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}`, number: options.number, tagList: options.tagList });
|
|
12
|
+
this.createDefaultIdentifyClusterServer();
|
|
13
|
+
this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Pump');
|
|
14
|
+
if (options.batteryPowered) {
|
|
15
|
+
this.createDefaultPowerSourceBatteryClusterServer();
|
|
16
|
+
}
|
|
17
|
+
else {
|
|
18
|
+
this.createDefaultPowerSourceWiredClusterServer();
|
|
19
|
+
}
|
|
20
|
+
this.createOnOffClusterServer(options.onOff ?? false);
|
|
21
|
+
if (options.levelControl !== false)
|
|
22
|
+
this.createLevelControlClusterServer(options.currentLevel ?? 254);
|
|
23
|
+
this.createDefaultPumpConfigurationAndControlClusterServer(options.operationMode, options.maxPressure ?? null, options.maxSpeed ?? null, options.maxFlow ?? null, options.minConstSpeed ?? null, options.maxConstSpeed ?? null);
|
|
24
|
+
if (options.temperatureMeasuredValue !== undefined)
|
|
25
|
+
this.createDefaultTemperatureMeasurementClusterServer(options.temperatureMeasuredValue);
|
|
26
|
+
if (options.pressureMeasuredValue !== undefined)
|
|
27
|
+
this.createDefaultPressureMeasurementClusterServer(options.pressureMeasuredValue);
|
|
28
|
+
if (options.flowMeasuredValue !== undefined)
|
|
29
|
+
this.createDefaultFlowMeasurementClusterServer(options.flowMeasuredValue);
|
|
30
|
+
}
|
|
31
|
+
async setOnOff(onOff) {
|
|
32
|
+
await this.setAttribute(OnOff, 'onOff', onOff);
|
|
33
|
+
}
|
|
34
|
+
getOnOff() {
|
|
35
|
+
return this.getAttribute(OnOff, 'onOff');
|
|
36
|
+
}
|
|
37
|
+
async setLevel(level) {
|
|
38
|
+
if (!this.hasClusterServer(LevelControl) || !Number.isFinite(level))
|
|
39
|
+
return;
|
|
40
|
+
await this.setAttribute(LevelControl, 'currentLevel', Math.min(254, Math.max(0, Math.round(level))));
|
|
41
|
+
}
|
|
42
|
+
getLevel() {
|
|
43
|
+
if (!this.hasClusterServer(LevelControl))
|
|
44
|
+
return undefined;
|
|
45
|
+
return this.getAttribute(LevelControl, 'currentLevel');
|
|
46
|
+
}
|
|
47
|
+
async setOperationMode(operationMode) {
|
|
48
|
+
await this.setAttribute(PumpConfigurationAndControl, 'operationMode', operationMode);
|
|
49
|
+
}
|
|
50
|
+
getOperationMode() {
|
|
51
|
+
return this.getAttribute(PumpConfigurationAndControl, 'operationMode');
|
|
52
|
+
}
|
|
53
|
+
getSpeed() {
|
|
54
|
+
return this.getAttribute(PumpConfigurationAndControl, 'speed');
|
|
55
|
+
}
|
|
56
|
+
getCapacity() {
|
|
57
|
+
return this.getAttribute(PumpConfigurationAndControl, 'capacity');
|
|
58
|
+
}
|
|
59
|
+
async setTemperatureMeasuredValue(value) {
|
|
60
|
+
if (!this.hasClusterServer(TemperatureMeasurement))
|
|
61
|
+
return;
|
|
62
|
+
await this.setAttribute(TemperatureMeasurement, 'measuredValue', value);
|
|
63
|
+
}
|
|
64
|
+
async setPressureMeasuredValue(value) {
|
|
65
|
+
if (!this.hasClusterServer(PressureMeasurement))
|
|
66
|
+
return;
|
|
67
|
+
await this.setAttribute(PressureMeasurement, 'measuredValue', value);
|
|
68
|
+
}
|
|
69
|
+
async setFlowMeasuredValue(value) {
|
|
70
|
+
if (!this.hasClusterServer(FlowMeasurement))
|
|
71
|
+
return;
|
|
72
|
+
await this.setAttribute(FlowMeasurement, 'measuredValue', value);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { ValveConfigurationAndControl } from '@matter/types/clusters/valve-configuration-and-control';
|
|
2
|
+
import type { EndpointNumber } from '@matter/types/datatype';
|
|
3
|
+
import type { Semtag } from '@matter/types/globals';
|
|
4
|
+
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
|
|
5
|
+
export interface WaterValveOptions {
|
|
6
|
+
valveState?: ValveConfigurationAndControl.ValveState;
|
|
7
|
+
level?: boolean;
|
|
8
|
+
valveLevel?: number;
|
|
9
|
+
movementDuration?: number;
|
|
10
|
+
autoClose?: boolean;
|
|
11
|
+
flowMeasuredValue?: number | null;
|
|
12
|
+
batteryPowered?: boolean;
|
|
13
|
+
tagList?: Semtag[];
|
|
14
|
+
id?: string;
|
|
15
|
+
number?: EndpointNumber;
|
|
16
|
+
}
|
|
17
|
+
export declare class WaterValve extends MatterbridgeEndpoint {
|
|
18
|
+
constructor(name: string, serial: string, options?: WaterValveOptions);
|
|
19
|
+
openValve(request?: ValveConfigurationAndControl.OpenRequest): Promise<void>;
|
|
20
|
+
closeValve(): Promise<void>;
|
|
21
|
+
setCurrentState(state: ValveConfigurationAndControl.ValveState): Promise<void>;
|
|
22
|
+
getCurrentState(): ValveConfigurationAndControl.ValveState | null | undefined;
|
|
23
|
+
setCurrentLevel(level: number | null): Promise<void>;
|
|
24
|
+
getCurrentLevel(): number | null | undefined;
|
|
25
|
+
setFlowMeasuredValue(value: number | null): Promise<void>;
|
|
26
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { FlowMeasurement } from '@matter/types/clusters/flow-measurement';
|
|
2
|
+
import { ValveConfigurationAndControl } from '@matter/types/clusters/valve-configuration-and-control';
|
|
3
|
+
import { MatterbridgeValveConfigurationAndControlServer } from '../behaviors/valveConfigurationAndControlServer.js';
|
|
4
|
+
import { powerSource, waterValve } from '../matterbridgeDeviceTypes.js';
|
|
5
|
+
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
|
|
6
|
+
export class WaterValve extends MatterbridgeEndpoint {
|
|
7
|
+
constructor(name, serial, options = {}) {
|
|
8
|
+
super([waterValve, powerSource], { id: options.id ?? `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}`, number: options.number, tagList: options.tagList });
|
|
9
|
+
this.createDefaultIdentifyClusterServer();
|
|
10
|
+
this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Water Valve');
|
|
11
|
+
if (options.batteryPowered) {
|
|
12
|
+
this.createDefaultPowerSourceBatteryClusterServer();
|
|
13
|
+
}
|
|
14
|
+
else {
|
|
15
|
+
this.createDefaultPowerSourceWiredClusterServer();
|
|
16
|
+
}
|
|
17
|
+
if (options.level === false) {
|
|
18
|
+
this.createOnOffValveConfigurationAndControlClusterServer(options.valveState, options.movementDuration, options.autoClose);
|
|
19
|
+
}
|
|
20
|
+
else {
|
|
21
|
+
this.createDefaultValveConfigurationAndControlClusterServer(options.valveState, options.valveLevel, options.movementDuration, options.autoClose);
|
|
22
|
+
}
|
|
23
|
+
if (options.flowMeasuredValue !== undefined)
|
|
24
|
+
this.createDefaultFlowMeasurementClusterServer(options.flowMeasuredValue);
|
|
25
|
+
}
|
|
26
|
+
async openValve(request = {}) {
|
|
27
|
+
await this.act(async (agent) => agent.get(MatterbridgeValveConfigurationAndControlServer).open(request));
|
|
28
|
+
}
|
|
29
|
+
async closeValve() {
|
|
30
|
+
await this.act(async (agent) => agent.get(MatterbridgeValveConfigurationAndControlServer).close());
|
|
31
|
+
}
|
|
32
|
+
async setCurrentState(state) {
|
|
33
|
+
await this.setAttribute(ValveConfigurationAndControl, 'currentState', state);
|
|
34
|
+
}
|
|
35
|
+
getCurrentState() {
|
|
36
|
+
return this.getAttribute(ValveConfigurationAndControl, 'currentState');
|
|
37
|
+
}
|
|
38
|
+
async setCurrentLevel(level) {
|
|
39
|
+
if (!this.hasAttributeServer(ValveConfigurationAndControl, 'currentLevel'))
|
|
40
|
+
return;
|
|
41
|
+
if (level !== null && !Number.isFinite(level))
|
|
42
|
+
return;
|
|
43
|
+
await this.setAttribute(ValveConfigurationAndControl, 'currentLevel', level === null ? null : Math.min(100, Math.max(0, Math.round(level))));
|
|
44
|
+
}
|
|
45
|
+
getCurrentLevel() {
|
|
46
|
+
if (!this.hasAttributeServer(ValveConfigurationAndControl, 'currentLevel'))
|
|
47
|
+
return undefined;
|
|
48
|
+
const currentLevel = this.getAttribute(ValveConfigurationAndControl.id, 'currentLevel');
|
|
49
|
+
return typeof currentLevel === 'number' ? currentLevel : null;
|
|
50
|
+
}
|
|
51
|
+
async setFlowMeasuredValue(value) {
|
|
52
|
+
if (!this.hasClusterServer(FlowMeasurement))
|
|
53
|
+
return;
|
|
54
|
+
await this.setAttribute(FlowMeasurement, 'measuredValue', value);
|
|
55
|
+
}
|
|
56
|
+
}
|
package/dist/frontend.js
CHANGED
|
@@ -1376,6 +1376,18 @@ export class Frontend extends EventEmitter {
|
|
|
1376
1376
|
await this.matterbridge.shutdownProcessAndFactoryReset();
|
|
1377
1377
|
sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
|
|
1378
1378
|
}
|
|
1379
|
+
else if (data.method === '/api/unregister-device') {
|
|
1380
|
+
this.wssSendSnackbarMessage('Resetting the device...');
|
|
1381
|
+
const { pluginName, serialNumber, uniqueId } = data.params;
|
|
1382
|
+
this.server.request({ type: 'platform_unregister_device', src: this.server.name, dst: 'platform', params: { pluginName, serialNumber, uniqueId } });
|
|
1383
|
+
sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
|
|
1384
|
+
}
|
|
1385
|
+
else if (data.method === '/api/rename-device') {
|
|
1386
|
+
this.wssSendSnackbarMessage('Renaming the device...');
|
|
1387
|
+
const { pluginName, serialNumber, uniqueId, label } = data.params;
|
|
1388
|
+
this.server.request({ type: 'platform_rename_device', src: this.server.name, dst: 'platform', params: { pluginName, serialNumber, uniqueId, label } });
|
|
1389
|
+
sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
|
|
1390
|
+
}
|
|
1379
1391
|
else if (data.method === '/api/viewhistorypage') {
|
|
1380
1392
|
generateHistoryPage({ outputPath: path.join(this.matterbridge.matterbridgeDirectory, MATTERBRIDGE_HISTORY_FILE), pageTitle: `Matterbridge Cpu & Memory History` });
|
|
1381
1393
|
sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
|
|
@@ -7,6 +7,7 @@ import { ConcentrationMeasurement } from '@matter/types/clusters/concentration-m
|
|
|
7
7
|
import { DeviceEnergyManagement } from '@matter/types/clusters/device-energy-management';
|
|
8
8
|
import type { DeviceEnergyManagementMode } from '@matter/types/clusters/device-energy-management-mode';
|
|
9
9
|
import { DoorLock } from '@matter/types/clusters/door-lock';
|
|
10
|
+
import { ElectricalEnergyMeasurement } from '@matter/types/clusters/electrical-energy-measurement';
|
|
10
11
|
import { FanControl } from '@matter/types/clusters/fan-control';
|
|
11
12
|
import { Identify } from '@matter/types/clusters/identify';
|
|
12
13
|
import type { IlluminanceMeasurement } from '@matter/types/clusters/illuminance-measurement';
|
|
@@ -155,9 +156,9 @@ export declare class MatterbridgeEndpoint extends Endpoint {
|
|
|
155
156
|
createDefaultBasicInformationClusterServer(deviceName: string, serialNumber: string, vendorId?: number, vendorName?: string, productId?: number, productName?: string, softwareVersion?: number, softwareVersionString?: string, hardwareVersion?: number, hardwareVersionString?: string, productLabel?: string, productUrl?: string, configurationVersion?: number): this;
|
|
156
157
|
createDefaultBridgedDeviceBasicInformationClusterServer(deviceName: string, serialNumber: string, vendorId?: number, vendorName?: string, productName?: string, softwareVersion?: number, softwareVersionString?: string, hardwareVersion?: number, hardwareVersionString?: string, productLabel?: string, productUrl?: string, configurationVersion?: number, productId?: number): this;
|
|
157
158
|
createDefaultPowerTopologyClusterServer(feature?: PowerTopology.Feature, availableEndpoints?: EndpointNumber[], activeEndpoints?: EndpointNumber[]): this;
|
|
158
|
-
createDefaultElectricalEnergyMeasurementClusterServer(energyImported?: number | bigint | null, energyExported?: number | bigint | null): this;
|
|
159
|
-
createImportedElectricalEnergyMeasurementClusterServer(energyImported?: number | bigint | null): this;
|
|
160
|
-
createExportedElectricalEnergyMeasurementClusterServer(energyExported?: number | bigint | null): this;
|
|
159
|
+
createDefaultElectricalEnergyMeasurementClusterServer(energyImported?: number | bigint | null, energyExported?: number | bigint | null, periodicEnergyImported?: ElectricalEnergyMeasurement.EnergyMeasurement | null, periodicEnergyExported?: ElectricalEnergyMeasurement.EnergyMeasurement | null): this;
|
|
160
|
+
createImportedElectricalEnergyMeasurementClusterServer(energyImported?: number | bigint | null, periodicEnergyImported?: ElectricalEnergyMeasurement.EnergyMeasurement | null): this;
|
|
161
|
+
createExportedElectricalEnergyMeasurementClusterServer(energyExported?: number | bigint | null, periodicEnergyExported?: ElectricalEnergyMeasurement.EnergyMeasurement | null): this;
|
|
161
162
|
createDefaultElectricalPowerMeasurementClusterServer(voltage?: number | bigint | null, current?: number | bigint | null, power?: number | bigint | null, frequency?: number | bigint | null): this;
|
|
162
163
|
createApparentElectricalPowerMeasurementClusterServer(voltage?: number | bigint | null, apparentCurrent?: number | bigint | null, apparentPower?: number | bigint | null, frequency?: number | bigint | null): this;
|
|
163
164
|
createDefaultDeviceEnergyManagementClusterServer(esaType?: DeviceEnergyManagement.EsaType, esaCanGenerate?: boolean, esaState?: DeviceEnergyManagement.EsaState, absMinPower?: number, absMaxPower?: number): this;
|
|
@@ -221,6 +222,7 @@ export declare class MatterbridgeEndpoint extends Endpoint {
|
|
|
221
222
|
createUserPinDoorLockClusterServer(lockState?: DoorLock.LockState, lockType?: DoorLock.LockType, autoRelockTime?: number, minPinCodeLength?: number, maxPinCodeLength?: number, numberOfWeekDaySchedulesSupportedPerUser?: number, numberOfYearDaySchedulesSupportedPerUser?: number, numberOfHolidaySchedulesSupported?: number, expiringUserTimeout?: number, numberOfRfidUsersSupported?: number, minRfidCodeLength?: number, maxRfidCodeLength?: number): this;
|
|
222
223
|
createDefaultModeSelectClusterServer(description: string, supportedModes: ModeSelect.ModeOption[], currentMode?: number, startUpMode?: number): this;
|
|
223
224
|
createDefaultValveConfigurationAndControlClusterServer(valveState?: ValveConfigurationAndControl.ValveState, valveLevel?: number, movementDuration?: number, autoClose?: boolean): this;
|
|
225
|
+
createOnOffValveConfigurationAndControlClusterServer(valveState?: ValveConfigurationAndControl.ValveState, movementDuration?: number, autoClose?: boolean): this;
|
|
224
226
|
createDefaultPumpConfigurationAndControlClusterServer(pumpMode?: PumpConfigurationAndControl.OperationMode, maxPressure?: number | null, maxSpeed?: number | null, maxFlow?: number | null, minConstSpeed?: number | null, maxConstSpeed?: number | null, speed?: number | null): this;
|
|
225
227
|
createDefaultSmokeCOAlarmClusterServer(smokeState?: SmokeCoAlarm.AlarmState, coState?: SmokeCoAlarm.AlarmState): this;
|
|
226
228
|
createSmokeOnlySmokeCOAlarmClusterServer(smokeState?: SmokeCoAlarm.AlarmState): this;
|
|
@@ -627,16 +627,16 @@ export class MatterbridgeEndpoint extends Endpoint {
|
|
|
627
627
|
}
|
|
628
628
|
return this;
|
|
629
629
|
}
|
|
630
|
-
createDefaultElectricalEnergyMeasurementClusterServer(energyImported = null, energyExported = null) {
|
|
631
|
-
this.behaviors.require(ElectricalEnergyMeasurementServer.with(ElectricalEnergyMeasurement.Feature.ImportedEnergy, ElectricalEnergyMeasurement.Feature.ExportedEnergy, ElectricalEnergyMeasurement.Feature.CumulativeEnergy), getDefaultElectricalEnergyMeasurementClusterServer(energyImported, energyExported));
|
|
630
|
+
createDefaultElectricalEnergyMeasurementClusterServer(energyImported = null, energyExported = null, periodicEnergyImported, periodicEnergyExported) {
|
|
631
|
+
this.behaviors.require(ElectricalEnergyMeasurementServer.with(ElectricalEnergyMeasurement.Feature.ImportedEnergy, ElectricalEnergyMeasurement.Feature.ExportedEnergy, ElectricalEnergyMeasurement.Feature.CumulativeEnergy, ...(periodicEnergyImported === undefined && periodicEnergyExported === undefined ? [] : [ElectricalEnergyMeasurement.Feature.PeriodicEnergy])), getDefaultElectricalEnergyMeasurementClusterServer(energyImported, energyExported, periodicEnergyImported, periodicEnergyExported));
|
|
632
632
|
return this;
|
|
633
633
|
}
|
|
634
|
-
createImportedElectricalEnergyMeasurementClusterServer(energyImported = null) {
|
|
635
|
-
this.behaviors.require(ElectricalEnergyMeasurementServer.with(ElectricalEnergyMeasurement.Feature.ImportedEnergy, ElectricalEnergyMeasurement.Feature.CumulativeEnergy), getImportedElectricalEnergyMeasurementClusterServer(energyImported));
|
|
634
|
+
createImportedElectricalEnergyMeasurementClusterServer(energyImported = null, periodicEnergyImported) {
|
|
635
|
+
this.behaviors.require(ElectricalEnergyMeasurementServer.with(ElectricalEnergyMeasurement.Feature.ImportedEnergy, ElectricalEnergyMeasurement.Feature.CumulativeEnergy, ...(periodicEnergyImported === undefined ? [] : [ElectricalEnergyMeasurement.Feature.PeriodicEnergy])), getImportedElectricalEnergyMeasurementClusterServer(energyImported, periodicEnergyImported));
|
|
636
636
|
return this;
|
|
637
637
|
}
|
|
638
|
-
createExportedElectricalEnergyMeasurementClusterServer(energyExported = null) {
|
|
639
|
-
this.behaviors.require(ElectricalEnergyMeasurementServer.with(ElectricalEnergyMeasurement.Feature.ExportedEnergy, ElectricalEnergyMeasurement.Feature.CumulativeEnergy), getExportedElectricalEnergyMeasurementClusterServer(energyExported));
|
|
638
|
+
createExportedElectricalEnergyMeasurementClusterServer(energyExported = null, periodicEnergyExported) {
|
|
639
|
+
this.behaviors.require(ElectricalEnergyMeasurementServer.with(ElectricalEnergyMeasurement.Feature.ExportedEnergy, ElectricalEnergyMeasurement.Feature.CumulativeEnergy, ...(periodicEnergyExported === undefined ? [] : [ElectricalEnergyMeasurement.Feature.PeriodicEnergy])), getExportedElectricalEnergyMeasurementClusterServer(energyExported, periodicEnergyExported));
|
|
640
640
|
return this;
|
|
641
641
|
}
|
|
642
642
|
createDefaultElectricalPowerMeasurementClusterServer(voltage = null, current = null, power = null, frequency = null) {
|
|
@@ -1426,6 +1426,19 @@ export class MatterbridgeEndpoint extends Endpoint {
|
|
|
1426
1426
|
});
|
|
1427
1427
|
return this;
|
|
1428
1428
|
}
|
|
1429
|
+
createOnOffValveConfigurationAndControlClusterServer(valveState = ValveConfigurationAndControl.ValveState.Closed, movementDuration = 0, autoClose = false) {
|
|
1430
|
+
this.behaviors.require(MatterbridgeValveConfigurationAndControlServer.with(), {
|
|
1431
|
+
currentState: valveState,
|
|
1432
|
+
targetState: valveState,
|
|
1433
|
+
openDuration: null,
|
|
1434
|
+
defaultOpenDuration: null,
|
|
1435
|
+
remainingDuration: null,
|
|
1436
|
+
valveFault: { generalFault: false, blocked: false, leaking: false, notConnected: false, shortCircuit: false, currentExceeded: false },
|
|
1437
|
+
movementDuration,
|
|
1438
|
+
autoClose,
|
|
1439
|
+
});
|
|
1440
|
+
return this;
|
|
1441
|
+
}
|
|
1429
1442
|
createDefaultPumpConfigurationAndControlClusterServer(pumpMode = PumpConfigurationAndControl.OperationMode.Normal, maxPressure = null, maxSpeed = null, maxFlow = null, minConstSpeed = null, maxConstSpeed = null, speed = null) {
|
|
1430
1443
|
this.behaviors.require(MatterbridgePumpConfigurationAndControlServer.with(PumpConfigurationAndControl.Feature.ConstantSpeed), {
|
|
1431
1444
|
minConstSpeed,
|
|
@@ -127,7 +127,7 @@ export declare function getDefaultPowerSourceRechargeableBatteryClusterServer(ba
|
|
|
127
127
|
replaceable: false;
|
|
128
128
|
wired: false;
|
|
129
129
|
}>, typeof MatterbridgePowerSourceServer>>;
|
|
130
|
-
export declare function getDefaultElectricalEnergyMeasurementClusterServer(energyImported?: number | bigint | null, energyExported?: number | bigint | null): Partial<import("@matter/node").ClusterState.Type<ClusterType.WithSupportedFeatures<ClusterType.WithSupportedFeatures<ClusterType.WithSupportedFeatures<ElectricalEnergyMeasurement, {
|
|
130
|
+
export declare function getDefaultElectricalEnergyMeasurementClusterServer(energyImported?: number | bigint | null, energyExported?: number | bigint | null, periodicEnergyImported?: ElectricalEnergyMeasurement.EnergyMeasurement | null, periodicEnergyExported?: ElectricalEnergyMeasurement.EnergyMeasurement | null): Partial<import("@matter/node").ClusterState.Type<ClusterType.WithSupportedFeatures<ClusterType.WithSupportedFeatures<ClusterType.WithSupportedFeatures<ElectricalEnergyMeasurement, {
|
|
131
131
|
apparentEnergy: false;
|
|
132
132
|
cumulativeEnergy: true;
|
|
133
133
|
exportedEnergy: true;
|
|
@@ -142,14 +142,14 @@ export declare function getDefaultElectricalEnergyMeasurementClusterServer(energ
|
|
|
142
142
|
periodicEnergy: false;
|
|
143
143
|
reactiveEnergy: false;
|
|
144
144
|
}>, {
|
|
145
|
-
apparentEnergy:
|
|
145
|
+
apparentEnergy: true;
|
|
146
146
|
cumulativeEnergy: true;
|
|
147
147
|
exportedEnergy: true;
|
|
148
148
|
importedEnergy: true;
|
|
149
|
-
periodicEnergy:
|
|
150
|
-
reactiveEnergy:
|
|
149
|
+
periodicEnergy: true;
|
|
150
|
+
reactiveEnergy: true;
|
|
151
151
|
}>, typeof ElectricalEnergyMeasurementServer>>;
|
|
152
|
-
export declare function getImportedElectricalEnergyMeasurementClusterServer(energyImported?: number | bigint | null): Partial<import("@matter/node").ClusterState.Type<ClusterType.WithSupportedFeatures<ClusterType.WithSupportedFeatures<ClusterType.WithSupportedFeatures<ElectricalEnergyMeasurement, {
|
|
152
|
+
export declare function getImportedElectricalEnergyMeasurementClusterServer(energyImported?: number | bigint | null, periodicEnergyImported?: ElectricalEnergyMeasurement.EnergyMeasurement | null): Partial<import("@matter/node").ClusterState.Type<ClusterType.WithSupportedFeatures<ClusterType.WithSupportedFeatures<ClusterType.WithSupportedFeatures<ElectricalEnergyMeasurement, {
|
|
153
153
|
apparentEnergy: false;
|
|
154
154
|
cumulativeEnergy: true;
|
|
155
155
|
exportedEnergy: true;
|
|
@@ -164,14 +164,14 @@ export declare function getImportedElectricalEnergyMeasurementClusterServer(ener
|
|
|
164
164
|
periodicEnergy: false;
|
|
165
165
|
reactiveEnergy: false;
|
|
166
166
|
}>, {
|
|
167
|
-
apparentEnergy:
|
|
167
|
+
apparentEnergy: true;
|
|
168
168
|
cumulativeEnergy: true;
|
|
169
|
-
exportedEnergy:
|
|
169
|
+
exportedEnergy: true;
|
|
170
170
|
importedEnergy: true;
|
|
171
|
-
periodicEnergy:
|
|
172
|
-
reactiveEnergy:
|
|
171
|
+
periodicEnergy: true;
|
|
172
|
+
reactiveEnergy: true;
|
|
173
173
|
}>, typeof ElectricalEnergyMeasurementServer>>;
|
|
174
|
-
export declare function getExportedElectricalEnergyMeasurementClusterServer(energyExported?: number | bigint | null): Partial<import("@matter/node").ClusterState.Type<ClusterType.WithSupportedFeatures<ClusterType.WithSupportedFeatures<ClusterType.WithSupportedFeatures<ElectricalEnergyMeasurement, {
|
|
174
|
+
export declare function getExportedElectricalEnergyMeasurementClusterServer(energyExported?: number | bigint | null, periodicEnergyExported?: ElectricalEnergyMeasurement.EnergyMeasurement | null): Partial<import("@matter/node").ClusterState.Type<ClusterType.WithSupportedFeatures<ClusterType.WithSupportedFeatures<ClusterType.WithSupportedFeatures<ElectricalEnergyMeasurement, {
|
|
175
175
|
apparentEnergy: false;
|
|
176
176
|
cumulativeEnergy: true;
|
|
177
177
|
exportedEnergy: true;
|
|
@@ -186,12 +186,12 @@ export declare function getExportedElectricalEnergyMeasurementClusterServer(ener
|
|
|
186
186
|
periodicEnergy: false;
|
|
187
187
|
reactiveEnergy: false;
|
|
188
188
|
}>, {
|
|
189
|
-
apparentEnergy:
|
|
189
|
+
apparentEnergy: true;
|
|
190
190
|
cumulativeEnergy: true;
|
|
191
191
|
exportedEnergy: true;
|
|
192
|
-
importedEnergy:
|
|
193
|
-
periodicEnergy:
|
|
194
|
-
reactiveEnergy:
|
|
192
|
+
importedEnergy: true;
|
|
193
|
+
periodicEnergy: true;
|
|
194
|
+
reactiveEnergy: true;
|
|
195
195
|
}>, typeof ElectricalEnergyMeasurementServer>>;
|
|
196
196
|
export declare function getDefaultElectricalPowerMeasurementClusterServer(voltage?: number | bigint | null, current?: number | bigint | null, power?: number | bigint | null, frequency?: number | bigint | null): Partial<import("@matter/node").ClusterState.Type<ClusterType.WithSupportedFeatures<ElectricalPowerMeasurement, {
|
|
197
197
|
alternatingCurrent: true;
|
|
@@ -952,8 +952,8 @@ export function getDefaultPowerSourceRechargeableBatteryClusterServer(batPercent
|
|
|
952
952
|
...(activeBatChargeFaults !== undefined ? { activeBatChargeFaults } : {}),
|
|
953
953
|
});
|
|
954
954
|
}
|
|
955
|
-
export function getDefaultElectricalEnergyMeasurementClusterServer(energyImported = null, energyExported = null) {
|
|
956
|
-
return optionsFor(ElectricalEnergyMeasurementServer.with(ElectricalEnergyMeasurement.Feature.ImportedEnergy, ElectricalEnergyMeasurement.Feature.ExportedEnergy, ElectricalEnergyMeasurement.Feature.CumulativeEnergy), {
|
|
955
|
+
export function getDefaultElectricalEnergyMeasurementClusterServer(energyImported = null, energyExported = null, periodicEnergyImported, periodicEnergyExported) {
|
|
956
|
+
return optionsFor(ElectricalEnergyMeasurementServer.with(ElectricalEnergyMeasurement.Feature.ImportedEnergy, ElectricalEnergyMeasurement.Feature.ExportedEnergy, ElectricalEnergyMeasurement.Feature.CumulativeEnergy, ...(periodicEnergyImported === undefined && periodicEnergyExported === undefined ? [] : [ElectricalEnergyMeasurement.Feature.PeriodicEnergy])), {
|
|
957
957
|
accuracy: {
|
|
958
958
|
measurementType: MeasurementType.ElectricalEnergy,
|
|
959
959
|
measured: true,
|
|
@@ -964,10 +964,12 @@ export function getDefaultElectricalEnergyMeasurementClusterServer(energyImporte
|
|
|
964
964
|
cumulativeEnergyReset: null,
|
|
965
965
|
cumulativeEnergyImported: energyImported !== null && energyImported >= 0 ? { energy: energyImported } : null,
|
|
966
966
|
cumulativeEnergyExported: energyExported !== null && energyExported >= 0 ? { energy: energyExported } : null,
|
|
967
|
+
...(periodicEnergyImported === undefined ? {} : { periodicEnergyImported }),
|
|
968
|
+
...(periodicEnergyExported === undefined ? {} : { periodicEnergyExported }),
|
|
967
969
|
});
|
|
968
970
|
}
|
|
969
|
-
export function getImportedElectricalEnergyMeasurementClusterServer(energyImported = null) {
|
|
970
|
-
return optionsFor(ElectricalEnergyMeasurementServer.with(ElectricalEnergyMeasurement.Feature.ImportedEnergy, ElectricalEnergyMeasurement.Feature.CumulativeEnergy), {
|
|
971
|
+
export function getImportedElectricalEnergyMeasurementClusterServer(energyImported = null, periodicEnergyImported) {
|
|
972
|
+
return optionsFor(ElectricalEnergyMeasurementServer.with(ElectricalEnergyMeasurement.Feature.ImportedEnergy, ElectricalEnergyMeasurement.Feature.CumulativeEnergy, ...(periodicEnergyImported === undefined ? [] : [ElectricalEnergyMeasurement.Feature.PeriodicEnergy])), {
|
|
971
973
|
accuracy: {
|
|
972
974
|
measurementType: MeasurementType.ElectricalEnergy,
|
|
973
975
|
measured: true,
|
|
@@ -977,10 +979,11 @@ export function getImportedElectricalEnergyMeasurementClusterServer(energyImport
|
|
|
977
979
|
},
|
|
978
980
|
cumulativeEnergyReset: null,
|
|
979
981
|
cumulativeEnergyImported: energyImported !== null && energyImported >= 0 ? { energy: energyImported } : null,
|
|
982
|
+
...(periodicEnergyImported === undefined ? {} : { periodicEnergyImported }),
|
|
980
983
|
});
|
|
981
984
|
}
|
|
982
|
-
export function getExportedElectricalEnergyMeasurementClusterServer(energyExported = null) {
|
|
983
|
-
return optionsFor(ElectricalEnergyMeasurementServer.with(ElectricalEnergyMeasurement.Feature.ExportedEnergy, ElectricalEnergyMeasurement.Feature.CumulativeEnergy), {
|
|
985
|
+
export function getExportedElectricalEnergyMeasurementClusterServer(energyExported = null, periodicEnergyExported) {
|
|
986
|
+
return optionsFor(ElectricalEnergyMeasurementServer.with(ElectricalEnergyMeasurement.Feature.ExportedEnergy, ElectricalEnergyMeasurement.Feature.CumulativeEnergy, ...(periodicEnergyExported === undefined ? [] : [ElectricalEnergyMeasurement.Feature.PeriodicEnergy])), {
|
|
984
987
|
accuracy: {
|
|
985
988
|
measurementType: MeasurementType.ElectricalEnergy,
|
|
986
989
|
measured: true,
|
|
@@ -990,6 +993,7 @@ export function getExportedElectricalEnergyMeasurementClusterServer(energyExport
|
|
|
990
993
|
},
|
|
991
994
|
cumulativeEnergyReset: null,
|
|
992
995
|
cumulativeEnergyExported: energyExported !== null && energyExported >= 0 ? { energy: energyExported } : null,
|
|
996
|
+
...(periodicEnergyExported === undefined ? {} : { periodicEnergyExported }),
|
|
993
997
|
});
|
|
994
998
|
}
|
|
995
999
|
export function getDefaultElectricalPowerMeasurementClusterServer(voltage = null, current = null, power = null, frequency = null) {
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type { EndpointNumber } from '@matter/types/datatype';
|
|
2
|
-
import type { ApiSelectDevice, ApiSelectEntity, PlatformConfig, PlatformMatterbridge, PlatformSchema } from '@matterbridge/types';
|
|
2
|
+
import type { ApiSelectDevice, ApiSelectEntity, PlatformConfig, PlatformMatterbridge, PlatformSchema, PlatformSelectDevice, PlatformSelectEntity } from '@matterbridge/types';
|
|
3
3
|
import { type AnsiLogger, type LogLevel } from 'node-ansi-logger';
|
|
4
4
|
import { type NodeStorage } from 'node-persist-manager';
|
|
5
5
|
import { type MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
|
|
6
|
-
export type { BasePlatformConfig, PlatformConfig, PlatformConfigValue, PlatformMatterbridge, PlatformSchema, PlatformSchemaValue } from '@matterbridge/types';
|
|
6
|
+
export type { BasePlatformConfig, PlatformConfig, PlatformConfigValue, PlatformMatterbridge, PlatformNodeLabel, PlatformSchema, PlatformSchemaValue, PlatformSelectDevice, PlatformSelectEntity, } from '@matterbridge/types';
|
|
7
7
|
export declare function isMatterbridgePlatform(value: unknown): value is MatterbridgePlatform;
|
|
8
8
|
export declare function assertMatterbridgePlatform(value: unknown, context?: string): asserts value is MatterbridgePlatform;
|
|
9
9
|
export declare class MatterbridgePlatform {
|
|
@@ -54,30 +54,12 @@ export declare class MatterbridgePlatform {
|
|
|
54
54
|
clearSelect(): Promise<void>;
|
|
55
55
|
clearDeviceSelect(serial: string): Promise<void>;
|
|
56
56
|
clearEntitySelect(name: string): Promise<void>;
|
|
57
|
-
setSelectDevice(serial: string, name: string, configUrl?: string, icon?: string, entities?:
|
|
58
|
-
|
|
59
|
-
description: string;
|
|
60
|
-
icon?: string;
|
|
61
|
-
}[]): void;
|
|
62
|
-
getSelectDevice(serial: string): {
|
|
63
|
-
serial: string;
|
|
64
|
-
name: string;
|
|
65
|
-
configUrl?: string;
|
|
66
|
-
icon?: string;
|
|
67
|
-
entities?: {
|
|
68
|
-
name: string;
|
|
69
|
-
description: string;
|
|
70
|
-
icon?: string;
|
|
71
|
-
}[];
|
|
72
|
-
} | undefined;
|
|
57
|
+
setSelectDevice(serial: string, name: string, configUrl?: string, icon?: string, entities?: PlatformSelectEntity[]): void;
|
|
58
|
+
getSelectDevice(serial: string): PlatformSelectDevice | undefined;
|
|
73
59
|
setSelectDeviceEntity(serial: string, entityName: string, entityDescription: string, entityIcon?: string): void;
|
|
74
60
|
getSelectDevices(): ApiSelectDevice[];
|
|
75
61
|
setSelectEntity(name: string, description: string, icon?: string): void;
|
|
76
|
-
getSelectEntity(name: string):
|
|
77
|
-
name: string;
|
|
78
|
-
description: string;
|
|
79
|
-
icon?: string | undefined;
|
|
80
|
-
} | undefined;
|
|
62
|
+
getSelectEntity(name: string): PlatformSelectEntity | undefined;
|
|
81
63
|
getSelectEntities(): ApiSelectEntity[];
|
|
82
64
|
verifyMatterbridgeVersion(requiredVersion: string, destroy?: boolean): boolean;
|
|
83
65
|
validateDevice(device: string | string[], log?: boolean): boolean;
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
import path from 'node:path';
|
|
2
|
+
import { BasicInformation } from '@matter/types/clusters/basic-information';
|
|
2
3
|
import { BridgedDeviceBasicInformation } from '@matter/types/clusters/bridged-device-basic-information';
|
|
3
4
|
import { Descriptor } from '@matter/types/clusters/descriptor';
|
|
4
5
|
import { BroadcastServer } from '@matterbridge/thread/server';
|
|
5
|
-
import {
|
|
6
|
+
import { hasAnyParameter } from '@matterbridge/utils/cli';
|
|
7
|
+
import { inspectError } from '@matterbridge/utils/error';
|
|
6
8
|
import { logModuleLoaded } from '@matterbridge/utils/loader';
|
|
7
9
|
import { isValidArray, isValidObject, isValidString } from '@matterbridge/utils/validate';
|
|
8
10
|
import { fireAndForget } from '@matterbridge/utils/wait';
|
|
@@ -47,14 +49,16 @@ export class MatterbridgePlatform {
|
|
|
47
49
|
isShuttingDown = false;
|
|
48
50
|
#selectDevices = new Map();
|
|
49
51
|
#selectEntities = new Map();
|
|
52
|
+
#nodeLabels = new Map();
|
|
50
53
|
#contextReady;
|
|
51
54
|
#selectDeviceContextReady;
|
|
52
55
|
#selectEntityContextReady;
|
|
56
|
+
#nodeLabelsContextReady;
|
|
53
57
|
ready;
|
|
54
58
|
#registeredEndpoints = new Map();
|
|
55
59
|
#server;
|
|
56
|
-
#debug =
|
|
57
|
-
#verbose =
|
|
60
|
+
#debug = hasAnyParameter('debug', 'verbose', 'debug-platform', 'verbose-platform');
|
|
61
|
+
#verbose = hasAnyParameter('verbose', 'verbose-platform');
|
|
58
62
|
#addBridgedEndpoint;
|
|
59
63
|
#removeBridgedEndpoint;
|
|
60
64
|
#removeAllBridgedEndpoints;
|
|
@@ -117,7 +121,15 @@ export class MatterbridgePlatform {
|
|
|
117
121
|
this.log.debug(`Loaded ${this.#selectEntities.size} selectEntity for plugin ${this.config.name}`);
|
|
118
122
|
return;
|
|
119
123
|
});
|
|
120
|
-
this.
|
|
124
|
+
this.log.debug(`Loading nodeLabels for plugin ${this.config.name}`);
|
|
125
|
+
this.#nodeLabelsContextReady = this.#storage.createStorage('nodeLabels').then(async (context) => {
|
|
126
|
+
const nodeLabels = await context.get('nodeLabels', []);
|
|
127
|
+
for (const label of nodeLabels)
|
|
128
|
+
this.#nodeLabels.set(label.uniqueId, label.label);
|
|
129
|
+
this.log.debug(`Loaded ${this.#nodeLabels.size} nodeLabels for plugin ${this.config.name}`);
|
|
130
|
+
return;
|
|
131
|
+
});
|
|
132
|
+
this.ready = Promise.all([this.#contextReady, this.#selectDeviceContextReady, this.#selectEntityContextReady, this.#nodeLabelsContextReady]).then(() => {
|
|
121
133
|
this.log.debug(`MatterbridgePlatform for plugin ${this.config.name} is fully initialized`);
|
|
122
134
|
this.isReady = true;
|
|
123
135
|
return;
|
|
@@ -166,6 +178,69 @@ export class MatterbridgePlatform {
|
|
|
166
178
|
return;
|
|
167
179
|
this.#server.respond({ ...msg, result: { entities: this.getSelectEntities().toSorted((keyA, keyB) => keyA.name.localeCompare(keyB.name)) } });
|
|
168
180
|
break;
|
|
181
|
+
case 'platform_unregister_device':
|
|
182
|
+
if (msg.params.pluginName === this.name) {
|
|
183
|
+
this.#server.respond({ ...msg, result: { success: true } });
|
|
184
|
+
const { serialNumber, uniqueId } = msg.params;
|
|
185
|
+
fireAndForget((async () => {
|
|
186
|
+
try {
|
|
187
|
+
const endpoint = this.getDevices().find((device) => device.serialNumber === serialNumber && device.uniqueId === uniqueId);
|
|
188
|
+
if (!endpoint) {
|
|
189
|
+
this.log.warn(`Unregister device: no device found with serialNumber ${CYAN}${serialNumber}${wr} and uniqueId ${CYAN}${uniqueId}${wr}`);
|
|
190
|
+
this.wssSendSnackbarMessage(`Device ${serialNumber} not found`, 5, 'warning');
|
|
191
|
+
return;
|
|
192
|
+
}
|
|
193
|
+
await this.unregisterDevice(endpoint);
|
|
194
|
+
this.wssSendSnackbarMessage(`Device ${endpoint.deviceName} reset`, 5, 'success');
|
|
195
|
+
this.wssSendRestartRequired(true, true);
|
|
196
|
+
}
|
|
197
|
+
finally {
|
|
198
|
+
this.#server.request({ type: 'frontend_closesnackbarmessage', src: 'platform', dst: 'frontend', params: { message: 'Resetting the device...' } });
|
|
199
|
+
}
|
|
200
|
+
})(), this.log, `Unregister device ${serialNumber}`);
|
|
201
|
+
}
|
|
202
|
+
else {
|
|
203
|
+
return;
|
|
204
|
+
}
|
|
205
|
+
break;
|
|
206
|
+
case 'platform_rename_device':
|
|
207
|
+
if (msg.params.pluginName === this.name) {
|
|
208
|
+
this.#server.respond({ ...msg, result: { success: true } });
|
|
209
|
+
const { serialNumber, uniqueId, label } = msg.params;
|
|
210
|
+
fireAndForget((async () => {
|
|
211
|
+
try {
|
|
212
|
+
const endpoint = this.getDevices().find((device) => device.serialNumber === serialNumber && device.uniqueId === uniqueId);
|
|
213
|
+
if (!endpoint?.uniqueId) {
|
|
214
|
+
this.log.warn(`Rename device: no device found with serialNumber ${CYAN}${serialNumber}${wr} and uniqueId ${CYAN}${uniqueId}${wr}`);
|
|
215
|
+
this.wssSendSnackbarMessage(`Device ${serialNumber} not found`, 5, 'warning');
|
|
216
|
+
return;
|
|
217
|
+
}
|
|
218
|
+
if (!isValidString(label, 1, 32)) {
|
|
219
|
+
this.log.warn(`Rename device: the new name for device ${CYAN}${endpoint.deviceName}${wr} must be 1 to 32 characters long`);
|
|
220
|
+
this.wssSendSnackbarMessage(`The new name must be 1 to 32 characters long`, 5, 'warning');
|
|
221
|
+
return;
|
|
222
|
+
}
|
|
223
|
+
if (label === endpoint.deviceName)
|
|
224
|
+
this.#nodeLabels.delete(endpoint.uniqueId);
|
|
225
|
+
else
|
|
226
|
+
this.#nodeLabels.set(endpoint.uniqueId, label);
|
|
227
|
+
const nodeLabels = Array.from(this.#nodeLabels.entries()).map(([key, value]) => ({ uniqueId: key, label: value }));
|
|
228
|
+
const storage = await this.#storage.createStorage('nodeLabels');
|
|
229
|
+
await storage.set('nodeLabels', nodeLabels);
|
|
230
|
+
await this.#setNodeLabel(endpoint, label);
|
|
231
|
+
this.log.info(`Device ${endpoint.deviceName} renamed to ${label}`);
|
|
232
|
+
this.wssSendSnackbarMessage(`Device ${endpoint.deviceName} renamed to ${label}`, 5, 'success');
|
|
233
|
+
this.wssSendRestartRequired(true, true);
|
|
234
|
+
}
|
|
235
|
+
finally {
|
|
236
|
+
this.#server.request({ type: 'frontend_closesnackbarmessage', src: 'platform', dst: 'frontend', params: { message: 'Renaming the device...' } });
|
|
237
|
+
}
|
|
238
|
+
})(), this.log, `Rename device ${serialNumber}`);
|
|
239
|
+
}
|
|
240
|
+
else {
|
|
241
|
+
return;
|
|
242
|
+
}
|
|
243
|
+
break;
|
|
169
244
|
default:
|
|
170
245
|
if (this.#verbose)
|
|
171
246
|
this.log.debug(`Unknown broadcast request ${CYAN}${msg.type}${db} from ${CYAN}${msg.src}${db}`);
|
|
@@ -176,6 +251,7 @@ export class MatterbridgePlatform {
|
|
|
176
251
|
this.log.debug(`Destroying MatterbridgePlatform for plugin ${this.config.name}`);
|
|
177
252
|
this.#selectDevices.clear();
|
|
178
253
|
this.#selectEntities.clear();
|
|
254
|
+
this.#nodeLabels.clear();
|
|
179
255
|
this.#registeredEndpoints.clear();
|
|
180
256
|
await this.context?.close();
|
|
181
257
|
this.context = undefined;
|
|
@@ -302,6 +378,22 @@ export class MatterbridgePlatform {
|
|
|
302
378
|
}
|
|
303
379
|
await this.#addBridgedEndpoint?.(this.name, device);
|
|
304
380
|
this.#registeredEndpoints.set(device.uniqueId, device);
|
|
381
|
+
const nodeLabel = this.#nodeLabels.get(device.uniqueId);
|
|
382
|
+
if (isValidString(nodeLabel, 1, 32)) {
|
|
383
|
+
await this.#setNodeLabel(device, nodeLabel);
|
|
384
|
+
}
|
|
385
|
+
}
|
|
386
|
+
async #setNodeLabel(device, nodeLabel) {
|
|
387
|
+
this.log.debug(`Setting nodeLabel ${CYAN}${nodeLabel}${db} for device ${CYAN}${device.deviceName}${db}`);
|
|
388
|
+
try {
|
|
389
|
+
if (device.hasClusterServer(BridgedDeviceBasicInformation))
|
|
390
|
+
await device.setAttribute(BridgedDeviceBasicInformation, 'nodeLabel', nodeLabel, this.log);
|
|
391
|
+
else if (device.hasClusterServer(BasicInformation))
|
|
392
|
+
await device.setAttribute(BasicInformation, 'nodeLabel', nodeLabel, this.log);
|
|
393
|
+
}
|
|
394
|
+
catch (error) {
|
|
395
|
+
inspectError(this.log, `Failed to set nodeLabel ${nodeLabel} for device ${device.deviceName}`, error);
|
|
396
|
+
}
|
|
305
397
|
}
|
|
306
398
|
async unregisterDevice(device) {
|
|
307
399
|
assertMatterbridgeEndpoint(device, `MatterbridgePlatform.unregisterDevice for plugin ${this.name}`);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@matterbridge/core",
|
|
3
|
-
"version": "3.11.2-dev-
|
|
3
|
+
"version": "3.11.2-dev-20261104-98c7a1f",
|
|
4
4
|
"description": "Matterbridge core library",
|
|
5
5
|
"author": "https://github.com/Luligu",
|
|
6
6
|
"homepage": "https://matterbridge.io/",
|
|
@@ -136,10 +136,10 @@
|
|
|
136
136
|
},
|
|
137
137
|
"dependencies": {
|
|
138
138
|
"@matter/main": "0.18.0",
|
|
139
|
-
"@matterbridge/dgram": "3.11.2-dev-
|
|
140
|
-
"@matterbridge/thread": "3.11.2-dev-
|
|
141
|
-
"@matterbridge/types": "3.11.2-dev-
|
|
142
|
-
"@matterbridge/utils": "3.11.2-dev-
|
|
139
|
+
"@matterbridge/dgram": "3.11.2-dev-20261104-98c7a1f",
|
|
140
|
+
"@matterbridge/thread": "3.11.2-dev-20261104-98c7a1f",
|
|
141
|
+
"@matterbridge/types": "3.11.2-dev-20261104-98c7a1f",
|
|
142
|
+
"@matterbridge/utils": "3.11.2-dev-20261104-98c7a1f",
|
|
143
143
|
"escape-html": "1.0.3",
|
|
144
144
|
"express": "5.3.0",
|
|
145
145
|
"express-rate-limit": "8.7.2",
|