XK-Z11-M Digi International, XK-Z11-M Datasheet - Page 125

• Manufacturer Part Number: XK-Z11-M
• Description: ZIGBEE MODULE DEVELOPMENT KIT
• Manufacturer: Digi International
• Series: XBee™r
• Type: Transceiver, 802.15.4/ZigBeer

Specifications of XK-Z11-M

• Frequency: 2.4GHz
• For Use With/related Products: XBee Modules
• Lead Free Status / RoHS Status: Lead free / RoHS Compliant
• Other names: 602-1184

© 2010 Digi International, Inc.
XBee®/XBee‐PRO® ZB RF Modules
A
P
I
P
a
c
k
e
t
Start Delimiter
Length
Frame-specific
Data
Checksum
The following table shows how the Explicit API frame can be used to read the hardware version attribute from a
device with a 64-bit address of 0x0013A200 40401234 (unknown 16-bit address). This example uses arbitrary
source and destination endpoints. Recall the hardware version attribute (attribute ID 0x0003) is part of the basic
cluster (cluster ID 0x0000). The Read Attribute general command ID is 0x00.
Frame Type
Frame ID
64-bit
Destination
Address
16-bit
Destination
Network
Address
Source
Endpoint
Destination
Endpoint
Cluster ID
Profile ID
Broadcast
Radius
Transmit
Options
Data Payload
Frame Fields
ZCL Frame
Header
ZCL Payload
Frame Control
Transaction
Sequence
Number
Command ID
Attribute ID
Offset Example
MSB 13 0xFF
MSB 17 0x00
MSB 19 0xD1
LSB 14 0xFE
LSB 18 0x00
LSB 20 0x23
MSB 1 0x00
MSB 5 0x00
LSB 2 0x19
10 0x40
12 0x34
15 0x41
16 0x42
21 0x00
22 0x00
23 0x00
24 0x01
25 0x00
26 0x03
27 0x00
28 0xFA
11 0x12
0 0x7E
3 0x11
4 0x01
6 0x13
7 0xA2
8 0x00
9 0x40
Number of bytes between the length and the checksum
Identifies the UART data frame for the host to correlate
with a subsequent transmit status. If set to 0, no transmit
status frame will be sent out the UART.
64-bit address of the destination device (big endian byte
order). For unicast transmissions, set to the 64-bit
address of the destination device, or to
0x0000000000000000 to send a unicast to the
coordinator. Set to 0x000000000000FFFF for broadcast.
16-bit address of the destination device (big endian byte
order). Set to 0xFFFE for broadcast, or if the 16-bit
address is unknown.
Set to the source endpoint on the sending device. (0x41
arbitrarily selected).
Set to the destination endpoint on the remote device.
(0x42 arbitrarily selected)
Set to the cluster ID that corresponds to the ZCL
command being sent.
0x0000 = Basic Cluster
Set to the profile ID supported on the device. (0xD123
arbitrarily selected).
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.
All bits must be set to 0.
Bitfield that defines the command type and other relevant
information in the ZCL command. See the ZCL
specification for details.
A sequence number used to correlate a ZCL command
with a ZCL response. (The hardware version response
will include this byte as a sequence number in the
response.) The value 0x01 was arbitrarily selected.
Since the frame control "frame type" bits are 00, this byte
specifies a general command. Command ID 0x00 is a
Read Attributes command.
The payload for a "Read Attributes" command is a list of
Attribute Identifiers that are being read.
Note the 16-bit Attribute ID (0x0003) is sent in little
endian byte order (0x0300). All multi-byte ZCL header
and payload values must be sent in little endian byte
order.
0xFF minus the 8 bit sum of bytes from offset 3 to this
byte.
Description
124