@matter/types 0.12.6-alpha.0-20250304-03716637c → 0.13.0-alpha.0-20250307-ebf84a05a

package/dist/esm/clusters/water-heater-mode.d.ts

@@ -0,0 +1,491 @@
+/**
+ * @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 { ModeBase } from "./mode-base.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
+import { Identity } from "#general";
+export declare namespace WaterHeaterMode {
+    /**
+     * These are optional features supported by WaterHeaterModeCluster.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 9.6.4
+     */
+    enum Feature {
+        /**
+         * OnOff (DEPONOFF)
+         *
+         * Dependency with the OnOff cluster
+         */
+        OnOff = "OnOff"
+    }
+    enum ModeTag {
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Auto = 0,
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Quick = 1,
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Quiet = 2,
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        LowNoise = 3,
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        LowEnergy = 4,
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Vacation = 5,
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Min = 6,
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Max = 7,
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Night = 8,
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Day = 9,
+        /**
+         * While in modes with this tag, the device will not attempt to keep the water warm.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1.1
+         */
+        Off = 16384,
+        /**
+         * While in modes with this tag, the device will attempt to keep the water warm based on the
+         * OccupiedHeatingSetpoint attribute of the associated Thermostat cluster.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1.2
+         */
+        Manual = 16385,
+        /**
+         * While in modes with this tag, the device will attempt to keep the water warm based on the Schedules
+         * attribute of the associated Thermostat cluster.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1.3
+         */
+        Timed = 16386
+    }
+    /**
+     * 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<ModeBase.ModeTag | 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.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 9.6.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<ModeBase.ModeTag | 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.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 9.6.5.1
+     */
+    interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {
+    }
+    /**
+     * These elements and properties are present in all WaterHeaterMode clusters.
+     */
+    const Base: {
+        readonly id: 158;
+        readonly name: "WaterHeaterMode";
+        readonly revision: 1;
+        readonly features: {
+            /**
+             * OnOff
+             *
+             * Dependency with the OnOff cluster
+             */
+            readonly onOff: BitFlag;
+        };
+        readonly attributes: {
+            /**
+             * At least one entry in the SupportedModes attribute shall include the Manual mode tag in the ModeTags
+             * field list.
+             *
+             * At least one entry in the SupportedModes attribute shall include the Off mode tag in the ModeTags field
+             * list.
+             *
+             * An entry in the SupportedModes attribute that includes one of an Off, Manual, or Timed tag shall NOT
+             * also include an additional instance of any one of these tag types.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 9.6.6.1
+             */
+            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<ModeBase.ModeTag | ModeTag>;
+                }>[]>;
+            }>[], any>;
+            /**
+             * @see {@link MatterSpecification.v13.Cluster} § 9.6.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 WaterHeaterModeCluster elements matter.js activates for specific feature
+         * combinations.
+         */
+        readonly extensions: readonly [{
+            readonly flags: {
+                readonly onOff: true;
+            };
+            readonly component: false;
+        }];
+    };
+    /**
+     * @see {@link Cluster}
+     */
+    const ClusterInstance: MutableCluster<{
+        readonly id: 158;
+        readonly name: "WaterHeaterMode";
+        readonly revision: 1;
+        readonly features: {
+            /**
+             * OnOff
+             *
+             * Dependency with the OnOff cluster
+             */
+            readonly onOff: BitFlag;
+        };
+        readonly attributes: {
+            /**
+             * At least one entry in the SupportedModes attribute shall include the Manual mode tag in the ModeTags
+             * field list.
+             *
+             * At least one entry in the SupportedModes attribute shall include the Off mode tag in the ModeTags field
+             * list.
+             *
+             * An entry in the SupportedModes attribute that includes one of an Off, Manual, or Timed tag shall NOT
+             * also include an additional instance of any one of these tag types.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 9.6.6.1
+             */
+            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<ModeBase.ModeTag | ModeTag>;
+                }>[]>;
+            }>[], any>;
+            /**
+             * @see {@link MatterSpecification.v13.Cluster} § 9.6.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 WaterHeaterModeCluster elements matter.js activates for specific feature
+         * combinations.
+         */
+        readonly extensions: readonly [{
+            readonly flags: {
+                readonly onOff: true;
+            };
+            readonly component: false;
+        }];
+    }, []>;
+    /**
+     * This cluster is derived from the Mode Base cluster and defines additional mode tags and namespaced enumerated
+     * values for water heater devices.
+     *
+     * WaterHeaterModeCluster supports optional features that you can enable with the WaterHeaterModeCluster.with()
+     * factory method.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 9.6
+     */
+    interface Cluster extends Identity<typeof ClusterInstance> {
+    }
+    const Cluster: Cluster;
+    const Complete: Cluster;
+}
+export type WaterHeaterModeCluster = WaterHeaterMode.Cluster;
+export declare const WaterHeaterModeCluster: WaterHeaterMode.Cluster;
+//# sourceMappingURL=water-heater-mode.d.ts.map

