/**
 * @license
 * Copyright 2022-2025 Matter.js Authors
 * SPDX-License-Identifier: Apache-2.0
 */
/*** THIS FILE IS GENERATED, DO NOT EDIT ***/
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 {
    /**
     * These are optional features supported by RvcCleanModeCluster.
     *
     * @see {@link MatterSpecification.v13.Cluster} § 1.10.4
     */
    enum Feature {
        /**
         * OnOff (DEPONOFF)
         *
         * This feature creates a dependency between an OnOff cluster instance and this cluster instance on the same
         * endpoint. See OnMode for more information.
         *
         * @see {@link MatterSpecification.v13.Cluster} § 1.10.4.1
         */
        OnOff = "OnOff"
    }
    enum ModeTag {
        /**
         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2
         */
        DeepClean = 16384,
        /**
         * The device’s vacuuming feature is enabled in this mode.
         *
         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2.2
         */
        Vacuum = 16385,
        /**
         * The device’s mopping feature is enabled in this mode.
         *
         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2.3
         */
        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.
     */
    const Base: {
        readonly id: 85;
        readonly name: "RvcCleanMode";
        readonly revision: 2;
        readonly features: {
            /**
             * OnOff
             *
             * This feature creates a dependency between an OnOff cluster instance and this cluster instance on the
             * same endpoint. See OnMode for more information.
             *
             * @see {@link MatterSpecification.v13.Cluster} § 1.10.4.1
             */
            readonly onOff: BitFlag;
        };
        readonly attributes: {
            /**
             * @see {@link MatterSpecification.v13.Cluster} § 7.3.6
             */
            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>;
            /**
             * @see {@link MatterSpecification.v13.Cluster} § 7.3.6
             */
            readonly currentMode: Attribute<number, any>;
        };
        readonly commands: {
            /**
             * This command is used to change device modes.
             *
             * On receipt of this command the device shall respond with a ChangeToModeResponse command.
             *
             * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.1
             */
            readonly changeToMode: Command<import("../tlv/TlvObject.js").TypeFromFields<{
                newMode: import("../tlv/TlvObject.js").FieldType<number>;
            }>, void, any>;
        };
        /**
         * This metadata controls which RvcCleanModeCluster elements matter.js activates for specific feature
         * combinations.
         */
        readonly extensions: readonly [];
    };
    /**
     * @see {@link Cluster}
     */
    const ClusterInstance: MutableCluster<{
        readonly id: 85;
        readonly name: "RvcCleanMode";
        readonly revision: 2;
        readonly features: {
            /**
             * OnOff
             *
             * This feature creates a dependency between an OnOff cluster instance and this cluster instance on the
             * same endpoint. See OnMode for more information.
             *
             * @see {@link MatterSpecification.v13.Cluster} § 1.10.4.1
             */
            readonly onOff: BitFlag;
        };
        readonly attributes: {
            /**
             * @see {@link MatterSpecification.v13.Cluster} § 7.3.6
             */
            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>;
            /**
             * @see {@link MatterSpecification.v13.Cluster} § 7.3.6
             */
            readonly currentMode: Attribute<number, any>;
        };
        readonly commands: {
            /**
             * This command is used to change device modes.
             *
             * On receipt of this command the device shall respond with a ChangeToModeResponse command.
             *
             * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.1
             */
            readonly changeToMode: Command<import("../tlv/TlvObject.js").TypeFromFields<{
                newMode: import("../tlv/TlvObject.js").FieldType<number>;
            }>, void, any>;
        };
        /**
         * This metadata controls which RvcCleanModeCluster elements matter.js activates for specific feature
         * combinations.
         */
        readonly extensions: readonly [];
    }, []>;
    /**
     * This cluster is derived from the Mode Base cluster to define specifics for Robotic Vacuum Cleaner devices. It
     * also defines a namespace for the cleaning type for these devices.
     *
     * RvcCleanModeCluster supports optional features that you can enable with the RvcCleanModeCluster.with() factory
     * method.
     *
     * @see {@link MatterSpecification.v13.Cluster} § 7.3
     */
    interface Cluster extends Identity<typeof ClusterInstance> {
    }
    const Cluster: Cluster;
    const Complete: Cluster;
}
export type RvcCleanModeCluster = RvcCleanMode.Cluster;
export declare const RvcCleanModeCluster: RvcCleanMode.Cluster;
//# sourceMappingURL=rvc-clean-mode.d.ts.map