@matter/types 0.12.6-alpha.0-20250304-03716637c → 0.13.0-alpha.0-20250307-ebf84a05a

package/src/clusters/actions.ts

@@ -41,8 +41,9 @@ export namespace Actions {
          * Can be used to set a static state of the associated endpoints (typically using InstantAction or
          * InstantActionWithTransition), or to bring these endpoints into a more dynamic state (typically using
          * StartAction), where the endpoints would e.g. gradually cycle through certain colors for a pleasing effect. A
-         * voice controller could use "set" (to map to InstantAction) or "play" (to map to StartAction) to trigger such
-         * actions.
+         * voice controller could use "set" (to map to InstantAction) or "play" (to map to StartAction) to trig
+         *
+         * ger such actions.
          *
          * Example: see examples 1 and 2.
          *
@@ -223,7 +224,7 @@ export namespace Actions {
          *
          * @see {@link MatterSpecification.v13.Core} § 9.14.4.6.2
          */
-        name: TlvField(1, TlvString.bound({ maxLength: 32 })),
+        name: TlvField(1, TlvString.bound({ maxLength: 128 })),
 
         /**
          * This field shall indicate the type of action. The value of Type of an action, along with its
@@ -300,8 +301,9 @@ export namespace Actions {
         /**
          * User-configured group of endpoints where an endpoint can be in any number of zones
          *
-         * Is a more general concept where an endpoint can be part of multiple zones, e.g. a light in the living room
-         * can be part of the "reading corner" zone (subset of the lights in the living room) but also part of the
+         * Is a more general concept where an endpoint can be part of multiple zones, e.g. a light in the living
+         *
+         * room can be part of the "reading corner" zone (subset of the lights in the living room) but also part of the
          * "downstairs" zone which contains all the lights on a floor, e.g. combining living room, kitchen and hallway.
          * This indicates that a user has defined this list of endpoints as something they logically would like to
          * control as a group, so Matter controllers could provide the user with a way to do as such.
@@ -332,7 +334,7 @@ export namespace Actions {
          *
          * @see {@link MatterSpecification.v13.Core} § 9.14.4.7.2
          */
-        name: TlvField(1, TlvString.bound({ maxLength: 32 })),
+        name: TlvField(1, TlvString.bound({ maxLength: 128 })),
 
         /**
          * This field shall indicate the type of endpoint list, see EndpointListTypeEnum.
@@ -717,8 +719,8 @@ export namespace Actions {
 
             /**
              * The SetupURL attribute (when provided) shall indicate a URL; its syntax shall follow the syntax as
-             * specified in RFC 3986, max. 512 ASCII characters. The location referenced by this URL shall provide
-             * additional information for the actions provided:
+             * specified in RFC 1738, max. 512 ASCII characters and shall use the https scheme. The location referenced
+             * by this URL shall provide additional information for the actions provided:
              *
              *   • When used without suffix, it shall provide information about the various actions which the cluster
              *     provides.
@@ -949,9 +951,8 @@ export namespace Actions {
      *
      *   • Information about logical grouping of endpoints on the Node (example: lights in a room)
      *
-     *   • Information about named actions that can be performed on such a group of endpoints
-     *
-     * ple: recall a scene for a group of lights by its name)
+     *   • Information about named actions that can be performed on such a group of endpoints (example: recall a scene
+     *     for a group of lights by its name)
      *
      *   • Commands to trigger such actions
      *

package/src/clusters/administrator-commissioning.ts

@@ -44,13 +44,12 @@ export namespace AdministratorCommissioning {
     export const TlvOpenBasicCommissioningWindowRequest = TlvObject({
         /**
          * This field shall specify the time in seconds during which commissioning session establishment is allowed by
-         * the Node. This is known as Open Basic Commissioning Window (OBCW). This timeout shall follow guidance as
-         * specified in the initial Announcement Duration.
+         * the Node. This timeout shall follow guidance as specified in the initial Announcement Duration.
          *
-         * When a Node receives the Open Basic Commissioning Window command, it shall begin advertising on DNS-SD as
-         * described in Section 4.3.1, “Commissionable Node Discovery” and for a time period as described in Section
-         * 11.19.8.2.1, “CommissioningTimeout Field”. When the command is received by a ICD, it shall enter into active
-         * mode. The ICD shall remain in Active Mode as long as one of these conditions is met:
+         * When a Node receives the OpenBasicCommissioningWindow command, it shall begin advertising on DNS-SD as
+         * described in Section 4.3.1, “Commissionable Node Discovery” and for a time period as described in
+         * CommissioningTimeout. When the command is received by a ICD, it shall enter into active mode. The ICD shall
+         * remain in Active Mode as long as one of these conditions is met:
          *
          *   • A commissioning window is open.
          *
@@ -96,10 +95,10 @@ export namespace AdministratorCommissioning {
     export const TlvOpenCommissioningWindowRequest = TlvObject({
         /**
          * This field shall specify the time in seconds during which commissioning session establishment is allowed by
-         * the Node. This is known as Open Commissioning Window (OCW). This timeout value shall follow guidance as
-         * specified in the initial Announcement Duration. The CommissioningTimeout applies only to cessation of any
-         * announcements and to accepting of new commissioning sessions; it does not apply to abortion of connections,
-         * i.e., a commissioning session SHOULD NOT abort prematurely upon expiration of this timeout.
+         * the Node. This timeout value shall follow guidance as specified in the initial Announcement Duration. The
+         * CommissioningTimeout applies only to cessation of any announcements and to accepting of new commissioning
+         * sessions; it does not apply to abortion of connections, i.e., a commissioning session SHOULD NOT abort
+         * prematurely upon expiration of this timeout.
          *
          * @see {@link MatterSpecification.v13.Core} § 11.19.8.1.1
          */
@@ -111,7 +110,8 @@ export namespace AdministratorCommissioning {
          * concatenation of two values (w0 || L) shall be (CRYPTO_GROUP_SIZE_BYTES +
          * CRYPTO_PUBLIC_KEY_SIZE_BYTES)-octets long as detailed in Crypto_PAKEValues_Responder. It shall be derived
          * from an ephemeral passcode (See PAKE). It shall be deleted by the Node at the end of commissioning or
-         * expiration of OCW, and shall be deleted by the existing Administrator after sending it to the Node(s).
+         * expiration of the OpenCommissioningWindow command, and shall be deleted by the existing Administrator after
+         * sending it to the Node(s).
          *
          * @see {@link MatterSpecification.v13.Core} § 11.19.8.1.2
          */
@@ -129,10 +129,9 @@ export namespace AdministratorCommissioning {
         /**
          * This field shall be used by the Node as the PAKE iteration count associated with the ephemeral PAKE passcode
          * verifier to be used for this commissioning, which shall be sent by the Node to the new Administrator’s
-         * software as response to the PBKDFParamRequest during PASE negotiation.
-         *
-         * The permitted range of values shall match the range specified in Section 3.9, “Password-Based Key Derivation
-         * Function (PBKDF)”, within the definition of the Crypto_PBKDFParameterSet.
+         * software as response to the PBKDFParamRequest during PASE negotiation. The permitted range of values shall
+         * match the range specified in Section 3.9, “Password-Based Key Derivation Function (PBKDF)”, within the
+         * definition of the Crypto_PBKDFParameterSet.
          *
          * @see {@link MatterSpecification.v13.Core} § 11.19.8.1.4
          */
@@ -146,9 +145,9 @@ export namespace AdministratorCommissioning {
          * Crypto_PBKDFParameterSet.
          *
          * When a Node receives the Open Commissioning Window command, it shall begin advertising on DNS-SD as
-         * described in Section 4.3.1, “Commissionable Node Discovery” and for a time period as described in Section
-         * 11.19.8.1.1, “CommissioningTimeout Field”. When the command is received by a ICD, it shall enter into active
-         * mode. The ICD shall remain in Active Mode as long as one of these conditions is met:
+         * described in Section 4.3.1, “Commissionable Node Discovery” and for a time period as described in
+         * CommissioningTimeout. When the command is received by a ICD, it shall enter into active mode. The ICD shall
+         * remain in Active Mode as long as one of these conditions is met:
          *
          *   • A commissioning window is open.
          *
@@ -195,7 +194,7 @@ export namespace AdministratorCommissioning {
              * This command may be used by a current Administrator to instruct a Node to go into commissioning mode, if
              * the node supports the Basic Commissioning Method. The Basic Commissioning Method specifies a window of
              * time during which an already commissioned Node accepts PASE sessions. The current Administrator shall
-             * specify a timeout value for the duration of OBCW.
+             * specify a timeout value for the duration of the OpenBasicCommissioningWindow command.
              *
              * If a commissioning window is already currently open, this command shall fail with a cluster specific
              * status code of Busy.
@@ -241,13 +240,16 @@ export namespace AdministratorCommissioning {
 
         attributes: {
             /**
-             * Indicates whether a new Commissioning window has been opened by an Administrator, using either the OCW
-             * command or the OBCW command.
+             * Indicates whether a new Commissioning window has been opened by an Administrator, using either the
+             * OpenCommissioningWindow command or the OpenBasicCommissioningWindow command.
              *
              * This attribute shall revert to WindowNotOpen upon expiry of a commissioning window.
              *
-             * Note that an initial commissioning window is not opened using either the OCW command or the OBCW
-             * command, and therefore this attribute shall be set to WindowNotOpen on initial commissioning.
+             * NOTE
+             *
+             * An initial commissioning window is not opened using either the OpenCommissioningWindow command or the
+             * OpenBasicCommissioningWindow command, and therefore this attribute shall be set to WindowNotOpen on
+             * initial commissioning.
              *
              * @see {@link MatterSpecification.v13.Core} § 11.19.7.1
              */
@@ -285,13 +287,15 @@ export namespace AdministratorCommissioning {
             /**
              * This command is used by a current Administrator to instruct a Node to go into commissioning mode. The
              * Enhanced Commissioning Method specifies a window of time during which an already commissioned Node
-             * accepts PASE sessions. The current Administrator MUST specify a timeout value for the duration of OCW.
+             * accepts PASE sessions. The current Administrator MUST specify a timeout value for the duration of the
+             * OpenCommissioningWindow command.
+             *
+             * When the OpenCommissioningWindow command expires or commissioning completes, the Node shall remove the
+             * Passcode by deleting the PAKE passcode verifier as well as stop publishing the DNS-SD record
+             * corresponding to this command as described in Section 4.3.1, “Commissionable
              *
-             * When OCW expires or commissioning completes, the Node shall remove the Passcode by deleting the PAKE
-             * passcode verifier as well as stop publishing the DNS-SD record corresponding to this command as
-             * described in Section 4.3.1, “Commissionable Node Discovery”. The commissioning into a new Fabric
-             * completes when the Node successfully receives a CommissioningComplete command, see Section 5.5,
-             * “Commissioning Flows”.
+             * Node Discovery”. The commissioning into a new Fabric completes when the Node successfully receives a
+             * CommissioningComplete command, see Section 5.5, “Commissioning Flows”.
              *
              * The parameters for OpenCommissioningWindow command are as follows:
              *
@@ -324,18 +328,19 @@ export namespace AdministratorCommissioning {
             ),
 
             /**
-             * This command is used by a current Administrator to instruct a Node to revoke any active Open
-             * Commissioning Window or Open Basic Commissioning Window command. This is an idempotent command and the
+             * This command is used by a current Administrator to instruct a Node to revoke any active
+             * OpenCommissioningWindow or OpenBasicCommissioningWindow command. This is an idempotent command and the
              * Node shall (for ECM) delete the temporary PAKEPasscodeVerifier and associated data, and stop publishing
-             * the DNS-SD record associated with the Open Commissioning Window or Open Basic Commissioning Window
-             * command, see Section 4.3.1, “Commissionable Node Discovery”.
+             * the DNS-SD record associated with the OpenCommissioningWindow or OpenBasicCommissioningWindow command,
+             * see Section 4.3.1, “Commissionable Node Discovery”.
              *
              * If no commissioning window was open at time of receipt, this command shall fail with a cluster specific
              * status code of WindowNotOpen.
              *
              * If the commissioning window was open and the fail-safe was armed when this command is received, the
-             * device shall immediately expire the fail-safe and perform the cleanup steps outlined in Section
-             * 11.10.6.2.2, “Behavior on expiry of Fail-Safe timer”.
+             * device shall immediately expire the fail-safe and perform the cleanup steps outlined
+             *
+             * in Section 11.10.7.2.2, “Behavior on expiry of Fail-Safe timer”.
              *
              * @see {@link MatterSpecification.v13.Core} § 11.19.8.3
              */
@@ -371,6 +376,20 @@ export namespace AdministratorCommissioning {
      * For the management of Operational Credentials and Trusted Root Certificates, the Node Operational Credentials
      * cluster is used.
      *
+     * If the Administrator Commissioning Cluster server instance is present on an endpoint with the Root Node device
+     * type in the Descriptor cluster DeviceTypeList, then:
+     *
+     *   • The Commissioning Window shall be opened or closed on the node that the Root Node endpoint is on.
+     *
+     *   • The attributes shall indicate the state of the node that the Root Node endpoint is on.
+     *
+     * If the Administrator Commissioning Cluster server instance is present on an endpoint with the Bridged Node
+     * device type in the Descriptor cluster DeviceTypeList, then:
+     *
+     *   • The Commissioning Window shall be opened or closed on the node represented by the Bridged Node.
+     *
+     *   • The attributes shall indicate the state of the node that is represented by the Bridged Node.
+     *
      * AdministratorCommissioningCluster supports optional features that you can enable with the
      * AdministratorCommissioningCluster.with() factory method.
      *

package/src/clusters/alarm-base.ts

@@ -84,10 +84,9 @@ export namespace AlarmBase {
          * alarm shall respond with a status code of FAILURE; otherwise the server shall respond with a status code of
          * SUCCESS.
          *
-         * On a SUCCESS case, the server shall also change the value of the Mask attribute to the value of the
-         *
-         * Mask field from this command. After that the server shall also update the value of its State attribute to
-         * reflect the status of the new alarm set as indicated by the new value of the Mask attribute.
+         * On a SUCCESS case, the server shall also change the value of the Mask attribute to the value of the Mask
+         * field from this command. After that the server shall also update the value of its State attribute to reflect
+         * the status of the new alarm set as indicated by the new value of the Mask attribute.
          *
          * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2.1
          */

package/src/clusters/application-launcher.ts

@@ -131,14 +131,29 @@ export namespace ApplicationLauncher {
         Success = 0,
 
         /**
-         * Requested app is not available.
+         * Requested app is not available
          */
         AppNotAvailable = 1,
 
         /**
-         * Video platform unable to honor command.
+         * Video platform unable to honor command
          */
-        SystemBusy = 2
+        SystemBusy = 2,
+
+        /**
+         * User approval for app download is pending
+         */
+        PendingUserApproval = 3,
+
+        /**
+         * Downloading the requested app
+         */
+        Downloading = 4,
+
+        /**
+         * Installing the requested app
+         */
+        Installing = 5
     }
 
     /**
@@ -235,7 +250,7 @@ export namespace ApplicationLauncher {
     export const Base = MutableCluster.Component({
         id: 0x50c,
         name: "ApplicationLauncher",
-        revision: 1,
+        revision: 2,
 
         features: {
             /**
@@ -308,10 +323,10 @@ export namespace ApplicationLauncher {
              * The endpoint may decide to stop the application based on manufacturer specific behavior or resource
              * constraints if any. The Status attribute shall be updated to ActiveHidden or Stopped, depending on the
              * action taken, on the Application Basic cluster of the Endpoint corresponding to the application on which
-             * the action was taken. The Status attribute shall be updated on any other
+             * the action was taken. The Status attribute shall be updated on any other application whose Status may
+             * have changed as a result of this command.
              *
-             * application whose Status may have changed as a result of this command. This command returns a Launcher
-             * Response.
+             * This command returns a Launcher Response.
              *
              * @see {@link MatterSpecification.v13.Cluster} § 6.4.7.3
              */

package/src/clusters/ballast-configuration.ts

@@ -110,15 +110,15 @@ export namespace BallastConfiguration {
             minLevel: WritableAttribute(0x10, TlvUInt8, { writeAcl: AccessLevel.Manage }),
 
             /**
-             * This attribute shall specify the light output of the ballast according to the dimming light curve
+             * This attribute shall specify the light output of the ballast according to the dimming light curve (see
+             * Dimming Curve) when the Level Control Cluster’s CurrentLevel attribute equals to 254 (and the On/Off
+             * Cluster’s OnOff attribute equals to TRUE).
              *
-             * (see Dimming Curve) when the Level Control Cluster’s CurrentLevel attribute equals to 254 (and the
-             * On/Off Cluster’s OnOff attribute equals to TRUE).
+             * The value of this attribute shall be both less than or equal to PhysicalMaxLevel and greater than
              *
-             * The value of this attribute shall be both less than or equal to PhysicalMaxLevel and greater than or
-             * equal to MinLevel. If an attempt is made to set this attribute to a level where these conditions are not
-             * met, a response shall be returned with status code set to CONSTRAINT_ERROR, and the level shall NOT be
-             * set.
+             * or equal to MinLevel. If an attempt is made to set this attribute to a level where these conditions are
+             * not met, a response shall be returned with status code set to CONSTRAINT_ERROR, and the level shall NOT
+             * be set.
              *
              * @see {@link MatterSpecification.v13.Cluster} § 3.3.6.5
              */

package/src/clusters/basic-information.ts

@@ -315,7 +315,7 @@ export namespace BasicInformation {
     export const ClusterInstance = MutableCluster({
         id: 0x28,
         name: "BasicInformation",
-        revision: 3,
+        revision: 4,
 
         attributes: {
             /**
@@ -453,10 +453,10 @@ export namespace BasicInformation {
             partNumber: OptionalFixedAttribute(0xc, TlvString.bound({ maxLength: 32 })),
 
             /**
-             * This attribute shall specify a link to a product specific web page. The syntax of the ProductURL
-             * attribute shall follow the syntax as specified in RFC 3986 [https://tools.ietf.org/html/rfc3986]. The
-             * specified URL SHOULD resolve to a maintained web page available for the lifetime of the product. The
-             * maximum length of the ProductUrl attribute is 256 ASCII characters.
+             * This attribute shall specify a link to a product specific web page. The specified URL SHOULD resolve to
+             * a maintained web page available for the lifetime of the product. The syntax of this attribute shall
+             * follow the syntax as specified in RFC 1738 and shall use the https scheme. The maximum length of this
+             * attribute is 256 ASCII characters.
              *
              * @see {@link MatterSpecification.v13.Core} § 11.1.5.14
              */
@@ -505,24 +505,34 @@ export namespace BasicInformation {
             reachable: OptionalAttribute(0x11, TlvBoolean, { default: true }),
 
             /**
-             * This attribute (when used) shall indicate a unique identifier for the device, which is constructed in a
-             * manufacturer specific manner.
+             * Indicates a unique identifier for the device, which is constructed in a manufacturer specific manner.
              *
              * It may be constructed using a permanent device identifier (such as device MAC address) as basis. In
              * order to prevent tracking,
              *
              *   • it SHOULD NOT be identical to (or easily derived from) such permanent device identifier
              *
-             *   • it SHOULD be updated when the device is factory reset
+             *   • it shall be updated when the device is factory reset
              *
-             *   • it shall not be identical to the SerialNumber attribute
+             *   • it shall NOT be identical to the SerialNumber attribute
              *
-             *   • it shall not be printed on the product or delivered with the product The value does not need to be
-             *     human readable.
+             *   • it shall NOT be printed on the product or delivered with the product
+             *
+             * The value does not need to be human readable, since it is intended for machine to machine (M2M)
+             * communication.
+             *
+             * NOTE
+             *
+             * NOTE
+             *
+             * The conformance of the UniqueID attribute was optional in cluster revisions prior to revision 4.
+             *
+             * This UniqueID attribute shall NOT be the same as the Persistent Unique ID which is used in the Rotating
+             * Device Identifier mechanism.
              *
              * @see {@link MatterSpecification.v13.Core} § 11.1.5.19
              */
-            uniqueId: OptionalFixedAttribute(0x12, TlvString.bound({ maxLength: 32 })),
+            uniqueId: FixedAttribute(0x12, TlvString.bound({ maxLength: 32 })),
 
             /**
              * This attribute shall provide the minimum guaranteed value for some system-wide resource capabilities
@@ -535,8 +545,9 @@ export namespace BasicInformation {
              * provided in this attribute.
              *
              * Note that since the fixed values within this attribute may change over time, both increasing and
-             * decreasing, as software versions change for a given Node, clients SHOULD take care not to assume forever
-             * unchanging values and SHOULD NOT cache this value permanently at Commissioning time.
+             * decreasing, as software versions change for a given Node, clients SHOULD take care not to assume
+             *
+             * forever unchanging values and SHOULD NOT cache this value permanently at Commissioning time.
              *
              * @see {@link MatterSpecification.v13.Core} § 11.1.5.20
              */
@@ -595,9 +606,8 @@ export namespace BasicInformation {
              * Indicates the maximum number of elements in a single InvokeRequests list (see Section 8.8.2, “Invoke
              * Request Action”) that the Node is able to process. Note that since this attribute may change over time,
              * both increasing and decreasing, as software versions change for a given Node, clients SHOULD take care
-             * not to assume forever unchanging values and SHOULD NOT
-             *
-             * cache this value permanently at Commissioning time.
+             * not to assume forever unchanging values and SHOULD NOT cache this value permanently at Commissioning
+             * time.
              *
              * If the MaxPathsPerInvoke attribute is absent or zero, such as in Basic Information cluster revisions
              * prior to Revision 3, clients shall assume a value of 1.
@@ -634,10 +644,8 @@ export namespace BasicInformation {
              * generated, it SHOULD be assumed that the fabric recorded in the event is no longer usable, and
              * subsequent interactions targeting that fabric will most likely fail.
              *
-             * Upon receipt of Leave Event on a subscription, the receiving Node may update other nodes in the
-             *
-             * fabric by removing related bindings, access control list entries and other data referencing the leaving
-             * Node.
+             * Upon receipt of Leave Event on a subscription, the receiving Node may update other nodes in the fabric
+             * by removing related bindings, access control list entries and other data referencing the leaving Node.
              *
              * @see {@link MatterSpecification.v13.Core} § 11.1.6.3
              */