WebThingsIO / zigbee-adapter

Zigbee adapter add-on for WebThings Gateway
Mozilla Public License 2.0
46 stars 29 forks source link

documentation of ZigBee constants #251

Open chas-iot opened 3 years ago

chas-iot commented 3 years ago

I've been trying to understand the ZigBee documentation. As part of that, I pulled together the attached (still incomplete) document. zigbee-constants-v2E.pdf

My source is html with internal cross-references, however GitHub won't let me attach a html file to an issue, so I converted to PDF.

I'm linking several people that have commits in this adapter. @mrstegeman @dhylands @frederic34 @IndrekHaav @flatsiedatsie @mrsteakhouse @tim-hellhake

davehylands commented 3 years ago

It's probably also useful to link to where the constants are defined in the code.

The Cluster IDs and several other constants come from: https://github.com/zigbeer/zcl-id/blob/master/definitions/common.json

The constants for attributes within each cluster come from: https://github.com/zigbeer/zcl-id/blob/master/definitions/cluster_defs.json

The Message IDs come from: https://github.com/jankolkmeier/xbee-api/blob/master/lib/constants.js

And finally, other constants come from the adapter here: https://github.com/WebThingsIO/zigbee-adapter/blob/master/zb-constants.js

chas-iot commented 3 years ago

It's probably also useful to link to where the constants are defined in the code.

Thanks @davehylands I’ll work through these links and see how the doc goes.