Matter Cluster 1106 — Thread Border Router Management Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1106 values in the device shadow use this format:

endpoint_id / 1106 / attribute_id

Example:

{
  "1/1106/0": "example"
}

Cluster 1106 Features

The FeatureMap attribute (1/1106/65532) is a bitmap. Each bit set means the device implements that feature and the attributes and commands that depend on it.

Example: FeatureMap = 0 means no optional feature is enabled; 1 means every feature listed above is enabled.

Cluster 1106 Attributes

Cluster 1106 defines 6 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 — BorderRouterName

Path example:

1/1106/0

Indicates a user-friendly name identifying the device model or product of the Border Router in MeshCOP (DNS-SD service name) as defined in the Thread specification, and has the following recommended format: <VendorName> <ProductName>._meshcop._udp. An example name would be ACME Border Router (74be)._meshcop._udp.

Example:

{
  "1/1106/0": "example"
}

Attribute 1 / 0x0001 — BorderAgentID

Path example:

1/1106/1

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

Example:

{
  "1/1106/1": "AQID"
}

Attribute 2 / 0x0002 — ThreadVersion

Path example:

1/1106/2

Indicates the Thread version supported by the Thread interface configured by the cluster instance. The format must match the value mapping defined in the "Version TLV" section of the Thread specification.

Example:

{
  "1/1106/2": 1
}

Attribute 3 / 0x0003 — InterfaceEnabled

Path example:

1/1106/3

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

Example:

{
  "1/1106/3": true
}

Attribute 4 / 0x0004 — ActiveDatasetTimestamp

Path example:

1/1106/4

Null if the Thread Border Router has no dataset configured, otherwise it is the timestamp value extracted from the Active Dataset value configured by the Thread Node to which the border router is connected. This attribute is updated when a new Active dataset is configured on the Thread network to which the border router is connected.

Example:

{
  "1/1106/4": 0
}

Attribute 5 / 0x0005 — PendingDatasetTimestamp

Path example:

1/1106/5

Null if the Thread Border Router has no Pending dataset configured, otherwise it is the timestamp value extracted from the Pending Dataset value configured by the Thread Node to which the border router is connected. This attribute is updated when a new Pending dataset is configured on the Thread network to which the border router is connected.

Example:

{
  "1/1106/5": 0
}

Cluster 1106 Commands

Cluster 1106 has 4 client-to-server commands and 1 response.

AcceptedCommandList

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

endpoint_id / 1106 / 65529

{
  "1/1106/65529": [
    0,
    1,
    3,
    4
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

This command is used to request the active operational dataset of the Thread network to which the border router is connected. If the command is not executed via a CASE session, the command must fail with a status code of UNSUPPORTED_ACCESS. If an internal error occurs, then this command must fail with a FAILURE status code sent back to the initiator. Otherwise, this must generate a DatasetResponse command.

Command Identity

Payload Fields

This command has no payload fields.

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1106,
    "command_name": "GetActiveDatasetRequest",
    "payload": {}
  }
}

The device answers with DatasetResponse (see below).

Command: GetPendingDatasetRequest

Purpose

This command is used to request the pending dataset of the Thread network to which the border router is connected. If the command is not executed via a CASE session, the command must fail with a status code of UNSUPPORTED_ACCESS. If an internal error occurs, then this command must fail with a FAILURE status code sent back to the initiator. Otherwise, this must generate a DatasetResponse command.

Command Identity

Payload Fields

This command has no payload fields.

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1106,
    "command_name": "GetPendingDatasetRequest",
    "payload": {}
  }
}

The device answers with DatasetResponse (see below).

Command: DatasetResponse

Purpose

This command is sent in response to GetActiveDatasetRequest or GetPendingDatasetRequest command.

Command Identity

Response Fields

Command: SetActiveDatasetRequest

Purpose

This command is used to set the active Dataset of the Thread network to which the Border Router is connected, when there is no active dataset already.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1106,
    "command_name": "SetActiveDatasetRequest",
    "payload": {
      "activeDataset": "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: SetPendingDatasetRequest

Purpose

This command is used to set or update the pending Dataset of the Thread network to which the Border Router is connected, if the Border Router supports PAN Change. If the command is not executed via a CASE session, the command must fail with a status code of UNSUPPORTED_ACCESS. This PendingDataset field contains the pending dataset to which the Thread network should be updated. The format of the data is an octet string containing the raw Thread TLV value of the pending dataset, as defined in the Thread specification.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1106,
    "command_name": "SetPendingDatasetRequest",
    "payload": {
      "pendingDataset": "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.

Cluster 1106 Events

Cluster 1106 defines no events.

SmartphoneKey Notes

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