Number Cluster

This cluster delivers deliver a generic number value that can be bind to any type of measurement or calculated data depending on the firmware (sensor type). The type of the value is defined at compile time depending on the application use-case. It can be one of the following ones: U8, U16, U24, U32, SingleFloat, I8, I16, I24, I32 (see codes here).

This cluster manages also the "Statistics attributes" minimum, average and maximum values of the number since last reboot or statistics reset.

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 Attributes

Present Value


The Present value information attribute contains  the attribute representing the current value defined by the device application.

Notice that the Present Value Attribute (0x0000) is the source of calculated attributes that keep currents Mean (0x0101), Minimal(0x0102) and Maximal(0x0103) values since startup or reset of the sensor. All these calculated attributes can be accessed the same way than the source one.

Standard report

Report

FeaturesFctrl CmdIDClusterIDAttributeIDAttribute typeDataComment
Report attributes0x11 or 0x31 or
...
0x0a0x800E0x0000<Attribute Type Code (ATC) >
Application defined
0x...0x...: Present value number. Number of bytes depending on ATC (from 1byte to 4 bytes).

Configuration

FeaturesFctrl CmdIDClusterIDPayloadComment
Configure reporting0x11 or 0x31 or
...
0x060x800E0x00 0x0000 <ATC>
0xmmmm 0xMMMM
0xcccc
0x00: Reserved
0x0000: AttributeID
<ATC>: Attribute type(Application defined)
0xmmmm: minimum reporting interval
0xMMMM: maximum reporting interval
0x...: Reportable change value. Number of bytes depending on ATC (from 1byte to 4 bytes).
Configure reporting response0x11 or 0x31 or
...
0x070x800E0xss 0x00 0x00000xss: status
0x00: Reserved
0x0000: AttributeID
Read reporting configuration0x11 or 0x31 or
...
0x080x800E0x00 0x00000x00: Reserved
0x0000: attributeID
Read reporting configuration response0x11 or 0x31 or
...
0x090x800E0xss 0x00 0x0000 <ATC>
0xmmmm 0xMMMM
0xcccc
0xss: status
0x00: Reserved
0x0000: AttributeID
<ATC>: Attribute type(Application defined)
0xmmmm: minimum reporting interval
0xMMMM: maximum reporting interval
0x...: Reportable change value. Number of bytes depending on ATC (from 1byte to 4 bytes).

Read

FeaturesFctrl CmdIDClusterIDAttributeIDStatusAttribute typeDataComment
Read attribute request0x11 or 0x31 or
...
0x000x800E0x0000Ask the current concentration indication
Read attribute response0x11 or 0x31 or
...
0x010x800E0x00000x00 <ATC>0x...<ATC>: Attribute type (Application defined)
0x...: Present Value. Number of bytes depending on ATC (from 1byte to 4 bytes).

Batch report

Depending on the application selected data type, the batch sample type code is given by the following table:  sample type table . ie: for an "unsigned int U16", the corresponding number to use in br_uncompress type is 6.

Configuration

FeaturesFctrl CmdIDClusterIDPayloadComment
Configure reporting0x11 or 0x31 or
...
0x060x800E0x15 0x0000 0x00 0xmmmm 0xMMMM <Delta> <Resol> 0xtt0x15: 0bsssssss is the size of configuration string after attributeID (obsssssss1 right shifted). The size here is 0x0A.
0x0000: AttributeID
0x00: the index of required field( the MeasuredValue attribute has got only one field 0)
0xmmmm: minimum reporting interval
0xMMMM: maximum reporting interval
<Delta>: required delta value. Number of bytes depending on application defined Attribute type of number (from 1byte to 4 bytes).
<Resol>: required resolution. Number of bytes depending on application defined Attribute type of number (from 1byte to 4 bytes).
0xtt: the tag value
Configure reporting response0x11 or 0x31 or
...
0x070x800E0xss 0x01 0x00000xss: status
0x01: batch
0x0000: AttributeID
Read reporting configuration0x11 or 0x31 or
...
0x080x800E0x01 0x00000x01: batch
0x0000: AttributeID
Read reporting configuration response0x11 or 0x31 or
...
0x090x800E0xss 0x15 0x0000 0x00 0xmmmm 0xMMMM <Delta> <Resol> 0xtt0xss: status
0x15: 0bsssssss is the size of configuration string after attributeID (obsssssss1 right shifted). The size here is 0x0A.
0x0000: AttributeID
0x00: the index of required field( the MeasuredValue attribute has got only one field 0)
0xmmmm: minimum reporting interval
0xMMMM: maximum reporting interval
<Delta>: required delta value. Number of bytes depending on application defined Attribute type of number (from 1byte to 4 bytes).
<Resol>: required resolution. Number of bytes depending on application defined Attribute type of number (from 1byte to 4 bytes).
0xtt: the tag value

Statistic Attributes

These reportables attributes show the Minimal, Average and Maximum values of CO2 or VOC sensor since sensor startup or last "Reset statistics" cluster specific command.

They can be read and reported in the same way than the "Measurement Attribute", by just changing the "Attribute ID" to the right one:

  • Average: 0x0101
  • Minimum : 0x0102
  • Maximum : 0x0103

Cluster specific commands

Specific commands can be used to :

  • Reset current Mean/Min/Max statistics attributes.

Cluster commands


FeaturesFctrl CmdIDClusterIDPayloadComment
Command: Reset statistics0x11...0x500x800E0x00Reset/restart MEAN|MIN|MAX calculations

Print Friendly