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

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

@@ -52,7 +52,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: (0, import_TlvObject.TlvOptionalField)(0, (0, import_TlvNullable.TlvNullable)(import_TlvString.TlvByteString.bound({ minLength: 1, maxLength: 32 }))),
     /**
@@ -60,7 +60,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: (0, import_TlvObject.TlvOptionalField)(1, import_TlvNumber.TlvUInt64)
   });
@@ -120,13 +120,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: (0, import_TlvObject.TlvOptionalField)(4, (0, import_TlvNumber.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: (0, import_TlvObject.TlvOptionalField)(5, import_TlvNumber.TlvInt8)
   });
@@ -139,7 +139,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: (0, import_TlvObject.TlvOptionalField)(5, import_TlvString.TlvByteString),
     rssi: (0, import_TlvObject.TlvOptionalField)(6, import_TlvNumber.TlvInt8),
@@ -161,7 +161,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: (0, import_TlvObject.TlvField)(0, (0, import_TlvNumber.TlvEnum)()),
     /**
@@ -169,7 +169,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: (0, import_TlvObject.TlvOptionalField)(1, import_TlvString.TlvString.bound({ maxLength: 512 })),
     /**
@@ -185,7 +185,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: (0, import_TlvObject.TlvOptionalField)(2, (0, import_TlvArray.TlvArray)(NetworkCommissioning2.TlvWiFiInterfaceScanResult)),
     /**
@@ -200,7 +200,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: (0, import_TlvObject.TlvOptionalField)(3, (0, import_TlvArray.TlvArray)(NetworkCommissioning2.TlvThreadInterfaceScanResult))
   });
@@ -208,13 +208,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: (0, import_TlvObject.TlvField)(0, import_TlvString.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: (0, import_TlvObject.TlvOptionalField)(1, import_TlvNumber.TlvUInt64)
   });
@@ -234,13 +234,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: (0, import_TlvObject.TlvField)(0, (0, import_TlvNumber.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: (0, import_TlvObject.TlvOptionalField)(1, import_TlvString.TlvString.bound({ maxLength: 512 })),
     /**
@@ -248,7 +248,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: (0, import_TlvObject.TlvOptionalField)(2, import_TlvNumber.TlvUInt8)
   });
@@ -257,13 +257,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: (0, import_TlvObject.TlvField)(0, import_TlvString.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: (0, import_TlvObject.TlvOptionalField)(1, import_TlvNumber.TlvUInt64)
   });
@@ -289,13 +289,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: (0, import_TlvObject.TlvField)(0, (0, import_TlvNumber.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: (0, import_TlvObject.TlvOptionalField)(1, import_TlvString.TlvString),
     /**
@@ -318,7 +318,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: (0, import_TlvObject.TlvField)(2, (0, import_TlvNullable.TlvNullable)(import_TlvNumber.TlvInt32))
   });
@@ -326,14 +326,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: (0, import_TlvObject.TlvField)(0, import_TlvString.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: (0, import_TlvObject.TlvField)(1, import_TlvNumber.TlvUInt8),
     /**
@@ -385,7 +385,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: (0, import_TlvObject.TlvOptionalField)(2, import_TlvNumber.TlvUInt64)
   });
@@ -394,7 +394,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: (0, import_TlvObject.TlvField)(0, import_TlvString.TlvByteString.bound({ maxLength: 32 })),
     /**
@@ -432,13 +432,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: (0, import_TlvObject.TlvField)(1, import_TlvString.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: (0, import_TlvObject.TlvOptionalField)(2, import_TlvNumber.TlvUInt64)
   });
@@ -472,13 +472,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: (0, import_TlvObject.TlvField)(0, import_TlvString.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: (0, import_TlvObject.TlvOptionalField)(1, import_TlvNumber.TlvUInt64)
   });
@@ -507,7 +507,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: (0, import_TlvObject.TlvField)(0, import_TlvString.TlvByteString.bound({ minLength: 1, maxLength: 32 })),
     /**
@@ -515,7 +515,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: (0, import_TlvObject.TlvField)(1, import_TlvBoolean.TlvBoolean)
   });
@@ -527,7 +527,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: (0, import_Cluster.FixedAttribute)(2, import_TlvNumber.TlvUInt8),
       /**
@@ -538,7 +538,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: (0, import_Cluster.FixedAttribute)(3, import_TlvNumber.TlvUInt8)
     },
@@ -583,7 +583,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: (0, import_Cluster.Command)(
         0,
@@ -608,7 +608,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: (0, import_Cluster.Command)(
         4,
@@ -693,7 +693,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: (0, import_Cluster.Command)(
         6,
@@ -706,7 +706,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: (0, import_Cluster.Command)(
         8,
@@ -722,7 +722,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: (0, import_Cluster.FixedAttribute)(8, (0, import_TlvArray.TlvArray)((0, import_TlvNumber.TlvEnum)(), { minLength: 1 }))
     },
@@ -742,7 +742,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: (0, import_Cluster.Command)(
         2,
@@ -764,7 +764,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: (0, import_Cluster.FixedAttribute)(9, (0, import_TlvNumber.TlvBitmap)(import_TlvNumber.TlvUInt16, NetworkCommissioning2.ThreadCapabilities)),
       /**
@@ -773,7 +773,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: (0, import_Cluster.FixedAttribute)(10, import_TlvNumber.TlvUInt16)
     },
@@ -794,7 +794,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: (0, import_Cluster.Command)(
         3,
@@ -835,7 +835,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: (0, import_Cluster.FixedAttribute)(
         0,
@@ -859,7 +859,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: (0, import_Cluster.Attribute)(
         1,
@@ -883,7 +883,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: (0, import_Cluster.WritableAttribute)(
         4,
@@ -899,7 +899,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: (0, import_Cluster.Attribute)(
         5,
@@ -918,7 +918,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: (0, import_Cluster.Attribute)(
         6,
@@ -937,7 +937,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: (0, import_Cluster.Attribute)(
         7,