Matter Cluster 1284 — Channel Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1284 values in the device shadow use this format:

endpoint_id / 1284 / attribute_id

Example:

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

Cluster 1284 Features

The FeatureMap attribute (1/1284/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; 15 means every feature listed above is enabled.

Data Types

ChannelTypeEnum

LineupInfoTypeEnum

StatusEnum

RecordingFlagBitmap (bitmap)

ChannelInfoStruct (struct)

This indicates a channel in a channel lineup. While the major and minor numbers in the ChannelInfoStruct support use of ATSC channel format, a lineup may use other formats which can map into these numeric values.

ChannelPagingStruct (struct)

This object defines the paging structure that includes the previous and next pagination tokens.

LineupInfoStruct (struct)

The Lineup Info allows references to external lineup sources like Gracenote. The combination of OperatorName, LineupName, and PostalCode must uniquely identify a lineup.

PageTokenStruct (struct)

This object defines the pagination structure.

ProgramCastStruct (struct)

This object provides the cast information related to a program.

ProgramCategoryStruct (struct)

This object defines the category associated to a program.

ProgramStruct (struct)

This indicates a program within an electronic program guide (EPG).

SeriesInfoStruct (struct)

This object provides the episode information related to a program.

Cluster 1284 Attributes

Cluster 1284 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 — ChannelList

Path example:

1/1284/0

This attribute provides the list of supported channels.

Each entry is a ChannelInfoStruct (see Data Types).

Example:

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

Attribute 1 / 0x0001 — Lineup

Path example:

1/1284/1

This attribute identifies the channel lineup using external data sources.

Value is a LineupInfoStruct struct (see Data Types).

Example:

{
  "1/1284/1": {
    "operatorName": "example",
    "lineupName": "example",
    "postalCode": "example",
    "lineupInfoType": 0
  }
}

Attribute 2 / 0x0002 — CurrentChannel

Path example:

1/1284/2

This attribute contains the current channel. When supported but a channel is not currently tuned to (if a content application is in foreground), the value of the field is null.

Value is a ChannelInfoStruct struct (see Data Types).

Example:

{
  "1/1284/2": {
    "majorNumber": 1,
    "minorNumber": 1,
    "name": "example",
    "callSign": "example"
  }
}

Cluster 1284 Commands

Cluster 1284 has 6 client-to-server commands and 2 responses.

AcceptedCommandList

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

endpoint_id / 1284 / 65529

{
  "1/1284/65529": [
    0,
    2,
    3,
    4,
    6,
    7
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

Change the channel to the channel case-insensitive exact matching the value passed as an argument. The match priority order is: Identifier, AffiliateCallSign, CallSign, Name, Number. In the match string, the Channel number should be presented in the Major.Minor format, such as 13.1. Upon receipt, this must generate a ChangeChannelResponse command.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1284,
    "command_name": "ChangeChannel",
    "payload": {
      "match": "example"
    }
  }
}

The device answers with ChangeChannelResponse (see below).

Command: ChangeChannelResponse

Purpose

This command is generated in response to a ChangeChannel command.

Command Identity

Response Fields

Status values (StatusEnum): 0 = Success, 1 = MultipleMatches, 2 = NoMatches

Command: ChangeChannelByNumber

Purpose

Change the channel to the channel with the given Number in the ChannelList attribute.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1284,
    "command_name": "ChangeChannelByNumber",
    "payload": {
      "majorNumber": 1,
      "minorNumber": 1
    }
  }
}

Command: SkipChannel

Purpose

This command provides channel up and channel down functionality, but allows channel index jumps of size Count. Jumps are relative to the available list of channels. For example, when the current channel is 100.0 and the list of available channels is [100.0, 200.0, 201.0, 305.1], a SkipChannel command with jump value of 2 must change the channel to 201.0. When the value of the increase or decrease is larger than the number of channels remaining in the given direction, then the behavior is to return to the beginning (or end) of the channel list and continue.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1284,
    "command_name": "SkipChannel",
    "payload": {
      "count": 1
    }
  }
}

Command: GetProgramGuide

Purpose

This command retrieves the program guide. It accepts several filter parameters to return specific schedule and program information from a content app. The command must receive in response a ProgramGuideResponse. Standard error codes is used when arguments provided are not valid.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1284,
    "command_name": "GetProgramGuide",
    "payload": {
      "startTime": 0,
      "endTime": 0
    }
  }
}

The device answers with ProgramGuideResponse (see below).

Command: ProgramGuideResponse

Purpose

This command is a response to the GetProgramGuide command.

Command Identity

Response Fields

Command: RecordProgram

Purpose

Record a specific program or series when it goes live. This functionality enables DVR recording features.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1284,
    "command_name": "RecordProgram",
    "payload": {
      "programIdentifier": "example",
      "shouldRecordSeries": true
    }
  }
}

Command: CancelRecordProgram

Purpose

Cancel recording for a specific program or series.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1284,
    "command_name": "CancelRecordProgram",
    "payload": {
      "programIdentifier": "example",
      "shouldRecordSeries": true
    }
  }
}

Cluster 1284 Events

Cluster 1284 defines no events.

SmartphoneKey Notes

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