@matter/types 0.14.0-alpha.0-20250531-7ed2d6da8 → 0.14.0-alpha.0-20250602-37f27bb02

package/dist/esm/clusters/basic-information.d.ts

@@ -13,7 +13,7 @@ export declare namespace BasicInformation {
      * This structure provides constant values related to overall global capabilities of this Node, that are not
      * cluster-specific.
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.1.4.4
+     * @see {@link MatterSpecification.v141.Core} § 11.1.4.4
      */
     const TlvCapabilityMinima: import("../tlv/TlvObject.js").ObjectSchema<{
         /**
@@ -23,7 +23,7 @@ export declare 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.v14.Core} § 11.1.4.4.1
+         * @see {@link MatterSpecification.v141.Core} § 11.1.4.4.1
          */
         caseSessionsPerFabric: import("../tlv/TlvObject.js").FieldType<number>;
         /**
@@ -32,7 +32,7 @@ export declare namespace BasicInformation {
          * This value shall NOT be smaller than the required minimum indicated in Section 8.5.1, “Subscribe
          * Transaction”.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.1.4.4.2
+         * @see {@link MatterSpecification.v141.Core} § 11.1.4.4.2
          */
         subscriptionsPerFabric: import("../tlv/TlvObject.js").FieldType<number>;
     }>;
@@ -40,14 +40,14 @@ export declare namespace BasicInformation {
      * This structure provides constant values related to overall global capabilities of this Node, that are not
      * cluster-specific.
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.1.4.4
+     * @see {@link MatterSpecification.v141.Core} § 11.1.4.4
      */
     interface CapabilityMinima extends TypeFromSchema<typeof TlvCapabilityMinima> {
     }
     /**
      * The data type of ProductFinishEnum is derived from enum8.
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.1.4.1
+     * @see {@link MatterSpecification.v141.Core} § 11.1.4.1
      */
     enum ProductFinish {
         /**
@@ -78,7 +78,7 @@ export declare namespace BasicInformation {
     /**
      * The data type of ColorEnum is derived from enum8.
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.1.4.2
+     * @see {@link MatterSpecification.v141.Core} § 11.1.4.2
      */
     enum Color {
         /**
@@ -169,87 +169,87 @@ export declare namespace BasicInformation {
     /**
      * This structure provides a description of the product’s appearance.
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.1.4.3
+     * @see {@link MatterSpecification.v141.Core} § 11.1.4.3
      */
     const TlvProductAppearance: import("../tlv/TlvObject.js").ObjectSchema<{
         /**
          * This field shall indicate the visible finish of the product.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.1.4.3.1
+         * @see {@link MatterSpecification.v141.Core} § 11.1.4.3.1
          */
         finish: import("../tlv/TlvObject.js").FieldType<ProductFinish>;
         /**
          * 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.v14.Core} § 11.1.4.3.2
+         * @see {@link MatterSpecification.v141.Core} § 11.1.4.3.2
          */
         primaryColor: import("../tlv/TlvObject.js").FieldType<Color | null>;
     }>;
     /**
      * This structure provides a description of the product’s appearance.
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.1.4.3
+     * @see {@link MatterSpecification.v141.Core} § 11.1.4.3
      */
     interface ProductAppearance extends TypeFromSchema<typeof TlvProductAppearance> {
     }
     /**
      * Body of the BasicInformation startUp event
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.1.6.1
+     * @see {@link MatterSpecification.v141.Core} § 11.1.6.1
      */
     const TlvStartUpEvent: import("../tlv/TlvObject.js").ObjectSchema<{
         /**
          * This field shall be set to the same value as the one available in the SoftwareVersion attribute.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.1.6.1.1
+         * @see {@link MatterSpecification.v141.Core} § 11.1.6.1.1
          */
         softwareVersion: import("../tlv/TlvObject.js").FieldType<number>;
     }>;
     /**
      * Body of the BasicInformation startUp event
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.1.6.1
+     * @see {@link MatterSpecification.v141.Core} § 11.1.6.1
      */
     interface StartUpEvent extends TypeFromSchema<typeof TlvStartUpEvent> {
     }
     /**
      * Body of the BasicInformation leave event
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.1.6.3
+     * @see {@link MatterSpecification.v141.Core} § 11.1.6.3
      */
     const TlvLeaveEvent: import("../tlv/TlvObject.js").ObjectSchema<{
         /**
          * This field shall contain the local Fabric Index of the fabric which the node is about to leave.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.1.6.3.1
+         * @see {@link MatterSpecification.v141.Core} § 11.1.6.3.1
          */
         fabricIndex: import("../tlv/TlvObject.js").FieldType<import("../datatype/FabricIndex.js").FabricIndex>;
     }>;
     /**
      * Body of the BasicInformation leave event
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.1.6.3
+     * @see {@link MatterSpecification.v141.Core} § 11.1.6.3
      */
     interface LeaveEvent extends TypeFromSchema<typeof TlvLeaveEvent> {
     }
     /**
      * Body of the BasicInformation reachableChanged event
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.1.6.4
+     * @see {@link MatterSpecification.v141.Core} § 11.1.6.4
      */
     const TlvReachableChangedEvent: import("../tlv/TlvObject.js").ObjectSchema<{
         /**
          * This field shall indicate the value of the Reachable attribute after it was changed.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.1.6.4.1
+         * @see {@link MatterSpecification.v141.Core} § 11.1.6.4.1
          */
         reachableNewValue: import("../tlv/TlvObject.js").FieldType<boolean>;
     }>;
     /**
      * Body of the BasicInformation reachableChanged event
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.1.6.4
+     * @see {@link MatterSpecification.v141.Core} § 11.1.6.4
      */
     interface ReachableChangedEvent extends TypeFromSchema<typeof TlvReachableChangedEvent> {
     }
@@ -265,40 +265,40 @@ export declare 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.v14.Core} § 11.1.5.1
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.1
              */
             readonly dataModelRevision: FixedAttribute<number, any>;
             /**
              * This attribute shall specify a human readable (displayable) name of the vendor for the Node.
              *
-             * @see {@link MatterSpecification.v14.Core} § 11.1.5.2
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.2
              */
             readonly vendorName: FixedAttribute<string, any>;
             /**
              * This attribute shall specify the Vendor ID.
              *
-             * @see {@link MatterSpecification.v14.Core} § 11.1.5.3
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.3
              */
             readonly vendorId: FixedAttribute<import("../datatype/VendorId.js").VendorId, any>;
             /**
              * 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.v14.Core} § 11.1.5.4
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.4
              */
             readonly productName: FixedAttribute<string, any>;
             /**
              * This attribute shall specify the Product ID assigned by the vendor that is unique to the specific product
              * of the Node.
              *
-             * @see {@link MatterSpecification.v14.Core} § 11.1.5.5
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.5
              */
             readonly productId: FixedAttribute<number, any>;
             /**
              * 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.v14.Core} § 11.1.5.6
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.6
              */
             readonly nodeLabel: WritableAttribute<string, any>;
             /**
@@ -313,14 +313,14 @@ export declare 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.v14.Core} § 11.1.5.7
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.7
              */
             readonly location: WritableAttribute<string, any>;
             /**
              * 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.v14.Core} § 11.1.5.8
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.8
              */
             readonly hardwareVersion: FixedAttribute<number, any>;
             /**
@@ -328,7 +328,7 @@ export declare 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.v14.Core} § 11.1.5.9
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.9
              */
             readonly hardwareVersionString: FixedAttribute<string, any>;
             /**
@@ -338,7 +338,7 @@ export declare 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.v14.Core} § 11.1.5.10
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.10
              */
             readonly softwareVersion: FixedAttribute<number, any>;
             /**
@@ -349,7 +349,7 @@ export declare namespace BasicInformation {
              *
              * Examples of version strings include "1.0", "1.2.3456", "1.2-2", "1.0b123", "1.2_3".
              *
-             * @see {@link MatterSpecification.v14.Core} § 11.1.5.11
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.11
              */
             readonly softwareVersionString: FixedAttribute<string, any>;
             /**
@@ -358,7 +358,7 @@ export declare 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.v14.Core} § 11.1.5.12
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.12
              */
             readonly manufacturingDate: OptionalFixedAttribute<string, any>;
             /**
@@ -369,7 +369,7 @@ export declare 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.v14.Core} § 11.1.5.13
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.13
              */
             readonly partNumber: OptionalFixedAttribute<string, any>;
             /**
@@ -378,7 +378,7 @@ export declare 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.v14.Core} § 11.1.5.14
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.14
              */
             readonly productUrl: OptionalFixedAttribute<string, any>;
             /**
@@ -387,13 +387,13 @@ export declare namespace BasicInformation {
              * ProductName attribute. The ProductLabel attribute SHOULD NOT include the name of the vendor as defined
              * within the VendorName attribute.
              *
-             * @see {@link MatterSpecification.v14.Core} § 11.1.5.15
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.15
              */
             readonly productLabel: OptionalFixedAttribute<string, any>;
             /**
              * This attribute shall specify a human readable (displayable) serial number.
              *
-             * @see {@link MatterSpecification.v14.Core} § 11.1.5.16
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.16
              */
             readonly serialNumber: OptionalFixedAttribute<string, any>;
             /**
@@ -402,7 +402,7 @@ export declare 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.v14.Core} § 11.1.5.17
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.17
              */
             readonly localConfigDisabled: OptionalWritableAttribute<boolean, any>;
             /**
@@ -412,7 +412,7 @@ export declare 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.v14.Core} § 11.1.5.18
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.18
              */
             readonly reachable: OptionalAttribute<boolean, any>;
             /**
@@ -439,7 +439,7 @@ export declare 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.v14.Core} § 11.1.5.19
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.19
              */
             readonly uniqueId: FixedAttribute<string, any>;
             /**
@@ -456,7 +456,7 @@ export declare namespace BasicInformation {
              * 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.v14.Core} § 11.1.5.20
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.20
              */
             readonly capabilityMinima: FixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
@@ -466,7 +466,7 @@ export declare 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.v14.Core} § 11.1.4.4.1
+                 * @see {@link MatterSpecification.v141.Core} § 11.1.4.4.1
                  */
                 caseSessionsPerFabric: import("../tlv/TlvObject.js").FieldType<number>;
                 /**
@@ -475,7 +475,7 @@ export declare namespace BasicInformation {
                  * This value shall NOT be smaller than the required minimum indicated in Section 8.5.1, “Subscribe
                  * Transaction”.
                  *
-                 * @see {@link MatterSpecification.v14.Core} § 11.1.4.4.2
+                 * @see {@link MatterSpecification.v141.Core} § 11.1.4.4.2
                  */
                 subscriptionsPerFabric: import("../tlv/TlvObject.js").FieldType<number>;
             }>, any>;
@@ -483,20 +483,20 @@ export declare 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.v14.Core} § 11.1.5.21
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.21
              */
             readonly productAppearance: OptionalFixedAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
                  * This field shall indicate the visible finish of the product.
                  *
