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

package/dist/esm/clusters/rvc-run-mode.d.ts

@@ -14,7 +14,7 @@ export declare 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
      */
     enum Feature {
         /**
@@ -26,43 +26,43 @@ export declare namespace RvcRunMode {
     }
     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,
         /**
@@ -72,14 +72,14 @@ export declare 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,
         /**
          * 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,
         /**
@@ -93,14 +93,14 @@ export declare 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
     }
     /**
      * 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
      */
     const TlvModeTagStruct: import("../tlv/TlvObject.js").ObjectSchema<{
         /**
@@ -114,21 +114,21 @@ export declare 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: import("../tlv/TlvObject.js").OptionalFieldType<import("../datatype/VendorId.js").VendorId>;
         /**
          * 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: import("../tlv/TlvObject.js").FieldType<ModeBase.ModeTag | ModeTag>;
     }>;
     /**
      * 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
      */
     interface ModeTagStruct extends TypeFromSchema<typeof TlvModeTagStruct> {
     }
@@ -136,7 +136,7 @@ export declare 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
      */
     const TlvModeOption: import("../tlv/TlvObject.js").ObjectSchema<{
         /**
@@ -144,13 +144,13 @@ export declare 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: import("../tlv/TlvObject.js").FieldType<string>;
         /**
          * 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: import("../tlv/TlvObject.js").FieldType<number>;
         /**
@@ -186,7 +186,7 @@ export declare 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: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
             /**
@@ -200,14 +200,14 @@ export declare 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: import("../tlv/TlvObject.js").OptionalFieldType<import("../datatype/VendorId.js").VendorId>;
             /**
              * 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: import("../tlv/TlvObject.js").FieldType<ModeBase.ModeTag | ModeTag>;
         }>[]>;
@@ -216,52 +216,52 @@ export declare 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
      */
     interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {
     }
     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
     }
     /**
      * 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
      */
     const TlvChangeToModeResponse: import("../tlv/TlvObject.js").ObjectSchema<{
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 1.10.7.2.1
+         * @see {@link MatterSpecification.v141.Cluster} § 1.10.7.2.1
          */
         status: import("../tlv/TlvObject.js").FieldType<ModeBase.ModeChangeStatus | ModeChangeStatus>;
         statusText: import("../tlv/TlvObject.js").FieldType<string>;
@@ -269,7 +269,7 @@ export declare 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
      */
     interface ChangeToModeResponse extends TypeFromSchema<typeof TlvChangeToModeResponse> {
     }
@@ -296,7 +296,7 @@ export declare 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
              */
             readonly supportedModes: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
@@ -304,13 +304,13 @@ export declare 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: import("../tlv/TlvObject.js").FieldType<string>;
                 /**
                  * 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: import("../tlv/TlvObject.js").FieldType<number>;
                 /**
@@ -346,7 +346,7 @@ export declare 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: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
                     /**
@@ -360,20 +360,20 @@ export declare 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: import("../tlv/TlvObject.js").OptionalFieldType<import("../datatype/VendorId.js").VendorId>;
                     /**
                      * 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: import("../tlv/TlvObject.js").FieldType<ModeBase.ModeTag | ModeTag>;
                 }>[]>;
             }>[], any>;
             /**
-             * @see {@link MatterSpecification.v14.Cluster} § 7.2.6
+             * @see {@link MatterSpecification.v141.Cluster} § 7.2.6
              */
             readonly currentMode: Attribute<number, any>;
         };
@@ -383,13 +383,13 @@ export declare 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
              */
             readonly changeToMode: Command<import("../tlv/TlvObject.js").TypeFromFields<{
                 newMode: import("../tlv/TlvObject.js").FieldType<number>;
             }>, import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
-                 * @see {@link MatterSpecification.v14.Cluster} § 1.10.7.2.1
+                 * @see {@link MatterSpecification.v141.Cluster} § 1.10.7.2.1
                  */
                 status: import("../tlv/TlvObject.js").FieldType<ModeBase.ModeChangeStatus | ModeChangeStatus>;
                 statusText: import("../tlv/TlvObject.js").FieldType<string>;
@@ -429,7 +429,7 @@ export declare 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
              */
             readonly supportedModes: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
@@ -437,13 +437,13 @@ export declare 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: import("../tlv/TlvObject.js").FieldType<string>;
                 /**
                  * 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: import("../tlv/TlvObject.js").FieldType<number>;
                 /**
@@ -479,7 +479,7 @@ export declare 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: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
                     /**
@@ -493,20 +493,20 @@ export declare 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: import("../tlv/TlvObject.js").OptionalFieldType<import("../datatype/VendorId.js").VendorId>;
                     /**
                      * 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: import("../tlv/TlvObject.js").FieldType<ModeBase.ModeTag | ModeTag>;
                 }>[]>;
             }>[], any>;
             /**
-             * @see {@link MatterSpecification.v14.Cluster} § 7.2.6
+             * @see {@link MatterSpecification.v141.Cluster} § 7.2.6
              */
             readonly currentMode: Attribute<number, any>;
         };
@@ -516,13 +516,13 @@ export declare 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
              */
             readonly changeToMode: Command<import("../tlv/TlvObject.js").TypeFromFields<{
                 newMode: import("../tlv/TlvObject.js").FieldType<number>;
             }>, import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
-                 * @see {@link MatterSpecification.v14.Cluster} § 1.10.7.2.1
+                 * @see {@link MatterSpecification.v141.Cluster} § 1.10.7.2.1
                  */
                 status: import("../tlv/TlvObject.js").FieldType<ModeBase.ModeChangeStatus | ModeChangeStatus>;
                 statusText: import("../tlv/TlvObject.js").FieldType<string>;
@@ -546,7 +546,7 @@ export declare 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
      */
     interface Cluster extends Identity<typeof ClusterInstance> {
     }

package/dist/esm/clusters/rvc-run-mode.js

@@ -47,14 +47,14 @@ var 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),
     /**
      * 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())
   });
@@ -64,13 +64,13 @@ var 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),
     /**
@@ -106,7 +106,7 @@ var 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(RvcRunMode2.TlvModeTagStruct, { maxLength: 8 }))
   });
@@ -123,7 +123,7 @@ var RvcRunMode;
   })(ModeChangeStatus = RvcRunMode2.ModeChangeStatus || (RvcRunMode2.ModeChangeStatus = {}));
   RvcRunMode2.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()),
     statusText: TlvField(1, TlvString.bound({ maxLength: 64 }))
@@ -148,7 +148,7 @@ var 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(
         0,
@@ -156,7 +156,7 @@ var RvcRunMode;
         { default: [] }
       ),
       /**
-       * @see {@link MatterSpecification.v14.Cluster} § 7.2.6
+       * @see {@link MatterSpecification.v141.Cluster} § 7.2.6
        */
       currentMode: Attribute(1, TlvUInt8, { persistent: true })
     },
@@ -166,7 +166,7 @@ var 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(0, ModeBase.TlvChangeToModeRequest, 1, RvcRunMode2.TlvChangeToModeResponse)
     },