@matter/types 0.14.0-alpha.0-20250531-7ed2d6da8 → 0.14.0-alpha.0-20250602-37f27bb02

package/src/clusters/rvc-run-mode.ts

@@ -23,7 +23,7 @@ export namespace RvcRunMode {
     /**
      * These are optional features supported by RvcRunModeCluster.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 7.2.4
+     * @see {@link MatterSpecification.v141.Cluster} § 7.2.4
      */
     export enum Feature {
         /**
@@ -36,52 +36,52 @@ export namespace RvcRunMode {
 
     export enum ModeTag {
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.2
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.2
          */
         Auto = 0,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.2
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.2
          */
         Quick = 1,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.2
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.2
          */
         Quiet = 2,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.2
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.2
          */
         LowNoise = 3,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.2
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.2
          */
         LowEnergy = 4,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.2
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.2
          */
         Vacation = 5,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.2
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.2
          */
         Min = 6,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.2
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.2
          */
         Max = 7,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.2
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.2
          */
         Night = 8,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.2
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.2
          */
         Day = 9,
 
@@ -92,7 +92,7 @@ export namespace RvcRunMode {
          * For example, the device has completed cleaning, successfully or not, on its own or due to a command, or has
          * not been asked to clean after a restart.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.2.1
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.2.1
          */
         Idle = 16384,
 
@@ -100,7 +100,7 @@ export namespace RvcRunMode {
          * The device was asked to clean so it may be actively running, or paused due to an error, due to a pause
          * command, or for recharging etc. If currently paused and the device can resume it will continue to clean.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.2.2
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.2.2
          */
         Cleaning = 16385,
 
@@ -115,7 +115,7 @@ export namespace RvcRunMode {
          *   previously done that, or if the layout has substantially changed, for an optimal subsequent cleaning
          *   experience.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.2.3
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.2.3
          */
         Mapping = 16386
     }
@@ -123,7 +123,7 @@ export namespace RvcRunMode {
     /**
      * A Mode Tag is meant to be interpreted by the client for the purpose the cluster serves.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.1
+     * @see {@link MatterSpecification.v141.Cluster} § 1.10.5.1
      */
     export const TlvModeTagStruct = TlvObject({
         /**
@@ -137,7 +137,7 @@ export namespace RvcRunMode {
          * 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.v14.Cluster} § 1.10.5.1.1
+         * @see {@link MatterSpecification.v141.Cluster} § 1.10.5.1.1
          */
         mfgCode: TlvOptionalField(0, TlvVendorId),
 
@@ -145,7 +145,7 @@ export namespace RvcRunMode {
          * This field shall indicate the mode tag within a mode tag namespace which is either manufacturer specific or
          * standard.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.1.2
+         * @see {@link MatterSpecification.v141.Cluster} § 1.10.5.1.2
          */
         value: TlvField(1, TlvEnum<ModeTag | ModeBase.ModeTag>())
     });
@@ -153,7 +153,7 @@ export namespace RvcRunMode {
     /**
      * A Mode Tag is meant to be interpreted by the client for the purpose the cluster serves.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.1
+     * @see {@link MatterSpecification.v141.Cluster} § 1.10.5.1
      */
     export interface ModeTagStruct extends TypeFromSchema<typeof TlvModeTagStruct> {}
 
@@ -161,7 +161,7 @@ export namespace RvcRunMode {
      * 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.v14.Cluster} § 7.2.5.1
+     * @see {@link MatterSpecification.v141.Cluster} § 7.2.5.1
      */
     export const TlvModeOption = TlvObject({
         /**
@@ -169,14 +169,14 @@ export namespace RvcRunMode {
          * the user to indicate what this option means. This field is meant to be readable and understandable by the
          * user.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.2.1
+         * @see {@link MatterSpecification.v141.Cluster} § 1.10.5.2.1
          */
         label: TlvField(0, TlvString.bound({ maxLength: 64 })),
 
         /**
          * This field is used to identify the mode option.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.2.2
+         * @see {@link MatterSpecification.v141.Cluster} § 1.10.5.2.2
          */
         mode: TlvField(1, TlvUInt8),
 
@@ -213,7 +213,7 @@ export namespace RvcRunMode {
          *   • 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.v14.Cluster} § 1.10.5.2.3
+         * @see {@link MatterSpecification.v141.Cluster} § 1.10.5.2.3
          */
         modeTags: TlvField(2, TlvArray(TlvModeTagStruct, { maxLength: 8 }))
     });
@@ -222,48 +222,48 @@ export namespace RvcRunMode {
      * 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.v14.Cluster} § 7.2.5.1
+     * @see {@link MatterSpecification.v141.Cluster} § 7.2.5.1
      */
     export interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {}
 
     export enum ModeChangeStatus {
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.1
          */
         Stuck = 65,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.1
          */
         DustBinMissing = 66,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.1
          */
         DustBinFull = 67,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.1
          */
         WaterTankEmpty = 68,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.1
          */
         WaterTankMissing = 69,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.1
          */
         WaterTankLidOpen = 70,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.1
          */
         MopCleaningPadMissing = 71,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 7.2.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 7.2.7.1
          */
         BatteryLow = 72
     }
@@ -271,11 +271,11 @@ export namespace RvcRunMode {
     /**
      * This command is sent by the device on receipt of the ChangeToMode command.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 1.10.7.2
+     * @see {@link MatterSpecification.v141.Cluster} § 1.10.7.2
      */
     export const TlvChangeToModeResponse = TlvObject({
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 1.10.7.2.1
+         * @see {@link MatterSpecification.v141.Cluster} § 1.10.7.2.1
          */
         status: TlvField(0, TlvEnum<ModeChangeStatus | ModeBase.ModeChangeStatus>()),
 
@@ -285,7 +285,7 @@ export namespace RvcRunMode {
     /**
      * This command is sent by the device on receipt of the ChangeToMode command.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 1.10.7.2
+     * @see {@link MatterSpecification.v141.Cluster} § 1.10.7.2
      */
     export interface ChangeToModeResponse extends TypeFromSchema<typeof TlvChangeToModeResponse> {}
 
@@ -314,7 +314,7 @@ export namespace RvcRunMode {
              * The Mapping, Cleaning, and Idle mode tags are mutually exclusive and shall NOT be used together in a
              * mode’s ModeTags.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 7.2.6.1
+             * @see {@link MatterSpecification.v141.Cluster} § 7.2.6.1
              */
             supportedModes: FixedAttribute(
                 0x0,
@@ -323,7 +323,7 @@ export namespace RvcRunMode {
             ),
 
             /**
-             * @see {@link MatterSpecification.v14.Cluster} § 7.2.6
+             * @see {@link MatterSpecification.v141.Cluster} § 7.2.6
              */
             currentMode: Attribute(0x1, TlvUInt8, { persistent: true })
         },
@@ -334,7 +334,7 @@ export namespace RvcRunMode {
              *
              * On receipt of this command the device shall respond with a ChangeToModeResponse command.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 1.10.7.1
+             * @see {@link MatterSpecification.v141.Cluster} § 1.10.7.1
              */
             changeToMode: Command(0x0, ModeBase.TlvChangeToModeRequest, 0x1, TlvChangeToModeResponse)
         },
@@ -358,7 +358,7 @@ export namespace RvcRunMode {
      * RvcRunModeCluster supports optional features that you can enable with the RvcRunModeCluster.with() factory
      * method.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 7.2
+     * @see {@link MatterSpecification.v141.Cluster} § 7.2
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}