Matter Cluster 80 — Mode Select Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 80 values in the device shadow use this format:

endpoint_id / 80 / attribute_id

Example:

{
  "1/80/0": "example"
}

Cluster 80 Features

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

ModeOptionStruct (struct)

This is a struct representing a possible mode of the server.

SemanticTagStruct (struct)

A Semantic Tag is meant to be interpreted by the client for the purpose the cluster serves.

Cluster 80 Attributes

Cluster 80 defines 6 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 — Description

Path example:

1/80/0

This attribute describes the purpose of the server, in readable text. For example, a coffee machine may have a Mode Select cluster for the amount of milk to add, and another Mode Select cluster for the amount of sugar to add. In this case, the first instance can have the description Milk and the second instance can have the description Sugar. This allows the user to tell the purpose of each of the instances.

Example:

{
  "1/80/0": "example"
}

Attribute 1 / 0x0001 — StandardNamespace

Path example:

1/80/1

This attribute, when not null, indicates a single standard namespace for any standard semantic tag value supported in this or any other cluster instance with the same value of this attribute. A null value indicates no standard namespace, and therefore, no standard semantic tags are provided in this cluster instance. Each standard namespace and corresponding values and value meanings is defined in another document.

Example:

{
  "1/80/1": 0
}

Attribute 2 / 0x0002 — SupportedModes

Path example:

1/80/2

This attribute is the list of supported modes that may be selected for the CurrentMode attribute. Each item in this list represents a unique mode as indicated by the Mode field of the ModeOptionStruct. Each entry in this list has a unique value for the Mode field.

Each entry is a ModeOptionStruct (see Data Types).

Example:

{
  "1/80/2": []
}

Attribute 3 / 0x0003 — CurrentMode

Path example:

1/80/3

This attribute represents the current mode of the server. The value of this field must match the Mode field of one of the entries in the SupportedModes attribute.

Example:

{
  "1/80/3": 1
}

Attribute 4 / 0x0004 — StartUpMode

Path example:

1/80/4

The StartUpMode attribute value indicates the desired startup mode for the server when it is supplied with power. If this attribute is not null, the CurrentMode attribute is set to the StartUpMode value, when the server is powered up, except in the case when the OnMode attribute overrides the StartUpMode attribute. This behavior does not apply to reboots associated with OTA. After an OTA restart, the CurrentMode attribute returns to its value prior to the restart.

Example:

{
  "1/80/4": 1
}

Attribute 5 / 0x0005 — OnMode

Path example:

1/80/5

Indicates the value of CurrentMode that depends on the state of the On/Off cluster on the same endpoint. If this attribute is not present or is set to null, it must NOT have an effect, otherwise the CurrentMode attribute must depend on the OnOff attribute of the On/Off cluster The value of this field must match the Mode field of one of the entries in the SupportedModes attribute.

Example:

{
  "1/80/5": 1
}

Cluster 80 Commands

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

AcceptedCommandList

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

endpoint_id / 80 / 65529

{
  "1/80/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": 80,
    "command_name": "ChangeToMode",
    "payload": {},
    "timed_request_timeout_ms": 1000
  }
}

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

Purpose

On receipt of this command, if the NewMode field indicates a valid mode transition within the supported list, the server must set the CurrentMode attribute to the NewMode value, otherwise, the server must respond with an INVALID_COMMAND status response.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 80,
    "command_name": "ChangeToMode",
    "payload": {
      "newMode": 1
    }
  }
}

Cluster 80 Events

Cluster 80 defines no events.

SmartphoneKey Notes

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