package/dist/esm/clusters/water-heater-mode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"water-heater-mode.d.ts","sourceRoot":"","sources":["../../../src/clusters/water-heater-mode.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,EAAiB,MAAM,uBAAuB,CAAC;AAM1F,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,eAAe,CAAC;IAC7B;;;;OAIG;IACH,KAAY,OAAO;QACf;;;;WAIG;QACH,KAAK,UAAU;KAClB;IAED,KAAY,OAAO;QACf;;WAEG;QACH,IAAI,IAAI;QAER;;WAEG;QACH,KAAK,IAAI;QAET;;WAEG;QACH,KAAK,IAAI;QAET;;WAEG;QACH,QAAQ,IAAI;QAEZ;;WAEG;QACH,SAAS,IAAI;QAEb;;WAEG;QACH,QAAQ,IAAI;QAEZ;;WAEG;QACH,GAAG,IAAI;QAEP;;WAEG;QACH,GAAG,IAAI;QAEP;;WAEG;QACH,KAAK,IAAI;QAET;;WAEG;QACH,GAAG,IAAI;QAEP;;;;WAIG;QACH,GAAG,QAAQ;QAEX;;;;;WAKG;QACH,MAAM,QAAQ;QAEd;;;;;WAKG;QACH,KAAK,QAAQ;KAChB;IAED;;;;OAIG;IACI,MAAM,gBAAgB;QACzB;;;;;;;;;;;;WAYG;;QAGH;;;;;WAKG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,aAAc,SAAQ,cAAc,CAAC,OAAO,gBAAgB,CAAC;KAAG;IAEjF;;;;;OAKG;IACI,MAAM,aAAa;QACtB;;;;;;WAMG;;QAGH;;;;WAIG;;QAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmCG;;YAzFH;;;;;;;;;;;;eAYG;;YAGH;;;;;eAKG;;;MAuEL,CAAC;IAEH;;;;;OAKG;IACH,UAAiB,UAAW,SAAQ,cAAc,CAAC,OAAO,aAAa,CAAC;KAAG;IAE3E;;OAEG;IACI,MAAM,IAAI;;;;;YAMT;;;;eAIG;;;;YAKH;;;;;;;;;;;eAWG;;gBA5FP;;;;;;mBAMG;;gBAGH;;;;mBAIG;;gBAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAmCG;;oBAzFH;;;;;;;;;;;;uBAYG;;oBAGH;;;;;uBAKG;;;;YAqHC;;eAEG;;;;YAKH;;;;;;eAMG;;;;;QAIP;;;WAGG;;;;;;;KAEL,CAAC;IAEH;;OAEG;IACI,MAAM,eAAe;;;;;YAtDpB;;;;eAIG;;;;YAKH;;;;;;;;;;;eAWG;;gBA5FP;;;;;;mBAMG;;gBAGH;;;;mBAIG;;gBAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAmCG;;oBAzFH;;;;;;;;;;;;uBAYG;;oBAGH;;;;;uBAKG;;;;YAqHC;;eAEG;;;;YAKH;;;;;;eAMG;;;;;QAIP;;;WAGG;;;;;;;UAO4C,CAAC;IAEpD;;;;;;;;OAQG;IACH,UAAiB,OAAQ,SAAQ,QAAQ,CAAC,OAAO,eAAe,CAAC;KAAG;IAE7D,MAAM,OAAO,EAAE,OAAyB,CAAC;IACzC,MAAM,QAAQ,SAAU,CAAC;CACnC;AAED,MAAM,MAAM,sBAAsB,GAAG,eAAe,CAAC,OAAO,CAAC;AAC7D,eAAO,MAAM,sBAAsB,yBAA0B,CAAC"}

