@matter/types 0.11.9-alpha.0-20241205-ccf69a00a → 0.11.9-alpha.0-20241206-22f233334

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

@@ -7,6 +7,7 @@
 import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
 import { BitFlag } from "../schema/BitmapSchema.js";
 import { FixedAttribute, Attribute, Command } from "../cluster/Cluster.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
 import { Identity } from "#general";
 export declare namespace RvcCleanMode {
     /**
@@ -25,12 +26,6 @@ export declare namespace RvcCleanMode {
          */
         OnOff = "OnOff"
     }
-    enum ModeChangeStatus {
-        /**
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.1
-         */
-        CleaningInProgress = 64
-    }
     enum ModeTag {
         /**
          * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2
@@ -47,7 +42,229 @@ export declare namespace RvcCleanMode {
          *
          * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2.3
          */
-        Mop = 16386
+        Mop = 16386,
+        /**
+         * The device decides which options, features and setting values to use.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Auto = 0,
+        /**
+         * The mode of the device is optimizing for faster completion.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Quick = 1,
+        /**
+         * The device is silent or barely audible while in this mode.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Quiet = 2,
+        /**
+         * Either the mode is inherently low noise or the device optimizes for that.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        LowNoise = 3,
+        /**
+         * The device is optimizing for lower energy usage in this mode. Sometimes called "Eco mode".
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        LowEnergy = 4,
+        /**
+         * A mode suitable for use during vacations or other extended absences.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Vacation = 5,
+        /**
+         * The mode uses the lowest available setting value.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Min = 6,
+        /**
+         * The mode uses the highest available setting value.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Max = 7,
+        /**
+         * The mode is recommended or suitable for use during night time.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Night = 8,
+        /**
+         * The mode is recommended or suitable for use during day time.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Day = 9
+    }
+    /**
+     * 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
+     */
+    const TlvModeTagStruct: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * If the MfgCode field exists, the Value field shall be in the manufacturer-specific value range (see Section
+         * 1.10.8, “Mode Namespace”).
+         *
+         * This field shall indicate the manufacturer’s VendorID and it shall determine the meaning of the Value field.
+         *
+         * The same manufacturer code and mode tag value in separate cluster instances are part of the same namespace
+         * and have the same meaning. For example: a manufacturer tag meaning "pinch" can be used both in a cluster
+         * 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
+         */
+        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.v13.Cluster} § 1.10.5.1.2
+         */
+        value: import("../tlv/TlvObject.js").FieldType<ModeTag>;
+    }>;
+    /**
+     * 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
+     */
+    interface ModeTagStruct extends TypeFromSchema<typeof TlvModeTagStruct> {
+    }
+    /**
+     * 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.
+     *
+     * 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.5.1
+     */
+    const TlvModeOption: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This field shall indicate readable text that describes the mode option, so that a client can provide it to
+         * 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
+         */
+        label: import("../tlv/TlvObject.js").FieldType<string>;
+        /**
+         * This field is used to identify the mode option.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2.2
+         */
+        mode: import("../tlv/TlvObject.js").FieldType<number>;
+        /**
+         * This field shall contain a list of tags that are associated with the mode option. This may be used by
+         * clients to determine the full or the partial semantics of a certain mode, depending on which tags they
+         * understand, using standard definitions and/or manufacturer specific namespace definitions.
+         *
+         * The standard mode tags are defined in this cluster specification. For the derived cluster instances, if the
+         * specification of the derived cluster defines a namespace, the set of standard mode tags also includes the
+         * mode tag values from that namespace.
+         *
+         * Mode tags can help clients look for options that meet certain criteria, render the user interface, use
+         *
+         * the mode in an automation, or to craft help text their voice-driven interfaces. A mode tag shall be either a
+         * standard tag or a manufacturer specific tag, as defined in each ModeTagStruct list entry.
+         *
+         * A mode option may have more than one mode tag. A mode option may be associated with a mixture of standard
+         * and manufacturer specific mode tags. A mode option shall be associated with at least one standard mode tag.
+         *
+         * A few examples are provided below.
+         *
+         *   • A mode named "100%" can have both the High (manufacturer specific) and Max (standard) mode tag. Clients
+         *     seeking the mode for either High or Max will find the same mode in this case.
+         *
+         *   • A mode that includes a LowEnergy tag can be displayed by the client using a widget icon that shows a
+         *     green leaf.
+         *
+         *   • A mode that includes a LowNoise tag may be used by the client when the user wishes for a lower level of
+         *     audible sound, less likely to disturb the household’s activities.
+         *
+         *   • A mode that includes a LowEnergy tag (standard, defined in this cluster specification) and also a
+         *     Delicate tag (standard, defined in the namespace of a Laundry Mode derived cluster).
+         *
+         *   • 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
+         */
+        modeTags: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+            /**
+             * If the MfgCode field exists, the Value field shall be in the manufacturer-specific value range (see Section
+             * 1.10.8, “Mode Namespace”).
+             *
+             * This field shall indicate the manufacturer’s VendorID and it shall determine the meaning of the Value field.
+             *
+             * The same manufacturer code and mode tag value in separate cluster instances are part of the same namespace
+             * and have the same meaning. For example: a manufacturer tag meaning "pinch" can be used both in a cluster
+             * 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
+             */
+            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.v13.Cluster} § 1.10.5.1.2
+             */
+            value: import("../tlv/TlvObject.js").FieldType<ModeTag>;
+        }>[]>;
+    }>;
+    /**
+     * 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.
+     *
+     * 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.5.1
+     */
+    interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {
+    }
+    enum ModeChangeStatus {
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.1
+         */
+        CleaningInProgress = 64,
+        /**
+         * Switching to the mode indicated by the NewMode field is allowed and possible. The CurrentMode attribute is
+         * set to the value of the NewMode field.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.2.1.2
+         */
+        Success = 0,
+        /**
+         * The value of the NewMode field doesn’t match any entries in the SupportedMode attribute.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.2.1.2
+         */
+        UnsupportedMode = 1,
+        /**
+         * Generic failure code, indicating that switching to the mode indicated by the NewMode field is not allowed or
+         * not possible.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.2.1.2
+         */
+        GenericFailure = 2,
+        /**
+         * The received request cannot be handled due to the current mode of the device
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.2.1.2
+         */
+        InvalidInMode = 3
     }
     /**
      * These elements and properties are present in all RvcCleanMode clusters.
@@ -71,12 +288,79 @@ export declare namespace RvcCleanMode {
             /**
              * @see {@link MatterSpecification.v13.Cluster} § 7.3.6
              */
