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

package/dist/cjs/clusters/energy-preference.d.ts

@@ -0,0 +1,665 @@
+/**
+ * @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 { FixedAttribute, WritableAttribute } from "../cluster/Cluster.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { Identity } from "#general";
+export declare namespace EnergyPreference {
+    /**
+     * These are optional features supported by EnergyPreferenceCluster.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 9.5.4
+     */
+    enum Feature {
+        /**
+         * EnergyBalance (BALA)
+         *
+         * This feature allows a user to select from a list of energy balances with associated descriptions of which
+         * strategies a device will use to target the specified balance.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 9.5.4.1
+         */
+        EnergyBalance = "EnergyBalance",
+        /**
+         * LowPowerModeSensitivity (LPMS)
+         *
+         * This feature allows the user to select a condition or set of conditions which will cause the device to
+         * switch to a mode using less power. For example, a device might provide a scale of durations that must elapse
+         * without user interaction before it goes to sleep.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 9.5.4.2
+         */
+        LowPowerModeSensitivity = "LowPowerModeSensitivity"
+    }
+    /**
+     * This represents a step along a scale of preferences.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2
+     */
+    const TlvBalance: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This field shall indicate the relative value of this step.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.1
+         */
+        step: import("../tlv/TlvObject.js").FieldType<number>;
+        /**
+         * This field shall indicate an optional string explaining which actions a device might take at the given step
+         * value.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.2
+         */
+        label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+    }>;
+    /**
+     * This represents a step along a scale of preferences.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2
+     */
+    interface Balance extends TypeFromSchema<typeof TlvBalance> {
+    }
+    /**
+     * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.1
+     */
+    enum EnergyPriority {
+        /**
+         * This value shall emphasize user comfort; e.g. local temperature for a thermostat.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.1.1
+         */
+        Comfort = 0,
+        /**
+         * This value shall emphasize how quickly a device accomplishes its targeted use; e.g. how quickly a robot
+         * vacuum completes a cleaning cycle.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.1.2
+         */
+        Speed = 1,
+        /**
+         * This value shall emphasize how much energy a device uses; e.g. electricity usage for a Pump.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.1.3
+         */
+        Efficiency = 2,
+        WaterConsumption = 3
+    }
+    /**
+     * A EnergyPreferenceCluster supports these elements if it supports feature EnergyBalance.
+     */
+    const EnergyBalanceComponent: {
+        readonly attributes: {
+            /**
+             * Indicates a list of BalanceStructs, each representing a step along a linear scale
+             *
+             * of relative priorities. A Step field with a value of zero shall indicate that the device SHOULD entirely
+             * favor the priority specified by the first element in EnergyPriorities; whereas a Step field with a value
+             * of 100 shall indicate that the device SHOULD entirely favor the priority specified by the second element
+             * in EnergyPriorities. The midpoint value of 50 shall indicate an even split between the two priorities.
+             *
+             * This shall contain at least two BalanceStructs.
+             *
+             * Each BalanceStruct shall have a Step field larger than the Step field on the previous BalanceStruct in
+             * the list.
+             *
+             * The first BalanceStruct shall have a Step value of zero, and the last BalanceStruct shall have a Step
+             * value of 100.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.1
+             */
+            readonly energyBalances: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall indicate the relative value of this step.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.1
+                 */
+                step: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field shall indicate an optional string explaining which actions a device might take at the given step
+                 * value.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.2
+                 */
+                label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+            }>[], any>;
+            /**
+             * Indicates the current preference of the user for balancing different priorities during device use. The
+             * value of this attribute is the index, 0-based, into the EnergyBalances attribute for the currently
+             * selected balance.
+             *
+             * If an attempt is made to set this attribute to an index outside the maximum index for EnergyBalances, a
+             * response with the status code CONSTRAINT_ERROR shall be returned.
+             *
+             * If the value of EnergyBalances changes after an update, the device shall migrate the value of the
+             * CurrentEnergyBalance attribute to the index which the manufacturer specifies most closely matches the
+             * previous value, while preserving extreme preferences as follows:
+             *
+             *   1. If the previous value of CurrentEnergyBalance was zero, indicating a total preference for the
+             *      priority specified by the first element in EnergyPriorities, the new value of CurrentEnergyBalance
+             *      shall also be zero.
+             *
+             *   2. If the previous value of CurrentEnergyBalance was the index of the last BalanceStruct in the
+             *      previous value of EnergyBalances, indicating a total preference for the priority specified by the
+             *      last element in EnergyPriorities, the new value of CurrentEnergyBalance shall be the index of the
+             *      last element in the updated value of EnergyBalances.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.2
+             */
+            readonly currentEnergyBalance: WritableAttribute<number, any>;
+            /**
+             * Indicates two extremes for interpreting the values in the EnergyBalances attribute. These two priorities
+             * shall be in opposition to each other; e.g. Comfort vs. Efficiency or Speed vs. WaterConsumption.
+             *
+             * If the value of EnergyPriorities changes after an update to represent a new balance between priorities,
+             * the value of the CurrentEnergyBalance attribute shall be set to its default.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3
+             */
+            readonly energyPriorities: FixedAttribute<EnergyPriority[], any>;
+        };
+    };
+    /**
+     * A EnergyPreferenceCluster supports these elements if it supports feature LowPowerModeSensitivity.
+     */
+    const LowPowerModeSensitivityComponent: {
+        readonly attributes: {
+            /**
+             * Indicates a list of BalanceStructs, each representing a condition or set of conditions for the device to
+             * enter a low power mode.
+             *
+             * This shall contain at least two BalanceStructs.
+             *
+             * Each BalanceStruct shall have a Step field larger than the Step field on the previous BalanceStruct in
+             * the list.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.4
+             */
+            readonly lowPowerModeSensitivities: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall indicate the relative value of this step.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.1
+                 */
+                step: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field shall indicate an optional string explaining which actions a device might take at the given step
+                 * value.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.2
+                 */
+                label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+            }>[], any>;
+            /**
+             * Indicates the current preference of the user for determining when the device should enter a low power
+             * mode. The value of this attribute is the index, 0-based, into the LowPowerModeSensitivities attribute
+             * for the currently selected preference.
+             *
+             * If an attempt is made to set this attribute to an index outside the maximum index for
+             * LowPowerModeSensitivities, a response with the status code CONSTRAINT_ERROR shall be returned.
+             *
+             * If the value of LowPowerModeSensitivities changes after an update, the device shall migrate the value of
+             * the LowPowerModeSensitivity attribute to the index which the manufacturer specifies most closely matches
+             * the previous value.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.5
+             */
+            readonly currentLowPowerModeSensitivity: WritableAttribute<number, any>;
+        };
+    };
+    /**
+     * These elements and properties are present in all EnergyPreference clusters.
+     */
+    const Base: {
+        readonly id: 155;
+        readonly name: "EnergyPreference";
+        readonly revision: 1;
+        readonly features: {
+            /**
+             * EnergyBalance
+             *
+             * This feature allows a user to select from a list of energy balances with associated descriptions of
+             * which strategies a device will use to target the specified balance.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 9.5.4.1
+             */
+            readonly energyBalance: BitFlag;
+            /**
+             * LowPowerModeSensitivity
+             *
+             * This feature allows the user to select a condition or set of conditions which will cause the device to
+             * switch to a mode using less power. For example, a device might provide a scale of durations that must
+             * elapse without user interaction before it goes to sleep.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 9.5.4.2
+             */
+            readonly lowPowerModeSensitivity: BitFlag;
+        };
+        /**
+         * This metadata controls which EnergyPreferenceCluster elements matter.js activates for specific feature
+         * combinations.
+         */
+        readonly extensions: readonly [{
+            readonly flags: {
+                readonly energyBalance: true;
+            };
+            readonly component: {
+                readonly attributes: {
+                    /**
+                     * Indicates a list of BalanceStructs, each representing a step along a linear scale
+                     *
+                     * of relative priorities. A Step field with a value of zero shall indicate that the device SHOULD entirely
+                     * favor the priority specified by the first element in EnergyPriorities; whereas a Step field with a value
+                     * of 100 shall indicate that the device SHOULD entirely favor the priority specified by the second element
+                     * in EnergyPriorities. The midpoint value of 50 shall indicate an even split between the two priorities.
+                     *
+                     * This shall contain at least two BalanceStructs.
+                     *
+                     * Each BalanceStruct shall have a Step field larger than the Step field on the previous BalanceStruct in
+                     * the list.
+                     *
+                     * The first BalanceStruct shall have a Step value of zero, and the last BalanceStruct shall have a Step
+                     * value of 100.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.1
+                     */
+                    readonly energyBalances: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                        /**
+                         * This field shall indicate the relative value of this step.
+                         *
+                         * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.1
+                         */
+                        step: import("../tlv/TlvObject.js").FieldType<number>;
+                        /**
+                         * This field shall indicate an optional string explaining which actions a device might take at the given step
+                         * value.
+                         *
+                         * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.2
+                         */
+                        label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+                    }>[], any>;
+                    /**
+                     * Indicates the current preference of the user for balancing different priorities during device use. The
+                     * value of this attribute is the index, 0-based, into the EnergyBalances attribute for the currently
+                     * selected balance.
+                     *
+                     * If an attempt is made to set this attribute to an index outside the maximum index for EnergyBalances, a
+                     * response with the status code CONSTRAINT_ERROR shall be returned.
+                     *
+                     * If the value of EnergyBalances changes after an update, the device shall migrate the value of the
+                     * CurrentEnergyBalance attribute to the index which the manufacturer specifies most closely matches the
+                     * previous value, while preserving extreme preferences as follows:
+                     *
+                     *   1. If the previous value of CurrentEnergyBalance was zero, indicating a total preference for the
+                     *      priority specified by the first element in EnergyPriorities, the new value of CurrentEnergyBalance
+                     *      shall also be zero.
+                     *
+                     *   2. If the previous value of CurrentEnergyBalance was the index of the last BalanceStruct in the
+                     *      previous value of EnergyBalances, indicating a total preference for the priority specified by the
+                     *      last element in EnergyPriorities, the new value of CurrentEnergyBalance shall be the index of the
+                     *      last element in the updated value of EnergyBalances.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.2
+                     */
+                    readonly currentEnergyBalance: WritableAttribute<number, any>;
+                    /**
+                     * Indicates two extremes for interpreting the values in the EnergyBalances attribute. These two priorities
+                     * shall be in opposition to each other; e.g. Comfort vs. Efficiency or Speed vs. WaterConsumption.
+                     *
+                     * If the value of EnergyPriorities changes after an update to represent a new balance between priorities,
+                     * the value of the CurrentEnergyBalance attribute shall be set to its default.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3
+                     */
+                    readonly energyPriorities: FixedAttribute<EnergyPriority[], any>;
+                };
+            };
+        }, {
+            readonly flags: {
+                readonly lowPowerModeSensitivity: true;
+            };
+            readonly component: {
+                readonly attributes: {
+                    /**
+                     * Indicates a list of BalanceStructs, each representing a condition or set of conditions for the device to
+                     * enter a low power mode.
+                     *
+                     * This shall contain at least two BalanceStructs.
+                     *
+                     * Each BalanceStruct shall have a Step field larger than the Step field on the previous BalanceStruct in
+                     * the list.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.4
+                     */
+                    readonly lowPowerModeSensitivities: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                        /**
+                         * This field shall indicate the relative value of this step.
+                         *
+                         * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.1
+                         */
+                        step: import("../tlv/TlvObject.js").FieldType<number>;
+                        /**
+                         * This field shall indicate an optional string explaining which actions a device might take at the given step
+                         * value.
+                         *
+                         * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.2
+                         */
+                        label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+                    }>[], any>;
+                    /**
+                     * Indicates the current preference of the user for determining when the device should enter a low power
+                     * mode. The value of this attribute is the index, 0-based, into the LowPowerModeSensitivities attribute
+                     * for the currently selected preference.
+                     *
+                     * If an attempt is made to set this attribute to an index outside the maximum index for
+                     * LowPowerModeSensitivities, a response with the status code CONSTRAINT_ERROR shall be returned.
+                     *
+                     * If the value of LowPowerModeSensitivities changes after an update, the device shall migrate the value of
+                     * the LowPowerModeSensitivity attribute to the index which the manufacturer specifies most closely matches
+                     * the previous value.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.5
+                     */
+                    readonly currentLowPowerModeSensitivity: WritableAttribute<number, any>;
+                };
+            };
+        }, {
+            readonly flags: {
+                readonly energyBalance: false;
+                readonly lowPowerModeSensitivity: false;
+            };
+            readonly component: false;
+        }];
+    };
+    /**
+     * @see {@link Cluster}
+     */
+    const ClusterInstance: MutableCluster.ExtensibleOnly<{
+        readonly id: 155;
+        readonly name: "EnergyPreference";
+        readonly revision: 1;
+        readonly features: {
+            /**
+             * EnergyBalance
+             *
+             * This feature allows a user to select from a list of energy balances with associated descriptions of
+             * which strategies a device will use to target the specified balance.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 9.5.4.1
+             */
+            readonly energyBalance: BitFlag;
+            /**
+             * LowPowerModeSensitivity
+             *
+             * This feature allows the user to select a condition or set of conditions which will cause the device to
+             * switch to a mode using less power. For example, a device might provide a scale of durations that must
+             * elapse without user interaction before it goes to sleep.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 9.5.4.2
+             */
+            readonly lowPowerModeSensitivity: BitFlag;
+        };
+        /**
+         * This metadata controls which EnergyPreferenceCluster elements matter.js activates for specific feature
+         * combinations.
+         */
+        readonly extensions: readonly [{
+            readonly flags: {
+                readonly energyBalance: true;
+            };
+            readonly component: {
+                readonly attributes: {
+                    /**
+                     * Indicates a list of BalanceStructs, each representing a step along a linear scale
+                     *
+                     * of relative priorities. A Step field with a value of zero shall indicate that the device SHOULD entirely
+                     * favor the priority specified by the first element in EnergyPriorities; whereas a Step field with a value
+                     * of 100 shall indicate that the device SHOULD entirely favor the priority specified by the second element
+                     * in EnergyPriorities. The midpoint value of 50 shall indicate an even split between the two priorities.
+                     *
+                     * This shall contain at least two BalanceStructs.
+                     *
+                     * Each BalanceStruct shall have a Step field larger than the Step field on the previous BalanceStruct in
+                     * the list.
+                     *
+                     * The first BalanceStruct shall have a Step value of zero, and the last BalanceStruct shall have a Step
+                     * value of 100.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.1
+                     */
+                    readonly energyBalances: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                        /**
+                         * This field shall indicate the relative value of this step.
+                         *
+                         * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.1
+                         */
+                        step: import("../tlv/TlvObject.js").FieldType<number>;
+                        /**
+                         * This field shall indicate an optional string explaining which actions a device might take at the given step
+                         * value.
+                         *
+                         * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.2
+                         */
+                        label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+                    }>[], any>;
+                    /**
+                     * Indicates the current preference of the user for balancing different priorities during device use. The
+                     * value of this attribute is the index, 0-based, into the EnergyBalances attribute for the currently
+                     * selected balance.
+                     *
+                     * If an attempt is made to set this attribute to an index outside the maximum index for EnergyBalances, a
+                     * response with the status code CONSTRAINT_ERROR shall be returned.
+                     *
+                     * If the value of EnergyBalances changes after an update, the device shall migrate the value of the
+                     * CurrentEnergyBalance attribute to the index which the manufacturer specifies most closely matches the
+                     * previous value, while preserving extreme preferences as follows:
+                     *
+                     *   1. If the previous value of CurrentEnergyBalance was zero, indicating a total preference for the
+                     *      priority specified by the first element in EnergyPriorities, the new value of CurrentEnergyBalance
+                     *      shall also be zero.
+                     *
+                     *   2. If the previous value of CurrentEnergyBalance was the index of the last BalanceStruct in the
+                     *      previous value of EnergyBalances, indicating a total preference for the priority specified by the
+                     *      last element in EnergyPriorities, the new value of CurrentEnergyBalance shall be the index of the
+                     *      last element in the updated value of EnergyBalances.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.2
+                     */
+                    readonly currentEnergyBalance: WritableAttribute<number, any>;
+                    /**
+                     * Indicates two extremes for interpreting the values in the EnergyBalances attribute. These two priorities
+                     * shall be in opposition to each other; e.g. Comfort vs. Efficiency or Speed vs. WaterConsumption.
+                     *
+                     * If the value of EnergyPriorities changes after an update to represent a new balance between priorities,
+                     * the value of the CurrentEnergyBalance attribute shall be set to its default.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3
+                     */
+                    readonly energyPriorities: FixedAttribute<EnergyPriority[], any>;
+                };
+            };
+        }, {
+            readonly flags: {
+                readonly lowPowerModeSensitivity: true;
+            };
+            readonly component: {
+                readonly attributes: {
+                    /**
+                     * Indicates a list of BalanceStructs, each representing a condition or set of conditions for the device to
+                     * enter a low power mode.
+                     *
+                     * This shall contain at least two BalanceStructs.
+                     *
+                     * Each BalanceStruct shall have a Step field larger than the Step field on the previous BalanceStruct in
+                     * the list.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.4
+                     */
+                    readonly lowPowerModeSensitivities: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                        /**
+                         * This field shall indicate the relative value of this step.
+                         *
+                         * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.1
+                         */
+                        step: import("../tlv/TlvObject.js").FieldType<number>;
+                        /**
+                         * This field shall indicate an optional string explaining which actions a device might take at the given step
+                         * value.
+                         *
+                         * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.2
+                         */
+                        label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+                    }>[], any>;
+                    /**
+                     * Indicates the current preference of the user for determining when the device should enter a low power
+                     * mode. The value of this attribute is the index, 0-based, into the LowPowerModeSensitivities attribute
+                     * for the currently selected preference.
+                     *
+                     * If an attempt is made to set this attribute to an index outside the maximum index for
+                     * LowPowerModeSensitivities, a response with the status code CONSTRAINT_ERROR shall be returned.
+                     *
+                     * If the value of LowPowerModeSensitivities changes after an update, the device shall migrate the value of
+                     * the LowPowerModeSensitivity attribute to the index which the manufacturer specifies most closely matches
+                     * the previous value.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 9.5.6.5
+                     */
+                    readonly currentLowPowerModeSensitivity: WritableAttribute<number, any>;
+                };
+            };
+        }, {
+            readonly flags: {
+                readonly energyBalance: false;
+                readonly lowPowerModeSensitivity: false;
+            };
+            readonly component: false;
+        }];
+    }>;
+    /**
+     * This cluster provides an interface to specify preferences for how devices should consume energy.
+     *
+     * NOTE Support for Energy Preference cluster is provisional.
+     *
+     * Per the Matter specification you cannot use {@link EnergyPreferenceCluster} without enabling certain feature
+     * combinations. You must use the {@link with} factory method to obtain a working cluster.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 9.5
+     */
+    interface Cluster extends Identity<typeof ClusterInstance> {
+    }
+    const Cluster: Cluster;
+    /**
+     * @see {@link Complete}
+     */
+    const CompleteInstance: MutableCluster<{
+        readonly id: 155;
+        readonly name: "EnergyPreference";
+        readonly revision: 1;
+        readonly features: {
+            /**
+             * EnergyBalance
+             *
+             * This feature allows a user to select from a list of energy balances with associated descriptions of
+             * which strategies a device will use to target the specified balance.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 9.5.4.1
+             */
+            readonly energyBalance: BitFlag;
+            /**
+             * LowPowerModeSensitivity
+             *
+             * This feature allows the user to select a condition or set of conditions which will cause the device to
+             * switch to a mode using less power. For example, a device might provide a scale of durations that must
+             * elapse without user interaction before it goes to sleep.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 9.5.4.2
+             */
+            readonly lowPowerModeSensitivity: BitFlag;
+        };
+        readonly attributes: {
+            readonly energyBalances: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall indicate the relative value of this step.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.1
+                 */
+                step: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field shall indicate an optional string explaining which actions a device might take at the given step
+                 * value.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.2
+                 */
+                label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+            }>[], any> & {
+                readonly optional: true;
+                readonly isConditional: true;
+                readonly optionalIf: [] | import("../cluster/Cluster.js").ConditionalFeatureList<import("../schema/BitmapSchema.js").BitSchema>;
+                readonly mandatoryIf: [] | [{
+                    energyBalance: boolean;
+                }];
+            };
+            readonly currentEnergyBalance: WritableAttribute<number, any> & {
+                readonly optional: true;
+                readonly isConditional: true;
+                readonly optionalIf: [] | import("../cluster/Cluster.js").ConditionalFeatureList<import("../schema/BitmapSchema.js").BitSchema>;
+                readonly mandatoryIf: [] | [{
+                    energyBalance: boolean;
+                }];
+            };
+            readonly energyPriorities: FixedAttribute<EnergyPriority[], any> & {
+                readonly optional: true;
+                readonly isConditional: true;
+                readonly optionalIf: [] | import("../cluster/Cluster.js").ConditionalFeatureList<import("../schema/BitmapSchema.js").BitSchema>;
+                readonly mandatoryIf: [] | [{
+                    energyBalance: boolean;
+                }];
+            };
+            readonly lowPowerModeSensitivities: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall indicate the relative value of this step.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.1
+                 */
+                step: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field shall indicate an optional string explaining which actions a device might take at the given step
+                 * value.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 9.5.5.2.2
+                 */
+                label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
+            }>[], any> & {
+                readonly optional: true;
+                readonly isConditional: true;
+                readonly optionalIf: [] | import("../cluster/Cluster.js").ConditionalFeatureList<import("../schema/BitmapSchema.js").BitSchema>;
+                readonly mandatoryIf: [] | [{
+                    lowPowerModeSensitivity: boolean;
+                }];
+            };
+            readonly currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
+                readonly optional: true;
+                readonly isConditional: true;
+                readonly optionalIf: [] | import("../cluster/Cluster.js").ConditionalFeatureList<import("../schema/BitmapSchema.js").BitSchema>;
+                readonly mandatoryIf: [] | [{
+                    lowPowerModeSensitivity: boolean;
+                }];
+            };
+        };
+    }, []>;
+    /**
+     * This cluster supports all EnergyPreference 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 EnergyPreferenceCluster = EnergyPreference.Cluster;
+export declare const EnergyPreferenceCluster: EnergyPreference.Cluster;
+//# sourceMappingURL=energy-preference.d.ts.map

package/dist/cjs/clusters/energy-preference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"energy-preference.d.ts","sourceRoot":"","sources":["../../../src/clusters/energy-preference.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAK1E,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,gBAAgB,CAAC;IAC9B;;;;OAIG;IACH,KAAY,OAAO;QACf;;;;;;;WAOG;QACH,aAAa,kBAAkB;QAE/B;;;;;;;;WAQG;QACH,uBAAuB,4BAA4B;KACtD;IAED;;;;OAIG;IACI,MAAM,UAAU;QACnB;;;;WAIG;;QAGH;;;;;WAKG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,OAAQ,SAAQ,cAAc,CAAC,OAAO,UAAU,CAAC;KAAG;IAErE;;OAEG;IACH,KAAY,cAAc;QACtB;;;;WAIG;QACH,OAAO,IAAI;QAEX;;;;;WAKG;QACH,KAAK,IAAI;QAET;;;;WAIG;QACH,UAAU,IAAI;QAEd,gBAAgB,IAAI;KACvB;IAED;;OAEG;IACI,MAAM,sBAAsB;;YAE3B;;;;;;;;;;;;;;;;;eAiBG;;gBA1EP;;;;mBAIG;;gBAGH;;;;;mBAKG;;;YAiEC;;;;;;;;;;;;;;;;;;;;;;eAsBG;;YAGH;;;;;;;;eAQG;;;KAGT,CAAC;IAEH;;OAEG;IACI,MAAM,gCAAgC;;YAErC;;;;;;;;;;eAUG;;gBAlIP;;;;mBAIG;;gBAGH;;;;;mBAKG;;;YAyHC;;;;;;;;;;;;;eAaG;;;KAGT,CAAC;IAEH;;OAEG;IACI,MAAM,IAAI;;;;;YAMT;;;;;;;eAOG;;YAGH;;;;;;;;eAQG;;;QAIP;;;WAGG;;;;;;;oBAhIC;;;;;;;;;;;;;;;;;uBAiBG;;wBA1EP;;;;2BAIG;;wBAGH;;;;;2BAKG;;;oBAiEC;;;;;;;;;;;;;;;;;;;;;;uBAsBG;;oBAGH;;;;;;;;uBAQG;;;;;;;;;;oBAUH;;;;;;;;;;uBAUG;;wBAlIP;;;;2BAIG;;wBAGH;;;;;2BAKG;;;oBAyHC;;;;;;;;;;;;;uBAaG;;;;;;;;;;;KA6CT,CAAC;IAEH;;OAEG;IACI,MAAM,eAAe;;;;;YApCpB;;;;;;;eAOG;;YAGH;;;;;;;;eAQG;;;QAIP;;;WAGG;;;;;;;oBAhIC;;;;;;;;;;;;;;;;;uBAiBG;;wBA1EP;;;;2BAIG;;wBAGH;;;;;2BAKG;;;oBAiEC;;;;;;;;;;;;;;;;;;;;;;uBAsBG;;oBAGH;;;;;;;;uBAQG;;;;;;;;;;oBAUH;;;;;;;;;;uBAUG;;wBAlIP;;;;2BAIG;;wBAGH;;;;;2BAKG;;;oBAyHC;;;;;;;;;;;;;uBAaG;;;;;;;;;;;MAkDuD,CAAC;IAEnE;;;;;;;;;OASG;IACH,UAAiB,OAAQ,SAAQ,QAAQ,CAAC,OAAO,eAAe,CAAC;KAAG;IAE7D,MAAM,OAAO,EAAE,OAAyB,CAAC;IAIhD;;OAEG;IACI,MAAM,gBAAgB;;;;;YAzDrB;;;;;;;eAOG;;YAGH;;;;;;;;eAQG;;;;;gBAlLP;;;;mBAIG;;gBAGH;;;;;mBAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAZH;;;;mBAIG;;gBAGH;;;;;mBAKG;;;;;;;;;;;;;;;;;;;UAyOL,CAAC;IAEH;;;;;OAKG;IACH,UAAiB,QAAS,SAAQ,QAAQ,CAAC,OAAO,gBAAgB,CAAC;KAAG;IAE/D,MAAM,QAAQ,EAAE,QAA2B,CAAC;CACtD;AAED,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,CAAC,OAAO,CAAC;AAC/D,eAAO,MAAM,uBAAuB,0BAA2B,CAAC"}