Matter Cluster 149 — Commodity Price Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 149 values in the device shadow use this format:

endpoint_id / 149 / attribute_id

Example:

{
  "1/149/0": 0
}

Cluster 149 Features

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

CommodityPriceDetailBitmap (bitmap)

CommodityPriceComponentStruct (struct)

This represents a component of a given price; it is only used in the Components field.

CommodityPriceStruct (struct)

This represents a price over a given period.

Cluster 149 Attributes

Cluster 149 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 — TariffUnit

Path example:

1/149/0

Indicates the unit of measure for all pricing reported by this cluster.

Example:

{
  "1/149/0": 0
}

Attribute 1 / 0x0001 — Currency

Path example:

1/149/1

Indicates the currency for all pricing reported by this cluster. If the current currency is unknown, or cannot be determined, the value is null.

Example:

{
  "1/149/1": 0
}

Attribute 2 / 0x0002 — CurrentPrice

Path example:

1/149/2

Indicates the current price. If the current price is unknown, or cannot be determined, the value is null. The Description and Components fields is omitted in this attribute's value.

Value is a CommodityPriceStruct struct (see Data Types).

Example:

{
  "1/149/2": {
    "periodStart": 1,
    "periodEnd": 1,
    "price": 1,
    "priceLevel": 100
  }
}

Attribute 3 / 0x0003 — PriceForecast

Path example:

1/149/3

Indicates the forecast of upcoming price changes. If the forecast is unable to be determined, this list is empty. The list entries is in time order: - All entries except the last one has a non-null PeriodEnd. - For all entries except the first one, PeriodStart is greater than the previous entry's PeriodEnd. The Description and Components fields is omitted from CommodityPriceStructs in this attribute's value.

Each entry is a CommodityPriceStruct (see Data Types).

Example:

{
  "1/149/3": []
}

Cluster 149 Commands

Cluster 149 has 2 client-to-server commands and 2 responses.

AcceptedCommandList

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

endpoint_id / 149 / 65529

{
  "1/149/65529": [
    0,
    2
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

On receipt, this must generate a GetDetailedPrice Response command.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 149,
    "command_name": "GetDetailedPriceRequest",
    "payload": {
      "details": 0
    }
  }
}

The device answers with GetDetailedPriceResponse (see below).

Command: GetDetailedPriceResponse

Purpose

This command is generated in response to a GetDetailedPrice Request command.

Command Identity

Response Fields

Command: GetDetailedForecastRequest

Purpose

On receipt, this must generate a GetDetailedForecast Response command.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 149,
    "command_name": "GetDetailedForecastRequest",
    "payload": {
      "details": 0
    }
  }
}

The device answers with GetDetailedForecastResponse (see below).

Command: GetDetailedForecastResponse

Purpose

This command is generated in response to a GetDetailedForecast Request command.

Command Identity

Response Fields

Cluster 149 Events

Event 0 — PriceChange

This event is generated when the value of the CurrentPrice attribute changes.

SmartphoneKey Notes

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