BooleanStateConfiguration Cluster

Cluster ID: 0x0080  |  Endpoint: Same Endpoint as BooleanState (application endpoint)

BooleanStateConfiguration is the companion Cluster to BooleanState (0x0045) — BooleanState is responsible for reporting the sensor's binary state (true/false), while BooleanStateConfiguration is responsible for configuring sensor behavior: managing alarm outputs (visual flashing, audible buzzer) and adjusting sensor sensitivity.

Typical use case: when a contact sensor detects that a door has been opened, BooleanState's StateValue changes to false, while BooleanStateConfiguration controls whether the LED flashes (Visual), whether the buzzer sounds (Audible), and the sensor's trigger sensitivity level.

Commands

The BooleanStateConfiguration Cluster has 2 commands, used for suppressing alarms and enabling/disabling alarms respectively. Both commands use the AlarmModeBitmap to specify which alarm channels to operate on. Click a command ID in the table below to jump to its detailed description.

SuppressAlarm — Suppress Alarm (0x00)

Temporarily suppresses currently active alarms. For example, when a sensor is buzzing an alarm and the user presses the "Mute" button, the app sends this command to pause the buzzing. Suppression is not the same as disabling — the alarm channel remains enabled, and the alarm will reactivate the next time the sensor triggers. This command requires the device to support the SPRS (AlarmSuppress) feature.

↑ Back to Commands

EnableDisableAlarm — Enable/Disable Alarm (0x01)

Enables or disables specified alarm channels. This modifies the AlarmsEnabled attribute, determining which alarm channels will respond when the sensor triggers in the future. This command requires the device to support at least one alarm feature (VIS or AUD).

↑ Back to Commands

Attributes

The BooleanStateConfiguration Cluster has 7 application attributes, divided into two groups: sensitivity configuration and alarm state. Click an attribute ID in the summary table below to jump to its detailed description.

Sensitivity Configuration (0x0000 ~ 0x0002)

Controls the sensor's trigger sensitivity. Sensitivity is represented as an integer level starting from 0, where 0 is the highest sensitivity (most easily triggered) and higher values mean lower sensitivity. These attributes require the device to support the SENS (SensitivityLevel) feature.

↑ Back to Attributes

Alarm State (0x0003 ~ 0x0006)

Manages the sensor's alarm output channels. All alarm attributes use the AlarmModeBitmap type, controlling two alarm modes via bitmap: visual (LED flash) and audible (buzzer).

↑ Back to Attributes

AlarmModeBitmap

The four attributes AlarmsActive, AlarmsSuppressed, AlarmsEnabled, and AlarmsSupported, as well as the parameters of both commands, all use the same AlarmModeBitmap definition. Each bit represents an alarm output channel:

Events

BooleanStateConfiguration defines one AlarmsStateChanged event, which the device proactively reports when any alarm state changes.

AlarmsStateChanged — Alarm State Change Event (0x00)

When the alarm state changes (alarm activated, cleared, or suppressed), the device generates this event. The event carries a complete snapshot of the alarm state after the change. Controllers should subscribe to this event to receive real-time alarm change notifications.

Event report example (visual alarm active, audible alarm suppressed):

{
  "eventReports": [{
    "eventData": {
      "path": {
        "endpointId": 1,
        "clusterId": "0x0080",
        "eventId": "0x00"       // AlarmsStateChanged
      },
      "eventNumber": 15,
      "priority": "INFO",
      "data": {
        "0": "0x01",            // AlarmsActive = 0x01 (visual alarm active)
        "1": "0x02"             // AlarmsSuppressed = 0x02 (audible alarm suppressed)
      }
    }
  }]
}

↑ Back to Events

Feature Bitmap

BooleanStateConfiguration declares its supported capabilities via FeatureMap (0xFFFC):

Example Data

Reading BooleanStateConfiguration attributes from a contact sensor that supports visual alarms, audible alarms, and sensitivity adjustment:

{
  // --- Sensitivity Configuration (SENS feature) ---
  "0x0000": 1,              // CurrentSensitivityLevel = 1 (current sensitivity level)
  "0x0001": 3,              // SupportedSensitivityLevels = 3 (supports levels 0/1/2)
  "0x0002": 1,              // DefaultSensitivityLevel = 1 (factory default level)

  // --- Alarm State (VIS + AUD features) ---
  "0x0003": "0x03",         // AlarmsActive = 0x03 (both visual + audible alarms active)
  "0x0004": "0x00",         // AlarmsSuppressed = 0x00 (no alarms suppressed)
  "0x0005": "0x03",         // AlarmsEnabled = 0x03 (both visual + audible alarms enabled)
  "0x0006": "0x03"          // AlarmsSupported = 0x03 (device supports visual + audible alarms)
}

Common Scenarios