@matter/types 0.11.0-alpha.0-20241005-e3e4e4a7a

package/dist/esm/clusters/mode-base.d.ts

@@ -0,0 +1,716 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { WritableAttribute, FixedAttribute, Attribute, OptionalWritableAttribute, Command } from "../cluster/Cluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
+import { Status } from "../globals/Status.js";
+import { Identity } from "#general";
+export declare namespace ModeBase {
+    /**
+     * These are optional features supported by ModeBaseCluster.
+     *
+     * @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"
+    }
+    /**
+     * 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 TlvModeTag: 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<number>;
+    }>;
+    /**
+     * 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 ModeTag extends TypeFromSchema<typeof TlvModeTag> {
+    }
+    /**
+     * This is a struct representing a possible mode of the server.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2
+     */
+    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<number>;
+        }>[]>;
+    }>;
+    /**
+     * This is a struct representing a possible mode of the server.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2
+     */
+    interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {
+    }
+    /**
+     * Input to the ModeBase changeToMode command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.1
+     */
+    const TlvChangeToModeRequest: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * If the NewMode field doesn’t match the Mode field of any entry of the SupportedModes list, the
+         * ChangeToModeResponse command’s Status field shall indicate UnsupportedMode and the StatusText field shall be
+         * included and may be used to indicate the issue, with a human readable string, or include an empty string.
+         *
+         * If the NewMode field matches the Mode field of one entry of the SupportedModes list, but the device is not
+         * able to transition as requested, the ChangeToModeResponse command shall:
+         *
+         *   • Have the Status set to a product-specific Status value representing the error, or GenericFailure if a
+         *     more specific error cannot be provided. See Status Field for details.
+         *
+         *   • Provide a human readable string in the StatusText field.
+         *
+         * If the NewMode field matches the Mode field of one entry of the SupportedModes list and the device is able
+         * to transition as requested, the server shall transition into the mode associated with NewMode, the
+         * ChangeToModeResponse command shall have the Status field set to Success, the StatusText field may be
+         * supplied with a human readable string or include an empty string and the CurrentMode field shall be set to
+         * the value of the NewMode field.
+         *
+         * If the NewMode field is the same as the value of the CurrentMode attribute the ChangeToModeRe
+         *
+         * sponse command shall have the Status field set to Success and the StatusText field may be supplied with a
+         * human readable string or include an empty string.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.1.1
+         */
+        newMode: import("../tlv/TlvObject.js").FieldType<number>;
+    }>;
+    /**
+     * Input to the ModeBase changeToMode command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.1
+     */
+    interface ChangeToModeRequest extends TypeFromSchema<typeof TlvChangeToModeRequest> {
+    }
+    /**
+     * This command is sent by the device on receipt of the ChangeToMode command.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.2
+     */
+    const TlvChangeToModeResponse: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.2.1
+         */
+        status: import("../tlv/TlvObject.js").FieldType<Status>;
+        statusText: import("../tlv/TlvObject.js").FieldType<string>;
+    }>;
+    /**
+     * This command is sent by the device on receipt of the ChangeToMode command.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.2
+     */
+    interface ChangeToModeResponse extends TypeFromSchema<typeof TlvChangeToModeResponse> {
+    }
+    enum ModeChangeStatus {
+        /**
+         * 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
+    }
+    enum ModeTagEnum {
+        /**
+         * 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 ModeBaseCluster supports these elements if it supports feature OnOff.
+     */
+    const OnOffComponent: {
+        readonly attributes: {
+            /**
+             * Indicates whether the value of CurrentMode depends on the state of the On/Off cluster on the same
+             * endpoint. If this attribute is not present or is set to null, there is no dependency, otherwise the
+             * CurrentMode attribute shall depend on the OnOff attribute in the On/Off cluster
+             *
+             * The value of this field shall match the Mode field of one of the entries in the SupportedModes attribute.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.10.6.5
+             */
+            readonly onMode: WritableAttribute<number | null, any>;
+        };
+    };
+    /**
+     * ModeBase is a derived cluster, not to be used directly. These elements are present in all clusters derived from
+     * ModeBase.
+     */
+    const Base: {
+        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 name: "ModeBase";
+        readonly revision: 2;
+        readonly attributes: {
+            /**
+             * This attribute shall contain the list of supported modes that may be selected for the CurrentMode
+             * attribute. Each item in this list represents a unique mode as indicated by the Mode field of the
+             * ModeOptionStruct.
+             *
+             * Each entry in this list shall have a unique value for the Mode field. Each entry in this list shall have
+             * a unique value for the Label field.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.10.6.2
+             */
+            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<number>;
+                }>[]>;
+            }>[], any>;
+            /**
+             * Indicates the current mode of the server.
+             *
+             * The value of this field shall match the Mode field of one of the entries in the SupportedModes attribute.
+             *
+             * The value of this attribute may change at any time via an out-of-band interaction outside of the server,
+             * such as interactions with a user interface, via internal mode changes due to autonomously progressing
+             * through a sequence of operations, on system time-outs or idle delays, or via interactions coming from a
+             * fabric other than the one which last executed a ChangeToMode.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.10.6.3
+             */
+            readonly currentMode: Attribute<number, any>;
+            /**
+             * Indicates the desired startup mode for the server when it is supplied with power.
+             *
+             * If this attribute is not null, the CurrentMode attribute shall be set to the StartUpMode value, when the
+             * server is powered up, except in the case when the OnMode attribute overrides the StartUpMode attribute
+             * (see OnModeWithPowerUp).
+             *
+             * This behavior does not apply to reboots associated with OTA. After an OTA restart, the CurrentMode
+             * attribute shall return to its value prior to the restart.
+             *
+             * The value of this field shall match the Mode field of one of the entries in the SupportedModes attribute.
+             *
+             * If this attribute is not implemented, or is set to the null value, it shall have no effect.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.10.6.4
+             */
+            readonly startUpMode: OptionalWritableAttribute<number | null, 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<{
+                /**
+                 * If the NewMode field doesn’t match the Mode field of any entry of the SupportedModes list, the
+                 * ChangeToModeResponse command’s Status field shall indicate UnsupportedMode and the StatusText field shall be
+                 * included and may be used to indicate the issue, with a human readable string, or include an empty string.
+                 *
+                 * If the NewMode field matches the Mode field of one entry of the SupportedModes list, but the device is not
+                 * able to transition as requested, the ChangeToModeResponse command shall:
+                 *
+                 *   • Have the Status set to a product-specific Status value representing the error, or GenericFailure if a
+                 *     more specific error cannot be provided. See Status Field for details.
+                 *
+                 *   • Provide a human readable string in the StatusText field.
+                 *
+                 * If the NewMode field matches the Mode field of one entry of the SupportedModes list and the device is able
+                 * to transition as requested, the server shall transition into the mode associated with NewMode, the
+                 * ChangeToModeResponse command shall have the Status field set to Success, the StatusText field may be
+                 * supplied with a human readable string or include an empty string and the CurrentMode field shall be set to
+                 * the value of the NewMode field.
+                 *
+                 * If the NewMode field is the same as the value of the CurrentMode attribute the ChangeToModeRe
+                 *
+                 * sponse command shall have the Status field set to Success and the StatusText field may be supplied with a
+                 * human readable string or include an empty string.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.1.1
+                 */
+                newMode: import("../tlv/TlvObject.js").FieldType<number>;
+            }>, import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.2.1
+                 */
+                status: import("../tlv/TlvObject.js").FieldType<Status>;
+                statusText: import("../tlv/TlvObject.js").FieldType<string>;
+            }>, any>;
+        };
+        /**
+         * This metadata controls which ModeBaseCluster elements matter.js activates for specific feature combinations.
+         */
+        readonly extensions: readonly [{
+            readonly flags: {
+                readonly onOff: true;
+            };
+            readonly component: {
+                readonly attributes: {
+                    /**
+                     * Indicates whether the value of CurrentMode depends on the state of the On/Off cluster on the same
+                     * endpoint. If this attribute is not present or is set to null, there is no dependency, otherwise the
+                     * CurrentMode attribute shall depend on the OnOff attribute in the On/Off cluster
+                     *
+                     * The value of this field shall match the Mode field of one of the entries in the SupportedModes attribute.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 1.10.6.5
+                     */
+                    readonly onMode: WritableAttribute<number | null, any>;
+                };
+            };
+        }];
+    };
+    /**
+     * @see {@link Complete}
+     */
+    const CompleteInstance: {
+        readonly name: "ModeBase";
+        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: {
+            readonly onMode: WritableAttribute<number | null, any> & {
+                readonly optional: true;
+                readonly isConditional: true;
+                readonly optionalIf: [] | import("../cluster/Cluster.js").ConditionalFeatureList<import("../schema/BitmapSchema.js").BitSchema>;
+                readonly mandatoryIf: [] | [{
+                    onOff: boolean;
+                }];
+            };
+            /**
+             * This attribute shall contain the list of supported modes that may be selected for the CurrentMode
+             * attribute. Each item in this list represents a unique mode as indicated by the Mode field of the
+             * ModeOptionStruct.
+             *
+             * Each entry in this list shall have a unique value for the Mode field. Each entry in this list shall have
+             * a unique value for the Label field.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.10.6.2
+             */
+            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<number>;
+                }>[]>;
+            }>[], any>;
+            /**
+             * Indicates the current mode of the server.
+             *
+             * The value of this field shall match the Mode field of one of the entries in the SupportedModes attribute.
+             *
+             * The value of this attribute may change at any time via an out-of-band interaction outside of the server,
+             * such as interactions with a user interface, via internal mode changes due to autonomously progressing
+             * through a sequence of operations, on system time-outs or idle delays, or via interactions coming from a
+             * fabric other than the one which last executed a ChangeToMode.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.10.6.3
+             */
+            readonly currentMode: Attribute<number, any>;
+            /**
+             * Indicates the desired startup mode for the server when it is supplied with power.
+             *
+             * If this attribute is not null, the CurrentMode attribute shall be set to the StartUpMode value, when the
+             * server is powered up, except in the case when the OnMode attribute overrides the StartUpMode attribute
+             * (see OnModeWithPowerUp).
+             *
+             * This behavior does not apply to reboots associated with OTA. After an OTA restart, the CurrentMode
+             * attribute shall return to its value prior to the restart.
+             *
+             * The value of this field shall match the Mode field of one of the entries in the SupportedModes attribute.
+             *
+             * If this attribute is not implemented, or is set to the null value, it shall have no effect.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.10.6.4
+             */
+            readonly startUpMode: OptionalWritableAttribute<number | null, 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<{
+                /**
+                 * If the NewMode field doesn’t match the Mode field of any entry of the SupportedModes list, the
+                 * ChangeToModeResponse command’s Status field shall indicate UnsupportedMode and the StatusText field shall be
+                 * included and may be used to indicate the issue, with a human readable string, or include an empty string.
+                 *
+                 * If the NewMode field matches the Mode field of one entry of the SupportedModes list, but the device is not
+                 * able to transition as requested, the ChangeToModeResponse command shall:
+                 *
+                 *   • Have the Status set to a product-specific Status value representing the error, or GenericFailure if a
+                 *     more specific error cannot be provided. See Status Field for details.
+                 *
+                 *   • Provide a human readable string in the StatusText field.
+                 *
+                 * If the NewMode field matches the Mode field of one entry of the SupportedModes list and the device is able
+                 * to transition as requested, the server shall transition into the mode associated with NewMode, the
+                 * ChangeToModeResponse command shall have the Status field set to Success, the StatusText field may be
+                 * supplied with a human readable string or include an empty string and the CurrentMode field shall be set to
+                 * the value of the NewMode field.
+                 *
+                 * If the NewMode field is the same as the value of the CurrentMode attribute the ChangeToModeRe
+                 *
+                 * sponse command shall have the Status field set to Success and the StatusText field may be supplied with a
+                 * human readable string or include an empty string.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.1.1
+                 */
+                newMode: import("../tlv/TlvObject.js").FieldType<number>;
+            }>, import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.2.1
+                 */
+                status: import("../tlv/TlvObject.js").FieldType<Status>;
+                statusText: import("../tlv/TlvObject.js").FieldType<string>;
+            }>, any>;
+        };
+    };
+    /**
+     * This cluster supports all ModeBase features. It may support illegal feature combinations.
+     *
+     * If you use this cluster you must manually specify which features are active and ensure the set of active
+     * features is legal per the Matter specification.
+     */
+    interface Complete extends Identity<typeof CompleteInstance> {
+    }
+    const Complete: Complete;
+}
+//# sourceMappingURL=mode-base.d.ts.map