@matter/types 0.17.4 → 0.17.5-alpha.0-20260702-a2cd6f764

package/dist/esm/clusters/oven-cavity-operational-state.d.ts

@@ -18,7 +18,7 @@ import type { MaybePromise } from "@matter/general";
  * This cluster is derived from the Operational State cluster and provides an interface for monitoring the operational
  * state of an oven.
  *
- * @see {@link MatterSpecification.v151.Cluster} § 8.10
+ * @see {@link MatterSpecification.v16.Cluster} § 8.10
  */
 export declare namespace OvenCavityOperationalState {
     /**
@@ -32,7 +32,7 @@ export declare namespace OvenCavityOperationalState {
     export const name: "OvenCavityOperationalState";
 
     /**
-     * The cluster revision assigned by {@link MatterSpecification.v151.Cluster}.
+     * The cluster revision assigned by {@link MatterSpecification.v16.Cluster}.
      */
     export const revision: 2;
 
@@ -56,7 +56,7 @@ export declare namespace OvenCavityOperationalState {
          * A null value indicates that the device does not present phases during its operation. When this attribute's
          * value is null, the CurrentPhase attribute shall also be set to null.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.5.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.5.1
          */
         phaseList: string[] | null;
 
@@ -68,7 +68,7 @@ export declare namespace OvenCavityOperationalState {
          *
          * Null if the PhaseList attribute is null or if the PhaseList attribute is an empty list.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.5.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.5.2
          */
         currentPhase: number | null;
 
@@ -82,7 +82,7 @@ export declare namespace OvenCavityOperationalState {
          * OperationalStateEnum. A device type requiring implementation of this cluster shall define the set of states
          * that are applicable to that specific device type.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.5.4
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.5.4
          */
         operationalStateList: OperationalState.OperationalStateStruct[];
 
@@ -90,7 +90,7 @@ export declare namespace OvenCavityOperationalState {
          * This attribute specifies the current operational state of a device. This shall be populated with a valid
          * OperationalStateID from the set of values in the OperationalStateList Attribute.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.5.5
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.5.5
          */
         operationalState: OperationalState.OperationalStateEnum;
 
@@ -101,7 +101,7 @@ export declare namespace OvenCavityOperationalState {
          *
          * When there is no error detected, this shall have an ErrorStateID of NoError.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.5.6
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.5.6
          */
         operationalError: OperationalState.ErrorStateStruct;
 
@@ -134,7 +134,7 @@ export declare namespace OvenCavityOperationalState {
          * As this attribute is not being reported during a regular countdown, clients SHOULD NOT rely on the reporting
          * of this attribute in order to keep track of the remaining duration.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.5.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.5.3
          */
         countdownTime?: number | null;
     }
@@ -154,7 +154,7 @@ export declare namespace OvenCavityOperationalState {
          * A null value indicates that the device does not present phases during its operation. When this attribute's
          * value is null, the CurrentPhase attribute shall also be set to null.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.5.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.5.1
          */
         phaseList: string[] | null;
 
@@ -166,7 +166,7 @@ export declare namespace OvenCavityOperationalState {
          *
          * Null if the PhaseList attribute is null or if the PhaseList attribute is an empty list.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.5.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.5.2
          */
         currentPhase: number | null;
 
@@ -180,7 +180,7 @@ export declare namespace OvenCavityOperationalState {
          * OperationalStateEnum. A device type requiring implementation of this cluster shall define the set of states
          * that are applicable to that specific device type.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.5.4
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.5.4
          */
         operationalStateList: OperationalState.OperationalStateStruct[];
 
@@ -188,7 +188,7 @@ export declare namespace OvenCavityOperationalState {
          * This attribute specifies the current operational state of a device. This shall be populated with a valid
          * OperationalStateID from the set of values in the OperationalStateList Attribute.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.5.5
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.5.5
          */
         operationalState: OperationalState.OperationalStateEnum;
 
@@ -199,7 +199,7 @@ export declare namespace OvenCavityOperationalState {
          *
          * When there is no error detected, this shall have an ErrorStateID of NoError.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.5.6
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.5.6
          */
         operationalError: OperationalState.ErrorStateStruct;
 
@@ -232,7 +232,7 @@ export declare namespace OvenCavityOperationalState {
          * As this attribute is not being reported during a regular countdown, clients SHOULD NOT rely on the reporting
          * of this attribute in order to keep track of the remaining duration.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.5.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.5.3
          */
         countdownTime: number | null;
     }
@@ -242,12 +242,12 @@ export declare namespace OvenCavityOperationalState {
      */
     export interface BaseCommands {
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.10.5
+         * @see {@link MatterSpecification.v16.Cluster} § 8.10.5
          */
         stop(): MaybePromise<OperationalCommandResponse>;
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.10.5
+         * @see {@link MatterSpecification.v16.Cluster} § 8.10.5
          */
         start(): MaybePromise<OperationalCommandResponse>;
     }
@@ -267,7 +267,7 @@ export declare namespace OvenCavityOperationalState {
          *
          * This event shall contain the following fields:
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.7.1
          */
         operationalError: OperationalState.OperationalErrorEvent;
 
@@ -282,7 +282,7 @@ export declare namespace OvenCavityOperationalState {
          *
          * This event shall contain the following fields:
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.7.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.7.2
          */
         operationCompletion?: OperationalState.OperationCompletionEvent;
     }
@@ -299,7 +299,7 @@ export declare namespace OvenCavityOperationalState {
          *
          * This event shall contain the following fields:
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.7.1
          */
         operationalError: OperationalState.OperationalErrorEvent;
 
@@ -314,7 +314,7 @@ export declare namespace OvenCavityOperationalState {
          *
          * This event shall contain the following fields:
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.7.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.7.2
          */
         operationCompletion: OperationalState.OperationCompletionEvent;
     }
@@ -322,7 +322,7 @@ export declare namespace OvenCavityOperationalState {
     export type Components = [{ flags: {}, attributes: BaseAttributes, commands: BaseCommands, events: BaseEvents }];
 
     /**
-     * @see {@link MatterSpecification.v151.Cluster} § 8.10.5
+     * @see {@link MatterSpecification.v16.Cluster} § 8.10.5
      */
     export class OperationalCommandResponse {
         constructor(values?: Partial<OperationalCommandResponse>);
@@ -332,7 +332,7 @@ export declare namespace OvenCavityOperationalState {
          * of the attempted command, the ErrorStateID shall be populated with NoError. See the individual command
          * sections for additional specific requirements on population.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.14.6.5.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.14.6.5.1
          */
         commandResponseState: OperationalState.ErrorStateStruct;
     }

package/dist/esm/clusters/oven-mode.d.ts

@@ -19,7 +19,7 @@ import type { VendorId } from "../datatype/VendorId.js";
  * This cluster is derived from the Mode Base cluster and defines additional mode tags and namespaced enumerated values
  * for oven devices.
  *
- * @see {@link MatterSpecification.v151.Cluster} § 8.11
+ * @see {@link MatterSpecification.v16.Cluster} § 8.11
  */
 export declare namespace OvenMode {
     /**
@@ -33,7 +33,7 @@ export declare namespace OvenMode {
     export const name: "OvenMode";
 
     /**
-     * The cluster revision assigned by {@link MatterSpecification.v151.Cluster}.
+     * The cluster revision assigned by {@link MatterSpecification.v16.Cluster}.
      */
     export const revision: 2;
 
@@ -52,12 +52,12 @@ export declare namespace OvenMode {
          * At least one entry in the SupportedModes attribute shall include the Bake mode tag in the ModeTags field
          * list.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.6.1
          */
         supportedModes: ModeOption[];
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.6
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.6
          */
         currentMode: number;
     }
@@ -73,12 +73,12 @@ export declare namespace OvenMode {
          * At least one entry in the SupportedModes attribute shall include the Bake mode tag in the ModeTags field
          * list.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.6.1
          */
         supportedModes: ModeOption[];
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.6
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.6
          */
         currentMode: number;
     }
@@ -92,7 +92,7 @@ export declare namespace OvenMode {
          *
          * On receipt of this command the device shall respond with a ChangeToModeResponse command.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.7.1
          */
         changeToMode(request: ModeBase.ChangeToModeRequest): MaybePromise<ModeBase.ChangeToModeResponse>;
     }
@@ -108,7 +108,7 @@ export declare namespace OvenMode {
     /**
      * These are optional features supported by OvenModeCluster.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 8.11.4
+     * @see {@link MatterSpecification.v16.Cluster} § 8.11.4
      */
     export enum Feature {
         /**
@@ -123,7 +123,7 @@ export declare namespace OvenMode {
      * The table below lists the changes relative to the Mode Base cluster for the fields of the ModeOptionStruct type.
      * A blank field indicates no change.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 8.11.5.1
+     * @see {@link MatterSpecification.v16.Cluster} § 8.11.5.1
      */
     export class ModeOption {
         constructor(values?: Partial<ModeOption>);
@@ -133,19 +133,19 @@ export declare namespace OvenMode {
          * the user to indicate what this option means. This field is meant to be readable and understandable by the
          * user.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.5.2.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.5.2.1
          */
         label: string;
 
         /**
          * This field is used to identify the mode option.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.5.2.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.5.2.2
          */
         mode: number;
 
         /**
-         * This field shall contain a list of tags that are associated with the mode option. This may be used by clients
+         * This field shall contain a list of tags that are associated with the mode option. This can be used by clients
          * to determine the full or the partial semantics of a certain mode, depending on which tags they understand,
          * using standard definitions and/or manufacturer specific namespace definitions.
          *
@@ -180,66 +180,66 @@ export declare namespace OvenMode {
          *   - A mode that includes both a generic Quick tag (defined here), and Vacuum and Mop tags, (defined in the
          *     RVC Clean cluster that is a derivation of this cluster).
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.5.2.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.5.2.3
          */
         modeTags: ModeTagStruct[];
     }
 
     export enum ModeTag {
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         Auto = 0,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         Quick = 1,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         Quiet = 2,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         LowNoise = 3,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         LowEnergy = 4,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         Vacation = 5,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         Min = 6,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         Max = 7,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         Night = 8,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         Day = 9,
 
         /**
          * This mode sets the device into baking mode for baking food items.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1.1
          */
         Bake = 16384,
 
@@ -247,7 +247,7 @@ export declare namespace OvenMode {
          * This mode sets the device into convection mode which creates an airflow within the device during the cooking
          * duration.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1.2
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1.2
          */
         Convection = 16385,
 
@@ -255,14 +255,14 @@ export declare namespace OvenMode {
          * This mode sets the device into grill mode for grilling food items. This is the same as Broil for many
          * regions.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1.3
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1.3
          */
         Grill = 16386,
 
         /**
          * This mode sets the device into roast mode for roasting food items.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1.4
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1.4
          */
         Roast = 16387,
 
@@ -272,56 +272,58 @@ export declare namespace OvenMode {
          * > [!NOTE]
          *
          * > NOTE: Depending on regulatory or other requirements, the following restrictions could apply to the use of
-         *   this mode: - It may NOT be possible to start this mode from a client. It may need to be started at the
-         *   device due to the temperatures used during this mode. - The setting of the oven temperature or other
-         *   features may be limited or not available while this mode is running. - Oven temperature measurement may NOT
-         *   be available while this mode is running.
+         *   this mode:
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1.5
+         *   - It may NOT be possible to start this mode from a client. It may need to be started at the device due to
+         *     the temperatures used during this mode. - The setting of the oven temperature or other features may be
+         *     limited or not available while this mode is running. - Oven temperature measurement may NOT be available
+         *     while this mode is running.
+         *
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1.5
          */
         Clean = 16388,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         ConvectionBake = 16389,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         ConvectionRoast = 16390,
 
         /**
          * This mode sets the device into a warming mode which begins warming the cavity.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1.8
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1.8
          */
         Warming = 16391,
 
         /**
          * This mode sets the device into proofing mode which creates an environment ready for proofing.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1.9
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1.9
          */
         Proofing = 16392,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         Steam = 16393,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         AirFry = 16394,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         AirSousVide = 16395,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 8.11.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 8.11.7.1
          */
         FrozenFood = 16396
     }
@@ -329,7 +331,7 @@ export declare namespace OvenMode {
     /**
      * A Mode Tag is meant to be interpreted by the client for the purpose the cluster serves.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.10.5.1
+     * @see {@link MatterSpecification.v16.Cluster} § 1.10.5.1
      */
     export class ModeTagStruct {
         constructor(values?: Partial<ModeTagStruct>);
@@ -345,7 +347,7 @@ export declare namespace OvenMode {
          * whose purpose is to choose the amount of sugar, or in a cluster whose purpose is to choose the amount of
          * salt.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.5.1.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.5.1.1
          */
         mfgCode?: VendorId;
 
@@ -353,7 +355,7 @@ export declare namespace OvenMode {
          * This field shall indicate the mode tag within a mode tag namespace which is either manufacturer specific or
          * standard.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.5.1.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.5.1.2
          */
         value: ModeTag | ModeBase.ModeTag;
     }