Networking and diagnostics1105 — Wi-Fi Network Management

Matter Cluster 1105 — Wi-Fi Network Management

Matter Cluster 1105 (0x0451) Wi-Fi Network Management: attributes, commands, events, data types, shadow paths and bridge payload examples.

Matter Cluster 1105 — Wi-Fi Network Management Cluster

Matter Cluster 1105, also written as 0x0451, is the Wi-Fi Network Management Cluster. This cluster provides an interface for getting information about the Wi-Fi network that a Network Infrastructure Manager device type provides. Privileged nodes within the same fabric as a Network Infrastructure Manager can use these interfaces to request information related to the Wi-Fi Network such as SSID and Passphrase.

Cluster Identity

FieldValue
Cluster ID decimal1105
Cluster ID hex0x0451
Cluster nameWi-Fi Network Management
Cluster revision (Matter 1.6.1)1
Roleapplication
ScopeEndpoint
PICS codeWIFINM
Typical endpoint1

Revision history

RevisionChange
1Initial revision

Shadow Path Format

Cluster 1105 values in the device shadow use this format:

endpoint_id / 1105 / attribute_id

Example:

{
  "1/1105/0": "AQID"
}
PartMeaning
1Endpoint ID
1105Wi-Fi Network Management cluster
0SSID attribute

Cluster 1105 Attributes

Cluster 1105 defines 2 attributes plus the global attributes. Conformance: M mandatory, O optional, a feature code means "mandatory when that feature is present", square brackets mean "optional when …".

IDHexAttributeTypeConformanceAccessQualitiesDefault
00x0000SSIDoctstrMR (read: view)nullable, persisted—
10x0001PassphraseSurrogateuint64MR (read: manage)nullable, persisted—

Global attributes

IDHexAttributeMeaning
655280xFFF8GeneratedCommandListResponse command IDs this server generates.
655290xFFF9AcceptedCommandListCommand IDs this server accepts.
655310xFFFBAttributeListAttribute IDs implemented.
655320xFFFCFeatureMapImplemented optional features (see above).
655330xFFFDClusterRevisionCluster revision implemented; 1 for a Matter 1.6.1 device.

Attribute Details

Attribute 0 / 0x0000 — SSID

Path example:

1/1105/0

No condensed specification text is available for SSID; use the type, conformance and constraint below together with the cluster description above.

PropertyValue
Typeoctstr
ConformanceM
AccessR (read: view)
Qualitiesnullable, persisted
Constraintlength 1 to 32

Example:

{
  "1/1105/0": "AQID"
}

Attribute 1 / 0x0001 — PassphraseSurrogate

Path example:

1/1105/1

This attribute contains an arbitrary numeric value; this value must increase whenever the passphrase or PSK associated with the primary Wi-Fi network provided by this device changes. A value of null indicates that no primary Wi-Fi network is available. Clients can subscribe to this attribute or compare its value to a locally cached copy to detect if a cached passphrase value has become stale. It is recommended that servers implement this attribute as either a timestamp or a counter.

PropertyValue
Typeuint64
ConformanceM
AccessR (read: manage)
Qualitiesnullable, persisted

Example:

{
  "1/1105/1": 1
}

Cluster 1105 Commands

Cluster 1105 has 1 client-to-server command and 1 response.

IDHexCommandDirectionConformanceResponseDescription
00x00NetworkPassphraseRequestclient → serverMNetworkPassphraseResponseThis command is used to request the current WPA-Personal passphrase or PSK associated with the Wi-Fi network provided by this device.
10x01NetworkPassphraseResponseserver → clientM—This command is generated in response to a NetworkPassphraseRequest command.

AcceptedCommandList

The AcceptedCommandList attribute lists the command IDs the endpoint actually implements:

endpoint_id / 1105 / 65529
{
  "1/1105/65529": [
    0
  ]
}

Before sending a Cluster 1105 command, check that the command ID exists in endpoint/1105/65529. Optional commands are only present when the matching feature is set in FeatureMap.


Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1105,
    "command_name": "NetworkPassphraseRequest",
    "payload": {},
    "timed_request_timeout_ms": 1000
  }
}

For Cluster 1105, always use "cluster_id": 1105. Payload keys are the command field names in lowerCamelCase. Octet-string fields are base64-encoded. timed_request_timeout_ms is required for timed commands and ignored otherwise.


Command: NetworkPassphraseRequest

Purpose

This command is used to request the current WPA-Personal passphrase or PSK associated with the Wi-Fi network provided by this device. If the command is not executed via a CASE session, the command is rejected with a status of UNSUPPORTED_ACCESS. If no primary Wi-Fi network is available (the SSID attribute is null), the command is rejected with a status of INVALID_IN_STATE. Otherwise a NetworkPassphraseResponse is generated.

Command Identity

FieldValue
Command ID0
Command hex0x00
Command nameNetworkPassphraseRequest
Directionclient → server
ConformanceM
ResponseNetworkPassphraseResponse
Access(invoke: manage)

Payload Fields

This command has no payload fields.

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1105,
    "command_name": "NetworkPassphraseRequest",
    "payload": {}
  }
}

The device answers with NetworkPassphraseResponse (see below).


Command: NetworkPassphraseResponse

Purpose

This command is generated in response to a NetworkPassphraseRequest command.

Command Identity

FieldValue
Command ID1
Command hex0x01
Command nameNetworkPassphraseResponse
Directionserver → client (response)
ConformanceM

Response Fields

IDFieldPayload keyTypeConformanceConstraintMeaning
0PassphrasepassphraseoctstrMmax length 64Indicates the current WPA-Personal passphrase or PSK associated with the primary Wi-Fi network provided by this device, in one of the following formats: - 8..63 bytes: WPA/WPA2/WPA3 passphrase. - 64 bytes: WPA/WPA2/WPA3 raw hex PSK.

Cluster 1105 Events

Cluster 1105 defines no events.


SmartphoneKey Notes

  • Cluster 1105 is not currently exposed by SmartphoneKey devices. This page documents the Matter 1.6.1 specification so that future devices can be interpreted without changes to the backend.
  • Shadow paths follow endpoint/1105/attribute; attribute values that the device reports as unreadable are written as n/a.
  • Attribute IDs, command IDs and enum values on this page come from the CSA Matter 1.6.1 data model; descriptions are condensed from the specification text.