@matter/types 0.13.0-alpha.0-20250304-d4a7592a4 → 0.13.0-alpha.0-20250311-3eb0af5f2

package/src/clusters/pump-configuration-and-control.ts

@@ -221,9 +221,10 @@ export namespace PumpConfigurationAndControl {
         /**
          * The pump will regulate its speed to maintain a constant differential pressure over its flanges.
          *
-         * The setpoint is interpreted as a percentage of the range derived of the [MinCompPressure – MaxCompPressure]
-         * attributes. The internal setpoint will be lowered (compensated) dependent on the flow in the pump (lower
-         * flow ⇒ lower internal setpoint).
+         * The setpoint is interpreted as a percentage of the range derived of the [MinCompPressure – Max
+         *
+         * CompPressure] attributes. The internal setpoint will be lowered (compensated) dependent on the flow in the
+         * pump (lower flow ⇒ lower internal setpoint).
          *
          * @see {@link MatterSpecification.v13.Cluster} § 4.2.6.3.3
          */
@@ -339,8 +340,9 @@ export namespace PumpConfigurationAndControl {
             maxCompPressure: OptionalFixedAttribute(0x6, TlvNullable(TlvInt16), { default: null }),
 
             /**
-             * This attribute specifies the minimum speed the pump can achieve when it is working with the ControlMode
-             * attribute set to ConstantSpeed.
+             * This attribute specifies the minimum speed the pump can achieve when it is working with the Con
+             *
+             * trolMode attribute set to ConstantSpeed.
              *
              * Valid range is 0 to 65,534 RPM (steps of 1 RPM). Null if the value is invalid.
              *
@@ -359,9 +361,8 @@ export namespace PumpConfigurationAndControl {
             maxConstSpeed: OptionalFixedAttribute(0x8, TlvNullable(TlvUInt16), { default: null }),
 
             /**
-             * This attribute specifies the minimum flow the pump can achieve when it is working with the Con
-             *
-             * trolMode attribute set to ConstantFlow.
+             * This attribute specifies the minimum flow the pump can achieve when it is working with the ControlMode
+             * attribute set to ConstantFlow.
              *
              * Valid range is 0 m/h to 6,553.4 m/h (steps of 0.1 m/h). Null if the value is invalid.
              *
@@ -436,8 +437,9 @@ export namespace PumpConfigurationAndControl {
     export const ConstantSpeedComponent = MutableCluster.Component({
         attributes: {
             /**
-             * This attribute specifies the minimum speed the pump can achieve when it is working with the ControlMode
-             * attribute set to ConstantSpeed.
+             * This attribute specifies the minimum speed the pump can achieve when it is working with the Con
+             *
+             * trolMode attribute set to ConstantSpeed.
              *
              * Valid range is 0 to 65,534 RPM (steps of 1 RPM). Null if the value is invalid.
              *
@@ -463,9 +465,8 @@ export namespace PumpConfigurationAndControl {
     export const ConstantFlowComponent = MutableCluster.Component({
         attributes: {
             /**
-             * This attribute specifies the minimum flow the pump can achieve when it is working with the Con
-             *
-             * trolMode attribute set to ConstantFlow.
+             * This attribute specifies the minimum flow the pump can achieve when it is working with the ControlMode
+             * attribute set to ConstantFlow.
              *
              * Valid range is 0 m/h to 6,553.4 m/h (steps of 0.1 m/h). Null if the value is invalid.
              *
@@ -606,8 +607,9 @@ export namespace PumpConfigurationAndControl {
 
             /**
              * This attribute specifies the activity status of the pump functions as listed in PumpStatusBitmap. Where
-             * a pump controller function is active, the corresponding bit shall be set to 1. Where a pump controller
-             * function is not active, the corresponding bit shall be set to 0.
+             * a pump controller function is active, the corresponding bit shall be set to 1. Where a pump
+             *
+             * controller function is not active, the corresponding bit shall be set to 0.
              *
              * @see {@link MatterSpecification.v13.Cluster} § 4.2.7.14
              */
@@ -675,7 +677,7 @@ export namespace PumpConfigurationAndControl {
              * If the value is not available (the measurement or estimation of the speed is done in the pump), this
              * attribute will indicate the null value.
              *
-             * Valid range is 0 to 65.534 RPM.
+             * Valid range is 0 to 65,534 RPM.
              *
              * @see {@link MatterSpecification.v13.Cluster} § 4.2.7.18
              */
@@ -686,10 +688,10 @@ export namespace PumpConfigurationAndControl {
              * has been running. It is updated dynamically as it increases. It is preserved over power cycles of the
              * pump. If LifeTimeRunningHours rises above maximum value it “rolls over” and starts at 0 (zero).
              *
-             * This attribute is writeable, in order to allow setting to an appropriate value after maintenance. If
+             * This attribute is writeable, in order to allow setting to an appropriate value after maintenance. If the
+             * value is not available, this attribute will indicate the null value.
              *
-             * the value is not available, this attribute will indicate the null value. Valid range is 0 to 16,777,214
-             * hrs.
+             * Valid range is 0 to 16,777,214 hrs.
              *
              * @see {@link MatterSpecification.v13.Cluster} § 4.2.7.19
              */
@@ -770,9 +772,7 @@ export namespace PumpConfigurationAndControl {
             /**
              * This attribute specifies the control mode of the pump as defined in ControlModeEnum.
              *
-             * See the OperationMode attribute for a detailed description of the operation and control of the
-             *
-             * pump.
+             * See the OperationMode attribute for a detailed description of the operation and control of the pump.
              *
              * ControlMode may be changed at any time, even when the pump is running. The behavior of the pump at the
              * point of changing is vendor-specific.
@@ -793,7 +793,7 @@ export namespace PumpConfigurationAndControl {
              * @see {@link MatterSpecification.v13.Cluster} § 4.2.7
              * @deprecated
              */
-            alarmMask: OptionalAttribute(0x22, TlvUInt16, { persistent: true, default: 0 })
+            alarmMask: OptionalWritableAttribute(0x22, TlvUInt16)
         },
 
         events: {
@@ -919,6 +919,18 @@ export namespace PumpConfigurationAndControl {
      * the automatic reporting of pump status information. Note that control of pump speed is not included – speed is
      * controlled by the On/Off and Level Control clusters.
      *
+     * ### Pump controller Pump
+     *
+     * C Pump configuration and control S C Level control S
+     *
+     * C On/Off S
+     *
+     * C = Client S = Server
+     *
+     * Note: Device names are examples for illustration purposes only
+     *
+     * Figure 14. Typical Usage of Pump Configuration and Control Cluster
+     *
      * Per the Matter specification you cannot use {@link PumpConfigurationAndControlCluster} without enabling certain
      * feature combinations. You must use the {@link with} factory method to obtain a working cluster.
      *

package/src/clusters/refrigerator-alarm.ts

@@ -203,7 +203,8 @@ export namespace RefrigeratorAlarm {
     export const ClusterInstance = MutableCluster(Base);
 
     /**
-     * This cluster is a derived cluster of Alarm Base cluster.
+     * This cluster is a derived cluster of Alarm Base cluster and provides the alarm definition related to
+     * refrigerator and temperature controlled cabinet devices.
      *
      * RefrigeratorAlarmCluster supports optional features that you can enable with the RefrigeratorAlarmCluster.with()
      * factory method.

package/src/clusters/refrigerator-and-temperature-controlled-cabinet-mode.ts

@@ -8,14 +8,14 @@
 
 import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
 import { BitFlag } from "../schema/BitmapSchema.js";
-import { FixedAttribute, Attribute, WritableAttribute, Command, TlvNoResponse } from "../cluster/Cluster.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 { TypeFromSchema } from "../tlv/TlvSchema.js";
 import { ModeBase } from "./mode-base.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
 import { Identity } from "#general";
 import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
 
@@ -23,104 +23,81 @@ export namespace RefrigeratorAndTemperatureControlledCabinetMode {
     /**
      * These are optional features supported by RefrigeratorAndTemperatureControlledCabinetModeCluster.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.10.4
+     * @see {@link MatterSpecification.v13.Cluster} § 8.7.4
      */
     export enum Feature {
         /**
          * OnOff (DEPONOFF)
          *
-         * This feature creates a dependency between an OnOff cluster instance and this cluster instance on the same
-         * endpoint. See OnMode for more information.
-         *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.4.1
+         * Dependency with the OnOff cluster
          */
         OnOff = "OnOff"
     }
 
     export enum ModeTag {
         /**
-         * This mode reduces the temperature rapidly, typically above freezing grade.
-         *
-         * @see {@link MatterSpecification.v13.Cluster} § 8.7.6.1.1
-         */
-        RapidCool = 16384,
-
-        /**
-         * This mode reduces the temperature rapidly, below freezing grade.
-         *
-         * @see {@link MatterSpecification.v13.Cluster} § 8.7.6.1.2
-         */
-        RapidFreeze = 16385,
-
-        /**
-         * The device decides which options, features and setting values to use.
-         *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v13.Cluster} § 8.7.7.1
          */
         Auto = 0,
 
         /**
-         * The mode of the device is optimizing for faster completion.
-         *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v13.Cluster} § 8.7.7.1
          */
         Quick = 1,
 
         /**
-         * The device is silent or barely audible while in this mode.
-         *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v13.Cluster} § 8.7.7.1
          */
         Quiet = 2,
 
         /**
-         * Either the mode is inherently low noise or the device optimizes for that.
-         *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v13.Cluster} § 8.7.7.1
          */
         LowNoise = 3,
 
         /**
-         * The device is optimizing for lower energy usage in this mode. Sometimes called "Eco mode".
-         *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v13.Cluster} § 8.7.7.1
          */
         LowEnergy = 4,
 
         /**
-         * A mode suitable for use during vacations or other extended absences.
-         *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v13.Cluster} § 8.7.7.1
          */
         Vacation = 5,
 
         /**
-         * The mode uses the lowest available setting value.
-         *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v13.Cluster} § 8.7.7.1
          */
         Min = 6,
 
         /**
-         * The mode uses the highest available setting value.
-         *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v13.Cluster} § 8.7.7.1
          */
         Max = 7,
 
         /**
-         * The mode is recommended or suitable for use during night time.
-         *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v13.Cluster} § 8.7.7.1
          */
         Night = 8,
 
         /**
-         * The mode is recommended or suitable for use during day time.
+         * @see {@link MatterSpecification.v13.Cluster} § 8.7.7.1
+         */
+        Day = 9,
+
+        /**
+         * This mode reduces the temperature rapidly, typically above freezing grade.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 8.7.7.1.1
+         */
+        RapidCool = 16384,
+
+        /**
+         * This mode reduces the temperature rapidly, below freezing grade.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v13.Cluster} § 8.7.7.1.2
          */
-        Day = 9
+        RapidFreeze = 16385
     }
 
     /**
@@ -150,7 +127,7 @@ export namespace RefrigeratorAndTemperatureControlledCabinetMode {
          *
          * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.1.2
          */
-        value: TlvField(1, TlvEnum<ModeTag>())
+        value: TlvField(1, TlvEnum<ModeTag | ModeBase.ModeTag>())
     });
 
     /**
@@ -164,9 +141,7 @@ export namespace RefrigeratorAndTemperatureControlledCabinetMode {
      * 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.
      *
-     * At least one entry in the SupportedModes attribute shall include the Auto mode tag in the ModeTags field list.
-     *
-     * @see {@link MatterSpecification.v13.Cluster} § 8.7.4.1
+     * @see {@link MatterSpecification.v13.Cluster} § 8.7.5.1
      */
     export const TlvModeOption = TlvObject({
         /**
@@ -228,9 +203,7 @@ export namespace RefrigeratorAndTemperatureControlledCabinetMode {
      * 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.
      *
-     * At least one entry in the SupportedModes attribute shall include the Auto mode tag in the ModeTags field list.
-     *
-     * @see {@link MatterSpecification.v13.Cluster} § 8.7.4.1
+     * @see {@link MatterSpecification.v13.Cluster} § 8.7.5.1
      */
     export interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {}
 
@@ -240,23 +213,23 @@ export namespace RefrigeratorAndTemperatureControlledCabinetMode {
     export const Base = MutableCluster.Component({
         id: 0x52,
         name: "RefrigeratorAndTemperatureControlledCabinetMode",
-        revision: 2,
+        revision: 3,
 
         features: {
             /**
              * OnOff
              *
-             * This feature creates a dependency between an OnOff cluster instance and this cluster instance on the
-             * same endpoint. See OnMode for more information.
-             *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.10.4.1
+             * Dependency with the OnOff cluster
              */
             onOff: BitFlag(0)
         },
 
         attributes: {
             /**
-             * @see {@link MatterSpecification.v13.Cluster} § 8.7.5
+             * At least one entry in the SupportedModes attribute shall include the Auto mode tag in the ModeTags field
+             * list.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 8.7.6.1
              */
             supportedModes: FixedAttribute(
                 0x0,
@@ -265,19 +238,9 @@ export namespace RefrigeratorAndTemperatureControlledCabinetMode {
             ),
 
             /**
-             * @see {@link MatterSpecification.v13.Cluster} § 8.7.5
-             */
-            currentMode: Attribute(0x1, TlvUInt8, { scene: true, persistent: true }),
-
-            /**
-             * @see {@link MatterSpecification.v13.Cluster} § 8.7.5
-             */
-            startUpMode: WritableAttribute(0x2, TlvUInt8, { persistent: true }),
-
-            /**
-             * @see {@link MatterSpecification.v13.Cluster} § 8.7.5
+             * @see {@link MatterSpecification.v13.Cluster} § 8.7.6
              */
-            onMode: WritableAttribute(0x3, TlvUInt8, { persistent: true })
+            currentMode: Attribute(0x1, TlvUInt8, { persistent: true })
         },
 
         commands: {
@@ -295,7 +258,7 @@ export namespace RefrigeratorAndTemperatureControlledCabinetMode {
          * This metadata controls which RefrigeratorAndTemperatureControlledCabinetModeCluster elements matter.js
          * activates for specific feature combinations.
          */
-        extensions: MutableCluster.Extensions()
+        extensions: MutableCluster.Extensions({ flags: { onOff: true }, component: false })
     });
 
     /**
@@ -304,7 +267,7 @@ export namespace RefrigeratorAndTemperatureControlledCabinetMode {
     export const ClusterInstance = MutableCluster(Base);
 
     /**
-     * This cluster is derived from the Mode Base cluster, defining additional mode tags and namespaced enumerated
+     * This cluster is derived from the Mode Base cluster and defines additional mode tags and namespaced enumerated
      * values for refrigerator and temperature controlled cabinet devices.
      *
      * RefrigeratorAndTemperatureControlledCabinetModeCluster supports optional features that you can enable with the

package/src/clusters/relative-humidity-measurement.ts

@@ -48,7 +48,7 @@ export namespace RelativeHumidityMeasurement {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 2.6.4.2
              */
-            minMeasuredValue: Attribute(0x1, TlvNullable(TlvUInt16)),
+            minMeasuredValue: Attribute(0x1, TlvNullable(TlvUInt16.bound({ max: 9999 }))),
 
             /**
              * The MaxMeasuredValue attribute indicates the maximum value of MeasuredValue that can be measured. The