How to use Zigbee "he cr" command?

🚧 Developers Coding Questions
1

Does anybody know - is there documentation anywhere for the "he cr" command.

That is, a zigbee command like:

"he cr 0x${device.deviceNetworkId} 0x${device.endpointId} 0x0006 0 0x0010 0 0xFFFF {}",

I'm assuming "cr" stands for configure reporting, but I'm looking for what goes in each field and what / when does anything go in the brackets {}.

Thanks.

2

use this method instead:
List<String> configureReporting(Integer clusterId, Integer attributeId, Integer dataType, Integer minReportTime, Integer maxReportTime, Integer reportableChange = null, Map additionalParams = [:], Integer delay = 2000)

additionalParams : [mfgCode: Integer manufacturerCode]

3

@mike.maxwell

Thank you - I understand that reportingConfiguration is to read what has already been set -- is that correct?

I though the "he cr" was to do the actual setting. To clarify, I'm trying to learn more about zigbee drivers lookin at some samples, including this one: https://github.com/hubitat/HubitatPublic/blob/master/examples/drivers/GenericZigbeeRGBWBulb.groovy

Lines 240-245 execute a number of these commands. Looking at the first line:

"he cr 0x${device.deviceNetworkId} 0x${device.endpointId} 0x0006 0 0x10 0 0xFFFF {}",

I"m assuming this was to send the Configure Reporting frame from section 2.5.7 of the Zigbee cluster spec with the parameters set as follows:

0x${device.deviceNetworkId} 0x${device.endpointId} are obvious, just the device and endpoint

0x0006 - looks like the cluster
0 following the cluster: I can't figure out what this is for. Maybe its the direction field?
0x10: I think this is the attribute.
0: unsure. Perhaps its the Minimum Reporting Interval
0xFFFF -> If the prior item was the minimum reporting, then this seems to be the maximum reporting interval.

Then for the brackets {} - maybe this is where you put the "Reportable Change" and "Timeout period" if those are being set.

Am I on track here?

Thanks for the help.

image
image2244×971 114 KB

4

Sorry, pre-coffee dyslexia, see edited post

5

Thank you. That's a lot clearer. Greatly appreciated.

As an FYI - what I was experimenting with was whether you can get automatic reports after issuing a command.

For example, if I change the level of the bulb, what is done in sample code that I've looked at is that you then do a read attributes to confirm the new value. I was trying to see if devices can be configured to report the change by themselves so you don't have to issue a query after a setting. Maybe you already know?

6

yeah, this is exactly what configureReporting is all about.
you shouldn't have to query a device for an attribute after a command is sent to it.
The issue with reporting on the level cluster being it can spam the hub with level values depending on how its configured.
To get around this you can disable reporting, then query for the value after some fixed period of time (usually based on the transition time that's been configured), this is how most dimmer drivers are setup.
For bulbs you can disable reporting as well, then store the level command value in state then commit that as an event when the bulb returns the result of the command response, this is how the advanced bulb drivers do it.

1 Like
7

I hadn't thought about handling it that way. Good to know. So would I find that approach in this driver: HubitatPublic/examples/drivers/advancedZigbeeCTbulb.groovy at master · hubitat/HubitatPublic · GitHub

8

yes