-            readonly supportedModes: FixedAttribute<import("../index.js").TypeFromFields<{
-                label: import("../index.js").FieldType<string>;
-                mode: import("../index.js").FieldType<number>;
-                modeTags: import("../index.js").FieldType<import("../index.js").TypeFromFields<{
-                    mfgCode: import("../index.js").OptionalFieldType<import("../index.js").VendorId>;
-                    value: import("../index.js").FieldType<number>;
+            readonly supportedModes: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall indicate readable text that describes the mode option, so that a client can provide it to
+                 * 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
+                 */
+                label: import("../tlv/TlvObject.js").FieldType<string>;
+                /**
+                 * This field is used to identify the mode option.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2.2
+                 */
+                mode: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field shall contain a list of tags that are associated with the mode option. This may be used by
+                 * clients to determine the full or the partial semantics of a certain mode, depending on which tags they
+                 * understand, using standard definitions and/or manufacturer specific namespace definitions.
+                 *
+                 * The standard mode tags are defined in this cluster specification. For the derived cluster instances, if the
+                 * specification of the derived cluster defines a namespace, the set of standard mode tags also includes the
+                 * mode tag values from that namespace.
+                 *
+                 * Mode tags can help clients look for options that meet certain criteria, render the user interface, use
+                 *
+                 * the mode in an automation, or to craft help text their voice-driven interfaces. A mode tag shall be either a
+                 * standard tag or a manufacturer specific tag, as defined in each ModeTagStruct list entry.
+                 *
+                 * A mode option may have more than one mode tag. A mode option may be associated with a mixture of standard
+                 * and manufacturer specific mode tags. A mode option shall be associated with at least one standard mode tag.
+                 *
+                 * A few examples are provided below.
+                 *
+                 *   • A mode named "100%" can have both the High (manufacturer specific) and Max (standard) mode tag. Clients
+                 *     seeking the mode for either High or Max will find the same mode in this case.
+                 *
+                 *   • A mode that includes a LowEnergy tag can be displayed by the client using a widget icon that shows a
+                 *     green leaf.
+                 *
+                 *   • A mode that includes a LowNoise tag may be used by the client when the user wishes for a lower level of
+                 *     audible sound, less likely to disturb the household’s activities.
+                 *
+                 *   • A mode that includes a LowEnergy tag (standard, defined in this cluster specification) and also a
+                 *     Delicate tag (standard, defined in the namespace of a Laundry Mode derived cluster).
+                 *
+                 *   • 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
+                 */
+                modeTags: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+                    /**
+                     * If the MfgCode field exists, the Value field shall be in the manufacturer-specific value range (see Section
+                     * 1.10.8, “Mode Namespace”).
+                     *
+                     * This field shall indicate the manufacturer’s VendorID and it shall determine the meaning of the Value field.
+                     *
+                     * The same manufacturer code and mode tag value in separate cluster instances are part of the same namespace
+                     * and have the same meaning. For example: a manufacturer tag meaning "pinch" can be used both in a cluster
+                     * 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
+                     */
+                    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.v13.Cluster} § 1.10.5.1.2
+                     */
+                    value: import("../tlv/TlvObject.js").FieldType<ModeTag>;
                 }>[]>;
             }>[], any>;
             /**
@@ -92,8 +376,8 @@ export declare namespace RvcCleanMode {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.1
              */
