Media1285 — Target Navigator

Matter Cluster 1285 — Target Navigator

Matter Cluster 1285 (0x0505) Target Navigator: attributes, commands, events, data types, shadow paths and bridge payload examples.

Matter Cluster 1285 — Target Navigator Cluster

Matter Cluster 1285, also written as 0x0505, is the Target Navigator Cluster. This cluster provides an interface for UX navigation within a set of targets on a device or endpoint. This cluster would be supported on Video Player devices or devices with navigable user interfaces. This cluster would also be supported on endpoints with navigable user interfaces such as a Content App.

Cluster Identity

FieldValue
Cluster ID decimal1285
Cluster ID hex0x0505
Cluster nameTarget Navigator
Cluster revision (Matter 1.6.1)2
Roleapplication
ScopeEndpoint
PICS codeTGTNAV
Typical endpoint1

Revision history

RevisionChange
1Initial revision
2Add TargetUpdated event

Shadow Path Format

Cluster 1285 values in the device shadow use this format:

endpoint_id / 1285 / attribute_id

Example:

{
  "1/1285/0": []
}
PartMeaning
1Endpoint ID
1285Target Navigator cluster
0TargetList attribute

Data Types

StatusEnum

ValueNameConformanceMeaning
0SuccessMCommand succeeded
1TargetNotFoundMRequested target was not found in the TargetList
2NotAllowedMTarget request is not allowed in current state.

TargetInfoStruct (struct)

This indicates an object describing the navigable target.

FieldNameTypeConformanceConstraintMeaning
0Identifieruint8Mmax 254This field contains an unique id within the TargetList.
1NamestringM—This field contains a name string for the TargetInfoStruct.

Cluster 1285 Attributes

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

IDHexAttributeTypeConformanceAccessQualitiesDefault
00x0000TargetListlist of TargetInfoStructMR (read: view)——
10x0001CurrentTargetuint8OR (read: view)—0xFF

Global attributes

IDHexAttributeMeaning
655280xFFF8GeneratedCommandListResponse command IDs this server generates.
655290xFFF9AcceptedCommandListCommand IDs this server accepts.
655310xFFFBAttributeListAttribute IDs implemented.
655320xFFFCFeatureMapImplemented optional features (see above).
655330xFFFDClusterRevisionCluster revision implemented; 2 for a Matter 1.6.1 device.

Attribute Details

Attribute 0 / 0x0000 — TargetList

Path example:

1/1285/0

Indicates a list of targets that can be navigated to within the experience presented to the user by the Endpoint (Video Player or Content App). The list must NOT contain any entries with the same Identifier in the TargetInfoStruct object.

PropertyValue
Typelist of TargetInfoStruct
ConformanceM
AccessR (read: view)

Each entry is a TargetInfoStruct (see Data Types).

Example:

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

Attribute 1 / 0x0001 — CurrentTarget

Path example:

1/1285/1

Indicates the Identifier for the target which is currently in foreground on the corresponding Endpoint (Video Player or Content App), or 0xFF to indicate that no target is in the foreground. When not 0xFF, the CurrentTarget is an Identifier value contained within one of the TargetInfoStruct objects in the TargetList attribute.

PropertyValue
Typeuint8
ConformanceO
AccessR (read: view)
Constraintdesc
Default0xFF

Example:

{
  "1/1285/1": 1
}

Cluster 1285 Commands

Cluster 1285 has 1 client-to-server command and 1 response.

IDHexCommandDirectionConformanceResponseDescription
00x00NavigateTargetclient → serverMNavigateTargetResponseOn receipt, this must navigation the UX to the target identified.
10x01NavigateTargetResponseserver → clientM—This command is generated in response to NavigateTarget command.

AcceptedCommandList

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

endpoint_id / 1285 / 65529
{
  "1/1285/65529": [
    0
  ]
}

Before sending a Cluster 1285 command, check that the command ID exists in endpoint/1285/65529. Optional commands are only present when the matching feature is set in FeatureMap.


Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

On receipt, this must navigation the UX to the target identified.

Command Identity

FieldValue
Command ID0
Command hex0x00
Command nameNavigateTarget
Directionclient → server
ConformanceM
ResponseNavigateTargetResponse
Access(invoke: operate)

Payload Fields

IDFieldPayload keyTypeConformanceConstraintMeaning
0Targettargetuint8M—Indicates the Identifier for the target for UX navigation. The Target is an Identifier value contained within one of the TargetInfoStruct objects in the TargetList attribute.
1DatadatastringO—Indicates Optional app-specific data.

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1285,
    "command_name": "NavigateTarget",
    "payload": {
      "target": 1
    }
  }
}

The device answers with NavigateTargetResponse (see below).


Command: NavigateTargetResponse

Purpose

This command is generated in response to NavigateTarget command.

Command Identity

FieldValue
Command ID1
Command hex0x01
Command nameNavigateTargetResponse
Directionserver → client (response)
ConformanceM

Response Fields

IDFieldPayload keyTypeConformanceConstraintMeaning
0StatusstatusStatusEnumM—Indicates the of the command.
1DatadatastringO—Indicates Optional app-specific data.

Status values (StatusEnum): 0 = Success, 1 = TargetNotFound, 2 = NotAllowed


Cluster 1285 Events

IDHexEventPriorityConformanceDescription
00x00TargetUpdatedinfoOThis event is generated when there is a change in either the active target or the list of available targets or both.

Event 0 — TargetUpdated

This event is generated when there is a change in either the active target or the list of available targets or both.

IDFieldTypeConformanceMeaning
0TargetListlist of TargetInfoStructO—
1CurrentTargetuint8O—
2DataoctstrO—

SmartphoneKey Notes

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