Matter Cluster 128 — Boolean State Configuration Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 128 values in the device shadow use this format:

endpoint_id / 128 / attribute_id

Example:

{
  "1/128/0": 100
}

Cluster 128 Features

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

Data Types

AlarmModeBitmap (bitmap)

SensorFaultBitmap (bitmap)

Cluster 128 Attributes

Cluster 128 defines 8 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 — CurrentSensitivityLevel

Path example:

1/128/0

Indicates the currently selected sensitivity level. If a write interaction to this attribute contains an unsupported sensitivity value, a CONSTRAINT_ERROR status is returned.

Example:

{
  "1/128/0": 100
}

Attribute 1 / 0x0001 — SupportedSensitivityLevels

Path example:

1/128/1

Indicates the number of supported sensitivity levels by the device. These supported sensitivity levels is ordered by sensitivity, where a value of 0 is considered the lowest sensitivity level (least sensitive) and the highest supported value is considered the highest sensitivity level. The number of supported sensitivity levels should represent unique sensitivity levels supported by the device.

Example:

{
  "1/128/1": 2
}

Attribute 2 / 0x0002 — DefaultSensitivityLevel

Path example:

1/128/2

Indicates the default sensitivity level selected by the manufacturer.

Example:

{
  "1/128/2": 100
}

Attribute 3 / 0x0003 — AlarmsActive

Path example:

1/128/3

Indicates which specific alarm modes on the server are currently active. When the sensor is no longer triggered, this attribute is set to the inactive state, by setting the bit to 0, for all supported alarm modes. If an alarm mode is not supported, the bit indicating this alarm mode must always be 0. A bit indicates whether the alarm mode inactive or not: - 0 = Inactive - 1 = Active

Bits (AlarmModeBitmap):

Example:

{
  "1/128/3": 0
}

Attribute 4 / 0x0004 — AlarmsSuppressed

Path example:

1/128/4

Indicates which specific alarm modes on the server are currently suppressed. When the sensor is no longer triggered, this attribute is set to the unsuppressed state, by setting the bit to 0, for all supported alarm modes. If an alarm mode is not supported, the bit indicating this alarm mode must always be 0. A bit indicates whether the alarm mode is suppressed or not: - 0 = Not suppressed - 1 = Suppressed

Bits (AlarmModeBitmap):

Example:

{
  "1/128/4": 0
}

Attribute 5 / 0x0005 — AlarmsEnabled

Path example:

1/128/5

Indicates the alarm modes that will be emitted if the sensor is triggered. If an alarm mode is not supported, the bit indicating this alarm mode must always be 0. A bit indicates whether the alarm mode is enabled or disabled: - 0 = Disabled - 1 = Enabled

Bits (AlarmModeBitmap):

Example:

{
  "1/128/5": 0
}

Attribute 6 / 0x0006 — AlarmsSupported

Path example:

1/128/6

Indicates the alarms supported by the sensor. A bit indicates whether the alarm mode is supported: - 0 = Not supported - 1 = Supported

Bits (AlarmModeBitmap):

Example:

{
  "1/128/6": 0
}

Attribute 7 / 0x0007 — SensorFault

Path example:

1/128/7

Indicates any faults registered by the device.

Bits (SensorFaultBitmap):

Example:

{
  "1/128/7": 0
}

Cluster 128 Commands

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

AcceptedCommandList

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

endpoint_id / 128 / 65529

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

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

Purpose

This command will suppress the alarm modes specified.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 128,
    "command_name": "SuppressAlarm",
    "payload": {
      "alarmsToSuppress": 0
    }
  }
}

Command: EnableDisableAlarm

Purpose

This command allows setting the enable or disable value for the specified alarm modes.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 128,
    "command_name": "EnableDisableAlarm",
    "payload": {
      "alarmsToEnableDisable": 0
    }
  }
}

Cluster 128 Events

Event 0 — AlarmsStateChanged

This event is generated after any bits in the AlarmsActive and/or AlarmsSuppressed attributes change. This may occur in situations such as when internal processing by the server determines that an alarm mode becomes active or inactive, or when the SuppressAlarm or EnableDisableAlarm commands are processed in a way that some alarm modes becomes suppressed, active or inactive. If several alarm modes change state at the same time, a single event combining multiple changes may be emitted instead of multiple events each representing a single change.

Event 1 — SensorFault

This event is generated when the device registers or clears a fault.

SmartphoneKey Notes

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