-            readonly changeToMode: Command<import("../index.js").TypeFromFields<{
-                newMode: import("../index.js").FieldType<number>;
+            readonly changeToMode: Command<import("../tlv/TlvObject.js").TypeFromFields<{
+                newMode: import("../tlv/TlvObject.js").FieldType<number>;
             }>, void, any>;
         };
         /**
@@ -124,12 +408,79 @@ export declare namespace RvcCleanMode {
             /**
              * @see {@link MatterSpecification.v13.Cluster} § 7.3.6
              */
-            readonly supportedModes: FixedAttribute<import("../index.js").TypeFromFields<{
-                label: import("../index.js").FieldType<string>;
-                mode: import("../index.js").FieldType<number>;
-                modeTags: import("../index.js").FieldType<import("../index.js").TypeFromFields<{
-                    mfgCode: import("../index.js").OptionalFieldType<import("../index.js").VendorId>;
-                    value: import("../index.js").FieldType<number>;
+            readonly supportedModes: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall indicate readable text that describes the mode option, so that a client can provide it to
+                 * 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
+                 */
+                label: import("../tlv/TlvObject.js").FieldType<string>;
+                /**
+                 * This field is used to identify the mode option.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2.2
+                 */
+                mode: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field shall contain a list of tags that are associated with the mode option. This may be used by
+                 * clients to determine the full or the partial semantics of a certain mode, depending on which tags they
+                 * understand, using standard definitions and/or manufacturer specific namespace definitions.
+                 *
+                 * The standard mode tags are defined in this cluster specification. For the derived cluster instances, if the
+                 * specification of the derived cluster defines a namespace, the set of standard mode tags also includes the
+                 * mode tag values from that namespace.
+                 *
+                 * Mode tags can help clients look for options that meet certain criteria, render the user interface, use
+                 *
+                 * the mode in an automation, or to craft help text their voice-driven interfaces. A mode tag shall be either a
+                 * standard tag or a manufacturer specific tag, as defined in each ModeTagStruct list entry.
+                 *
+                 * A mode option may have more than one mode tag. A mode option may be associated with a mixture of standard
+                 * and manufacturer specific mode tags. A mode option shall be associated with at least one standard mode tag.
+                 *
+                 * A few examples are provided below.
+                 *
+                 *   • A mode named "100%" can have both the High (manufacturer specific) and Max (standard) mode tag. Clients
+                 *     seeking the mode for either High or Max will find the same mode in this case.
+                 *
+                 *   • A mode that includes a LowEnergy tag can be displayed by the client using a widget icon that shows a
+                 *     green leaf.
+                 *
+                 *   • A mode that includes a LowNoise tag may be used by the client when the user wishes for a lower level of
+                 *     audible sound, less likely to disturb the household’s activities.
+                 *
+                 *   • A mode that includes a LowEnergy tag (standard, defined in this cluster specification) and also a
+                 *     Delicate tag (standard, defined in the namespace of a Laundry Mode derived cluster).
+                 *
+                 *   • 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
+                 */
+                modeTags: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+                    /**
+                     * If the MfgCode field exists, the Value field shall be in the manufacturer-specific value range (see Section
+                     * 1.10.8, “Mode Namespace”).
+                     *
+                     * This field shall indicate the manufacturer’s VendorID and it shall determine the meaning of the Value field.
+                     *
+                     * The same manufacturer code and mode tag value in separate cluster instances are part of the same namespace
+                     * and have the same meaning. For example: a manufacturer tag meaning "pinch" can be used both in a cluster
+                     * 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
+                     */
+                    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.v13.Cluster} § 1.10.5.1.2
+                     */
+                    value: import("../tlv/TlvObject.js").FieldType<ModeTag>;
                 }>[]>;
             }>[], any>;
             /**
@@ -145,8 +496,8 @@ export declare namespace RvcCleanMode {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.1
              */
