@matter/types 0.11.9-alpha.0-20241205-ccf69a00a → 0.11.9-alpha.0-20241207-b604cfa44

package/src/clusters/oven-mode.ts

@@ -15,10 +15,14 @@ import {
     Command,
     TlvNoResponse
 } from "../cluster/Cluster.js";
-import { TlvUInt8 } from "../tlv/TlvNumber.js";
+import { TlvUInt8, TlvEnum } from "../tlv/TlvNumber.js";
 import { TlvNullable } from "../tlv/TlvNullable.js";
 import { BitFlag } from "../schema/BitmapSchema.js";
 import { TlvArray } from "../tlv/TlvArray.js";
+import { TlvField, TlvOptionalField, TlvObject } from "../tlv/TlvObject.js";
+import { TlvString } from "../tlv/TlvString.js";
+import { TlvVendorId } from "../datatype/VendorId.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
 import { ModeBase } from "./mode-base.js";
 import { Identity } from "#general";
 import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
@@ -106,9 +110,184 @@ export namespace OvenMode {
         /**
          * @see {@link MatterSpecification.v13.Cluster} § 8.11.4.1
          */
-        Steam = 16393
+        Steam = 16393,
+
+        /**
+         * The device decides which options, features and setting values to use.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Auto = 0,
+
+        /**
+         * The mode of the device is optimizing for faster completion.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Quick = 1,
+
+        /**
+         * The device is silent or barely audible while in this mode.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Quiet = 2,
+
+        /**
+         * Either the mode is inherently low noise or the device optimizes for that.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        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
+         */
+        LowEnergy = 4,
+
+        /**
+         * A mode suitable for use during vacations or other extended absences.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Vacation = 5,
+
+        /**
+         * The mode uses the lowest available setting value.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Min = 6,
+
+        /**
+         * The mode uses the highest available setting value.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Max = 7,
+
+        /**
+         * The mode is recommended or suitable for use during night time.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Night = 8,
+
+        /**
+         * The mode is recommended or suitable for use during day time.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Day = 9
     }
 
+    /**
+     * 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
+     */
+    export const 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<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
+     */
+    export interface ModeTagStruct extends TypeFromSchema<typeof TlvModeTagStruct> {}
+
+    /**
+     * This is a struct representing a possible mode of the server.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2
+     */
+    export const 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(TlvModeTagStruct, { maxLength: 8 }))
+    });
+
+    /**
+     * This is a struct representing a possible mode of the server.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2
+     */
+    export interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {}
+
     /**
      * A OvenModeCluster supports these elements if it supports feature OnOff.
      */
@@ -158,7 +337,7 @@ export namespace OvenMode {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.10.6.2
              */
-            supportedModes: FixedAttribute(0x0, TlvArray(ModeBase.TlvModeOption, { minLength: 2, maxLength: 255 })),
+            supportedModes: FixedAttribute(0x0, TlvArray(TlvModeOption, { minLength: 2, maxLength: 255 })),
 
             /**
              * Indicates the current mode of the server.

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

@@ -787,7 +787,13 @@ export namespace PumpConfigurationAndControl {
                 0x21,
                 TlvEnum<ControlMode>(),
                 { persistent: true, default: ControlMode.ConstantSpeed, writeAcl: AccessLevel.Manage }
-            )
+            ),
+
+            /**
+             * @see {@link MatterSpecification.v13.Cluster} § 4.2.7
+             * @deprecated
+             */
+            alarmMask: OptionalAttribute(0x22, TlvUInt16, { persistent: true, default: 0 })
         },
 
         events: {

package/src/clusters/refrigerator-alarm.ts

@@ -8,9 +8,10 @@
 
 import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
 import { FixedAttribute, Command, TlvNoResponse, Attribute, Event, EventPriority } from "../cluster/Cluster.js";
-import { TlvUInt32 } from "../tlv/TlvNumber.js";
-import { AlarmBase } from "./alarm-base.js";
 import { BitFlag } from "../schema/BitmapSchema.js";
+import { TlvUInt32, TlvBitmap } from "../tlv/TlvNumber.js";
+import { TlvField, TlvObject } from "../tlv/TlvObject.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
 import { Identity } from "#general";
 import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
 
@@ -39,6 +40,73 @@ export namespace RefrigeratorAlarm {
         doorOpen: BitFlag(0)
     };
 
+    /**
+     * Input to the RefrigeratorAlarm reset command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1
+     */
+    export const TlvResetRequest = TlvObject({
+        /**
+         * This field shall indicate a bitmap where each bit set in this field corresponds to an alarm that shall be
+         * reset to inactive in the State attribute unless the alarm definition requires manual intervention. If the
+         * alarms indicated are successfully reset, the response status code shall be SUCCESS, otherwise, the response
+         * status code shall be FAILURE.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1.1
+         */
+        alarms: TlvField(0, TlvBitmap(TlvUInt32, Alarm))
+    });
+
+    /**
+     * Input to the RefrigeratorAlarm reset command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1
+     */
+    export interface ResetRequest extends TypeFromSchema<typeof TlvResetRequest> {}
+
+    /**
+     * Body of the RefrigeratorAlarm notify event
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1
+     */
+    export const TlvNotifyEvent = TlvObject({
+        /**
+         * This field shall indicate those alarms that have become active.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.1
+         */
+        active: TlvField(1, TlvBitmap(TlvUInt32, Alarm)),
+
+        /**
+         * This field shall indicate those alarms that have become inactive.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.2
+         */
+        inactive: TlvField(2, TlvBitmap(TlvUInt32, Alarm)),
+
+        /**
+         * This field shall be a copy of the new State attribute value that resulted in the event being generated. That
+         * is, this field shall have all the bits in Active set and shall NOT have any of the bits in Inactive set.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.4
+         */
+        state: TlvField(3, TlvBitmap(TlvUInt32, Alarm)),
+
+        /**
+         * This field shall be a copy of the Mask attribute when this event was generated.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.3
+         */
+        mask: TlvField(4, TlvBitmap(TlvUInt32, Alarm))
+    });
+
+    /**
+     * Body of the RefrigeratorAlarm notify event
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1
+     */
+    export interface NotifyEvent extends TypeFromSchema<typeof TlvNotifyEvent> {}
+
     /**
      * A RefrigeratorAlarmCluster supports these elements if it supports feature Reset.
      */
@@ -51,7 +119,7 @@ export namespace RefrigeratorAlarm {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.2
              */
-            latch: FixedAttribute(0x1, TlvUInt32)
+            latch: FixedAttribute(0x1, TlvBitmap(TlvUInt32, Alarm))
         },
 
         commands: {
@@ -61,7 +129,7 @@ export namespace RefrigeratorAlarm {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1
              */
-            reset: Command(0x0, AlarmBase.TlvResetRequest, 0x0, TlvNoResponse)
+            reset: Command(0x0, TlvResetRequest, 0x0, TlvNoResponse)
         }
     });
 
