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

package/dist/cjs/clusters/mode-select.d.ts

@@ -0,0 +1,638 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/*** THIS FILE IS GENERATED, DO NOT EDIT ***/
+import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
+import { WritableAttribute, FixedAttribute, Attribute, OptionalWritableAttribute, Command } from "../cluster/Cluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
+import { Identity } from "#general";
+export declare namespace ModeSelect {
+    /**
+     * These are optional features supported by ModeSelectCluster.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.9.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.9.4.1
+         */
+        OnOff = "OnOff"
+    }
+    /**
+     * A Semantic Tag is meant to be interpreted by the client for the purpose the cluster serves.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.1
+     */
+    const TlvSemanticTag: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This field shall indicate a manufacturer code (Vendor ID), and the Value field shall indicate a semantic tag
+         * defined by the manufacturer. Each manufacturer code supports a single namespace of values. The same
+         * manufacturer code and semantic tag value in separate cluster instances are part of the same namespace and
+         * have the same meaning. For example: a manufacturer tag meaning "pinch", has the same meaning in a cluster
+         * whose purpose is to choose the amount of sugar, or amount of salt.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.1.2
+         */
+        mfgCode: import("../tlv/TlvObject.js").FieldType<import("../datatype/VendorId.js").VendorId>;
+        /**
+         * This field shall indicate the semantic tag within a semantic tag namespace which is either manufacturer
+         * specific or standard. For semantic tags in a standard namespace, see Standard Namespace.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.1.1
+         */
+        value: import("../tlv/TlvObject.js").FieldType<number>;
+    }>;
+    /**
+     * A Semantic Tag is meant to be interpreted by the client for the purpose the cluster serves.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.1
+     */
+    interface SemanticTag extends TypeFromSchema<typeof TlvSemanticTag> {
+    }
+    /**
+     * This is a struct representing a possible mode of the server.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.2
+     */
+    const TlvModeOption: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This field is readable text that describes the mode option that can be used by a client to indicate to the
+         * user what this option means. This field is meant to be readable and understandable by the user.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.2.1
+         */
+        label: import("../tlv/TlvObject.js").FieldType<string>;
+        /**
+         * The Mode field is used to identify the mode option. The value shall be unique for every item in the
+         * SupportedModes attribute.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.2.2
+         */
+        mode: import("../tlv/TlvObject.js").FieldType<number>;
+        /**
+         * This field is a list of semantic tags that map to the mode option. This may be used by clients to determine
+         * the meaning of the mode option as defined in a standard or manufacturer specific namespace. Semantic tags
+         * can help clients look for options that meet certain criteria. A semantic tag shall be either a standard tag
+         * or manufacturer specific tag as defined in each SemanticTagStruct list entry.
+         *
+         * A mode option may have more than one semantic tag. A mode option may be mapped to a mixture of standard and
+         * manufacturer specific semantic tags.
+         *
+         * All standard semantic tags are from a single namespace indicated by the StandardNamespace attribute.
+         *
+         * For example: A mode labeled "100%" can have both the HIGH (MS) and MAX (standard) semantic tag. Clients
+         * seeking the option for either HIGH or MAX will find the same option in this case.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.2.3
+         */
+        semanticTags: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+            /**
+             * This field shall indicate a manufacturer code (Vendor ID), and the Value field shall indicate a semantic tag
+             * defined by the manufacturer. Each manufacturer code supports a single namespace of values. The same
+             * manufacturer code and semantic tag value in separate cluster instances are part of the same namespace and
+             * have the same meaning. For example: a manufacturer tag meaning "pinch", has the same meaning in a cluster
+             * whose purpose is to choose the amount of sugar, or amount of salt.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.1.2
+             */
+            mfgCode: import("../tlv/TlvObject.js").FieldType<import("../datatype/VendorId.js").VendorId>;
+            /**
+             * This field shall indicate the semantic tag within a semantic tag namespace which is either manufacturer
+             * specific or standard. For semantic tags in a standard namespace, see Standard Namespace.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.1.1
+             */
+            value: import("../tlv/TlvObject.js").FieldType<number>;
+        }>[]>;
+    }>;
+    /**
+     * This is a struct representing a possible mode of the server.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.2
+     */
+    interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {
+    }
+    /**
+     * Input to the ModeSelect changeToMode command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.9.7.1
+     */
+    const TlvChangeToModeRequest: import("../tlv/TlvObject.js").ObjectSchema<{
+        newMode: import("../tlv/TlvObject.js").FieldType<number>;
+    }>;
+    /**
+     * Input to the ModeSelect changeToMode command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.9.7.1
+     */
+    interface ChangeToModeRequest extends TypeFromSchema<typeof TlvChangeToModeRequest> {
+    }
+    /**
+     * A ModeSelectCluster supports these elements if it supports feature OnOff.
+     */
+    const OnOffComponent: {
+        readonly attributes: {
+            /**
+             * Indicates the value of CurrentMode that depends on the state of the On/Off cluster on the same endpoint.
+             * If this attribute is not present or is set to null, it shall NOT have an effect, otherwise the
+             * CurrentMode attribute shall depend on the OnOff attribute of 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.9.6.7
+             */
+            readonly onMode: WritableAttribute<number | null, any>;
+        };
+    };
+    /**
+     * These elements and properties are present in all ModeSelect clusters.
+     */
+    const Base: {
+        readonly id: 80;
+        readonly name: "ModeSelect";
+        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.9.4.1
+             */
+            readonly onOff: BitFlag;
+        };
+        readonly attributes: {
+            /**
+             * This attribute describes the purpose of the server, in readable text.
+             *
+             * For example, a coffee machine may have a Mode Select cluster for the amount of milk to add, and another
+             * Mode Select cluster for the amount of sugar to add. In this case, the first instance can have the
+             * description Milk and the second instance can have the description Sugar. This allows the user to tell
+             * the purpose of each of the instances.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.9.6.2
+             */
+            readonly description: FixedAttribute<string, any>;
+            /**
+             * This attribute, when not null, shall indicate a single standard namespace for any standard semantic tag
+             * value supported in this or any other cluster instance with the same value of this attribute. A
+             *
+             * null value indicates no standard namespace, and therefore, no standard semantic tags are provided in
+             * this cluster instance. Each standard namespace and corresponding values and value meanings shall be
+             * defined in another document.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.9.6.3
+             */
+            readonly standardNamespace: FixedAttribute<number | null, any>;
+            /**
+             * This attribute is 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.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.9.6.4
+             */
+            readonly supportedModes: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field is readable text that describes the mode option that can be used by a client to indicate to the
+                 * user what this option means. This field is meant to be readable and understandable by the user.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.2.1
+                 */
+                label: import("../tlv/TlvObject.js").FieldType<string>;
+                /**
+                 * The Mode field is used to identify the mode option. The value shall be unique for every item in the
+                 * SupportedModes attribute.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.2.2
+                 */
+                mode: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field is a list of semantic tags that map to the mode option. This may be used by clients to determine
+                 * the meaning of the mode option as defined in a standard or manufacturer specific namespace. Semantic tags
+                 * can help clients look for options that meet certain criteria. A semantic tag shall be either a standard tag
+                 * or manufacturer specific tag as defined in each SemanticTagStruct list entry.
+                 *
+                 * A mode option may have more than one semantic tag. A mode option may be mapped to a mixture of standard and
+                 * manufacturer specific semantic tags.
+                 *
+                 * All standard semantic tags are from a single namespace indicated by the StandardNamespace attribute.
+                 *
+                 * For example: A mode labeled "100%" can have both the HIGH (MS) and MAX (standard) semantic tag. Clients
+                 * seeking the option for either HIGH or MAX will find the same option in this case.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.2.3
+                 */
+                semanticTags: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+                    /**
+                     * This field shall indicate a manufacturer code (Vendor ID), and the Value field shall indicate a semantic tag
+                     * defined by the manufacturer. Each manufacturer code supports a single namespace of values. The same
+                     * manufacturer code and semantic tag value in separate cluster instances are part of the same namespace and
+                     * have the same meaning. For example: a manufacturer tag meaning "pinch", has the same meaning in a cluster
+                     * whose purpose is to choose the amount of sugar, or amount of salt.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.1.2
+                     */
+                    mfgCode: import("../tlv/TlvObject.js").FieldType<import("../datatype/VendorId.js").VendorId>;
+                    /**
+                     * This field shall indicate the semantic tag within a semantic tag namespace which is either manufacturer
+                     * specific or standard. For semantic tags in a standard namespace, see Standard Namespace.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.1.1
+                     */
+                    value: import("../tlv/TlvObject.js").FieldType<number>;
+                }>[]>;
+            }>[], any>;
+            /**
+             * This attribute represents the current mode of the server.
+             *
+             * The value of this field must match the Mode field of one of the entries in the SupportedModes
+             *
+             * attribute.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.9.6.5
+             */
+            readonly currentMode: Attribute<number, any>;
+            /**
+             * The StartUpMode attribute value 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.9.6.6
+             */
+            readonly startUpMode: OptionalWritableAttribute<number | null, any>;
+        };
+        readonly commands: {
+            /**
+             * On receipt of this command, if the NewMode field indicates a valid mode transition within the supported
+             * list, the server shall set the CurrentMode attribute to the NewMode value, otherwise, the server shall
+             * respond with an INVALID_COMMAND status response.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.9.7.1
+             */
+            readonly changeToMode: Command<import("../tlv/TlvObject.js").TypeFromFields<{
+                newMode: import("../tlv/TlvObject.js").FieldType<number>;
+            }>, void, any>;
+        };
+        /**
+         * This metadata controls which ModeSelectCluster elements matter.js activates for specific feature
+         * combinations.
+         */
+        readonly extensions: readonly [{
+            readonly flags: {
+                readonly onOff: true;
+            };
+            readonly component: {
+                readonly attributes: {
+                    /**
+                     * Indicates the value of CurrentMode that depends on the state of the On/Off cluster on the same endpoint.
+                     * If this attribute is not present or is set to null, it shall NOT have an effect, otherwise the
+                     * CurrentMode attribute shall depend on the OnOff attribute of 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.9.6.7
+                     */
+                    readonly onMode: WritableAttribute<number | null, any>;
+                };
+            };
+        }];
+    };
+    /**
+     * @see {@link Cluster}
+     */
+    const ClusterInstance: MutableCluster<{
+        readonly id: 80;
+        readonly name: "ModeSelect";
+        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.9.4.1
+             */
+            readonly onOff: BitFlag;
+        };
+        readonly attributes: {
+            /**
+             * This attribute describes the purpose of the server, in readable text.
+             *
+             * For example, a coffee machine may have a Mode Select cluster for the amount of milk to add, and another
+             * Mode Select cluster for the amount of sugar to add. In this case, the first instance can have the
+             * description Milk and the second instance can have the description Sugar. This allows the user to tell
+             * the purpose of each of the instances.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.9.6.2
+             */
+            readonly description: FixedAttribute<string, any>;
+            /**
+             * This attribute, when not null, shall indicate a single standard namespace for any standard semantic tag
+             * value supported in this or any other cluster instance with the same value of this attribute. A
+             *
+             * null value indicates no standard namespace, and therefore, no standard semantic tags are provided in
+             * this cluster instance. Each standard namespace and corresponding values and value meanings shall be
+             * defined in another document.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.9.6.3
+             */
+            readonly standardNamespace: FixedAttribute<number | null, any>;
+            /**
+             * This attribute is 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.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.9.6.4
+             */
+            readonly supportedModes: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field is readable text that describes the mode option that can be used by a client to indicate to the
+                 * user what this option means. This field is meant to be readable and understandable by the user.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.2.1
+                 */
+                label: import("../tlv/TlvObject.js").FieldType<string>;
+                /**
+                 * The Mode field is used to identify the mode option. The value shall be unique for every item in the
+                 * SupportedModes attribute.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.2.2
+                 */
+                mode: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field is a list of semantic tags that map to the mode option. This may be used by clients to determine
+                 * the meaning of the mode option as defined in a standard or manufacturer specific namespace. Semantic tags
+                 * can help clients look for options that meet certain criteria. A semantic tag shall be either a standard tag
+                 * or manufacturer specific tag as defined in each SemanticTagStruct list entry.
+                 *
+                 * A mode option may have more than one semantic tag. A mode option may be mapped to a mixture of standard and
+                 * manufacturer specific semantic tags.
+                 *
+                 * All standard semantic tags are from a single namespace indicated by the StandardNamespace attribute.
+                 *
+                 * For example: A mode labeled "100%" can have both the HIGH (MS) and MAX (standard) semantic tag. Clients
+                 * seeking the option for either HIGH or MAX will find the same option in this case.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.2.3
+                 */
+                semanticTags: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+                    /**
+                     * This field shall indicate a manufacturer code (Vendor ID), and the Value field shall indicate a semantic tag
+                     * defined by the manufacturer. Each manufacturer code supports a single namespace of values. The same
+                     * manufacturer code and semantic tag value in separate cluster instances are part of the same namespace and
+                     * have the same meaning. For example: a manufacturer tag meaning "pinch", has the same meaning in a cluster
+                     * whose purpose is to choose the amount of sugar, or amount of salt.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.1.2
+                     */
+                    mfgCode: import("../tlv/TlvObject.js").FieldType<import("../datatype/VendorId.js").VendorId>;
+                    /**
+                     * This field shall indicate the semantic tag within a semantic tag namespace which is either manufacturer
+                     * specific or standard. For semantic tags in a standard namespace, see Standard Namespace.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.1.1
+                     */
+                    value: import("../tlv/TlvObject.js").FieldType<number>;
+                }>[]>;
+            }>[], any>;
+            /**
+             * This attribute represents the current mode of the server.
+             *
+             * The value of this field must match the Mode field of one of the entries in the SupportedModes
+             *
+             * attribute.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.9.6.5
+             */
+            readonly currentMode: Attribute<number, any>;
+            /**
+             * The StartUpMode attribute value 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.9.6.6
+             */
+            readonly startUpMode: OptionalWritableAttribute<number | null, any>;
+        };
+        readonly commands: {
+            /**
+             * On receipt of this command, if the NewMode field indicates a valid mode transition within the supported
+             * list, the server shall set the CurrentMode attribute to the NewMode value, otherwise, the server shall
+             * respond with an INVALID_COMMAND status response.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.9.7.1
+             */
+            readonly changeToMode: Command<import("../tlv/TlvObject.js").TypeFromFields<{
+                newMode: import("../tlv/TlvObject.js").FieldType<number>;
+            }>, void, any>;
+        };
+        /**
+         * This metadata controls which ModeSelectCluster elements matter.js activates for specific feature
+         * combinations.
+         */
+        readonly extensions: readonly [{
+            readonly flags: {
+                readonly onOff: true;
+            };
+            readonly component: {
+                readonly attributes: {
+                    /**
+                     * Indicates the value of CurrentMode that depends on the state of the On/Off cluster on the same endpoint.
+                     * If this attribute is not present or is set to null, it shall NOT have an effect, otherwise the
+                     * CurrentMode attribute shall depend on the OnOff attribute of 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.9.6.7
+                     */
+                    readonly onMode: WritableAttribute<number | null, any>;
+                };
+            };
+        }];
+    }, []>;
+    /**
+     * This cluster provides an interface for controlling a characteristic of a device that can be set to one of
+     * several predefined values. For example, the light pattern of a disco ball, the mode of a massage chair, or the
+     * wash cycle of a laundry machine.
+     *
+     * The server allows the client to set a mode on the server. A mode is one of a list of options that may be
+     * presented by a client for a user choice, or understood by the client, via the semantic tags on the mode.
+     *
+     * A semantic tag is either a standard tag within a standard category namespace, or a manufacturer specific tag,
+     * within the namespace of the vendor ID of the manufacturer. If there is no semantic tag, the mode is anonymous,
+     * and the selection is made by the user solely based on the Label string.
+     *
+     * Each cluster ID that indicates this specification shall define a distinct purpose for the cluster instance. For
+     * example: A LightBlinking cluster ID supports blinking modes for a light (and is described that way).
+     *
+     * An anonymous mode shall support the derived cluster purpose. A manufacturer specific semantic tag shall support
+     * the derived cluster purpose. An anonymous mode shall NOT replace the meaning of a standard semantic tag, when
+     * one exists, for the cluster purpose.
+     *
+     * ModeSelectCluster supports optional features that you can enable with the ModeSelectCluster.with() factory
+     * method.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.9
+     */
+    interface Cluster extends Identity<typeof ClusterInstance> {
+    }
+    const Cluster: Cluster;
+    /**
+     * @see {@link Complete}
+     */
+    const CompleteInstance: MutableCluster<{
+        readonly id: import("#general").Branded<80, "ClusterId">;
+        readonly name: "ModeSelect";
+        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.9.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;
+                }];
+            };
+            readonly description: FixedAttribute<string, any>;
+            readonly standardNamespace: FixedAttribute<number | null, any>;
+            readonly supportedModes: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field is readable text that describes the mode option that can be used by a client to indicate to the
+                 * user what this option means. This field is meant to be readable and understandable by the user.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.2.1
+                 */
+                label: import("../tlv/TlvObject.js").FieldType<string>;
+                /**
+                 * The Mode field is used to identify the mode option. The value shall be unique for every item in the
+                 * SupportedModes attribute.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.2.2
+                 */
+                mode: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field is a list of semantic tags that map to the mode option. This may be used by clients to determine
+                 * the meaning of the mode option as defined in a standard or manufacturer specific namespace. Semantic tags
+                 * can help clients look for options that meet certain criteria. A semantic tag shall be either a standard tag
+                 * or manufacturer specific tag as defined in each SemanticTagStruct list entry.
+                 *
+                 * A mode option may have more than one semantic tag. A mode option may be mapped to a mixture of standard and
+                 * manufacturer specific semantic tags.
+                 *
+                 * All standard semantic tags are from a single namespace indicated by the StandardNamespace attribute.
+                 *
+                 * For example: A mode labeled "100%" can have both the HIGH (MS) and MAX (standard) semantic tag. Clients
+                 * seeking the option for either HIGH or MAX will find the same option in this case.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.2.3
+                 */
+                semanticTags: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+                    /**
+                     * This field shall indicate a manufacturer code (Vendor ID), and the Value field shall indicate a semantic tag
+                     * defined by the manufacturer. Each manufacturer code supports a single namespace of values. The same
+                     * manufacturer code and semantic tag value in separate cluster instances are part of the same namespace and
+                     * have the same meaning. For example: a manufacturer tag meaning "pinch", has the same meaning in a cluster
+                     * whose purpose is to choose the amount of sugar, or amount of salt.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.1.2
+                     */
+                    mfgCode: import("../tlv/TlvObject.js").FieldType<import("../datatype/VendorId.js").VendorId>;
+                    /**
+                     * This field shall indicate the semantic tag within a semantic tag namespace which is either manufacturer
+                     * specific or standard. For semantic tags in a standard namespace, see Standard Namespace.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 1.9.5.1.1
+                     */
+                    value: import("../tlv/TlvObject.js").FieldType<number>;
+                }>[]>;
+            }>[], any>;
+            readonly currentMode: Attribute<number, any>;
+            readonly startUpMode: OptionalWritableAttribute<number | null, any>;
+            readonly clusterRevision: Attribute<number, never>;
+            readonly featureMap: Attribute<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
+                /**
+                 * 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.9.4.1
+                 */
+                readonly onOff: BitFlag;
+            }>, never>;
+            readonly attributeList: Attribute<import("../index.js").AttributeId[], never>;
+            readonly eventList: Attribute<import("../index.js").EventId[], never>;
+            readonly acceptedCommandList: Attribute<import("../index.js").CommandId[], never>;
+            readonly generatedCommandList: Attribute<import("../index.js").CommandId[], never>;
+        };
+        readonly commands: {
+            /**
+             * On receipt of this command, if the NewMode field indicates a valid mode transition within the supported
+             * list, the server shall set the CurrentMode attribute to the NewMode value, otherwise, the server shall
+             * respond with an INVALID_COMMAND status response.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.9.7.1
+             */
+            readonly changeToMode: Command<import("../tlv/TlvObject.js").TypeFromFields<{
+                newMode: import("../tlv/TlvObject.js").FieldType<number>;
+            }>, void, any>;
+        };
+    }, []>;
+    /**
+     * This cluster supports all ModeSelect 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;
+}
+export type ModeSelectCluster = ModeSelect.Cluster;
+export declare const ModeSelectCluster: ModeSelect.Cluster;
+//# sourceMappingURL=mode-select.d.ts.map

package/dist/cjs/clusters/mode-select.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mode-select.d.ts","sourceRoot":"","sources":["../../../src/clusters/mode-select.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EACH,iBAAiB,EACjB,cAAc,EACd,SAAS,EACT,yBAAyB,EACzB,OAAO,EAEV,MAAM,uBAAuB,CAAC;AAG/B,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAKpD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,UAAU,CAAC;IACxB;;;;OAIG;IACH,KAAY,OAAO;QACf;;;;;;;WAOG;QACH,KAAK,UAAU;KAClB;IAED;;;;OAIG;IACI,MAAM,cAAc;QACvB;;;;;;;;WAQG;;QAGH;;;;;WAKG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,WAAY,SAAQ,cAAc,CAAC,OAAO,cAAc,CAAC;KAAG;IAE7E;;;;OAIG;IACI,MAAM,aAAa;QACtB;;;;;WAKG;;QAGH;;;;;WAKG;;QAGH;;;;;;;;;;;;;;;WAeG;;YAhEH;;;;;;;;eAQG;;YAGH;;;;;eAKG;;;MAkDL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,UAAW,SAAQ,cAAc,CAAC,OAAO,aAAa,CAAC;KAAG;IAE3E;;;;OAIG;IACI,MAAM,sBAAsB;;MAAgD,CAAC;IAEpF;;;;OAIG;IACH,UAAiB,mBAAoB,SAAQ,cAAc,CAAC,OAAO,sBAAsB,CAAC;KAAG;IAE7F;;OAEG;IACI,MAAM,cAAc;;YAEnB;;;;;;;;eAQG;;;KAGT,CAAC;IAEH;;OAEG;IACI,MAAM,IAAI;;;;;YAMT;;;;;;;eAOG;;;;YAKH;;;;;;;;;eASG;;YAGH;;;;;;;;;eASG;;YAGH;;;;;;eAMG;;gBA7HP;;;;;mBAKG;;gBAGH;;;;;mBAKG;;gBAGH;;;;;;;;;;;;;;;mBAeG;;oBAhEH;;;;;;;;uBAQG;;oBAGH;;;;;uBAKG;;;;YAiJC;;;;;;;;eAQG;;YAGH;;;;;;;;;;;;;;;;;;eAkBG;;;;YAKH;;;;;;eAMG;;;;;QAIP;;;WAGG;;;;;;;oBAlHC;;;;;;;;uBAQG;;;;;KA4GT,CAAC;IAEH;;OAEG;IACI,MAAM,eAAe;;;;;YAnGpB;;;;;;;eAOG;;;;YAKH;;;;;;;;;eASG;;YAGH;;;;;;;;;eASG;;YAGH;;;;;;eAMG;;gBA7HP;;;;;mBAKG;;gBAGH;;;;;mBAKG;;gBAGH;;;;;;;;;;;;;;;mBAeG;;oBAhEH;;;;;;;;uBAQG;;oBAGH;;;;;uBAKG;;;;YAiJC;;;;;;;;eAQG;;YAGH;;;;;;;;;;;;;;;;;;eAkBG;;;;YAKH;;;;;;eAMG;;;;;QAIP;;;WAGG;;;;;;;oBAlHC;;;;;;;;uBAQG;;;;;UAiHwC,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAiB,OAAQ,SAAQ,QAAQ,CAAC,OAAO,eAAe,CAAC;KAAG;IAE7D,MAAM,OAAO,EAAE,OAAyB,CAAC;IAGhD;;OAEG;IACI,MAAM,gBAAgB;;;;;YArIrB;;;;;;;eAOG;;;;;;;;;;;;;;;gBA1FP;;;;;mBAKG;;gBAGH;;;;;mBAKG;;gBAGH;;;;;;;;;;;;;;;mBAeG;;oBAhEH;;;;;;;;uBAQG;;oBAGH;;;;;uBAKG;;;;;;;;gBAoGC;;;;;;;mBAOG;;;;;;;;;YAwEH;;;;;;eAMG;;;;;UA0DT,CAAC;IAEH;;;;;OAKG;IACH,UAAiB,QAAS,SAAQ,QAAQ,CAAC,OAAO,gBAAgB,CAAC;KAAG;IAE/D,MAAM,QAAQ,EAAE,QAA2B,CAAC;CACtD;AAED,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,CAAC;AACnD,eAAO,MAAM,iBAAiB,oBAAqB,CAAC"}