-            readonly changeToMode: Command<import("../index.js").TypeFromFields<{
-                newMode: import("../index.js").FieldType<number>;
+            readonly changeToMode: Command<import("../tlv/TlvObject.js").TypeFromFields<{
+                newMode: import("../tlv/TlvObject.js").FieldType<number>;
             }>, void, any>;
         };
         /**

package/dist/esm/clusters/rvc-clean-mode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rvc-clean-mode.d.ts","sourceRoot":"","sources":["../../../src/clusters/rvc-clean-mode.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,EAAiB,MAAM,uBAAuB,CAAC;AAI1F,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,YAAY,CAAC;IAC1B;;;;OAIG;IACH,KAAY,OAAO;QACf;;;;;;;WAOG;QACH,KAAK,UAAU;KAClB;IAED,KAAY,gBAAgB;QACxB;;WAEG;QACH,kBAAkB,KAAK;KAC1B;IAED,KAAY,OAAO;QACf;;WAEG;QACH,SAAS,QAAQ;QAEjB;;;;WAIG;QACH,MAAM,QAAQ;QAEd;;;;WAIG;QACH,GAAG,QAAQ;KACd;IAED;;OAEG;IACI,MAAM,IAAI;;;;;YAMT;;;;;;;eAOG;;;;YAKH;;eAEG;;;;;;;;;YAOH;;eAEG;;;;YAKH;;;;;;eAMG;;;;;QAIP;;;WAGG;;KAEL,CAAC;IAEH;;OAEG;IACI,MAAM,eAAe;;;;;YAhDpB;;;;;;;eAOG;;;;YAKH;;eAEG;;;;;;;;;YAOH;;eAEG;;;;YAKH;;;;;;eAMG;;;;;QAIP;;;WAGG;;UAO4C,CAAC;IAEpD;;;;;;;;OAQG;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,mBAAmB,GAAG,YAAY,CAAC,OAAO,CAAC;AACvD,eAAO,MAAM,mBAAmB,sBAAuB,CAAC"}
+{"version":3,"file":"rvc-clean-mode.d.ts","sourceRoot":"","sources":["../../../src/clusters/rvc-clean-mode.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,EAAiB,MAAM,uBAAuB,CAAC;AAM1F,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,YAAY,CAAC;IAC1B;;;;OAIG;IACH,KAAY,OAAO;QACf;;;;;;;WAOG;QACH,KAAK,UAAU;KAClB;IAED,KAAY,OAAO;QACf;;WAEG;QACH,SAAS,QAAQ;QAEjB;;;;WAIG;QACH,MAAM,QAAQ;QAEd;;;;WAIG;QACH,GAAG,QAAQ;QAEX;;;;WAIG;QACH,IAAI,IAAI;QAER;;;;WAIG;QACH,KAAK,IAAI;QAET;;;;WAIG;QACH,KAAK,IAAI;QAET;;;;WAIG;QACH,QAAQ,IAAI;QAEZ;;;;WAIG;QACH,SAAS,IAAI;QAEb;;;;WAIG;QACH,QAAQ,IAAI;QAEZ;;;;WAIG;QACH,GAAG,IAAI;QAEP;;;;WAIG;QACH,GAAG,IAAI;QAEP;;;;WAIG;QACH,KAAK,IAAI;QAET;;;;WAIG;QACH,GAAG,IAAI;KACV;IAED;;;;OAIG;IACI,MAAM,gBAAgB;QACzB;;;;;;;;;;;;WAYG;;QAGH;;;;;WAKG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,aAAc,SAAQ,cAAc,CAAC,OAAO,gBAAgB,CAAC;KAAG;IAEjF;;;;;;;;OAQG;IACI,MAAM,aAAa;QACtB;;;;;;WAMG;;QAGH;;;;WAIG;;QAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmCG;;YA5FH;;;;;;;;;;;;eAYG;;YAGH;;;;;eAKG;;;MA0EL,CAAC;IAEH;;;;;;;;OAQG;IACH,UAAiB,UAAW,SAAQ,cAAc,CAAC,OAAO,aAAa,CAAC;KAAG;IAE3E,KAAY,gBAAgB;QACxB;;WAEG;QACH,kBAAkB,KAAK;QAEvB;;;;;WAKG;QACH,OAAO,IAAI;QAEX;;;;WAIG;QACH,eAAe,IAAI;QAEnB;;;;;WAKG;QACH,cAAc,IAAI;QAElB;;;;WAIG;QACH,aAAa,IAAI;KACpB;IAED;;OAEG;IACI,MAAM,IAAI;;;;;YAMT;;;;;;;eAOG;;;;YAKH;;eAEG;;gBA9HP;;;;;;mBAMG;;gBAGH;;;;mBAIG;;gBAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAmCG;;oBA5FH;;;;;;;;;;;;uBAYG;;oBAGH;;;;;uBAKG;;;;YA0JC;;eAEG;;;;YAKH;;;;;;eAMG;;;;;QAIP;;;WAGG;;KAEL,CAAC;IAEH;;OAEG;IACI,MAAM,eAAe;;;;;YAhDpB;;;;;;;eAOG;;;;YAKH;;eAEG;;gBA9HP;;;;;;mBAMG;;gBAGH;;;;mBAIG;;gBAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAmCG;;oBA5FH;;;;;;;;;;;;uBAYG;;oBAGH;;;;;uBAKG;;;;YA0JC;;eAEG;;;;YAKH;;;;;;eAMG;;;;;QAIP;;;WAGG;;UAO4C,CAAC;IAEpD;;;;;;;;OAQG;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,mBAAmB,GAAG,YAAY,CAAC,OAAO,CAAC;AACvD,eAAO,MAAM,mBAAmB,sBAAuB,CAAC"}

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

@@ -7,8 +7,11 @@ import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
 import { BitFlag } from "../schema/BitmapSchema.js";
 import { FixedAttribute, Attribute, Command, TlvNoResponse } from "../cluster/Cluster.js";
 import { TlvArray } from "../tlv/TlvArray.js";
+import { TlvField, TlvOptionalField, TlvObject } from "../tlv/TlvObject.js";
+import { TlvString } from "../tlv/TlvString.js";
+import { TlvUInt8, TlvEnum } from "../tlv/TlvNumber.js";
+import { TlvVendorId } from "../datatype/VendorId.js";
 import { ModeBase } from "./mode-base.js";
-import { TlvUInt8 } from "../tlv/TlvNumber.js";
 import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
 var RvcCleanMode;
 ((RvcCleanMode2) => {
@@ -16,16 +19,106 @@ var RvcCleanMode;
   ((Feature2) => {
     Feature2["OnOff"] = "OnOff";
   })(Feature = RvcCleanMode2.Feature || (RvcCleanMode2.Feature = {}));
-  let ModeChangeStatus;
-  ((ModeChangeStatus2) => {
-    ModeChangeStatus2[ModeChangeStatus2["CleaningInProgress"] = 64] = "CleaningInProgress";
-  })(ModeChangeStatus = RvcCleanMode2.ModeChangeStatus || (RvcCleanMode2.ModeChangeStatus = {}));
   let ModeTag;
   ((ModeTag2) => {
     ModeTag2[ModeTag2["DeepClean"] = 16384] = "DeepClean";
     ModeTag2[ModeTag2["Vacuum"] = 16385] = "Vacuum";
     ModeTag2[ModeTag2["Mop"] = 16386] = "Mop";
+    ModeTag2[ModeTag2["Auto"] = 0] = "Auto";
+    ModeTag2[ModeTag2["Quick"] = 1] = "Quick";
+    ModeTag2[ModeTag2["Quiet"] = 2] = "Quiet";
+    ModeTag2[ModeTag2["LowNoise"] = 3] = "LowNoise";
+    ModeTag2[ModeTag2["LowEnergy"] = 4] = "LowEnergy";
+    ModeTag2[ModeTag2["Vacation"] = 5] = "Vacation";
+    ModeTag2[ModeTag2["Min"] = 6] = "Min";
+    ModeTag2[ModeTag2["Max"] = 7] = "Max";
+    ModeTag2[ModeTag2["Night"] = 8] = "Night";
+    ModeTag2[ModeTag2["Day"] = 9] = "Day";
   })(ModeTag = RvcCleanMode2.ModeTag || (RvcCleanMode2.ModeTag = {}));
+  RvcCleanMode2.TlvModeTagStruct = TlvObject({
+    /**
+     * If the MfgCode field exists, the Value field shall be in the manufacturer-specific value range (see Section
+     * 1.10.8, “Mode Namespace”).
+     *
+     * This field shall indicate the manufacturer’s VendorID and it shall determine the meaning of the Value field.
+     *
+     * The same manufacturer code and mode tag value in separate cluster instances are part of the same namespace
+     * and have the same meaning. For example: a manufacturer tag meaning "pinch" can be used both in a cluster
+     * 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
+     */
+    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.v13.Cluster} § 1.10.5.1.2
+     */
+    value: TlvField(1, TlvEnum())
+  });
+  RvcCleanMode2.TlvModeOption = TlvObject({
+    /**
+     * This field shall indicate readable text that describes the mode option, so that a client can provide it to
+     * 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
+     */
+    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
+     */
+    mode: TlvField(1, TlvUInt8),
+    /**
+     * This field shall contain a list of tags that are associated with the mode option. This may be used by
+     * clients to determine the full or the partial semantics of a certain mode, depending on which tags they
+     * understand, using standard definitions and/or manufacturer specific namespace definitions.
+     *
+     * The standard mode tags are defined in this cluster specification. For the derived cluster instances, if the
+     * specification of the derived cluster defines a namespace, the set of standard mode tags also includes the
+     * mode tag values from that namespace.
+     *
+     * Mode tags can help clients look for options that meet certain criteria, render the user interface, use
+     *
+     * the mode in an automation, or to craft help text their voice-driven interfaces. A mode tag shall be either a
+     * standard tag or a manufacturer specific tag, as defined in each ModeTagStruct list entry.
+     *
+     * A mode option may have more than one mode tag. A mode option may be associated with a mixture of standard
+     * and manufacturer specific mode tags. A mode option shall be associated with at least one standard mode tag.
+     *
+     * A few examples are provided below.
+     *
+     *   • A mode named "100%" can have both the High (manufacturer specific) and Max (standard) mode tag. Clients
+     *     seeking the mode for either High or Max will find the same mode in this case.
+     *
+     *   • A mode that includes a LowEnergy tag can be displayed by the client using a widget icon that shows a
+     *     green leaf.
+     *
+     *   • A mode that includes a LowNoise tag may be used by the client when the user wishes for a lower level of
+     *     audible sound, less likely to disturb the household’s activities.
+     *
+     *   • A mode that includes a LowEnergy tag (standard, defined in this cluster specification) and also a
+     *     Delicate tag (standard, defined in the namespace of a Laundry Mode derived cluster).
+     *
+     *   • 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
+     */
+    modeTags: TlvField(2, TlvArray(RvcCleanMode2.TlvModeTagStruct, { maxLength: 8 }))
+  });
+  let ModeChangeStatus;
+  ((ModeChangeStatus2) => {
+    ModeChangeStatus2[ModeChangeStatus2["CleaningInProgress"] = 64] = "CleaningInProgress";
+    ModeChangeStatus2[ModeChangeStatus2["Success"] = 0] = "Success";
+    ModeChangeStatus2[ModeChangeStatus2["UnsupportedMode"] = 1] = "UnsupportedMode";
+    ModeChangeStatus2[ModeChangeStatus2["GenericFailure"] = 2] = "GenericFailure";
+    ModeChangeStatus2[ModeChangeStatus2["InvalidInMode"] = 3] = "InvalidInMode";
+  })(ModeChangeStatus = RvcCleanMode2.ModeChangeStatus || (RvcCleanMode2.ModeChangeStatus = {}));
   RvcCleanMode2.Base = MutableCluster.Component({
     id: 85,
     name: "RvcCleanMode",
@@ -47,7 +140,7 @@ var RvcCleanMode;
        */
       supportedModes: FixedAttribute(
         0,
-        TlvArray(ModeBase.TlvModeOption, { minLength: 2, maxLength: 255 }),
+        TlvArray(RvcCleanMode2.TlvModeOption, { minLength: 2, maxLength: 255 }),
         { default: [] }
       ),
       /**

package/dist/esm/clusters/rvc-clean-mode.js.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../../../src/clusters/rvc-clean-mode.ts"],
-  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,SAAS,sBAAsB;AAC/B,SAAS,eAAe;AACxB,SAAS,gBAAgB,WAAW,SAAS,qBAAqB;AAClE,SAAS,gBAAgB;AACzB,SAAS,gBAAgB;AACzB,SAAS,gBAAgB;AAEzB,SAAS,uBAAuB;AAEzB,IAAU;AAAA,CAAV,CAAUA,kBAAV;AAMI,MAAK;AAAL,IAAKC,aAAL;AASH,IAAAA,SAAA,WAAQ;AAAA,KATA,UAAAD,cAAA,YAAAA,cAAA;AAYL,MAAK;AAAL,IAAKE,sBAAL;AAIH,IAAAA,oCAAA,wBAAqB,MAArB;AAAA,KAJQ,mBAAAF,cAAA,qBAAAA,cAAA;AAOL,MAAK;AAAL,IAAKG,aAAL;AAIH,IAAAA,kBAAA,eAAY,SAAZ;AAOA,IAAAA,kBAAA,YAAS,SAAT;AAOA,IAAAA,kBAAA,SAAM,SAAN;AAAA,KAlBQ,UAAAH,cAAA,YAAAA,cAAA;AAwBL,EAAMA,cAAA,OAAO,eAAe,UAAU;AAAA,IACzC,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASN,OAAO,QAAQ,CAAC;AAAA,IACpB;AAAA,IAEA,YAAY;AAAA;AAAA;AAAA;AAAA,MAIR,gBAAgB;AAAA,QACZ;AAAA,QACA,SAAS,SAAS,eAAe,EAAE,WAAW,GAAG,WAAW,IAAI,CAAC;AAAA,QACjE,EAAE,SAAS,CAAC,EAAE;AAAA,MAClB;AAAA;AAAA;AAAA;AAAA,MAKA,aAAa,UAAU,GAAK,UAAU,EAAE,OAAO,MAAM,YAAY,KAAK,CAAC;AAAA,IAC3E;AAAA,IAEA,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQN,cAAc,QAAQ,GAAK,SAAS,wBAAwB,GAAK,aAAa;AAAA,IAClF;AAAA;AAAA;AAAA;AAAA;AAAA,IAMA,YAAY,eAAe,WAAW;AAAA,EAC1C,CAAC;AAKM,EAAMA,cAAA,kBAAkB,eAAeA,cAAA,IAAI;AAa3C,EAAMA,cAAA,UAAmBA,cAAA;AACzB,EAAMA,cAAA,WAAWA,cAAA;AAAA,GArHX;AAyHV,MAAM,sBAAsB,aAAa;AAChD,gBAAgB,SAAS,aAAa,QAAQ;",
-  "names": ["RvcCleanMode", "Feature", "ModeChangeStatus", "ModeTag"]
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,SAAS,sBAAsB;AAC/B,SAAS,eAAe;AACxB,SAAS,gBAAgB,WAAW,SAAS,qBAAqB;AAClE,SAAS,gBAAgB;AACzB,SAAS,UAAU,kBAAkB,iBAAiB;AACtD,SAAS,iBAAiB;AAC1B,SAAS,UAAU,eAAe;AAClC,SAAS,mBAAmB;AAE5B,SAAS,gBAAgB;AAEzB,SAAS,uBAAuB;AAEzB,IAAU;AAAA,CAAV,CAAUA,kBAAV;AAMI,MAAK;AAAL,IAAKC,aAAL;AASH,IAAAA,SAAA,WAAQ;AAAA,KATA,UAAAD,cAAA,YAAAA,cAAA;AAYL,MAAK;AAAL,IAAKE,aAAL;AAIH,IAAAA,kBAAA,eAAY,SAAZ;AAOA,IAAAA,kBAAA,YAAS,SAAT;AAOA,IAAAA,kBAAA,SAAM,SAAN;AAOA,IAAAA,kBAAA,UAAO,KAAP;AAOA,IAAAA,kBAAA,WAAQ,KAAR;AAOA,IAAAA,kBAAA,WAAQ,KAAR;AAOA,IAAAA,kBAAA,cAAW,KAAX;AAOA,IAAAA,kBAAA,eAAY,KAAZ;AAOA,IAAAA,kBAAA,cAAW,KAAX;AAOA,IAAAA,kBAAA,SAAM,KAAN;AAOA,IAAAA,kBAAA,SAAM,KAAN;AAOA,IAAAA,kBAAA,WAAQ,KAAR;AAOA,IAAAA,kBAAA,SAAM,KAAN;AAAA,KAxFQ,UAAAF,cAAA,YAAAA,cAAA;AAgGL,EAAMA,cAAA,mBAAmB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IActC,SAAS,iBAAiB,GAAG,WAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQxC,OAAO,SAAS,GAAG,QAAiB,CAAC;AAAA,EACzC,CAAC;AAkBM,EAAMA,cAAA,gBAAgB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQnC,OAAO,SAAS,GAAG,UAAU,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOrD,MAAM,SAAS,GAAG,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAsC1B,UAAU,SAAS,GAAG,SAASA,cAAA,kBAAkB,EAAE,WAAW,EAAE,CAAC,CAAC;AAAA,EACtE,CAAC;AAaM,MAAK;AAAL,IAAKG,sBAAL;AAIH,IAAAA,oCAAA,wBAAqB,MAArB;AAQA,IAAAA,oCAAA,aAAU,KAAV;AAOA,IAAAA,oCAAA,qBAAkB,KAAlB;AAQA,IAAAA,oCAAA,oBAAiB,KAAjB;AAOA,IAAAA,oCAAA,mBAAgB,KAAhB;AAAA,KAlCQ,mBAAAH,cAAA,qBAAAA,cAAA;AAwCL,EAAMA,cAAA,OAAO,eAAe,UAAU;AAAA,IACzC,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASN,OAAO,QAAQ,CAAC;AAAA,IACpB;AAAA,IAEA,YAAY;AAAA;AAAA;AAAA;AAAA,MAIR,gBAAgB;AAAA,QACZ;AAAA,QACA,SAASA,cAAA,eAAe,EAAE,WAAW,GAAG,WAAW,IAAI,CAAC;AAAA,QACxD,EAAE,SAAS,CAAC,EAAE;AAAA,MAClB;AAAA;AAAA;AAAA;AAAA,MAKA,aAAa,UAAU,GAAK,UAAU,EAAE,OAAO,MAAM,YAAY,KAAK,CAAC;AAAA,IAC3E;AAAA,IAEA,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQN,cAAc,QAAQ,GAAK,SAAS,wBAAwB,GAAK,aAAa;AAAA,IAClF;AAAA;AAAA;AAAA;AAAA;AAAA,IAMA,YAAY,eAAe,WAAW;AAAA,EAC1C,CAAC;AAKM,EAAMA,cAAA,kBAAkB,eAAeA,cAAA,IAAI;AAa3C,EAAMA,cAAA,UAAmBA,cAAA;AACzB,EAAMA,cAAA,WAAWA,cAAA;AAAA,GA1UX;AA8UV,MAAM,sBAAsB,aAAa;AAChD,gBAAgB,SAAS,aAAa,QAAQ;",
+  "names": ["RvcCleanMode", "Feature", "ModeTag", "ModeChangeStatus"]
 }