Volume Meter Cluster
This cluster delivers the value of the volume, and the maximum and minimum flow of the sensor.
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.
- Volume attribute
- VolumeDisplayMode attribute
- MinFlow attribute
- MaxFlow attribute
- FlowDisplayMode attribute
- Cluster Commands
Volume
The Volume information attribute set contains the attribute representing the volume index of the device.
Standard report
Report
| Features | Fctrl | CmdID | ClusterID | AttributeID | Attribute type | Data | Comment |
|---|---|---|---|---|---|---|---|
| Report attributes | 0x11 or 0x31 or ... | 0x0A | 0x80 0x02 | 0x00 0x00 | 0x2b | 0xvvvvvvvv | 0xvvvvvvvv: volume index |
Configuration
| Features | Fctrl | CmdID | ClusterID | Payload | Comment |
|---|---|---|---|---|---|
| Configure reporting | 0x11 or 0x31 or ... | 0x06 | 0x80 0x02 | 0x00 0x00 0x00 0x2b 0xmmmm 0xMMMM 0xcccccccc | 0x00 0x00: attributeID 0x2b: attribute type 0xmmmm: minimum reporting interval 0xMMMM: maximum reporting interval 0xcccccccc: reportable change |
| Configure reporting response | 0x11 or 0x31 or ... | 0x07 | 0x80 0x02 | 0xss 0x00 0x00 0x00 | 0xss:status |
| Read reporting configuration | 0x11 or 0x31 or ... | 0x08 | 0x80 0x02 | 0x00 0x00 0x00 | 0x00 0x00: attributeID |
| Read reporting configuration response | 0x11 or 0x31 or ... | 0x09 | 0x80 0x02 | 0xss 0x00 0x00 0x00 0x2b 0xmmmm 0xMMMM 0xcccccccc | 0xss:status 0x00 0x00:attributeID 0x2b: attribute type 0xmmmm: minimum reporting interval 0xMMMM: maximum reporting interval 0xcccccccc: reportable change |
Read/Write
| Features | Fctrl | CmdID | ClusterID | AttributeID | Status | Attribute type | Data | Comment |
|---|---|---|---|---|---|---|---|---|
| Read attribute request | 0x11 or 0x31 or ... | 0x00 | 0x80 0x02 | 0x00 0x00 | Ask the volume index of the sensor | |||
| Read attribute response | 0x11 or 0x31 or ... | 0x01 | 0x80 0x02 | 0x00 0x00 | 0x00 | 0x2b | 0xvvvvvvvv | 0xvvvvvvvv: volume index |
| Write attribute no response | 0x11 or 0x31 or ... | 0x05 | 0x80 0x02 | 0x00 0x00 | 0x2b | 0xvvvvvvvv | Set the volume value |
Batch report
The Volume sample type is "signed int l32", the corresponding number to use in br_uncompress type is 11.
Configuration
| Feature | Fctrl | CmdID | ClusterID | Payload | Comment |
|---|---|---|---|---|---|
| Configure reporting | 0x11 or 0x31 or ... | 0x06 | 0x80 0x02 | 0x1D 0x00 0x00 0x00 0xmmmm 0xMMMM 0xdddddddd 0xrrrrrrrr 0xtt | 0x1D: Batch(size+flag); 0bsssssss is the size of configuration string after attributeID (obsssssss1 right shifted). The size here is 0x14. 0x00 0x00: AttributeID 0x00: the index of required field( the volume has got only one field 0) 0xmmmm: minimum recorting interval 0xMMMM: maximum recorting interval 0xdddddddd: the required delta value (the size depends on the attribute data type) 0xrrrrrrrr: the required resolution value (the size depends on the attribute data type) 0xtt:the tag value |
| Configure reporting response | 0x11 or 0x31 or ... | 0x07 | 0x80 0x02 | 0xss 0x01 0x00 0x00 | 0xss : status 0x01 : batch |
| Read reporting configuration | 0x11 or 0x31 or ... | 0x08 | 0x80 0x02 | 0x01 0x00 0x00 | 0x01: Batch |
| Read reporting configuration response | 0x11 or 0x31 or ... | 0x09 | 0x80 0x02 | 0xss 0x1D 0x00 0x00 0x00 0xmmmm 0xMMMM 0xdddddddd 0xrrrrrrrr 0xtt | 0xss : status 0x1D: Batch(size+flag); 0bsssssss is the size of configuration string after attributeID (obsssssss1 right shifted). The size here is 0x14. 0x00: the index of required field( the volume has got only one field 0) 0xmmmm: minimum reporting interval 0xMMMM: maximum reporting interval 0xdddddddd: the required delta value (the size depends on the attribute data type) 0xrrrrrrrr: the required resolution value (the size depends on the attribute data type) 0xtt: the tag value |
VolumeDisplayMode
The VolumeDisplayMode information attribute set contains the volume unit of the volume attribute of the device.
Read/Write
| Features | Fctrl | CmdID | ClusterID | AttributeID | Status | Attribute type | Data | Comment |
|---|---|---|---|---|---|---|---|---|
| Read attribute request | 0x11 or 0x31 or ... | 0x00 | 0x80 0x02 | 0x00 0x01 | Ask the volume unit of the volume attribute of the sensor | |||
| Read attribute response | 0x11 or 0x31 or ... | 0x01 | 0x80 0x02 | 0x00 0x01 | 0x00 | 0x20 | 0xvv | 0xvv: unit of the volume attribute 0x00: deciLiter 0x01: Liter |
MinFlow
The MinFlow information attribute set contains the minimum flow of the device.
Standard report
Report
| Features | Fctrl | CmdID | ClusterID | AttributeID | Attribute type | Data | Comment |
|---|---|---|---|---|---|---|---|
| Report attributes | 0x11 or 0x31 or ... | 0x0A | 0x80 0x02 | 0x00 0x02 | 0x28 | 0xvv | 0xvv: minflow index |
Configuration
| Features | Fctrl | CmdID | ClusterID | Payload | Comment |
|---|---|---|---|---|---|
| Configure reporting | 0x11 or 0x31 or ... | 0x06 | 0x80 0x02 | 0x00 0x00 0x02 0x28 0xmmmm 0xMMMM 0xcc | 0x00 0x02: attributeID 0x28: attribute type 0xmmmm: minimum reporting interval 0xMMMM: maximum reporting interval 0xcc: reportable change |
| Configure reporting response | 0x11 or 0x31 or ... | 0x07 | 0x80 0x02 | 0xss 0x00 0x00 0x02 | 0xss:status |
| Read reporting configuration | 0x11 or 0x31 or ... | 0x08 | 0x80 0x02 | 0x00 0x00 0x02 | 0x00 0x02: attributeID |
| Read reporting configuration response | 0x11 or 0x31 or ... | 0x09 | 0x80 0x02 | 0xss 0x00 0x00 0x02 0x28 0xmmmm 0xMMMM 0xcc | 0xss:status 0x00 0x02:attributeID 0x28: attribute type 0xmmmm: minimum reporting interval 0xMMMM: maximum reporting interval 0xcc: reportable change |
Read/Write
| Features | Fctrl | CmdID | ClusterID | AttributeID | Status | Attribute type | Data | Comment |
|---|---|---|---|---|---|---|---|---|
| Read attribute request | 0x11 or 0x31 or ... | 0x00 | 0x80 0x02 | 0x00 0x02 | Ask the minimum flow of the sensor | |||
| Read attribute response | 0x11 or 0x31 or ... | 0x01 | 0x80 0x02 | 0x00 0x02 | 0x00 | 0x28 | 0xvv | 0xvv: minimum flow |
Batch report
The MinFlow sample type is "signed int l8", the corresponding number to use in br_uncompress type is 5.
Configuration
| Feature | Fctrl | CmdID | ClusterID | Payload | Comment |
|---|---|---|---|---|---|
| Configure reporting | 0x11 or 0x31 or ... | 0x06 | 0x80 0x02 | 0x11 0x00 0x02 0x00 0xmmmm 0xMMMM 0xdd 0xrr 0xtt | 0x11: Batch(size+flag); 0bsssssss is the size of configuration string after attributeID (obsssssss1 right shifted). The size here is 0x08. 0x00 0x02: AttributeID 0x00: the index of required field( the minflow has got only one field 0) 0xmmmm: minimum recorting interval 0xMMMM: maximum recorting interval 0xdd: the required delta value (the size depends on the attribute data type) 0xrr: the required resolution value (the size depends on the attribute data type) 0xtt:the tag value |
| Configure reporting response | 0x11 or 0x31 or ... | 0x07 | 0x80 0x02 | 0xss 0x01 0x00 0x02 | 0xss : status 0x01 : batch |
| Read reporting configuration | 0x11 or 0x31 or ... | 0x08 | 0x80 0x02 | 0x01 0x00 0x02 | 0x01: Batch |
| Read reporting configuration response | 0x11 or 0x31 or ... | 0x09 | 0x80 0x02 | 0xss 0x11 0x00 0x02 0x00 0xmmmm 0xMMMM 0xdd 0xrr 0xtt | 0xss : status 0x11: Batch(size+flag); 0bsssssss is the size of configuration string after attributeID (obsssssss1 right shifted). The size here is 0x08. 0x00: the index of required field( the minflow has got only one field 0) 0xmmmm: minimum reporting interval 0xMMMM: maximum reporting interval 0xdd: the required delta value (the size depends on the attribute data type) 0xrr: the required resolution value (the size depends on the attribute data type) 0xtt: the tag value |
MaxFlow
The MaxFlow information attribute set contains the maximum flow of the device.
Standard report
Report
| Features | Fctrl | CmdID | ClusterID | AttributeID | Attribute type | Data | Comment |
|---|---|---|---|---|---|---|---|
| Report attributes | 0x11 or 0x31 or ... | 0x0A | 0x80 0x02 | 0x00 0x03 | 0x28 | 0xvv | 0xvv: maxflow index |
Configuration
| Features | Fctrl | CmdID | ClusterID | Payload | Comment |
|---|---|---|---|---|---|
| Configure reporting | 0x11 or 0x31 or ... | 0x06 | 0x80 0x02 | 0x00 0x00 0x03 0x28 0xmmmm 0xMMMM 0xcc | 0x00 0x03: attributeID 0x28: attribute type 0xmmmm: minimum reporting interval 0xMMMM: maximum reporting interval 0xcc: reportable change |
| Configure reporting response | 00x11 or 0x31 or ... | 0x07 | 0x80 0x02 | 0xss 0x00 0x00 0x03 | 0xss:status |
| Read reporting configuration | 0x11 or 0x31 or ... | 0x08 | 0x80 0x02 | 0x00 0x00 0x03 | 0x00 0x03: attributeID |
| Read reporting configuration response | 0x11 or 0x31 or ... | 0x09 | 0x80 0x02 | 0xss 0x00 0x00 0x03 0x28 0xmmmm 0xMMMM 0xcc | 0xss:status 0x00 0x03:attributeID 0x28: attribute type 0xmmmm: minimum reporting interval 0xMMMM: maximum reporting interval 0xcc: reportable change |
Read/Write
| Features | Fctrl | CmdID | ClusterID | AttributeID | Status | Attribute type | Data | Comment |
|---|---|---|---|---|---|---|---|---|
| Read attribute request | 0x11 or 0x31 or ... | 0x00 | 0x80 0x02 | 0x00 0x03 | Ask the maximum flow of the sensor | |||
| Read attribute response | 0x11 or 0x31 or ... | 0x01 | 0x80 0x02 | 0x00 0x03 | 0x00 | 0x28 | 0xvv | 0xvv: maximum flow |
Batch report
The MaxFlow sample type is "signed int l8", the corresponding number to use in br_uncompress type is 5.
Configuration
| Feature | Fctrl | CmdID | ClusterID | Payload | Comment |
|---|---|---|---|---|---|
| Configure reporting | 0x11 or 0x31 or ... | 0x06 | 0x80 0x02 | 0x11 0x00 0x03 0x00 0xmmmm 0xMMMM 0xdd 0xrr 0xtt | 0x11: Batch(size+flag); 0bsssssss is the size of configuration string after attributeID (obsssssss1 right shifted). The size here is 0x08. 0x00 0x03: AttributeID 0x00: the index of required field( the maxflow has got only one field 0) 0xmmmm: minimum recorting interval 0xMMMM: maximum recorting interval 0xdd: the required delta value (the size depends on the attribute data type) 0xrr: the required resolution value (the size depends on the attribute data type) 0xtt:the tag value |
| Configure reporting response | 0x11 or 0x31 or ... | 0x07 | 0x80 0x02 | 0xss 0x01 0x00 0x03 | 0xss : status 0x01 : batch |
| Read reporting configuration | 0x11 or 0x31 or ... | 0x08 | 0x80 0x02 | 0x01 0x00 0x03 | 0x01: Batch |
| Read reporting configuration response | 0x11 or 0x31 or ... | 0x09 | 0x80 0x02 | 0xss 0x11 0x00 0x03 0x00 0xmmmm 0xMMMM 0xdd 0xrr 0xtt | 0xss : status 0x11: Batch(size+flag); 0bsssssss is the size of configuration string after attributeID (obsssssss1 right shifted). The size here is 0x08. 0x00: the index of required field( the maxflow has got only one field 0) 0xmmmm: minimum reporting interval 0xMMMM: maximum reporting interval 0xdd: the required delta value (the size depends on the attribute data type) 0xrr: the required resolution value (the size depends on the attribute data type) 0xtt: the tag value |
FlowDisplayMode
The FlowDisplayMode information attribute set contains the unit of the MinFlow and the MaxFlow attributes of the device.
Read/Write
| Features | Fctrl | CmdID | ClusterID | AttributeID | Status | Attribute type | Data | Comment |
|---|---|---|---|---|---|---|---|---|
| Read attribute request | 0x11 or 0x31 or ... | 0x00 | 0x80 0x02 | 0x00 0x04 | Ask the flow unit of the MinFlow and MaxFlow attributes of the sensor | |||
| Read attribute response | 0x11 or 0x31 or ... | 0x01 | 0x80 0x02 | 0x00 0x04 | 0x00 | 0x20 | 0xvv | 0xvv: unit of the MinFlow and MaxFlow attributes 0x00: Max: Liter/min Min: dLiter/Hour |
Cluster Commands
| Features | Fctrl | CmdID | ClusterID | Data | Comment |
|---|---|---|---|---|---|
| Command: reset | 0x11 or 0x31 or ... | 0x50 | 0x80 0x02 | 0x00 0xrr | 0x00: command ID. Resets the attribute whose the corresponding bit of the flag is set to 1. 0xrr: Flag reset: 0x00: Reset volume 0x01: Reset MinFlow 0x10: Reset MaxFlow |