package/dist/esm/clusters/water-heater-mode.js

@@ -0,0 +1,175 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { FixedAttribute, Attribute, Command, TlvNoResponse } from "../cluster/Cluster.js";
+import { TlvArray } from "../tlv/TlvArray.js";
+import { TlvField, TlvOptionalField, TlvObject } from "../tlv/TlvObject.js";
+import { TlvString } from "../tlv/TlvString.js";
+import { TlvUInt8, TlvEnum } from "../tlv/TlvNumber.js";
+import { TlvVendorId } from "../datatype/VendorId.js";
+import { ModeBase } from "./mode-base.js";
+import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
+var WaterHeaterMode;
+((WaterHeaterMode2) => {
+  let Feature;
+  ((Feature2) => {
+    Feature2["OnOff"] = "OnOff";
+  })(Feature = WaterHeaterMode2.Feature || (WaterHeaterMode2.Feature = {}));
+  let ModeTag;
+  ((ModeTag2) => {
+    ModeTag2[ModeTag2["Auto"] = 0] = "Auto";
+    ModeTag2[ModeTag2["Quick"] = 1] = "Quick";
+    ModeTag2[ModeTag2["Quiet"] = 2] = "Quiet";
+    ModeTag2[ModeTag2["LowNoise"] = 3] = "LowNoise";
+    ModeTag2[ModeTag2["LowEnergy"] = 4] = "LowEnergy";
+    ModeTag2[ModeTag2["Vacation"] = 5] = "Vacation";
+    ModeTag2[ModeTag2["Min"] = 6] = "Min";
+    ModeTag2[ModeTag2["Max"] = 7] = "Max";
+    ModeTag2[ModeTag2["Night"] = 8] = "Night";
+    ModeTag2[ModeTag2["Day"] = 9] = "Day";
+    ModeTag2[ModeTag2["Off"] = 16384] = "Off";
+    ModeTag2[ModeTag2["Manual"] = 16385] = "Manual";
+    ModeTag2[ModeTag2["Timed"] = 16386] = "Timed";
+  })(ModeTag = WaterHeaterMode2.ModeTag || (WaterHeaterMode2.ModeTag = {}));
+  WaterHeaterMode2.TlvModeTagStruct = TlvObject({
+    /**
+     * If the MfgCode field exists, the Value field shall be in the manufacturer-specific value range (see Section
+     * 1.10.8, “Mode Namespace”).
+     *
+     * This field shall indicate the manufacturer’s VendorID and it shall determine the meaning of the Value field.
+     *
+     * The same manufacturer code and mode tag value in separate cluster instances are part of the same namespace
+     * and have the same meaning. For example: a manufacturer tag meaning "pinch" can be used both in a cluster
+     * whose purpose is to choose the amount of sugar, or in a cluster whose purpose is to choose the amount of
+     * salt.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.1.1
+     */
+    mfgCode: TlvOptionalField(0, TlvVendorId),
+    /**
+     * This field shall indicate the mode tag within a mode tag namespace which is either manufacturer specific or
+     * standard.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.1.2
+     */
+    value: TlvField(1, TlvEnum())
+  });
+  WaterHeaterMode2.TlvModeOption = TlvObject({
+    /**
+     * This field shall indicate readable text that describes the mode option, so that a client can provide it to
+     * the user to indicate what this option means. This field is meant to be readable and understandable by the
+     * user.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2.1
+     */
+    label: TlvField(0, TlvString.bound({ maxLength: 64 })),
+    /**
+     * This field is used to identify the mode option.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2.2
+     */
+    mode: TlvField(1, TlvUInt8),
+    /**
+     * This field shall contain a list of tags that are associated with the mode option. This may be used by
+     * clients to determine the full or the partial semantics of a certain mode, depending on which tags they
+     * understand, using standard definitions and/or manufacturer specific namespace definitions.
+     *
+     * The standard mode tags are defined in this cluster specification. For the derived cluster instances, if the
+     * specification of the derived cluster defines a namespace, the set of standard mode tags also includes the
+     * mode tag values from that namespace.
+     *
+     * Mode tags can help clients look for options that meet certain criteria, render the user interface, use
+     *
+     * the mode in an automation, or to craft help text their voice-driven interfaces. A mode tag shall be either a
+     * standard tag or a manufacturer specific tag, as defined in each ModeTagStruct list entry.
+     *
+     * A mode option may have more than one mode tag. A mode option may be associated with a mixture of standard
+     * and manufacturer specific mode tags. A mode option shall be associated with at least one standard mode tag.
+     *
+     * A few examples are provided below.
+     *
+     *   • A mode named "100%" can have both the High (manufacturer specific) and Max (standard) mode tag. Clients
+     *     seeking the mode for either High or Max will find the same mode in this case.
+     *
+     *   • A mode that includes a LowEnergy tag can be displayed by the client using a widget icon that shows a
+     *     green leaf.
+     *
+     *   • A mode that includes a LowNoise tag may be used by the client when the user wishes for a lower level of
+     *     audible sound, less likely to disturb the household’s activities.
+     *
+     *   • A mode that includes a LowEnergy tag (standard, defined in this cluster specification) and also a
+     *     Delicate tag (standard, defined in the namespace of a Laundry Mode derived cluster).
+     *
+     *   • A mode that includes both a generic Quick tag (defined here), and Vacuum and Mop tags, (defined in the
+     *     RVC Clean cluster that is a derivation of this cluster).
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2.3
+     */
+    modeTags: TlvField(2, TlvArray(WaterHeaterMode2.TlvModeTagStruct, { maxLength: 8 }))
+  });
+  WaterHeaterMode2.Base = MutableCluster.Component({
+    id: 158,
+    name: "WaterHeaterMode",
+    revision: 1,
+    features: {
+      /**
+       * OnOff
+       *
+       * Dependency with the OnOff cluster
+       */
+      onOff: BitFlag(0)
+    },
+    attributes: {
+      /**
+       * At least one entry in the SupportedModes attribute shall include the Manual mode tag in the ModeTags
+       * field list.
+       *
+       * At least one entry in the SupportedModes attribute shall include the Off mode tag in the ModeTags field
+       * list.
+       *
+       * An entry in the SupportedModes attribute that includes one of an Off, Manual, or Timed tag shall NOT
+       * also include an additional instance of any one of these tag types.
+       *
+       * @see {@link MatterSpecification.v13.Cluster} § 9.6.6.1
+       */
+      supportedModes: FixedAttribute(
+        0,
+        TlvArray(WaterHeaterMode2.TlvModeOption, { minLength: 2, maxLength: 255 }),
+        { default: [] }
+      ),
+      /**
+       * @see {@link MatterSpecification.v13.Cluster} § 9.6.6
+       */
+      currentMode: Attribute(1, TlvUInt8, { persistent: true })
+    },
+    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
+       */
+      changeToMode: Command(0, ModeBase.TlvChangeToModeRequest, 0, TlvNoResponse)
+    },
+    /**
+     * This metadata controls which WaterHeaterModeCluster elements matter.js activates for specific feature
+     * combinations.
+     */
+    extensions: MutableCluster.Extensions({ flags: { onOff: true }, component: false })
+  });
+  WaterHeaterMode2.ClusterInstance = MutableCluster(WaterHeaterMode2.Base);
+  WaterHeaterMode2.Cluster = WaterHeaterMode2.ClusterInstance;
+  WaterHeaterMode2.Complete = WaterHeaterMode2.Cluster;
+})(WaterHeaterMode || (WaterHeaterMode = {}));
+const WaterHeaterModeCluster = WaterHeaterMode.Cluster;
+ClusterRegistry.register(WaterHeaterMode.Complete);
+export {
+  WaterHeaterMode,
+  WaterHeaterModeCluster
+};
+//# sourceMappingURL=water-heater-mode.js.map