Matter Cluster 159 — Device Energy Management Mode Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 159 values in the device shadow use this format:

endpoint_id / 159 / attribute_id

Example:

{
  "1/159/0": 0
}

Cluster 159 Features

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

ModeTag

ModeOptionStruct (struct)

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

ModeTagStruct (struct)

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

Cluster 159 Attributes

Cluster 159 defines 4 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 — SupportedModes

Path example:

1/159/0

At least one entry in the SupportedModes attribute includes the NoOptimization mode tag in the ModeTags field. At least one entry in the SupportedModes attribute includes the LocalOptimization mode tag in the ModeTags field list. At least one entry in the SupportedModes attribute includes the GridOptimization mode tag in the ModeTags field list. An entry in the SupportedModes attribute that includes one of an DeviceOptimization, LocalOptimization, or GridOptimization tags must NOT also include NoOptimization tag.

Example:

{
  "1/159/0": 0
}

Attribute 1 / 0x0001 — CurrentMode

Path example:

1/159/1

No condensed specification text is available for CurrentMode; use the type, conformance and constraint below together with the cluster description above.

Example:

{
  "1/159/1": 0
}

Attribute 2 / 0x0002 — StartUpMode

Path example:

1/159/2

No condensed specification text is available for StartUpMode; use the type, conformance and constraint below together with the cluster description above.

Example:

{
  "1/159/2": 0
}

Attribute 3 / 0x0003 — OnMode

Path example:

1/159/3

No condensed specification text is available for OnMode; use the type, conformance and constraint below together with the cluster description above.

Example:

{
  "1/159/3": 0
}

Cluster 159 Commands

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

AcceptedCommandList

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

endpoint_id / 159 / 65529

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

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

This command is used to change device modes. On receipt of this command the device must respond with a ChangeToModeResponse command.

Command Identity

Payload Fields

Bridge Command Example

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

The device answers with ChangeToModeResponse (see below).

Command: ChangeToModeResponse

Purpose

This command is sent by the device on receipt of the ChangeToMode command.

Command Identity

Response Fields

Cluster 159 Events

Cluster 159 defines no events.

SmartphoneKey Notes

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