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

package/dist/esm/clusters/network-commissioning.js

@@ -28,7 +28,7 @@ var NetworkCommissioning;
      * if the field is absent, or if it is null, this shall indicate scanning of all BSSID in range. This field
      * shall be ignored for ScanNetworks invocations on non-Wi-Fi server instances.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.1.1
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.1.1
      */
     ssid: TlvOptionalField(0, TlvNullable(TlvByteString.bound({ minLength: 1, maxLength: 32 }))),
     /**
@@ -36,7 +36,7 @@ var NetworkCommissioning;
      * Commissioning cluster on success of the associated command. If the command fails, the Breadcrumb attribute in
      * the General Commissioning cluster shall be left unchanged.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.1.2
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.1.2
      */
     breadcrumb: TlvOptionalField(1, TlvUInt64)
   });
@@ -96,13 +96,13 @@ var NetworkCommissioning;
      * This field, if present, may be used to differentiate overlapping channel number values across different Wi-Fi
      * frequency bands.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.5.6.1
+     * @see {@link MatterSpecification.v14.Core} § 11.9.5.6.1
      */
     wiFiBand: TlvOptionalField(4, TlvEnum()),
     /**
      * This field, if present, shall denote the signal strength in dBm of the associated scan result.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.5.6.2
+     * @see {@link MatterSpecification.v14.Core} § 11.9.5.6.2
      */
     rssi: TlvOptionalField(5, TlvInt8)
   });
@@ -115,7 +115,7 @@ var NetworkCommissioning;
     /**
      * ExtendedAddress stands for an IEEE 802.15.4 Extended Address.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.5.7.1
+     * @see {@link MatterSpecification.v14.Core} § 11.9.5.7.1
      */
     extendedAddress: TlvOptionalField(5, TlvByteString),
     rssi: TlvOptionalField(6, TlvInt8),
@@ -137,7 +137,7 @@ var NetworkCommissioning;
      *
      *   • UnknownError: An internal error occurred during scanning.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.2.1
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.2.1
      */
     networkingStatus: TlvField(0, TlvEnum()),
     /**
@@ -145,7 +145,7 @@ var NetworkCommissioning;
      * case the NetworkingStatus was not Success. Its purpose is to help developers in troubleshooting errors and
      * may go into logs or crash reports.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.2.2
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.2.2
      */
     debugText: TlvOptionalField(1, TlvString.bound({ maxLength: 512 })),
     /**
@@ -161,7 +161,7 @@ var NetworkCommissioning;
      * RSSI order, even if RSSI is not reported in the response, to maximize the likelihood that most likely to be
      * reachable elements are included within the size limits of the response.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.2.3
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.2.3
      */
     wiFiScanResults: TlvOptionalField(2, TlvArray(NetworkCommissioning2.TlvWiFiInterfaceScanResult)),
     /**
@@ -176,7 +176,7 @@ var NetworkCommissioning;
      * LQI order, to maximize the likelihood that most likely to be reachable elements are included within the size
      * limits of the response.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.2.4
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.2.4
      */
     threadScanResults: TlvOptionalField(3, TlvArray(NetworkCommissioning2.TlvThreadInterfaceScanResult))
   });
@@ -184,13 +184,13 @@ var NetworkCommissioning;
     /**
      * This field shall contain the NetworkID for the entry to remove: the SSID for Wi-Fi and XPAN ID for Thread.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.6.1
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.6.1
      */
     networkId: TlvField(0, TlvByteString.bound({ minLength: 1, maxLength: 32 })),
     /**
      * See Breadcrumb for usage.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.6.2
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.6.2
      */
     breadcrumb: TlvOptionalField(1, TlvUInt64)
   });
@@ -210,13 +210,13 @@ var NetworkCommissioning;
      *
      *   • UnknownError: An internal error occurred during the operation.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.7.1
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.7.1
      */
     networkingStatus: TlvField(0, TlvEnum()),
     /**
      * See DebugText for usage.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.7.2
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.7.2
      */
     debugText: TlvOptionalField(1, TlvString.bound({ maxLength: 512 })),
     /**
@@ -224,7 +224,7 @@ var NetworkCommissioning;
      * entry in the Networks attribute that was last added, updated or removed successfully by the associated
      * request command.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.7.3
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.7.3
      */
     networkIndex: TlvOptionalField(2, TlvUInt8)
   });
@@ -233,13 +233,13 @@ var NetworkCommissioning;
      * This field shall contain the NetworkID for the entry used to configure the connection: the SSID for Wi-Fi and
      * XPAN ID for Thread.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.8.1
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.8.1
      */
     networkId: TlvField(0, TlvByteString.bound({ minLength: 1, maxLength: 32 })),
     /**
      * See Breadcrumb for usage.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.8.2
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.8.2
      */
     breadcrumb: TlvOptionalField(1, TlvUInt64)
   });
