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

package/dist/esm/clusters/operational-state.js

@@ -32,7 +32,7 @@ var OperationalState;
     /**
      * 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()),
     /**
@@ -40,7 +40,7 @@ var OperationalState;
      * 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 }))
   });
@@ -55,7 +55,7 @@ var OperationalState;
     /**
      * 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()),
     /**
@@ -64,7 +64,7 @@ var OperationalState;
      * 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 })),
     /**
@@ -72,7 +72,7 @@ var OperationalState;
      * 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 }))
   });
@@ -82,7 +82,7 @@ var OperationalState;
      * 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, OperationalState2.TlvErrorStateStruct)
   });
@@ -92,7 +92,7 @@ var OperationalState;
      * This field provides an indication of the state at the end of the operation. This field shall have a value
      * from the ErrorStateEnum set. A value of NoError indicates success, that is, no error has been detected.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.2.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.14.7.2.1
      */
     completionErrorCode: TlvField(0, TlvUInt8),
     /**
@@ -102,7 +102,7 @@ var OperationalState;
      * spent while paused. There may be cases whereby the total operational time exceeds the maximum value that can
      * be conveyed by this attribute, in such instances, this attribute shall be populated with null.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.2.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.14.7.2.2
      */
     totalOperationalTime: TlvOptionalField(1, TlvNullable(TlvUInt32)),
     /**
@@ -110,7 +110,7 @@ var OperationalState;
      * exceeds the maximum value that can be conveyed by this attribute, in such instances, this attribute shall be
      * populated with null.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.2.3
+     * @see {@link MatterSpecification.v14.Cluster} § 1.14.7.2.3
      */
     pausedTime: TlvOptionalField(2, TlvNullable(TlvUInt32))
   });
@@ -128,7 +128,7 @@ var OperationalState;
        * 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(0, TlvNullable(TlvArray(TlvString, { maxLength: 32 }))),
       /**
@@ -140,7 +140,7 @@ var OperationalState;
        *
        * 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(1, TlvNullable(TlvUInt8)),
       /**
@@ -172,7 +172,7 @@ var OperationalState;
        * 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(2, TlvNullable(TlvUInt32.bound({ max: 259200 })), { default: null }),
       /**
@@ -185,14 +185,14 @@ var OperationalState;
        * 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(3, TlvArray(OperationalState2.TlvOperationalStateStruct), { default: [] }),
       /**
        * 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(4, TlvEnum()),
       /**
@@ -202,7 +202,7 @@ var OperationalState;
        *
        * 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(5, OperationalState2.TlvErrorStateStruct)
     },
@@ -245,7 +245,7 @@ var OperationalState;
        *
        * ### Table 3. Pause Compatibility
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.14.6.1
+       * @see {@link MatterSpecification.v14.Cluster} § 1.14.6.1
        */
       pause: OptionalCommand(0, TlvNoArguments, 4, OperationalState2.TlvOperationalCommandResponse),
       /**
@@ -269,7 +269,7 @@ var OperationalState;
        *
        *   • The device shall respond with an OperationalCommandResponse command with an ErrorStateID of NoError.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.14.6.2
+       * @see {@link MatterSpecification.v14.Cluster} § 1.14.6.2
        */
       stop: OptionalCommand(1, TlvNoArguments, 4, OperationalState2.TlvOperationalCommandResponse),
       /**
@@ -295,7 +295,7 @@ var OperationalState;
        *
        *   • The device shall respond with an OperationalCommandResponse command with an ErrorStateID of NoError.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.14.6.3
+       * @see {@link MatterSpecification.v14.Cluster} § 1.14.6.3
        */
       start: OptionalCommand(2, TlvNoArguments, 4, OperationalState2.TlvOperationalCommandResponse),
       /**
@@ -336,7 +336,7 @@ var OperationalState;
        *
        *   • The device shall respond with an OperationalCommandResponse command with an ErrorStateID of NoError.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.14.6.4
+       * @see {@link MatterSpecification.v14.Cluster} § 1.14.6.4
        */
       resume: OptionalCommand(3, TlvNoArguments, 4, OperationalState2.TlvOperationalCommandResponse)
     },
@@ -347,7 +347,7 @@ var OperationalState;
        *
        * 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(0, EventPriority.Critical, OperationalState2.TlvOperationalErrorEvent),
       /**
@@ -361,7 +361,7 @@ var OperationalState;
        *
        * 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(1, EventPriority.Info, OperationalState2.TlvOperationCompletionEvent)
     }