matterbridge 3.0.1 → 3.0.2-dev-20250509-ae61aa7

package/dist/matterbridgeAccessoryPlatform.js

@@ -1,38 +1,5 @@
-/**
- * This file contains the class MatterbridgeAccessoryPlatform.
- *
- * @file matterbridgeAccessoryPlatform.ts
- * @author Luca Liguori
- * @date 2023-12-29
- * @version 1.0.5
- *
- * Copyright 2023, 2024, 2025 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. *
- */
 import { MatterbridgePlatform } from './matterbridgePlatform.js';
-/**
- * Represents a Matterbridge accessory platform.
- *
- * This class extends the MatterbridgePlatform class.
- */
 export class MatterbridgeAccessoryPlatform extends MatterbridgePlatform {
-    /**
-     * Creates an instance of MatterbridgeAccessoryPlatform.
-     * @param {Matterbridge} matterbridge - The Matterbridge instance.
-     * @param {AnsiLogger} log - The logger instance.
-     * @param {PlatformConfig} config - The platform configuration.
-     */
     constructor(matterbridge, log, config) {
         super(matterbridge, log, config);
         this.type = 'AccessoryPlatform';
@@ -40,4 +7,3 @@ export class MatterbridgeAccessoryPlatform extends MatterbridgePlatform {
         this.log.debug(`Matterbridge${this.type} loaded`);
     }
 }
-//# sourceMappingURL=matterbridgeAccessoryPlatform.js.map

package/dist/matterbridgeBehaviors.js

@@ -1,31 +1,4 @@
-/**
- * This file contains the class MatterbridgeEndpoint that extends the Endpoint class from the Matter.js library.
- *
- * @file matterbridgeBehaviors.ts
- * @author Luca Liguori
- * @date 2024-11-07
- * @version 1.0.0
- *
- * Copyright 2024, 2025, 2026 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. *
- */
-/* eslint-disable @typescript-eslint/no-namespace */
-/* eslint-disable @typescript-eslint/no-unused-vars */
-/* eslint-disable @typescript-eslint/no-explicit-any */
-// @matter
 import { Behavior } from '@matter/main';
-// @matter clusters
 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';
@@ -35,7 +8,10 @@ import { ValveConfigurationAndControl } from '@matter/main/clusters/valve-config
 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';
-// @matter behaviors
+import { ModeBase } from '@matter/main/clusters/mode-base';
+import { RvcRunMode } from '@matter/main/clusters/rvc-run-mode';
+import { RvcOperationalState } from '@matter/main/clusters/rvc-operational-state';
+import { ServiceArea } from '@matter/main/clusters/service-area';
 import { IdentifyServer } from '@matter/main/behaviors/identify';
 import { OnOffServer } from '@matter/main/behaviors/on-off';
 import { LevelControlServer } from '@matter/main/behaviors/level-control';
@@ -49,10 +25,14 @@ import { ModeSelectServer } from '@matter/main/behaviors/mode-select';
 import { SmokeCoAlarmServer } from '@matter/main/behaviors/smoke-co-alarm';
 import { SwitchServer } from '@matter/main/behaviors/switch';
 import { OperationalStateServer } from '@matter/main/behaviors/operational-state';
+import { RvcRunModeServer } from '@matter/main/behaviors/rvc-run-mode';
+import { RvcCleanModeServer } from '@matter/main/behaviors/rvc-clean-mode';
+import { RvcOperationalStateServer } from '@matter/main/behaviors/rvc-operational-state';
+import { ServiceAreaServer } from '@matter/main/behaviors/service-area';
 export class MatterbridgeServerDevice {
     log;
     commandHandler;
-    device; // Will be a plugin device
+    device;
     endpointId = undefined;
     endpointNumber = undefined;
     constructor(log, commandHandler, device) {
@@ -186,6 +166,14 @@ export class MatterbridgeServerDevice {
         this.log.info(`Resume (endpoint ${this.endpointId}.${this.endpointNumber})`);
         this.commandHandler.executeHandler('resume', { request: {}, attributes: {}, endpoint: { number: this.endpointNumber, uniqueStorageKey: this.endpointId } });
     }
+    goHome() {
+        this.log.info(`GoHome (endpoint ${this.endpointId}.${this.endpointNumber})`);
+        this.commandHandler.executeHandler('goHome', { request: {}, attributes: {}, endpoint: { number: this.endpointNumber, uniqueStorageKey: this.endpointId } });
+    }
+    selectAreas({ newAreas }) {
+        this.log.info(`Selecting areas ${newAreas} (endpoint ${this.endpointId}.${this.endpointNumber})`);
+        this.commandHandler.executeHandler('selectAreas', { request: { newAreas }, attributes: {}, endpoint: { number: this.endpointNumber, uniqueStorageKey: this.endpointId } });
+    }
 }
 export class MatterbridgeServer extends Behavior {
     static id = 'matterbridge';
@@ -308,7 +296,6 @@ export class MatterbridgeWindowCoveringServer extends WindowCoveringServer.with(
         super.goToLiftPercentage({ liftPercent100thsValue });
     }
     async handleMovement(type, reversed, direction, targetPercent100ths) {
-        // Do nothing here, as the device will handle the movement
     }
 }
 export class MatterbridgeDoorLockServer extends DoorLockServer {
@@ -355,8 +342,6 @@ export class MatterbridgeFanControlServer extends FanControlServer.with(FanContr
                 this.state.percentCurrent = Math.max(this.state.percentCurrent - 10, lowestOff ? 0 : 10);
         }
         device.log.debug('Set percentCurrent to:', this.state.percentCurrent);
-        // step is not implemented in matter.js
-        // super.step();
     }
 }
 export class MatterbridgeThermostatServer extends ThermostatServer.with(Thermostat.Feature.Cooling, Thermostat.Feature.Heating, Thermostat.Feature.AutoMode) {
@@ -377,8 +362,6 @@ export class MatterbridgeThermostatServer extends ThermostatServer.with(Thermost
             this.state.occupiedCoolingSetpoint = setpoint * 100;
             device.log.debug('Set occupiedCoolingSetpoint to:', setpoint);
         }
-        // setpointRaiseLower is not implemented in matter.js
-        // super.setpointRaiseLower();
     }
 }
 export class MatterbridgeValveConfigurationAndControlServer extends ValveConfigurationAndControlServer.with(ValveConfigurationAndControl.Feature.Level) {
@@ -388,8 +371,6 @@ export class MatterbridgeValveConfigurationAndControlServer extends ValveConfigu
         device.open({ openDuration, targetLevel });
         this.state.targetLevel = targetLevel ?? 100;
         this.state.currentLevel = targetLevel ?? 100;
-        // open is not implemented in matter.js
-        // super.open();
     }
     close() {
         const device = this.agent.get(MatterbridgeServer).state.deviceCommand;
@@ -397,8 +378,6 @@ export class MatterbridgeValveConfigurationAndControlServer extends ValveConfigu
         device.close();
         this.state.targetLevel = 0;
         this.state.currentLevel = 0;
-        // close is not implemented in matter.js
-        // super.close();
     }
 }
 export class MatterbridgeSmokeCoAlarmServer extends SmokeCoAlarmServer.with(SmokeCoAlarm.Feature.SmokeAlarm, SmokeCoAlarm.Feature.CoAlarm) {
@@ -406,8 +385,6 @@ export class MatterbridgeSmokeCoAlarmServer extends SmokeCoAlarmServer.with(Smok
         const device = this.agent.get(MatterbridgeServer).state.deviceCommand;
         device.log.debug(`MatterbridgeSmokeCoAlarmServer: selfTestRequest called`);
         device.selfTestRequest();
-        // selfTestRequest is not implemented in matter.js
-        // super.selfTestRequest();
     }
 }
 export class MatterbridgeBooleanStateConfigurationServer extends BooleanStateConfigurationServer.with(BooleanStateConfiguration.Feature.Visual, BooleanStateConfiguration.Feature.Audible, BooleanStateConfiguration.Feature.SensitivityLevel) {
@@ -415,13 +392,10 @@ export class MatterbridgeBooleanStateConfigurationServer extends BooleanStateCon
         const device = this.agent.get(MatterbridgeServer).state.deviceCommand;
         device.log.debug(`MatterbridgeBooleanStateConfigurationServer: enableDisableAlarm called`);
         device.enableDisableAlarm({ alarmsToEnableDisable });
-        // enableDisableAlarm is not implemented in matter.js
-        // super.enableDisableAlarm({ alarmsToEnableDisable });
     }
 }
 export class MatterbridgeSwitchServer extends SwitchServer {
     initialize() {
-        // Do nothing here, as the device will handle the switch logic: we need to convert something like "single" into the oppropriate states and events sequences
     }
 }
 export class MatterbridgeOperationalStateServer extends OperationalStateServer {
@@ -437,7 +411,6 @@ export class MatterbridgeOperationalStateServer extends OperationalStateServer {
         device.pause();
         this.state.operationalState = OperationalState.OperationalStateEnum.Paused;
         this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
-        // pause is not implemented in matter.js
         return {
             commandResponseState: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
         };
@@ -448,7 +421,6 @@ export class MatterbridgeOperationalStateServer extends OperationalStateServer {
         device.stop();
         this.state.operationalState = OperationalState.OperationalStateEnum.Stopped;
         this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
-        // stop is not implemented in matter.js
         return {
             commandResponseState: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
         };
@@ -459,7 +431,6 @@ export class MatterbridgeOperationalStateServer extends OperationalStateServer {
         device.start();
         this.state.operationalState = OperationalState.OperationalStateEnum.Running;
         this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
-        // start is not implemented in matter.js
         return {
             commandResponseState: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
         };
@@ -470,10 +441,100 @@ export class MatterbridgeOperationalStateServer extends OperationalStateServer {
         device.resume();
         this.state.operationalState = OperationalState.OperationalStateEnum.Running;
         this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
-        // resume is not implemented in matter.js
         return {
             commandResponseState: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
         };
     }
 }
-//# sourceMappingURL=matterbridgeBehaviors.js.map
+export class MatterbridgeRvcRunModeServer extends RvcRunModeServer {
+    changeToMode({ newMode }) {
+        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const supported = this.state.supportedModes.find((mode) => mode.mode === newMode);
+        if (!supported) {
+            device.log.error(`MatterbridgeRvcRunModeServer changeToMode called with unsupported newMode: ${newMode}`);
+            return { status: ModeBase.ModeChangeStatus.UnsupportedMode, statusText: 'Unsupported mode' };
+        }
+        device.changeToMode({ newMode });
+        this.state.currentMode = newMode;
+        if (supported.modeTags.find((tag) => tag.value === RvcRunMode.ModeTag.Cleaning)) {
+            device.log.info('MatterbridgeRvcRunModeServer changeToMode called with newMode Cleaning => Running');
+            this.agent.get(MatterbridgeRvcOperationalStateServer).state.operationalState = RvcOperationalState.OperationalState.Running;
+            return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Running' };
+        }
+        else if (supported.modeTags.find((tag) => tag.value === RvcRunMode.ModeTag.Idle)) {
+            device.log.info('MatterbridgeRvcRunModeServer changeToMode called with newMode Idle => Docked');
+            this.agent.get(MatterbridgeRvcOperationalStateServer).state.operationalState = RvcOperationalState.OperationalState.Docked;
+            return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Docked' };
+        }
+        device.log.info(`MatterbridgeRvcRunModeServer changeToMode called with newMode ${newMode} => ${supported.label}`);
+        this.agent.get(MatterbridgeRvcOperationalStateServer).state.operationalState = RvcOperationalState.OperationalState.Running;
+        return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Success' };
+    }
+}
+export class MatterbridgeRvcCleanModeServer extends RvcCleanModeServer {
+    changeToMode({ newMode }) {
+        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const supported = this.state.supportedModes.find((mode) => mode.mode === newMode);
+        if (!supported) {
+            device.log.error(`MatterbridgeRvcCleanModeServer changeToMode called with unsupported newMode: ${newMode}`);
+            return { status: ModeBase.ModeChangeStatus.UnsupportedMode, statusText: 'Unsupported mode' };
+        }
+        device.changeToMode({ newMode });
+        this.state.currentMode = newMode;
+        device.log.info(`MatterbridgeRvcCleanModeServer changeToMode called with newMode ${newMode} => ${supported.label}`);
+        return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Success' };
+    }
+}
+export class MatterbridgeRvcOperationalStateServer extends RvcOperationalStateServer {
+    pause() {
+        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        device.log.info('MatterbridgeRvcOperationalStateServer: pause called setting operational state to Paused and currentMode to Idle');
+        device.pause();
+        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 1;
+        this.state.operationalState = RvcOperationalState.OperationalState.Paused;
+        this.state.operationalError = { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateLabel: 'No Error', errorStateDetails: 'Fully operational' };
+        return {
+            commandResponseState: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
+        };
+    }
+    resume() {
+        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        device.log.info('MatterbridgeRvcOperationalStateServer: resume called setting operational state to Running and currentMode to Cleaning');
+        device.resume();
+        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 2;
+        this.state.operationalState = RvcOperationalState.OperationalState.Running;
+        this.state.operationalError = { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateLabel: 'No Error', errorStateDetails: 'Fully operational' };
+        return {
+            commandResponseState: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
+        };
+    }
+    goHome() {
+        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        device.log.info('MatterbridgeRvcOperationalStateServer: goHome called setting operational state to Docked and currentMode to Idle');
+        device.goHome();
+        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 1;
+        this.state.operationalState = RvcOperationalState.OperationalState.Docked;
+        this.state.operationalError = { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateLabel: 'No Error', errorStateDetails: 'Fully operational' };
+        return {
+            commandResponseState: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
+        };
+    }
+}
+export class MatterbridgeServiceAreaServer extends ServiceAreaServer {
+    selectAreas({ newAreas }) {
+        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        for (const area of newAreas) {
+            const supportedArea = this.state.supportedAreas.find((supportedArea) => supportedArea.areaId === area);
+            if (!supportedArea) {
+                device.log.error(`MatterbridgeServiceAreaServer selectAreas called with unsupported area: ${area}`);
+                return { status: ServiceArea.SelectAreasStatus.UnsupportedArea, statusText: 'Unsupported areas' };
+            }
+        }
+        device.selectAreas({ newAreas });
+        this.state.selectedAreas = newAreas;
+        this.state.currentArea = newAreas[0];
+        device.log.info(`MatterbridgeServiceAreaServer selectAreas called with: ${newAreas.map((area) => area.toString()).join(', ')}`);
+        device.selectAreas({ newAreas });
+        return { status: ServiceArea.SelectAreasStatus.Success, statusText: 'Succesfully selected new areas' };
+    }
+}