Matter Cluster 1107 — Thread Network Directory Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1107 values in the device shadow use this format:

endpoint_id / 1107 / attribute_id

Example:

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

Data Types

ThreadNetworkStruct (struct)

Represents the data associated with a Thread Network.

Cluster 1107 Attributes

Cluster 1107 defines 3 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 …".

Global attributes

Attribute Details

Attribute 0 / 0x0000 — PreferredExtendedPanID

Path example:

1/1107/0

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

Example:

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

Attribute 1 / 0x0001 — ThreadNetworks

Path example:

1/1107/1

Indicates the list of Thread Networks known about by this cluster. If the node hosting this cluster includes a Thread Border Router, then an entry for its Thread Network is included in this list. The list can be modified via the AddNetwork and RemoveNetwork commands. For each entry in the list, the cluster server also stores a Thread Operational Dataset.

Each entry is a ThreadNetworkStruct (see Data Types).

Example:

{
  "1/1107/1": []
}

Attribute 2 / 0x0002 — ThreadNetworkTableSize

Path example:

1/1107/2

Indicates the maximum number of entries that can be held in the ThreadNetworks list; it is at least 2 times the number of SupportedFabrics advertised in the Operational Credentials Cluster on the root endpoint of this node.

Example:

{
  "1/1107/2": 1
}

Cluster 1107 Commands

Cluster 1107 has 3 client-to-server commands and 1 response.

AcceptedCommandList

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

endpoint_id / 1107 / 65529

{
  "1/1107/65529": [
    0,
    1,
    2
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

For Cluster 1107, always use "cluster_id": 1107. 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: AddNetwork

Purpose

Adds an entry to the ThreadNetworks attribute with the specified Thread Operational Dataset. If there is an existing entry with the Extended PAN ID then the Thread Operational Dataset for that entry is replaced. As a result, changes to the network parameters (e.g. Channel, Network Name, PSKc, ...) of an existing entry with a given Extended PAN ID can be made using this command.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1107,
    "command_name": "AddNetwork",
    "payload": {
      "operationalDataset": "AQID"
    },
    "timed_request_timeout_ms": 1000
  }
}

This is a timed command: the bridge must send it inside a timed interaction, so timed_request_timeout_ms is required.

Command: RemoveNetwork

Purpose

Removes the network with the given Extended PAN ID from the ThreadNetworks attribute.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1107,
    "command_name": "RemoveNetwork",
    "payload": {
      "extendedPanID": "AQID"
    },
    "timed_request_timeout_ms": 1000
  }
}

This is a timed command: the bridge must send it inside a timed interaction, so timed_request_timeout_ms is required.

Command: GetOperationalDataset

Purpose

Retrieves the Thread Operational Dataset with the given Extended PAN ID.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1107,
    "command_name": "GetOperationalDataset",
    "payload": {
      "extendedPanID": "AQID"
    }
  }
}

The device answers with OperationalDatasetResponse (see below).

Command: OperationalDatasetResponse

Purpose

Contains the Thread Operational Dataset for the Extended PAN specified in GetOperationalDataset.

Command Identity

Response Fields

Cluster 1107 Events

Cluster 1107 defines no events.

SmartphoneKey Notes

• Cluster 1107 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/1107/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.