matterbridge 3.5.0 → 3.5.1-dev-20260121-22e98b4
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 +14 -0
- package/bin/mb_coap.js +1 -1
- package/bin/mb_mdns.js +1 -1
- package/dist/broadcastServer.d.ts +0 -115
- package/dist/broadcastServer.js +1 -119
- package/dist/broadcastServerTypes.d.ts +0 -43
- package/dist/broadcastServerTypes.js +0 -24
- package/dist/cli.d.ts +1 -26
- package/dist/cli.js +2 -102
- package/dist/cliEmitter.d.ts +0 -36
- package/dist/cliEmitter.js +0 -37
- package/dist/cliHistory.d.ts +0 -42
- package/dist/cliHistory.js +1 -39
- package/dist/clusters/export.d.ts +0 -1
- package/dist/clusters/export.js +0 -2
- package/dist/deviceManager.d.ts +0 -108
- package/dist/deviceManager.js +2 -114
- package/dist/devices/airConditioner.d.ts +0 -75
- package/dist/devices/airConditioner.js +0 -57
- package/dist/devices/batteryStorage.d.ts +0 -43
- package/dist/devices/batteryStorage.js +1 -48
- package/dist/devices/cooktop.d.ts +0 -55
- package/dist/devices/cooktop.js +0 -56
- package/dist/devices/dishwasher.d.ts +0 -55
- package/dist/devices/dishwasher.js +0 -57
- package/dist/devices/evse.d.ts +0 -57
- package/dist/devices/evse.js +10 -74
- package/dist/devices/export.d.ts +0 -1
- package/dist/devices/export.js +0 -5
- package/dist/devices/extractorHood.d.ts +0 -41
- package/dist/devices/extractorHood.js +0 -43
- package/dist/devices/heatPump.d.ts +0 -43
- package/dist/devices/heatPump.js +2 -50
- package/dist/devices/laundryDryer.d.ts +0 -58
- package/dist/devices/laundryDryer.js +3 -62
- package/dist/devices/laundryWasher.d.ts +0 -64
- package/dist/devices/laundryWasher.js +4 -70
- package/dist/devices/microwaveOven.d.ts +1 -77
- package/dist/devices/microwaveOven.js +5 -88
- package/dist/devices/oven.d.ts +0 -82
- package/dist/devices/oven.js +0 -85
- package/dist/devices/refrigerator.d.ts +0 -100
- package/dist/devices/refrigerator.js +0 -102
- package/dist/devices/roboticVacuumCleaner.d.ts +0 -83
- package/dist/devices/roboticVacuumCleaner.js +9 -100
- package/dist/devices/solarPower.d.ts +0 -36
- package/dist/devices/solarPower.js +0 -38
- package/dist/devices/speaker.d.ts +0 -79
- package/dist/devices/speaker.js +0 -84
- package/dist/devices/temperatureControl.d.ts +0 -21
- package/dist/devices/temperatureControl.js +3 -24
- package/dist/devices/waterHeater.d.ts +0 -74
- package/dist/devices/waterHeater.js +2 -82
- package/dist/frontend.d.ts +0 -187
- package/dist/frontend.js +39 -505
- package/dist/frontendTypes.d.ts +0 -57
- package/dist/frontendTypes.js +0 -45
- package/dist/helpers.d.ts +0 -43
- package/dist/helpers.js +1 -54
- package/dist/index.d.ts +0 -23
- package/dist/index.js +0 -25
- package/dist/jestutils/export.d.ts +0 -1
- package/dist/jestutils/export.js +0 -1
- package/dist/jestutils/jestHelpers.d.ts +0 -255
- package/dist/jestutils/jestHelpers.js +14 -372
- package/dist/logger/export.d.ts +0 -1
- package/dist/logger/export.js +0 -1
- package/dist/matter/behaviors.d.ts +0 -1
- package/dist/matter/behaviors.js +0 -2
- package/dist/matter/clusters.d.ts +0 -1
- package/dist/matter/clusters.js +0 -2
- package/dist/matter/devices.d.ts +0 -1
- package/dist/matter/devices.js +0 -2
- package/dist/matter/endpoints.d.ts +0 -1
- package/dist/matter/endpoints.js +0 -2
- package/dist/matter/export.d.ts +0 -1
- package/dist/matter/export.js +0 -2
- package/dist/matter/types.d.ts +0 -1
- package/dist/matter/types.js +0 -2
- package/dist/matterNode.d.ts +0 -258
- package/dist/matterNode.js +9 -364
- package/dist/matterbridge.d.ts +0 -362
- package/dist/matterbridge.js +60 -860
- package/dist/matterbridgeAccessoryPlatform.d.ts +0 -36
- package/dist/matterbridgeAccessoryPlatform.js +0 -38
- package/dist/matterbridgeBehaviors.d.ts +0 -24
- package/dist/matterbridgeBehaviors.js +5 -68
- package/dist/matterbridgeDeviceTypes.d.ts +0 -649
- package/dist/matterbridgeDeviceTypes.js +6 -673
- package/dist/matterbridgeDynamicPlatform.d.ts +0 -36
- package/dist/matterbridgeDynamicPlatform.js +0 -38
- package/dist/matterbridgeEndpoint.d.ts +2 -1332
- package/dist/matterbridgeEndpoint.js +94 -1459
- package/dist/matterbridgeEndpointHelpers.d.ts +0 -425
- package/dist/matterbridgeEndpointHelpers.js +21 -486
- package/dist/matterbridgeEndpointTypes.d.ts +0 -70
- package/dist/matterbridgeEndpointTypes.js +0 -25
- package/dist/matterbridgePlatform.d.ts +0 -425
- package/dist/matterbridgePlatform.js +2 -453
- package/dist/matterbridgeTypes.d.ts +0 -46
- package/dist/matterbridgeTypes.js +0 -26
- package/dist/mb_coap.d.ts +1 -0
- package/dist/{dgram/mb_coap.js → mb_coap.js} +3 -41
- package/dist/mb_mdns.d.ts +1 -0
- package/dist/{dgram/mb_mdns.js → mb_mdns.js} +37 -81
- package/dist/pluginManager.d.ts +0 -305
- package/dist/pluginManager.js +8 -345
- package/dist/shelly.d.ts +0 -157
- package/dist/shelly.js +7 -178
- package/dist/spawn.d.ts +1 -0
- package/dist/{utils/spawn.js → spawn.js} +3 -73
- package/dist/storage/export.d.ts +0 -1
- package/dist/storage/export.js +0 -1
- package/dist/update.d.ts +0 -75
- package/dist/update.js +7 -100
- package/dist/utils/export.d.ts +1 -13
- package/dist/utils/export.js +1 -13
- package/dist/workerGlobalPrefix.d.ts +0 -24
- package/dist/workerGlobalPrefix.js +6 -40
- package/dist/workerTypes.d.ts +0 -25
- package/dist/workerTypes.js +0 -24
- package/dist/workers.d.ts +0 -61
- package/dist/workers.js +4 -68
- package/npm-shrinkwrap.json +35 -5
- package/package.json +5 -5
- package/dist/broadcastServer.d.ts.map +0 -1
- package/dist/broadcastServer.js.map +0 -1
- package/dist/broadcastServerTypes.d.ts.map +0 -1
- package/dist/broadcastServerTypes.js.map +0 -1
- package/dist/cli.d.ts.map +0 -1
- package/dist/cli.js.map +0 -1
- package/dist/cliEmitter.d.ts.map +0 -1
- package/dist/cliEmitter.js.map +0 -1
- package/dist/cliHistory.d.ts.map +0 -1
- package/dist/cliHistory.js.map +0 -1
- package/dist/clusters/export.d.ts.map +0 -1
- package/dist/clusters/export.js.map +0 -1
- package/dist/deviceManager.d.ts.map +0 -1
- package/dist/deviceManager.js.map +0 -1
- package/dist/devices/airConditioner.d.ts.map +0 -1
- package/dist/devices/airConditioner.js.map +0 -1
- package/dist/devices/batteryStorage.d.ts.map +0 -1
- package/dist/devices/batteryStorage.js.map +0 -1
- package/dist/devices/cooktop.d.ts.map +0 -1
- package/dist/devices/cooktop.js.map +0 -1
- package/dist/devices/dishwasher.d.ts.map +0 -1
- package/dist/devices/dishwasher.js.map +0 -1
- package/dist/devices/evse.d.ts.map +0 -1
- package/dist/devices/evse.js.map +0 -1
- package/dist/devices/export.d.ts.map +0 -1
- package/dist/devices/export.js.map +0 -1
- package/dist/devices/extractorHood.d.ts.map +0 -1
- package/dist/devices/extractorHood.js.map +0 -1
- package/dist/devices/heatPump.d.ts.map +0 -1
- package/dist/devices/heatPump.js.map +0 -1
- package/dist/devices/laundryDryer.d.ts.map +0 -1
- package/dist/devices/laundryDryer.js.map +0 -1
- package/dist/devices/laundryWasher.d.ts.map +0 -1
- package/dist/devices/laundryWasher.js.map +0 -1
- package/dist/devices/microwaveOven.d.ts.map +0 -1
- package/dist/devices/microwaveOven.js.map +0 -1
- package/dist/devices/oven.d.ts.map +0 -1
- package/dist/devices/oven.js.map +0 -1
- package/dist/devices/refrigerator.d.ts.map +0 -1
- package/dist/devices/refrigerator.js.map +0 -1
- package/dist/devices/roboticVacuumCleaner.d.ts.map +0 -1
- package/dist/devices/roboticVacuumCleaner.js.map +0 -1
- package/dist/devices/solarPower.d.ts.map +0 -1
- package/dist/devices/solarPower.js.map +0 -1
- package/dist/devices/speaker.d.ts.map +0 -1
- package/dist/devices/speaker.js.map +0 -1
- package/dist/devices/temperatureControl.d.ts.map +0 -1
- package/dist/devices/temperatureControl.js.map +0 -1
- package/dist/devices/waterHeater.d.ts.map +0 -1
- package/dist/devices/waterHeater.js.map +0 -1
- package/dist/dgram/coap.d.ts +0 -205
- package/dist/dgram/coap.d.ts.map +0 -1
- package/dist/dgram/coap.js +0 -365
- package/dist/dgram/coap.js.map +0 -1
- package/dist/dgram/dgram.d.ts +0 -144
- package/dist/dgram/dgram.d.ts.map +0 -1
- package/dist/dgram/dgram.js +0 -363
- package/dist/dgram/dgram.js.map +0 -1
- package/dist/dgram/mb_coap.d.ts +0 -24
- package/dist/dgram/mb_coap.d.ts.map +0 -1
- package/dist/dgram/mb_coap.js.map +0 -1
- package/dist/dgram/mb_mdns.d.ts +0 -24
- package/dist/dgram/mb_mdns.d.ts.map +0 -1
- package/dist/dgram/mb_mdns.js.map +0 -1
- package/dist/dgram/mdns.d.ts +0 -371
- package/dist/dgram/mdns.d.ts.map +0 -1
- package/dist/dgram/mdns.js +0 -934
- package/dist/dgram/mdns.js.map +0 -1
- package/dist/dgram/multicast.d.ts +0 -67
- package/dist/dgram/multicast.d.ts.map +0 -1
- package/dist/dgram/multicast.js +0 -179
- package/dist/dgram/multicast.js.map +0 -1
- package/dist/dgram/unicast.d.ts +0 -64
- package/dist/dgram/unicast.d.ts.map +0 -1
- package/dist/dgram/unicast.js +0 -100
- package/dist/dgram/unicast.js.map +0 -1
- package/dist/frontend.d.ts.map +0 -1
- package/dist/frontend.js.map +0 -1
- package/dist/frontendTypes.d.ts.map +0 -1
- package/dist/frontendTypes.js.map +0 -1
- package/dist/helpers.d.ts.map +0 -1
- package/dist/helpers.js.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/jestutils/export.d.ts.map +0 -1
- package/dist/jestutils/export.js.map +0 -1
- package/dist/jestutils/jestHelpers.d.ts.map +0 -1
- package/dist/jestutils/jestHelpers.js.map +0 -1
- package/dist/logger/export.d.ts.map +0 -1
- package/dist/logger/export.js.map +0 -1
- package/dist/matter/behaviors.d.ts.map +0 -1
- package/dist/matter/behaviors.js.map +0 -1
- package/dist/matter/clusters.d.ts.map +0 -1
- package/dist/matter/clusters.js.map +0 -1
- package/dist/matter/devices.d.ts.map +0 -1
- package/dist/matter/devices.js.map +0 -1
- package/dist/matter/endpoints.d.ts.map +0 -1
- package/dist/matter/endpoints.js.map +0 -1
- package/dist/matter/export.d.ts.map +0 -1
- package/dist/matter/export.js.map +0 -1
- package/dist/matter/types.d.ts.map +0 -1
- package/dist/matter/types.js.map +0 -1
- package/dist/matterNode.d.ts.map +0 -1
- package/dist/matterNode.js.map +0 -1
- package/dist/matterbridge.d.ts.map +0 -1
- package/dist/matterbridge.js.map +0 -1
- package/dist/matterbridgeAccessoryPlatform.d.ts.map +0 -1
- package/dist/matterbridgeAccessoryPlatform.js.map +0 -1
- package/dist/matterbridgeBehaviors.d.ts.map +0 -1
- package/dist/matterbridgeBehaviors.js.map +0 -1
- package/dist/matterbridgeDeviceTypes.d.ts.map +0 -1
- package/dist/matterbridgeDeviceTypes.js.map +0 -1
- package/dist/matterbridgeDynamicPlatform.d.ts.map +0 -1
- package/dist/matterbridgeDynamicPlatform.js.map +0 -1
- package/dist/matterbridgeEndpoint.d.ts.map +0 -1
- package/dist/matterbridgeEndpoint.js.map +0 -1
- package/dist/matterbridgeEndpointHelpers.d.ts.map +0 -1
- package/dist/matterbridgeEndpointHelpers.js.map +0 -1
- package/dist/matterbridgeEndpointTypes.d.ts.map +0 -1
- package/dist/matterbridgeEndpointTypes.js.map +0 -1
- package/dist/matterbridgePlatform.d.ts.map +0 -1
- package/dist/matterbridgePlatform.js.map +0 -1
- package/dist/matterbridgeTypes.d.ts.map +0 -1
- package/dist/matterbridgeTypes.js.map +0 -1
- package/dist/pluginManager.d.ts.map +0 -1
- package/dist/pluginManager.js.map +0 -1
- package/dist/shelly.d.ts.map +0 -1
- package/dist/shelly.js.map +0 -1
- package/dist/storage/export.d.ts.map +0 -1
- package/dist/storage/export.js.map +0 -1
- package/dist/update.d.ts.map +0 -1
- package/dist/update.js.map +0 -1
- package/dist/utils/colorUtils.d.ts +0 -101
- package/dist/utils/colorUtils.d.ts.map +0 -1
- package/dist/utils/colorUtils.js +0 -282
- package/dist/utils/colorUtils.js.map +0 -1
- package/dist/utils/commandLine.d.ts +0 -66
- package/dist/utils/commandLine.d.ts.map +0 -1
- package/dist/utils/commandLine.js +0 -123
- package/dist/utils/commandLine.js.map +0 -1
- package/dist/utils/copyDirectory.d.ts +0 -35
- package/dist/utils/copyDirectory.d.ts.map +0 -1
- package/dist/utils/copyDirectory.js +0 -76
- package/dist/utils/copyDirectory.js.map +0 -1
- package/dist/utils/createDirectory.d.ts +0 -34
- package/dist/utils/createDirectory.d.ts.map +0 -1
- package/dist/utils/createDirectory.js +0 -54
- package/dist/utils/createDirectory.js.map +0 -1
- package/dist/utils/createZip.d.ts +0 -39
- package/dist/utils/createZip.d.ts.map +0 -1
- package/dist/utils/createZip.js +0 -114
- package/dist/utils/createZip.js.map +0 -1
- package/dist/utils/deepCopy.d.ts +0 -32
- package/dist/utils/deepCopy.d.ts.map +0 -1
- package/dist/utils/deepCopy.js +0 -79
- package/dist/utils/deepCopy.js.map +0 -1
- package/dist/utils/deepEqual.d.ts +0 -54
- package/dist/utils/deepEqual.d.ts.map +0 -1
- package/dist/utils/deepEqual.js +0 -129
- package/dist/utils/deepEqual.js.map +0 -1
- package/dist/utils/error.d.ts +0 -45
- package/dist/utils/error.d.ts.map +0 -1
- package/dist/utils/error.js +0 -54
- package/dist/utils/error.js.map +0 -1
- package/dist/utils/export.d.ts.map +0 -1
- package/dist/utils/export.js.map +0 -1
- package/dist/utils/format.d.ts +0 -53
- package/dist/utils/format.d.ts.map +0 -1
- package/dist/utils/format.js +0 -78
- package/dist/utils/format.js.map +0 -1
- package/dist/utils/hex.d.ts +0 -89
- package/dist/utils/hex.d.ts.map +0 -1
- package/dist/utils/hex.js +0 -242
- package/dist/utils/hex.js.map +0 -1
- package/dist/utils/inspector.d.ts +0 -87
- package/dist/utils/inspector.d.ts.map +0 -1
- package/dist/utils/inspector.js +0 -268
- package/dist/utils/inspector.js.map +0 -1
- package/dist/utils/isValid.d.ts +0 -103
- package/dist/utils/isValid.d.ts.map +0 -1
- package/dist/utils/isValid.js +0 -162
- package/dist/utils/isValid.js.map +0 -1
- package/dist/utils/network.d.ts +0 -141
- package/dist/utils/network.d.ts.map +0 -1
- package/dist/utils/network.js +0 -314
- package/dist/utils/network.js.map +0 -1
- package/dist/utils/spawn.d.ts +0 -33
- package/dist/utils/spawn.d.ts.map +0 -1
- package/dist/utils/spawn.js.map +0 -1
- package/dist/utils/tracker.d.ts +0 -108
- package/dist/utils/tracker.d.ts.map +0 -1
- package/dist/utils/tracker.js +0 -264
- package/dist/utils/tracker.js.map +0 -1
- package/dist/utils/wait.d.ts +0 -54
- package/dist/utils/wait.d.ts.map +0 -1
- package/dist/utils/wait.js +0 -125
- package/dist/utils/wait.js.map +0 -1
- package/dist/workerGlobalPrefix.d.ts.map +0 -1
- package/dist/workerGlobalPrefix.js.map +0 -1
- package/dist/workerTypes.d.ts.map +0 -1
- package/dist/workerTypes.js.map +0 -1
- package/dist/workers.d.ts.map +0 -1
- package/dist/workers.js.map +0 -1
|
@@ -1,26 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @description This file contains the WaterHeater class.
|
|
3
|
-
* @file src/devices/waterHeater.ts
|
|
4
|
-
* @author Luca Liguori
|
|
5
|
-
* @contributor Ludovic BOUÉ
|
|
6
|
-
* @created 2025-05-18
|
|
7
|
-
* @version 1.1.0
|
|
8
|
-
* @license Apache-2.0
|
|
9
|
-
*
|
|
10
|
-
* Copyright 2025, 2026, 2027 Luca Liguori.
|
|
11
|
-
*
|
|
12
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
13
|
-
* you may not use this file except in compliance with the License.
|
|
14
|
-
* You may obtain a copy of the License at
|
|
15
|
-
*
|
|
16
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
17
|
-
*
|
|
18
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
19
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
20
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
21
|
-
* See the License for the specific language governing permissions and
|
|
22
|
-
* limitations under the License.
|
|
23
|
-
*/
|
|
24
1
|
import { MaybePromise } from '@matter/general';
|
|
25
2
|
import { ModeBase } from '@matter/types/clusters/mode-base';
|
|
26
3
|
import { WaterHeaterManagement } from '@matter/types/clusters/water-heater-management';
|
|
@@ -29,29 +6,6 @@ import { WaterHeaterManagementServer } from '@matter/node/behaviors/water-heater
|
|
|
29
6
|
import { WaterHeaterModeServer } from '@matter/node/behaviors/water-heater-mode';
|
|
30
7
|
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
|
|
31
8
|
export declare class WaterHeater extends MatterbridgeEndpoint {
|
|
32
|
-
/**
|
|
33
|
-
* Creates an instance of the WaterHeater class.
|
|
34
|
-
*
|
|
35
|
-
* @param {string} name - The name of the water heater.
|
|
36
|
-
* @param {string} serial - The serial number of the water heater.
|
|
37
|
-
* @param {number} [waterTemperature] - The current water temperature. Defaults to 50.
|
|
38
|
-
* @param {number} [targetWaterTemperature] - The target water temperature. Defaults to 55.
|
|
39
|
-
* @param {number} [minHeatSetpointLimit] - The minimum heat setpoint limit. Defaults to 20.
|
|
40
|
-
* @param {number} [maxHeatSetpointLimit] - The maximum heat setpoint limit. Defaults to 80.
|
|
41
|
-
* @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heaterTypes] - Indicates the heat sources that the water heater can call on for heating. Defaults to { immersionElement1: true }.
|
|
42
|
-
* @param {boolean} heaterTypes.immersionElement1 - Indicates if the water heater has an immersion element 1. Defaults to true.
|
|
43
|
-
* @param {boolean} heaterTypes.immersionElement2 - Indicates if the water heater has an immersion element 2.
|
|
44
|
-
* @param {boolean} heaterTypes.heatPump - Indicates if the water heater has a heat pump.
|
|
45
|
-
* @param {boolean} heaterTypes.boiler - Indicates if the water heater has a boiler.
|
|
46
|
-
* @param {boolean} heaterTypes.other - Indicates if the water heater has other types of heating sources.
|
|
47
|
-
* @param {number} [tankPercentage] - The current tank percentage of the WaterHeaterManagement cluster. Defaults to 90.
|
|
48
|
-
* @param {number} [voltage] - The voltage value in millivolts. Defaults to null if not provided.
|
|
49
|
-
* @param {number} [current] - The current value in milliamperes. Defaults to null if not provided.
|
|
50
|
-
* @param {number} [power] - The power value in milliwatts. Defaults to null if not provided.
|
|
51
|
-
* @param {number} [energy] - The total consumption value in mW/h. Defaults to null if not provided.
|
|
52
|
-
* @param {number} [absMinPower] - Indicate the minimum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
|
|
53
|
-
* @param {number} [absMaxPower] - Indicate the maximum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
|
|
54
|
-
*/
|
|
55
9
|
constructor(name: string, serial: string, waterTemperature?: number, targetWaterTemperature?: number, minHeatSetpointLimit?: number, maxHeatSetpointLimit?: number, heaterTypes?: {
|
|
56
10
|
immersionElement1?: boolean;
|
|
57
11
|
immersionElement2?: boolean;
|
|
@@ -59,25 +13,6 @@ export declare class WaterHeater extends MatterbridgeEndpoint {
|
|
|
59
13
|
boiler?: boolean;
|
|
60
14
|
other?: boolean;
|
|
61
15
|
}, tankPercentage?: number, voltage?: number | bigint | null, current?: number | bigint | null, power?: number | bigint | null, energy?: number | bigint | null, absMinPower?: number, absMaxPower?: number);
|
|
62
|
-
/**
|
|
63
|
-
* Creates a default WaterHeaterManagement Cluster Server.
|
|
64
|
-
*
|
|
65
|
-
* @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heaterTypes] - Indicates the heat sources that the water heater can call on for heating. Defaults to { immersionElement1: true }.
|
|
66
|
-
* @param {boolean} heaterTypes.immersionElement1 - Indicates if the water heater has an immersion element 1. Defaults to true.
|
|
67
|
-
* @param {boolean} heaterTypes.immersionElement2 - Indicates if the water heater has an immersion element 2.
|
|
68
|
-
* @param {boolean} heaterTypes.heatPump - Indicates if the water heater has a heat pump.
|
|
69
|
-
* @param {boolean} heaterTypes.boiler - Indicates if the water heater has a boiler.
|
|
70
|
-
* @param {boolean} heaterTypes.other - Indicates if the water heater has other types of heating sources.
|
|
71
|
-
* @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heatDemand] - Indicates if the water heater is heating water. Defaults to all heat sources unset.
|
|
72
|
-
* @param {boolean} heatDemand.immersionElement1 - Indicates if the water heater is heating water with immersion element 1. Defaults to false.
|
|
73
|
-
* @param {boolean} heatDemand.immersionElement2 - Indicates if the water heater is heating water with immersion element 2.
|
|
74
|
-
* @param {boolean} heatDemand.heatPump - Indicates if the water heater is heating water with a heat pump.
|
|
75
|
-
* @param {boolean} heatDemand.boiler - Indicates if the water heater is heating water with a boiler.
|
|
76
|
-
* @param {boolean} heatDemand.other - Indicates if the water heater is heating water with other types of heating sources.
|
|
77
|
-
* @param {number} [tankPercentage] - The current tank percentage of the WaterHeaterManagement cluster. Defaults to 100.
|
|
78
|
-
* @param {WaterHeaterManagement.BoostState} [boostState] - The current boost state of the WaterHeaterManagement cluster. Defaults to Inactive.
|
|
79
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
80
|
-
*/
|
|
81
16
|
createDefaultWaterHeaterManagementClusterServer(heaterTypes?: {
|
|
82
17
|
immersionElement1?: boolean;
|
|
83
18
|
immersionElement2?: boolean;
|
|
@@ -91,14 +26,6 @@ export declare class WaterHeater extends MatterbridgeEndpoint {
|
|
|
91
26
|
boiler?: boolean;
|
|
92
27
|
other?: boolean;
|
|
93
28
|
}, tankPercentage?: number, boostState?: WaterHeaterManagement.BoostState): this;
|
|
94
|
-
/**
|
|
95
|
-
* Creates a default WaterHeaterMode Cluster Server.
|
|
96
|
-
*
|
|
97
|
-
* @param {number} [currentMode] - The current mode of the WaterHeaterMode cluster. Defaults to mode 1 (WaterHeaterMode.ModeTag.Auto).
|
|
98
|
-
* @param {WaterHeaterMode.ModeOption[]} [supportedModes] - The supported modes for the WaterHeaterMode cluster. Defaults all cluster modes.
|
|
99
|
-
*
|
|
100
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
101
|
-
*/
|
|
102
29
|
createDefaultWaterHeaterModeClusterServer(currentMode?: number, supportedModes?: WaterHeaterMode.ModeOption[]): this;
|
|
103
30
|
}
|
|
104
31
|
export declare class MatterbridgeWaterHeaterManagementServer extends WaterHeaterManagementServer {
|
|
@@ -108,4 +35,3 @@ export declare class MatterbridgeWaterHeaterManagementServer extends WaterHeater
|
|
|
108
35
|
export declare class MatterbridgeWaterHeaterModeServer extends WaterHeaterModeServer {
|
|
109
36
|
changeToMode(request: ModeBase.ChangeToModeRequest): MaybePromise<ModeBase.ChangeToModeResponse>;
|
|
110
37
|
}
|
|
111
|
-
//# sourceMappingURL=waterHeater.d.ts.map
|
|
@@ -1,26 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @description This file contains the WaterHeater class.
|
|
3
|
-
* @file src/devices/waterHeater.ts
|
|
4
|
-
* @author Luca Liguori
|
|
5
|
-
* @contributor Ludovic BOUÉ
|
|
6
|
-
* @created 2025-05-18
|
|
7
|
-
* @version 1.1.0
|
|
8
|
-
* @license Apache-2.0
|
|
9
|
-
*
|
|
10
|
-
* Copyright 2025, 2026, 2027 Luca Liguori.
|
|
11
|
-
*
|
|
12
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
13
|
-
* you may not use this file except in compliance with the License.
|
|
14
|
-
* You may obtain a copy of the License at
|
|
15
|
-
*
|
|
16
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
17
|
-
*
|
|
18
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
19
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
20
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
21
|
-
* See the License for the specific language governing permissions and
|
|
22
|
-
* limitations under the License.
|
|
23
|
-
*/
|
|
24
1
|
import { ModeBase } from '@matter/types/clusters/mode-base';
|
|
25
2
|
import { WaterHeaterManagement } from '@matter/types/clusters/water-heater-management';
|
|
26
3
|
import { WaterHeaterMode } from '@matter/types/clusters/water-heater-mode';
|
|
@@ -31,29 +8,6 @@ import { MatterbridgeServer } from '../matterbridgeBehaviors.js';
|
|
|
31
8
|
import { electricalSensor, powerSource, waterHeater } from '../matterbridgeDeviceTypes.js';
|
|
32
9
|
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
|
|
33
10
|
export class WaterHeater extends MatterbridgeEndpoint {
|
|
34
|
-
/**
|
|
35
|
-
* Creates an instance of the WaterHeater class.
|
|
36
|
-
*
|
|
37
|
-
* @param {string} name - The name of the water heater.
|
|
38
|
-
* @param {string} serial - The serial number of the water heater.
|
|
39
|
-
* @param {number} [waterTemperature] - The current water temperature. Defaults to 50.
|
|
40
|
-
* @param {number} [targetWaterTemperature] - The target water temperature. Defaults to 55.
|
|
41
|
-
* @param {number} [minHeatSetpointLimit] - The minimum heat setpoint limit. Defaults to 20.
|
|
42
|
-
* @param {number} [maxHeatSetpointLimit] - The maximum heat setpoint limit. Defaults to 80.
|
|
43
|
-
* @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heaterTypes] - Indicates the heat sources that the water heater can call on for heating. Defaults to { immersionElement1: true }.
|
|
44
|
-
* @param {boolean} heaterTypes.immersionElement1 - Indicates if the water heater has an immersion element 1. Defaults to true.
|
|
45
|
-
* @param {boolean} heaterTypes.immersionElement2 - Indicates if the water heater has an immersion element 2.
|
|
46
|
-
* @param {boolean} heaterTypes.heatPump - Indicates if the water heater has a heat pump.
|
|
47
|
-
* @param {boolean} heaterTypes.boiler - Indicates if the water heater has a boiler.
|
|
48
|
-
* @param {boolean} heaterTypes.other - Indicates if the water heater has other types of heating sources.
|
|
49
|
-
* @param {number} [tankPercentage] - The current tank percentage of the WaterHeaterManagement cluster. Defaults to 90.
|
|
50
|
-
* @param {number} [voltage] - The voltage value in millivolts. Defaults to null if not provided.
|
|
51
|
-
* @param {number} [current] - The current value in milliamperes. Defaults to null if not provided.
|
|
52
|
-
* @param {number} [power] - The power value in milliwatts. Defaults to null if not provided.
|
|
53
|
-
* @param {number} [energy] - The total consumption value in mW/h. Defaults to null if not provided.
|
|
54
|
-
* @param {number} [absMinPower] - Indicate the minimum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
|
|
55
|
-
* @param {number} [absMaxPower] - Indicate the maximum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
|
|
56
|
-
*/
|
|
57
11
|
constructor(name, serial, waterTemperature = 50, targetWaterTemperature = 55, minHeatSetpointLimit = 20, maxHeatSetpointLimit = 80, heaterTypes = { immersionElement1: true }, tankPercentage = 90, voltage = null, current = null, power = null, energy = null, absMinPower = 0, absMaxPower = 0) {
|
|
58
12
|
super([waterHeater, powerSource, electricalSensor], { id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` });
|
|
59
13
|
this.createDefaultIdentifyClusterServer()
|
|
@@ -68,42 +22,15 @@ export class WaterHeater extends MatterbridgeEndpoint {
|
|
|
68
22
|
.createDefaultDeviceEnergyManagementClusterServer(DeviceEnergyManagement.EsaType.WaterHeating, true, DeviceEnergyManagement.EsaState.Online, absMinPower, absMaxPower)
|
|
69
23
|
.createDefaultDeviceEnergyManagementModeClusterServer();
|
|
70
24
|
}
|
|
71
|
-
/**
|
|
72
|
-
* Creates a default WaterHeaterManagement Cluster Server.
|
|
73
|
-
*
|
|
74
|
-
* @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heaterTypes] - Indicates the heat sources that the water heater can call on for heating. Defaults to { immersionElement1: true }.
|
|
75
|
-
* @param {boolean} heaterTypes.immersionElement1 - Indicates if the water heater has an immersion element 1. Defaults to true.
|
|
76
|
-
* @param {boolean} heaterTypes.immersionElement2 - Indicates if the water heater has an immersion element 2.
|
|
77
|
-
* @param {boolean} heaterTypes.heatPump - Indicates if the water heater has a heat pump.
|
|
78
|
-
* @param {boolean} heaterTypes.boiler - Indicates if the water heater has a boiler.
|
|
79
|
-
* @param {boolean} heaterTypes.other - Indicates if the water heater has other types of heating sources.
|
|
80
|
-
* @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heatDemand] - Indicates if the water heater is heating water. Defaults to all heat sources unset.
|
|
81
|
-
* @param {boolean} heatDemand.immersionElement1 - Indicates if the water heater is heating water with immersion element 1. Defaults to false.
|
|
82
|
-
* @param {boolean} heatDemand.immersionElement2 - Indicates if the water heater is heating water with immersion element 2.
|
|
83
|
-
* @param {boolean} heatDemand.heatPump - Indicates if the water heater is heating water with a heat pump.
|
|
84
|
-
* @param {boolean} heatDemand.boiler - Indicates if the water heater is heating water with a boiler.
|
|
85
|
-
* @param {boolean} heatDemand.other - Indicates if the water heater is heating water with other types of heating sources.
|
|
86
|
-
* @param {number} [tankPercentage] - The current tank percentage of the WaterHeaterManagement cluster. Defaults to 100.
|
|
87
|
-
* @param {WaterHeaterManagement.BoostState} [boostState] - The current boost state of the WaterHeaterManagement cluster. Defaults to Inactive.
|
|
88
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
89
|
-
*/
|
|
90
25
|
createDefaultWaterHeaterManagementClusterServer(heaterTypes, heatDemand, tankPercentage, boostState) {
|
|
91
26
|
this.behaviors.require(MatterbridgeWaterHeaterManagementServer.with(WaterHeaterManagement.Feature.TankPercent), {
|
|
92
|
-
heaterTypes: heaterTypes ?? { immersionElement1: true },
|
|
27
|
+
heaterTypes: heaterTypes ?? { immersionElement1: true },
|
|
93
28
|
heatDemand: heatDemand ?? {},
|
|
94
29
|
tankPercentage: tankPercentage ?? 100,
|
|
95
30
|
boostState: boostState ?? WaterHeaterManagement.BoostState.Inactive,
|
|
96
31
|
});
|
|
97
32
|
return this;
|
|
98
33
|
}
|
|
99
|
-
/**
|
|
100
|
-
* Creates a default WaterHeaterMode Cluster Server.
|
|
101
|
-
*
|
|
102
|
-
* @param {number} [currentMode] - The current mode of the WaterHeaterMode cluster. Defaults to mode 1 (WaterHeaterMode.ModeTag.Auto).
|
|
103
|
-
* @param {WaterHeaterMode.ModeOption[]} [supportedModes] - The supported modes for the WaterHeaterMode cluster. Defaults all cluster modes.
|
|
104
|
-
*
|
|
105
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
106
|
-
*/
|
|
107
34
|
createDefaultWaterHeaterModeClusterServer(currentMode, supportedModes) {
|
|
108
35
|
this.behaviors.require(MatterbridgeWaterHeaterModeServer, {
|
|
109
36
|
supportedModes: supportedModes ?? [
|
|
@@ -120,7 +47,7 @@ export class WaterHeater extends MatterbridgeEndpoint {
|
|
|
120
47
|
{ label: 'Off', mode: 11, modeTags: [{ value: WaterHeaterMode.ModeTag.Off }] },
|
|
121
48
|
{ label: 'Manual', mode: 12, modeTags: [{ value: WaterHeaterMode.ModeTag.Manual }] },
|
|
122
49
|
{ label: 'Timed', mode: 13, modeTags: [{ value: WaterHeaterMode.ModeTag.Timed }] },
|
|
123
|
-
],
|
|
50
|
+
],
|
|
124
51
|
currentMode: currentMode ?? 1,
|
|
125
52
|
});
|
|
126
53
|
return this;
|
|
@@ -133,9 +60,6 @@ export class MatterbridgeWaterHeaterManagementServer extends WaterHeaterManageme
|
|
|
133
60
|
device.commandHandler.executeHandler('boost', { request, cluster: WaterHeaterManagementServer.id, attributes: this.state, endpoint: this.endpoint });
|
|
134
61
|
device.log.debug(`MatterbridgeWaterHeaterManagementServer boost called with: ${JSON.stringify(request)}`);
|
|
135
62
|
this.state.boostState = WaterHeaterManagement.BoostState.Active;
|
|
136
|
-
// The implementation is responsible for setting the device accordingly with the boostInfo of the boost command
|
|
137
|
-
// super.boost({ boostInfo });
|
|
138
|
-
// boost is not implemented in matter.js
|
|
139
63
|
}
|
|
140
64
|
cancelBoost() {
|
|
141
65
|
const device = this.endpoint.stateOf(MatterbridgeServer);
|
|
@@ -143,9 +67,6 @@ export class MatterbridgeWaterHeaterManagementServer extends WaterHeaterManageme
|
|
|
143
67
|
device.commandHandler.executeHandler('cancelBoost', { request: {}, cluster: WaterHeaterManagementServer.id, attributes: this.state, endpoint: this.endpoint });
|
|
144
68
|
device.log.debug(`MatterbridgeWaterHeaterManagementServer cancelBoost called`);
|
|
145
69
|
this.state.boostState = WaterHeaterManagement.BoostState.Inactive;
|
|
146
|
-
// The implementation is responsible for setting the device accordingly with the cancelBoost command
|
|
147
|
-
// super.cancelBoost();
|
|
148
|
-
// cancelBoost is not implemented in matter.js
|
|
149
70
|
}
|
|
150
71
|
}
|
|
151
72
|
export class MatterbridgeWaterHeaterModeServer extends WaterHeaterModeServer {
|
|
@@ -163,4 +84,3 @@ export class MatterbridgeWaterHeaterModeServer extends WaterHeaterModeServer {
|
|
|
163
84
|
return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Success' };
|
|
164
85
|
}
|
|
165
86
|
}
|
|
166
|
-
//# sourceMappingURL=waterHeater.js.map
|
package/dist/frontend.d.ts
CHANGED
|
@@ -1,35 +1,9 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file contains the class Frontend.
|
|
3
|
-
*
|
|
4
|
-
* @file frontend.ts
|
|
5
|
-
* @author Luca Liguori
|
|
6
|
-
* @created 2025-01-13
|
|
7
|
-
* @version 1.3.3
|
|
8
|
-
* @license Apache-2.0
|
|
9
|
-
*
|
|
10
|
-
* Copyright 2025, 2026, 2027 Luca Liguori.
|
|
11
|
-
*
|
|
12
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
13
|
-
* you may not use this file except in compliance with the License.
|
|
14
|
-
* You may obtain a copy of the License at
|
|
15
|
-
*
|
|
16
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
17
|
-
*
|
|
18
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
19
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
20
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
21
|
-
* See the License for the specific language governing permissions and
|
|
22
|
-
* limitations under the License.
|
|
23
|
-
*/
|
|
24
1
|
import EventEmitter from 'node:events';
|
|
25
2
|
import { LogLevel } from 'node-ansi-logger';
|
|
26
3
|
import { EndpointNumber } from '@matter/types/datatype';
|
|
27
4
|
import type { ApiMatter } from './matterbridgeTypes.js';
|
|
28
5
|
import type { Matterbridge } from './matterbridge.js';
|
|
29
6
|
import type { RefreshRequiredChanged, WsMessageBroadcast } from './frontendTypes.js';
|
|
30
|
-
/**
|
|
31
|
-
* Represents the Frontend events.
|
|
32
|
-
*/
|
|
33
7
|
interface FrontendEvents {
|
|
34
8
|
server_listening: [protocol: string, port: number, address?: string];
|
|
35
9
|
server_error: [error: Error];
|
|
@@ -56,190 +30,29 @@ export declare class Frontend extends EventEmitter<FrontendEvents> {
|
|
|
56
30
|
set logLevel(logLevel: LogLevel);
|
|
57
31
|
start(port?: number): Promise<void>;
|
|
58
32
|
stop(): Promise<void>;
|
|
59
|
-
/**
|
|
60
|
-
* Retrieves the api settings data.
|
|
61
|
-
*
|
|
62
|
-
* @returns {Promise<{ matterbridgeInformation: MatterbridgeInformation, systemInformation: SystemInformation }>} A promise that resolve in the api settings object.
|
|
63
|
-
*/
|
|
64
33
|
private getApiSettings;
|
|
65
|
-
/**
|
|
66
|
-
* Retrieves the reachable attribute.
|
|
67
|
-
*
|
|
68
|
-
* @param {MatterbridgeEndpoint} device - The MatterbridgeEndpoint object.
|
|
69
|
-
* @returns {boolean} The reachable attribute.
|
|
70
|
-
*/
|
|
71
34
|
private getReachability;
|
|
72
|
-
/**
|
|
73
|
-
* Retrieves the power source attribute.
|
|
74
|
-
*
|
|
75
|
-
* @param {MatterbridgeEndpoint} endpoint - The MatterbridgeDevice to retrieve the power source from.
|
|
76
|
-
* @returns {'ac' | 'dc' | 'ok' | 'warning' | 'critical' | undefined} The power source attribute.
|
|
77
|
-
*/
|
|
78
35
|
private getPowerSource;
|
|
79
|
-
/**
|
|
80
|
-
* Retrieves the battery level attribute.
|
|
81
|
-
*
|
|
82
|
-
* @param {MatterbridgeEndpoint} endpoint - The MatterbridgeDevice to retrieve the power source from.
|
|
83
|
-
* @returns {number | undefined} The battery level attribute.
|
|
84
|
-
*/
|
|
85
36
|
private getBatteryLevel;
|
|
86
|
-
/**
|
|
87
|
-
* Retrieves the cluster text description from a given device.
|
|
88
|
-
* The output is a string with the attributes description of the cluster servers in the device to show in the frontend.
|
|
89
|
-
*
|
|
90
|
-
* @param {MatterbridgeEndpoint} device - The MatterbridgeEndpoint to retrieve the cluster text from.
|
|
91
|
-
* @returns {string} The attributes description of the cluster servers in the device.
|
|
92
|
-
*/
|
|
93
37
|
private getClusterTextFromDevice;
|
|
94
|
-
/**
|
|
95
|
-
* Retrieves the registered plugins sanitized for res.json().
|
|
96
|
-
*
|
|
97
|
-
* @returns {ApiPlugin[]} An array of BaseRegisteredPlugin.
|
|
98
|
-
*/
|
|
99
38
|
private getPlugins;
|
|
100
|
-
/**
|
|
101
|
-
* Retrieves the devices from Matterbridge.
|
|
102
|
-
*
|
|
103
|
-
* @param {string} [pluginName] - The name of the plugin to filter devices by.
|
|
104
|
-
* @returns {ApiDevice[]} An array of ApiDevices for the frontend.
|
|
105
|
-
*/
|
|
106
39
|
private getDevices;
|
|
107
|
-
/**
|
|
108
|
-
* Retrieves the clusters from a given plugin and endpoint number.
|
|
109
|
-
*
|
|
110
|
-
* Response for /api/clusters
|
|
111
|
-
*
|
|
112
|
-
* @param {string} pluginName - The name of the plugin.
|
|
113
|
-
* @param {number} endpointNumber - The endpoint number.
|
|
114
|
-
* @returns {ApiClusters | undefined} A promise that resolves to the clusters or undefined if not found.
|
|
115
|
-
*/
|
|
116
40
|
private getClusters;
|
|
117
41
|
private generateDiagnostic;
|
|
118
|
-
/**
|
|
119
|
-
* Handles incoming websocket api request messages from the Matterbridge frontend.
|
|
120
|
-
*
|
|
121
|
-
* @param {WebSocket} client - The websocket client that sent the message.
|
|
122
|
-
* @param {WebSocket.RawData} message - The raw data of the message received from the client.
|
|
123
|
-
* @returns {Promise<void>} A promise that resolves when the message has been handled.
|
|
124
|
-
*/
|
|
125
42
|
private wsMessageHandler;
|
|
126
|
-
/**
|
|
127
|
-
* Sends a WebSocket log message to all connected clients. The function is called by AnsiLogger.setGlobalCallback.
|
|
128
|
-
*
|
|
129
|
-
* @param {string} level - The logger level of the message: debug info notice warn error fatal...
|
|
130
|
-
* @param {string} time - The time string of the message
|
|
131
|
-
* @param {string} name - The logger name of the message
|
|
132
|
-
* @param {string} message - The content of the message.
|
|
133
|
-
*
|
|
134
|
-
* @remarks
|
|
135
|
-
* The function removes ANSI escape codes, leading asterisks, non-printable characters, and replaces all occurrences of \t and \n.
|
|
136
|
-
* It also replaces all occurrences of \" with " and angle-brackets with < and >.
|
|
137
|
-
* The function sends the message to all connected clients.
|
|
138
|
-
*/
|
|
139
43
|
wssSendLogMessage(level: string, time: string, name: string, message: string): void;
|
|
140
|
-
/**
|
|
141
|
-
* Sends a need to refresh WebSocket message to all connected clients.
|
|
142
|
-
*
|
|
143
|
-
* @param {string} changed - The changed value.
|
|
144
|
-
* @param {Record<string, unknown>} params - Additional parameters to send with the message.
|
|
145
|
-
* possible values for changed:
|
|
146
|
-
* - 'settings' (when the bridge has started in bridge mode or childbridge mode and when update finds a new version)
|
|
147
|
-
* - 'plugins'
|
|
148
|
-
* - 'devices'
|
|
149
|
-
* - 'matter' with param 'matter' (QRDiv component)
|
|
150
|
-
* @param {ApiMatter} params.matter - The matter device that has changed. Required if changed is 'matter'.
|
|
151
|
-
*/
|
|
152
44
|
wssSendRefreshRequired(changed: RefreshRequiredChanged, params?: {
|
|
153
45
|
matter: ApiMatter;
|
|
154
46
|
}): void;
|
|
155
|
-
/**
|
|
156
|
-
* Sends a need to restart WebSocket message to all connected clients.
|
|
157
|
-
*
|
|
158
|
-
* @param {boolean} snackbar - If true, a snackbar message will be sent to all connected clients. Default is true.
|
|
159
|
-
* @param {boolean} fixed - If true, the restart is fixed and will not be reset by plugin restarts. Default is false.
|
|
160
|
-
*/
|
|
161
47
|
wssSendRestartRequired(snackbar?: boolean, fixed?: boolean): void;
|
|
162
|
-
/**
|
|
163
|
-
* Sends a no need to restart WebSocket message to all connected clients.
|
|
164
|
-
*
|
|
165
|
-
* @param {boolean} snackbar - If true, the snackbar message will be cleared from all connected clients. Default is true.
|
|
166
|
-
*/
|
|
167
48
|
wssSendRestartNotRequired(snackbar?: boolean): void;
|
|
168
|
-
/**
|
|
169
|
-
* Sends a need to update WebSocket message to all connected clients.
|
|
170
|
-
*
|
|
171
|
-
* @param {boolean} devVersion - If true, the update is for a development version. Default is false.
|
|
172
|
-
*/
|
|
173
49
|
wssSendUpdateRequired(devVersion?: boolean): void;
|
|
174
|
-
/**
|
|
175
|
-
* Sends a cpu update message to all connected clients.
|
|
176
|
-
*
|
|
177
|
-
* @param {number} cpuUsage - The CPU usage percentage to send.
|
|
178
|
-
* @param {number} processCpuUsage - The CPU usage percentage of the process to send.
|
|
179
|
-
*/
|
|
180
50
|
wssSendCpuUpdate(cpuUsage: number, processCpuUsage: number): void;
|
|
181
|
-
/**
|
|
182
|
-
* Sends a memory update message to all connected clients.
|
|
183
|
-
*
|
|
184
|
-
* @param {string} totalMemory - The total memory in bytes.
|
|
185
|
-
* @param {string} freeMemory - The free memory in bytes.
|
|
186
|
-
* @param {string} rss - The resident set size in bytes.
|
|
187
|
-
* @param {string} heapTotal - The total heap memory in bytes.
|
|
188
|
-
* @param {string} heapUsed - The used heap memory in bytes.
|
|
189
|
-
* @param {string} external - The external memory in bytes.
|
|
190
|
-
* @param {string} arrayBuffers - The array buffers memory in bytes.
|
|
191
|
-
*/
|
|
192
51
|
wssSendMemoryUpdate(totalMemory: string, freeMemory: string, rss: string, heapTotal: string, heapUsed: string, external: string, arrayBuffers: string): void;
|
|
193
|
-
/**
|
|
194
|
-
* Sends an uptime update message to all connected clients.
|
|
195
|
-
*
|
|
196
|
-
* @param {string} systemUptime - The system uptime in a human-readable format.
|
|
197
|
-
* @param {string} processUptime - The process uptime in a human-readable format.
|
|
198
|
-
*/
|
|
199
52
|
wssSendUptimeUpdate(systemUptime: string, processUptime: string): void;
|
|
200
|
-
/**
|
|
201
|
-
* Sends an open snackbar message to all connected clients.
|
|
202
|
-
*
|
|
203
|
-
* @param {string} message - The message to send.
|
|
204
|
-
* @param {number} timeout - The timeout in seconds for the snackbar message. Default is 5 seconds.
|
|
205
|
-
* @param {'info' | 'warning' | 'error' | 'success'} severity - The severity of the message.
|
|
206
|
-
* possible values are: 'info', 'warning', 'error', 'success'. Default is 'info'.
|
|
207
|
-
*
|
|
208
|
-
* @remarks
|
|
209
|
-
* If timeout is 0, the snackbar message will be displayed until closed by the user.
|
|
210
|
-
*/
|
|
211
53
|
wssSendSnackbarMessage(message: string, timeout?: number, severity?: 'info' | 'warning' | 'error' | 'success'): void;
|
|
212
|
-
/**
|
|
213
|
-
* Sends a close snackbar message to all connected clients.
|
|
214
|
-
* It will close the snackbar message with the same message and timeout = 0.
|
|
215
|
-
*
|
|
216
|
-
* @param {string} message - The message to send.
|
|
217
|
-
*/
|
|
218
54
|
wssSendCloseSnackbarMessage(message: string): void;
|
|
219
|
-
/**
|
|
220
|
-
* Sends an attribute update message to all connected WebSocket clients.
|
|
221
|
-
*
|
|
222
|
-
* @param {string | undefined} plugin - The name of the plugin.
|
|
223
|
-
* @param {string | undefined} serialNumber - The serial number of the device.
|
|
224
|
-
* @param {string | undefined} uniqueId - The unique identifier of the device.
|
|
225
|
-
* @param {EndpointNumber} number - The endpoint number where the attribute belongs.
|
|
226
|
-
* @param {string} id - The endpoint id where the attribute belongs.
|
|
227
|
-
* @param {string} cluster - The cluster name where the attribute belongs.
|
|
228
|
-
* @param {string} attribute - The name of the attribute that changed.
|
|
229
|
-
* @param {number | string | boolean} value - The new value of the attribute.
|
|
230
|
-
*
|
|
231
|
-
* @remarks
|
|
232
|
-
* This method logs a debug message and sends a JSON-formatted message to all connected WebSocket clients
|
|
233
|
-
* with the updated attribute information.
|
|
234
|
-
*/
|
|
235
55
|
wssSendAttributeChangedMessage(plugin: string, serialNumber: string, uniqueId: string, number: EndpointNumber, id: string, cluster: string, attribute: string, value: number | string | boolean | null): void;
|
|
236
|
-
/**
|
|
237
|
-
* Sends a message to all connected clients.
|
|
238
|
-
* This is an helper function to send a broadcast message to all connected clients.
|
|
239
|
-
*
|
|
240
|
-
* @param {WsMessageBroadcast} msg - The message to send.
|
|
241
|
-
*/
|
|
242
56
|
wssBroadcastMessage(msg: WsMessageBroadcast): void;
|
|
243
57
|
}
|
|
244
58
|
export {};
|
|
245
|
-
//# sourceMappingURL=frontend.d.ts.map
|