Input to the NetworkCommissioning addOrUpdateWiFiNetwork command

MatterSpecification.v13.Core § 11.9.7.3

interface AddOrUpdateWiFiNetworkRequest {
    breadcrumb?: number | bigint;
    credentials: Uint8Array;
    ssid: Uint8Array;
}

Hierarchy (view full)

Properties

breadcrumb?: number | bigint

See Section 11.9.7.1.2, “Breadcrumb Field” for usage.

MatterSpecification.v13.Core § 11.9.7.3.3

credentials: Uint8Array

Credentials is the passphrase or PSK for the network (if any is needed).

Security type, cipher and credential format (passphrase or PSK) shall be contextually auto- selected during execution of the ConnectNetwork Command and during subsequent operational state network connections, based on the most secure Wi-Fi security type available within beacons and probe responses for the set of all discovered BSSIDs for the configured SSID. The type of PSK or passphrase used shall be inferred based on the length and contents of the Credentials field provided, matching the security type chosen.

Valid Credentials length are:

• 0 bytes: Unsecured (open) connection

• 5 bytes: WEP-64 passphrase

• 10 hexadecimal ASCII characters: WEP-64 40-bit hex raw PSK

• 13 bytes: WEP-128 passphrase

• 26 hexadecimal ASCII characters: WEP-128 104-bit hex raw PSK

• 8..63 bytes: WPA/WPA2/WPA3 passphrase

• 64 bytes: WPA/WPA2/WPA3 raw hex PSK

These lengths shall be contextually interpreted based on the security type of the BSSID where connection will occur.

When the length of Credentials and available set of BSSID admits more than one option, such as the presence of both WPA2 and WPA security type within the result set, WPA2 shall be considered more secure.

Note that it may occur that a station cannot connect to a particular access point with higher security and 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.

MatterSpecification.v13.Core § 11.9.7.3.2

ssid: Uint8Array

This field shall contain the SSID to which to attempt connection. Specific BSSID selection is not supported by this cluster.

MatterSpecification.v13.Core § 11.9.7.3.1