@matter/types 0.16.0-alpha.0-20251022-5a69ce65a → 0.16.0-alpha.0-20251027-17770fb28

package/src/clusters/label.ts

@@ -29,8 +29,9 @@ export namespace Label {
 
         /**
          * The Label or Value semantic is not defined here. The Value is a discriminator for a Label that may have
-         * multiple instances. Label:Value examples: "room":"bedroom 2", "orientation":"North", "floor":"2",
-         * "direction":"up"
+         * multiple instances.
+         *
+         * Label:Value examples: "room":"bedroom 2", "orientation":"North", "floor":"2", "direction":"up"
          *
          * @see {@link MatterSpecification.v141.Core} § 9.7.4.1.2
          */

package/src/clusters/laundry-washer-controls.ts

@@ -93,10 +93,10 @@ export namespace LaundryWasherControls {
              * spin speed, as such, this attribute can be an integer between 0 and the number of entries in SpinSpeeds -
              * 1. If a value is received that is outside of the defined constraints, a CONSTRAINT_ERROR shall be sent as
              * the response. If a value is attempted to be written that doesn’t match a valid index (e.g. an index of 5
-             * when the list has 4 values), a CONSTRAINT_ERROR shall be sent as the response. If null is written to this
-             * attribute, there will be no spin speed for the
+             * when the list has 4 values), a CONSTRAINT_ERROR shall be
              *
-             * selected cycle. If the value is null, there will be no spin speed on the current mode.
+             * sent as the response. If null is written to this attribute, there will be no spin speed for the selected
+             * cycle. If the value is null, there will be no spin speed on the current mode.
              *
              * @see {@link MatterSpecification.v141.Cluster} § 8.6.6.2
              */
@@ -118,7 +118,7 @@ export namespace LaundryWasherControls {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 8.6.6.3
              */
-            numberOfRinses: WritableAttribute(0x2, TlvEnum<NumberOfRinses>(), { default: NumberOfRinses.Normal }),
+            numberOfRinses: WritableAttribute(0x2, TlvEnum<NumberOfRinses>()),
 
             /**
              * Indicates the amount of rinses allowed for a specific mode. Each entry shall indicate a

package/src/clusters/laundry-washer-mode.ts

@@ -152,7 +152,7 @@ export namespace LaundryWasherMode {
     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.
+     * The table below lists the changes relative to the Mode Base cluster for the fields of the ModeOption Struct type.
      * A blank field indicates no change.
      *
      * @see {@link MatterSpecification.v141.Cluster} § 8.5.5.1
@@ -164,7 +164,7 @@ export namespace LaundryWasherMode {
     });
 
     /**
-     * The table below lists the changes relative to the Mode Base cluster for the fields of the ModeOptionStruct type.
+     * The table below lists the changes relative to the Mode Base cluster for the fields of the ModeOption Struct type.
      * A blank field indicates no change.
      *
      * @see {@link MatterSpecification.v141.Cluster} § 8.5.5.1

package/src/clusters/level-control.ts

@@ -60,7 +60,7 @@ export namespace LevelControl {
         /**
          * Frequency (FQ)
          *
-         * Supports frequency attributes and behavior.
+         * NOTE The Frequency feature is provisional.
          *
          * @see {@link MatterSpecification.v141.Cluster} § 1.6.4.3
          */
@@ -272,7 +272,7 @@ export namespace LevelControl {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.6.6.3
              */
-            remainingTime: Attribute(0x1, TlvUInt16, { default: 0 }),
+            remainingTime: Attribute(0x1, TlvUInt16),
 
             minLevel: OptionalAttribute(0x2, TlvUInt8.bound({ min: 1, max: 254 }), { default: 1 }),
 
@@ -314,8 +314,7 @@ export namespace LevelControl {
     export const FrequencyComponent = MutableCluster.Component({
         attributes: {
             /**
-             * This attribute shall indicate the frequency at which the device is at CurrentLevel. A CurrentFrequency of
-             * 0 is unknown.
+             * Indicates the frequency at which the device is at CurrentLevel. A CurrentFrequency of 0 is unknown.
              *
              * Changes to this attribute shall only be marked as reportable in the following cases:
              *
@@ -327,7 +326,7 @@ export namespace LevelControl {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.6.6.6
              */
-            currentFrequency: Attribute(0x4, TlvUInt16, { scene: true, default: 0 }),
+            currentFrequency: Attribute(0x4, TlvUInt16, { scene: true }),
 
             /**
              * Indicates the minimum value of CurrentFrequency that is capable of being assigned. MinFrequency shall be
@@ -335,7 +334,7 @@ export namespace LevelControl {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.6.6.7
              */
-            minFrequency: Attribute(0x5, TlvUInt16, { default: 0 }),
+            minFrequency: Attribute(0x5, TlvUInt16),
 
             /**
              * Indicates the maximum value of CurrentFrequency that is capable of being assigned. MaxFrequency shall be
@@ -343,7 +342,7 @@ export namespace LevelControl {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.6.6.8
              */
-            maxFrequency: Attribute(0x6, TlvUInt16, { default: 0 })
+            maxFrequency: Attribute(0x6, TlvUInt16)
         },
 
         commands: {
@@ -385,7 +384,7 @@ export namespace LevelControl {
             lighting: BitFlag(1),
 
             /**
-             * Supports frequency attributes and behavior.
+             * NOTE The Frequency feature is provisional.
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.6.4.3
              */
@@ -406,7 +405,7 @@ export namespace LevelControl {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.6.6.2
              */
-            currentLevel: Attribute(0x0, TlvNullable(TlvUInt8), { scene: true, persistent: true, default: null }),
+            currentLevel: Attribute(0x0, TlvNullable(TlvUInt8), { scene: true, persistent: true }),
 
             /**
              * Indicates the maximum value of CurrentLevel that is capable of being assigned.
@@ -462,7 +461,7 @@ export namespace LevelControl {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.6.6.11
              */
-            onLevel: WritableAttribute(0x11, TlvNullable(TlvUInt8), { default: null }),
+            onLevel: WritableAttribute(0x11, TlvNullable(TlvUInt8)),
 
             /**
              * Indicates the time taken to move the current level from the minimum level to the maximum level when an On

package/src/clusters/media-playback.ts

@@ -255,6 +255,8 @@ export namespace MediaPlayback {
     }
 
     /**
+     * This command is used to indicate the status of the command that was issued by the client.
+     *
      * This command shall be generated in response to various Playback Commands.
      *
      * @see {@link MatterSpecification.v141.Cluster} § 6.10.7.12
@@ -276,6 +278,8 @@ export namespace MediaPlayback {
     });
 
     /**
+     * This command is used to indicate the status of the command that was issued by the client.
+     *
      * This command shall be generated in response to various Playback Commands.
      *
      * @see {@link MatterSpecification.v141.Cluster} § 6.10.7.12
@@ -651,6 +655,8 @@ export namespace MediaPlayback {
          * This field shall indicate the updated start time as defined by the StartTime attribute, and has the same
          * constraint as that attribute.
          *
+         * This field value shall be 0 when the value of the StartTime attribute is NULL.
+         *
          * @see {@link MatterSpecification.v141.Cluster} § 6.10.8.1.2
          */
         startTime: TlvOptionalField(1, TlvEpochUs),
@@ -659,6 +665,8 @@ export namespace MediaPlayback {
          * This field shall indicate the updated duration as defined by the Duration attribute, and has the same
          * constraint as that attribute.
          *
+         * This field value shall be 0 when the value of the Duration attribute is NULL.
+         *
          * @see {@link MatterSpecification.v141.Cluster} § 6.10.8.1.3
          */
         duration: TlvOptionalField(2, TlvUInt64),
@@ -667,6 +675,9 @@ export namespace MediaPlayback {
          * This field shall indicate the updated position of playback as defined by the SampledPosition attribute, and
          * has the same constraint as that attribute.
          *
+         * The UpdatedAt field value of the PlaybackPositionStruct shall be 0, and the Position field value of the
+         * PlaybackPositionStruct shall be NULL, when the value of the SampledPosition attribute is NULL.
+         *
          * @see {@link MatterSpecification.v141.Cluster} § 6.10.8.1.4
          */
         sampledPosition: TlvOptionalField(3, TlvPlaybackPosition),
@@ -683,6 +694,8 @@ export namespace MediaPlayback {
          * This field shall indicate the updated start of the seek range end as defined by the SeekRangeEnd attribute,
          * and has the same constraint as that attribute.
          *
+         * This field value shall be 0 when the value of the SeekRangeEnd attribute is NULL.
+         *
          * @see {@link MatterSpecification.v141.Cluster} § 6.10.8.1.7
          */
         seekRangeEnd: TlvOptionalField(5, TlvUInt64),
@@ -691,6 +704,8 @@ export namespace MediaPlayback {
          * This field shall indicate the updated start of the seek range start as defined by the SeekRangeStart
          * attribute, and has the same constraint as that attribute.
          *
+         * This field value shall be 0 when the value of the SeekRangeStart attribute is NULL.
+         *
          * @see {@link MatterSpecification.v141.Cluster} § 6.10.8.1.6
          */
         seekRangeStart: TlvOptionalField(6, TlvUInt64),
@@ -809,7 +824,7 @@ export namespace MediaPlayback {
              * the start of the media. When the media has an associated StartTime, a value of null shall indicate that a
              * seek forward is valid only until the current time within the media, using a position computed from the
              * difference between the current time offset and StartTime, in milliseconds from start of the media,
-             * truncating fractional milliseconds towards 0. A value of Nas when StartTime is not specified shall
+             * truncating fractional milliseconds towards 0. A value of NULL when StartTime is not specified shall
              * indicate that seeking forward is not allowed.
              *
              * @see {@link MatterSpecification.v141.Cluster} § 6.10.6.7
@@ -818,7 +833,7 @@ export namespace MediaPlayback {
 
             /**
              * Indicates the earliest valid position to which a client may seek back, in milliseconds from start of the
-             * media. A value of Nas shall indicate that seeking backwards is not allowed.
+             * media. A value of NULL shall indicate that seeking backwards is not allowed.
              *
              * @see {@link MatterSpecification.v141.Cluster} § 6.10.6.6
              */
@@ -827,6 +842,8 @@ export namespace MediaPlayback {
 
         commands: {
             /**
+             * This command is used to seek to a specific position in the media.
+             *
              * Upon receipt, this shall change the playback position in the media to the given position.
              *
              * @see {@link MatterSpecification.v141.Cluster} § 6.10.7.11
@@ -860,6 +877,8 @@ export namespace MediaPlayback {
 
         commands: {
             /**
+             * This command is used to activate a specific Audio Track for the media being played.
+             *
              * Upon receipt, the server shall set the active Audio Track to the one identified by the TrackID in the
              * Track catalog for the streaming media. If the TrackID does not exist in the Track catalog, OR does not
              * correspond to the streaming media OR no media is being streamed at the time of receipt of this command,
@@ -897,6 +916,8 @@ export namespace MediaPlayback {
 
         commands: {
             /**
+             * This command is used to activate a specific Text Track for the media being played.
+             *
              * Upon receipt, the server shall set the active Text Track to the one identified by the TrackID in the
              * Track catalog for the streaming media. If the TrackID does not exist in the Track catalog, OR does not
              * correspond to the streaming media OR no media is being streamed at the time of receipt of this command,
@@ -907,6 +928,8 @@ export namespace MediaPlayback {
             activateTextTrack: Command(0xd, TlvActivateTextTrackRequest, 0xd, TlvNoResponse),
 
             /**
+             * This command is used to deactivate a specific Text Track for the media being played.
+             *
              * If a Text Track is active (i.e. being displayed), upon receipt of this command, the server shall stop
              * displaying it.
              *
@@ -922,6 +945,8 @@ export namespace MediaPlayback {
     export const VariableSpeedComponent = MutableCluster.Component({
         commands: {
             /**
+             * This command is used to rewind the media.
+             *
              * Upon receipt, this shall start playback of the media backward in case the media is currently playing in
              * the forward direction or is not playing. If the playback is already happening in the backwards direction
              * receipt of this command shall increase the speed of the media playback backwards.
@@ -939,6 +964,8 @@ export namespace MediaPlayback {
             rewind: Command(0x6, TlvRewindRequest, 0xa, TlvPlaybackResponse),
 
             /**
+             * This command is used to fast forward the media.
+             *
              * Upon receipt, this shall start playback of the media in the forward direction in case the media is
              * currently playing in the backward direction or is not playing. If the playback is already happening in
              * the forward direction receipt of this command shall increase the speed of the media playback.
@@ -1021,6 +1048,8 @@ export namespace MediaPlayback {
 
         commands: {
             /**
+             * This command is used to start playback of the media.
+             *
              * Upon receipt, this shall play media. If content is currently in a FastForward or Rewind state. Play shall
              * return media to normal playback speed.
              *
@@ -1029,13 +1058,16 @@ export namespace MediaPlayback {
             play: Command(0x0, TlvNoArguments, 0xa, TlvPlaybackResponse),
 
             /**
-             * Upon receipt, this shall pause playback of the media.
+             * This command is used to pause playback of the media. Upon receipt, this shall pause playback of the
+             * media.
              *
              * @see {@link MatterSpecification.v141.Cluster} § 6.10.7.2
              */
             pause: Command(0x1, TlvNoArguments, 0xa, TlvPlaybackResponse),
 
             /**
+             * This command is used to stop playback of the media.
+             *
              * Upon receipt, this shall stop playback of the media. User-visible outcome is context-specific. This may
              * navigate the user back to the location from where the media was originally launched.
              *
@@ -1044,13 +1076,16 @@ export namespace MediaPlayback {
             stop: Command(0x2, TlvNoArguments, 0xa, TlvPlaybackResponse),
 
             /**
-             * Upon receipt, this shall Start Over with the current media playback item.
+             * This command is used to start playback of the media from the beginning. Upon receipt, this shall Start
+             * Over with the current media playback item.
              *
              * @see {@link MatterSpecification.v141.Cluster} § 6.10.7.4
              */
             startOver: OptionalCommand(0x3, TlvNoArguments, 0xa, TlvPlaybackResponse),
 
             /**
+             * This command is used to go back to the previous media playback item.
+             *
              * Upon receipt, this shall cause the handler to be invoked for "Previous". User experience is
              * context-specific. This will often Go back to the previous media playback item.
              *
@@ -1059,6 +1094,8 @@ export namespace MediaPlayback {
             previous: OptionalCommand(0x4, TlvNoArguments, 0xa, TlvPlaybackResponse),
 
             /**
+             * This command is used to go to the next media playback item.
+             *
              * Upon receipt, this shall cause the handler to be invoked for "Next". User experience is context-specific.
              * This will often Go forward to the next media playback item.
              *
@@ -1067,6 +1104,8 @@ export namespace MediaPlayback {
             next: OptionalCommand(0x5, TlvNoArguments, 0xa, TlvPlaybackResponse),
 
             /**
+             * This command is used to skip forward in the media.
+             *
              * Upon receipt, this shall Skip forward in the media by the given number of milliseconds.
              *
              * @see {@link MatterSpecification.v141.Cluster} § 6.10.7.9
@@ -1074,6 +1113,8 @@ export namespace MediaPlayback {
             skipForward: OptionalCommand(0x8, TlvSkipForwardRequest, 0xa, TlvPlaybackResponse),
 
             /**
+             * This command is used to skip backward in the media.
+             *
              * Upon receipt, this shall Skip backward in the media by the given number of milliseconds.
              *
              * @see {@link MatterSpecification.v141.Cluster} § 6.10.7.10

package/src/clusters/messages.ts

@@ -444,7 +444,7 @@ export namespace Messages {
 
         /**
          * This field shall indicate the MessageResponseID selected by the user. If there was no response before the
-         * Duration of the message has elapsed, this field shall be null.
+         * Duration field of the message has elapsed, this field shall be null.
          *
          * @see {@link MatterSpecification.v141.Cluster} § 1.16.8.3.2
          */
@@ -589,8 +589,8 @@ export namespace Messages {
             messagePresented: Event(0x1, Priority.Info, TlvMessagePresentedEvent),
 
             /**
-             * This event shall be generated when the message is confirmed by the user, or when the Duration of the
-             * message has elapsed without confirmation.
+             * This event shall be generated when the message is confirmed by the user, or when the Duration field of
+             * the message has elapsed without confirmation.
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.16.8.3
              */

package/src/clusters/microwave-oven-control.ts

@@ -180,14 +180,14 @@ export namespace MicrowaveOvenControl {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 8.13.5.4
              */
-            minPower: FixedAttribute(0x3, TlvUInt8.bound({ min: 1, max: 99 }), { default: 10 }),
+            minPower: FixedAttribute(0x3, TlvUInt8.bound({ min: 1, max: 99 })),
 
             /**
              * Indicates the maximum value to which the PowerSetting attribute that can be set on the server.
              *
              * @see {@link MatterSpecification.v141.Cluster} § 8.13.5.5
              */
-            maxPower: FixedAttribute(0x4, TlvUInt8.bound({ max: 100 }), { default: 100 }),
+            maxPower: FixedAttribute(0x4, TlvUInt8.bound({ max: 100 })),
 
             /**
              * Indicates the increment of power that can be set on the server. The value of this attribute shall be
@@ -200,7 +200,7 @@ export namespace MicrowaveOvenControl {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 8.13.5.6
              */
-            powerStep: FixedAttribute(0x5, TlvUInt8, { default: 10 })
+            powerStep: FixedAttribute(0x5, TlvUInt8)
         }
     });
 
@@ -261,7 +261,7 @@ export namespace MicrowaveOvenControl {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 8.13.5.1
              */
-            cookTime: Attribute(0x0, TlvUInt32.bound({ min: 1 }), { default: 30 }),
+            cookTime: Attribute(0x0, TlvUInt32.bound({ min: 1 })),
 
             /**
              * Indicates the maximum value to which the CookTime attribute can be set.

package/src/clusters/microwave-oven-mode.ts

@@ -175,6 +175,9 @@ export namespace MicrowaveOvenMode {
          * 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.
          *
+         * Each mode tag in this field shall be distinct from other mode tags in this field. For example, a simplified
+         * list containing [Auto, Auto] would not be allowed.
+         *
          * A few examples are provided below.
          *
          *   • A mode named "100%" can have both the High (manufacturer specific) and Max (standard) mode tag. Clients

package/src/clusters/mode-base.ts

@@ -169,6 +169,9 @@ export namespace ModeBase {
          * 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.
          *
+         * Each mode tag in this field shall be distinct from other mode tags in this field. For example, a simplified
+         * list containing [Auto, Auto] would not be allowed.
+         *
          * A few examples are provided below.
          *
          *   • A mode named "100%" can have both the High (manufacturer specific) and Max (standard) mode tag. Clients
@@ -306,7 +309,7 @@ export namespace ModeBase {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.10.6.4
              */
-            onMode: WritableAttribute(0x3, TlvNullable(TlvUInt8), { persistent: true, default: null })
+            onMode: WritableAttribute(0x3, TlvNullable(TlvUInt8), { persistent: true })
         }
     });
 
@@ -337,6 +340,16 @@ export namespace ModeBase {
              * Each entry in this list shall have a unique value for the Mode field. Each entry in this list shall have
              * a unique value for the Label field.
              *
+             * The set of ModeTags listed in each entry in this list shall be distinct from the sets of ModeTags listed
+             * in the other entries. This comparison shall NOT depend on the order of the ModeTags in the lists. Two
+             * sets shall be considered distinct if one of them contains an element that the other one does not. Note
+             * that the two sets could have a non-empty intersection, or one could be a subset of the other, and still
+             * be distinct.
+             *
+             * Simplified examples of allowed ModeTags lists:
+             *
+             * Simplified examples of disallowed ModeTags lists:
+             *
              * @see {@link MatterSpecification.v141.Cluster} § 1.10.6.1
              */
             supportedModes: FixedAttribute(0x0, TlvArray(TlvModeOption, { minLength: 2, maxLength: 255 })),
@@ -360,7 +373,7 @@ export namespace ModeBase {
              *
              * If this attribute is not null, the CurrentMode attribute shall be set to the StartUpMode value, when the
              * server is powered up, except in the case when the OnMode attribute overrides the StartUpMode attribute
-             * (see OnModeWithPowerUp).
+             * (see Section 1.10.6.4.1, “OnMode with Power Up”).
              *
              * This behavior does not apply to reboots associated with OTA. After an OTA restart, the CurrentMode
              * attribute shall return to its value prior to the restart.

package/src/clusters/mode-select.ts

@@ -38,7 +38,7 @@ export namespace ModeSelect {
          * 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.
+         * endpoint. See Section 1.9.6.6, “OnMode Attribute” for more information.
          *
          * @see {@link MatterSpecification.v141.Cluster} § 1.9.4.1
          */
@@ -169,7 +169,7 @@ export namespace ModeSelect {
         features: {
             /**
              * This feature creates a dependency between an OnOff cluster instance and this cluster instance on the same
-             * endpoint. See OnMode for more information.
+             * endpoint. See Section 1.9.6.6, “OnMode Attribute” for more information.
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.9.4.1
              */
@@ -224,7 +224,7 @@ export namespace ModeSelect {
              *
              * If this attribute is not null, the CurrentMode attribute shall be set to the StartUpMode value, when the
              * server is powered up, except in the case when the OnMode attribute overrides the StartUpMode attribute
-             * (see OnModeWithPowerUp).
+             * (see Section 1.9.6.6.1, “OnMode with Power Up”).
              *
              * This behavior does not apply to reboots associated with OTA. After an OTA restart, the CurrentMode
              * attribute shall return to its value prior to the restart.