@@ -265,13 +265,13 @@ var NetworkCommissioning;
      *   • Association errors (see also description of errors in NetworkCommissioningStatusEnum): AuthFailure,
      *     UnsupportedSecurity, OtherConnectionFailure, IPV6Failed, IPBindFailed
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.9.1
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.9.1
      */
     networkingStatus: TlvField(0, TlvEnum()),
     /**
      * See DebugText for usage.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.9.2
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.9.2
      */
     debugText: TlvOptionalField(1, TlvString),
     /**
@@ -294,7 +294,7 @@ var NetworkCommissioning;
      *   • Otherwise, the ErrorValue field shall contain an implementation-dependent value which may be used by a
      *     reader of the structure to record, report or diagnose the failure.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.9.3
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.9.3
      */
     errorValue: TlvField(2, TlvNullable(TlvInt32))
   });
@@ -302,14 +302,14 @@ var NetworkCommissioning;
     /**
      * This field shall contain the NetworkID for the entry to reorder: the SSID for Wi-Fi and XPAN ID for Thread.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.10.1
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.10.1
      */
     networkId: TlvField(0, TlvByteString.bound({ minLength: 1, maxLength: 32 })),
     /**
      * This field shall contain the 0-based index of the new desired position of the entry in the Networks
      * attribute.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.10.2
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.10.2
      */
     networkIndex: TlvField(1, TlvUInt8),
     /**
@@ -361,7 +361,7 @@ var NetworkCommissioning;
      * In the above outcome, BlueDolphin, Home-Guest and WillowTree moved "up" and FancyCat became the lowest
      * priority network in the list.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.10.3
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.10.3
      */
     breadcrumb: TlvOptionalField(2, TlvUInt64)
   });
@@ -370,7 +370,7 @@ var NetworkCommissioning;
      * This field shall contain the SSID to which to attempt connection. Specific BSSID selection is not supported
      * by this cluster.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.3.1
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.3.1
      */
     ssid: TlvField(0, TlvByteString.bound({ maxLength: 32 })),
     /**
@@ -408,13 +408,13 @@ var NetworkCommissioning;
      * selects a lower security connectivity type if the link quality is deemed to be too low to achieve successful
      * operation, or if all retry attempts fail.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.3.2
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.3.2
      */
     credentials: TlvField(1, TlvByteString.bound({ maxLength: 64 })),
     /**
      * See Breadcrumb for usage.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.3.3
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.3.3
      */
     breadcrumb: TlvOptionalField(2, TlvUInt64)
   });
@@ -448,13 +448,13 @@ var NetworkCommissioning;
      * The encoding for the OperationalDataset field is defined in the Thread specification. The client shall pass
      * the OperationalDataset as an opaque octet string.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.4.1
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.4.1
      */
     operationalDataset: TlvField(0, TlvByteString.bound({ maxLength: 254 })),
     /**
      * See Breadcrumb for usage.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.7.4.2
+     * @see {@link MatterSpecification.v14.Core} § 11.9.7.4.2
      */
     breadcrumb: TlvOptionalField(1, TlvUInt64)
   });
@@ -483,7 +483,7 @@ var NetworkCommissioning;
      *
      * XPAN ID is a big-endian 64-bit unsigned number, represented on the first 8 octets of the octet string.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.5.5.1
+     * @see {@link MatterSpecification.v14.Core} § 11.9.5.5.1
      */
     networkId: TlvField(0, TlvByteString.bound({ minLength: 1, maxLength: 32 })),
     /**
@@ -491,7 +491,7 @@ var NetworkCommissioning;
      * linked to the network technology (e.g. Associated for a Wi-Fi network, media connected for an Ethernet
      * network).
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.9.5.5.2
+     * @see {@link MatterSpecification.v14.Core} § 11.9.5.5.2
      */
     connected: TlvField(1, TlvBoolean)
   });
@@ -503,7 +503,7 @@ var NetworkCommissioning;
        *
        * See ScanNetworks for usage.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.6.3
+       * @see {@link MatterSpecification.v14.Core} § 11.9.6.3
        */
       scanMaxTimeSeconds: FixedAttribute(2, TlvUInt8),
       /**
@@ -514,7 +514,7 @@ var NetworkCommissioning;
        * deemed to have occurred, including, for example, obtaining IP addresses, or the execution of necessary
        * internal retries.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.6.4
+       * @see {@link MatterSpecification.v14.Core} § 11.9.6.4
        */
       connectMaxTimeSeconds: FixedAttribute(3, TlvUInt8)
     },
@@ -559,7 +559,7 @@ var NetworkCommissioning;
        * clients, while the network interface is processing the scan. Clients SHOULD NOT use this command unless
        * actively in the process of re-configuring network connectivity.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.7.1
