matterbridge 3.4.3-dev-20251209-e6cb85f → 3.4.3

package/dist/devices/oven.js

@@ -1,13 +1,49 @@
+/**
+ * @description This file contains the Oven class.
+ * @file src/devices/oven.ts
+ * @author Luca Liguori
+ * @created 2025-05-25
+ * @version 1.1.0
+ * @license Apache-2.0
+ *
+ * Copyright 2025, 2026, 2027 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 { ModeBase } from '@matter/types/clusters/mode-base';
 import { OvenMode } from '@matter/types/clusters/oven-mode';
 import { OperationalState } from '@matter/types/clusters/operational-state';
 import { OvenModeServer } from '@matter/node/behaviors/oven-mode';
 import { OvenCavityOperationalStateServer } from '@matter/node/behaviors/oven-cavity-operational-state';
+// Matterbridge
 import { oven, powerSource, temperatureControlledCabinetHeater } from '../matterbridgeDeviceTypes.js';
 import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 import { MatterbridgeServer } from '../matterbridgeBehaviors.js';
 import { createLevelTemperatureControlClusterServer } from './temperatureControl.js';
 export class Oven extends MatterbridgeEndpoint {
+    /**
+     * Creates an instance of the Oven class.
+     *
+     * @param {string} name - The name of the oven.
+     * @param {string} serial - The serial number of the oven.
+     *
+     * @remarks
+     * 13.9 An oven represents a device that contains one or more cabinets, and optionally a single cooktop,
+     * that are all capable of heating food. Examples of consumer products implementing this device type
+     * include ovens, wall ovens, convection ovens, etc.
+     * An oven is always defined via endpoint composition.
+     * - Use `addCabinet` to add one or more cabinets to the oven.
+     */
     constructor(name, serial) {
         super([oven, powerSource], { id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` });
         this.createDefaultIdentifyClusterServer();
@@ -15,6 +51,25 @@ export class Oven extends MatterbridgeEndpoint {
         this.createDefaultPowerSourceWiredClusterServer();
         this.addFixedLabel('composed', 'Oven');
     }
+    /**
+     * Adds a Temperature Controlled Cabinet Heater to the oven.
+     *
+     * @param {string} name - The name of the cabinet.
+     * @param {Semtag[]} tagList - The tagList associated with the cabinet.
+     * @param {number} currentMode - The current mode of the cabinet. Defaults to 2 (which corresponds to 'Convection').
+     * @param {OvenMode.ModeOption[]} supportedModes - The supported modes of the cabinet. Defaults to a set of common oven modes.
+     * @param {number} selectedTemperatureLevel - The selected temperature level as an index of the supportedTemperatureLevels array. Defaults to 1 (which corresponds to 'Warm').
+     * @param {string[]} supportedTemperatureLevels - The list of supported temperature levels for the cabinet. Defaults to ['Defrost', '180°', '190°', '200°', '250°', '300°'].
+     * @param {OperationalState.OperationalStateEnum} operationalState - The initial operational state of the cabinet. Defaults to Stopped.
+     * @param {number} [currentPhase] - Optional: the current phase of the cabinet.
+     * @param {string[]} [phaseList] - Optional: the list of phases for the cabinet.
+     *
+     * @returns {MatterbridgeEndpoint} The MatterbridgeEndpoint instance representing the cabinet.
+     *
+     * @remarks
+     * 13.4.1 A Temperature Controlled Cabinet Heater is a device that provides a heated space for warming food.
+     * It is typically installed within an oven and can be used in conjunction with other heating elements.
+     */
     addCabinet(name, tagList, currentMode = 2, supportedModes = [
         { label: 'Bake', mode: 1, modeTags: [{ value: OvenMode.ModeTag.Bake }] },
         { label: 'Convection', mode: 2, modeTags: [{ value: OvenMode.ModeTag.Convection }] },
@@ -36,6 +91,19 @@ export class Oven extends MatterbridgeEndpoint {
         this.createDefaultOvenCavityOperationalStateClusterServer(cabinet, operationalState, currentPhase, phaseList);
         return cabinet;
     }
+    /**
+     * Creates a default OvenMode Cluster Server.
+     *
+     * @param {MatterbridgeEndpoint} endpoint - The Matterbridge endpoint instance.
+     * @param {number} currentMode - The current mode of the oven.
+     * @param {OvenMode.ModeOption[]} supportedModes - The supported modes of the oven.
+     *
+     * @returns {MatterbridgeEndpoint} The current MatterbridgeEndpoint instance for chaining.
+     *
+     * @remarks
+     * - supportedModes is a fixed attribute. It cannot be changed at runtime.
+     * - currentMode persists across reboots.
+     */
     createDefaultOvenModeClusterServer(endpoint, currentMode, supportedModes) {
         endpoint.behaviors.require(MatterbridgeOvenModeServer, {
             supportedModes,
@@ -43,6 +111,20 @@ export class Oven extends MatterbridgeEndpoint {
         });
         return endpoint;
     }
+    /**
+     * Creates a default Oven Cavity Operational State Cluster Server.
+     *
+     * @param {MatterbridgeEndpoint} endpoint - The Matterbridge endpoint instance.
+     * @param {OperationalState.OperationalStateEnum} operationalState - The initial operational state.
+     * @param {number} [currentPhase] - The current phase of the oven cavity.
+     * @param {string[]} [phaseList] - The list of phases for the oven cavity.
+     *
+     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
+     *
+     * @remarks
+     * For this derived cluster, only these pre-defined strings may be used in the PhaseList attribute:
+     * "pre-heating", "pre-heated", and "cooling down".
+     */
     createDefaultOvenCavityOperationalStateClusterServer(endpoint, operationalState = OperationalState.OperationalStateEnum.Stopped, currentPhase, phaseList) {
         endpoint.behaviors.require(MatterbridgeOvenCavityOperationalStateServer, {
             phaseList: phaseList || null,
@@ -54,6 +136,7 @@ export class Oven extends MatterbridgeEndpoint {
         return endpoint;
     }
 }
+// Server for OvenMode
 export class MatterbridgeOvenModeServer extends OvenModeServer {
     initialize() {
         const device = this.endpoint.stateOf(MatterbridgeServer);
@@ -73,6 +156,7 @@ export class MatterbridgeOvenModeServer extends OvenModeServer {
         }
     }
 }
+// Server for OvenCavityOperationalState
 export class MatterbridgeOvenCavityOperationalStateServer extends OvenCavityOperationalStateServer {
     initialize() {
         const device = this.endpoint.stateOf(MatterbridgeServer);
@@ -99,3 +183,4 @@ export class MatterbridgeOvenCavityOperationalStateServer extends OvenCavityOper
         };
     }
 }
+//# sourceMappingURL=oven.js.map

package/dist/devices/oven.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oven.js","sourceRoot":"","sources":["../../src/devices/oven.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAKH,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,gCAAgC,EAAE,MAAM,sDAAsD,CAAC;AAExG,eAAe;AACf,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,kCAAkC,EAAE,MAAM,+BAA+B,CAAC;AACtG,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAEjE,OAAO,EAAE,0CAA0C,EAAE,MAAM,yBAAyB,CAAC;AAErF,MAAM,OAAO,IAAK,SAAQ,oBAAoB;IAC5C;;;;;;;;;;;;OAYG;IACH,YAAY,IAAY,EAAE,MAAc;QACtC,KAAK,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAChG,IAAI,CAAC,kCAAkC,EAAE,CAAC;QAC1C,IAAI,CAAC,0CAA0C,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QACtG,IAAI,CAAC,0CAA0C,EAAE,CAAC;QAClD,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CACR,IAAY,EACZ,OAAiB,EACjB,cAAsB,CAAC,EACvB,iBAAwC;QACtC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE;QACxE,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,EAAE;QACpF,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;QAC1E,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;QAC1E,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;QAC1E,EAAE,KAAK,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,EAAE;QAC7F,EAAE,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,EAAE;QAC/F,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,EAAE;QAC9E,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE;QAChF,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;KAC5E,EACD,2BAAmC,CAAC,EACpC,6BAAuC,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAC1F,mBAA0D,gBAAgB,CAAC,oBAAoB,CAAC,OAAO,EACvG,YAAqB,EACrB,SAAoB;QAEpB,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,kCAAkC,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC;QACrG,OAAO,CAAC,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;QAC3B,OAAO,CAAC,kCAAkC,EAAE,CAAC;QAC7C,0CAA0C,CAAC,OAAO,EAAE,wBAAwB,EAAE,0BAA0B,CAAC,CAAC;QAC1G,OAAO,CAAC,gDAAgD,CAAC,IAAI,CAAC,CAAC;QAC/D,IAAI,CAAC,kCAAkC,CAAC,OAAO,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;QAC9E,IAAI,CAAC,oDAAoD,CAAC,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;QAC9G,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,kCAAkC,CAAC,QAA8B,EAAE,WAAmB,EAAE,cAAqC;QAC3H,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,0BAA0B,EAAE;YACrD,cAAc;YACd,WAAW;SACZ,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,oDAAoD,CAClD,QAA8B,EAC9B,mBAA0D,gBAAgB,CAAC,oBAAoB,CAAC,OAAO,EACvG,YAAqB,EACrB,SAAoB;QAEpB,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,4CAA4C,EAAE;YACvE,SAAS,EAAE,SAAS,IAAI,IAAI;YAC5B,YAAY,EAAE,YAAY,IAAI,IAAI;YAClC,oBAAoB,EAAE,CAAC,EAAE,kBAAkB,EAAE,gBAAgB,CAAC,oBAAoB,CAAC,OAAO,EAAE,EAAE,EAAE,kBAAkB,EAAE,gBAAgB,CAAC,oBAAoB,CAAC,OAAO,EAAE,EAAE,EAAE,kBAAkB,EAAE,gBAAgB,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;YACzO,gBAAgB;YAChB,gBAAgB,EAAE,EAAE,YAAY,EAAE,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE;SAChH,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAED,sBAAsB;AACtB,MAAM,OAAO,0BAA2B,SAAQ,cAAc;IACnD,UAAU;QACjB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;IAC5D,CAAC;IACQ,YAAY,CAAC,OAAqC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;QAChH,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,sDAAsD,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,sBAAsB,aAAa,CAAC,IAAI,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC,CAAC;YAC7L,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;YACzC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;QAC9E,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,sDAAsD,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,8BAA8B,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;YAC1K,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,aAAa,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC;QACzF,CAAC;IACH,CAAC;CACF;AAED,wCAAwC;AACxC,MAAM,OAAO,4CAA6C,SAAQ,gCAAgC;IACvF,UAAU;QACjB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,kIAAkI,CAAC,CAAC;QACpJ,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,gBAAgB,CAAC,oBAAoB,CAAC,OAAO,CAAC;QAC5E,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,EAAE,YAAY,EAAE,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;IAC9H,CAAC;IAEQ,IAAI;QACX,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,gEAAgE,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,iFAAiF,CAAC,CAAC;QACrN,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,gBAAgB,CAAC,oBAAoB,CAAC,OAAO,CAAC;QAC5E,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,EAAE,YAAY,EAAE,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;QAC5H,OAAO;YACL,oBAAoB,EAAE,EAAE,YAAY,EAAE,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE;SACrE,CAAC;IACnD,CAAC;IAEQ,KAAK;QACZ,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,iEAAiE,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,iFAAiF,CAAC,CAAC;QACtN,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,gBAAgB,CAAC,oBAAoB,CAAC,OAAO,CAAC;QAC5E,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,EAAE,YAAY,EAAE,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;QAC5H,OAAO;YACL,oBAAoB,EAAE,EAAE,YAAY,EAAE,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE;SACrE,CAAC;IACnD,CAAC;CACF"}

package/dist/devices/refrigerator.d.ts

@@ -0,0 +1,118 @@
+/**
+ * @description This file contains the Refrigerator class.
+ * @file src/devices/refrigerator.ts
+ * @author Luca Liguori
+ * @created 2025-05-25
+ * @version 1.1.0
+ * @license Apache-2.0
+ *
+ * Copyright 2025, 2026, 2027 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 { MaybePromise } from '@matter/general';
+import { Semtag } from '@matter/types';
+import { ModeBase } from '@matter/types/clusters/mode-base';
+import { RefrigeratorAndTemperatureControlledCabinetMode } from '@matter/types/clusters/refrigerator-and-temperature-controlled-cabinet-mode';
+import { RefrigeratorAndTemperatureControlledCabinetModeServer } from '@matter/node/behaviors/refrigerator-and-temperature-controlled-cabinet-mode';
+import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
+export declare class Refrigerator extends MatterbridgeEndpoint {
+    /**
+     * Creates an instance of the Refrigerator class.
+     *
+     * @param {string} name - The name of the refrigerator.
+     * @param {string} serial - The serial number of the refrigerator.
+     *
+     * @remarks
+     * 13.2 A refrigerator represents a device that contains one or more cabinets that are capable of chilling or
+     * freezing food. Examples of consumer products that MAY make use of this device type include refrigerators,
+     * freezers, and wine coolers.
+     * A refrigerator is always defined via endpoint composition.
+     * - Use `addCabinet` to add one or more cabinets to the refrigerator.
+     */
+    constructor(name: string, serial: string);
+    /**
+     * Adds a Level Temperature Controlled Cabinet Cooler to the refrigerator.
+     *
+     * @param {string} name - The name of the cabinet.
+     * @param {Semtag[]} tagList - The tagList associated with the cabinet.
+     * @param {number} currentMode - The current mode of the cabinet. Defaults to 1 (which corresponds to 'Auto').
+     * @param {RefrigeratorAndTemperatureControlledCabinetMode.ModeOption[]} supportedModes - The supported modes for the cabinet. Defaults to 'Auto', 'RapidCool', and 'RapidFreeze'.
+     * @param {number} selectedTemperatureLevel - The selected temperature level as an index of the supportedTemperatureLevels array. Defaults to 2 (which corresponds to 'Level 3').
+     * @param {string[]} supportedTemperatureLevels - The list of supported temperature levels for the cabinet. Defaults to ['Level 1', 'Level 2', 'Level 3', 'Level 4', 'Level 5'].
+     * @param {number} currentTemperature - The current temperature of the cabinet in degrees Celsius. Defaults to 1000 (which corresponds to 10.00 degrees Celsius).
+     *
+     * @returns {MatterbridgeEndpoint} The MatterbridgeEndpoint instance representing the cabinet.
+     *
+     * @remarks
+     * 13.4.1 A Temperature Controlled Cabinet Cooler is a device that provides a cooled space for chilling food.
+     * It is typically installed within a refrigerator.
+     *
+     * Example usage with specific namespace tags:
+     * ```
+     *  refrigerator.addCabinet('Refrigerator Top', [
+     *    { mfgCode: null, namespaceId: PositionTag.Top.namespaceId, tag: PositionTag.Top.tag, label: 'Refrigerator Top' },
+     *    { mfgCode: null, namespaceId: RefrigeratorTag.Refrigerator.namespaceId, tag: RefrigeratorTag.Refrigerator.tag, label: RefrigeratorTag.Refrigerator.label },
+     *  ]);
+     *  refrigerator.addCabinet('Freezer Bottom', [
+     *    { mfgCode: null, namespaceId: PositionTag.Bottom.namespaceId, tag: PositionTag.Bottom.tag, label: 'Freezer Bottom' },
+     *    { mfgCode: null, namespaceId: RefrigeratorTag.Freezer.namespaceId, tag: RefrigeratorTag.Freezer.tag, label: RefrigeratorTag.Freezer.label },
+     *  ]);
+     * ```
+     */
+    addCabinet(name: string, tagList: Semtag[], currentMode?: number, supportedModes?: RefrigeratorAndTemperatureControlledCabinetMode.ModeOption[], selectedTemperatureLevel?: number, supportedTemperatureLevels?: string[], currentTemperature?: number): MatterbridgeEndpoint;
+    /**
+     * Creates a default RefrigeratorAndTemperatureControlledCabinetMode Cluster Server.
+     *
+     * @param {MatterbridgeEndpoint} endpoint - The Matterbridge endpoint instance.
+     * @param {number} currentMode - The current mode of the oven.
+     * @param {RefrigeratorAndTemperatureControlledCabinetMode.ModeOption[]} supportedModes - The supported modes for the refrigerator and temperature controlled cabinet.
+     *
+     * @returns {MatterbridgeEndpoint} The current MatterbridgeEndpoint instance for chaining.
+     *
+     * @remarks
+     * - supportedModes is a fixed attribute. It cannot be changed at runtime.
+     * - currentMode persists across reboots.
+     */
+    createDefaultRefrigeratorAndTemperatureControlledCabinetModeClusterServer(endpoint: MatterbridgeEndpoint, currentMode: number, supportedModes: RefrigeratorAndTemperatureControlledCabinetMode.ModeOption[]): MatterbridgeEndpoint;
+    /**
+     * Creates a default RefrigeratorAlarm Cluster Server.
+     *
+     * @param {MatterbridgeEndpoint} endpoint - The Matterbridge endpoint instance.
+     * @param {boolean} doorOpen - Indicates if the refrigerator door is open.
+     *
+     * @returns {MatterbridgeEndpoint} The updated MatterbridgeEndpoint instance.
+     */
+    createDefaultRefrigeratorAlarmClusterServer(endpoint: MatterbridgeEndpoint, doorOpen?: boolean): MatterbridgeEndpoint;
+    /**
+     * Sets the door open state for a specific cabinet.
+     *
+     * @param {string} cabinetName - The name of the cabinet.
+     * @param {boolean} doorOpen - Indicates if the door is open.
+     * @returns {MatterbridgeEndpoint | undefined} The updated MatterbridgeEndpoint instance or undefined if not found.
+     */
+    setDoorOpenState(cabinetName: string, doorOpen: boolean): Promise<MatterbridgeEndpoint | undefined>;
+    /**
+     * Triggers the notify event for door open state on a specific cabinet.
+     *
+     * @param {string} cabinetName - The name of the cabinet.
+     * @param {boolean} doorOpen - Indicates if the door is open.
+     * @returns {MatterbridgeEndpoint | undefined} The updated MatterbridgeEndpoint instance or undefined if not found.
+     */
+    triggerDoorOpenState(cabinetName: string, doorOpen: boolean): Promise<MatterbridgeEndpoint | undefined>;
+}
+export declare class MatterbridgeRefrigeratorAndTemperatureControlledCabinetModeServer extends RefrigeratorAndTemperatureControlledCabinetModeServer {
+    initialize(): void;
+    changeToMode(request: ModeBase.ChangeToModeRequest): MaybePromise<ModeBase.ChangeToModeResponse>;
+}
+//# sourceMappingURL=refrigerator.d.ts.map

package/dist/devices/refrigerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"refrigerator.d.ts","sourceRoot":"","sources":["../../src/devices/refrigerator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,+CAA+C,EAAE,MAAM,6EAA6E,CAAC;AAC9I,OAAO,EAAE,qDAAqD,EAAE,MAAM,6EAA6E,CAAC;AAKpJ,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAKlE,qBAAa,YAAa,SAAQ,oBAAoB;IACpD;;;;;;;;;;;;OAYG;gBACS,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAQxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,UAAU,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EAAE,EACjB,WAAW,GAAE,MAAU,EACvB,cAAc,GAAE,+CAA+C,CAAC,UAAU,EAIzE,EACD,wBAAwB,GAAE,MAAU,EACpC,0BAA0B,GAAE,MAAM,EAA4D,EAC9F,kBAAkB,GAAE,MAAa,GAChC,oBAAoB;IAWvB;;;;;;;;;;;;OAYG;IACH,yEAAyE,CAAC,QAAQ,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,+CAA+C,CAAC,UAAU,EAAE,GAAG,oBAAoB;IAQlO;;;;;;;OAOG;IACH,2CAA2C,CAAC,QAAQ,EAAE,oBAAoB,EAAE,QAAQ,GAAE,OAAe,GAAG,oBAAoB;IAS5H;;;;;;OAMG;IACG,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;IAQzG;;;;;;OAMG;IACG,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;CAW9G;AAGD,qBAAa,iEAAkE,SAAQ,qDAAqD;IACjI,UAAU;IAIV,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,mBAAmB,GAAG,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC;CAY1G"}

package/dist/devices/refrigerator.js

@@ -1,12 +1,48 @@
+/**
+ * @description This file contains the Refrigerator class.
+ * @file src/devices/refrigerator.ts
+ * @author Luca Liguori
+ * @created 2025-05-25
+ * @version 1.1.0
+ * @license Apache-2.0
+ *
+ * Copyright 2025, 2026, 2027 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 { ModeBase } from '@matter/types/clusters/mode-base';
 import { RefrigeratorAndTemperatureControlledCabinetMode } from '@matter/types/clusters/refrigerator-and-temperature-controlled-cabinet-mode';
 import { RefrigeratorAndTemperatureControlledCabinetModeServer } from '@matter/node/behaviors/refrigerator-and-temperature-controlled-cabinet-mode';
 import { RefrigeratorAlarmServer } from '@matter/node/behaviors/refrigerator-alarm';
+// Matterbridge
 import { powerSource, refrigerator, temperatureControlledCabinetCooler } from '../matterbridgeDeviceTypes.js';
 import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 import { MatterbridgeServer } from '../matterbridgeBehaviors.js';
 import { createLevelTemperatureControlClusterServer } from './temperatureControl.js';
 export class Refrigerator extends MatterbridgeEndpoint {
+    /**
+     * Creates an instance of the Refrigerator class.
+     *
+     * @param {string} name - The name of the refrigerator.
+     * @param {string} serial - The serial number of the refrigerator.
+     *
+     * @remarks
+     * 13.2 A refrigerator represents a device that contains one or more cabinets that are capable of chilling or
+     * freezing food. Examples of consumer products that MAY make use of this device type include refrigerators,
+     * freezers, and wine coolers.
+     * A refrigerator is always defined via endpoint composition.
+     * - Use `addCabinet` to add one or more cabinets to the refrigerator.
+     */
     constructor(name, serial) {
         super([refrigerator, powerSource], { id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer();
@@ -14,6 +50,35 @@ export class Refrigerator extends MatterbridgeEndpoint {
         this.createDefaultPowerSourceWiredClusterServer();
         this.addFixedLabel('composed', 'Refrigerator');
     }
+    /**
+     * Adds a Level Temperature Controlled Cabinet Cooler to the refrigerator.
+     *
+     * @param {string} name - The name of the cabinet.
+     * @param {Semtag[]} tagList - The tagList associated with the cabinet.
+     * @param {number} currentMode - The current mode of the cabinet. Defaults to 1 (which corresponds to 'Auto').
+     * @param {RefrigeratorAndTemperatureControlledCabinetMode.ModeOption[]} supportedModes - The supported modes for the cabinet. Defaults to 'Auto', 'RapidCool', and 'RapidFreeze'.
+     * @param {number} selectedTemperatureLevel - The selected temperature level as an index of the supportedTemperatureLevels array. Defaults to 2 (which corresponds to 'Level 3').
+     * @param {string[]} supportedTemperatureLevels - The list of supported temperature levels for the cabinet. Defaults to ['Level 1', 'Level 2', 'Level 3', 'Level 4', 'Level 5'].
+     * @param {number} currentTemperature - The current temperature of the cabinet in degrees Celsius. Defaults to 1000 (which corresponds to 10.00 degrees Celsius).
+     *
+     * @returns {MatterbridgeEndpoint} The MatterbridgeEndpoint instance representing the cabinet.
+     *
+     * @remarks
+     * 13.4.1 A Temperature Controlled Cabinet Cooler is a device that provides a cooled space for chilling food.
+     * It is typically installed within a refrigerator.
+     *
+     * Example usage with specific namespace tags:
+     * ```
+     *  refrigerator.addCabinet('Refrigerator Top', [
+     *    { mfgCode: null, namespaceId: PositionTag.Top.namespaceId, tag: PositionTag.Top.tag, label: 'Refrigerator Top' },
+     *    { mfgCode: null, namespaceId: RefrigeratorTag.Refrigerator.namespaceId, tag: RefrigeratorTag.Refrigerator.tag, label: RefrigeratorTag.Refrigerator.label },
+     *  ]);
+     *  refrigerator.addCabinet('Freezer Bottom', [
+     *    { mfgCode: null, namespaceId: PositionTag.Bottom.namespaceId, tag: PositionTag.Bottom.tag, label: 'Freezer Bottom' },
+     *    { mfgCode: null, namespaceId: RefrigeratorTag.Freezer.namespaceId, tag: RefrigeratorTag.Freezer.tag, label: RefrigeratorTag.Freezer.label },
+     *  ]);
+     * ```
+     */
     addCabinet(name, tagList, currentMode = 1, supportedModes = [
         { label: 'Auto', mode: 1, modeTags: [{ value: RefrigeratorAndTemperatureControlledCabinetMode.ModeTag.Auto }] },
         { label: 'RapidCool', mode: 2, modeTags: [{ value: RefrigeratorAndTemperatureControlledCabinetMode.ModeTag.RapidCool }] },
@@ -28,6 +93,19 @@ export class Refrigerator extends MatterbridgeEndpoint {
         cabinet.createDefaultTemperatureMeasurementClusterServer(currentTemperature);
         return cabinet;
     }
+    /**
+     * Creates a default RefrigeratorAndTemperatureControlledCabinetMode Cluster Server.
+     *
+     * @param {MatterbridgeEndpoint} endpoint - The Matterbridge endpoint instance.
+     * @param {number} currentMode - The current mode of the oven.
+     * @param {RefrigeratorAndTemperatureControlledCabinetMode.ModeOption[]} supportedModes - The supported modes for the refrigerator and temperature controlled cabinet.
+     *
+     * @returns {MatterbridgeEndpoint} The current MatterbridgeEndpoint instance for chaining.
+     *
+     * @remarks
+     * - supportedModes is a fixed attribute. It cannot be changed at runtime.
+     * - currentMode persists across reboots.
+     */
     createDefaultRefrigeratorAndTemperatureControlledCabinetModeClusterServer(endpoint, currentMode, supportedModes) {
         endpoint.behaviors.require(MatterbridgeRefrigeratorAndTemperatureControlledCabinetModeServer, {
             supportedModes,
@@ -35,6 +113,14 @@ export class Refrigerator extends MatterbridgeEndpoint {
         });
         return endpoint;
     }
+    /**
+     * Creates a default RefrigeratorAlarm Cluster Server.
+     *
+     * @param {MatterbridgeEndpoint} endpoint - The Matterbridge endpoint instance.
+     * @param {boolean} doorOpen - Indicates if the refrigerator door is open.
+     *
+     * @returns {MatterbridgeEndpoint} The updated MatterbridgeEndpoint instance.
+     */
     createDefaultRefrigeratorAlarmClusterServer(endpoint, doorOpen = false) {
         endpoint.behaviors.require(RefrigeratorAlarmServer, {
             mask: { doorOpen: true },
@@ -43,6 +129,13 @@ export class Refrigerator extends MatterbridgeEndpoint {
         });
         return endpoint;
     }
+    /**
+     * Sets the door open state for a specific cabinet.
+     *
+     * @param {string} cabinetName - The name of the cabinet.
+     * @param {boolean} doorOpen - Indicates if the door is open.
+     * @returns {MatterbridgeEndpoint | undefined} The updated MatterbridgeEndpoint instance or undefined if not found.
+     */
     async setDoorOpenState(cabinetName, doorOpen) {
         const endpoint = this.getChildEndpointByName(cabinetName);
         if (endpoint) {
@@ -50,6 +143,13 @@ export class Refrigerator extends MatterbridgeEndpoint {
             return endpoint;
         }
     }
+    /**
+     * Triggers the notify event for door open state on a specific cabinet.
+     *
+     * @param {string} cabinetName - The name of the cabinet.
+     * @param {boolean} doorOpen - Indicates if the door is open.
+     * @returns {MatterbridgeEndpoint | undefined} The updated MatterbridgeEndpoint instance or undefined if not found.
+     */
     async triggerDoorOpenState(cabinetName, doorOpen) {
         const endpoint = this.getChildEndpointByName(cabinetName);
         if (endpoint) {
@@ -63,6 +163,7 @@ export class Refrigerator extends MatterbridgeEndpoint {
         }
     }
 }
+// Server for RefrigeratorAndTemperatureControlledCabinetMode
 export class MatterbridgeRefrigeratorAndTemperatureControlledCabinetModeServer extends RefrigeratorAndTemperatureControlledCabinetModeServer {
     initialize() {
         const device = this.endpoint.stateOf(MatterbridgeServer);
@@ -82,3 +183,4 @@ export class MatterbridgeRefrigeratorAndTemperatureControlledCabinetModeServer e
         }
     }
 }
+//# sourceMappingURL=refrigerator.js.map

package/dist/devices/refrigerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"refrigerator.js","sourceRoot":"","sources":["../../src/devices/refrigerator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAKH,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,+CAA+C,EAAE,MAAM,6EAA6E,CAAC;AAC9I,OAAO,EAAE,qDAAqD,EAAE,MAAM,6EAA6E,CAAC;AACpJ,OAAO,EAAE,uBAAuB,EAAE,MAAM,2CAA2C,CAAC;AAEpF,eAAe;AACf,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,kCAAkC,EAAE,MAAM,+BAA+B,CAAC;AAC9G,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAEjE,OAAO,EAAE,0CAA0C,EAAE,MAAM,yBAAyB,CAAC;AAErF,MAAM,OAAO,YAAa,SAAQ,oBAAoB;IACpD;;;;;;;;;;;;OAYG;IACH,YAAY,IAAY,EAAE,MAAc;QACtC,KAAK,CAAC,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QAC9G,IAAI,CAAC,kCAAkC,EAAE,CAAC;QAC1C,IAAI,CAAC,0CAA0C,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;QAC9G,IAAI,CAAC,0CAA0C,EAAE,CAAC;QAClD,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,UAAU,CACR,IAAY,EACZ,OAAiB,EACjB,cAAsB,CAAC,EACvB,iBAA+E;QAC7E,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,+CAA+C,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE;QAC/G,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,+CAA+C,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE;QACzH,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,+CAA+C,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,EAAE;KAC9H,EACD,2BAAmC,CAAC,EACpC,6BAAuC,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC,EAC9F,qBAA6B,IAAI;QAEjC,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,kCAAkC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/F,OAAO,CAAC,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;QAC3B,OAAO,CAAC,kCAAkC,EAAE,CAAC;QAC7C,0CAA0C,CAAC,OAAO,EAAE,wBAAwB,EAAE,0BAA0B,CAAC,CAAC;QAC1G,IAAI,CAAC,yEAAyE,CAAC,OAAO,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;QACrH,IAAI,CAAC,2CAA2C,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACjE,OAAO,CAAC,gDAAgD,CAAC,kBAAkB,CAAC,CAAC;QAC7E,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,yEAAyE,CAAC,QAA8B,EAAE,WAAmB,EAAE,cAA4E;QACzM,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,iEAAiE,EAAE;YAC5F,cAAc;YACd,WAAW;SACZ,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,2CAA2C,CAAC,QAA8B,EAAE,WAAoB,KAAK;QACnG,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,uBAAuB,EAAE;YAClD,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;YACxB,SAAS,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;YAC7B,KAAK,EAAE,EAAE,QAAQ,EAAE;SACpB,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CAAC,WAAmB,EAAE,QAAiB;QAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QAC1D,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,QAAQ,CAAC,YAAY,CAAC,mBAAmB,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;YACtF,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,oBAAoB,CAAC,WAAmB,EAAE,QAAiB;QAC/D,MAAM,QAAQ,GAAG,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QAC1D,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,QAAQ,CAAC,YAAY,CAAC,mBAAmB,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC/L,CAAC;iBAAM,CAAC;gBACN,MAAM,QAAQ,CAAC,YAAY,CAAC,mBAAmB,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;YAChM,CAAC;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;CACF;AAED,6DAA6D;AAC7D,MAAM,OAAO,iEAAkE,SAAQ,qDAAqD;IACjI,UAAU;QACjB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,+EAA+E,CAAC,CAAC;IACnG,CAAC;IACQ,YAAY,CAAC,OAAqC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;QAChH,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,6FAA6F,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,sBAAsB,aAAa,CAAC,IAAI,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC,CAAC;YACpO,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;YACzC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;QAC9E,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,6FAA6F,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,8BAA8B,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;YACjN,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,aAAa,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC;QACzF,CAAC;IACH,CAAC;CACF"}

package/dist/devices/roboticVacuumCleaner.d.ts

@@ -0,0 +1,112 @@
+/**
+ * @description This file contains the RoboticVacuumCleaner class.
+ * @file src/devices/roboticVacuumCleaner.ts
+ * @author Luca Liguori
+ * @created 2025-05-01
+ * @version 1.1.0
+ * @license Apache-2.0
+ *
+ * Copyright 2025, 2026, 2027 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 { MaybePromise } from '@matter/general';
+import { RvcRunMode } from '@matter/types/clusters/rvc-run-mode';
+import { RvcCleanMode } from '@matter/types/clusters/rvc-clean-mode';
+import { RvcOperationalState } from '@matter/types/clusters/rvc-operational-state';
+import { ServiceArea } from '@matter/types/clusters/service-area';
+import { ModeBase } from '@matter/types/clusters/mode-base';
+import { OperationalState } from '@matter/types/clusters/operational-state';
+import { RvcRunModeServer } from '@matter/node/behaviors/rvc-run-mode';
+import { RvcOperationalStateServer } from '@matter/node/behaviors/rvc-operational-state';
+import { RvcCleanModeServer } from '@matter/node/behaviors/rvc-clean-mode';
+import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
+export declare class RoboticVacuumCleaner extends MatterbridgeEndpoint {
+    /**
+     * Creates an instance of the RoboticVacuumCleaner class.
+     *
+     * @param {string} name - The name of the robotic vacuum cleaner.
+     * @param {string} serial - The serial number of the robotic vacuum cleaner.
+     * @param {'server' | 'matter' | undefined} [mode] - The mode of the robotic vacuum cleaner. Defaults to undefined. Use 'server' or 'matter' if you want Apple Home compatibility.
+     * @param {number} [currentRunMode] - The current run mode of the robotic vacuum cleaner. Defaults to 1 (Idle).
+     * @param {RvcRunMode.ModeOption[]} [supportedRunModes] - The supported run modes for the robotic vacuum cleaner. Defaults to a predefined set of modes.
+     * @param {number} [currentCleanMode] - The current clean mode of the robotic vacuum cleaner. Defaults to 1 (Vacuum).
+     * @param {RvcCleanMode.ModeOption[]} [supportedCleanModes] - The supported clean modes for the robotic vacuum cleaner. Defaults to a predefined set of modes.
+     * @param {number | null} [currentPhase] - The current phase of the robotic vacuum cleaner. Defaults to null.
+     * @param {string[] | null} [phaseList] - The list of phases for the robotic vacuum cleaner. Defaults to null.
+     * @param {RvcOperationalState.OperationalState} [operationalState] - The current operational state of the robotic vacuum cleaner. Defaults to Docked.
+     * @param {RvcOperationalState.OperationalStateStruct[]} [operationalStateList] - The list of operational states for the robotic vacuum cleaner. Defaults to a predefined set of states.
+     * @param {ServiceArea.Area[]} [supportedAreas] - The supported areas for the robotic vacuum cleaner. Defaults to a predefined set of areas.
+     * @param {number[]} [selectedAreas] - The selected areas for the robotic vacuum cleaner. Defaults to an empty array (all areas allowed).
+     * @param {number} [currentArea] - The current area of the robotic vacuum cleaner. Defaults to 1 (Living).
+     * @param {ServiceArea.Map[]} [supportedMaps] - The supported maps for the robotic vacuum cleaner. Defaults to empty list.
+     */
+    constructor(name: string, serial: string, mode?: 'server' | 'matter' | undefined, currentRunMode?: number, supportedRunModes?: RvcRunMode.ModeOption[], currentCleanMode?: number, supportedCleanModes?: RvcCleanMode.ModeOption[], currentPhase?: number | null, phaseList?: string[] | null, operationalState?: RvcOperationalState.OperationalState, operationalStateList?: RvcOperationalState.OperationalStateStruct[], supportedAreas?: ServiceArea.Area[], selectedAreas?: number[], currentArea?: number, supportedMaps?: ServiceArea.Map[]);
+    /**
+     * Creates a default RvcRunMode Cluster Server.
+     *
+     * @param {number} [currentMode] - The current mode of the RvcRunMode cluster. Defaults to 1 (Idle).
+     * @param {RvcRunMode.ModeOption[]} [supportedModes] - The supported modes for the RvcRunMode cluster. Defaults to a predefined set of modes.
+     *
+     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
+     *
+     * @remarks
+     * - supportedModes is a fixed attribute that defines the run modes available for the robotic vacuum cleaner.
+     */
+    createDefaultRvcRunModeClusterServer(currentMode?: number, supportedModes?: RvcRunMode.ModeOption[]): this;
+    /**
+     * Creates a default RvcCleanMode Cluster Server.
+     *
+     * @param {number} [currentMode] - The current mode of the RvcCleanMode cluster. Defaults to 1 (Vacuum).
+     * @param {RvcCleanMode.ModeOption[]} [supportedModes] - The supported modes for the RvcCleanMode cluster. Defaults to a predefined set of modes.
+     *
+     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
+     *
+     * @remarks
+     * - supportedModes is a fixed attribute that defines the clean modes available for the robotic vacuum cleaner.
+     */
+    createDefaultRvcCleanModeClusterServer(currentMode?: number, supportedModes?: RvcCleanMode.ModeOption[]): this;
+    /**
+     * Creates a default ServiceArea Cluster Server.
+     *
+     * @param {ServiceArea.Area[]} [supportedAreas] - The supported areas for the ServiceArea cluster. Defaults to a predefined set of areas.
+     * @param {number[]} [selectedAreas] - The selected areas for the ServiceArea cluster. Defaults to an empty array (all areas allowed).
+     * @param {number} [currentArea] - The current areaId (not the index in the array!) of the ServiceArea cluster. Defaults to 1 (Living).
+     * @param {ServiceArea.Map[]} [supportedMaps] - The supported maps for the robotic vacuum cleaner. Defaults empty list.
+     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
+     */
+    createDefaultServiceAreaClusterServer(supportedAreas?: ServiceArea.Area[], selectedAreas?: number[], currentArea?: number, supportedMaps?: ServiceArea.Map[]): this;
+    /**
+     * Creates a default RvcOperationalState Cluster Server.
+     *
+     * @param {string[] | null} [phaseList] - The list of phases for the RvcOperationalState cluster. Defaults to null.
+     * @param {number | null} [currentPhase] - The current phase (the index of the phaseList) of the RvcOperationalState cluster. Defaults to null.
+     * @param {RvcOperationalState.OperationalStateStruct[]} [operationalStateList] - The list of operational states for the RvcOperationalState cluster. Defaults to a predefined set of states.
+     * @param {RvcOperationalState.OperationalState} [operationalState] - The current operationalStateId of the RvcOperationalState cluster. Defaults to Docked.
+     * @param {RvcOperationalState.ErrorStateStruct} [operationalError] - The current operational error of the RvcOperationalState cluster. Defaults to NoError.
+     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
+     */
+    createDefaultRvcOperationalStateClusterServer(phaseList?: string[] | null, currentPhase?: number | null, operationalStateList?: RvcOperationalState.OperationalStateStruct[], operationalState?: RvcOperationalState.OperationalState, operationalError?: RvcOperationalState.ErrorStateStruct): this;
+}
+export declare class MatterbridgeRvcRunModeServer extends RvcRunModeServer {
+    changeToMode(request: ModeBase.ChangeToModeRequest): MaybePromise<ModeBase.ChangeToModeResponse>;
+}
+export declare class MatterbridgeRvcCleanModeServer extends RvcCleanModeServer {
+    changeToMode(request: ModeBase.ChangeToModeRequest): MaybePromise<ModeBase.ChangeToModeResponse>;
+}
+export declare class MatterbridgeRvcOperationalStateServer extends RvcOperationalStateServer {
+    pause(): MaybePromise<OperationalState.OperationalCommandResponse>;
+    resume(): MaybePromise<OperationalState.OperationalCommandResponse>;
+    goHome(): MaybePromise<OperationalState.OperationalCommandResponse>;
+}
+//# sourceMappingURL=roboticVacuumCleaner.d.ts.map

package/dist/devices/roboticVacuumCleaner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roboticVacuumCleaner.d.ts","sourceRoot":"","sources":["../../src/devices/roboticVacuumCleaner.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAC;AACnF,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,yBAAyB,EAAE,MAAM,8CAA8C,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAG3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAIlE,qBAAa,oBAAqB,SAAQ,oBAAoB;IAC5D;;;;;;;;;;;;;;;;;;OAkBG;gBAED,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,IAAI,GAAE,QAAQ,GAAG,QAAQ,GAAG,SAAqB,EACjD,cAAc,CAAC,EAAE,MAAM,EACvB,iBAAiB,CAAC,EAAE,UAAU,CAAC,UAAU,EAAE,EAC3C,gBAAgB,CAAC,EAAE,MAAM,EACzB,mBAAmB,CAAC,EAAE,YAAY,CAAC,UAAU,EAAE,EAC/C,YAAY,GAAE,MAAM,GAAG,IAAW,EAClC,SAAS,GAAE,MAAM,EAAE,GAAG,IAAW,EACjC,gBAAgB,CAAC,EAAE,mBAAmB,CAAC,gBAAgB,EACvD,oBAAoB,CAAC,EAAE,mBAAmB,CAAC,sBAAsB,EAAE,EACnE,cAAc,CAAC,EAAE,WAAW,CAAC,IAAI,EAAE,EACnC,aAAa,CAAC,EAAE,MAAM,EAAE,EACxB,WAAW,CAAC,EAAE,MAAM,EACpB,aAAa,CAAC,EAAE,WAAW,CAAC,GAAG,EAAE;IAYnC;;;;;;;;;;OAUG;IACH,oCAAoC,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,UAAU,CAAC,UAAU,EAAE,GAAG,IAAI;IAa1G;;;;;;;;;;OAUG;IACH,sCAAsC,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,YAAY,CAAC,UAAU,EAAE,GAAG,IAAI;IAY9G;;;;;;;;OAQG;IACH,qCAAqC,CAAC,cAAc,CAAC,EAAE,WAAW,CAAC,IAAI,EAAE,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,IAAI;IAqCnK;;;;;;;;;OASG;IACH,6CAA6C,CAC3C,SAAS,GAAE,MAAM,EAAE,GAAG,IAAW,EACjC,YAAY,GAAE,MAAM,GAAG,IAAW,EAClC,oBAAoB,CAAC,EAAE,mBAAmB,CAAC,sBAAsB,EAAE,EACnE,gBAAgB,CAAC,EAAE,mBAAmB,CAAC,gBAAgB,EACvD,gBAAgB,CAAC,EAAE,mBAAmB,CAAC,gBAAgB,GACtD,IAAI;CAkBR;AAED,qBAAa,4BAA6B,SAAQ,gBAAgB;IACvD,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,mBAAmB,GAAG,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC;CAuB1G;AAED,qBAAa,8BAA+B,SAAQ,kBAAkB;IAC3D,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,mBAAmB,GAAG,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC;CAa1G;AAED,qBAAa,qCAAsC,SAAQ,yBAAyB;IACzE,KAAK,IAAI,YAAY,CAAC,gBAAgB,CAAC,0BAA0B,CAAC;IAalE,MAAM,IAAI,YAAY,CAAC,gBAAgB,CAAC,0BAA0B,CAAC;IAanE,MAAM,IAAI,YAAY,CAAC,gBAAgB,CAAC,0BAA0B,CAAC;CAa7E"}