XB24-DKS Digi International/Maxstream, XB24-DKS Datasheet - Page 57

• Manufacturer Part Number: XB24-DKS
• Description: KIT STARTER XBEE
• Manufacturer: Digi International/Maxstream
• Series: XBee™r
• Type: 802.15.4/Zigbeer

Specifications of XB24-DKS

• Frequency: 2.4GHz
• For Use With/related Products: XBee and XBee Pro Radios
• Lead Free Status / RoHS Status: Contains lead / RoHS non-compliant
• Other names: XB-DKS; XB-DKS

XBee®/XBee‐PRO® RF Modules ‐ 802.15.4 ‐ v1.xEx [2009.09.23]
API Operation
API Frame Specifications
Start Delimiter
Start Delimiter
(Byte 1)
API Operation (AP parameter = 1)
API Operation - with Escape Characters (AP parameter = 2)
0x7E
By default, XBee®/XBee-PRO® RF Modules act as a serial line replacement (Transparent Opera-
tion) - all UART data received through the DI pin is queued up for RF transmission. When the mod-
ule receives an RF packet, the data is sent out the DO pin with no additional information.
Inherent to Transparent Operation are the following behaviors:
As an alternative to the default Transparent Operation, API (Application Programming Interface)
Operations are available. API operation requires that communication with the module be done
through a structured interface (data is communicated in frames in a defined order). The API spec-
ifies how commands, command responses and module status messages are sent and received
from the module using a UART Data Frame.
Two API modes are supported and both can be enabled using the AP (API Enable) command. Use
the following AP parameter values to configure the module to operate in a particular mode:
Any data received prior to the start delimiter is silently discarded. If the frame is not received cor-
rectly or if the checksum fails, the data is silently discarded.
When this API mode is enabled (AP = 1), the UART data frame structure is defined as follows:
Figure 3‐01. UART Data Frame Structure:
(Byte 1)
When this API mode is enabled (AP = 2), the UART data frame structure is defined as follows:
Figure 3‐02. UART Data Frame Structure ‐ with escape control characters:
Escape characters. When sending or receiving a UART data frame, specific data values must be
escaped (flagged) so they do not interfere with the UART or UART data frame operation. To escape
an interfering data byte, insert 0x7D and follow it with the byte to be escaped XOR’d with 0x20.
0x7E
© 2009 Digi Internatonal, Inc.
• If module parameter registers are to be set or queried, a special operation is required for
• In point-to-multipoint systems, the application must send extra information so that the
• AP = 0 (default): Transparent Operation (UART Serial line replacement)
• AP = 1: API Operation
• AP = 2: API Operation (with escaped characters)
transitioning the module into Command Mode.
receiving module(s) can distinguish between data coming from different remotes.
API modes are disabled.
MSB = Most Significant Byte, LSB = Least Significant Byte
MSB = Most Significant Byte, LSB = Least Significant Byte
MSB
(Bytes 2-3)
MSB
Length
(Bytes 2-3)
Length
LSB
LSB
Characters Escaped If Needed
API-specific Structure
API-specific Structure
Frame Data
(Bytes 4-n)
Frame Data
(Bytes 4-n)
(Byte n + 1)
Checksum
1 Byte
(Byte n + 1)
Checksum
1 Byte
57