@matter/types 0.13.0-alpha.0-20250328-6dde053de → 0.13.0-alpha.0-20250330-df5a17eba

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

@@ -23,7 +23,7 @@ export namespace RvcCleanMode {
     /**
      * These are optional features supported by RvcCleanModeCluster.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 7.3.4
+     * @see {@link MatterSpecification.v14.Cluster} § 7.3.4
      */
     export enum Feature {
         /**
@@ -36,71 +36,71 @@ export namespace RvcCleanMode {
 
     export enum ModeTag {
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2
+         * @see {@link MatterSpecification.v14.Cluster} § 7.3.7.2
          */
         Auto = 0,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2
+         * @see {@link MatterSpecification.v14.Cluster} § 7.3.7.2
          */
         Quick = 1,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2
+         * @see {@link MatterSpecification.v14.Cluster} § 7.3.7.2
          */
         Quiet = 2,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2
+         * @see {@link MatterSpecification.v14.Cluster} § 7.3.7.2
          */
         LowNoise = 3,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2
+         * @see {@link MatterSpecification.v14.Cluster} § 7.3.7.2
          */
         LowEnergy = 4,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2
+         * @see {@link MatterSpecification.v14.Cluster} § 7.3.7.2
          */
         Vacation = 5,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2
+         * @see {@link MatterSpecification.v14.Cluster} § 7.3.7.2
          */
         Min = 6,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2
+         * @see {@link MatterSpecification.v14.Cluster} § 7.3.7.2
          */
         Max = 7,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2
+         * @see {@link MatterSpecification.v14.Cluster} § 7.3.7.2
          */
         Night = 8,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2
+         * @see {@link MatterSpecification.v14.Cluster} § 7.3.7.2
          */
         Day = 9,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2
+         * @see {@link MatterSpecification.v14.Cluster} § 7.3.7.2
          */
         DeepClean = 16384,
 
         /**
          * The device’s vacuuming feature is enabled in this mode.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2.2
+         * @see {@link MatterSpecification.v14.Cluster} § 7.3.7.2.2
          */
         Vacuum = 16385,
 
         /**
          * The device’s mopping feature is enabled in this mode.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2.3
+         * @see {@link MatterSpecification.v14.Cluster} § 7.3.7.2.3
          */
         Mop = 16386
     }
@@ -108,7 +108,7 @@ export namespace RvcCleanMode {
     /**
      * A Mode Tag is meant to be interpreted by the client for the purpose the cluster serves.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.1
      */
     export const TlvModeTagStruct = TlvObject({
         /**
@@ -122,7 +122,7 @@ export namespace RvcCleanMode {
          * 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.v13.Cluster} § 1.10.5.1.1
+         * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.1.1
          */
         mfgCode: TlvOptionalField(0, TlvVendorId),
 
@@ -130,7 +130,7 @@ export namespace RvcCleanMode {
          * This field shall indicate the mode tag within a mode tag namespace which is either manufacturer specific or
          * standard.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.1.2
+         * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.1.2
          */
         value: TlvField(1, TlvEnum<ModeTag | ModeBase.ModeTag>())
     });
@@ -138,7 +138,7 @@ export namespace RvcCleanMode {
     /**
      * A Mode Tag is meant to be interpreted by the client for the purpose the cluster serves.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.1
      */
     export interface ModeTagStruct extends TypeFromSchema<typeof TlvModeTagStruct> {}
 
@@ -146,7 +146,7 @@ export namespace RvcCleanMode {
      * 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.v13.Cluster} § 7.3.5.1
+     * @see {@link MatterSpecification.v14.Cluster} § 7.3.5.1
      */
     export const TlvModeOption = TlvObject({
         /**
@@ -154,14 +154,14 @@ export namespace RvcCleanMode {
          * the user to indicate what this option means. This field is meant to be readable and understandable by the
          * user.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2.1
+         * @see {@link MatterSpecification.v14.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.v13.Cluster} § 1.10.5.2.2
+         * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.2.2
          */
         mode: TlvField(1, TlvUInt8),
 
@@ -199,7 +199,7 @@ export namespace RvcCleanMode {
          *   • 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.v13.Cluster} § 1.10.5.2.3
+         * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.2.3
          */
         modeTags: TlvField(2, TlvArray(TlvModeTagStruct, { maxLength: 8 }))
     });
@@ -208,13 +208,13 @@ export namespace RvcCleanMode {
      * 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.v13.Cluster} § 7.3.5.1
+     * @see {@link MatterSpecification.v14.Cluster} § 7.3.5.1
      */
     export interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {}
 
     export enum ModeChangeStatus {
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.1
+         * @see {@link MatterSpecification.v14.Cluster} § 7.3.7.1
          */
         CleaningInProgress = 64
     }
@@ -241,7 +241,7 @@ export namespace RvcCleanMode {
              * At least one entry in the SupportedModes attribute shall include the Vacuum and/or the Mop mode tag in
              * the ModeTags field list.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 7.3.6.1
+             * @see {@link MatterSpecification.v14.Cluster} § 7.3.6.1
              */
             supportedModes: FixedAttribute(
                 0x0,
@@ -250,7 +250,7 @@ export namespace RvcCleanMode {
             ),
 
             /**
-             * @see {@link MatterSpecification.v13.Cluster} § 7.3.6
+             * @see {@link MatterSpecification.v14.Cluster} § 7.3.6
              */
             currentMode: Attribute(0x1, TlvUInt8, { persistent: true })
         },
@@ -261,7 +261,7 @@ export namespace RvcCleanMode {
              *
              * On receipt of this command the device shall respond with a ChangeToModeResponse command.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.1
+             * @see {@link MatterSpecification.v14.Cluster} § 1.10.7.1
              */
             changeToMode: Command(0x0, ModeBase.TlvChangeToModeRequest, 0x1, ModeBase.TlvChangeToModeResponse)
         },
@@ -285,7 +285,7 @@ export namespace RvcCleanMode {
      * RvcCleanModeCluster supports optional features that you can enable with the RvcCleanModeCluster.with() factory
      * method.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 7.3
+     * @see {@link MatterSpecification.v14.Cluster} § 7.3
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

package/src/clusters/rvc-operational-state.ts

@@ -45,7 +45,7 @@ export namespace RvcOperationalState {
      * resumed, the device shall respond with an OperationalCommandResponse command with an ErrorStateID of
      * CommandInvalidInState but take no further action.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 7.4.4.1
+     * @see {@link MatterSpecification.v14.Cluster} § 7.4.4.1
      */
     export enum OperationalState {
         /**
@@ -87,13 +87,13 @@ export namespace RvcOperationalState {
     /**
      * The OperationalStateStruct is used to indicate a possible state of the device.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.14.4.2
      */
     export const TlvOperationalStateStruct = TlvObject({
         /**
          * This shall be populated with a value from the OperationalStateEnum.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.2.1
+         * @see {@link MatterSpecification.v14.Cluster} § 1.14.4.2.1
          */
         operationalStateId: TlvField(0, TlvEnum<OperationalState | OperationalStateNamespace.OperationalStateEnum>()),
 
@@ -102,7 +102,7 @@ export namespace RvcOperationalState {
          * States, otherwise it shall NOT be present. If present, this shall contain a human-readable description of the
          * operational state.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.2.2
+         * @see {@link MatterSpecification.v14.Cluster} § 1.14.4.2.2
          */
         operationalStateLabel: TlvOptionalField(1, TlvString.bound({ maxLength: 64 }))
     });
@@ -110,7 +110,7 @@ export namespace RvcOperationalState {
     /**
      * The OperationalStateStruct is used to indicate a possible state of the device.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.14.4.2
      */
     export interface OperationalStateStruct extends TypeFromSchema<typeof TlvOperationalStateStruct> {}
 
@@ -118,7 +118,7 @@ export namespace RvcOperationalState {
      * The values defined herein are applicable to this derived cluster of Operational State only and are additional to
      * the set of values defined in Operational State itself.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 7.4.4.2
+     * @see {@link MatterSpecification.v14.Cluster} § 7.4.4.2
      */
     export enum ErrorState {
         /**
@@ -183,13 +183,13 @@ export namespace RvcOperationalState {
     }
 
     /**
-     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4
+     * @see {@link MatterSpecification.v14.Cluster} § 1.14.4.4
      */
     export const TlvErrorStateStruct = TlvObject({
         /**
          * This shall be populated with a value from the ErrorStateEnum.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4.1
+         * @see {@link MatterSpecification.v14.Cluster} § 1.14.4.4.1
          */
         errorStateId: TlvField(0, TlvEnum<ErrorState | OperationalStateNamespace.ErrorState>()),
 
@@ -199,7 +199,7 @@ export namespace RvcOperationalState {
          * ErrorStateID; e.g. for a manufacturer specific ErrorStateID of "0x80" the ErrorStateLabel may contain "My
          * special error".
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4.2
+         * @see {@link MatterSpecification.v14.Cluster} § 1.14.4.4.2
          */
         errorStateLabel: TlvOptionalField(1, TlvString.bound({ maxLength: 64 })),
 
@@ -208,20 +208,20 @@ export namespace RvcOperationalState {
          * ErrorStateID indicates that the device is a Robotic Vacuum that is stuck, the ErrorStateDetails contains
          * "left wheel blocked".
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4.3
+         * @see {@link MatterSpecification.v14.Cluster} § 1.14.4.4.3
          */
         errorStateDetails: TlvOptionalField(2, TlvString.bound({ maxLength: 64 }))
     });
 
     /**
-     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4
+     * @see {@link MatterSpecification.v14.Cluster} § 1.14.4.4
      */
     export interface ErrorStateStruct extends TypeFromSchema<typeof TlvErrorStateStruct> {}
 
     /**
      * Input to the RvcOperationalState operationalCommandResponse command
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 7.4.5
+     * @see {@link MatterSpecification.v14.Cluster} § 7.4.5
      */
     export const TlvOperationalCommandResponse = TlvObject({
         /**
@@ -229,7 +229,7 @@ export namespace RvcOperationalState {
          * of the attempted command, the ErrorStateID shall be populated with NoError. Please see the individual command
          * sections for additional specific requirements on population.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.14.6.5.1
+         * @see {@link MatterSpecification.v14.Cluster} § 1.14.6.5.1
          */
         commandResponseState: TlvField(0, TlvErrorStateStruct)
     });
@@ -237,21 +237,21 @@ export namespace RvcOperationalState {
     /**
      * Input to the RvcOperationalState operationalCommandResponse command
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 7.4.5
+     * @see {@link MatterSpecification.v14.Cluster} § 7.4.5
      */
     export interface OperationalCommandResponse extends TypeFromSchema<typeof TlvOperationalCommandResponse> {}
 
     /**
      * Body of the RvcOperationalState operationalError event
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.14.7.1
      */
     export const TlvOperationalErrorEvent = TlvObject({ errorState: TlvField(0, TlvErrorStateStruct) });
 
     /**
      * Body of the RvcOperationalState operationalError event
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.14.7.1
      */
     export interface OperationalErrorEvent extends TypeFromSchema<typeof TlvOperationalErrorEvent> {}
 
@@ -273,7 +273,7 @@ export namespace RvcOperationalState {
              * 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.v13.Cluster} § 1.14.5.1
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.1
              */
             phaseList: Attribute(0x0, TlvNullable(TlvArray(TlvString, { maxLength: 32 }))),
 
@@ -286,7 +286,7 @@ export namespace RvcOperationalState {
              *
              * Null if the PhaseList attribute is null or if the PhaseList attribute is an empty list.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.2
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.2
              */
             currentPhase: Attribute(0x1, TlvNullable(TlvUInt8)),
 
@@ -319,7 +319,7 @@ export namespace RvcOperationalState {
              * 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.v13.Cluster} § 1.14.5.3
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.3
              */
             countdownTime: OptionalAttribute(0x2, TlvNullable(TlvUInt32.bound({ max: 259200 })), { default: null }),
 
@@ -333,7 +333,7 @@ export namespace RvcOperationalState {
              * 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.v13.Cluster} § 1.14.5.4
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.4
              */
             operationalStateList: Attribute(0x3, TlvArray(TlvOperationalStateStruct), { default: [] }),
 
@@ -341,7 +341,7 @@ export namespace RvcOperationalState {
              * 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.v13.Cluster} § 1.14.5.5
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.5
              */
             operationalState: Attribute(
                 0x4,
@@ -355,7 +355,7 @@ export namespace RvcOperationalState {
              *
              * When there is no error detected, this shall have an ErrorStateID of NoError.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.6
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.6
              */
             operationalError: Attribute(0x5, TlvErrorStateStruct)
         },
@@ -379,7 +379,7 @@ export namespace RvcOperationalState {
              *
              *   • The device shall respond with an OperationalCommandResponse command with an ErrorStateID of NoError.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 7.4.5.1
+             * @see {@link MatterSpecification.v14.Cluster} § 7.4.5.1
              */
             goHome: OptionalCommand(0x80, TlvNoArguments, 0x4, TlvOperationalCommandResponse)
         },
@@ -391,7 +391,7 @@ export namespace RvcOperationalState {
              *
              * This event shall contain the following fields:
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.1
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.7.1
              */
             operationalError: Event(0x0, EventPriority.Critical, TlvOperationalErrorEvent),
 
@@ -406,7 +406,7 @@ export namespace RvcOperationalState {
              *
              * This event shall contain the following fields:
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.2
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.7.2
              */
             operationCompletion: OptionalEvent(
                 0x1,
@@ -420,7 +420,7 @@ export namespace RvcOperationalState {
      * This cluster is derived from the Operational State cluster and provides an interface for monitoring the
      * operational state of a robotic vacuum cleaner.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 7.4
+     * @see {@link MatterSpecification.v14.Cluster} § 7.4
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}