-                 * @see {@link MatterSpecification.v14.Core} § 11.1.4.3.1
+                 * @see {@link MatterSpecification.v141.Core} § 11.1.4.3.1
                  */
                 finish: import("../tlv/TlvObject.js").FieldType<ProductFinish>;
                 /**
                  * 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.v14.Core} § 11.1.4.3.2
+                 * @see {@link MatterSpecification.v141.Core} § 11.1.4.3.2
                  */
                 primaryColor: import("../tlv/TlvObject.js").FieldType<Color | null>;
             }>, any>;
@@ -533,7 +533,7 @@ export declare namespace BasicInformation {
              * Comparison of SpecificationVersion shall always include the total value over 32 bits, without masking
              * reserved parts.
              *
-             * @see {@link MatterSpecification.v14.Core} § 11.1.5.22
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.22
              */
             readonly specificationVersion: FixedAttribute<number, any>;
             /**
@@ -546,7 +546,7 @@ export declare 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.v14.Core} § 11.1.5.23
+             * @see {@link MatterSpecification.v141.Core} § 11.1.5.23
              */
             readonly maxPathsPerInvoke: FixedAttribute<number, any>;
         };
@@ -556,13 +556,13 @@ export declare 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.v14.Core} § 11.1.6.1
+             * @see {@link MatterSpecification.v141.Core} § 11.1.6.1
              */
             readonly startUp: Event<import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
                  * This field shall be set to the same value as the one available in the SoftwareVersion attribute.
                  *
