Configuration Cluster
This cluster has been implemented to configure some attributes or to know the different services of a device.
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.
- Descriptor attribute
- Node power descriptor attribute
- Batch's redondancies attibutes
- Actions attribute
- Cluster commands attribute
Descriptor
Descriptor attribute represents the descriptor of endpoints/services provided by a device.
Read/Write
| Features | Fctrl | CmdID | ClusterID | AttributeID | Status | Attribute type | Data | Comment |
|---|---|---|---|---|---|---|---|---|
| Read attribute request | 0x11 | 0x00 | 0x00 0x50 | 0x00 0x04 | Ask the endpoint/ clusterID list managed by the sensor | |||
| Read attribute response | 0x11 | 0x01 | 0x00 0x50 | 0x00 0x04 | 0x00 | 0x4C | 0xllll 0xen {0xpp 0xmm [0xyyyy].... 0xnn [0xzzzz]... }... | 0xllll: number of bytes that follow this one 0xen: number of endpoints of the sensor. 0xpp: Endpoint number 0xmm: number of input cluster 0xyyyy: input clusterID used, it depends on the number of inputs 0xnn: number of output cluster 0xyyyy: output clusterID used, it depends on the number of outputs |
Node power descriptor
Node Power Descriptor attribute represents the power mode and supply characteristics of the device. The power sources measurement is done every 10 minutes to optimize the energy.
Field index for batch configuration and new standard configuration is defined by:
- 0x00: power modes
- 0x01: current power source
- 0x02: constant power
- 0x03: rechargeable battery
- 0x04: disposable battery
- 0x05: solar harvesting
- 0x06: TIC harvesting
Standard report
Report
| Features | Fctrl | CmdID | ClusterID | AttributeID | Payload | Comment |
|---|---|---|---|---|---|---|
| Report attributes | 0x11 | 0x0a | 0x00 0x50 | 0x00 0x06 | 0x41 0xss 0xmm 0xrr [0xvvvv]... 0xcc | 0xss: number of the following bytes 0xmm: current "power mode" 0xrr: available "power sources" 0xvvvv: Voltage level in V/1000 (mV) for each "power source" defined in 0xrr 0xcc: current "power source" |
The different power sources available in Watteco's sensors are illustrated in the table below:
| Power sources (Bits field) | Description |
|---|---|
| 0x01 | Constant (main) or External power |
| 0x02 | Rechargeable battery |
| 0x04 | Diposable battery |
| 0x08 | Solar harvesting |
| 0x10 | TIC harvesting |
| Others | Reserved |
| 0x00 | Undefined: should not occur |
The power modes available are represented in the table below:
| Power mode (Bits field) | Description |
|---|---|
| 0x00 | ON when idle |
| 0x01 | Periodically ON |
| 0x02 | ON on user event (Button or specific configuration command …) |
| Others | Reserved |
Configuration
| Features | Fctrl | CmdID | ClusterID | Payload | Comment |
|---|---|---|---|---|---|
| Configure reporting | 0x11 | 0x06 | 0x00 0x50 | 0x00 0x00 0x06 0x41 0xmmmm 0xMMMM 0xss 0xmm 0xrr[0xvvvv] ... 0xcc | 0x00 0x06: AttributeID 0x41: Attribute type 0xmmmm: minimum reporting interval 0xMMMM: maximum reporting interval 0xss:number of the following bytes 0xmm: mode power, there is only one mode power 0x00 (permanent listening or listening on awakening) 0xrr: power sources on which will be a report 0xvvvv: Delta on specific power source level 0xcc: report on power source changing |
| Configure reporting response | 0x11 | 0x07 | 0x00 0x50 | 0xss 0x00 0x00 0x06 | 0xss: status |
| Read reporting configuration | 0x11 | 0x08 | 0x00 0x50 | 0x00 0x00 0x06 | 0x00 0x06: AttributeID |
| Read reporting configuration response | 0x11 | 0x09 | 0x00 0x50 | 0xss 0x00 0x00 0x06 0x41 0xmmmm 0xMMMM 0xss 0xmm 0xrr[0xvvvv] ... 0xcc | 0xss: status 0x00 0x06: AttributeID 0x41: Attribute type 0xmmmm: minimum reporting interval 0xMMMM: maximum reporting interval 0xss:number of the following bytes 0xmm: mode power, there is only one mode power 0x00 (permenent listening or listening on awakening) 0xrr: power sources on which will be a report 0xvvvv: Delta on specific power source level 0xcc: report on power source changing |
example: report the battery level once a day.
Send on the fport 125: 11 06 00 50 00 00 06 41 800A 85A0 05 00 04 00C8 00
with 800A : 8000(minutes) | 000A (10) => periodicity of measure all 10 minutes
with 85A0 : 8000(minutes) | 05A0 (1440) => periodicity of sending all 1440 minutes = 1 day
with 04: set a delta variation on disposable battery.
with 00C8 : the delta variation for which a report will be sent is 200 mV
Read/Write
| Features | Fctrl | CmdID | ClusterID | AttributeID | Status | Attribute type | Data | Comment |
|---|---|---|---|---|---|---|---|---|
| Read attribute request | 0x11 | 0x00 | 0x00 0x50 | 0x00 0x06 | ||||
| Read attribute response | 0x11 | 0x01 | 0x00 0x50 | 0x00 0x06 | 0x00 | 0x41 | 0xss 0xmm 0xrr [0xvvvv]... 0xcc | 0xss: number of the following bytes 0xmm: current "power mode" 0xrr: available "power sources" 0xvvvv: Voltage level in V/1000 for each "power source" defined in 0xrr 0xcc: current "power source" |
Batch report
The Present value sample type is "Octet string", the corresponding number to use in br_uncompress type is 6 .
Configuration
| Features | Fctrl | CmdID | ClusterID | Payload | Comment |
|---|---|---|---|---|---|
| Configure reporting | 0x11 | 0x06 | 0x00 0x50 | 0bsssssss1 0x00 0x06 [0xii 0xmmmm 0xMMMM 0xdddd 0xrrrr 0xtt]... | 0bsssssss1: obsssssss is the size of configuration string after attributeID (obsssssss1 right shifted) 0x00 0x06:attributeID 0xii: the index of required field -0x00: power modes (sample type to use in br_uncompress: U8) -0x01: current power source (sample type to use in br_uncompress: U8) -0x02: constant power (sample type to use in br_uncompress: U16) -0x03: rechargeable battery (sample type to use in br_uncompress: U16) -0x04: disposable battery (sample type to use in br_uncompress: U16) -0x05: solar harvesting (sample type to use in br_uncompress: U16) -0x06: TIC harvesting (sample type to use in br_uncompress: U16) 0xmmmm: minimum reporting interval 0xMMMM: maximum reporting interval 0xdddd: required delta value (the size depends on the attribute data type) 0xrrrr: required resolution (the size depends on the attribute data type) 0xtt: the tag value |
| Configure reporting response | 0x11 | 0x07 | 0x00 0x50 | 0xss 0x01 0x00 0x06 | 0xss: status 0x01: batch |
| Read reporting configuration | 0x11 | 0x08 | 0x00 0x50 | 0x01 0x00 0x06 | 0x01 : batch |
| Read reporting configuration response | 0x11 | 0x09 | 0x00 0x50 | 0xss 0bsssssss1 0x00 0x06 [0xii 0xmmmm 0xMMMM 0xdddd 0xrrrr 0xtt]... | 0xss: status 0bsssssss1: obsssssss is the size of configuration string after attributeID (obsssssss1 right shifted) 0x00 0x06:attributeID 0xii: the index of required field -0x00: power modes (sample type to use in br_uncompress: U8) -0x01: current power source (sample type to use in br_uncompress: U8) -0x02: constant power (sample type to use in br_uncompress: U16) -0x03: rechargeable battery (sample type to use in br_uncompress: U16) -0x04: disposable battery (sample type to use in br_uncompress: U16) -0x05: solar harvesting (sample type to use in br_uncompress: U16) -0x06: TIC harvesting (sample type to use in br_uncompress: U16) 0xmmmm: minimum reporting interval 0xMMMM: maximum reporting interval 0xdddd: required delta value (the size depends on the attribute data type) 0xrrrr: required resolution (the size depends on the attribute data type) 0xtt: the tag value |
Batch's redondancies
Batch's redondancies attributes are available from release v3.5.2.5908. It permits to ask at each batch sending to send automatically a number defined saved batches.
Read/Write
| Features | Fctrl | CmdID | ClusterID | AttributeID | Status | Attribute type | Data | Comment |
|---|---|---|---|---|---|---|---|---|
| Read attribute request | 0x11 | 0x00 | 0x00 0x50 | 0x00 0x08 | Ask the number of historical batches which will be sent at each batch sending | |||
| Read attribute response | 0x11 | 0x01 | 0x00 0x50 | 0x00 0x08 | 0x00 | 0x20 | 0xdd | 0xdd: number of historical batches which will be sent at each batch sending |
| Write attribute no response | 0x11 | 0X05 | 0x00 0x50 | 0X00 0x08 | 0X20 | 0xdd | 0xdd: number of historical batches which will be sent at each batch sending | |
| Read attribute request | 0x11 | 0x00 | 0x00 0x50 | 0x00 0x09 | Ask the delay between each historical batch sending | |||
| Read attribute response | 0x11 | 0x01 | 0x00 0x50 | 0x00 0x09 | 0x00 | 0x21 | 0xdd 0xdd | 0xdd dd: the delay between each historical batch sending in second |
| Write attribute no response | 0x11 | 0X05 | 0x00 0x50 | 0X00 0x09 | 0x21 | 0xdd 0xdd | 0xdd dd: the delay between each historical batch sending in second |
Actions
Actions attribute permits to save the Actions to execute on crossing Threshold or specific command. Available on v3.x.2.yyyy
Read/Write
| Features | Fctrl | CmdID | ClusterID | AttributeID | Status | Attribute type | Data | Comment |
|---|---|---|---|---|---|---|---|---|
| Read attribute request | 0x11 | 0x00 | 0x00 0x50 | 0xFF 0xyy | Ask the Action to execute on Threshold or specific command 0xyy: corresponds to the index of Actions. from 0 to (n). The number of actions (n) is specific at each device. |
|||
| Read attribute response | 0x11 | 0x01 | 0x00 0x50 | 0xFF 0xyy | 0x00 | 0x41 | 0xss 0xdd ... 0xdd | 0xyy: corresponds to the index of Actions. from 0 to (n). The number of actions (n) is specific at each device. 0xss: size of followed datas 0xdd ... 0xdd: zcl commande which will be executed |
| Write attribute no response | 0x11 | 0x05 | 0x00 0x50 | 0xFF 0xyy | 0x41 | 0xss 0xdd ... 0xdd | 0xyy: corresponds to the index of Actions. from 0 to (n). The number of actions (n) is specific at each device. 0xss: size of followed datas 0xdd ... 0xdd: zcl commande which will be executed |
Cluster commands
| Features | Fctrl | CmdID | ClusterID | Payload | Comment |
|---|---|---|---|---|---|
| Command: Reboot | 0x11 | 0x50 | 0x00 0x50 | 0x00 | Restart the device. All configuration parameters are kept |
| Command: Remove reports | 0x11 | 0x50 | 0x00 0x50 | 0x02 0xpp | 0xpp: 0x01: remove standard reports 0x02: remove batch reports 0x03: remove standard and batch reports No response if command is OK |
| Command: Get specific batch | 0x11 | 0x50 | 0x00 0x50 | 0x03 0xcc | 0xcc: 0b0000nnn Get specific batch from its counter 0b0000001: batch counter 1 0b0000010: batch counter 2 0b0000011: batch counter 3 0b0000100: batch counter 4 0b0000101: batch counter 5 0b0000110: batch counter 6 0b0000111: batch counter 7 |
| Command: Force Batch report Only available on firmware 3.5.2.5908 and later | 0x11 | 0x50 | 0x00 0x50 | 0x08 | Force to send a batch with all recorded measures. |
| Command: Execute Actions | 0x11 | 0x50 | 0x00 0x50 | 0xF0 0xss 0xdd ... 0xdd | Execute immediately list of Actions defined in the “Actions” Attribute. 0xss: Size of followed data 0xdd …0xdd: set of Actions. Defined by [<AoD><Val>]* This command will trigg an answer: 11 50 0050 ss where 0xss is the Status. If 00 the requested action(s) have been correctly started, |
| Command: Set Alternate default configuration | 0x11 | 0x50 | 0x00 0x50 | 0xF1 0xVV | From version 3.5.x.r5365 Change to an "alternate default configuration 0xVV", if defined in flash configuration. Back to "default factory reset" with: 11500050F100 An answer will be given with a read response for last default configuration attribute (0x0007): 11 01 0050 0007 00 41 02 "NF" "NC" NF = Number of accepted frames from configuration NC = Number of last applied default configuration See example in VAQAO. |
| Command: Factory reset Only available on firmware 3.4.0.4147 and later | 0x11 | 0x50 | 0x00 0x50 | 0x07 | Restart the device with the default factory configurations. |
| Command: Ask all report configurations Only available on firmware 3.5.2.6209 and later | 0x11 | 0x50 | 0x00 0x50 | 0x09 0xpp 0xdd 0xdd | 0xpp: 0x01: configurations of standard reports 0x02: configurations of batch reports 0x03: configurations of standard and batch reports 0xdd 0xdd: delay in seconds between each configurations sending |
