@matter/types 0.11.9-alpha.0-20241205-ccf69a00a → 0.11.9-alpha.0-20241207-b604cfa44

package/dist/esm/clusters/rvc-operational-state.d.ts

@@ -6,6 +6,7 @@
 /*** THIS FILE IS GENERATED, DO NOT EDIT ***/
 import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
 import { Attribute, OptionalAttribute, OptionalCommand, Event, OptionalEvent } from "../cluster/Cluster.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
 import { Identity } from "#general";
 export declare namespace RvcOperationalState {
     /**
@@ -42,6 +43,34 @@ export declare namespace RvcOperationalState {
          */
         Docked = 66
     }
+    /**
+     * The OperationalStateStruct is used to indicate a possible state of the device.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.2
+     */
+    const TlvOperationalStateStruct: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This shall be populated with a value from the OperationalStateEnum.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.2.1
+         */
+        operationalStateId: import("../tlv/TlvObject.js").FieldType<OperationalState>;
+        /**
+         * This field shall be present if the OperationalStateID is from the set reserved for Manufacturer Specific
+         * 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
+         */
+        operationalStateLabel: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+    }>;
+    /**
+     * The OperationalStateStruct is used to indicate a possible state of the device.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.2
+     */
+    interface OperationalStateStruct extends TypeFromSchema<typeof TlvOperationalStateStruct> {
+    }
     /**
      * 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.
@@ -82,6 +111,124 @@ export declare namespace RvcOperationalState {
          */
         MopCleaningPadMissing = 71
     }
+    /**
+     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4
+     */
+    const TlvErrorStateStruct: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This shall be populated with a value from the ErrorStateEnum.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4.1
+         */
+        errorStateId: import("../tlv/TlvObject.js").FieldType<ErrorState>;
+        /**
+         * This field shall be present if the ErrorStateID is from the set reserved for Manufacturer Specific Errors,
+         * otherwise it shall NOT be present. If present, this shall contain a human-readable description of the
+         * 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
+         */
+        errorStateLabel: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+        /**
+         * This shall be a human-readable string that provides details about the error condition. As an example, if the
+         * 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
+         */
+        errorStateDetails: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+    }>;
+    /**
+     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4
+     */
+    interface ErrorStateStruct extends TypeFromSchema<typeof TlvErrorStateStruct> {
+    }
+    /**
+     * Input to the RvcOperationalState operationalCommandResponse command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 7.4.5
+     */
+    const TlvOperationalCommandResponse: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This shall indicate the success or otherwise of the attempted command invocation. On a successful invocation
+         * 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
+         */
+        commandResponseState: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+            /**
+             * This shall be populated with a value from the ErrorStateEnum.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4.1
+             */
+            errorStateId: import("../tlv/TlvObject.js").FieldType<ErrorState>;
+            /**
+             * This field shall be present if the ErrorStateID is from the set reserved for Manufacturer Specific Errors,
+             * otherwise it shall NOT be present. If present, this shall contain a human-readable description of the
+             * 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
+             */
+            errorStateLabel: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+            /**
+             * This shall be a human-readable string that provides details about the error condition. As an example, if the
+             * 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
+             */
+            errorStateDetails: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+        }>>;
+    }>;
+    /**
+     * Input to the RvcOperationalState operationalCommandResponse command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 7.4.5
+     */
+    interface OperationalCommandResponse extends TypeFromSchema<typeof TlvOperationalCommandResponse> {
+    }
+    /**
+     * Body of the RvcOperationalState operationalError event
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.1
+     */
+    const TlvOperationalErrorEvent: import("../tlv/TlvObject.js").ObjectSchema<{
+        errorState: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+            /**
+             * This shall be populated with a value from the ErrorStateEnum.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4.1
+             */
+            errorStateId: import("../tlv/TlvObject.js").FieldType<ErrorState>;
+            /**
+             * This field shall be present if the ErrorStateID is from the set reserved for Manufacturer Specific Errors,
+             * otherwise it shall NOT be present. If present, this shall contain a human-readable description of the
+             * 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
+             */
+            errorStateLabel: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+            /**
+             * This shall be a human-readable string that provides details about the error condition. As an example, if the
+             * 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
+             */
+            errorStateDetails: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+        }>>;
+    }>;
+    /**
+     * Body of the RvcOperationalState operationalError event
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.1
+     */
+    interface OperationalErrorEvent extends TypeFromSchema<typeof TlvOperationalErrorEvent> {
+    }
     /**
      * @see {@link Cluster}
      */