+       * @see {@link MatterSpecification.v14.Core} § 11.9.7.1
        */
       scanNetworks: Command(
         0,
@@ -584,7 +584,7 @@ var NetworkCommissioning;
        * of the entry in the Networks attribute that was just removed, and a NetworkingStatus status field set to
        * Success.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.7.6
+       * @see {@link MatterSpecification.v14.Core} § 11.9.7.6
        */
       removeNetwork: Command(
         4,
@@ -669,7 +669,7 @@ var NetworkCommissioning;
        * determining the reason for a failure after reconnecting over a Commissioning channel, especially in
        * non-concurrent commissioning situations.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.7.8
+       * @see {@link MatterSpecification.v14.Core} § 11.9.7.8
        */
       connectNetwork: Command(
         6,
@@ -682,7 +682,7 @@ var NetworkCommissioning;
        * This command shall set the specific order of the network configuration selected by its NetworkID in the
        * Networks attribute to match the position given by NetworkIndex.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.7.10
+       * @see {@link MatterSpecification.v14.Core} § 11.9.7.10
        */
       reorderNetwork: Command(
         8,
@@ -698,7 +698,7 @@ var NetworkCommissioning;
       /**
        * Indicates all the frequency bands supported by the Wi-Fi interface configured by the cluster instance.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.6.9
+       * @see {@link MatterSpecification.v14.Core} § 11.9.6.9
        */
       supportedWiFiBands: FixedAttribute(8, TlvArray(TlvEnum(), { minLength: 1 }))
     },
@@ -718,7 +718,7 @@ var NetworkCommissioning;
        * See Section 11.9.7.5, “Common processing of AddOrUpdateWiFiNetwork and AddOrUpdateThreadNetwork” for
        * behavior of addition/update.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.7.3
+       * @see {@link MatterSpecification.v14.Core} § 11.9.7.3
        */
       addOrUpdateWiFiNetwork: Command(
         2,
@@ -740,7 +740,7 @@ var NetworkCommissioning;
        * Note that most run-time details of the actual Thread interface are found in the Thread Network
        * Diagnostics cluster, if supported.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.6.10
+       * @see {@link MatterSpecification.v14.Core} § 11.9.6.10
        */
       supportedThreadFeatures: FixedAttribute(9, TlvBitmap(TlvUInt16, NetworkCommissioning2.ThreadCapabilities)),
       /**
@@ -749,7 +749,7 @@ var NetworkCommissioning;
        * The format shall match the value mapping found in the "Version TLV" section of Thread specification. For
        * example, Thread 1.3.0 would have ThreadVersion set to 4.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.6.11
+       * @see {@link MatterSpecification.v14.Core} § 11.9.6.11
        */
       threadVersion: FixedAttribute(10, TlvUInt16)
     },
@@ -770,7 +770,7 @@ var NetworkCommissioning;
        * OperationalDataset, the operation shall be considered an addition, otherwise, it shall be considered an
        * update.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.7.4
+       * @see {@link MatterSpecification.v14.Core} § 11.9.7.4
        */
       addOrUpdateThreadNetwork: Command(
         3,
@@ -811,7 +811,7 @@ var NetworkCommissioning;
        * available device resources. The length of the Networks attribute shall be less than or equal to this
        * value.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.6.1
+       * @see {@link MatterSpecification.v14.Core} § 11.9.6.1
        */
       maxNetworks: FixedAttribute(
         0,
@@ -835,7 +835,7 @@ var NetworkCommissioning;
        * There shall be no way to add, update or remove Ethernet network configurations to those Cluster
        * instances.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.6.2
+       * @see {@link MatterSpecification.v14.Core} § 11.9.6.2
        */
       networks: Attribute(
         1,
@@ -859,7 +859,7 @@ var NetworkCommissioning;
        * On Ethernet-only Nodes, there shall always be at least one of the Network Commissioning server cluster
        * instances with InterfaceEnabled set to true.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.6.5
+       * @see {@link MatterSpecification.v14.Core} § 11.9.6.5
        */
       interfaceEnabled: WritableAttribute(
         4,
@@ -875,7 +875,7 @@ var NetworkCommissioning;
        * This attribute is present to assist with error recovery during Network commissioning and to assist in
        * non-concurrent networking commissioning flows.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.6.6
+       * @see {@link MatterSpecification.v14.Core} § 11.9.6.6
        */
       lastNetworkingStatus: Attribute(
         5,
@@ -894,7 +894,7 @@ var NetworkCommissioning;
        * This attribute is present to assist with error recovery during Network commissioning and to assist in
        * non-concurrent networking commissioning flows.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.6.7
+       * @see {@link MatterSpecification.v14.Core} § 11.9.6.7
        */
       lastNetworkId: Attribute(
         6,
@@ -913,7 +913,7 @@ var NetworkCommissioning;
        * This attribute is present to assist with error recovery during Network commissioning and to assist in
        * non-concurrent networking commissioning flows.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.9.6.8
+       * @see {@link MatterSpecification.v14.Core} § 11.9.6.8
        */
       lastConnectErrorValue: Attribute(
         7,