matterbridge 3.3.3-dev-20251015-706d832 → 3.3.3-dev-20251017-2e6040a

package/CHANGELOG.md

@@ -33,6 +33,8 @@ Advantages:
 - [frontend]: Added icon to open the cpu and memory usage in System Information panel.
 - [thermostat]: Added thermostatRunningState attribute. Thanks Ludovic BOUÉ (https://github.com/Luligu/matterbridge/pull/410).
 - [ElectricalPowerMeasurement]: Added createApparentElectricalPowerMeasurementClusterServer cluster helper. Thanks Ludovic BOUÉ (https://github.com/Luligu/matterbridge/pull/411).
+- [DeviceEnergyManagementMode]: Added logic to set optOutState. Thanks Ludovic BOUÉ (https://github.com/Luligu/matterbridge-example-dynamic-platform/issues/34).
+- [Thermostat]: Added provisional support for setActivePresetRequest. Thanks Ludovic BOUÉ (https://github.com/Luligu/matterbridge-example-dynamic-platform/issues/38).
 
 ### Changed
 

package/dist/deviceManager.js

@@ -1,12 +1,13 @@
 import { AnsiLogger, BLUE, CYAN, db, debugStringify, er, wr } from 'node-ansi-logger';
 import { dev } from './matterbridgeTypes.js';
 import { BroadcastServer } from './broadcastServer.js';
+import { hasParameter } from './utils/commandLine.js';
 export class DeviceManager {
     _devices = new Map();
     log;
     server;
     constructor() {
-        this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4, logLevel: "info" });
+        this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
         this.log.debug('Matterbridge device manager starting...');
         this.server = new BroadcastServer('devices', this.log);
         this.server.on('broadcast_message', this.msgHandler.bind(this));

package/dist/frontend.js

@@ -35,7 +35,7 @@ export class Frontend extends EventEmitter {
         this.matterbridge = matterbridge;
         this.log = new AnsiLogger({ logName: 'Frontend', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
         this.log.logNameColor = '\x1b[38;5;97m';
-        this.server = new BroadcastServer('plugins', this.log);
+        this.server = new BroadcastServer('frontend', this.log);
         this.server.on('broadcast_message', this.msgHandler.bind(this));
     }
     destroy() {

package/dist/matterbridge.js

@@ -14,7 +14,7 @@ import { BasicInformationServer } from '@matter/main/behaviors/basic-information
 import { getParameter, getIntParameter, hasParameter } from './utils/commandLine.js';
 import { copyDirectory } from './utils/copyDirectory.js';
 import { createDirectory } from './utils/createDirectory.js';
-import { isValidString, parseVersionString, isValidNumber } from './utils/isvalid.js';
+import { isValidString, parseVersionString, isValidNumber, isValidObject } from './utils/isvalid.js';
 import { formatMemoryUsage, formatOsUpTime } from './utils/network.js';
 import { withTimeout, waiter, wait } from './utils/wait.js';
 import { dev, MATTER_LOGGER_FILE, MATTER_STORAGE_NAME, MATTERBRIDGE_LOGGER_FILE, NODE_STORAGE_DIR, plg, typ } from './matterbridgeTypes.js';
@@ -1133,8 +1133,12 @@ export class Matterbridge extends EventEmitter {
             this.emit('cleanup_completed');
         }
         else {
-            if (!this.initialized)
+            if (!this.initialized) {
                 this.log.debug('Cleanup with instance not initialized...');
+                this.frontend.destroy();
+                this.plugins.destroy();
+                this.devices.destroy();
+            }
             if (this.hasCleanupStarted)
                 this.log.debug('Cleanup already started...');
         }
@@ -1737,6 +1741,8 @@ export class Matterbridge extends EventEmitter {
             { cluster: 'Thermostat', attribute: 'occupiedCoolingSetpoint' },
             { cluster: 'Thermostat', attribute: 'occupiedHeatingSetpoint' },
             { cluster: 'Thermostat', attribute: 'systemMode' },
+            { cluster: 'Thermostat', attribute: 'thermostatRunningMode' },
+            { cluster: 'Thermostat', attribute: 'thermostatRunningState' },
             { cluster: 'WindowCovering', attribute: 'operationalStatus' },
             { cluster: 'WindowCovering', attribute: 'currentPositionLiftPercent100ths' },
             { cluster: 'DoorLock', attribute: 'lockState' },
@@ -1766,7 +1772,7 @@ export class Matterbridge extends EventEmitter {
             if (device.hasAttributeServer(sub.cluster, sub.attribute)) {
                 this.log.debug(`Subscribing to endpoint ${or}${device.id}${db}:${or}${device.number}${db} attribute ${dev}${sub.cluster}${db}.${dev}${sub.attribute}${db} changes...`);
                 await device.subscribeAttribute(sub.cluster, sub.attribute, (value) => {
-                    this.log.debug(`Bridged endpoint ${or}${device.id}${db}:${or}${device.number}${db} attribute ${dev}${sub.cluster}${db}.${dev}${sub.attribute}${db} changed to ${CYAN}${value}${db}`);
+                    this.log.debug(`Bridged endpoint ${or}${device.id}${db}:${or}${device.number}${db} attribute ${dev}${sub.cluster}${db}.${dev}${sub.attribute}${db} changed to ${CYAN}${isValidObject(value) ? debugStringify(value) : value}${db}`);
                     this.frontend.wssSendAttributeChangedMessage(device.plugin, device.serialNumber, device.uniqueId, device.number, device.id, sub.cluster, sub.attribute, value);
                 });
             }
@@ -1774,7 +1780,7 @@ export class Matterbridge extends EventEmitter {
                 if (child.hasAttributeServer(sub.cluster, sub.attribute)) {
                     this.log.debug(`Subscribing to child endpoint ${or}${child.id}${db}:${or}${child.number}${db} attribute ${dev}${sub.cluster}${db}.${dev}${sub.attribute}${db} changes...`);
                     await child.subscribeAttribute(sub.cluster, sub.attribute, (value) => {
-                        this.log.debug(`Bridged child endpoint ${or}${child.id}${db}:${or}${child.number}${db} attribute ${dev}${sub.cluster}${db}.${dev}${sub.attribute}${db} changed to ${CYAN}${value}${db}`);
+                        this.log.debug(`Bridged child endpoint ${or}${child.id}${db}:${or}${child.number}${db} attribute ${dev}${sub.cluster}${db}.${dev}${sub.attribute}${db} changed to ${CYAN}${isValidObject(value) ? debugStringify(value) : value}${db}`);
                         this.frontend.wssSendAttributeChangedMessage(device.plugin, device.serialNumber, device.uniqueId, child.number, child.id, sub.cluster, sub.attribute, value);
                     });
                 }

package/dist/matterbridgeBehaviors.js

@@ -1,21 +1,23 @@
 import { Behavior } from '@matter/main';
-import { BooleanStateConfiguration } from '@matter/main/clusters/boolean-state-configuration';
-import { ColorControl } from '@matter/main/clusters/color-control';
-import { FanControl } from '@matter/main/clusters/fan-control';
-import { WindowCovering } from '@matter/main/clusters/window-covering';
-import { Thermostat } from '@matter/main/clusters/thermostat';
-import { ValveConfigurationAndControl } from '@matter/main/clusters/valve-configuration-and-control';
-import { SmokeCoAlarm } from '@matter/main/clusters/smoke-co-alarm';
-import { BooleanStateConfigurationServer } from '@matter/main/behaviors/boolean-state-configuration';
-import { OperationalState } from '@matter/main/clusters/operational-state';
-import { ModeBase } from '@matter/main/clusters/mode-base';
-import { ServiceArea } from '@matter/main/clusters/service-area';
+import { BooleanStateConfiguration } from '@matter/types/clusters/boolean-state-configuration';
+import { ColorControl } from '@matter/types/clusters/color-control';
+import { FanControl } from '@matter/types/clusters/fan-control';
+import { WindowCovering } from '@matter/types/clusters/window-covering';
+import { Thermostat } from '@matter/types/clusters/thermostat';
+import { ValveConfigurationAndControl } from '@matter/types/clusters/valve-configuration-and-control';
+import { SmokeCoAlarm } from '@matter/types/clusters/smoke-co-alarm';
+import { OperationalState } from '@matter/types/clusters/operational-state';
+import { ModeBase } from '@matter/types/clusters/mode-base';
+import { ServiceArea } from '@matter/types/clusters/service-area';
+import { DeviceEnergyManagement } from '@matter/types/clusters/device-energy-management';
 import { ResourceMonitoring } from '@matter/types/clusters/resource-monitoring';
+import { DeviceEnergyManagementMode } from '@matter/types/clusters/device-energy-management-mode';
 import { IdentifyServer } from '@matter/main/behaviors/identify';
 import { OnOffServer } from '@matter/main/behaviors/on-off';
 import { LevelControlServer } from '@matter/main/behaviors/level-control';
 import { ColorControlServer } from '@matter/main/behaviors/color-control';
 import { WindowCoveringServer } from '@matter/main/behaviors/window-covering';
+import { BooleanStateConfigurationServer } from '@matter/main/behaviors/boolean-state-configuration';
 import { DoorLockServer } from '@matter/main/behaviors/door-lock';
 import { FanControlServer } from '@matter/main/behaviors/fan-control';
 import { ThermostatServer } from '@matter/main/behaviors/thermostat';
@@ -321,6 +323,35 @@ export class MatterbridgeThermostatServer extends ThermostatServer.with(Thermost
         }
     }
 }
+export class MatterbridgePresetThermostatServer extends ThermostatServer.with(Thermostat.Feature.Presets, Thermostat.Feature.Cooling, Thermostat.Feature.Heating, Thermostat.Feature.AutoMode) {
+    setpointRaiseLower(request) {
+        const device = this.endpoint.stateOf(MatterbridgeServer);
+        device.log.info(`Setting setpoint by ${request.amount} in mode ${request.mode} (endpoint ${this.endpoint.maybeId}.${this.endpoint.maybeNumber})`);
+        device.commandHandler.executeHandler('setpointRaiseLower', { request, cluster: ThermostatServer.id, attributes: this.state, endpoint: this.endpoint });
+        const lookupSetpointAdjustMode = ['Heat', 'Cool', 'Both'];
+        device.log.debug(`MatterbridgeThermostatServer: setpointRaiseLower called with mode: ${lookupSetpointAdjustMode[request.mode]} amount: ${request.amount / 10}`);
+        if (this.state.occupiedHeatingSetpoint !== undefined)
+            device.log.debug(`- current occupiedHeatingSetpoint: ${this.state.occupiedHeatingSetpoint / 100}`);
+        if (this.state.occupiedCoolingSetpoint !== undefined)
+            device.log.debug(`- current occupiedCoolingSetpoint: ${this.state.occupiedCoolingSetpoint / 100}`);
+        if ((request.mode === Thermostat.SetpointRaiseLowerMode.Heat || request.mode === Thermostat.SetpointRaiseLowerMode.Both) && this.state.occupiedHeatingSetpoint !== undefined) {
+            const setpoint = this.state.occupiedHeatingSetpoint / 100 + request.amount / 10;
+            this.state.occupiedHeatingSetpoint = setpoint * 100;
+            device.log.debug(`Set occupiedHeatingSetpoint to ${setpoint}`);
+        }
+        if ((request.mode === Thermostat.SetpointRaiseLowerMode.Cool || request.mode === Thermostat.SetpointRaiseLowerMode.Both) && this.state.occupiedCoolingSetpoint !== undefined) {
+            const setpoint = this.state.occupiedCoolingSetpoint / 100 + request.amount / 10;
+            this.state.occupiedCoolingSetpoint = setpoint * 100;
+            device.log.debug(`Set occupiedCoolingSetpoint to ${setpoint}`);
+        }
+    }
+    setActivePresetRequest(request) {
+        const device = this.endpoint.stateOf(MatterbridgeServer);
+        device.log.info(`Setting preset to ${request.presetHandle} (endpoint ${this.endpoint.maybeId}.${this.endpoint.maybeNumber})`);
+        device.commandHandler.executeHandler('setActivePresetRequest', { request, cluster: ThermostatServer.id, attributes: this.state, endpoint: this.endpoint });
+        device.log.debug(`MatterbridgePresetThermostatServer: setActivePresetRequest called with presetHandle: ${request.presetHandle}`);
+    }
+}
 export class MatterbridgeValveConfigurationAndControlServer extends ValveConfigurationAndControlServer.with(ValveConfigurationAndControl.Feature.Level) {
     open(request) {
         const device = this.endpoint.stateOf(MatterbridgeServer);
@@ -467,7 +498,7 @@ export class MatterbridgeActivatedCarbonFilterMonitoringServer extends Activated
         device.log.debug(`MatterbridgeActivatedCarbonFilterMonitoringServer: resetCondition called`);
     }
 }
-export class MatterbridgeDeviceEnergyManagementServer extends DeviceEnergyManagementServer {
+export class MatterbridgeDeviceEnergyManagementServer extends DeviceEnergyManagementServer.with(DeviceEnergyManagement.Feature.PowerForecastReporting, DeviceEnergyManagement.Feature.PowerAdjustment) {
     powerAdjustRequest(request) {
         const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info(`Adjusting power to ${request.power} duration ${request.duration} cause ${request.cause} (endpoint ${this.endpoint.maybeId}.${this.endpoint.maybeNumber})`);
@@ -492,6 +523,14 @@ export class MatterbridgeDeviceEnergyManagementModeServer extends DeviceEnergyMa
             return { status: ModeBase.ModeChangeStatus.UnsupportedMode, statusText: 'Unsupported mode' };
         }
         this.state.currentMode = request.newMode;
+        if (supported.modeTags.find((tag) => tag.value === DeviceEnergyManagementMode.ModeTag.NoOptimization)) {
+            if (this.endpoint.behaviors.has(DeviceEnergyManagementServer))
+                this.endpoint.setStateOf(DeviceEnergyManagementServer.with(DeviceEnergyManagement.Feature.PowerForecastReporting, DeviceEnergyManagement.Feature.PowerAdjustment), { optOutState: DeviceEnergyManagement.OptOutState.OptOut });
+        }
+        else {
+            if (this.endpoint.behaviors.has(DeviceEnergyManagementServer))
+                this.endpoint.setStateOf(DeviceEnergyManagementServer.with(DeviceEnergyManagement.Feature.PowerForecastReporting, DeviceEnergyManagement.Feature.PowerAdjustment), { optOutState: DeviceEnergyManagement.OptOutState.NoOptOut });
+        }
         device.log.debug(`MatterbridgeDeviceEnergyManagementModeServer changeToMode called with newMode ${request.newMode} => ${supported.label}`);
         return super.changeToMode(request);
     }

package/dist/matterbridgeEndpoint.js

@@ -1157,13 +1157,14 @@ export class MatterbridgeEndpoint extends Endpoint {
     }
     createDefaultDeviceEnergyManagementClusterServer(esaType = DeviceEnergyManagement.EsaType.Other, esaCanGenerate = false, esaState = DeviceEnergyManagement.EsaState.Online, absMinPower = 0, absMaxPower = 0) {
         this.behaviors.require(MatterbridgeDeviceEnergyManagementServer.with(DeviceEnergyManagement.Feature.PowerForecastReporting, DeviceEnergyManagement.Feature.PowerAdjustment), {
-            forecast: null,
-            powerAdjustmentCapability: null,
             esaType,
             esaCanGenerate,
             esaState,
             absMinPower,
             absMaxPower,
+            powerAdjustmentCapability: null,
+            optOutState: DeviceEnergyManagement.OptOutState.NoOptOut,
+            forecast: null,
         });
         return this;
     }