@@ -140,9 +287,21 @@ export declare namespace RvcOperationalState {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.4
              */
-            readonly operationalStateList: Attribute<import("../index.js").TypeFromFields<{
-                operationalStateId: import("../index.js").FieldType<number>;
-                operationalStateLabel: import("../index.js").OptionalFieldType<string>;
+            readonly operationalStateList: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This shall be populated with a value from the OperationalStateEnum.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.2.1
+                 */
+                operationalStateId: import("../tlv/TlvObject.js").FieldType<OperationalState>;
+                /**
+                 * This field shall be present if the OperationalStateID is from the set reserved for Manufacturer Specific
+                 * 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
+                 */
+                operationalStateLabel: import("../tlv/TlvObject.js").OptionalFieldType<string>;
             }>[], any>;
             /**
              * This attribute specifies the current operational state of a device. This shall be populated with a valid
@@ -150,7 +309,7 @@ export declare namespace RvcOperationalState {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.5
              */
-            readonly operationalState: Attribute<number, any>;
+            readonly operationalState: Attribute<OperationalState, any>;
             /**
              * This attribute shall specify the details of any current error condition being experienced on the device
              * when the OperationalState attribute is populated with Error. Please see ErrorStateStruct for general
@@ -160,10 +319,30 @@ export declare namespace RvcOperationalState {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.6
              */
-            readonly operationalError: Attribute<import("../index.js").TypeFromFields<{
-                errorStateId: import("../index.js").FieldType<number>;
-                errorStateLabel: import("../index.js").OptionalFieldType<string>;
-                errorStateDetails: import("../index.js").OptionalFieldType<string>;
+            readonly operationalError: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This shall be populated with a value from the ErrorStateEnum.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4.1
+                 */
+                errorStateId: import("../tlv/TlvObject.js").FieldType<ErrorState>;
+                /**
+                 * This field shall be present if the ErrorStateID is from the set reserved for Manufacturer Specific Errors,
+                 * otherwise it shall NOT be present. If present, this shall contain a human-readable description of the
+                 * 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
+                 */
+                errorStateLabel: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+                /**
+                 * This shall be a human-readable string that provides details about the error condition. As an example, if the
+                 * 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
+                 */
+                errorStateDetails: import("../tlv/TlvObject.js").OptionalFieldType<string>;
             }>, any>;
         };
         readonly commands: {
@@ -187,11 +366,38 @@ export declare namespace RvcOperationalState {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 7.4.5.1
              */
-            readonly goHome: OptionalCommand<void, import("../index.js").TypeFromFields<{
-                commandResponseState: import("../index.js").FieldType<import("../index.js").TypeFromFields<{
-                    errorStateId: import("../index.js").FieldType<number>;
-                    errorStateLabel: import("../index.js").OptionalFieldType<string>;
-                    errorStateDetails: import("../index.js").OptionalFieldType<string>;
+            readonly goHome: OptionalCommand<void, import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This shall indicate the success or otherwise of the attempted command invocation. On a successful invocation
+                 * 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
+                 */
+                commandResponseState: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+                    /**
+                     * This shall be populated with a value from the ErrorStateEnum.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4.1
+                     */
+                    errorStateId: import("../tlv/TlvObject.js").FieldType<ErrorState>;
+                    /**
+                     * This field shall be present if the ErrorStateID is from the set reserved for Manufacturer Specific Errors,
+                     * otherwise it shall NOT be present. If present, this shall contain a human-readable description of the
+                     * 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
+                     */
+                    errorStateLabel: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+                    /**
+                     * This shall be a human-readable string that provides details about the error condition. As an example, if the
+                     * 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
+                     */
+                    errorStateDetails: import("../tlv/TlvObject.js").OptionalFieldType<string>;
                 }>>;
             }>, any>;
         };
@@ -204,11 +410,31 @@ export declare namespace RvcOperationalState {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.1
              */
-            readonly operationalError: Event<import("../index.js").TypeFromFields<{
-                errorState: import("../index.js").FieldType<import("../index.js").TypeFromFields<{
-                    errorStateId: import("../index.js").FieldType<number>;
-                    errorStateLabel: import("../index.js").OptionalFieldType<string>;
-                    errorStateDetails: import("../index.js").OptionalFieldType<string>;
+            readonly operationalError: Event<import("../tlv/TlvObject.js").TypeFromFields<{
+                errorState: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+                    /**
+                     * This shall be populated with a value from the ErrorStateEnum.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4.1
+                     */
+                    errorStateId: import("../tlv/TlvObject.js").FieldType<ErrorState>;
+                    /**
+                     * This field shall be present if the ErrorStateID is from the set reserved for Manufacturer Specific Errors,
+                     * otherwise it shall NOT be present. If present, this shall contain a human-readable description of the
+                     * 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
+                     */
+                    errorStateLabel: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+                    /**
+                     * This shall be a human-readable string that provides details about the error condition. As an example, if the
+                     * 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
+                     */
+                    errorStateDetails: import("../tlv/TlvObject.js").OptionalFieldType<string>;
                 }>>;
             }>, any>;
             /**
@@ -220,10 +446,10 @@ export declare namespace RvcOperationalState {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.2
              */
-            readonly operationCompletion: OptionalEvent<import("../index.js").TypeFromFields<{
-                completionErrorCode: import("../index.js").FieldType<number>;
-                totalOperationalTime: import("../index.js").OptionalFieldType<number | null>;
-                pausedTime: import("../index.js").OptionalFieldType<number | null>;
+            readonly operationCompletion: OptionalEvent<import("../tlv/TlvObject.js").TypeFromFields<{
+                completionErrorCode: import("../tlv/TlvObject.js").FieldType<number>;
+                totalOperationalTime: import("../tlv/TlvObject.js").OptionalFieldType<number | null>;
+                pausedTime: import("../tlv/TlvObject.js").OptionalFieldType<number | null>;
             }>, any>;
         };
     }, []>;

package/dist/esm/clusters/rvc-operational-state.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rvc-operational-state.d.ts","sourceRoot":"","sources":["../../../src/clusters/rvc-operational-state.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EACH,SAAS,EACT,iBAAiB,EACjB,eAAe,EACf,KAAK,EAEL,aAAa,EAChB,MAAM,uBAAuB,CAAC;AAO/B,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,mBAAmB,CAAC;IACjC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAY,gBAAgB;QACxB;;WAEG;QACH,cAAc,KAAK;QAEnB;;WAEG;QACH,QAAQ,KAAK;QAEb;;WAEG;QACH,MAAM,KAAK;KACd;IAED;;;;;OAKG;IACH,KAAY,UAAU;QAClB;;WAEG;QACH,wBAAwB,KAAK;QAE7B;;WAEG;QACH,KAAK,KAAK;QAEV;;WAEG;QACH,cAAc,KAAK;QAEnB;;WAEG;QACH,WAAW,KAAK;QAEhB;;WAEG;QACH,cAAc,KAAK;QAEnB;;WAEG;QACH,gBAAgB,KAAK;QAErB;;WAEG;QACH,gBAAgB,KAAK;QAErB;;WAEG;QACH,qBAAqB,KAAK;KAC7B;IAED;;OAEG;IACI,MAAM,eAAe;;;;;YAMpB;;;;;;;;;;eAUG;;YAGH;;;;;;;;;eASG;;YAGH;;;;;;;;;;;;;eAaG;;YAOH;;;;;;;;;;;eAWG;;;;;YAOH;;;;;eAKG;;YAGH;;;;;;;;eAQG;;;;;;;;YAKH;;;;;;;;;;;;;;;;;;;eAmBG;;;;;;;;;;YAKH;;;;;;;eAOG;;;;;;;;YAGH;;;;;;;;eAQG;;;;;;;UAOT,CAAC;IAEH;;;;OAIG;IACH,UAAiB,OAAQ,SAAQ,QAAQ,CAAC,OAAO,eAAe,CAAC;KAAG;IAE7D,MAAM,OAAO,EAAE,OAAyB,CAAC;IACzC,MAAM,QAAQ,SAAU,CAAC;CACnC;AAED,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,CAAC,OAAO,CAAC;AACrE,eAAO,MAAM,0BAA0B,6BAA8B,CAAC"}
+{"version":3,"file":"rvc-operational-state.d.ts","sourceRoot":"","sources":["../../../src/clusters/rvc-operational-state.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EACH,SAAS,EACT,iBAAiB,EACjB,eAAe,EACf,KAAK,EAEL,aAAa,EAChB,MAAM,uBAAuB,CAAC;AAM/B,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGrD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,mBAAmB,CAAC;IACjC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAY,gBAAgB;QACxB;;WAEG;QACH,cAAc,KAAK;QAEnB;;WAEG;QACH,QAAQ,KAAK;QAEb;;WAEG;QACH,MAAM,KAAK;KACd;IAED;;;;OAIG;IACI,MAAM,yBAAyB;QAClC;;;;WAIG;;QAGH;;;;;;WAMG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,sBAAuB,SAAQ,cAAc,CAAC,OAAO,yBAAyB,CAAC;KAAG;IAEnG;;;;;OAKG;IACH,KAAY,UAAU;QAClB;;WAEG;QACH,wBAAwB,KAAK;QAE7B;;WAEG;QACH,KAAK,KAAK;QAEV;;WAEG;QACH,cAAc,KAAK;QAEnB;;WAEG;QACH,WAAW,KAAK;QAEhB;;WAEG;QACH,cAAc,KAAK;QAEnB;;WAEG;QACH,gBAAgB,KAAK;QAErB;;WAEG;QACH,gBAAgB,KAAK;QAErB;;WAEG;QACH,qBAAqB,KAAK;KAC7B;IAED;;OAEG;IACI,MAAM,mBAAmB;QAC5B;;;;WAIG;;QAGH;;;;;;;WAOG;;QAGH;;;;;;WAMG;;MAEL,CAAC;IAEH;;OAEG;IACH,UAAiB,gBAAiB,SAAQ,cAAc,CAAC,OAAO,mBAAmB,CAAC;KAAG;IAEvF;;;;OAIG;IACI,MAAM,6BAA6B;QACtC;;;;;;WAMG;;YA5CH;;;;eAIG;;YAGH;;;;;;;eAOG;;YAGH;;;;;;eAMG;;;MAuBL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,0BAA2B,SAAQ,cAAc,CAAC,OAAO,6BAA6B,CAAC;KAAG;IAE3G;;;;OAIG;IACI,MAAM,wBAAwB;;YA5DjC;;;;eAIG;;YAGH;;;;;;;eAOG;;YAGH;;;;;;eAMG;;;MAqC4F,CAAC;IAEpG;;;;OAIG;IACH,UAAiB,qBAAsB,SAAQ,cAAc,CAAC,OAAO,wBAAwB,CAAC;KAAG;IAEjG;;OAEG;IACI,MAAM,eAAe;;;;;YAMpB;;;;;;;;;;eAUG;;YAGH;;;;;;;;;eASG;;YAGH;;;;;;;;;;;;;eAaG;;YAOH;;;;;;;;;;;eAWG;;gBAlNP;;;;mBAIG;;gBAGH;;;;;;mBAMG;;;YAwMC;;;;;eAKG;;YAGH;;;;;;;;eAQG;;gBAzJP;;;;mBAIG;;gBAGH;;;;;;;mBAOG;;gBAGH;;;;;;mBAMG;;;;;YAuIC;;;;;;;;;;;;;;;;;;;eAmBG;;gBA3IP;;;;;;mBAMG;;oBA5CH;;;;uBAIG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;uBAMG;;;;;;YA+JC;;;;;;;eAOG;;;oBA7LP;;;;uBAIG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;uBAMG;;;;YAyKC;;;;;;;;eAQG;;;;;;;UAOT,CAAC;IAEH;;;;OAIG;IACH,UAAiB,OAAQ,SAAQ,QAAQ,CAAC,OAAO,eAAe,CAAC;KAAG;IAE7D,MAAM,OAAO,EAAE,OAAyB,CAAC;IACzC,MAAM,QAAQ,SAAU,CAAC;CACnC;AAED,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,CAAC,OAAO,CAAC;AACrE,eAAO,MAAM,0BAA0B,6BAA8B,CAAC"}

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

@@ -15,9 +15,10 @@ import {
 import { TlvArray } from "../tlv/TlvArray.js";
 import { TlvString } from "../tlv/TlvString.js";
 import { TlvNullable } from "../tlv/TlvNullable.js";
-import { TlvUInt8, TlvUInt32 } from "../tlv/TlvNumber.js";
-import { OperationalState as OperationalStateNamespace } from "./operational-state.js";
+import { TlvUInt8, TlvUInt32, TlvEnum } from "../tlv/TlvNumber.js";
+import { TlvField, TlvOptionalField, TlvObject } from "../tlv/TlvObject.js";
 import { TlvNoArguments } from "../tlv/TlvNoArguments.js";
+import { OperationalState as OperationalStateNamespace } from "./operational-state.js";
 import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
 var RvcOperationalState;
 ((RvcOperationalState2) => {
@@ -27,6 +28,22 @@ var RvcOperationalState;
     OperationalState2[OperationalState2["Charging"] = 65] = "Charging";
     OperationalState2[OperationalState2["Docked"] = 66] = "Docked";
   })(OperationalState = RvcOperationalState2.OperationalState || (RvcOperationalState2.OperationalState = {}));
+  RvcOperationalState2.TlvOperationalStateStruct = TlvObject({
+    /**
+     * This shall be populated with a value from the OperationalStateEnum.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.2.1
+     */
+    operationalStateId: TlvField(0, TlvEnum()),
+    /**
+     * This field shall be present if the OperationalStateID is from the set reserved for Manufacturer Specific
+     * 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
+     */
+    operationalStateLabel: TlvOptionalField(1, TlvString.bound({ maxLength: 64 }))
+  });
   let ErrorState;
   ((ErrorState2) => {
     ErrorState2[ErrorState2["FailedToFindChargingDock"] = 64] = "FailedToFindChargingDock";
@@ -38,6 +55,42 @@ var RvcOperationalState;
     ErrorState2[ErrorState2["WaterTankLidOpen"] = 70] = "WaterTankLidOpen";
     ErrorState2[ErrorState2["MopCleaningPadMissing"] = 71] = "MopCleaningPadMissing";
   })(ErrorState = RvcOperationalState2.ErrorState || (RvcOperationalState2.ErrorState = {}));
+  RvcOperationalState2.TlvErrorStateStruct = TlvObject({
+    /**
+     * This shall be populated with a value from the ErrorStateEnum.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4.1
+     */
+    errorStateId: TlvField(0, TlvEnum()),
+    /**
+     * This field shall be present if the ErrorStateID is from the set reserved for Manufacturer Specific Errors,
+     * otherwise it shall NOT be present. If present, this shall contain a human-readable description of the
+     * 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
+     */
+    errorStateLabel: TlvOptionalField(1, TlvString.bound({ maxLength: 64 })),
+    /**
+     * This shall be a human-readable string that provides details about the error condition. As an example, if the
+     * 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
+     */
+    errorStateDetails: TlvOptionalField(2, TlvString.bound({ maxLength: 64 }))
+  });
+  RvcOperationalState2.TlvOperationalCommandResponse = TlvObject({
+    /**
+     * This shall indicate the success or otherwise of the attempted command invocation. On a successful invocation
+     * 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
+     */
+    commandResponseState: TlvField(0, RvcOperationalState2.TlvErrorStateStruct)
+  });
+  RvcOperationalState2.TlvOperationalErrorEvent = TlvObject({ errorState: TlvField(0, RvcOperationalState2.TlvErrorStateStruct) });
   RvcOperationalState2.ClusterInstance = MutableCluster({
     id: 97,
     name: "RvcOperationalState",
@@ -97,18 +150,14 @@ var RvcOperationalState;
        *
        * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.4
        */
-      operationalStateList: Attribute(
-        3,
-        TlvArray(OperationalStateNamespace.TlvOperationalStateStruct),
-        { default: [] }
-      ),
+      operationalStateList: Attribute(3, TlvArray(RvcOperationalState2.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
        */
-      operationalState: Attribute(4, TlvUInt8),
+      operationalState: Attribute(4, TlvEnum()),
       /**
        * This attribute shall specify the details of any current error condition being experienced on the device
        * when the OperationalState attribute is populated with Error. Please see ErrorStateStruct for general
@@ -118,7 +167,7 @@ var RvcOperationalState;
        *
        * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.6
        */
-      operationalError: Attribute(5, OperationalStateNamespace.TlvErrorState)
+      operationalError: Attribute(5, RvcOperationalState2.TlvErrorStateStruct)
     },
     commands: {
       /**
@@ -141,7 +190,7 @@ var RvcOperationalState;
        *
        * @see {@link MatterSpecification.v13.Cluster} § 7.4.5.1
        */
-      goHome: OptionalCommand(128, TlvNoArguments, 4, OperationalStateNamespace.TlvOperationalCommandResponse)
+      goHome: OptionalCommand(128, TlvNoArguments, 4, RvcOperationalState2.TlvOperationalCommandResponse)
     },
     events: {
       /**
@@ -152,7 +201,7 @@ var RvcOperationalState;
        *
        * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.1
        */
-      operationalError: Event(0, EventPriority.Critical, OperationalStateNamespace.TlvOperationalErrorEvent),
+      operationalError: Event(0, EventPriority.Critical, RvcOperationalState2.TlvOperationalErrorEvent),
       /**
        * This event is generated when the overall operation ends, successfully or otherwise. For example, the
        * completion of a cleaning operation in a Robot Vacuum Cleaner, or the completion of a wash cycle in a

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

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../../../src/clusters/rvc-operational-state.ts"],
-  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,SAAS,sBAAsB;AAC/B;AAAA,EACI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AACP,SAAS,gBAAgB;AACzB,SAAS,iBAAiB;AAC1B,SAAS,mBAAmB;AAC5B,SAAS,UAAU,iBAAiB;AACpC,SAAS,oBAAoB,iCAAiC;AAC9D,SAAS,sBAAsB;AAE/B,SAAS,uBAAuB;AAEzB,IAAU;AAAA,CAAV,CAAUA,yBAAV;AAqBI,MAAK;AAAL,IAAKC,sBAAL;AAIH,IAAAA,oCAAA,oBAAiB,MAAjB;AAKA,IAAAA,oCAAA,cAAW,MAAX;AAKA,IAAAA,oCAAA,YAAS,MAAT;AAAA,KAdQ,mBAAAD,qBAAA,qBAAAA,qBAAA;AAuBL,MAAK;AAAL,IAAKE,gBAAL;AAIH,IAAAA,wBAAA,8BAA2B,MAA3B;AAKA,IAAAA,wBAAA,WAAQ,MAAR;AAKA,IAAAA,wBAAA,oBAAiB,MAAjB;AAKA,IAAAA,wBAAA,iBAAc,MAAd;AAKA,IAAAA,wBAAA,oBAAiB,MAAjB;AAKA,IAAAA,wBAAA,sBAAmB,MAAnB;AAKA,IAAAA,wBAAA,sBAAmB,MAAnB;AAKA,IAAAA,wBAAA,2BAAwB,MAAxB;AAAA,KAvCQ,aAAAF,qBAAA,eAAAA,qBAAA;AA6CL,EAAMA,qBAAA,kBAAkB,eAAe;AAAA,IAC1C,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAYR,WAAW,UAAU,GAAK,YAAY,SAAS,WAAW,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAY7E,cAAc,UAAU,GAAK,YAAY,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAgBlD,eAAe;AAAA,QACX;AAAA,QACA,YAAY,UAAU,MAAM,EAAE,KAAK,OAAO,CAAC,CAAC;AAAA,QAC5C,EAAE,aAAa,MAAM,SAAS,KAAK;AAAA,MACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAcA,sBAAsB;AAAA,QAClB;AAAA,QACA,SAAS,0BAA0B,yBAAyB;AAAA,QAC5D,EAAE,SAAS,CAAC,EAAE;AAAA,MAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQA,kBAAkB,UAAU,GAAK,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAWzC,kBAAkB,UAAU,GAAK,0BAA0B,aAAa;AAAA,IAC5E;AAAA,IAEA,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAqBN,QAAQ,gBAAgB,KAAM,gBAAgB,GAAK,0BAA0B,6BAA6B;AAAA,IAC9G;AAAA,IAEA,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASJ,kBAAkB,MAAM,GAAK,cAAc,UAAU,0BAA0B,wBAAwB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAWvG,qBAAqB;AAAA,QACjB;AAAA,QACA,cAAc;AAAA,QACd,0BAA0B;AAAA,MAC9B;AAAA,IACJ;AAAA,EACJ,CAAC;AASM,EAAMA,qBAAA,UAAmBA,qBAAA;AACzB,EAAMA,qBAAA,WAAWA,qBAAA;AAAA,GA9OX;AAkPV,MAAM,6BAA6B,oBAAoB;AAC9D,gBAAgB,SAAS,oBAAoB,QAAQ;",
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,SAAS,sBAAsB;AAC/B;AAAA,EACI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AACP,SAAS,gBAAgB;AACzB,SAAS,iBAAiB;AAC1B,SAAS,mBAAmB;AAC5B,SAAS,UAAU,WAAW,eAAe;AAC7C,SAAS,UAAU,kBAAkB,iBAAiB;AAEtD,SAAS,sBAAsB;AAC/B,SAAS,oBAAoB,iCAAiC;AAE9D,SAAS,uBAAuB;AAEzB,IAAU;AAAA,CAAV,CAAUA,yBAAV;AAqBI,MAAK;AAAL,IAAKC,sBAAL;AAIH,IAAAA,oCAAA,oBAAiB,MAAjB;AAKA,IAAAA,oCAAA,cAAW,MAAX;AAKA,IAAAA,oCAAA,YAAS,MAAT;AAAA,KAdQ,mBAAAD,qBAAA,qBAAAA,qBAAA;AAsBL,EAAMA,qBAAA,4BAA4B,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAM/C,oBAAoB,SAAS,GAAG,QAA0B,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAS3D,uBAAuB,iBAAiB,GAAG,UAAU,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC;AAAA,EACjF,CAAC;AAeM,MAAK;AAAL,IAAKE,gBAAL;AAIH,IAAAA,wBAAA,8BAA2B,MAA3B;AAKA,IAAAA,wBAAA,WAAQ,MAAR;AAKA,IAAAA,wBAAA,oBAAiB,MAAjB;AAKA,IAAAA,wBAAA,iBAAc,MAAd;AAKA,IAAAA,wBAAA,oBAAiB,MAAjB;AAKA,IAAAA,wBAAA,sBAAmB,MAAnB;AAKA,IAAAA,wBAAA,sBAAmB,MAAnB;AAKA,IAAAA,wBAAA,2BAAwB,MAAxB;AAAA,KAvCQ,aAAAF,qBAAA,eAAAA,qBAAA;AA6CL,EAAMA,qBAAA,sBAAsB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMzC,cAAc,SAAS,GAAG,QAAoB,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAU/C,iBAAiB,iBAAiB,GAAG,UAAU,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASvE,mBAAmB,iBAAiB,GAAG,UAAU,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC;AAAA,EAC7E,CAAC;AAYM,EAAMA,qBAAA,gCAAgC,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQnD,sBAAsB,SAAS,GAAGA,qBAAA,mBAAmB;AAAA,EACzD,CAAC;AAcM,EAAMA,qBAAA,2BAA2B,UAAU,EAAE,YAAY,SAAS,GAAGA,qBAAA,mBAAmB,EAAE,CAAC;AAY3F,EAAMA,qBAAA,kBAAkB,eAAe;AAAA,IAC1C,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAYR,WAAW,UAAU,GAAK,YAAY,SAAS,WAAW,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAY7E,cAAc,UAAU,GAAK,YAAY,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAgBlD,eAAe;AAAA,QACX;AAAA,QACA,YAAY,UAAU,MAAM,EAAE,KAAK,OAAO,CAAC,CAAC;AAAA,QAC5C,EAAE,aAAa,MAAM,SAAS,KAAK;AAAA,MACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAcA,sBAAsB,UAAU,GAAK,SAASA,qBAAA,yBAAyB,GAAG,EAAE,SAAS,CAAC,EAAE,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQzF,kBAAkB,UAAU,GAAK,QAA0B,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAW5D,kBAAkB,UAAU,GAAKA,qBAAA,mBAAmB;AAAA,IACxD;AAAA,IAEA,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAqBN,QAAQ,gBAAgB,KAAM,gBAAgB,GAAKA,qBAAA,6BAA6B;AAAA,IACpF;AAAA,IAEA,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASJ,kBAAkB,MAAM,GAAK,cAAc,UAAUA,qBAAA,wBAAwB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAW7E,qBAAqB;AAAA,QACjB;AAAA,QACA,cAAc;AAAA,QACd,0BAA0B;AAAA,MAC9B;AAAA,IACJ;AAAA,EACJ,CAAC;AASM,EAAMA,qBAAA,UAAmBA,qBAAA;AACzB,EAAMA,qBAAA,WAAWA,qBAAA;AAAA,GAjVX;AAqVV,MAAM,6BAA6B,oBAAoB;AAC9D,gBAAgB,SAAS,oBAAoB,QAAQ;",
   "names": ["RvcOperationalState", "OperationalState", "ErrorState"]
 }