@matter/types 0.13.0-alpha.0-20250329-cd36948da → 0.13.0-alpha.0-20250330-df5a17eba

package/src/clusters/administrator-commissioning.ts

@@ -25,7 +25,7 @@ export namespace AdministratorCommissioning {
     /**
      * These are optional features supported by AdministratorCommissioningCluster.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.19.4
+     * @see {@link MatterSpecification.v14.Core} § 11.19.4
      */
     export enum Feature {
         /**
@@ -39,7 +39,7 @@ export namespace AdministratorCommissioning {
     /**
      * Input to the AdministratorCommissioning openBasicCommissioningWindow command
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.19.8.2
+     * @see {@link MatterSpecification.v14.Core} § 11.19.8.2
      */
     export const TlvOpenBasicCommissioningWindowRequest = TlvObject({
         /**
@@ -55,7 +55,7 @@ export namespace AdministratorCommissioning {
          *
          *   • There is an armed fail-safe timer.
          *
-         * @see {@link MatterSpecification.v13.Core} § 11.19.8.2.1
+         * @see {@link MatterSpecification.v14.Core} § 11.19.8.2.1
          */
         commissioningTimeout: TlvField(0, TlvUInt16)
     });
@@ -63,12 +63,12 @@ export namespace AdministratorCommissioning {
     /**
      * Input to the AdministratorCommissioning openBasicCommissioningWindow command
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.19.8.2
+     * @see {@link MatterSpecification.v14.Core} § 11.19.8.2
      */
     export interface OpenBasicCommissioningWindowRequest extends TypeFromSchema<typeof TlvOpenBasicCommissioningWindowRequest> {}
 
     /**
-     * @see {@link MatterSpecification.v13.Core} § 11.19.5.1
+     * @see {@link MatterSpecification.v14.Core} § 11.19.5.1
      */
     export enum CommissioningWindowStatus {
         /**
@@ -90,7 +90,7 @@ export namespace AdministratorCommissioning {
     /**
      * Input to the AdministratorCommissioning openCommissioningWindow command
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.19.8.1
+     * @see {@link MatterSpecification.v14.Core} § 11.19.8.1
      */
     export const TlvOpenCommissioningWindowRequest = TlvObject({
         /**
@@ -100,7 +100,7 @@ export namespace AdministratorCommissioning {
          * 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
+         * @see {@link MatterSpecification.v14.Core} § 11.19.8.1.1
          */
         commissioningTimeout: TlvField(0, TlvUInt16),
 
@@ -113,7 +113,7 @@ export namespace AdministratorCommissioning {
          * 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
+         * @see {@link MatterSpecification.v14.Core} § 11.19.8.1.2
          */
         pakePasscodeVerifier: TlvField(1, TlvByteString.bound({ length: 97 })),
 
@@ -122,7 +122,7 @@ export namespace AdministratorCommissioning {
          * Discriminator) for discovery by the new Administrator. The new Administrator can find and filter DNS-SD
          * records by long discriminator to locate and initiate commissioning with the appropriate Node.
          *
-         * @see {@link MatterSpecification.v13.Core} § 11.19.8.1.3
+         * @see {@link MatterSpecification.v14.Core} § 11.19.8.1.3
          */
         discriminator: TlvField(2, TlvUInt16.bound({ max: 4095 })),
 
@@ -133,7 +133,7 @@ export namespace AdministratorCommissioning {
          * 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
+         * @see {@link MatterSpecification.v14.Core} § 11.19.8.1.4
          */
         iterations: TlvField(3, TlvUInt32.bound({ min: 1000, max: 100000 })),
 
@@ -153,7 +153,7 @@ export namespace AdministratorCommissioning {
          *
          *   • There is an armed fail-safe timer.
          *
-         * @see {@link MatterSpecification.v13.Core} § 11.19.8.1.5
+         * @see {@link MatterSpecification.v14.Core} § 11.19.8.1.5
          */
         salt: TlvField(4, TlvByteString.bound({ minLength: 16, maxLength: 32 }))
     });
@@ -161,12 +161,12 @@ export namespace AdministratorCommissioning {
     /**
      * Input to the AdministratorCommissioning openCommissioningWindow command
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.19.8.1
+     * @see {@link MatterSpecification.v14.Core} § 11.19.8.1
      */
     export interface OpenCommissioningWindowRequest extends TypeFromSchema<typeof TlvOpenCommissioningWindowRequest> {}
 
     /**
-     * @see {@link MatterSpecification.v13.Core} § 11.19.6.1
+     * @see {@link MatterSpecification.v14.Core} § 11.19.6.1
      */
     export enum StatusCode {
         /**
@@ -209,7 +209,7 @@ export namespace AdministratorCommissioning {
              * command, see Section 5.5, “Commissioning Flows”. The new Administrator shall discover the Node on the IP
              * network using DNS-based Service Discovery (DNS-SD) for commissioning.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.19.8.2
+             * @see {@link MatterSpecification.v14.Core} § 11.19.8.2
              */
             openBasicCommissioningWindow: Command(
                 0x1,
@@ -251,7 +251,7 @@ export namespace AdministratorCommissioning {
              * OpenBasicCommissioningWindow command, and therefore this attribute shall be set to WindowNotOpen on
              * initial commissioning.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.19.7.1
+             * @see {@link MatterSpecification.v14.Core} § 11.19.7.1
              */
             windowStatus: Attribute(0x0, TlvEnum<CommissioningWindowStatus>()),
 
@@ -265,7 +265,7 @@ export namespace AdministratorCommissioning {
              *
              * When the WindowStatus attribute is set to WindowNotOpen, this attribute shall be set to null.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.19.7.2
+             * @see {@link MatterSpecification.v14.Core} § 11.19.7.2
              */
             adminFabricIndex: Attribute(0x1, TlvNullable(TlvFabricIndex)),
 
@@ -278,7 +278,7 @@ export namespace AdministratorCommissioning {
              *
              * When the WindowStatus attribute is set to WindowNotOpen, this attribute shall be set to null.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.19.7.3
+             * @see {@link MatterSpecification.v14.Core} § 11.19.7.3
              */
             adminVendorId: Attribute(0x2, TlvNullable(TlvVendorId))
         },
@@ -317,7 +317,7 @@ export namespace AdministratorCommissioning {
              *
              * In case of any other parameter error, this command shall fail with a status code of COMMAND_INVALID.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.19.8.1
+             * @see {@link MatterSpecification.v14.Core} § 11.19.8.1
              */
             openCommissioningWindow: Command(
                 0x0,
@@ -342,7 +342,7 @@ export namespace AdministratorCommissioning {
              *
              * in Section 11.10.7.2.2, “Behavior on expiry of Fail-Safe timer”.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.19.8.3
+             * @see {@link MatterSpecification.v14.Core} § 11.19.8.3
              */
             revokeCommissioning: Command(
                 0x2,
@@ -393,7 +393,7 @@ export namespace AdministratorCommissioning {
      * AdministratorCommissioningCluster supports optional features that you can enable with the
      * AdministratorCommissioningCluster.with() factory method.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.19
+     * @see {@link MatterSpecification.v14.Core} § 11.19
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

package/src/clusters/air-quality.ts

@@ -17,7 +17,7 @@ export namespace AirQuality {
     /**
      * These are optional features supported by AirQualityCluster.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 2.9.4
+     * @see {@link MatterSpecification.v14.Cluster} § 2.9.4
      */
     export enum Feature {
         /**
@@ -53,7 +53,7 @@ export namespace AirQuality {
      * The AirQualityEnum provides a representation of the quality of the analyzed air. It is up to the device
      * manufacturer to determine the mapping between the measured values and their corresponding enumeration values.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 2.9.5.1
+     * @see {@link MatterSpecification.v14.Cluster} § 2.9.5.1
      */
     export enum AirQualityEnum {
         /**
@@ -134,7 +134,7 @@ export namespace AirQuality {
             /**
              * Indicates a value from AirQualityEnum that is indicative of the currently measured air quality.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 2.9.6.1
+             * @see {@link MatterSpecification.v14.Cluster} § 2.9.6.1
              */
             airQuality: Attribute(0x0, TlvEnum<AirQualityEnum>(), { default: AirQualityEnum.Unknown })
         },
@@ -158,7 +158,7 @@ export namespace AirQuality {
      * AirQualityCluster supports optional features that you can enable with the AirQualityCluster.with() factory
      * method.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 2.9
+     * @see {@link MatterSpecification.v14.Cluster} § 2.9
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

package/src/clusters/alarm-base.ts

@@ -26,7 +26,7 @@ export namespace AlarmBase {
     /**
      * These are optional features supported by AlarmBaseCluster.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.15.4
+     * @see {@link MatterSpecification.v14.Cluster} § 1.15.4
      */
     export enum Feature {
         /**
@@ -34,7 +34,7 @@ export namespace AlarmBase {
          *
          * This feature indicates that alarms can be reset via the Reset command.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.15.4.1
+         * @see {@link MatterSpecification.v14.Cluster} § 1.15.4.1
          */
         Reset = "Reset"
     }
@@ -42,7 +42,7 @@ export namespace AlarmBase {
     /**
      * Input to the AlarmBase reset command
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.1
      */
     export const TlvResetRequest = TlvObject({
         /**
@@ -51,7 +51,7 @@ export namespace AlarmBase {
          * 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
+         * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.1.1
          */
         alarms: TlvField(0, TlvUInt32)
     });
@@ -59,14 +59,14 @@ export namespace AlarmBase {
     /**
      * Input to the AlarmBase reset command
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.1
      */
     export interface ResetRequest extends TypeFromSchema<typeof TlvResetRequest> {}
 
     /**
      * Input to the AlarmBase modifyEnabledAlarms command
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.2
      */
     export const TlvModifyEnabledAlarmsRequest = TlvObject({
         /**
@@ -88,7 +88,7 @@ export namespace AlarmBase {
          * 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
+         * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.2.1
          */
         mask: TlvField(0, TlvUInt32)
     });
@@ -96,27 +96,27 @@ export namespace AlarmBase {
     /**
      * Input to the AlarmBase modifyEnabledAlarms command
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.2
      */
     export interface ModifyEnabledAlarmsRequest extends TypeFromSchema<typeof TlvModifyEnabledAlarmsRequest> {}
 
     /**
      * Body of the AlarmBase notify event
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1
+     * @see {@link MatterSpecification.v14.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
+         * @see {@link MatterSpecification.v14.Cluster} § 1.15.8.1.1
          */
         active: TlvField(0, TlvUInt32),
 
         /**
          * This field shall indicate those alarms that have become inactive.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.2
+         * @see {@link MatterSpecification.v14.Cluster} § 1.15.8.1.2
          */
         inactive: TlvField(1, TlvUInt32),
 
@@ -124,14 +124,14 @@ export namespace AlarmBase {
          * 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
+         * @see {@link MatterSpecification.v14.Cluster} § 1.15.8.1.4
          */
         state: TlvField(2, TlvUInt32),
 
         /**
          * 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
+         * @see {@link MatterSpecification.v14.Cluster} § 1.15.8.1.3
          */
         mask: TlvField(3, TlvUInt32)
     });
@@ -139,7 +139,7 @@ export namespace AlarmBase {
     /**
      * Body of the AlarmBase notify event
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.15.8.1
      */
     export interface NotifyEvent extends TypeFromSchema<typeof TlvNotifyEvent> {}
 
@@ -153,7 +153,7 @@ export namespace AlarmBase {
              * will be latched when set, and will not reset to inactive when the underlying condition which caused the
              * alarm is no longer present, and so requires an explicit reset using the Reset command.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.2
+             * @see {@link MatterSpecification.v14.Cluster} § 1.15.6.2
              */
             latch: FixedAttribute(0x1, TlvUInt32)
         },
@@ -163,7 +163,7 @@ export namespace AlarmBase {
              * This command resets active and latched alarms (if possible). Any generated Notify event shall contain
              * fields that represent the state of the server after the command has been processed.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1
+             * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.1
              */
             reset: Command(0x0, TlvResetRequest, 0x0, TlvNoResponse)
         }
@@ -180,7 +180,7 @@ export namespace AlarmBase {
              *
              * This feature indicates that alarms can be reset via the Reset command.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.15.4.1
+             * @see {@link MatterSpecification.v14.Cluster} § 1.15.4.1
              */
             reset: BitFlag(0)
         },
@@ -193,7 +193,7 @@ export namespace AlarmBase {
              * Indicates a bitmap where each bit set in the Mask attribute corresponds to an alarm that shall be
              * enabled.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.1
+             * @see {@link MatterSpecification.v14.Cluster} § 1.15.6.1
              */
             mask: Attribute(0x0, TlvUInt32),
 
@@ -201,7 +201,7 @@ export namespace AlarmBase {
              * Indicates a bitmap where each bit shall represent the state of an alarm. The value of true means the
              * alarm is active, otherwise the alarm is inactive.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.3
+             * @see {@link MatterSpecification.v14.Cluster} § 1.15.6.3
              */
             state: Attribute(0x2, TlvUInt32),
 
@@ -211,7 +211,7 @@ export namespace AlarmBase {
              *
              * If an alarm is not supported, the corresponding bit in Mask, Latch, and State shall be false.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.4
+             * @see {@link MatterSpecification.v14.Cluster} § 1.15.6.4
              */
             supported: FixedAttribute(0x3, TlvUInt32)
         },
@@ -220,7 +220,7 @@ export namespace AlarmBase {
             /**
              * This command allows a client to request that an alarm be enabled or suppressed at the server.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2
+             * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.2
              */
             modifyEnabledAlarms: OptionalCommand(0x1, TlvModifyEnabledAlarmsRequest, 0x1, TlvNoResponse)
         },
@@ -229,7 +229,7 @@ export namespace AlarmBase {
             /**
              * This event shall be generated when one or more alarms change state, and shall have these fields:
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1
+             * @see {@link MatterSpecification.v14.Cluster} § 1.15.8.1
              */
             notify: Event(0x0, EventPriority.Info, TlvNotifyEvent)
         },

package/src/clusters/application-basic.ts

@@ -22,7 +22,7 @@ export namespace ApplicationBasic {
     /**
      * This indicates a global identifier for an Application given a catalog.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.3.4.2
+     * @see {@link MatterSpecification.v14.Cluster} § 6.3.4.2
      */
     export const TlvApplication = TlvObject({
         /**
@@ -33,7 +33,7 @@ export namespace ApplicationBasic {
          * will have their own catalog vendor ID (set to their own Vendor ID) and will assign an ApplicationID to each
          * Content App.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 6.3.4.2.1
+         * @see {@link MatterSpecification.v14.Cluster} § 6.3.4.2.1
          */
         catalogVendorId: TlvField(0, TlvUInt16),
 
@@ -43,7 +43,7 @@ export namespace ApplicationBasic {
          *
          * For the DIAL registry catalog, this value shall be the DIAL prefix.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 6.3.4.2.2
+         * @see {@link MatterSpecification.v14.Cluster} § 6.3.4.2.2
          */
         applicationId: TlvField(1, TlvString)
     });
@@ -51,12 +51,12 @@ export namespace ApplicationBasic {
     /**
      * This indicates a global identifier for an Application given a catalog.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.3.4.2
+     * @see {@link MatterSpecification.v14.Cluster} § 6.3.4.2
      */
     export interface Application extends TypeFromSchema<typeof TlvApplication> {}
 
     /**
-     * @see {@link MatterSpecification.v13.Cluster} § 6.3.4.1
+     * @see {@link MatterSpecification.v14.Cluster} § 6.3.4.1
      */
     export enum ApplicationStatus {
         /**
@@ -92,7 +92,7 @@ export namespace ApplicationBasic {
             /**
              * This attribute shall specify a human readable (displayable) name of the vendor for the Content App.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.1
+             * @see {@link MatterSpecification.v14.Cluster} § 6.3.5.1
              */
             vendorName: OptionalFixedAttribute(0x0, TlvString.bound({ maxLength: 32 })),
 
@@ -100,7 +100,7 @@ export namespace ApplicationBasic {
              * This attribute, if present, shall specify the Connectivity Standards Alliance assigned Vendor ID for the
              * Content App.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.2
+             * @see {@link MatterSpecification.v14.Cluster} § 6.3.5.2
              */
             vendorId: OptionalFixedAttribute(0x1, TlvVendorId),
 
@@ -109,7 +109,7 @@ export namespace ApplicationBasic {
              * vendor. For example, "NPR On Demand". The maximum length of the ApplicationName attribute is 256 bytes of
              * UTF-8 characters.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.3
+             * @see {@link MatterSpecification.v14.Cluster} § 6.3.5.3
              */
             applicationName: FixedAttribute(0x2, TlvString),
 
@@ -118,21 +118,21 @@ export namespace ApplicationBasic {
              * Content App made by them. If the Content App is certified by the Connectivity Standards Alliance, then
              * this would be the Product ID as specified by the vendor for the certification.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.4
+             * @see {@link MatterSpecification.v14.Cluster} § 6.3.5.4
              */
             productId: OptionalFixedAttribute(0x3, TlvUInt16),
 
             /**
              * This attribute shall specify a Content App which consists of an Application ID using a specified catalog.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.5
+             * @see {@link MatterSpecification.v14.Cluster} § 6.3.5.5
              */
             application: FixedAttribute(0x4, TlvApplication),
 
             /**
              * This attribute shall specify the current running status of the application.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.6
+             * @see {@link MatterSpecification.v14.Cluster} § 6.3.5.6
              */
             status: Attribute(0x5, TlvEnum<ApplicationStatus>()),
 
@@ -140,14 +140,14 @@ export namespace ApplicationBasic {
              * This attribute shall specify a human readable (displayable) version of the Content App assigned by the
              * vendor. The maximum length of the ApplicationVersion attribute is 32 bytes of UTF-8 characters.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.7
+             * @see {@link MatterSpecification.v14.Cluster} § 6.3.5.7
              */
             applicationVersion: FixedAttribute(0x6, TlvString.bound({ maxLength: 32 })),
 
             /**
              * This attribute is a list of vendor IDs. Each entry is a vendor-id.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.8
+             * @see {@link MatterSpecification.v14.Cluster} § 6.3.5.8
              */
             allowedVendorList: FixedAttribute(
                 0x7,
@@ -164,7 +164,7 @@ export namespace ApplicationBasic {
      * The cluster server for this cluster should be supported on each endpoint that represents a Content App on a Video
      * Player device. This cluster provides identification information about the Content App such as vendor and product.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.3
+     * @see {@link MatterSpecification.v14.Cluster} § 6.3
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}