Matter Cluster 1366 — Chime Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1366 values in the device shadow use this format:

endpoint_id / 1366 / attribute_id

Example:

{
  "1/1366/1": 1
}

Data Types

ChimeSoundStruct (struct)

This struct is used to encode information needed to define a Chime Sound.

Cluster 1366 Attributes

Cluster 1366 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 — InstalledChimeSounds

Path example:

1/1366/0

This attribute contains all installed chime sounds, represented by a list of Chime Sounds. Each entry in this list has a unique ChimeID value and a unique Name value.

Each entry is a ChimeSoundStruct (see Data Types).

Example:

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

Attribute 1 / 0x0001 — SelectedChime

Path example:

1/1366/1

Indicates the currently selected chime sound that will be played when PlayChimeSound is invoked and is the ChimeID value for the requested Chime Sound within InstalledChimeSounds. This attribute may be written by the client to request a different chime sound. An attempt to write a value that is not contained within InstalledChimeSounds is failed with a NOT_FOUND response. Writes to this attribute while a chime is currently playing must NOT affect the playback in progress and only apply starting at the next PlayChimeSound command invocation.

Example:

{
  "1/1366/1": 1
}

Attribute 2 / 0x0002 — Enabled

Path example:

1/1366/2

Indicates if chime sounds can currently be played or not, and may be written by the client to enable / disable playing of chime sounds.

Example:

{
  "1/1366/2": true
}

Cluster 1366 Commands

Cluster 1366 has 1 client-to-server command and 0 responses.

AcceptedCommandList

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

endpoint_id / 1366 / 65529

{
  "1/1366/65529": [
    0
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

This command will play the currently selected chime or the chime passed in. In either case the server must generate the ChimeStartedPlaying event.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1366,
    "command_name": "PlayChimeSound",
    "payload": {
      "chimeID": 1
    }
  }
}

Cluster 1366 Events

Event 0 — ChimeStartedPlaying

This event indicates a Chime sound has just started playing. The data on this event contains the following information.

SmartphoneKey Notes

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