Matter Cluster 1287 — Media Input Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1287 values in the device shadow use this format:

endpoint_id / 1287 / attribute_id

Example:

{
  "1/1287/1": 1
}

Cluster 1287 Features

The FeatureMap attribute (1/1287/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.

Data Types

InputTypeEnum

InputInfoStruct (struct)

This contains information about an input.

Cluster 1287 Attributes

Cluster 1287 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 — InputList

Path example:

1/1287/0

This attribute provides a list of the media inputs supported by the device.

Each entry is a InputInfoStruct (see Data Types).

Example:

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

Attribute 1 / 0x0001 — CurrentInput

Path example:

1/1287/1

This attribute contains the value of the index field of the currently selected InputInfoStruct.

Example:

{
  "1/1287/1": 1
}

Cluster 1287 Commands

Cluster 1287 has 4 client-to-server commands and 0 responses.

AcceptedCommandList

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

endpoint_id / 1287 / 65529

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

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

On receipt, this command must change the media input on the device to the input at a specific index in the Input List.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1287,
    "command_name": "SelectInput",
    "payload": {
      "index": 1
    }
  }
}

Command: ShowInputStatus

Purpose

On receipt, this command must display the active status of the input list on screen.

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": 1287,
    "command_name": "ShowInputStatus",
    "payload": {}
  }
}

Command: HideInputStatus

Purpose

On receipt, this command must hide the input list from the screen.

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": 1287,
    "command_name": "HideInputStatus",
    "payload": {}
  }
}

Command: RenameInput

Purpose

On receipt, this command must rename the input at a specific index in the Input List. Updates to the input name must appear in the device's settings menus.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1287,
    "command_name": "RenameInput",
    "payload": {
      "index": 1,
      "name": "example"
    }
  }
}

Cluster 1287 Events

Cluster 1287 defines no events.

SmartphoneKey Notes

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