matterbridge 3.4.0 → 3.4.1-dev-20251127-826b2bf
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 +128 -112
- package/README-DEV.md +2 -2
- package/README-DOCKER.md +1 -1
- package/README-MACOS-PLIST.md +1 -1
- package/README-NGINX.md +1 -1
- package/README-PODMAN.md +1 -1
- package/README-SERVICE-LOCAL.md +1 -1
- package/README-SERVICE-OPT.md +6 -1
- package/README-SERVICE.md +1 -1
- package/README.md +57 -49
- package/dist/broadcastServer.js +1 -93
- package/dist/broadcastServerTypes.js +0 -24
- package/dist/cli.js +1 -97
- package/dist/cliEmitter.js +0 -37
- package/dist/cliHistory.js +0 -38
- package/dist/clusters/export.js +0 -2
- package/dist/defaultConfigSchema.js +0 -24
- package/dist/deviceManager.js +1 -113
- package/dist/devices/airConditioner.js +0 -57
- package/dist/devices/batteryStorage.js +1 -48
- package/dist/devices/cooktop.js +0 -56
- package/dist/devices/dishwasher.js +0 -57
- package/dist/devices/evse.js +10 -74
- package/dist/devices/export.js +0 -5
- package/dist/devices/extractorHood.js +0 -43
- package/dist/devices/heatPump.js +2 -50
- package/dist/devices/laundryDryer.js +3 -62
- package/dist/devices/laundryWasher.js +4 -70
- package/dist/devices/microwaveOven.js +5 -88
- package/dist/devices/oven.js +0 -85
- package/dist/devices/refrigerator.js +0 -102
- package/dist/devices/roboticVacuumCleaner.js +9 -100
- package/dist/devices/solarPower.js +0 -38
- package/dist/devices/speaker.js +0 -84
- package/dist/devices/temperatureControl.js +3 -24
- package/dist/devices/waterHeater.js +2 -82
- package/dist/dgram/coap.js +13 -126
- package/dist/dgram/dgram.js +2 -114
- package/dist/dgram/mb_coap.js +3 -41
- package/dist/dgram/mb_mdns.js +15 -80
- package/dist/dgram/mdns.js +137 -299
- package/dist/dgram/multicast.js +1 -62
- package/dist/dgram/unicast.js +0 -54
- package/dist/frontend.js +35 -455
- package/dist/frontendTypes.js +0 -45
- package/dist/helpers.js +0 -53
- package/dist/index.js +0 -25
- package/dist/jestutils/export.js +0 -1
- package/dist/jestutils/jestHelpers.js +13 -352
- package/dist/logger/export.js +0 -1
- package/dist/matter/behaviors.js +0 -2
- package/dist/matter/clusters.js +0 -2
- package/dist/matter/devices.js +0 -2
- package/dist/matter/endpoints.js +0 -2
- package/dist/matter/export.js +0 -3
- package/dist/matter/types.js +0 -3
- package/dist/matterNode.js +8 -369
- package/dist/matterbridge.js +74 -788
- package/dist/matterbridgeAccessoryPlatform.js +0 -38
- package/dist/matterbridgeBehaviors.js +5 -68
- package/dist/matterbridgeDeviceTypes.js +14 -635
- package/dist/matterbridgeDynamicPlatform.js +0 -38
- package/dist/matterbridgeEndpoint.js +53 -1444
- package/dist/matterbridgeEndpointHelpers.js +20 -483
- package/dist/matterbridgeEndpointTypes.js +0 -25
- package/dist/matterbridgePlatform.js +2 -460
- package/dist/matterbridgeTypes.js +0 -26
- package/dist/pluginManager.js +5 -340
- package/dist/shelly.js +7 -168
- package/dist/storage/export.js +0 -1
- package/dist/update.js +0 -69
- package/dist/utils/colorUtils.js +2 -97
- package/dist/utils/commandLine.js +0 -60
- package/dist/utils/copyDirectory.js +0 -37
- package/dist/utils/createDirectory.js +0 -33
- package/dist/utils/createZip.js +2 -47
- package/dist/utils/deepCopy.js +0 -39
- package/dist/utils/deepEqual.js +1 -72
- package/dist/utils/error.js +0 -41
- package/dist/utils/export.js +0 -1
- package/dist/utils/format.js +0 -49
- package/dist/utils/hex.js +0 -124
- package/dist/utils/inspector.js +1 -69
- package/dist/utils/isvalid.js +0 -101
- package/dist/utils/network.js +5 -96
- package/dist/utils/spawn.js +1 -71
- package/dist/utils/tracker.js +1 -64
- package/dist/utils/wait.js +8 -60
- package/frontend/build/assets/index.js +4 -4
- package/frontend/build/assets/vendor_mui.js +1 -1
- package/frontend/build/assets/vendor_node_modules.js +19 -83
- package/frontend/build/assets/vendor_qrcode.js +1 -9
- package/frontend/build/assets/vendor_rjsf.js +1 -9
- package/frontend/package-lock.json +229 -439
- package/frontend/package.json +15 -15
- package/marked.ps1 +15 -0
- package/npm-shrinkwrap.json +165 -231
- package/package.json +2 -3
- package/dist/broadcastServer.d.ts +0 -115
- package/dist/broadcastServer.d.ts.map +0 -1
- package/dist/broadcastServer.js.map +0 -1
- package/dist/broadcastServerTypes.d.ts +0 -838
- package/dist/broadcastServerTypes.d.ts.map +0 -1
- package/dist/broadcastServerTypes.js.map +0 -1
- package/dist/cli.d.ts +0 -30
- package/dist/cli.d.ts.map +0 -1
- package/dist/cli.js.map +0 -1
- package/dist/cliEmitter.d.ts +0 -50
- package/dist/cliEmitter.d.ts.map +0 -1
- package/dist/cliEmitter.js.map +0 -1
- package/dist/cliHistory.d.ts +0 -48
- package/dist/cliHistory.d.ts.map +0 -1
- package/dist/cliHistory.js.map +0 -1
- package/dist/clusters/export.d.ts +0 -2
- package/dist/clusters/export.d.ts.map +0 -1
- package/dist/clusters/export.js.map +0 -1
- package/dist/defaultConfigSchema.d.ts +0 -28
- package/dist/defaultConfigSchema.d.ts.map +0 -1
- package/dist/defaultConfigSchema.js.map +0 -1
- package/dist/deviceManager.d.ts +0 -135
- package/dist/deviceManager.d.ts.map +0 -1
- package/dist/deviceManager.js.map +0 -1
- package/dist/devices/airConditioner.d.ts +0 -98
- package/dist/devices/airConditioner.d.ts.map +0 -1
- package/dist/devices/airConditioner.js.map +0 -1
- package/dist/devices/batteryStorage.d.ts +0 -48
- package/dist/devices/batteryStorage.d.ts.map +0 -1
- package/dist/devices/batteryStorage.js.map +0 -1
- package/dist/devices/cooktop.d.ts +0 -61
- package/dist/devices/cooktop.d.ts.map +0 -1
- package/dist/devices/cooktop.js.map +0 -1
- package/dist/devices/dishwasher.d.ts +0 -71
- package/dist/devices/dishwasher.d.ts.map +0 -1
- package/dist/devices/dishwasher.js.map +0 -1
- package/dist/devices/evse.d.ts +0 -76
- package/dist/devices/evse.d.ts.map +0 -1
- package/dist/devices/evse.js.map +0 -1
- package/dist/devices/export.d.ts +0 -17
- package/dist/devices/export.d.ts.map +0 -1
- package/dist/devices/export.js.map +0 -1
- package/dist/devices/extractorHood.d.ts +0 -46
- package/dist/devices/extractorHood.d.ts.map +0 -1
- package/dist/devices/extractorHood.js.map +0 -1
- package/dist/devices/heatPump.d.ts +0 -47
- package/dist/devices/heatPump.d.ts.map +0 -1
- package/dist/devices/heatPump.js.map +0 -1
- package/dist/devices/laundryDryer.d.ts +0 -67
- package/dist/devices/laundryDryer.d.ts.map +0 -1
- package/dist/devices/laundryDryer.js.map +0 -1
- package/dist/devices/laundryWasher.d.ts +0 -81
- package/dist/devices/laundryWasher.d.ts.map +0 -1
- package/dist/devices/laundryWasher.js.map +0 -1
- package/dist/devices/microwaveOven.d.ts +0 -168
- package/dist/devices/microwaveOven.d.ts.map +0 -1
- package/dist/devices/microwaveOven.js.map +0 -1
- package/dist/devices/oven.d.ts +0 -105
- package/dist/devices/oven.d.ts.map +0 -1
- package/dist/devices/oven.js.map +0 -1
- package/dist/devices/refrigerator.d.ts +0 -118
- package/dist/devices/refrigerator.d.ts.map +0 -1
- package/dist/devices/refrigerator.js.map +0 -1
- package/dist/devices/roboticVacuumCleaner.d.ts +0 -112
- package/dist/devices/roboticVacuumCleaner.d.ts.map +0 -1
- package/dist/devices/roboticVacuumCleaner.js.map +0 -1
- package/dist/devices/solarPower.d.ts +0 -40
- package/dist/devices/solarPower.d.ts.map +0 -1
- package/dist/devices/solarPower.js.map +0 -1
- package/dist/devices/speaker.d.ts +0 -87
- package/dist/devices/speaker.d.ts.map +0 -1
- package/dist/devices/speaker.js.map +0 -1
- package/dist/devices/temperatureControl.d.ts +0 -166
- package/dist/devices/temperatureControl.d.ts.map +0 -1
- package/dist/devices/temperatureControl.js.map +0 -1
- package/dist/devices/waterHeater.d.ts +0 -111
- 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.map +0 -1
- package/dist/dgram/dgram.d.ts +0 -141
- package/dist/dgram/dgram.d.ts.map +0 -1
- 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 -290
- package/dist/dgram/mdns.d.ts.map +0 -1
- 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.map +0 -1
- package/dist/dgram/unicast.d.ts +0 -56
- package/dist/dgram/unicast.d.ts.map +0 -1
- package/dist/dgram/unicast.js.map +0 -1
- package/dist/frontend.d.ts +0 -238
- package/dist/frontend.d.ts.map +0 -1
- package/dist/frontend.js.map +0 -1
- package/dist/frontendTypes.d.ts +0 -529
- package/dist/frontendTypes.d.ts.map +0 -1
- package/dist/frontendTypes.js.map +0 -1
- package/dist/helpers.d.ts +0 -48
- package/dist/helpers.d.ts.map +0 -1
- package/dist/helpers.js.map +0 -1
- package/dist/index.d.ts +0 -34
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/jestutils/export.d.ts +0 -2
- package/dist/jestutils/export.d.ts.map +0 -1
- package/dist/jestutils/export.js.map +0 -1
- package/dist/jestutils/jestHelpers.d.ts +0 -303
- package/dist/jestutils/jestHelpers.d.ts.map +0 -1
- package/dist/jestutils/jestHelpers.js.map +0 -1
- package/dist/logger/export.d.ts +0 -2
- package/dist/logger/export.d.ts.map +0 -1
- package/dist/logger/export.js.map +0 -1
- package/dist/matter/behaviors.d.ts +0 -2
- package/dist/matter/behaviors.d.ts.map +0 -1
- package/dist/matter/behaviors.js.map +0 -1
- package/dist/matter/clusters.d.ts +0 -2
- package/dist/matter/clusters.d.ts.map +0 -1
- package/dist/matter/clusters.js.map +0 -1
- package/dist/matter/devices.d.ts +0 -2
- package/dist/matter/devices.d.ts.map +0 -1
- package/dist/matter/devices.js.map +0 -1
- package/dist/matter/endpoints.d.ts +0 -2
- package/dist/matter/endpoints.d.ts.map +0 -1
- package/dist/matter/endpoints.js.map +0 -1
- package/dist/matter/export.d.ts +0 -5
- package/dist/matter/export.d.ts.map +0 -1
- package/dist/matter/export.js.map +0 -1
- package/dist/matter/types.d.ts +0 -3
- package/dist/matter/types.d.ts.map +0 -1
- package/dist/matter/types.js.map +0 -1
- package/dist/matterNode.d.ts +0 -342
- package/dist/matterNode.d.ts.map +0 -1
- package/dist/matterNode.js.map +0 -1
- package/dist/matterbridge.d.ts +0 -473
- package/dist/matterbridge.d.ts.map +0 -1
- package/dist/matterbridge.js.map +0 -1
- package/dist/matterbridgeAccessoryPlatform.d.ts +0 -41
- package/dist/matterbridgeAccessoryPlatform.d.ts.map +0 -1
- package/dist/matterbridgeAccessoryPlatform.js.map +0 -1
- package/dist/matterbridgeBehaviors.d.ts +0 -2404
- package/dist/matterbridgeBehaviors.d.ts.map +0 -1
- package/dist/matterbridgeBehaviors.js.map +0 -1
- package/dist/matterbridgeDeviceTypes.d.ts +0 -698
- package/dist/matterbridgeDeviceTypes.d.ts.map +0 -1
- package/dist/matterbridgeDeviceTypes.js.map +0 -1
- package/dist/matterbridgeDynamicPlatform.d.ts +0 -41
- package/dist/matterbridgeDynamicPlatform.d.ts.map +0 -1
- package/dist/matterbridgeDynamicPlatform.js.map +0 -1
- package/dist/matterbridgeEndpoint.d.ts +0 -1507
- package/dist/matterbridgeEndpoint.d.ts.map +0 -1
- package/dist/matterbridgeEndpoint.js.map +0 -1
- package/dist/matterbridgeEndpointHelpers.d.ts +0 -787
- package/dist/matterbridgeEndpointHelpers.d.ts.map +0 -1
- package/dist/matterbridgeEndpointHelpers.js.map +0 -1
- package/dist/matterbridgeEndpointTypes.d.ts +0 -166
- package/dist/matterbridgeEndpointTypes.d.ts.map +0 -1
- package/dist/matterbridgeEndpointTypes.js.map +0 -1
- package/dist/matterbridgePlatform.d.ts +0 -524
- package/dist/matterbridgePlatform.d.ts.map +0 -1
- package/dist/matterbridgePlatform.js.map +0 -1
- package/dist/matterbridgeTypes.d.ts +0 -251
- package/dist/matterbridgeTypes.d.ts.map +0 -1
- package/dist/matterbridgeTypes.js.map +0 -1
- package/dist/pluginManager.d.ts +0 -371
- package/dist/pluginManager.d.ts.map +0 -1
- package/dist/pluginManager.js.map +0 -1
- package/dist/shelly.d.ts +0 -174
- package/dist/shelly.d.ts.map +0 -1
- package/dist/shelly.js.map +0 -1
- package/dist/storage/export.d.ts +0 -2
- package/dist/storage/export.d.ts.map +0 -1
- package/dist/storage/export.js.map +0 -1
- package/dist/update.d.ts +0 -75
- 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.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.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.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.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.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.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.map +0 -1
- package/dist/utils/error.d.ts +0 -44
- package/dist/utils/error.d.ts.map +0 -1
- package/dist/utils/error.js.map +0 -1
- package/dist/utils/export.d.ts +0 -13
- 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.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.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.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.map +0 -1
- package/dist/utils/network.d.ts +0 -111
- package/dist/utils/network.d.ts.map +0 -1
- 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.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.map +0 -1
package/dist/devices/cooktop.js
CHANGED
|
@@ -1,45 +1,7 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @description This file contains the Cooktop class.
|
|
3
|
-
* @file src/devices/cooktop.ts
|
|
4
|
-
* @author Luca Liguori
|
|
5
|
-
* @created 2025-05-25
|
|
6
|
-
* @version 1.1.0
|
|
7
|
-
* @license Apache-2.0
|
|
8
|
-
*
|
|
9
|
-
* Copyright 2025, 2026, 2027 Luca Liguori.
|
|
10
|
-
*
|
|
11
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
12
|
-
* you may not use this file except in compliance with the License.
|
|
13
|
-
* You may obtain a copy of the License at
|
|
14
|
-
*
|
|
15
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
16
|
-
*
|
|
17
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
18
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
19
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
20
|
-
* See the License for the specific language governing permissions and
|
|
21
|
-
* limitations under the License.
|
|
22
|
-
*/
|
|
23
|
-
// Matterbridge
|
|
24
1
|
import { cookSurface, cooktop, powerSource } from '../matterbridgeDeviceTypes.js';
|
|
25
2
|
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
|
|
26
3
|
import { createLevelTemperatureControlClusterServer } from './temperatureControl.js';
|
|
27
4
|
export class Cooktop extends MatterbridgeEndpoint {
|
|
28
|
-
/**
|
|
29
|
-
* Creates an instance of the Cooktop class.
|
|
30
|
-
*
|
|
31
|
-
* @param {string} name - The name of the cooktop.
|
|
32
|
-
* @param {string} serial - The serial number of the cooktop.
|
|
33
|
-
*
|
|
34
|
-
* @remarks
|
|
35
|
-
* 13.8 A cooktop is a cooking surface that heats food either by transferring currents from an electromagnetic
|
|
36
|
-
* field located below the glass surface directly to the magnetic induction cookware placed
|
|
37
|
-
* above or through traditional gas or electric burners.
|
|
38
|
-
*
|
|
39
|
-
* 13.8.4 A Cooktop SHALL be composed of zero or more endpoints with the Cook Surface device type.
|
|
40
|
-
* An Cooktop is always defined via endpoint composition.
|
|
41
|
-
* - Use `addSurface` to add one or more surfaces to the cooktop.
|
|
42
|
-
*/
|
|
43
5
|
constructor(name, serial) {
|
|
44
6
|
super([cooktop, powerSource], { id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` });
|
|
45
7
|
this.createDefaultIdentifyClusterServer();
|
|
@@ -48,23 +10,6 @@ export class Cooktop extends MatterbridgeEndpoint {
|
|
|
48
10
|
this.createOffOnlyOnOffClusterServer(true);
|
|
49
11
|
this.addFixedLabel('composed', 'Cooktop');
|
|
50
12
|
}
|
|
51
|
-
/**
|
|
52
|
-
* Adds a surface to the cooktop.
|
|
53
|
-
*
|
|
54
|
-
* @param {string} name - The name of the surface.
|
|
55
|
-
* @param {Semtag[]} tagList - The tagList associated with the surface.
|
|
56
|
-
* @param {number} selectedTemperatureLevel - The selected temperature level as an index of the supportedTemperatureLevels array. Defaults to 2 (which corresponds to 'Level 3').
|
|
57
|
-
* @param {string[]} supportedTemperatureLevels - The list of supported temperature levels for the surface. Defaults to ['Level 1', 'Level 2', 'Level 3', 'Level 4', 'Level 5'].
|
|
58
|
-
*
|
|
59
|
-
* @returns {MatterbridgeEndpoint} The MatterbridgeEndpoint instance representing the surface.
|
|
60
|
-
*
|
|
61
|
-
* @remarks
|
|
62
|
-
* 13.7 A Cook Surface device type represents a heating object on a cooktop or other similar device. It
|
|
63
|
-
* SHALL only be used when composed as part of another device type.
|
|
64
|
-
*
|
|
65
|
-
* The OffOnly feature is required for the On/Off cluster in this device type due to safety requirements.
|
|
66
|
-
* TemperatureLevel is the only valid temperature control mode.
|
|
67
|
-
*/
|
|
68
13
|
addSurface(name, tagList, selectedTemperatureLevel = 2, supportedTemperatureLevels = ['Level 1', 'Level 2', 'Level 3', 'Level 4', 'Level 5']) {
|
|
69
14
|
const surface = this.addChildDeviceType(name, cookSurface, { tagList }, true);
|
|
70
15
|
surface.log.logName = name;
|
|
@@ -74,4 +19,3 @@ export class Cooktop extends MatterbridgeEndpoint {
|
|
|
74
19
|
return surface;
|
|
75
20
|
}
|
|
76
21
|
}
|
|
77
|
-
//# sourceMappingURL=cooktop.js.map
|
|
@@ -1,54 +1,12 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @description This file contains the Dishwasher class.
|
|
3
|
-
* @file src/devices/dishwasher.ts
|
|
4
|
-
* @author Luca Liguori
|
|
5
|
-
* @created 2025-05-25
|
|
6
|
-
* @version 1.1.0
|
|
7
|
-
* @license Apache-2.0
|
|
8
|
-
*
|
|
9
|
-
* Copyright 2025, 2026, 2027 Luca Liguori.
|
|
10
|
-
*
|
|
11
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
12
|
-
* you may not use this file except in compliance with the License.
|
|
13
|
-
* You may obtain a copy of the License at
|
|
14
|
-
*
|
|
15
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
16
|
-
*
|
|
17
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
18
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
19
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
20
|
-
* See the License for the specific language governing permissions and
|
|
21
|
-
* limitations under the License.
|
|
22
|
-
*/
|
|
23
1
|
import { ModeBase } from '@matter/types/clusters/mode-base';
|
|
24
2
|
import { DishwasherMode } from '@matter/types/clusters/dishwasher-mode';
|
|
25
3
|
import { DishwasherModeServer } from '@matter/node/behaviors/dishwasher-mode';
|
|
26
4
|
import { DishwasherAlarmServer } from '@matter/node/behaviors/dishwasher-alarm';
|
|
27
|
-
// Matterbridge
|
|
28
5
|
import { dishwasher, powerSource } from '../matterbridgeDeviceTypes.js';
|
|
29
6
|
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
|
|
30
7
|
import { MatterbridgeOnOffServer, MatterbridgeServer } from '../matterbridgeBehaviors.js';
|
|
31
8
|
import { createLevelTemperatureControlClusterServer, createNumberTemperatureControlClusterServer } from './temperatureControl.js';
|
|
32
9
|
export class Dishwasher extends MatterbridgeEndpoint {
|
|
33
|
-
/**
|
|
34
|
-
* Creates an instance of the DishWasher class.
|
|
35
|
-
*
|
|
36
|
-
* @param {string} name - The name of the dish washer.
|
|
37
|
-
* @param {string} serial - The serial number of the dish washer.
|
|
38
|
-
* @param {number} [currentMode] - The current mode of the dish washer. Defaults to 2 (Normal mode). Dead Front OnOff Cluster will set this to 2 when turned off. Persistent attribute.
|
|
39
|
-
* @param {DishwasherMode.ModeOption[]} [supportedModes] - The supported modes of the dish washer. Defaults to a set of common modes (which include Light, Normal, Heavy). Fixed attribute.
|
|
40
|
-
* @param {number} [selectedTemperatureLevel] - The selected temperature level as an index of the supportedTemperatureLevels array. Defaults to 1 (which corresponds to 'Warm').
|
|
41
|
-
* @param {string[]} [supportedTemperatureLevels] - The supported temperature levels. Defaults to ['Cold', 'Warm', 'Hot', '30°', '40°', '60°', '80°']. Fixed attribute.
|
|
42
|
-
* @param {number} [temperatureSetpoint] - The temperature setpoint * 100. Defaults to 40 * 100 (which corresponds to 40°C).
|
|
43
|
-
* @param {number} [minTemperature] - The minimum temperature * 100. Defaults to 30 * 100 (which corresponds to 30°C). Fixed attribute.
|
|
44
|
-
* @param {number} [maxTemperature] - The maximum temperature * 100. Defaults to 60 * 100 (which corresponds to 60°C). Fixed attribute.
|
|
45
|
-
* @param {number} [step] - The step size for temperature changes. Defaults to 10 * 100 (which corresponds to 10°C). Fixed attribute.
|
|
46
|
-
* @param {OperationalState.OperationalStateEnum} [operationalState] - The operational state of the laundry washer. Defaults to OperationalState.OperationalStateEnum.Off.
|
|
47
|
-
*
|
|
48
|
-
* Remarks:
|
|
49
|
-
* - If `temperatureSetpoint` is provided, the `createNumberTemperatureControlClusterServer` method will be used to create the TemperatureControl Cluster Server with features TemperatureNumber and TemperatureStep.
|
|
50
|
-
* - If `temperatureSetpoint` is not provided, the `createLevelTemperatureControlClusterServer` method will be used to create the TemperatureControl Cluster Server with feature TemperatureLevel.
|
|
51
|
-
*/
|
|
52
10
|
constructor(name, serial, currentMode, supportedModes, selectedTemperatureLevel, supportedTemperatureLevels, temperatureSetpoint, minTemperature, maxTemperature, step, operationalState) {
|
|
53
11
|
super([dishwasher, powerSource], { id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` });
|
|
54
12
|
this.createDefaultIdentifyClusterServer();
|
|
@@ -63,14 +21,6 @@ export class Dishwasher extends MatterbridgeEndpoint {
|
|
|
63
21
|
createLevelTemperatureControlClusterServer(this, selectedTemperatureLevel, supportedTemperatureLevels);
|
|
64
22
|
this.createDefaultOperationalStateClusterServer(operationalState);
|
|
65
23
|
}
|
|
66
|
-
/**
|
|
67
|
-
* Creates a default Dishwasher Mode Cluster Server.
|
|
68
|
-
*
|
|
69
|
-
* @param {number} currentMode - The current mode of the dishwasher. Persistent attribute.
|
|
70
|
-
* @param {DishwasherMode.ModeOption[]} supportedModes - The supported modes of the dishwasher. Defaults to a set of common modes (Light, Normal, Heavy). Fixed attribute.
|
|
71
|
-
*
|
|
72
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
73
|
-
*/
|
|
74
24
|
createDefaultDishwasherModeClusterServer(currentMode = 2, supportedModes = [
|
|
75
25
|
{ label: 'Light', mode: 1, modeTags: [{ value: DishwasherMode.ModeTag.Light }] },
|
|
76
26
|
{ label: 'Normal', mode: 2, modeTags: [{ value: DishwasherMode.ModeTag.Normal }] },
|
|
@@ -82,11 +32,6 @@ export class Dishwasher extends MatterbridgeEndpoint {
|
|
|
82
32
|
});
|
|
83
33
|
return this;
|
|
84
34
|
}
|
|
85
|
-
/**
|
|
86
|
-
* Creates a default Dishwasher Alarm Cluster Server.
|
|
87
|
-
*
|
|
88
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
89
|
-
*/
|
|
90
35
|
createDefaultDishwasherAlarmClusterServer() {
|
|
91
36
|
this.behaviors.require(DishwasherAlarmServer, {
|
|
92
37
|
mask: { inflowError: true, drainError: true, doorError: true, tempTooLow: true, tempTooHigh: true, waterLevelError: true },
|
|
@@ -103,7 +48,6 @@ export class MatterbridgeDishwasherModeServer extends DishwasherModeServer {
|
|
|
103
48
|
this.state.currentMode = 2;
|
|
104
49
|
this.reactTo(this.agent.get(MatterbridgeOnOffServer).events.onOff$Changed, this.handleOnOffChange);
|
|
105
50
|
}
|
|
106
|
-
// Dead Front OnOff Cluster
|
|
107
51
|
handleOnOffChange(onOff) {
|
|
108
52
|
const device = this.endpoint.stateOf(MatterbridgeServer);
|
|
109
53
|
if (onOff === false) {
|
|
@@ -127,4 +71,3 @@ export class MatterbridgeDishwasherModeServer extends DishwasherModeServer {
|
|
|
127
71
|
}
|
|
128
72
|
}
|
|
129
73
|
}
|
|
130
|
-
//# sourceMappingURL=dishwasher.js.map
|
package/dist/devices/evse.js
CHANGED
|
@@ -1,54 +1,13 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @description This file contains the Evse class.
|
|
3
|
-
* @file src/devices/energy-evse.ts
|
|
4
|
-
* @author Luca Liguori
|
|
5
|
-
* @contributor Ludovic BOUÉ
|
|
6
|
-
* @created 2025-05-27
|
|
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 { EnergyEvseMode } from '@matter/types/clusters/energy-evse-mode';
|
|
25
2
|
import { EnergyEvse } from '@matter/types/clusters/energy-evse';
|
|
26
3
|
import { DeviceEnergyManagement } from '@matter/types/clusters/device-energy-management';
|
|
27
4
|
import { ModeBase } from '@matter/types/clusters/mode-base';
|
|
28
5
|
import { EnergyEvseServer } from '@matter/node/behaviors/energy-evse';
|
|
29
6
|
import { EnergyEvseModeServer } from '@matter/node/behaviors/energy-evse-mode';
|
|
30
|
-
// Matterbridge
|
|
31
7
|
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
|
|
32
8
|
import { MatterbridgeServer } from '../matterbridgeBehaviors.js';
|
|
33
9
|
import { deviceEnergyManagement, electricalSensor, evse, powerSource } from '../matterbridgeDeviceTypes.js';
|
|
34
10
|
export class Evse extends MatterbridgeEndpoint {
|
|
35
|
-
/**
|
|
36
|
-
* Creates an instance of the EVSE class.
|
|
37
|
-
*
|
|
38
|
-
* @param {string} name - The name of the EVSE.
|
|
39
|
-
* @param {string} serial - The serial number of the EVSE.
|
|
40
|
-
* @param {number} [currentMode] - The current mode of the EnergyEvseMode cluster. Defaults to mode 1 (EnergyEvseMode.ModeTag.Manual).
|
|
41
|
-
* @param {EnergyEvseMode.ModeOption[]} [supportedModes] - The supported modes for the EnergyEvseMode cluster. This is a fixed attribute that defaults to a predefined set of EnergyEvseMode cluster modes.
|
|
42
|
-
* @param {EnergyEvse.State} [state] - The current state of the EVSE. Defaults to NotPluggedIn.
|
|
43
|
-
* @param {EnergyEvse.SupplyState} [supplyState] - The supply state of the EVSE. Defaults to Disabled.
|
|
44
|
-
* @param {EnergyEvse.FaultState} [faultState] - The fault state of the EVSE. Defaults to NoError.
|
|
45
|
-
* @param {number} [voltage] - The voltage value in millivolts. Defaults to null if not provided.
|
|
46
|
-
* @param {number} [current] - The current value in milliamperes. Defaults to null if not provided.
|
|
47
|
-
* @param {number} [power] - The power value in milliwatts. Defaults to null if not provided.
|
|
48
|
-
* @param {number} [energy] - The total consumption value in mW/h. Defaults to null if not provided.
|
|
49
|
-
* @param {number} [absMinPower] - Indicate the minimum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
|
|
50
|
-
* @param {number} [absMaxPower] - Indicate the maximum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
|
|
51
|
-
*/
|
|
52
11
|
constructor(name, serial, currentMode, supportedModes, state, supplyState, faultState, voltage = null, current = null, power = null, energy = null, absMinPower, absMaxPower) {
|
|
53
12
|
super([evse, powerSource, electricalSensor, deviceEnergyManagement], { id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` });
|
|
54
13
|
this.createDefaultIdentifyClusterServer()
|
|
@@ -63,47 +22,30 @@ export class Evse extends MatterbridgeEndpoint {
|
|
|
63
22
|
.createDefaultEnergyEvseModeClusterServer(currentMode, supportedModes)
|
|
64
23
|
.addRequiredClusterServers();
|
|
65
24
|
}
|
|
66
|
-
/**
|
|
67
|
-
* Creates a default EnergyEvseServer Cluster Server.
|
|
68
|
-
*
|
|
69
|
-
* @param {EnergyEvse.State} [state] - The initial state of the EnergyEvse cluster. Defaults to EnergyEvse.State.NotPluggedIn.
|
|
70
|
-
* @param {EnergyEvse.SupplyState} [supplyState] - The initial supply state of the EnergyEvse cluster. Defaults to EnergyEvse.SupplyState.ChargingEnabled.
|
|
71
|
-
* @param {EnergyEvse.FaultState} [faultState] - The initial fault state of the EnergyEvse cluster. Defaults to EnergyEvse.FaultState.NoError.
|
|
72
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
73
|
-
*/
|
|
74
25
|
createDefaultEnergyEvseClusterServer(state, supplyState, faultState) {
|
|
75
26
|
this.behaviors.require(MatterbridgeEnergyEvseServer, {
|
|
76
27
|
state: state !== undefined ? state : EnergyEvse.State.NotPluggedIn,
|
|
77
28
|
supplyState: supplyState !== undefined ? supplyState : EnergyEvse.SupplyState.ChargingEnabled,
|
|
78
29
|
faultState: faultState !== undefined ? faultState : EnergyEvse.FaultState.NoError,
|
|
79
|
-
chargingEnabledUntil: null,
|
|
80
|
-
circuitCapacity: 32_000,
|
|
81
|
-
minimumChargeCurrent: 6_000,
|
|
82
|
-
maximumChargeCurrent: 32_000,
|
|
83
|
-
userMaximumChargeCurrent: 32_000,
|
|
84
|
-
sessionId: null,
|
|
85
|
-
sessionDuration: null,
|
|
86
|
-
sessionEnergyCharged: null,
|
|
30
|
+
chargingEnabledUntil: null,
|
|
31
|
+
circuitCapacity: 32_000,
|
|
32
|
+
minimumChargeCurrent: 6_000,
|
|
33
|
+
maximumChargeCurrent: 32_000,
|
|
34
|
+
userMaximumChargeCurrent: 32_000,
|
|
35
|
+
sessionId: null,
|
|
36
|
+
sessionDuration: null,
|
|
37
|
+
sessionEnergyCharged: null,
|
|
87
38
|
});
|
|
88
39
|
return this;
|
|
89
40
|
}
|
|
90
|
-
/**
|
|
91
|
-
* Creates a default EnergyEvseMode Cluster Server.
|
|
92
|
-
*
|
|
93
|
-
* @param {number} [currentMode] - The current mode of the EnergyEvseMode cluster. Defaults to mode 1 (EnergyEvseMode.ModeTag.Manual).
|
|
94
|
-
* @param {EnergyEvseMode.ModeOption[]} [supportedModes] - The supported modes for the EnergyEvseMode cluster. Defaults all EnergyEvseMode cluster modes.
|
|
95
|
-
*
|
|
96
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
97
|
-
*/
|
|
98
41
|
createDefaultEnergyEvseModeClusterServer(currentMode, supportedModes) {
|
|
99
42
|
this.behaviors.require(MatterbridgeEnergyEvseModeServer, {
|
|
100
43
|
supportedModes: supportedModes ?? [
|
|
101
44
|
{ label: 'On demand', mode: 1, modeTags: [{ value: EnergyEvseMode.ModeTag.Manual }] },
|
|
102
45
|
{ label: 'Scheduled', mode: 2, modeTags: [{ value: EnergyEvseMode.ModeTag.TimeOfUse }] },
|
|
103
46
|
{ label: 'Solar charging', mode: 3, modeTags: [{ value: EnergyEvseMode.ModeTag.SolarCharging }] },
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
currentMode: currentMode ?? 1, // Persistent attribute
|
|
47
|
+
],
|
|
48
|
+
currentMode: currentMode ?? 1,
|
|
107
49
|
});
|
|
108
50
|
return this;
|
|
109
51
|
}
|
|
@@ -119,8 +61,6 @@ export class MatterbridgeEnergyEvseServer extends EnergyEvseServer {
|
|
|
119
61
|
this.state.state = EnergyEvse.State.PluggedInDemand;
|
|
120
62
|
}
|
|
121
63
|
this.state.chargingEnabledUntil = 0;
|
|
122
|
-
// super.disable();
|
|
123
|
-
// disable is not implemented in matter.js
|
|
124
64
|
}
|
|
125
65
|
enableCharging(request) {
|
|
126
66
|
const device = this.endpoint.stateOf(MatterbridgeServer);
|
|
@@ -134,9 +74,6 @@ export class MatterbridgeEnergyEvseServer extends EnergyEvseServer {
|
|
|
134
74
|
this.state.chargingEnabledUntil = request.chargingEnabledUntil;
|
|
135
75
|
this.state.minimumChargeCurrent = request.minimumChargeCurrent;
|
|
136
76
|
this.state.maximumChargeCurrent = request.maximumChargeCurrent;
|
|
137
|
-
// The implementation should also stop the charging session at the required time and update the sessionId, sessionDuration, and sessionEnergyCharged attributes if needed.
|
|
138
|
-
// super.enableCharging();
|
|
139
|
-
// enableCharging is not implemented in matter.js
|
|
140
77
|
}
|
|
141
78
|
}
|
|
142
79
|
export class MatterbridgeEnergyEvseModeServer extends EnergyEvseModeServer {
|
|
@@ -154,4 +91,3 @@ export class MatterbridgeEnergyEvseModeServer extends EnergyEvseModeServer {
|
|
|
154
91
|
return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Success' };
|
|
155
92
|
}
|
|
156
93
|
}
|
|
157
|
-
//# sourceMappingURL=evse.js.map
|
package/dist/devices/export.js
CHANGED
|
@@ -1,8 +1,5 @@
|
|
|
1
|
-
// Chapter 10. Media Device Types - Single class device types
|
|
2
1
|
export * from './speaker.js';
|
|
3
|
-
// Chapter 12. Robotic Device Types - Single class device types
|
|
4
2
|
export * from './roboticVacuumCleaner.js';
|
|
5
|
-
// Chapter 13. Appliances Device Types - Single class device types
|
|
6
3
|
export * from './laundryWasher.js';
|
|
7
4
|
export * from './laundryDryer.js';
|
|
8
5
|
export * from './extractorHood.js';
|
|
@@ -12,10 +9,8 @@ export * from './oven.js';
|
|
|
12
9
|
export * from './cooktop.js';
|
|
13
10
|
export * from './refrigerator.js';
|
|
14
11
|
export * from './airConditioner.js';
|
|
15
|
-
// Chapter 14. Energy Device Types - Single class device types
|
|
16
12
|
export * from './waterHeater.js';
|
|
17
13
|
export * from './evse.js';
|
|
18
14
|
export * from './solarPower.js';
|
|
19
15
|
export * from './batteryStorage.js';
|
|
20
16
|
export * from './heatPump.js';
|
|
21
|
-
//# sourceMappingURL=export.js.map
|
|
@@ -1,49 +1,7 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @description This file contains the ExtractorHood class.
|
|
3
|
-
* @file src/devices/extractorHood.ts
|
|
4
|
-
* @author Luca Liguori
|
|
5
|
-
* @created 2025-05-25
|
|
6
|
-
* @version 1.1.0
|
|
7
|
-
* @license Apache-2.0
|
|
8
|
-
*
|
|
9
|
-
* Copyright 2025, 2026, 2027 Luca Liguori.
|
|
10
|
-
*
|
|
11
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
12
|
-
* you may not use this file except in compliance with the License.
|
|
13
|
-
* You may obtain a copy of the License at
|
|
14
|
-
*
|
|
15
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
16
|
-
*
|
|
17
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
18
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
19
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
20
|
-
* See the License for the specific language governing permissions and
|
|
21
|
-
* limitations under the License.
|
|
22
|
-
*/
|
|
23
|
-
// Imports from @matter
|
|
24
1
|
import { ResourceMonitoring } from '@matter/types/clusters/resource-monitoring';
|
|
25
|
-
// Matterbridge
|
|
26
2
|
import { extractorHood, powerSource } from '../matterbridgeDeviceTypes.js';
|
|
27
3
|
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
|
|
28
4
|
export class ExtractorHood extends MatterbridgeEndpoint {
|
|
29
|
-
/**
|
|
30
|
-
* Creates an instance of the ExtractorHood class.
|
|
31
|
-
*
|
|
32
|
-
* @param {string} name - The name of the extractor hood.
|
|
33
|
-
* @param {string} serial - The serial number of the extractor hood.
|
|
34
|
-
*
|
|
35
|
-
* @param {number} [hepaCondition] - The initial HEPA filter condition (range 0-100). Default is 100.
|
|
36
|
-
* @param {ResourceMonitoring.ChangeIndication} hepaChangeIndication - The initial HEPA filter change indication. Default is ResourceMonitoring.ChangeIndication.Ok.
|
|
37
|
-
* @param {boolean | undefined} hepaInPlaceIndicator - The HEPA filter in-place indicator. Default is true.
|
|
38
|
-
* @param {number | null | undefined} hepaLastChangedTime - The last time the HEPA filter was changed. Default is null.
|
|
39
|
-
* @param {ResourceMonitoring.ReplacementProduct[]} hepaReplacementProductList - The list of HEPA filter replacement products. Default is an empty array.
|
|
40
|
-
|
|
41
|
-
* @param {number} [activatedCarbonCondition] - The initial activated carbon filter condition (range 0-100). Default is 100.
|
|
42
|
-
* @param {ResourceMonitoring.ChangeIndication} activatedCarbonChangeIndication - The initial activated carbon filter change indication. Default is ResourceMonitoring.ChangeIndication.Ok.
|
|
43
|
-
* @param {boolean | undefined} activatedCarbonInPlaceIndicator - The activated carbon filter in-place indicator. Default is true.
|
|
44
|
-
* @param {number | null | undefined} activatedCarbonLastChangedTime - The last time the activated carbon filter was changed. Default is null.
|
|
45
|
-
* @param {ResourceMonitoring.ReplacementProduct[]} activatedCarbonReplacementProductList - The list of activated carbon filter replacement products. Default is an empty array.
|
|
46
|
-
*/
|
|
47
5
|
constructor(name, serial, hepaCondition = 100, hepaChangeIndication = ResourceMonitoring.ChangeIndication.Ok, hepaInPlaceIndicator = true, hepaLastChangedTime = null, hepaReplacementProductList = [], activatedCarbonCondition = 100, activatedCarbonChangeIndication = ResourceMonitoring.ChangeIndication.Ok, activatedCarbonInPlaceIndicator = true, activatedCarbonLastChangedTime = null, activatedCarbonReplacementProductList = []) {
|
|
48
6
|
super([extractorHood, powerSource], { id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` });
|
|
49
7
|
this.createDefaultIdentifyClusterServer();
|
|
@@ -75,4 +33,3 @@ export class ExtractorHood extends MatterbridgeEndpoint {
|
|
|
75
33
|
});
|
|
76
34
|
}
|
|
77
35
|
}
|
|
78
|
-
//# sourceMappingURL=extractorHood.js.map
|
package/dist/devices/heatPump.js
CHANGED
|
@@ -1,52 +1,8 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @description This file contains the HeatPump class.
|
|
3
|
-
* @file src/devices/heatPump.ts
|
|
4
|
-
* @author Luca Liguori
|
|
5
|
-
* @created 2025-06-29
|
|
6
|
-
* @version 1.0.0
|
|
7
|
-
* @license Apache-2.0
|
|
8
|
-
*
|
|
9
|
-
* Copyright 2025, 2026, 2027 Luca Liguori.
|
|
10
|
-
*
|
|
11
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
12
|
-
* you may not use this file except in compliance with the License.
|
|
13
|
-
* You may obtain a copy of the License at
|
|
14
|
-
*
|
|
15
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
16
|
-
*
|
|
17
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
18
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
19
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
20
|
-
* See the License for the specific language governing permissions and
|
|
21
|
-
* limitations under the License.
|
|
22
|
-
*/
|
|
23
|
-
// @matter
|
|
24
1
|
import { NumberTag, PowerSourceTag } from '@matter/node';
|
|
25
2
|
import { DeviceEnergyManagement } from '@matter/types/clusters/device-energy-management';
|
|
26
|
-
// Matterbridge
|
|
27
3
|
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
|
|
28
4
|
import { deviceEnergyManagement, electricalSensor, powerSource, heatPump, temperatureSensor, thermostatDevice } from '../matterbridgeDeviceTypes.js';
|
|
29
5
|
export class HeatPump extends MatterbridgeEndpoint {
|
|
30
|
-
/**
|
|
31
|
-
* Creates an instance of the HeatPump class.
|
|
32
|
-
*
|
|
33
|
-
* @param {string} name - The name of the HeatPump.
|
|
34
|
-
* @param {string} serial - The serial number of the HeatPump.
|
|
35
|
-
* @param {number} voltage - The voltage value in millivolts.
|
|
36
|
-
* @param {number} current - The current value in milliamperes.
|
|
37
|
-
* @param {number} power - The power value in milliwatts.
|
|
38
|
-
* @param {number} energyImported - The total production value in mW/h.
|
|
39
|
-
* @param {number} [absMinPower] - Indicate the minimum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
|
|
40
|
-
* @param {number} [absMaxPower] - Indicate the maximum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
|
|
41
|
-
*
|
|
42
|
-
* @remarks
|
|
43
|
-
* - The HeatPump includes clusters for power source, electrical power measurement, electrical energy measurement, and device energy management.
|
|
44
|
-
* - It also includes child devices for flow temperature, return temperature, and a thermostat.
|
|
45
|
-
* - The flow and return temperature sensors are set to default values of 45.00°C and 35.00°C respectively.
|
|
46
|
-
* - The heating only thermostat is set up with a default temperature setpoint of 21.00°C.
|
|
47
|
-
* - The device energy management cluster is set to `esaType` as `SpaceHeating`, `esaCanGenerate` as `false`, and `esaState` as `Online`.
|
|
48
|
-
* - The absolute minimum and maximum power values can be set to indicate the range of power consumption for the heat pump.
|
|
49
|
-
*/
|
|
50
6
|
constructor(name, serial, voltage = null, current = null, power = null, energyImported = null, absMinPower = 0, absMaxPower = 0) {
|
|
51
7
|
super([heatPump, powerSource, electricalSensor, deviceEnergyManagement], {
|
|
52
8
|
tagList: [{ mfgCode: null, namespaceId: PowerSourceTag.Grid.namespaceId, tag: PowerSourceTag.Grid.tag, label: null }],
|
|
@@ -61,19 +17,16 @@ export class HeatPump extends MatterbridgeEndpoint {
|
|
|
61
17
|
.createDefaultDeviceEnergyManagementClusterServer(DeviceEnergyManagement.EsaType.SpaceHeating, false, DeviceEnergyManagement.EsaState.Online, absMinPower, absMaxPower)
|
|
62
18
|
.createDefaultDeviceEnergyManagementModeClusterServer()
|
|
63
19
|
.addRequiredClusterServers();
|
|
64
|
-
// Add the flow temperature sensor for the heat pump.
|
|
65
20
|
this.addChildDeviceType('FlowTemperature', temperatureSensor, {
|
|
66
21
|
tagList: [{ mfgCode: null, namespaceId: NumberTag.One.namespaceId, tag: NumberTag.One.tag, label: 'Flow' }],
|
|
67
22
|
})
|
|
68
|
-
.createDefaultTemperatureMeasurementClusterServer(4500)
|
|
23
|
+
.createDefaultTemperatureMeasurementClusterServer(4500)
|
|
69
24
|
.addRequiredClusterServers();
|
|
70
|
-
// Add the return temperature sensor for the heat pump.
|
|
71
25
|
this.addChildDeviceType('ReturnTemperature', temperatureSensor, {
|
|
72
26
|
tagList: [{ mfgCode: null, namespaceId: NumberTag.Two.namespaceId, tag: NumberTag.Two.tag, label: 'Return' }],
|
|
73
27
|
})
|
|
74
|
-
.createDefaultTemperatureMeasurementClusterServer(3500)
|
|
28
|
+
.createDefaultTemperatureMeasurementClusterServer(3500)
|
|
75
29
|
.addRequiredClusterServers();
|
|
76
|
-
// Add the global thermostat for the heat pump.
|
|
77
30
|
this.addChildDeviceType('Thermostat', thermostatDevice, {
|
|
78
31
|
tagList: [{ mfgCode: null, namespaceId: NumberTag.One.namespaceId, tag: NumberTag.One.tag, label: 'Main Thermostat' }],
|
|
79
32
|
})
|
|
@@ -81,4 +34,3 @@ export class HeatPump extends MatterbridgeEndpoint {
|
|
|
81
34
|
.addRequiredClusterServers();
|
|
82
35
|
}
|
|
83
36
|
}
|
|
84
|
-
//# sourceMappingURL=heatPump.js.map
|
|
@@ -1,53 +1,11 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @description This file contains the LaundryDryer class.
|
|
3
|
-
* @file src/devices/laundryDryer.ts
|
|
4
|
-
* @author Luca Liguori
|
|
5
|
-
* @created 2025-06-29
|
|
6
|
-
* @version 1.1.0
|
|
7
|
-
* @license Apache-2.0
|
|
8
|
-
*
|
|
9
|
-
* Copyright 2025, 2026, 2027 Luca Liguori.
|
|
10
|
-
*
|
|
11
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
12
|
-
* you may not use this file except in compliance with the License.
|
|
13
|
-
* You may obtain a copy of the License at
|
|
14
|
-
*
|
|
15
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
16
|
-
*
|
|
17
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
18
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
19
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
20
|
-
* See the License for the specific language governing permissions and
|
|
21
|
-
* limitations under the License.
|
|
22
|
-
*/
|
|
23
1
|
import { LaundryWasherMode } from '@matter/types/clusters/laundry-washer-mode';
|
|
24
2
|
import { LaundryDryerControls } from '@matter/types/clusters/laundry-dryer-controls';
|
|
25
3
|
import { LaundryDryerControlsServer } from '@matter/node/behaviors/laundry-dryer-controls';
|
|
26
|
-
// Matterbridge
|
|
27
4
|
import { laundryDryer, powerSource } from '../matterbridgeDeviceTypes.js';
|
|
28
5
|
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
|
|
29
6
|
import { MatterbridgeLaundryWasherModeServer } from './laundryWasher.js';
|
|
30
7
|
import { createLevelTemperatureControlClusterServer, createNumberTemperatureControlClusterServer } from './temperatureControl.js';
|
|
31
8
|
export class LaundryDryer extends MatterbridgeEndpoint {
|
|
32
|
-
/**
|
|
33
|
-
* Creates an instance of the LaundryDryer class.
|
|
34
|
-
*
|
|
35
|
-
* @param {string} name - The name of the laundry dryer.
|
|
36
|
-
* @param {string} serial - The serial number of the laundry dryer.
|
|
37
|
-
* @param {number} [currentMode] - The current mode of the laundry dryer. Defaults to 2 (Normal mode). Dead Front OnOff Cluster will set this to 2 when turned off. Persistent attribute.
|
|
38
|
-
* @param {LaundryWasherMode.ModeOption[]} [supportedModes] - The supported modes of the laundry dryer. Defaults to a set of common modes (which include Delicate, Normal, Heavy, and Whites). Fixed attribute.
|
|
39
|
-
* @param {number} [selectedTemperatureLevel] - The selected temperature level as an index of the supportedTemperatureLevels array. Defaults to 1 (which corresponds to 'Warm').
|
|
40
|
-
* @param {string[]} [supportedTemperatureLevels] - The supported temperature levels. Defaults to ['Cold', 'Warm', 'Hot', '30°', '40°', '60°', '80°']. Fixed attribute.
|
|
41
|
-
* @param {number} [temperatureSetpoint] - The temperature setpoint * 100. Defaults to 40 * 100 (which corresponds to 40°C).
|
|
42
|
-
* @param {number} [minTemperature] - The minimum temperature * 100. Defaults to 30 * 100 (which corresponds to 30°C). Fixed attribute.
|
|
43
|
-
* @param {number} [maxTemperature] - The maximum temperature * 100. Defaults to 60 * 100 (which corresponds to 60°C). Fixed attribute.
|
|
44
|
-
* @param {number} [step] - The step size for temperature changes. Defaults to 10 * 100 (which corresponds to 10°C). Fixed attribute.
|
|
45
|
-
* @param {OperationalState.OperationalStateEnum} [operationalState] - The operational state of the laundry washer. Defaults to OperationalState.OperationalStateEnum.Off.
|
|
46
|
-
*
|
|
47
|
-
* Remarks:
|
|
48
|
-
* - If `temperatureSetpoint` is provided, the `createNumberTemperatureControlClusterServer` method will be used to create the TemperatureControl Cluster Server with features TemperatureNumber and TemperatureStep.
|
|
49
|
-
* - If `temperatureSetpoint` is not provided, the `createLevelTemperatureControlClusterServer` method will be used to create the TemperatureControl Cluster Server with feature TemperatureLevel.
|
|
50
|
-
*/
|
|
51
9
|
constructor(name, serial, currentMode, supportedModes, selectedTemperatureLevel, supportedTemperatureLevels, temperatureSetpoint, minTemperature, maxTemperature, step, operationalState) {
|
|
52
10
|
super([laundryDryer, powerSource], { id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` });
|
|
53
11
|
this.createDefaultIdentifyClusterServer();
|
|
@@ -62,14 +20,6 @@ export class LaundryDryer extends MatterbridgeEndpoint {
|
|
|
62
20
|
createLevelTemperatureControlClusterServer(this, selectedTemperatureLevel, supportedTemperatureLevels);
|
|
63
21
|
this.createDefaultOperationalStateClusterServer(operationalState);
|
|
64
22
|
}
|
|
65
|
-
/**
|
|
66
|
-
* Creates a default Laundry Washer Mode Cluster Server.
|
|
67
|
-
*
|
|
68
|
-
* @param {number} currentMode - The current mode of the laundry washer. Defaults to 2 (Normal mode). Dead Front OnOff Cluster will set this to 2 when turned off. Persistent attribute.
|
|
69
|
-
* @param {LaundryWasherMode.ModeOption[]} supportedModes - The supported modes of the laundry washer. Defaults to a set of common modes (which include Delicate, Normal, Heavy, and Whites). Fixed attribute.
|
|
70
|
-
*
|
|
71
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
72
|
-
*/
|
|
73
23
|
createDefaultLaundryWasherModeClusterServer(currentMode = 2, supportedModes = [
|
|
74
24
|
{ label: 'Delicate', mode: 1, modeTags: [{ value: LaundryWasherMode.ModeTag.Delicate }] },
|
|
75
25
|
{ label: 'Normal', mode: 2, modeTags: [{ value: LaundryWasherMode.ModeTag.Normal }] },
|
|
@@ -77,25 +27,16 @@ export class LaundryDryer extends MatterbridgeEndpoint {
|
|
|
77
27
|
{ label: 'Whites', mode: 4, modeTags: [{ value: LaundryWasherMode.ModeTag.Whites }] },
|
|
78
28
|
]) {
|
|
79
29
|
this.behaviors.require(MatterbridgeLaundryWasherModeServer, {
|
|
80
|
-
supportedModes,
|
|
81
|
-
currentMode,
|
|
30
|
+
supportedModes,
|
|
31
|
+
currentMode,
|
|
82
32
|
});
|
|
83
33
|
return this;
|
|
84
34
|
}
|
|
85
|
-
/**
|
|
86
|
-
* Creates a default Laundry Dryer Controls Cluster Server.
|
|
87
|
-
*
|
|
88
|
-
* @param {LaundryDryerControls.DrynessLevel} selectedDrynessLevel - The selected dryness level. Default is undefined.
|
|
89
|
-
* @param {LaundryDryerControls.DrynessLevel[]} supportedDrynessLevels - The supported dryness levels. Default is [Low, Normal, Extra, Max].
|
|
90
|
-
*
|
|
91
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
92
|
-
*/
|
|
93
35
|
createDefaultLaundryDryerControlsClusterServer(selectedDrynessLevel, supportedDrynessLevels) {
|
|
94
36
|
this.behaviors.require(LaundryDryerControlsServer, {
|
|
95
37
|
supportedDrynessLevels: supportedDrynessLevels ?? [LaundryDryerControls.DrynessLevel.Low, LaundryDryerControls.DrynessLevel.Normal, LaundryDryerControls.DrynessLevel.Extra, LaundryDryerControls.DrynessLevel.Max],
|
|
96
|
-
selectedDrynessLevel,
|
|
38
|
+
selectedDrynessLevel,
|
|
97
39
|
});
|
|
98
40
|
return this;
|
|
99
41
|
}
|
|
100
42
|
}
|
|
101
|
-
//# sourceMappingURL=laundryDryer.js.map
|