Multi Binary Inputs Cluster

This cluster manages multi binary entries, it delivers the current state.

If a field of the payload starts with 0x, this means that it’s an hexadecimal representation, and if it starts with 0b, it is a binary representation.

Any multi-byte numerical value is serialized in “Big Endian” order.

Present value

The Present value information attribute set contains only the attribute representing the current state of the device.

Standard report

Report

Configuration

Read/Write

Batch report

The Present value sample type is "Unsigned 16 bits integer", the corresponding number to use in br_uncompress type is 6.

Configuration

Cluster Overview

The Multi-Binary Inputs cluster exposes several binary inputs in a single bitmap attribute.

Each bit represents one binary input:

b0 = input 1
b1 = input 2
b2 = input 3
b3 = input 4
...

For example:

present_value = 0x0005

0x0005 = 0000 0000 0000 0101b
=> b0 = 1
=> b2 = 1

Advanced Reporting Frame

An advanced reporting configuration on the present_value attribute uses the following structure:

<EP> 06 80 05 <RP> 00 00 19 <Min> <Max> <Slot...>

Example:

11 06 80 05 98 00 00 19 00 00 FF FF ...

Pattern Mode: Val and Gap

For a bitmap attribute, threshold reporting is used as a pattern matching service.

The fields Val and Gap are interpreted as follows:

The firmware checks the pattern with the following logic:

((~(Current ^ Val)) & Gap) == Gap

In plain words:

All bits set to 1 in Gap must match the value defined in Val.
All bits set to 0 in Gap are ignored.

Example: Check b0 and b2 at 1

Val = 0x0005
Gap = 0x0005

0x0005 = 0000 0000 0000 0101b
=> check b0 and b2
=> b0 must be 1
=> b2 must be 1

This condition is true when:

b2 = 1 AND b0 = 1

Example: Check b2 at 1 and b1 at 0

Val = 0x0004
Gap = 0x0006

Gap = 0x0006 => check b1 and b2
Val = 0x0004 => b2 must be 1, b1 must be 0

This condition is true when:

b2 = 1 AND b1 = 0

How to Create an OR Condition

A single pattern slot naturally creates an AND condition between all bits selected by Gap.

To create an OR condition, use several slots.

Wanted condition:
b2 = 1 AND (b0 = 1 OR b1 = 1)

Slot 1:
Val = 0x0005
Gap = 0x0005
=> b2 = 1 AND b0 = 1

Slot 2:
Val = 0x0006
Gap = 0x0006
=> b2 = 1 AND b1 = 1

Occurrences

Occurrences define how many consecutive checks must validate a condition before the slot is triggered, and how many opposite checks are required before the slot is rearmed.

Short Occurrence Format

In the short format, one byte is used for both values:

<Occ>

It is equivalent to:

OccHigh = Occ
OccLow  = Occ

Extended Occurrence Format

In the extended format, OccHigh and OccLow are configured separately:

80 <OccHigh:16> <OccLow:16>

Example:

80 00 01 00 00

OccHigh = 1
OccLow  = 0

Use OccLow = 0 when repeated reports are expected while the condition remains true.

pattern true  => trigger
pattern true  => can trigger again
pattern true  => can trigger again

Use OccLow != 0 when the slot must wait for the condition to become false before it can trigger again.

OccHigh = 1
OccLow  = 1

pattern false => armed
pattern true  => trigger
pattern true  => no new trigger
pattern false => rearmed
pattern true  => trigger again

Delta / Variation Mode

Delta mode triggers a report when the bitmap value changes compared with the last reported value.

For the Multi-Binary Inputs cluster, the firmware keeps two values:

current_present_value
last_present_value

In the historical Multi-Binary Input implementation, the test is based on the numeric difference:

abs(current_present_value - last_present_value) >= delta

After the report is sent, the last reported value is updated:

last_present_value = current_present_value

Delta in Generic Criteria Slots

When using the generic criteria-slot engine in delta mode with a bitmap, the Val field is treated as an enable flag, not as a precise bit mask.

For backward compatibility, the firmware does the following:

Mask = (Val != 0 ? 0xFFFFFFFF : 0)

Therefore:

Use delta mode when the required service is:

Send a report when any input bit changes.

Do not use delta mode when the required service is:

Send a report only when b0 = 1.
Send a report only when b2 = 1 AND b1 = 1.
Ignore some bits and check only selected bits.

For those cases, use pattern mode with Val and Gap.

Delta Slot Example

11 06 80 05 90 00 00 19 00 00 FF FF 09 00 01

Actions

When a slot is configured in threshold-with-actions mode, it can execute an action list.

The action section starts with:

<ActionDesc> <Actions...>

The ActionDesc byte is decoded as follows:

Examples:

0E = 14 bytes of actions, with slot report
8E = 14 bytes of actions, without slot report

If bit 7 is 0, the slot generates its own report when it triggers.

If bit 7 is 1, the slot executes the action list but does not generate the slot report directly.

Examples

Alarm Condition with a Time Window

Inputs:

b0 = PIR sensor
b1 = door contact
b2 = active time window

Required condition:

b2 = 1 AND (b0 = 1 OR b1 = 1)

Use two pattern slots:

Slot 1:
Val = 0x0005
Gap = 0x0005
=> b2 = 1 AND b0 = 1

Slot 2:
Val = 0x0006
Gap = 0x0006
=> b2 = 1 AND b1 = 1

Recommended occurrences to avoid retriggering while the pattern remains true:

80 00 01 00 01

OccHigh = 1
OccLow  = 1

Recommended action descriptor when the slot must execute actions without generating its own immediate report:

8E

Pattern Slot Example

11 06 80 05 98 00 00 19 00 00 FF FF D9 00 05 00 05 80 00 01 00 01 ...

Rule of Thumb