Matter Cluster 87 — Refrigerator Alarm Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 87 values in the device shadow use this format:

endpoint_id / 87 / attribute_id

Example:

{
  "1/87/0": 0
}

Cluster 87 Features

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

AlarmBitmap (bitmap)

This data type is a map32 with values defined by the derived cluster. The meaning of each bit position is consistent for all attributes in a derived cluster.

Cluster 87 Attributes

Cluster 87 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 — Mask

Path example:

1/87/0

Indicates a bitmap where each bit set in the Mask attribute corresponds to an alarm that is enabled.

Bits (AlarmBitmap):

Example:

{
  "1/87/0": 0
}

Attribute 1 / 0x0001 — Latch

Path example:

1/87/1

Indicates a bitmap where each bit set in the Latch attribute indicates that the corresponding alarm will be latched when set, and will not reset to inactive when the underlying condition which caused the alarm is no longer present, and so requires an explicit reset using the Reset command.

Bits (AlarmBitmap):

Example:

{
  "1/87/1": 0
}

Attribute 2 / 0x0002 — State

Path example:

1/87/2

Indicates a bitmap where each bit represents the state of an alarm. The value of true means the alarm is active, otherwise the alarm is inactive.

Bits (AlarmBitmap):

Example:

{
  "1/87/2": 0
}

Attribute 3 / 0x0003 — Supported

Path example:

1/87/3

Indicates a bitmap where each bit represents whether or not an alarm is supported. The value of true means the alarm is supported, otherwise the alarm is not supported. If an alarm is not supported, the corresponding bit in Mask, Latch, and State is false.

Bits (AlarmBitmap):

Example:

{
  "1/87/3": 0
}

Cluster 87 Commands

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

AcceptedCommandList

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

endpoint_id / 87 / 65529

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

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

Purpose

This command resets active and latched alarms (if possible). Any generated Notify event contains fields that represent the state of the server after the command has been processed.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 87,
    "command_name": "Reset",
    "payload": {
      "alarms": 0
    }
  }
}

Command: ModifyEnabledAlarms

Purpose

ModifyEnabledAlarms is a server response of the Refrigerator Alarm cluster.

Command Identity

Payload Fields

This response has no fields.

Cluster 87 Events

Event 0 — Notify

This event is generated when one or more alarms change state.

SmartphoneKey Notes

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