Matter Survey

Community-driven database of Matter device capabilities

The Network Commissioning cluster (0x0031) is a Matter cluster that Configures network connectivity (WiFi, Thread, Ethernet) during device setup.. It defines 11 commands and 11 attributes and is mandatory for 2 device types.

Network Commissioning 0x0031

Global Cluster
Utility
Introduced in: Matter 1.0
Devices: 511
Configures network connectivity (WiFi, Thread, Ethernet) during device setup.

Spec History

This cluster's ClusterRevision across the Matter releases it has shipped in. Click a version to inspect the cluster as it existed in that release.

Attributes 11
Commands 11
Features 4
Code Name Type Flags
0x0000 MaxNetworks
min 1
int8u read: administer
0x0001 Networks array read: administer
0x0002 ScanMaxTimeSeconds int8u Optional
0x0003 ConnectMaxTimeSeconds int8u Optional
0x0004 InterfaceEnabled
default 1
boolean Writable write: administer
0x0005 LastNetworkingStatus
max 0x0C · nullable
NetworkCommissioningStatusEnum read: administer
0x0006 LastNetworkID
nullable
octet_string read: administer
0x0007 LastConnectErrorValue
nullable
int32s read: administer
0x0008 SupportedWiFiBands array Optional
0x0009 SupportedThreadFeatures
max 0x001F
ThreadCapabilitiesBitmap Optional
0x000A ThreadVersion int16u Optional
Code Name Direction Parameters
0x00 ScanNetworks Optional invoke: administer
This command is used to scan for available networks on the network interface associated with the cluster instance.
client→server
SSID: octet_string, Breadcrumb: int64u
0x01 ScanNetworksResponse Optional
This command is used to report the results of a ScanNetworks command.
server→client
NetworkingStatus: NetworkCommissioningStatusEnum, DebugText: long_char_string, WiFiScanResults: WiFiInterfaceScanResultStruct, ThreadScanResults: ThreadInterfaceScanResultStruct
0x02 AddOrUpdateWiFiNetwork Optional invoke: administer
This command is used to add or update a Wi-Fi network configuration.
client→server
SSID: octet_string, Credentials: octet_string, Breadcrumb: int64u, NetworkIdentity: octet_string, ClientIdentifier: octet_string, PossessionNonce: octet_string
0x03 AddOrUpdateThreadNetwork Optional invoke: administer
This command is used to add or update a Thread network configuration.
client→server
OperationalDataset: octet_string, Breadcrumb: int64u
0x04 RemoveNetwork Optional invoke: administer
This command is used to remove a network configuration on the network interface associated with the cluster instance.
client→server
NetworkID: octet_string, Breadcrumb: int64u
0x05 NetworkConfigResponse Optional
This command is used to report the results of a network configuration command (AddOrUpdateWiFiNetwork, AddOrUpdateThreadNetwork, or RemoveNetwork).
server→client
NetworkingStatus: NetworkCommissioningStatusEnum, DebugText: long_char_string, NetworkIndex: int8u, ClientIdentity: octet_string, PossessionSignature: octet_string
0x06 ConnectNetwork Optional invoke: administer
This command is used to connect to a network on the network interface associated with the cluster instance.
client→server
NetworkID: octet_string, Breadcrumb: int64u
0x07 ConnectNetworkResponse Optional
This command is used to report the results of a ConnectNetwork command.
server→client
NetworkingStatus: NetworkCommissioningStatusEnum, DebugText: char_string, ErrorValue: int32s
0x08 ReorderNetwork Optional invoke: administer
This command is used to re-order the network configuration list.
client→server
NetworkID: octet_string, NetworkIndex: int8u, Breadcrumb: int64u
0x09 QueryIdentity Optional Provisional invoke: administer
This command is used to query the identity of a network configuration.
client→server
KeyIdentifier: octet_string, PossessionNonce: octet_string
0x0A QueryIdentityResponse Optional Provisional
This command is used to report the results of a QueryIdentity command.
server→client
Identity: octet_string, PossessionSignature: octet_string
WiFiNetworkInterface (WI) bit 0
Wi-Fi related features
ThreadNetworkInterface (TH) bit 1
Thread related features
EthernetNetworkInterface (ET) bit 2
Ethernet related features
PerDeviceCredentials (PDC) bit 3 Provisional
Wi-Fi Per-Device Credentials

Device Types Using This Cluster

Device types in the Matter spec that reference this cluster

Devices Implementing This Cluster

511 devices in the survey implement this cluster