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

package/dist/cjs/clusters/rvc-run-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 RvcRunMode {
     /**
@@ -25,6 +26,239 @@ export declare namespace RvcRunMode {
          */
         OnOff = "OnOff"
     }
+    enum ModeTag {
+        /**
+         * The device is not performing any of the main operations of the other modes. However, auxiliary actions, such
+         * as seeking the charger or charging, may occur.
+         *
+         * For example, the device has completed cleaning, successfully or not, on its own or due to a command, or has
+         * not been asked to clean after a restart.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 7.2.7.2.1
+         */
+        Idle = 16384,
+        /**
+         * The device was asked to clean so it may be actively running, or paused due to an error, due to a pause
+         * command, or for recharging etc. If currently paused and the device can resume it will continue to clean.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 7.2.7.2.2
+         */
+        Cleaning = 16385,
+        /**
+         * The device was asked to create a map of the space it is located in, so it may be actively running, or paused
+         * due to an error, due to a pause command, or for recharging etc. If currently paused and the device can
+         * resume, it will continue to map.
+         *
+         * NOTE
+         *
+         * this mode is intended to be used so the current space can be mapped by the device if the robot has not
+         * previously done that, or if the layout has substantially changed, for an optimal subsequent cleaning
+         * experience.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 7.2.7.2.3
+         */
+        Mapping = 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 Idle mode tag in the ModeTags field.
+     *
+     * At least one entry in the SupportedModes attribute (different from the one above) shall include the Cleaning
+     * mode tag in the ModeTags field.
+     *
+     * The Mapping, Cleaning, and Idle mode tags are mutually exclusive and shall NOT be used together in a mode’s
+     * ModeTags.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 7.2.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 Idle mode tag in the ModeTags field.
+     *
+     * At least one entry in the SupportedModes attribute (different from the one above) shall include the Cleaning
+     * mode tag in the ModeTags field.
+     *
+     * The Mapping, Cleaning, and Idle mode tags are mutually exclusive and shall NOT be used together in a mode’s
+     * ModeTags.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 7.2.5.1
+     */
+    interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {
+    }
     enum ModeChangeStatus {
         /**
          * @see {@link MatterSpecification.v13.Cluster} § 7.2.7.1
@@ -57,40 +291,33 @@ export declare namespace RvcRunMode {
         /**
          * @see {@link MatterSpecification.v13.Cluster} § 7.2.7.1
          */
-        BatteryLow = 72
-    }
-    enum ModeTag {
+        BatteryLow = 72,
         /**
-         * The device is not performing any of the main operations of the other modes. However, auxiliary actions, such
-         * as seeking the charger or charging, may occur.
-         *
-         * For example, the device has completed cleaning, successfully or not, on its own or due to a command, or has
-         * not been asked to clean after a restart.
+         * 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} § 7.2.7.2.1
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.2.1.2
          */
-        Idle = 16384,
+        Success = 0,
         /**
-         * The device was asked to clean so it may be actively running, or paused due to an error, due to a pause
-         * command, or for recharging etc. If currently paused and the device can resume it will continue to clean.
+         * The value of the NewMode field doesn’t match any entries in the SupportedMode attribute.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 7.2.7.2.2
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.2.1.2
          */
-        Cleaning = 16385,
+        UnsupportedMode = 1,
         /**
-         * The device was asked to create a map of the space it is located in, so it may be actively running, or paused
-         * due to an error, due to a pause command, or for recharging etc. If currently paused and the device can
-         * resume, it will continue to map.
+         * Generic failure code, indicating that switching to the mode indicated by the NewMode field is not allowed or
+         * not possible.
          *
-         * NOTE
-         *
-         * this mode is intended to be used so the current space can be mapped by the device if the robot has not
-         * previously done that, or if the layout has substantially changed, for an optimal subsequent cleaning
-         * experience.
+         * @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} § 7.2.7.2.3
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.2.1.2
          */
-        Mapping = 16386
+        InvalidInMode = 3
     }
     /**
      * These elements and properties are present in all RvcRunMode clusters.
@@ -114,12 +341,79 @@ export declare namespace RvcRunMode {
             /**
              * @see {@link MatterSpecification.v13.Cluster} § 7.2.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>;
             /**
@@ -135,8 +429,8 @@ export declare namespace RvcRunMode {
              *
              * @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>;
         };
         /**
@@ -167,12 +461,79 @@ export declare namespace RvcRunMode {
             /**
              * @see {@link MatterSpecification.v13.Cluster} § 7.2.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>;
             /**
@@ -188,8 +549,8 @@ export declare namespace RvcRunMode {
              *
              * @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/cjs/clusters/rvc-run-mode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rvc-run-mode.d.ts","sourceRoot":"","sources":["../../../src/clusters/rvc-run-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,UAAU,CAAC;IACxB;;;;OAIG;IACH,KAAY,OAAO;QACf;;;;;;;WAOG;QACH,KAAK,UAAU;KAClB;IAED,KAAY,gBAAgB;QACxB;;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;QAE1B;;WAEG;QACH,UAAU,KAAK;KAClB;IAED,KAAY,OAAO;QACf;;;;;;;;WAQG;QACH,IAAI,QAAQ;QAEZ;;;;;WAKG;QACH,QAAQ,QAAQ;QAEhB;;;;;;;;;;;;WAYG;QACH,OAAO,QAAQ;KAClB;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,iBAAiB,GAAG,UAAU,CAAC,OAAO,CAAC;AACnD,eAAO,MAAM,iBAAiB,oBAAqB,CAAC"}
+{"version":3,"file":"rvc-run-mode.d.ts","sourceRoot":"","sources":["../../../src/clusters/rvc-run-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,UAAU,CAAC;IACxB;;;;OAIG;IACH,KAAY,OAAO;QACf;;;;;;;WAOG;QACH,KAAK,UAAU;KAClB;IAED,KAAY,OAAO;QACf;;;;;;;;WAQG;QACH,IAAI,QAAQ;QAEZ;;;;;WAKG;QACH,QAAQ,QAAQ;QAEhB;;;;;;;;;;;;WAYG;QACH,OAAO,QAAQ;QAEf;;;;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;;;;;;;;;;;;;OAaG;IACI,MAAM,aAAa;QACtB;;;;;;WAMG;;QAGH;;;;WAIG;;QAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmCG;;YAjGH;;;;;;;;;;;;eAYG;;YAGH;;;;;eAKG;;;MA+EL,CAAC;IAEH;;;;;;;;;;;;;OAaG;IACH,UAAiB,UAAW,SAAQ,cAAc,CAAC,OAAO,aAAa,CAAC;KAAG;IAE3E,KAAY,gBAAgB;QACxB;;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;QAE1B;;WAEG;QACH,UAAU,KAAK;QAEf;;;;;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;;gBAtKP;;;;;;mBAMG;;gBAGH;;;;mBAIG;;gBAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAmCG;;oBAjGH;;;;;;;;;;;;uBAYG;;oBAGH;;;;;uBAKG;;;;YAuMC;;eAEG;;;;YAKH;;;;;;eAMG;;;;;QAIP;;;WAGG;;KAEL,CAAC;IAEH;;OAEG;IACI,MAAM,eAAe;;;;;YAhDpB;;;;;;;eAOG;;;;YAKH;;eAEG;;gBAtKP;;;;;;mBAMG;;gBAGH;;;;mBAIG;;gBAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAmCG;;oBAjGH;;;;;;;;;;;;uBAYG;;oBAGH;;;;;uBAKG;;;;YAuMC;;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,iBAAiB,GAAG,UAAU,CAAC,OAAO,CAAC;AACnD,eAAO,MAAM,iBAAiB,oBAAqB,CAAC"}

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

@@ -26,8 +26,11 @@ var import_MutableCluster = require("../cluster/mutation/MutableCluster.js");
 var import_BitmapSchema = require("../schema/BitmapSchema.js");
 var import_Cluster = require("../cluster/Cluster.js");
 var import_TlvArray = require("../tlv/TlvArray.js");
-var import_mode_base = require("./mode-base.js");
+var import_TlvObject = require("../tlv/TlvObject.js");
+var import_TlvString = require("../tlv/TlvString.js");
 var import_TlvNumber = require("../tlv/TlvNumber.js");
+var import_VendorId = require("../datatype/VendorId.js");
+var import_mode_base = require("./mode-base.js");
 var import_ClusterRegistry = require("../cluster/ClusterRegistry.js");
 /**
  * @license
@@ -40,6 +43,98 @@ var RvcRunMode;
   ((Feature2) => {
     Feature2["OnOff"] = "OnOff";
   })(Feature = RvcRunMode2.Feature || (RvcRunMode2.Feature = {}));
+  let ModeTag;
+  ((ModeTag2) => {
+    ModeTag2[ModeTag2["Idle"] = 16384] = "Idle";
+    ModeTag2[ModeTag2["Cleaning"] = 16385] = "Cleaning";
+    ModeTag2[ModeTag2["Mapping"] = 16386] = "Mapping";
+    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 = RvcRunMode2.ModeTag || (RvcRunMode2.ModeTag = {}));
+  RvcRunMode2.TlvModeTagStruct = (0, import_TlvObject.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: (0, import_TlvObject.TlvOptionalField)(0, import_VendorId.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: (0, import_TlvObject.TlvField)(1, (0, import_TlvNumber.TlvEnum)())
+  });
+  RvcRunMode2.TlvModeOption = (0, import_TlvObject.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: (0, import_TlvObject.TlvField)(0, import_TlvString.TlvString.bound({ maxLength: 64 })),
+    /**
+     * This field is used to identify the mode option.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2.2
+     */
+    mode: (0, import_TlvObject.TlvField)(1, import_TlvNumber.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: (0, import_TlvObject.TlvField)(2, (0, import_TlvArray.TlvArray)(RvcRunMode2.TlvModeTagStruct, { maxLength: 8 }))
+  });
   let ModeChangeStatus;
   ((ModeChangeStatus2) => {
     ModeChangeStatus2[ModeChangeStatus2["Stuck"] = 65] = "Stuck";
@@ -50,13 +145,11 @@ var RvcRunMode;
     ModeChangeStatus2[ModeChangeStatus2["WaterTankLidOpen"] = 70] = "WaterTankLidOpen";
     ModeChangeStatus2[ModeChangeStatus2["MopCleaningPadMissing"] = 71] = "MopCleaningPadMissing";
     ModeChangeStatus2[ModeChangeStatus2["BatteryLow"] = 72] = "BatteryLow";
+    ModeChangeStatus2[ModeChangeStatus2["Success"] = 0] = "Success";
+    ModeChangeStatus2[ModeChangeStatus2["UnsupportedMode"] = 1] = "UnsupportedMode";
+    ModeChangeStatus2[ModeChangeStatus2["GenericFailure"] = 2] = "GenericFailure";
+    ModeChangeStatus2[ModeChangeStatus2["InvalidInMode"] = 3] = "InvalidInMode";
   })(ModeChangeStatus = RvcRunMode2.ModeChangeStatus || (RvcRunMode2.ModeChangeStatus = {}));
-  let ModeTag;
-  ((ModeTag2) => {
-    ModeTag2[ModeTag2["Idle"] = 16384] = "Idle";
-    ModeTag2[ModeTag2["Cleaning"] = 16385] = "Cleaning";
-    ModeTag2[ModeTag2["Mapping"] = 16386] = "Mapping";
-  })(ModeTag = RvcRunMode2.ModeTag || (RvcRunMode2.ModeTag = {}));
   RvcRunMode2.Base = import_MutableCluster.MutableCluster.Component({
     id: 84,
     name: "RvcRunMode",
@@ -78,7 +171,7 @@ var RvcRunMode;
        */
       supportedModes: (0, import_Cluster.FixedAttribute)(
         0,
-        (0, import_TlvArray.TlvArray)(import_mode_base.ModeBase.TlvModeOption, { minLength: 2, maxLength: 255 }),
+        (0, import_TlvArray.TlvArray)(RvcRunMode2.TlvModeOption, { minLength: 2, maxLength: 255 }),
         { default: [] }
       ),
       /**