-                 * @see {@link MatterSpecification.v14.Core} § 11.1.6.1.1
+                 * @see {@link MatterSpecification.v141.Core} § 11.1.6.1.1
                  */
                 softwareVersion: import("../tlv/TlvObject.js").FieldType<number>;
             }>, any>;
@@ -572,7 +572,7 @@ export declare 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.v14.Core} § 11.1.6.2
+             * @see {@link MatterSpecification.v141.Core} § 11.1.6.2
              */
             readonly shutDown: OptionalEvent<void, any>;
             /**
@@ -585,13 +585,13 @@ export declare 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.v14.Core} § 11.1.6.3
+             * @see {@link MatterSpecification.v141.Core} § 11.1.6.3
              */
             readonly leave: OptionalEvent<import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
                  * This field shall contain the local Fabric Index of the fabric which the node is about to leave.
                  *
-                 * @see {@link MatterSpecification.v14.Core} § 11.1.6.3.1
+                 * @see {@link MatterSpecification.v141.Core} § 11.1.6.3.1
                  */
                 fabricIndex: import("../tlv/TlvObject.js").FieldType<import("../datatype/FabricIndex.js").FabricIndex>;
             }>, any>;
@@ -602,13 +602,13 @@ export declare namespace BasicInformation {
              *
              * Its main use case is in the derived Bridged Device Basic Information cluster.
              *
-             * @see {@link MatterSpecification.v14.Core} § 11.1.6.4
+             * @see {@link MatterSpecification.v141.Core} § 11.1.6.4
              */
             readonly reachableChanged: OptionalEvent<import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
                  * This field shall indicate the value of the Reachable attribute after it was changed.
                  *
-                 * @see {@link MatterSpecification.v14.Core} § 11.1.6.4.1
+                 * @see {@link MatterSpecification.v141.Core} § 11.1.6.4.1
                  */
                 reachableNewValue: import("../tlv/TlvObject.js").FieldType<boolean>;
             }>, any>;
@@ -619,7 +619,7 @@ export declare 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.v14.Core} § 11.1
+     * @see {@link MatterSpecification.v141.Core} § 11.1
      */
     interface Cluster extends Identity<typeof ClusterInstance> {
     }