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


Descriptor attribute represents the descriptor of endpoints/services provided by a device.

Read/Write

FeaturesFctrl CmdIDClusterIDAttributeIDStatusAttribute typeDataComment
Read attribute request0x110x000x00 0x500x00 0x04Ask the endpoint/ clusterID list managed by the sensor
Read attribute response0x110x010x00 0x500x00 0x040x000x4C0xllll 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.

Standard report

Report

FeaturesFctrl CmdIDClusterIDAttributeIDPayloadComment
Report attributes0x110x0a0x00 0x500x00 0x060x41 0xss 0xmm 0xrr [0xvvvv]... 0xcc0xss: 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 Nke Watteco's sensors are illustrated in the table below:

Power sources (Bits field)Description
0x01Constant (main) or External power
0x02Rechargeable battery
0x04Diposable battery
0x08Solar harvesting
0x10TIC harvesting
OthersReserved
0x00Undefined: should not occur

The power modes available are represented in the table below:

Power mode (Bits field)Description
0x00ON when idle
0x01Periodically ON
0x02ON on user event (Button or
specific configuration command …)
OthersReserved

Configuration

FeaturesFctrl CmdIDClusterIDPayloadComment
Configure reporting0x110x060x00 0x500x00 0x00 0x06 0x41 0xmmmm 0xMMMM 0xss 0xmm 0xrr[0xvvvv] ... 0xcc0x00 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 response0x110x070x00 0x500xss 0x00 0x00 0x060xss: status
Read reporting configuration0x110x080x00 0x500x00 0x00 0x060x00 0x06: AttributeID
Read reporting configuration response0x11 0x090x00 0x500xss 0x00 0x00 0x06 0x41 0xmmmm 0xMMMM 0xss 0xmm 0xrr[0xvvvv] ... 0xcc0xss: 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

FeaturesFctrl CmdIDClusterIDAttributeIDStatusAttribute typeDataComment
Read attribute request0x110x000x00 0x500x00 0x06
Read attribute response0x110x010x00 0x500x00 0x060x000x410xss 0xmm 0xrr [0xvvvv]... 0xcc0xss: 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

FeaturesFctrl CmdIDClusterIDPayloadComment
Configure reporting0x110x060x00 0x500bsssssss1 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 response0x11 0x070x00 0x500xss 0x01 0x00 0x060xss: status
0x01: batch
Read reporting configuration0x11 0x080x00 0x500x01 0x00 0x060x01 : batch
Read reporting configuration response0x11 0x090x00 0x500xss 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

 

Actions


Actions attribute permits to save the Actions to execute on crossing Threshold or specific command. Available on v3.x.2.yyyy

Read/Write

FeaturesFctrl CmdIDClusterIDAttributeIDStatusAttribute typeDataComment
Read attribute request0x110x000x00 0x500xFF 0xyyAsk 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 response0x110x010x00 0x500xFF 0xyy0x000x410xss 0xdd ... 0xdd0xyy: 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 response0x110x050x00 0x500xFF 0xyy0x410xss 0xdd ... 0xdd0xyy: 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


FeaturesFctrl CmdIDClusterIDPayloadComment
Command: Reboot0x11 0x500x00 0x500x00Restart the device. All configuration parameters are kept
Command: Remove reports0x11 0x500x00 0x500x02 0xpp0xpp:
0x01: remove standard reports
0x02: remove batch reports
0x03: remove standard and batch reports
No response if command is OK
Command: Get specific batch0x110x500x00 0x500x03 0xcc0xcc: 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: Execute Actions0x110x500x00 0x500xF0 0xss 0xdd ... 0xddExecute defined Actions in the “Actions” Attribute.
0xss: Size of followed data
0xdd …0xdd: set of Actions. Defined by [<AoD><Val>]*
Print Friendly