@@ -89,7 +157,7 @@ export namespace RefrigeratorAlarm {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.1
              */
-            mask: Attribute(0x0, TlvUInt32),
+            mask: Attribute(0x0, TlvBitmap(TlvUInt32, Alarm)),
 
             /**
              * Indicates a bitmap where each bit shall represent the state of an alarm. The value of true means the
@@ -97,7 +165,7 @@ export namespace RefrigeratorAlarm {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.3
              */
-            state: Attribute(0x2, TlvUInt32),
+            state: Attribute(0x2, TlvBitmap(TlvUInt32, Alarm)),
 
             /**
              * Indicates a bitmap where each bit shall represent whether or not an alarm is supported. The value of
@@ -107,7 +175,7 @@ export namespace RefrigeratorAlarm {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.4
              */
-            supported: FixedAttribute(0x3, TlvUInt32)
+            supported: FixedAttribute(0x3, TlvBitmap(TlvUInt32, Alarm))
         },
 
         events: {
@@ -116,7 +184,7 @@ export namespace RefrigeratorAlarm {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1
              */
-            notify: Event(0x0, EventPriority.Info, AlarmBase.TlvNotifyEvent)
+            notify: Event(0x0, EventPriority.Info, TlvNotifyEvent)
         },
 
         /**

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

@@ -10,8 +10,12 @@ import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
 import { BitFlag } from "../schema/BitmapSchema.js";
 import { FixedAttribute, Attribute, WritableAttribute, 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 { TlvUInt8 } from "../tlv/TlvNumber.js";
 import { Identity } from "#general";
 import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
 
@@ -46,9 +50,190 @@ export namespace RefrigeratorAndTemperatureControlledCabinetMode {
          *
          * @see {@link MatterSpecification.v13.Cluster} § 8.7.6.1.2
          */
-        RapidFreeze = 16385
+        RapidFreeze = 16385,
+
+        /**
+         * The device decides which options, features and setting values to use.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Auto = 0,
+
+        /**
+         * The mode of the device is optimizing for faster completion.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Quick = 1,
+
+        /**
+         * The device is silent or barely audible while in this mode.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Quiet = 2,
+
+        /**
+         * Either the mode is inherently low noise or the device optimizes for that.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        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
+         */
+        LowEnergy = 4,
+
+        /**
+         * A mode suitable for use during vacations or other extended absences.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Vacation = 5,
+
+        /**
+         * The mode uses the lowest available setting value.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Min = 6,
+
+        /**
+         * The mode uses the highest available setting value.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Max = 7,
+
+        /**
+         * The mode is recommended or suitable for use during night time.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Night = 8,
+
+        /**
+         * The mode is recommended or suitable for use during day time.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Day = 9
     }
 
+    /**
+     * 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
+     */
+    export const 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<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
+     */
+    export 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.
+     *
+     * 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
+     */
+    export const 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(TlvModeTagStruct, { maxLength: 8 }))
+    });
+
+    /**
+     * 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
+     */
+    export interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {}
+
     /**
      * These elements and properties are present in all RefrigeratorAndTemperatureControlledCabinetMode clusters.
      */
@@ -75,7 +260,7 @@ export namespace RefrigeratorAndTemperatureControlledCabinetMode {
              */
             supportedModes: FixedAttribute(
                 0x0,
-                TlvArray(ModeBase.TlvModeOption, { minLength: 2, maxLength: 255 }),
+                TlvArray(TlvModeOption, { minLength: 2, maxLength: 255 }),
                 { default: [] }
             ),