Matter Cluster 2050 — TLS Client Management Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 2050 values in the device shadow use this format:

endpoint_id / 2050 / attribute_id

Example:

{
  "0/2050/0": 5
}

Data Types

StatusCodeEnum

TLSEndpointStruct (struct) — fabric-scoped

This struct encodes details about a TLS Endpoint.

Cluster 2050 Attributes

Cluster 2050 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 …".

Global attributes

Attribute Details

Attribute 0 / 0x0000 — MaxProvisioned

Path example:

0/2050/0

Indicates the maximum number of per fabric TLSEndpoints that can be installed on this Node.

Example:

{
  "0/2050/0": 5
}

Attribute 1 / 0x0001 — ProvisionedEndpoints

Path example:

0/2050/1

Indicates a list of currently provisioned TLS Endpoints on this Node. The maximum length of this list when read will be the value of MaxProvisioned.

Each entry is a TLSEndpointStruct (see Data Types).

Example:

{
  "0/2050/1": []
}

Cluster 2050 Commands

Cluster 2050 has 3 client-to-server commands and 2 responses.

AcceptedCommandList

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

endpoint_id / 2050 / 65529

{
  "0/2050/65529": [
    0,
    2,
    4
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 2050,
    "command_name": "ProvisionEndpoint",
    "payload": {},
    "timed_request_timeout_ms": 1000
  }
}

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

Purpose

This command is used to provision a TLS Endpoint for the provided Hostname / Port combination.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 2050,
    "command_name": "ProvisionEndpoint",
    "payload": {
      "hostname": "AQID",
      "port": 1,
      "caid": 0,
      "ccdid": 0,
      "endpointID": 0
    }
  }
}

The device answers with ProvisionEndpointResponse (see below).

Command: ProvisionEndpointResponse

Purpose

This command is used to report the result of the ProvisionEndpoint command.

Command Identity

Response Fields

Command: FindEndpoint

Purpose

This command is used to find a TLS Endpoint by its ID. This command returns the TLSEndpointStruct for the passed in EndpointID.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 2050,
    "command_name": "FindEndpoint",
    "payload": {
      "endpointID": 0
    }
  }
}

The device answers with FindEndpointResponse (see below).

Command: FindEndpointResponse

Purpose

This command is used to report the result of the FindEndpoint command.

Command Identity

Response Fields

Command: RemoveEndpoint

Purpose

This command is used to remove a TLS Endpoint by its ID. This command is generated to request the Node remove any TLS Endpoint.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 2050,
    "command_name": "RemoveEndpoint",
    "payload": {
      "endpointID": 0
    }
  }
}

Cluster 2050 Events

Cluster 2050 defines no events.

SmartphoneKey Notes

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