@matter/types 0.13.0-alpha.0-20250328-6dde053de → 0.13.0-alpha.0-20250330-df5a17eba

package/src/clusters/basic-information.ts

@@ -35,7 +35,7 @@ export namespace BasicInformation {
      * This structure provides constant values related to overall global capabilities of this Node, that are not
      * cluster-specific.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.1.4.4
+     * @see {@link MatterSpecification.v14.Core} § 11.1.4.4
      */
     export const TlvCapabilityMinima = TlvObject({
         /**
@@ -45,7 +45,7 @@ export namespace BasicInformation {
          * This value shall NOT be smaller than the required minimum indicated in Section 4.14.2.8, “Minimal Number of
          * CASE Sessions”.
          *
-         * @see {@link MatterSpecification.v13.Core} § 11.1.4.4.1
+         * @see {@link MatterSpecification.v14.Core} § 11.1.4.4.1
          */
         caseSessionsPerFabric: TlvField(0, TlvUInt16.bound({ min: 3 })),
 
@@ -55,7 +55,7 @@ export namespace BasicInformation {
          * This value shall NOT be smaller than the required minimum indicated in Section 8.5.1, “Subscribe
          * Transaction”.
          *
-         * @see {@link MatterSpecification.v13.Core} § 11.1.4.4.2
+         * @see {@link MatterSpecification.v14.Core} § 11.1.4.4.2
          */
         subscriptionsPerFabric: TlvField(1, TlvUInt16.bound({ min: 3 }))
     });
@@ -64,14 +64,14 @@ export namespace BasicInformation {
      * This structure provides constant values related to overall global capabilities of this Node, that are not
      * cluster-specific.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.1.4.4
+     * @see {@link MatterSpecification.v14.Core} § 11.1.4.4
      */
     export interface CapabilityMinima extends TypeFromSchema<typeof TlvCapabilityMinima> {}
 
     /**
      * The data type of ProductFinishEnum is derived from enum8.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.1.4.1
+     * @see {@link MatterSpecification.v14.Core} § 11.1.4.1
      */
     export enum ProductFinish {
         /**
@@ -108,7 +108,7 @@ export namespace BasicInformation {
     /**
      * The data type of ColorEnum is derived from enum8.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.1.4.2
+     * @see {@link MatterSpecification.v14.Core} § 11.1.4.2
      */
     export enum Color {
         /**
@@ -220,13 +220,13 @@ export namespace BasicInformation {
     /**
      * This structure provides a description of the product’s appearance.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.1.4.3
+     * @see {@link MatterSpecification.v14.Core} § 11.1.4.3
      */
     export const TlvProductAppearance = TlvObject({
         /**
          * This field shall indicate the visible finish of the product.
          *
-         * @see {@link MatterSpecification.v13.Core} § 11.1.4.3.1
+         * @see {@link MatterSpecification.v14.Core} § 11.1.4.3.1
          */
         finish: TlvField(0, TlvEnum<ProductFinish>()),
 
@@ -234,7 +234,7 @@ export namespace BasicInformation {
          * This field indicates the representative color of the visible parts of the product. If the product has no
          * representative color, the field shall be null.
          *
-         * @see {@link MatterSpecification.v13.Core} § 11.1.4.3.2
+         * @see {@link MatterSpecification.v14.Core} § 11.1.4.3.2
          */
         primaryColor: TlvField(1, TlvNullable(TlvEnum<Color>()))
     });
@@ -242,20 +242,20 @@ export namespace BasicInformation {
     /**
      * This structure provides a description of the product’s appearance.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.1.4.3
+     * @see {@link MatterSpecification.v14.Core} § 11.1.4.3
      */
     export interface ProductAppearance extends TypeFromSchema<typeof TlvProductAppearance> {}
 
     /**
      * Body of the BasicInformation startUp event
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.1.6.1
+     * @see {@link MatterSpecification.v14.Core} § 11.1.6.1
      */
     export const TlvStartUpEvent = TlvObject({
         /**
          * This field shall be set to the same value as the one available in the SoftwareVersion attribute.
          *
-         * @see {@link MatterSpecification.v13.Core} § 11.1.6.1.1
+         * @see {@link MatterSpecification.v14.Core} § 11.1.6.1.1
          */
         softwareVersion: TlvField(0, TlvUInt32)
     });
@@ -263,20 +263,20 @@ export namespace BasicInformation {
     /**
      * Body of the BasicInformation startUp event
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.1.6.1
+     * @see {@link MatterSpecification.v14.Core} § 11.1.6.1
      */
     export interface StartUpEvent extends TypeFromSchema<typeof TlvStartUpEvent> {}
 
     /**
      * Body of the BasicInformation leave event
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.1.6.3
+     * @see {@link MatterSpecification.v14.Core} § 11.1.6.3
      */
     export const TlvLeaveEvent = TlvObject({
         /**
          * This field shall contain the local Fabric Index of the fabric which the node is about to leave.
          *
-         * @see {@link MatterSpecification.v13.Core} § 11.1.6.3.1
+         * @see {@link MatterSpecification.v14.Core} § 11.1.6.3.1
          */
         fabricIndex: TlvField(0, TlvFabricIndex)
     });
@@ -284,20 +284,20 @@ export namespace BasicInformation {
     /**
      * Body of the BasicInformation leave event
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.1.6.3
+     * @see {@link MatterSpecification.v14.Core} § 11.1.6.3
      */
     export interface LeaveEvent extends TypeFromSchema<typeof TlvLeaveEvent> {}
 
     /**
      * Body of the BasicInformation reachableChanged event
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.1.6.4
+     * @see {@link MatterSpecification.v14.Core} § 11.1.6.4
      */
     export const TlvReachableChangedEvent = TlvObject({
         /**
          * This field shall indicate the value of the Reachable attribute after it was changed.
          *
-         * @see {@link MatterSpecification.v13.Core} § 11.1.6.4.1
+         * @see {@link MatterSpecification.v14.Core} § 11.1.6.4.1
          */
         reachableNewValue: TlvField(0, TlvBoolean)
     });
@@ -305,7 +305,7 @@ export namespace BasicInformation {
     /**
      * Body of the BasicInformation reachableChanged event
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.1.6.4
+     * @see {@link MatterSpecification.v14.Core} § 11.1.6.4
      */
     export interface ReachableChangedEvent extends TypeFromSchema<typeof TlvReachableChangedEvent> {}
 
@@ -322,21 +322,21 @@ export namespace BasicInformation {
              * This attribute shall be set to the revision number of the Data Model against which the Node is certified.
              * The value of this attribute shall be one of the valid values listed in Section 7.1.1, “Revision History”.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.1
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.1
              */
             dataModelRevision: FixedAttribute(0x0, TlvUInt16),
 
             /**
              * This attribute shall specify a human readable (displayable) name of the vendor for the Node.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.2
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.2
              */
             vendorName: FixedAttribute(0x1, TlvString.bound({ maxLength: 32 })),
 
             /**
              * This attribute shall specify the Vendor ID.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.3
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.3
              */
             vendorId: FixedAttribute(0x2, TlvVendorId),
 
@@ -344,7 +344,7 @@ export namespace BasicInformation {
              * This attribute shall specify a human readable (displayable) name of the model for the Node such as the
              * model number (or other identifier) assigned by the vendor.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.4
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.4
              */
             productName: FixedAttribute(0x3, TlvString.bound({ maxLength: 32 })),
 
@@ -352,7 +352,7 @@ export namespace BasicInformation {
              * This attribute shall specify the Product ID assigned by the vendor that is unique to the specific product
              * of the Node.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.5
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.5
              */
             productId: FixedAttribute(0x4, TlvUInt16),
 
@@ -360,7 +360,7 @@ export namespace BasicInformation {
              * Indicates a user defined name for the Node. This attribute SHOULD be set during initial commissioning and
              * may be updated by further reconfigurations.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.6
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.6
              */
             nodeLabel: WritableAttribute(
                 0x5,
@@ -380,7 +380,7 @@ export namespace BasicInformation {
              * avoiding region-specific assumptions as much as is practical. The special value XX shall indicate that
              * region-agnostic mode is used.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.7
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.7
              */
             location: WritableAttribute(
                 0x6,
@@ -392,7 +392,7 @@ export namespace BasicInformation {
              * This attribute shall specify the version number of the hardware of the Node. The meaning of its value,
              * and the versioning scheme, are vendor defined.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.8
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.8
              */
             hardwareVersion: FixedAttribute(0x7, TlvUInt16, { default: 0 }),
 
@@ -401,7 +401,7 @@ export namespace BasicInformation {
              * and the versioning scheme, are vendor defined. The HardwareVersionString attribute shall be used to
              * provide a more user-friendly value than that represented by the HardwareVersion attribute.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.9
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.9
              */
             hardwareVersionString: FixedAttribute(0x8, TlvString.bound({ minLength: 1, maxLength: 64 })),
 
@@ -413,7 +413,7 @@ export namespace BasicInformation {
              * software updates (see Section 11.20.3.3, “Availability of Software Images”). Nodes may query this field
              * to determine the currently running version of software on another given Node.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.10
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.10
              */
             softwareVersion: FixedAttribute(0x9, TlvUInt32, { default: 0 }),
 
@@ -425,7 +425,7 @@ export namespace BasicInformation {
              *
              * Examples of version strings include "1.0", "1.2.3456", "1.2-2", "1.0b123", "1.2_3".
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.11
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.11
              */
             softwareVersionString: FixedAttribute(0xa, TlvString.bound({ minLength: 1, maxLength: 64 })),
 
@@ -435,7 +435,7 @@ export namespace BasicInformation {
              * YYYYMMDD, e.g., 20060814. The final 8 characters may include country, factory, line, shift or other
              * related information at the option of the vendor. The format of this information is vendor defined.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.12
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.12
              */
             manufacturingDate: OptionalFixedAttribute(0xb, TlvString.bound({ minLength: 8, maxLength: 16 })),
 
@@ -447,7 +447,7 @@ export namespace BasicInformation {
              * packaging (with different PartNumbers) for different regions; also different colors of a product might
              * share the ProductID but may have a different PartNumber.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.13
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.13
              */
             partNumber: OptionalFixedAttribute(0xc, TlvString.bound({ maxLength: 32 })),
 
@@ -457,7 +457,7 @@ export namespace BasicInformation {
              * 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
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.14
              */
             productUrl: OptionalFixedAttribute(0xd, TlvString.bound({ maxLength: 256 })),
 
@@ -467,14 +467,14 @@ export namespace BasicInformation {
              * ProductName attribute. The ProductLabel attribute SHOULD NOT include the name of the vendor as defined
              * within the VendorName attribute.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.15
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.15
              */
             productLabel: OptionalFixedAttribute(0xe, TlvString.bound({ maxLength: 64 })),
 
             /**
              * This attribute shall specify a human readable (displayable) serial number.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.16
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.16
              */
             serialNumber: OptionalFixedAttribute(0xf, TlvString.bound({ maxLength: 32 })),
 
@@ -484,7 +484,7 @@ export namespace BasicInformation {
              * the LocalConfigDisabled attribute shall NOT in any way modify, disable, or otherwise affect the user’s
              * ability to trigger a factory reset on the Node.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.17
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.17
              */
             localConfigDisabled: OptionalWritableAttribute(
                 0x10,
@@ -499,7 +499,7 @@ export namespace BasicInformation {
              * Its main use case is in the derived Bridged Device Basic Information cluster where it is used to indicate
              * whether the bridged device is reachable by the bridge over the non-native network.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.18
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.18
              */
             reachable: OptionalAttribute(0x11, TlvBoolean, { default: true }),
 
@@ -529,7 +529,7 @@ export namespace BasicInformation {
              * 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
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.19
              */
             uniqueId: FixedAttribute(0x12, TlvString.bound({ maxLength: 32 })),
 
@@ -548,7 +548,7 @@ export namespace BasicInformation {
              *
              * forever unchanging values and SHOULD NOT cache this value permanently at Commissioning time.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.20
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.20
              */
             capabilityMinima: FixedAttribute(
                 0x13,
@@ -560,7 +560,7 @@ export namespace BasicInformation {
              * This attribute shall provide information about the appearance of the product, which could be useful to a
              * user trying to locate or identify the node.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.21
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.21
              */
             productAppearance: OptionalFixedAttribute(0x14, TlvProductAppearance),
 
@@ -597,7 +597,7 @@ export namespace BasicInformation {
              * Comparison of SpecificationVersion shall always include the total value over 32 bits, without masking
              * reserved parts.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.22
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.22
              */
             specificationVersion: FixedAttribute(0x15, TlvUInt32, { default: 0 }),
 
@@ -611,7 +611,7 @@ export namespace BasicInformation {
              * 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.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.5.23
+             * @see {@link MatterSpecification.v14.Core} § 11.1.5.23
              */
             maxPathsPerInvoke: FixedAttribute(0x16, TlvUInt16.bound({ min: 1 }), { default: 1 })
         },
@@ -622,7 +622,7 @@ export namespace BasicInformation {
              * process. The StartUp event SHOULD be the first Data Model event recorded by the Node after it completes a
              * boot or reboot process.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.6.1
+             * @see {@link MatterSpecification.v14.Core} § 11.1.6.1
              */
             startUp: Event(0x0, EventPriority.Critical, TlvStartUpEvent),
 
@@ -632,7 +632,7 @@ export namespace BasicInformation {
              * This event SHOULD be delivered urgently to current subscribers on a best- effort basis. Any subsequent
              * incoming interactions to the Node may be dropped until the completion of a future boot or reboot process.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.6.2
+             * @see {@link MatterSpecification.v14.Core} § 11.1.6.2
              */
             shutDown: OptionalEvent(0x1, EventPriority.Critical, TlvNoArguments),
 
@@ -646,7 +646,7 @@ export namespace BasicInformation {
              * 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
+             * @see {@link MatterSpecification.v14.Core} § 11.1.6.3
              */
             leave: OptionalEvent(0x2, EventPriority.Info, TlvLeaveEvent),
 
@@ -657,7 +657,7 @@ export namespace BasicInformation {
              *
              * Its main use case is in the derived Bridged Device Basic Information cluster.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.1.6.4
+             * @see {@link MatterSpecification.v14.Core} § 11.1.6.4
              */
             reachableChanged: OptionalEvent(0x3, EventPriority.Info, TlvReachableChangedEvent)
         }
@@ -668,7 +668,7 @@ export namespace BasicInformation {
      * Commissioning and operational determination of Node characteristics, such as Vendor ID, Product ID and serial
      * number, which apply to the whole Node.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.1
+     * @see {@link MatterSpecification.v14.Core} § 11.1
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

package/src/clusters/binding.ts

@@ -22,13 +22,13 @@ import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
 
 export namespace Binding {
     /**
-     * @see {@link MatterSpecification.v13.Core} § 9.6.5.1
+     * @see {@link MatterSpecification.v14.Core} § 9.6.5.1
      */
     export const TlvTarget = TlvObject({
         /**
          * This field is the remote target node ID. If the Endpoint field is present, this field shall be present.
          *
-         * @see {@link MatterSpecification.v13.Core} § 9.6.5.1.1
+         * @see {@link MatterSpecification.v14.Core} § 9.6.5.1.1
          */
         node: TlvOptionalField(1, TlvNodeId),
 
@@ -36,7 +36,7 @@ export namespace Binding {
          * This field is the target group ID that represents remote endpoints. If the Endpoint field is present, this
          * field shall NOT be present.
          *
-         * @see {@link MatterSpecification.v13.Core} § 9.6.5.1.2
+         * @see {@link MatterSpecification.v14.Core} § 9.6.5.1.2
          */
         group: TlvOptionalField(2, TlvGroupId),
 
@@ -44,7 +44,7 @@ export namespace Binding {
          * This field is the remote endpoint that the local endpoint is bound to. If the Group field is present, this
          * field shall NOT be present.
          *
-         * @see {@link MatterSpecification.v13.Core} § 9.6.5.1.3
+         * @see {@link MatterSpecification.v14.Core} § 9.6.5.1.3
          */
         endpoint: TlvOptionalField(3, TlvEndpointNumber),
 
@@ -53,7 +53,7 @@ export namespace Binding {
          * the client cluster shall also exist on this endpoint (with this Binding cluster). If this field is present,
          * the target shall be this cluster on the target endpoint(s).
          *
-         * @see {@link MatterSpecification.v13.Core} § 9.6.5.1.4
+         * @see {@link MatterSpecification.v14.Core} § 9.6.5.1.4
          */
         cluster: TlvOptionalField(4, TlvClusterId),
 
@@ -61,7 +61,7 @@ export namespace Binding {
     });
 
     /**
-     * @see {@link MatterSpecification.v13.Core} § 9.6.5.1
+     * @see {@link MatterSpecification.v14.Core} § 9.6.5.1
      */
     export interface Target extends TypeFromSchema<typeof TlvTarget> {}
 
@@ -77,7 +77,7 @@ export namespace Binding {
             /**
              * Each entry shall represent a binding.
              *
-             * @see {@link MatterSpecification.v13.Core} § 9.6.6.1
+             * @see {@link MatterSpecification.v14.Core} § 9.6.6.1
              */
             binding: WritableFabricScopedAttribute(
                 0x0,
@@ -117,7 +117,7 @@ export namespace Binding {
      * Once a binding entry is created on the Binding cluster, the client endpoint may initiate interactions to the
      * binding target.
      *
-     * @see {@link MatterSpecification.v13.Core} § 9.6
+     * @see {@link MatterSpecification.v14.Core} § 9.6
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}