Appliances93 — Dishwasher Alarm

Matter Cluster 93 — Dishwasher Alarm

Matter Cluster 93 (0x005D) Dishwasher Alarm: attributes, commands, events, data types, shadow paths and bridge payload examples.

Matter Cluster 93 — Dishwasher Alarm Cluster

Matter Cluster 93, also written as 0x005D, is the Dishwasher Alarm Cluster. This cluster is a derived cluster of the Alarm Base cluster and provides the alarm definition related to dishwasher devices.

This cluster is derived from the Alarm Base cluster: it inherits the base attributes, commands and data types listed below and adds the cluster-specific values. Where the base definition applies, the base text is used.

Cluster Identity

FieldValue
Cluster ID decimal93
Cluster ID hex0x005D
Cluster nameDishwasher Alarm
Cluster revision (Matter 1.6.1)1
Roleapplication
ScopeEndpoint
PICS codeDISHALM
Typical endpoint1

Revision history

RevisionChange
1Initial revision

Shadow Path Format

Cluster 93 values in the device shadow use this format:

endpoint_id / 93 / attribute_id

Example:

{
  "1/93/0": 0
}
PartMeaning
1Endpoint ID
93Dishwasher Alarm cluster
0Mask attribute

Cluster 93 Features

The FeatureMap attribute (1/93/65532) is a bitmap. Each bit set means the device implements that feature and the attributes and commands that depend on it.

BitCodeFeatureConformanceMeaning
0RESETResetOSupports the ability to reset alarms

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.

BitNameConformanceMeaning
0InflowErrorP, OWater inflow is abnormal
1DrainErrorP, OWater draining is abnormal
2DoorErrorODoor or door lock is abnormal
3TempTooLowP, OUnable to reach normal temperature
4TempTooHighP, OTemperature is too high
5WaterLevelErrorP, OWater level is abnormal

Cluster 93 Attributes

Cluster 93 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 …".

IDHexAttributeTypeConformanceAccessQualitiesDefault
00x0000MaskAlarmBitmapMR (read: view)——
10x0001LatchAlarmBitmapRESETR (read: view)——
20x0002StateAlarmBitmapMR (read: view)——
30x0003SupportedAlarmBitmapMR (read: view)——

Global attributes

IDHexAttributeMeaning
655280xFFF8GeneratedCommandListResponse command IDs this server generates.
655290xFFF9AcceptedCommandListCommand IDs this server accepts.
655310xFFFBAttributeListAttribute IDs implemented.
655320xFFFCFeatureMapImplemented optional features (see above).
655330xFFFDClusterRevisionCluster revision implemented; 1 for a Matter 1.6.1 device.

Attribute Details

Attribute 0 / 0x0000 — Mask

Path example:

1/93/0

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

PropertyValue
TypeAlarmBitmap
ConformanceM
AccessR (read: view)

Bits (AlarmBitmap):

BitNameMeaning
0InflowErrorWater inflow is abnormal
1DrainErrorWater draining is abnormal
2DoorErrorDoor or door lock is abnormal
3TempTooLowUnable to reach normal temperature
4TempTooHighTemperature is too high
5WaterLevelErrorWater level is abnormal

Example:

{
  "1/93/0": 0
}

Attribute 1 / 0x0001 — Latch

Path example:

1/93/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.

PropertyValue
TypeAlarmBitmap
ConformanceRESET
AccessR (read: view)

Bits (AlarmBitmap):

BitNameMeaning
0InflowErrorWater inflow is abnormal
1DrainErrorWater draining is abnormal
2DoorErrorDoor or door lock is abnormal
3TempTooLowUnable to reach normal temperature
4TempTooHighTemperature is too high
5WaterLevelErrorWater level is abnormal

Example:

{
  "1/93/1": 0
}

Attribute 2 / 0x0002 — State

Path example:

1/93/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.

PropertyValue
TypeAlarmBitmap
ConformanceM
AccessR (read: view)

Bits (AlarmBitmap):

BitNameMeaning
0InflowErrorWater inflow is abnormal
1DrainErrorWater draining is abnormal
2DoorErrorDoor or door lock is abnormal
3TempTooLowUnable to reach normal temperature
4TempTooHighTemperature is too high
5WaterLevelErrorWater level is abnormal

Example:

{
  "1/93/2": 0
}

Attribute 3 / 0x0003 — Supported

Path example:

1/93/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.

PropertyValue
TypeAlarmBitmap
ConformanceM
AccessR (read: view)

Bits (AlarmBitmap):

BitNameMeaning
0InflowErrorWater inflow is abnormal
1DrainErrorWater draining is abnormal
2DoorErrorDoor or door lock is abnormal
3TempTooLowUnable to reach normal temperature
4TempTooHighTemperature is too high
5WaterLevelErrorWater level is abnormal

Example:

{
  "1/93/3": 0
}

Cluster 93 Commands

Cluster 93 has 2 client-to-server commands and 0 responses.

IDHexCommandDirectionConformanceResponseDescription
00x00Resetclient → serverRESETstatusThis command resets active and latched alarms (if possible).
10x01ModifyEnabledAlarmsclient → serverOstatusThis command allows a client to request that an alarm be enabled or suppressed at the server.

AcceptedCommandList

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

endpoint_id / 93 / 65529
{
  "1/93/65529": [
    0,
    1
  ]
}

Before sending a Cluster 93 command, check that the command ID exists in endpoint/93/65529. Optional commands are only present when the matching feature is set in FeatureMap.


Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

FieldValue
Command ID0
Command hex0x00
Command nameReset
Directionclient → server
ConformanceRESET
Responsestatus
Access(invoke: operate)

Payload Fields

IDFieldPayload keyTypeConformanceConstraintMeaning
0AlarmsalarmsAlarmBitmapM—Indicates a bitmap where each bit set in this field corresponds to an alarm that is reset to inactive in the State attribute unless the alarm definition requires manual intervention.

Bridge Command Example

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

Command: ModifyEnabledAlarms

Purpose

This command allows a client to request that an alarm be enabled or suppressed at the server.

Command Identity

FieldValue
Command ID1
Command hex0x01
Command nameModifyEnabledAlarms
Directionclient → server
ConformanceO
Responsestatus
Access(invoke: operate)

Payload Fields

IDFieldPayload keyTypeConformanceConstraintMeaning
0MaskmaskAlarmBitmapM—Indicates a bitmap where each bit set in the this field corresponds to an alarm that should be enabled or suppressed. A value of 1 indicates that the alarm should be enabled while a value of 0 indicates that the alarm should be suppressed.

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 93,
    "command_name": "ModifyEnabledAlarms",
    "payload": {
      "mask": 0
    }
  }
}

Cluster 93 Events

IDHexEventPriorityConformanceDescription
00x00NotifyinfoMThis event is generated when one or more alarms change state.

Event 0 — Notify

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

IDFieldTypeConformanceMeaning
0ActiveAlarmBitmapMIndicates those alarms that have become active.
1InactiveAlarmBitmapMIndicates those alarms that have become inactive.
2StateAlarmBitmapMThis field is a copy of the new State attribute value that resulted in the event being generated. That is, this field has all the bits in Active set and must NOT have any of the bits in Inactive set.
3MaskAlarmBitmapMThis field is a copy of the Mask attribute when this event was generated.

SmartphoneKey Notes

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