matterbridge 3.1.1-dev-20250629-cfe9124 → 3.1.1-dev-20250630-1555eae

package/CHANGELOG.md

@@ -10,15 +10,17 @@ If you like this project and find it useful, please consider giving it a star on
 
 ## [3.1.1] - 2025-07-??
 
-### Breaking Changes
+### Development Breaking Changes
 
 - [devices]: The single devices (i.e. Rvc, Evse etc...) are only exported from matterbridge/devices. Please update your imports to use the new export path. Refer to the [documentation](README-DEV.md) for details on imports.
 
 ### Added
 
-- [SolarPower]: Added SolarPower class and Jest test. Thanks Ludovic BOUÉ.
-- [BatteryStorage]: Added BatteryStorage class and Jest test. Thanks Ludovic BOUÉ.
+- [LaundryDryer]: Added LaundryDryer (not supported by the Home app) class and Jest test.
 - [DeviceEnergyManagement]: Added MatterbridgeDeviceEnergyManagementServer with power adjustment methods.
+- [SolarPower]: Added SolarPower class and Jest test (working on Home Assistant and SmartThings). Thanks Ludovic BOUÉ.
+- [BatteryStorage]: Added BatteryStorage class and Jest test (working on Home Assistant and SmartThings). Thanks Ludovic BOUÉ.
+- [HeatPump]: Added HeatPump class and Jest test (working on Home Assistant and SmartThings).
 
 ### Changed
 

package/dist/batteryStorage.js

@@ -5,20 +5,24 @@ import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
 import { deviceEnergyManagement, electricalSensor, batteryStorage, powerSource } from './matterbridgeDeviceTypes.js';
 export class BatteryStorage extends MatterbridgeEndpoint {
     constructor(name, serial, batPercentRemaining = 100, batChargeLevel = PowerSource.BatChargeLevel.Ok, voltage = null, current = null, power = null, energyImported = null, energyExported = null, absMinPower = 0, absMaxPower = 0) {
-        super([batteryStorage, powerSource, electricalSensor, deviceEnergyManagement], {
-            tagList: [
-                { mfgCode: null, namespaceId: PowerSourceTag.Battery.namespaceId, tag: PowerSourceTag.Battery.tag, label: null },
-                { mfgCode: null, namespaceId: PowerSourceTag.Grid.namespaceId, tag: PowerSourceTag.Grid.tag, label: null },
-            ],
-            id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}`,
-        }, true);
+        super([batteryStorage, powerSource, electricalSensor, deviceEnergyManagement], { id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer()
             .createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Solar Power')
-            .createDefaultPowerSourceWiredBatteryClusterServer(batPercentRemaining, batChargeLevel)
             .createDefaultPowerTopologyClusterServer()
             .createDefaultElectricalPowerMeasurementClusterServer(voltage, current, power)
             .createDefaultElectricalEnergyMeasurementClusterServer(energyImported, energyExported)
             .createDefaultDeviceEnergyManagementClusterServer(DeviceEnergyManagement.EsaType.BatteryStorage, true, DeviceEnergyManagement.EsaState.Online, absMinPower, absMaxPower)
+            .createDefaultDeviceEnergyManagementModeClusterServer()
+            .addRequiredClusterServers();
+        this.addChildDeviceType('BatteryPowerSource', powerSource, {
+            tagList: [{ mfgCode: null, namespaceId: PowerSourceTag.Battery.namespaceId, tag: PowerSourceTag.Battery.tag, label: null }],
+        })
+            .createDefaultPowerSourceRechargeableBatteryClusterServer(batPercentRemaining, batChargeLevel)
+            .addRequiredClusterServers();
+        this.addChildDeviceType('GridPowerSource', powerSource, {
+            tagList: [{ mfgCode: null, namespaceId: PowerSourceTag.Grid.namespaceId, tag: PowerSourceTag.Grid.tag, label: null }],
+        })
+            .createDefaultPowerSourceWiredClusterServer()
             .addRequiredClusterServers();
     }
 }

package/dist/devices/export.js

@@ -1,5 +1,6 @@
 export * from '../roboticVacuumCleaner.js';
 export * from '../laundryWasher.js';
+export * from '../laundryDryer.js';
 export * from '../waterHeater.js';
 export * from '../evse.js';
 export * from '../solarPower.js';

package/dist/evse.js

@@ -16,6 +16,7 @@ export class Evse extends MatterbridgeEndpoint {
             .createDefaultElectricalPowerMeasurementClusterServer()
             .createDefaultElectricalEnergyMeasurementClusterServer()
             .createDefaultDeviceEnergyManagementClusterServer(DeviceEnergyManagement.EsaType.Evse, false, DeviceEnergyManagement.EsaState.Online, absMinPower, absMaxPower)
+            .createDefaultDeviceEnergyManagementModeClusterServer()
             .createDefaultEnergyEvseClusterServer(state, supplyState, faultState)
             .createDefaultEnergyEvseModeClusterServer(currentMode, supportedModes)
             .addRequiredClusterServers();

package/dist/heatPump.js

@@ -0,0 +1,21 @@
+import { PowerSourceTag } from '@matter/main';
+import { DeviceEnergyManagement } from '@matter/main/clusters/device-energy-management';
+import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
+import { deviceEnergyManagement, electricalSensor, powerSource, heatPump } from './matterbridgeDeviceTypes.js';
+export class HeatPump extends MatterbridgeEndpoint {
+    constructor(name, serial, voltage = null, current = null, power = null, energyImported = null, absMinPower = 0, absMaxPower = 0) {
+        super([heatPump, powerSource, electricalSensor, deviceEnergyManagement], {
+            tagList: [{ mfgCode: null, namespaceId: PowerSourceTag.Grid.namespaceId, tag: PowerSourceTag.Grid.tag, label: null }],
+            id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}`,
+        }, true);
+        this.createDefaultIdentifyClusterServer()
+            .createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Heat Pump')
+            .createDefaultPowerSourceWiredClusterServer()
+            .createDefaultPowerTopologyClusterServer()
+            .createDefaultElectricalPowerMeasurementClusterServer(voltage, current, power)
+            .createDefaultElectricalEnergyMeasurementClusterServer(energyImported)
+            .createDefaultDeviceEnergyManagementClusterServer(DeviceEnergyManagement.EsaType.Other, true, DeviceEnergyManagement.EsaState.Online, absMinPower, absMaxPower)
+            .createDefaultDeviceEnergyManagementModeClusterServer()
+            .addRequiredClusterServers();
+    }
+}

