Sending Zigbee Cluster Library (Zcl) Commands With The Api - Digi XBee-PRO User Manual

Frame Fields
Broadcast
Radius
Transmit
Options
Data Payload
Frame-specific
Data
Checksum

Sending ZigBee Cluster Library (ZCL) commands with the API

The ZigBee Cluster Library defines a set of attributes and commands (clusters) that can be supported in multiple
ZigBee profiles. The ZCL commands are typically required when developing a ZigBee product that will
interoperate in a public profile such as home automation or smart energy, or when communicating with ZigBee
devices from other vendors. Applications that are not designed for a public profile or for interoperability
applications can skip this section.
The following table shows some prominent clusters with their respective attributes and commands.
Cluster (Cluster ID)
Basic (0x0000)
Identify (0x0003)
Time (0x000A)
Thermostat (0x0201)
The ZCL defines a number of profile-wide commands that can be supported on any profile, also known as general
commands. These commands include the following.
XBee/XBee-PRO ZigBee RF Modules User Guide
Offset
21
22
Transaction 23
Sequence
Number
ZDO Payload 24
25
26
Attributes (Attribute ID)
Application Version (0x0001)
Hardware Version (0x0003)
Model Identifier (0x0005)
Identify Time (0x0000)
Time (0x0000)
Time Status (0x0001)
Time Zone (0x0002)
Local Temperature (0x0000)
Occupancy (0x0002)
Sending ZigBee Cluster Library (ZCL) commands with the API
Example Description
0x00 Sets the maximum number of hops a broadcast
transmission can traverse. If set to 0, the
transmission radius will be set to the network
maximum hops value.
0x00 All bits must be set to 0.
0x01 The required payload for a ZDO command. All
multi-byte ZDO parameter values (u16, u32, 64-
bit address) must be sent in little endian byte
order.
0x34
The Active Endpoints Request includes the
following payload:
0x12
[16-bit NwkAddrOfInterest]
Note the 16-bit address in the API example
(0x1234) is sent in little endian byte order
(0x3412).
0xA6 0xFF minus the 8 bit sum of bytes from offset 3 to
this byte.
Cluster ID
-Reset to defaults (0x00)
Identify (0x00)
Identify Query (0x01)
-Setpoint raise / lower (0x00)
180