@matter/types 0.13.0-alpha.0-20250328-6dde053de → 0.13.0-alpha.0-20250330-df5a17eba

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

@@ -13,7 +13,7 @@ export declare namespace EnergyPreference {
     /**
      * These are optional features supported by EnergyPreferenceCluster.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 9.7.4
+     * @see {@link MatterSpecification.v14.Cluster} § 9.7.4
      */
     enum Feature {
         /**
@@ -22,7 +22,7 @@ export declare namespace EnergyPreference {
          * 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.7.4.1
+         * @see {@link MatterSpecification.v14.Cluster} § 9.7.4.1
          */
         EnergyBalance = "EnergyBalance",
         /**
@@ -32,39 +32,39 @@ export declare namespace EnergyPreference {
          * 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.7.4.2
+         * @see {@link MatterSpecification.v14.Cluster} § 9.7.4.2
          */
         LowPowerModeSensitivity = "LowPowerModeSensitivity"
     }
     /**
      * This represents a step along a scale of preferences.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 9.7.5.2
+     * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.1
+         * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.2
+         * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2
+     * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.2
      */
     interface Balance extends TypeFromSchema<typeof TlvBalance> {
     }
     /**
-     * @see {@link MatterSpecification.v13.Cluster} § 9.7.5.1
+     * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.1
      */
     enum EnergyPriority {
         /**
@@ -72,7 +72,7 @@ export declare namespace EnergyPreference {
          *
          * This value shall emphasize user comfort; e.g. local temperature for a thermostat.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 9.7.5.1.1
+         * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.1.1
          */
         Comfort = 0,
         /**
@@ -81,7 +81,7 @@ export declare namespace EnergyPreference {
          * 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.7.5.1.2
+         * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.1.2
          */
         Speed = 1,
         /**
@@ -89,7 +89,7 @@ export declare namespace EnergyPreference {
          *
          * This value shall emphasize how much energy a device uses; e.g. electricity usage for a Pump.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 9.7.5.1.3
+         * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.1.3
          */
         Efficiency = 2,
         /**
@@ -117,20 +117,20 @@ export declare namespace EnergyPreference {
              * 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.7.6.1
+             * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.1
+                 * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.2
+                 * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.2.2
                  */
                 label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
             }>[], any>;
@@ -155,7 +155,7 @@ export declare namespace EnergyPreference {
              *      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.7.6.2
+             * @see {@link MatterSpecification.v14.Cluster} § 9.7.6.2
              */
             readonly currentEnergyBalance: WritableAttribute<number, any>;
             /**
@@ -165,7 +165,7 @@ export declare namespace EnergyPreference {
              * 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.7.6.3
+             * @see {@link MatterSpecification.v14.Cluster} § 9.7.6.3
              */
             readonly energyPriorities: FixedAttribute<EnergyPriority[], any>;
         };
@@ -182,20 +182,20 @@ export declare namespace EnergyPreference {
              * 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.7.6.4
+             * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.1
+                 * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.2
+                 * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.2.2
                  */
                 label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
             }>[], any>;
@@ -211,7 +211,7 @@ export declare namespace EnergyPreference {
              * the LowPowerModeSensitivity attribute to the index which the manufacturer specifies most closely matches
              * the previous value.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 9.7.6.5
+             * @see {@link MatterSpecification.v14.Cluster} § 9.7.6.5
              */
             readonly currentLowPowerModeSensitivity: WritableAttribute<number, any>;
         };
@@ -230,7 +230,7 @@ export declare namespace EnergyPreference {
              * 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.7.4.1
+             * @see {@link MatterSpecification.v14.Cluster} § 9.7.4.1
              */
             readonly energyBalance: BitFlag;
             /**
@@ -240,7 +240,7 @@ export declare namespace EnergyPreference {
              * 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.7.4.2
+             * @see {@link MatterSpecification.v14.Cluster} § 9.7.4.2
              */
             readonly lowPowerModeSensitivity: BitFlag;
         };
@@ -269,20 +269,20 @@ export declare namespace EnergyPreference {
                      * 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.7.6.1
+                     * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.1
+                         * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.2
+                         * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.2.2
                          */
                         label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
                     }>[], any>;
@@ -307,7 +307,7 @@ export declare namespace EnergyPreference {
                      *      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.7.6.2
+                     * @see {@link MatterSpecification.v14.Cluster} § 9.7.6.2
                      */
                     readonly currentEnergyBalance: WritableAttribute<number, any>;
                     /**
@@ -317,7 +317,7 @@ export declare namespace EnergyPreference {
                      * 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.7.6.3
+                     * @see {@link MatterSpecification.v14.Cluster} § 9.7.6.3
                      */
                     readonly energyPriorities: FixedAttribute<EnergyPriority[], any>;
                 };
@@ -335,20 +335,20 @@ export declare namespace EnergyPreference {
                      * 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.7.6.4
+                     * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.1
+                         * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.2
+                         * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.2.2
                          */
                         label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
                     }>[], any>;
@@ -364,7 +364,7 @@ export declare namespace EnergyPreference {
                      * the LowPowerModeSensitivity attribute to the index which the manufacturer specifies most closely matches
                      * the previous value.
                      *
-                     * @see {@link MatterSpecification.v13.Cluster} § 9.7.6.5
+                     * @see {@link MatterSpecification.v14.Cluster} § 9.7.6.5
                      */
                     readonly currentLowPowerModeSensitivity: WritableAttribute<number, any>;
                 };
@@ -391,7 +391,7 @@ export declare namespace EnergyPreference {
              * 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.7.4.1
+             * @see {@link MatterSpecification.v14.Cluster} § 9.7.4.1
              */
             readonly energyBalance: BitFlag;
             /**
@@ -401,7 +401,7 @@ export declare namespace EnergyPreference {
              * 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.7.4.2
+             * @see {@link MatterSpecification.v14.Cluster} § 9.7.4.2
              */
             readonly lowPowerModeSensitivity: BitFlag;
         };
@@ -430,20 +430,20 @@ export declare namespace EnergyPreference {
                      * 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.7.6.1
+                     * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.1
+                         * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.2
+                         * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.2.2
                          */
                         label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
                     }>[], any>;
@@ -468,7 +468,7 @@ export declare namespace EnergyPreference {
                      *      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.7.6.2
+                     * @see {@link MatterSpecification.v14.Cluster} § 9.7.6.2
                      */
                     readonly currentEnergyBalance: WritableAttribute<number, any>;
                     /**
@@ -478,7 +478,7 @@ export declare namespace EnergyPreference {
                      * 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.7.6.3
+                     * @see {@link MatterSpecification.v14.Cluster} § 9.7.6.3
                      */
                     readonly energyPriorities: FixedAttribute<EnergyPriority[], any>;
                 };
@@ -496,20 +496,20 @@ export declare namespace EnergyPreference {
                      * 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.7.6.4
+                     * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.1
+                         * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.2
+                         * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.2.2
                          */
                         label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
                     }>[], any>;
@@ -525,7 +525,7 @@ export declare namespace EnergyPreference {
                      * the LowPowerModeSensitivity attribute to the index which the manufacturer specifies most closely matches
                      * the previous value.
                      *
-                     * @see {@link MatterSpecification.v13.Cluster} § 9.7.6.5
+                     * @see {@link MatterSpecification.v14.Cluster} § 9.7.6.5
                      */
                     readonly currentLowPowerModeSensitivity: WritableAttribute<number, any>;
                 };
@@ -546,7 +546,7 @@ export declare namespace EnergyPreference {
      * 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.7
+     * @see {@link MatterSpecification.v14.Cluster} § 9.7
      */
     interface Cluster extends Identity<typeof ClusterInstance> {
     }
@@ -565,7 +565,7 @@ export declare namespace EnergyPreference {
              * 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.7.4.1
+             * @see {@link MatterSpecification.v14.Cluster} § 9.7.4.1
              */
             readonly energyBalance: BitFlag;
             /**
@@ -575,7 +575,7 @@ export declare namespace EnergyPreference {
              * 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.7.4.2
+             * @see {@link MatterSpecification.v14.Cluster} § 9.7.4.2
              */
             readonly lowPowerModeSensitivity: BitFlag;
         };
@@ -584,14 +584,14 @@ export declare namespace EnergyPreference {
                 /**
                  * This field shall indicate the relative value of this step.
                  *
-                 * @see {@link MatterSpecification.v13.Cluster} § 9.7.5.2.1
+                 * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.2
+                 * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.2.2
                  */
                 label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
             }>[], any> & {
@@ -622,14 +622,14 @@ export declare namespace EnergyPreference {
                 /**
                  * This field shall indicate the relative value of this step.
                  *
-                 * @see {@link MatterSpecification.v13.Cluster} § 9.7.5.2.1
+                 * @see {@link MatterSpecification.v14.Cluster} § 9.7.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.7.5.2.2
+                 * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.2.2
                  */
                 label: import("../tlv/TlvObject.js").OptionalFieldType<string>;
             }>[], any> & {

package/dist/esm/clusters/energy-preference.js

@@ -22,14 +22,14 @@ var EnergyPreference;
     /**
      * This field shall indicate the relative value of this step.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 9.7.5.2.1
+     * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.2.1
      */
     step: TlvField(0, TlvPercent),
     /**
      * 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.7.5.2.2
+     * @see {@link MatterSpecification.v14.Cluster} § 9.7.5.2.2
      */
     label: TlvOptionalField(1, TlvString.bound({ maxLength: 64 }))
   });
@@ -57,7 +57,7 @@ var EnergyPreference;
        * 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.7.6.1
+       * @see {@link MatterSpecification.v14.Cluster} § 9.7.6.1
        */
       energyBalances: FixedAttribute(0, TlvArray(EnergyPreference2.TlvBalance, { minLength: 2, maxLength: 10 })),
       /**
@@ -81,7 +81,7 @@ var EnergyPreference;
        *      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.7.6.2
+       * @see {@link MatterSpecification.v14.Cluster} § 9.7.6.2
        */
       currentEnergyBalance: WritableAttribute(1, TlvUInt8, { persistent: true }),
       /**
@@ -91,7 +91,7 @@ var EnergyPreference;
        * 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.7.6.3
+       * @see {@link MatterSpecification.v14.Cluster} § 9.7.6.3
        */
       energyPriorities: FixedAttribute(2, TlvArray(TlvEnum(), { length: 2 }))
     }
@@ -105,7 +105,7 @@ var EnergyPreference;
        * 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.7.6.4
+       * @see {@link MatterSpecification.v14.Cluster} § 9.7.6.4
        */
       lowPowerModeSensitivities: FixedAttribute(3, TlvArray(EnergyPreference2.TlvBalance, { minLength: 2, maxLength: 10 })),
       /**
@@ -120,7 +120,7 @@ var EnergyPreference;
        * the LowPowerModeSensitivity attribute to the index which the manufacturer specifies most closely matches
        * the previous value.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 9.7.6.5
+       * @see {@link MatterSpecification.v14.Cluster} § 9.7.6.5
        */
       currentLowPowerModeSensitivity: WritableAttribute(4, TlvUInt8, { persistent: true })
     }
@@ -136,7 +136,7 @@ var EnergyPreference;
        * 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.7.4.1
+       * @see {@link MatterSpecification.v14.Cluster} § 9.7.4.1
        */
       energyBalance: BitFlag(0),
       /**
@@ -146,7 +146,7 @@ var EnergyPreference;
        * 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.7.4.2
+       * @see {@link MatterSpecification.v14.Cluster} § 9.7.4.2
        */
       lowPowerModeSensitivity: BitFlag(1)
     },