package/dist/laundryDryer.js

@@ -0,0 +1,58 @@
+import { LaundryWasherMode } from '@matter/main/clusters/laundry-washer-mode';
+import { TemperatureControl } from '@matter/main/clusters/temperature-control';
+import { LaundryDryerControls } from '@matter/main/clusters/laundry-dryer-controls';
+import { LaundryDryerControlsServer } from '@matter/main/behaviors/laundry-dryer-controls';
+import { laundryDryer, powerSource } from './matterbridgeDeviceTypes.js';
+import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
+import { MatterbridgeLaundryWasherModeServer, MatterbridgeLevelTemperatureControlServer, MatterbridgeNumberTemperatureControlServer } from './laundryWasher.js';
+export class LaundryDryer extends MatterbridgeEndpoint {
+    constructor(name, serial, currentMode, supportedModes, selectedTemperatureLevel, supportedTemperatureLevels, temperatureSetpoint, minTemperature, maxTemperature, step, operationalState) {
+        super([laundryDryer, powerSource], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
+        this.createDefaultIdentifyClusterServer();
+        this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Laundry Dryer');
+        this.createDefaultPowerSourceWiredClusterServer();
+        this.createDeadFrontOnOffClusterServer(true);
+        this.createDefaultLaundryWasherModeClusterServer(currentMode, supportedModes);
+        this.createDefaultLaundryDryerControlsClusterServer(1);
+        if (temperatureSetpoint)
+            this.createNumberTemperatureControlClusterServer(temperatureSetpoint, minTemperature, maxTemperature, step);
+        else
+            this.createLevelTemperatureControlClusterServer(selectedTemperatureLevel, supportedTemperatureLevels);
+        this.createDefaultOperationalStateClusterServer(operationalState);
+    }
+    createDefaultLaundryWasherModeClusterServer(currentMode = 2, supportedModes = [
+        { label: 'Delicate', mode: 1, modeTags: [{ value: LaundryWasherMode.ModeTag.Delicate }] },
+        { label: 'Normal', mode: 2, modeTags: [{ value: LaundryWasherMode.ModeTag.Normal }] },
+        { label: 'Heavy', mode: 3, modeTags: [{ value: LaundryWasherMode.ModeTag.Heavy }] },
+        { label: 'Whites', mode: 4, modeTags: [{ value: LaundryWasherMode.ModeTag.Whites }] },
+    ]) {
+        this.behaviors.require(MatterbridgeLaundryWasherModeServer, {
+            supportedModes,
+            currentMode,
+        });
+        return this;
+    }
+    createDefaultLaundryDryerControlsClusterServer(selectedDrynessLevel, supportedDrynessLevels) {
+        this.behaviors.require(LaundryDryerControlsServer, {
+            supportedDrynessLevels: supportedDrynessLevels ?? [LaundryDryerControls.DrynessLevel.Low, LaundryDryerControls.DrynessLevel.Normal, LaundryDryerControls.DrynessLevel.Extra, LaundryDryerControls.DrynessLevel.Max],
+            selectedDrynessLevel,
+        });
+        return this;
+    }
+    createLevelTemperatureControlClusterServer(selectedTemperatureLevel = 1, supportedTemperatureLevels = ['Cold', 'Warm', 'Hot', '30°', '40°', '60°', '80°']) {
+        this.behaviors.require(MatterbridgeLevelTemperatureControlServer.with(TemperatureControl.Feature.TemperatureLevel), {
+            selectedTemperatureLevel,
+            supportedTemperatureLevels,
+        });
+        return this;
+    }
+    createNumberTemperatureControlClusterServer(temperatureSetpoint = 40 * 100, minTemperature = 30 * 100, maxTemperature = 60 * 100, step = 10 * 100) {
+        this.behaviors.require(MatterbridgeNumberTemperatureControlServer.with(TemperatureControl.Feature.TemperatureNumber, TemperatureControl.Feature.TemperatureStep), {
+            temperatureSetpoint,
+            minTemperature,
+            maxTemperature,
+            step,
+        });
+        return this;
+    }
+}

package/dist/laundryWasher.js

@@ -5,12 +5,12 @@ import { ModeBase } from '@matter/main/clusters/mode-base';
 import { TemperatureControlServer } from '@matter/main/behaviors/temperature-control';
 import { LaundryWasherModeServer } from '@matter/main/behaviors/laundry-washer-mode';
 import { LaundryWasherControlsServer } from '@matter/main/behaviors/laundry-washer-controls';
-import { laundryWasher } from './matterbridgeDeviceTypes.js';
+import { laundryWasher, powerSource } from './matterbridgeDeviceTypes.js';
 import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
 import { MatterbridgeOnOffServer, MatterbridgeServer } from './matterbridgeBehaviors.js';
 export class LaundryWasher extends MatterbridgeEndpoint {
     constructor(name, serial, currentMode, supportedModes, spinSpeedCurrent, spinSpeeds, numberOfRinses, supportedRinses, selectedTemperatureLevel, supportedTemperatureLevels, temperatureSetpoint, minTemperature, maxTemperature, step, operationalState) {
-        super(laundryWasher, { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
+        super([laundryWasher, powerSource], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer();
         this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Laundry Washer');
         this.createDefaultPowerSourceWiredClusterServer();

package/dist/matterbridgeEndpoint.js

@@ -417,29 +417,6 @@ export class MatterbridgeEndpoint extends Endpoint {
         });
         return this;
     }
-    createDefaultPowerSourceWiredBatteryClusterServer(batPercentRemaining = 100, batChargeLevel = PowerSource.BatChargeLevel.Ok) {
-        this.behaviors.require(PowerSourceServer.with(PowerSource.Feature.Battery, PowerSource.Feature.Rechargeable), {
-            status: PowerSource.PowerSourceStatus.Active,
-            order: 0,
-            description: 'Primary battery',
-            endpointList: [],
-            batVoltage: null,
-            batPercentRemaining: Math.min(Math.max(batPercentRemaining * 2, 0), 200),
-            batTimeRemaining: null,
-            batChargeLevel,
-            batReplacementNeeded: false,
-            batReplaceability: PowerSource.BatReplaceability.Unspecified,
-            batPresent: true,
-            activeBatFaults: [],
-            batChargeState: PowerSource.BatChargeState.IsNotCharging,
-            batTimeToFullCharge: null,
-            batFunctionalWhileCharging: true,
-            batChargingCurrent: null,
-            batCapacity: 1,
-            activeBatChargeFaults: [],
-        });
-        return this;
-    }
     createDefaultPowerSourceReplaceableBatteryClusterServer(batPercentRemaining = 100, batChargeLevel = PowerSource.BatChargeLevel.Ok, batVoltage = 1500, batReplacementDescription = 'Battery type', batQuantity = 1) {
         this.behaviors.require(PowerSourceServer.with(PowerSource.Feature.Battery, PowerSource.Feature.Replaceable), {
             status: PowerSource.PowerSourceStatus.Active,

package/dist/roboticVacuumCleaner.js

@@ -8,11 +8,11 @@ import { RvcOperationalState } from '@matter/main/clusters/rvc-operational-state
 import { ModeBase } from '@matter/main/clusters/mode-base';
 import { OperationalState } from '@matter/main/clusters/operational-state';
 import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
-import { roboticVacuumCleaner } from './matterbridgeDeviceTypes.js';
+import { powerSource, roboticVacuumCleaner } from './matterbridgeDeviceTypes.js';
 import { MatterbridgeServer, MatterbridgeServiceAreaServer } from './matterbridgeBehaviors.js';
 export class RoboticVacuumCleaner extends MatterbridgeEndpoint {
     constructor(name, serial, currentRunMode, supportedRunModes, currentCleanMode, supportedCleanModes, currentPhase = null, phaseList = null, operationalState, operationalStateList, supportedAreas, selectedAreas, currentArea) {
-        super(roboticVacuumCleaner, { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
+        super([roboticVacuumCleaner, powerSource], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer()
             .createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Robot Vacuum Cleaner')
             .createDefaultPowerSourceRechargeableBatteryClusterServer(80, PowerSource.BatChargeLevel.Ok, 5900)

package/dist/solarPower.js

@@ -15,6 +15,7 @@ export class SolarPower extends MatterbridgeEndpoint {
             .createDefaultElectricalPowerMeasurementClusterServer(voltage, current, power)
             .createDefaultElectricalEnergyMeasurementClusterServer(0, energyExported)
             .createDefaultDeviceEnergyManagementClusterServer(DeviceEnergyManagement.EsaType.SolarPv, true, DeviceEnergyManagement.EsaState.Online, absMinPower, absMaxPower)
+            .createDefaultDeviceEnergyManagementModeClusterServer()
             .addRequiredClusterServers();
     }
 }

package/dist/waterHeater.js

@@ -4,11 +4,11 @@ import { WaterHeaterMode } from '@matter/main/clusters/water-heater-mode';
 import { WaterHeaterManagementServer } from '@matter/main/behaviors/water-heater-management';
 import { WaterHeaterModeServer } from '@matter/main/behaviors/water-heater-mode';
 import { MatterbridgeServer } from './matterbridgeBehaviors.js';
-import { waterHeater } from './matterbridgeDeviceTypes.js';
+import { electricalSensor, powerSource, waterHeater } from './matterbridgeDeviceTypes.js';
 import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
 export class WaterHeater extends MatterbridgeEndpoint {
     constructor(name, serial, waterTemperature = 50, targetWaterTemperature = 55, minHeatSetpointLimit = 20, maxHeatSetpointLimit = 80, heaterTypes = { immersionElement1: true }, tankPercentage = 90) {
-        super(waterHeater, { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
+        super([waterHeater, powerSource, electricalSensor], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer()
             .createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Water Heater')
             .createDefaultPowerSourceWiredClusterServer()

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge",
-  "version": "3.1.1-dev-20250629-cfe9124",
+  "version": "3.1.1-dev-20250630-1555eae",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge",
-      "version": "3.1.1-dev-20250629-cfe9124",
+      "version": "3.1.1-dev-20250630-1555eae",
       "license": "Apache-2.0",
       "dependencies": {
         "@matter/main": "0.15.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "3.1.1-dev-20250629-cfe9124",
+  "version": "3.1.1-dev-20250630-1555eae",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",