Matter Cluster 1792 — Commodity Tariff Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1792 values in the device shadow use this format:

endpoint_id / 1792 / attribute_id

Example:

{
  "1/1792/0": {
    "tariffLabel": "example",
    "providerName": "example",
    "currency": 0,
    "blockMode": 0
  }
}

Cluster 1792 Features

The FeatureMap attribute (1/1792/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; 63 means every feature listed above is enabled.

Data Types

AuxiliaryLoadSettingEnum

This enumeration must indicated the required state of an auxiliary switch.

BlockModeEnum

DayEntryRandomizationTypeEnum

DayTypeEnum

PeakPeriodSeverityEnum

DayPatternDayOfWeekBitmap (bitmap)

AuxiliaryLoadSwitchSettingsStruct (struct)

This represents the settings for a given auxiliary load switch in a tariff component.

AuxiliaryLoadSwitchesSettingsStruct (struct)

This represents the set of auxiliary load settings in a tariff component.

CalendarPeriodStruct (struct)

This represents a sub period of a calendar, commencing on its StartDate. A 'Calendar Period', while normally considered to be a 3 or 6 month period, could be used for other arbitrary periods e.g. monthly or quarterly.

DayEntryStruct (struct)

This struct represents a day entry at a particular time of day, along with an optional duration and randomization parameters.

DayPatternStruct (struct)

This represents a series of day entries over the course of a day for a given set of days of the week.

DayStruct (struct)

This represents a series of day entries over the course of a day for a specific date.

PeakPeriodStruct (struct)

TariffComponentStruct (struct)

This represents components of a tariff. Tariff components typically represent a price or price level, though they may also specify other aspects of a tariff.

TariffInformationStruct (struct)

This represents particular Tariff Price information.

TariffPeriodStruct (struct)

This represents the tariff components in effect for a set of calendar day entry IDs.

TariffPriceStruct (struct)

This indicates a price or price level for a given tariff component, as well as what type of pricing it represents

Cluster 1792 Attributes

Cluster 1792 defines 19 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 — TariffInfo

Path example:

1/1792/0

Indicates basic information about the tariff. If the tariff is unavailable, this attribute is null.

Value is a TariffInformationStruct struct (see Data Types).

Example:

{
  "1/1792/0": {
    "tariffLabel": "example",
    "providerName": "example",
    "currency": 0,
    "blockMode": 0
  }
}

Attribute 1 / 0x0001 — TariffUnit

Path example:

1/1792/1

Indicates the unit of the commodity for pricing. If the tariff is unavailable, this attribute is null.

Example:

{
  "1/1792/1": 0
}

Attribute 2 / 0x0002 — StartDate

Path example:

1/1792/2

Indicates a timestamp in UTC to denote the time at which the published calendar becomes active. A start date/time of 0x00000000 indicates that the calendar should become active immediately. If the tariff is unavailable, this attribute is null.

Example:

{
  "1/1792/2": 1
}

Attribute 3 / 0x0003 — DayEntries

Path example:

1/1792/3

Indicates the list of DayEntryStructs included in this calendar. The maximum constraint of this attribute is intended to allow representation of seven days of tariff information at 15 minute intervals. If the tariff is unavailable, this attribute is null.

Each entry is a DayEntryStruct (see Data Types).

Example:

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

Attribute 4 / 0x0004 — DayPatterns

Path example:

1/1792/4

Indicates the list of DayPatternStructs used in the CalendarPeriodStruct in this calendar. Each day pattern in this list must define the specific schedule that applies to the days it covers.

Each entry is a DayPatternStruct (see Data Types).

Example:

{
  "1/1792/4": []
}

Attribute 5 / 0x0005 — CalendarPeriods

Path example:

1/1792/5

Indicates the list of CalendarPeriodStructs comprising this calendar. The CalendarPeriodStructs in this list is arranged in increasing order by the value of StartDate. If and only if the value of the StartDate attribute is null, the value of the StartDate field on the first CalendarPeriodStruct in the CalendarPeriods attribute must also be null, indicating that the period begins immediately. The value of the StartDate field on any subsequent CalendarPeriodStruct in CalendarPeriods must NOT be null.

Each entry is a CalendarPeriodStruct (see Data Types).

Example:

{
  "1/1792/5": []
}

Attribute 6 / 0x0006 — IndividualDays

Path example:

1/1792/6

Indicates the list of days to overlay on this calendar. The DayStruct in this list is arranged in increasing order by the value of Date. The DayStruct in this list must not overlap. If the calendar is unavailable, this attribute is null.

Each entry is a DayStruct (see Data Types).

Example:

{
  "1/1792/6": []
}

Attribute 7 / 0x0007 — CurrentDay

Path example:

1/1792/7

Indicates the current day's day entries. If the tariff is not active or CurrentDay information is not available, this attribute is null.

Value is a DayStruct struct (see Data Types).

Example:

{
  "1/1792/7": {
    "date": 1,
    "dayType": 0,
    "dayEntryIDs": []
  }
}

Attribute 8 / 0x0008 — NextDay

Path example:

1/1792/8

Indicates the next day's day entries. If the tariff is not active or NextDay information is not available, this attribute is null.

Value is a DayStruct struct (see Data Types).

Example:

{
  "1/1792/8": {
    "date": 1,
    "dayType": 0,
    "dayEntryIDs": []
  }
}

Attribute 9 / 0x0009 — CurrentDayEntry

Path example:

1/1792/9

Indicates the currently active DayEntryStruct. If the tariff is not active or day entry information is not available, this attribute is null.

Value is a DayEntryStruct struct (see Data Types).

Example:

{
  "1/1792/9": {
    "dayEntryID": 1,
    "startTime": 0,
    "duration": 1,
    "randomizationOffset": 1
  }
}

Attribute 10 / 0x000A — CurrentDayEntryDate

Path example:

1/1792/10

Indicates the UTC date when the CurrentDay, CurrentDayEntry, and CurrentTariffComponents attributes were last updated. If the tariff is not active or day entry information is not available, this attribute is null.

Example:

{
  "1/1792/10": 1
}

Attribute 11 / 0x000B — NextDayEntry

Path example:

1/1792/11

Indicates the predicted next active DayEntryStruct. If the tariff is not active or is not available, this attribute is null.

Value is a DayEntryStruct struct (see Data Types).

Example:

{
  "1/1792/11": {
    "dayEntryID": 1,
    "startTime": 0,
    "duration": 1,
    "randomizationOffset": 1
  }
}

Attribute 12 / 0x000C — NextDayEntryDate

Path example:

1/1792/12

Indicates the predicted UTC date when the CurrentDay, CurrentDayEntry, and CurrentTariffComponents attributes will update to the values in the NextDay, NextDayEntry, and NextTariffComponents attributes, respectively. If the tariff is not active or is not available, this attribute is null.

Example:

{
  "1/1792/12": 1
}

Attribute 13 / 0x000D — TariffComponents

Path example:

1/1792/13

Indicates a list of TariffComponentStructs for the tariff. If the tariff is unavailable, this attribute is empty.

Each entry is a TariffComponentStruct (see Data Types).

Example:

{
  "1/1792/13": []
}

Attribute 14 / 0x000E — TariffPeriods

Path example:

1/1792/14

Indicates a list of TariffPeriodStructs for the tariff. If the tariff is unavailable, this attribute is empty.

Each entry is a TariffPeriodStruct (see Data Types).

Example:

{
  "1/1792/14": []
}

Attribute 15 / 0x000F — CurrentTariffComponents

Path example:

1/1792/15

Indicates a list of the currently active TariffComponentStructs. If the tariff is unavailable, this attribute is empty.

Each entry is a TariffComponentStruct (see Data Types).

Example:

{
  "1/1792/15": []
}

Attribute 16 / 0x0010 — NextTariffComponents

Path example:

1/1792/16

Indicates the predicted next active TariffComponentStructs. If the tariff is unavailable, this attribute is null.

Each entry is a TariffComponentStruct (see Data Types).

Example:

{
  "1/1792/16": []
}

Attribute 17 / 0x0011 — DefaultRandomizationOffset

Path example:

1/1792/17

Indicates a default randomization offset for DayEntryStructs in this tariff. See RandomizationOffset for details.

Example:

{
  "1/1792/17": 1
}

Attribute 18 / 0x0012 — DefaultRandomizationType

Path example:

1/1792/18

Indicates a default randomization type for DayEntryStruct in this tariff. See RandomizationType for details.

Values (DayEntryRandomizationTypeEnum):

Example:

{
  "1/1792/18": 0
}

Cluster 1792 Commands

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

AcceptedCommandList

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

endpoint_id / 1792 / 65529

{
  "1/1792/65529": [
    0,
    1
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

The GetTariffComponent command allows a client to request information for a tariff component identifier that may no longer be available in the TariffPeriods attributes.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1792,
    "command_name": "GetTariffComponent",
    "payload": {
      "tariffComponentID": 1
    }
  }
}

The device answers with GetTariffComponentResponse (see below).

Command: GetTariffComponentResponse

Purpose

The GetTariffComponentResponse command is sent in response to a GetTariffComponent command.

Command Identity

Response Fields

Command: GetDayEntry

Purpose

The GetDayEntry command allows a client to request information for a calendar day entry identifier that may no longer be available in the CalendarPeriods or IndividualDays attributes.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1792,
    "command_name": "GetDayEntry",
    "payload": {
      "dayEntryID": 1
    }
  }
}

The device answers with GetDayEntryResponse (see below).

Command: GetDayEntryResponse

Purpose

The GetDayEntryResponse command is sent in response to a GetDayEntry command.

Command Identity

Response Fields

Cluster 1792 Events

Cluster 1792 defines no events.

SmartphoneKey Notes

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