Digi XBEEPRO2 Revised Used Manual
Digi International Inc.
11001 Bren Road East
Minnetonka, MN 55343
877 912-3444 or 952 912-3444
http://www.digi.com
XBee®/XBee-PRO® ZB RF Modules
ZigBee RF Modules by Digi International
Models: XBEE2, XBEEPRO2, PRO S2B
Hardware: S2 and S2B
Firmware Versions:
- 20xx - Coordinator - AT/Transparent Operation
- 21xx - Coordinator - API Operation
- 22xx - Router - AT/Transparent Operation
- 23xx - Router - API Operation
- 28xx - End Device - AT/Transparent Operation
- 29xx - End Device - API Operation
DRAFT
90000976_H
7/21/2011
XBee®/XBee‐PRO®ZBRFModules
© 2011 Digi International, Inc. All rights reserved
Nopartofthecontentsofthismanualmaybetransmittedorreproducedinany
formorbyanymeanswithoutthewrittenpermissionofDigiInternational,Inc.
®isaregisteredtrademarkoftheZigBeeAlliance.
ZigBee
XBee®andXBee‐PRO®areregisteredtrademarksofDigiInternational,Inc.
Technical Support: Phone: (866) 765-9885 toll-free U.S.A. & Canada
(801) 765-9885 Worldwide
8:00 am - 5:00 pm [U.S. Mountain Time]
Live Chat: www.digi.com
Online Support: http://www.digi.com/support/eservice/login.jsp
Email: rf-experts@digi.com
©2011DigiInternational,Inc. 2
XBee®/XBee‐PRO®ZBRFModules
Contents
Overview 6
What's New in 2x7x 6
Firmware 6
Manual 7
Key Features 8
Worldwide Acceptance 8
Specifications 9
Hardware Specs for Programmable Variant 10
Mechanical Drawings 10
SIF Header Interface 11
Mounting Considerations 12
Pin Signals 13
EM250 Pin Mappings 14
Design Notes 14
Power Supply Design 14
Recommended Pin Connections 15
Board Layout 15
Electrical Characteristics 17
Module Operation for Programmable Variant 17
XBEE Programmable Bootloader 19
Overview 19
Bootloader Software Specifics 19
Bootloader Menu Commands 24
Firmware Updates 25
Output File configuration 25
RF Module Operation 27
Serial Communications 27
UART Data Flow 27
Serial Buffers 27
Serial Flow Control 28
Serial Interface Protocols 29
Modes of Operation 31
Idle Mode 31
Transmit Mode 31
Receive Mode 32
Command Mode 32
Sleep Mode 33
XBee ZigBee Networks 34
Introduction to ZigBee 34
ZigBee Stack Layers 34
Networking Concepts 34
Device Types 34
PAN ID 35
Operating Channel 36
ZigBee Application Layers: In Depth 36
Application Support Sublayer (APS) 36
Application Profiles 36
Coordinator Operation 37
Forming a Network 37
Channel Selection 37
PAN ID Selection 37
Security Policy 38
Persistent Data 38
XBee ZB Coordinator Startup 38
Permit Joining 39
Resetting the Coordinator 39
Leaving a Network 39
Replacing a Coordinator (Security Disabled Only) 40
Example: Starting a Coordinator 40
Example: Replacing a Coordinator (security disabled) 41
Router Operation 41
Discovering ZigBee Networks 41
Joining a Network 41
Authentication 41
Persistent Data 42
XBee ZB Router Joining 42
Permit Joining 44
Joining Always Enabled 44
Joining Temporarily Enabled 44
Router Network Connectivity 44
Leaving a Network 46
Resetting the Router 47
Example: Joining a Network 47
End Device Operation 47
Discovering ZigBee Networks 47
Joining a Network 48
Parent Child Relationship 48
End Device Capacity 48
Authentication 48
Persistent Data 48
Orphan Scans 48
XBee: ZB End Device Joining 49
Parent Connectivity 50
Resetting the End Device 50
Leaving a Network 50
Example: Joining a Network 50
Channel Scanning 51
©2011DigiInternaitonal,Inc. 3
XBee®/XBee‐PRO®ZBRFModules
Contents
Managing Multiple ZigBee Networks 51
PAN ID Filtering 51
Preconfigured Security Keys 51
Permit Joining 52
Application Messaging 52
Transmission, Addressing, and Routing 53
Addressing 53
64-bit Device Addresses 53
16-bit Device Addresses 53
Application Layer Addressing 53
Data Transmission 53
Broadcast Transmissions 54
Unicast Transmissions 54
Data Transmission Examples 56
RF Packet Routing 57
Link Status Transmission 58
AODV Mesh Routing 59
Many-to-One Routing 61
Source Routing 61
Encrypted Transmissions 64
Maximum RF Payload Size 64
Throughput 65
ZDO Transmissions 65
ZigBee Device Objects (ZDO) 65
Sending a ZDO Command 66
Receiving ZDO Commands and Responses 66
Transmission Timeouts 67
Unicast Timeout 68
Extended Timeout 68
Transmission Examples 69
Security 71
Security Modes 71
ZigBee Security Model 71
Network Layer Security 71
Frame Counter 72
Message Integrity Code 72
Network Layer Encryption and Decryption 72
Network Key Updates 72
APS Layer Security 72
Message integrity Code 73
APS Link Keys 73
APS Layer Encryption and Decryption 73
Network and APS Layer Encryption 73
Trust Center 74
Forming and Joining a Secure Network 74
Implementing Security on the XBee 74
Enabling Security 75
Setting the Network Security Key 75
Setting the APS Trust Center Link Key 75
Enabling APS Encryption 75
Using a Trust Center 75
XBee Security Examples 76
Example 1: Forming a network with security (pre-configured link keys) 76
Example 2: Forming a network with security (obtaining keys during joining) 76
Network Commissioning and Diagnostics 78
Device Configuration 78
Device Placement 78
Link Testing 78
RSSI Indicators 79
Device Discovery 79
Network Discovery 79
ZDO Discovery 79
Joining Announce 79
Commissioning Pushbutton and Associate LED 79
Commissioning Pushbutton 80
Associate LED 81
Managing End Devices 83
End Device Operation 83
Parent Operation 83
End Device Poll Timeouts 84
Packet Buffer Usage 84
Non-Parent Device Operation 84
XBee End Device Configuration 85
Pin Sleep 85
Cyclic Sleep 87
Transmitting RF Data 90
Receiving RF Data 90
IO Sampling 91
Waking End Devices with the Commissioning Pushbutton 91
Parent Verification 91
Rejoining 91
XBee Router/Coordinator Configuration 91
RF Packet Buffering Timeout 92
Child Poll Timeout 92
©2011DigiInternaitonal,Inc. 4
XBee®/XBee‐PRO®ZBRFModules
Contents
Transmission Timeout 92
Putting it all Together 93
Short Sleep Periods 93
Extended Sleep Periods 93
Sleep Examples 93
XBee Analog and Digital IO Lines 95
IO Configuration 95
IO Sampling 95
Queried Sampling 97
Periodic IO Sampling 97
Change Detection Sampling 97
RSSI PWM 97
IO Examples 98
API Operation 99
API Frame Specifications 99
API Examples 101
API UART Exchanges 102
AT Commands 102
Transmitting and Receiving RF Data 102
Remote AT Commands 102
Source Routing 103
Supporting the API 103
API Frames 103
AT Command 103
AT Command - Queue Parameter Value 104
ZigBee Transmit Request 104
Explicit Addressing ZigBee Command Frame 106
Remote AT Command Request 108
Create Source Route 109
AT Command Response 110
Modem Status 110
ZigBee Transmit Status 111
ZigBee Receive Packet 112
ZigBee Explicit Rx Indicator 113
ZigBee IO Data Sample Rx Indicator 114
XBee Sensor Read Indicator 115
Node Identification Indicator 117
Remote Command Response 118
Over-the-Air Firmware Update Status 119
Route Record Indicator 120
Many-to-One Route Request Indicator 121
Sending ZigBee Device Objects (ZDO) Commands
with the API 122
Sending ZigBee Cluster Library (ZCL) Commands
with the API 124
Sending Public Profile Commands with the API 126
XBee Command Reference Tables 129
Module Support 139
X-CTU Configuration Tool 139
Customizing XBee ZB Firmware 139
Design Considerations for Digi Drop-In Networking
139
XBee Bootloader 139
Programming XBee Modules 140
Serial Firmware Updates 140
Invoke XBee Bootloader 140
Send Firmware Image 140
SIF Firmware Updates 141
Writing Custom Firmware 141
Regulatory Compliance 141
Enabling GPIO 1 and 2 141
Detecting XBee vs. XBee-PRO 142
Ensuring Optimal Output Power 142
Improving Low Power Current Consumption 143
XBee (non-PRO) Initialization: 143
When sleeping (end devices): 143
When waking from sleep (end devices): 143
Appendix A:Definitions 144
Appendix B: Agency Certifications 146
Appendix C:Migrating from ZNet 2.5 to XBee ZB 154
Appendix D:Additional Information 155
©2011DigiInternaitonal,Inc. 5
1.Overview
This manual describes the operation of the XBee/XBee-PRO ZB RF module, which
consists of ZigBee firmware loaded onto XBee S2 and S2B hardware, models:
XBEE2, XBEEPRO2 and PRO S2B. The XBee/XBee-PRO ZB RF Modules are
designed to operate within the ZigBee protocol and support the unique needs of
low-cost, low-power wireless sensor networks. The modules require minimal
power and provide reliable delivery of data between remote devices.
The modules operate within the ISM 2.4 GHz frequency band and are compatible
with the following:
•XBee RS-232 Adapter
•XBee RS-485 Adapter
•XBee Analog I/O Adapter
•XBee Digital I/O Adapter
•XBee Sensor
•XBee USB Adapter
•XStick
•ConnectPort X Gateways
•XBee Wall Router.
The XBee/XBee-PRO ZB firmware release can be installed on XBee ZNet or ZB modules. The XBee ZB firmware is based
on the EmberZNet 3.x ZigBee PRO Feature Set mesh networking stack, while the XBee ZNet 2.5 firmware is based on
Ember's proprietary "designed for ZigBee" mesh stack (EmberZNet 2.5.x). ZB and ZNet 2.5 firmware are similar in
nature, but not over-the-air compatible. Devices running ZNet 2.5 firmware cannot talk to devices running the ZB firmware.
What's New in 2x7x
Firmware
XBee/XBee-PRO ZB firmware includes the following new features (compared with 2x6x):
•Using Ember stack version 3.4.1.
•Support for the PRO S2B with temperature compensation and an overvoltage check. Within 15 seconds of
the supply voltage exceeding 3.9V, the API will emit a 0x08 modem status (Overvoltage) message, and
then the AT/API versions will do a watchdog reset.
•ZDO pass-through added. If AO=3, then ZDO requests which are not supported by the stack will be
passed out the UART.
•An attempt to send an oversized packet (256+ bytes) will result in a Tx Status message with a status code
of 0x74.
•End devices have two speed polling. 7.5 seconds is the slow rate, which switches to the fast rate to transact with its parent. When transactions are done, it switches back to the slow rate.
•A new receive option bit (0x40) indicates if the packet came from an end device.
•Added extended timeout option since end devices need more time than routers to ack their packets.
•An option bit (0x01) was added to disable APS retries.
•If an end device has not had its polls answered for 5 secs, it will leave and attempt to rejoin the network.
•XBee S2B has a new TP command which returns the temperature compensation sensor reading in units of
Celsius degrees.
•The PP command returns the power dBm setting when PL4 is selected.
•The PO command sets the slow polling rate on end devices. Range is 1-0x1770 in units of 10 msec (10
msec to 60 sec). Default is 0 which invokes a 100 msec delay.
•Rejoining now can proceed without a NR or NRO command after a Mgmt_Leave_req is processed.
•Command ranges were changed for the SC, IR, and LT commands.
•A PAN ID corruption problem was fixed.
See the 2x7x release notes for a complete list of new features and bug fixes at www.digi.com/support.
©2011DigiInternational,Inc. 6
XBee®/XBee‐PRO®ZBRFModules
Manual
The XBee/XBee-PRO/S2B ZB 2x7x manual includes the following corrections over the 2x6x manual:
•Descriptions and specification for the PRO S2B.
•SIF Header Interface, pin 8 relabeled as pin 10.
•Pin mappings for pins 22 and 24 updated.
•New modem status codes were added.
•Corrections to the ZigBee Receive Packet description.
•Description changes for the SC, PL, PP, AO, IR, %V, and PO commands.
•Updates to Appendix B.
©2011DigiInternational,Inc. 7
XBee®/XBee‐PRO®ZBRFModules
High Performance, Low Cost
XBee
• Indoor/Urban: up to 133’ (40 m)
• Outdoor line-of-sight: up to 400’ (120 m)
• Transmit Power: 2 mW (3 dBm)
• Receiver Sensitivity: -96 dBm
XBee-PRO (S2)
• Indoor/Urban: up to 300’ (90 m), 200' (60
m) for International variant
• Outdoor line-of-sight: up to 2 miles (3200
m), 5000' (1500 m) for International variant
• Transmit Power: 50mW (17dBm), 10mW
(10dBm) for International variant
• Receiver Sensitivity: -102 dBm
XBee-PRO (S2B)
• Indoor/Urban: up to 300’ (90 m), 200' (60
m) for International variant
• Outdoor line-of-sight: up to 2 miles (3200
m), 5000' (1500 m) for International variant
• Transmit Power: 63mW (18dBm), 10mW
(10dBm) for International variant
• Receiver Sensitivity: -102 dBm
Advanced Networking & Security
Retries and Acknowledgements
DSSS (Direct Sequence Spread Spectrum)
Each direct sequence channel has over
65,000 unique network addresses available
Point-to-point, point-to-multipoint
and peer-to-peer topologies supported
Self-routing, self-healing and fault-tolerant
mesh networking
Low Power
XBee
• TX Peak Current: 40 mA (@3.3 V)
• RX Current: 40 mA (@3.3 V)
• Power-down Current: < 1 A
XBee-PRO (S2)
• TX Peak Current: 295mA (170mA for
international variant)
• RX Current: 45 mA (@3.3 V)
• Power-down Current: 3.5 A typical
@ 25 degrees C
XBee-PRO (S2B)
• TX Peak Current: 205mA (117mA for
international variant)
• RX Current: 47 mA (@3.3 V)
• Power-down Current: 3.5 A typical
@ 25 degrees C
Easy-to-Use
No configuration necessary for out-of box
RF communications
AT and API Command Modes for
configuring module parameters
Small form factor
Extensive command set
Free X-CTU Software
(Testing and configuration software)
Free & Unlimited Technical Support
Key Features
©2011DigiInternational,Inc. 8
Worldwide Acceptance
FCC Approval (USA) Refer to Appendix A for FCC Requirements. Systems that contain XBee®/
XBee-PRO® ZB RF Modules inherit Digi Certifications.
ISM (Industrial, Scientific & Medical) 2.4 GHz frequency band
Manufactured under ISO 9001:2000 registered standards
XBee®/XBee-PRO® ZB RF Modules are optimized for use in US, Canada, Europe, Australia, and
Japan (contact Digi for complete list of agency approvals).
XBee®/XBee‐PRO®ZBRFModules
Specifications
SpecificationsoftheXBee®/XBee‐PRO®ZBRFModule
Specification XBee XBee-PRO (S2) XBee-PRO (S2B)
Performance
Indoor/Urban Range up to 133 ft. (40 m)
Outdoor RF line-of-sight
Range
Transmit Power Output
RF Data Rate 250,000 bps 250,000 bps 250,000 bps
Data Throughput up to 35000 bps (see chapter 4) up to 35000 bps (see chapter 4) up to 35000 bps (see chapter 4)
Serial Interface Data Rate
(software selectable)
Receiver Sensitivity
Power Requirements
Supply Voltage 2.1 - 3.6 V 3.0 - 3.4 V 2.7 - 3.6 V
Operating Current
(Transmit, max output
power)
Operating Current
(Receive))
Idle Current (Receiver off) 15mA 15mA 15mA
Power-down Current
General
Operating Frequency
Band
Dimensions 0.960” x 1.087” (2.438cm x 2.761cm) 0.960 x 1.297 (2.438cm x 3.294cm) 0.960 x 1.297 (2.438cm x 3.294cm)
Operating Temperature -40 to 85º C (industrial) -40 to 85º C (industrial) -40 to 85º C (industrial)
Antenna Options
Networking & Security
Supported Network
Topologies
Number of Channels 16 Direct Sequence Channels 14 Direct Sequence Channels 15 Direct Sequence Channels
Channels 11 to 26 11 to 24 11 to 25
Addressing Options
Agency Approvals
United States (FCC Part
15.247)
Industry Canada (IC) IC: 4214A-XBEE2 IC: 1846A-XBEEPRO2 IC: 1846A-PROS2B
Europe (CE) ETSI ETSI (International variant) ETSI (10 mW max)
Up to 300 ft. (90 m), up to 200 ft (60 m)
international variant
up to 400 ft. (120 m)
2mW (+3dBm), boost mode enabled
1.25mW (+1dBm), boost mode
disabled
1200 bps - 1 Mbps
(non-standard baud rates also
supported)
-96 dBm, boost mode enabled
-95 dBm, boost mode disabled
40mA (@ 3.3 V, boost mode
enabled)
35mA (@ 3.3 V, boost mode
disabled)
40mA (@ 3.3 V, boost mode
enabled)
38mA (@ 3.3 V, boost mode
disabled)
o
< 1 uA @ 25
ISM 2.4 GHz ISM 2.4 GHz ISM 2.4 GHz
Integrated Whip, Chip, RPSMA, or
U.FL Connector
Point-to-point, Point-to-multipoint,
Peer-to-peer, and Mesh
PAN ID and Addresses, Cluster IDs
and Endpoints (optional)
FCC ID: OUR-XBEE2 FCC ID: MCQ-XBEEPRO2 FCC ID: MCQ-PROS2B
C3.5 A typical @ 25oC3.5 A typical @ 25oC
Up to 2 miles (3200 m), up to 5000 ft
(1500 m) international variant
50mW (+17 dBm)
10mW (+10 dBm) for International
variant
1200 bps - 1 Mbps
(non-standard baud rates also
supported)
-102 dBm -102 dBm
295mA (@3.3 V)
170mA (@3.3 V) international variant
45 mA (@3.3 V)
Integrated Whip Antenna, Embedded
PCB Antenna, RPSMA or U.FL
Connector
Point-to-point, Point-to-multipoint, Peerto-peer, and Mesh
PAN ID and Addresses, Cluster IDs and
Endpoints (optional)
Up to 300 ft. (90 m), up to 200 ft (60 m)
international variant
Up to 2 miles (3200 m), up to 5000 ft (1500
m) international variant
63mW (+18 dBm)
10mW (+10 dBm) for International variant
1200 bps - 1 Mbps
(non-standard baud rates also supported)
205mA, up to 220 mA with programmable
variant (@3.3 V)
117mA, up to 132 mA with programmable
variant (@3.3 V), International variant
47 mA, up to 62 mA with programmable
variant (@3.3 V)
Integrated Whip Antenna, Embedded PCB
Antenna, RPSMA or U.FL Connector
Point-to-point, Point-to-multipoint, Peer-topeer, and Mesh
PAN ID and Addresses, Cluster IDs and
Endpoints (optional)
©2011DigiInternational,Inc. 9
XBee®/XBee‐PRO®ZBRFModules
SpecificationsoftheXBee®/XBee‐PRO®ZBRFModule
Specification XBee XBee-PRO (S2) XBee-PRO (S2B)
Australia C-Tick C-Tick C-Tick
Japan R201WW07215215
RoHS Compliant Compliant Compliant
R201WW08215142 (international
variant)
Hardware Specs for Programmable Variant
The following specifications need to be added to the current measurement of the previous table if the module
has the programmable secondary processor. For example, if the secondary processor is running and
constantly collecting DIO samples at a rate while having the RF portion of the XBEE sleeping the new current
will be I
of the RF portion of the module of the XBEE-PRO (S2B) listed in the table below.
= Ir2 + I0, where I
total
Specificationsoftheprogrammablesecondaryprocessor
Optional Secondary Processor Specification
Runtime current for 32k running at 20MHz +14mA
Runtime current for 32k running at 1MHz +1mA
For additional specifications see Freescale Datasheet and
Minimum Reset low pulse time for EM250 +50 nS (additional resistor increases minimum time)
is the runtime current of the secondary processor and Is is the sleep current
r2
Sleep current +0.5uA typical
Manual
VREF Range 1.8VDC to VCC
R201WW10215062 (international variant)
These numbers add to S2B specifications
(Add to RX, TX, and sleep currents depending on
mode of operation)
MC9SO8QE32
Mechanical Drawings
MechanicaldrawingsoftheXBee®/XBee‐PRO®ZBRFModules(antennaoptionsnotshown)
.
©2011DigiInternational,Inc. 10
XBee®/XBee‐PRO®ZBRFModules
MechanicalDrawingsfortheRPSMAVari a nt
SIF Header Interface
The XBee/XBee-PRO ZB modules include a SIF programming header that can be used with Ember's
programming tools to upload custom firmware images onto the XBee module. The SIF header orientation and
pinout are shown below.
A male header can be populated on the XBee that mates with Ember's 2x5 ribbon cable. The male header and
ribbon cables are available from Samtec:
2x5 Male Header - FTSH-105-01-F-DV-K
2x5 Ribbon Cable - FFSD-05-D-12.00-01-N
©2011DigiInternational,Inc. 11
XBee®/XBee‐PRO®ZBRFModules
Mounting Considerations
The XBee module was designed to mount into a receptacle (socket) and therefore does not require any
soldering when mounting it to a board. The XBee-PRO Development Kits contain RS-232 and USB interface
boards which use two 20-pin receptacles to receive modules.
XBee‐PROModuleMountingtoanRS‐232InterfaceBoard.
The receptacles used on Digi development boards are manufactured by Century Interconnect. Several other
manufacturers provide comparable mounting solutions; however, Digi currently uses the following
receptacles:
• Through-hole single-row receptacles -
Samtec P/N: MMS-110-01-L-SV (or equivalent)
• Through-hole single-row receptacles -
Mill-Max P/N: 831-43-0101-10-001000
• Surface-mount double-row receptacles -
Century Interconnect P/N: CPRMSL20-D-0-1 (or equivalent)
• Surface-mount single-row receptacles -
Samtec P/N: SMM-110-02-SM-S
Digi also recommends printing an outline of the module on the board to indicate the orientation the
module should be mounted.
©2011DigiInternational,Inc. 12
XBee®/XBee‐PRO®ZBRFModules
Pin Signals
PinAssignmentsfortheXBee/XBee‐PROModules
Pin # Name Direction Default State Description
1 VCC - - Power supply
2 DOUT Output Output UART Data Out
3 DIN / CONFIG
4 DIO12 Both Disabled Digital I/O 12
5 RESET
6 RSSI PWM / DIO10 Both Output RX Signal Strength Indicator / Digital IO
7 DIO11 Both Input Digital I/O 11
8 [reserved] - Disabled Do not connect
9DTR
10 GND - - Ground
11 DIO4 Both Disabled Digital I/O 4
12 CTS
13 ON / SLEEP
14 VREF Input -
15 Associate / DIO5 Both Output Associated Indicator, Digital I/O 5
16 RTS
17 AD3 / DIO3 Both Disabled Analog Input 3 or Digital I/O 3
18 AD2 / DIO2 Both Disabled Analog Input 2 or Digital I/O 2
19 AD1 / DIO1 Both Disabled Analog Input 1 or Digital I/O 1
20
(Low‐assertedsignalsaredistinguishedwithahorizontallineabovesignalname.)
Input Input UART Data In
Both
/ SLEEP_RQ/ DIO8 Both Input Pin Sleep Control Line or Digital IO 8
/ DIO7 Both Output
Output Output Module Status Indicator or Digital I/O 9
/ DIO6 Both Input
AD0 / DIO0 /
Commissioning Button
Both Disabled
Open-Collector with
pull-up
Module Reset (reset pulse must be at least 200
ns)
Clear-to-Send Flow Control or Digital I/O 7. CTS, if
enabled, is an output.
Not used for EM250. Used for programmable
secondary processor.
For compatibility with other XBEE modules, we
recommend connecting this pin voltage reference
if Analog sampling is desired.
Otherwise, connect to GND.
Request-to-Send Flow Control, Digital I/O 6. RTS,
if enabled, is an input.
Analog Input 0, Digital IO 0, or Commissioning
Button
• Signal Direction is specified with respect to the module
• See Design Notes section below for details on pin connections.
©2011DigiInternational,Inc. 13
XBee®/XBee‐PRO®ZBRFModules
EM250 Pin Mappings
The following table shows how the EM250 pins are used on the XBee.
EM250 Pin Number XBee Pin Number Other Usage
13 (Reset) 5* Connected to pin 8 on 2x5 SIF header.
19 (GPIO 11) 16*
20 (GPIO 12) 12*
21 (GPIO 0)
22 (GPIO 1)
24 (GPIO 2)
25 (GPIO 3) 13
26 (GPIO 4 / ADC 0) 20 Connected to pin 9 on 2x5 SIF header.
27 (GPIO 5 / ADC 1) 19 Connected to pin 10 on 2x5 SIF header.
29 (GPIO 6 /ADC 2) 18
30 (GPIO 7 / ADC 3 17
31 (GPIO 8) 4
32 (GPIO 9) 2*
33 (GPIO 10) 3*
34 (SIF_CLK) Connected to pin 6 on 2x5 SIF header.
35 (SIF_MISO) Connected to pin 2 on 2x5 SIF header.
36 (SIF_MOSI) Connected to pin 4 on 2x5 SIF header.
37 (SIF_LOAD) Connected to pin 7 on 2x5 SIF header.
40 (GPIO 16) 7
41 (GPIO 15) 6
42 (GPIO 14) 9
43 (GPIO 13) 11
15
XBee
Tied to ground (module identification)
XBee-PRO (S2)
Low-asserting shutdown line for output power compensation circuitry.
XBee-PRO (S2B)
Used to communicate with Temp Sensor and control Shutdown for low power mode.
XBee
Not connected. Configured as output low.
XBee-PRO (S2)
Powers the output power compensation circuitry.
XBee-PRO (S2B)
Used to communicate with Temp Sensor and control Shutdown for low power mode.
* NOTE: These lines may not go to the external XBEE pins of the module if the programmable secondary processor
is populated.
Design Notes
The XBee modules do not specifically require any external circuitry or specific connections for proper
operation. However, there are some general design guidelines that are recommended for help in
troubleshooting and building a robust design.
Power Supply Design
Poor power supply can lead to poor radio performance especially if the supply voltage is not kept within
tolerance or is excessively noisy. To help reduce noise a 1uF and 8.2pF capacitor are recommended to be
placed as near to pin1 on the PCB as possible. If using a switching regulator for your power supply, switching
frequencies above 500kHz are preferred. Power supply ripple should be limited to a maximum 250mV peak to
peak.
Note – For designs using the programmable modules an additional 10uF decoupling cap is recommended near
pin 1 of the module. The nearest proximity to pin 1 of the 3 caps should be in the following order: 8.2pf, 1uF
followed by 10uF.
©2011DigiInternational,Inc. 14
XBee®/XBee‐PRO®ZBRFModules
Recommended Pin Connections
The only required pin connections are VCC, GND, DOUT and DIN. To support serial firmware updates, VCC,
GND, DOUT, DIN, RTS, and DTR should be connected.
All unused pins should be left disconnected. All inputs on the radio can be pulled high with 30k internal pull-up
resistors using the PR software command. No specific treatment is needed for unused outputs.
For applications that need to ensure the lowest sleep current, inputs should never be left floating. Use internal
or external pull-up or pull-down resistors, or set the unused I/O lines to outputs.
Other pins may be connected to external circuitry for convenience of operation including the Associate LED pin
(pin 15) and the Commissioning pin (pin 20). The Associate LED pin will flash differently depending on the
state of the module to the network, and a pushbutton attached to pin 20 can enable various join functions
without having to send UART commands. Please see the commissioning pushbutton and associate LED section
in chapter 7 for more details. The source and sink capabilities are limited to 4mA for all pins on the module.
The VRef pin (pin 14) is not used on this module. For compatibility with other XBee modules, we recommend
connecting this pin to a voltage reference if analog sampling is desired. Otherwise, connect to GND.
Board Layout
XBee modules do not have any specific sensitivity to nearby processors, crystals or other PCB components.
Other than mechanical considerations, no special PCB placement is required for integrating XBee radios except
for those with integral antennas. In general, Power and GND traces should be thicker than signal traces and be
able to comfortably support the maximum currents.
The radios are also designed to be self sufficient and work with the integrated and external antennas without
the need for additional ground planes on the host PCB. However, considerations should be taken on the choice
of antenna and antenna location. Metal objects that are near an antenna cause reflections and may reduce the
ability for an antenna to efficiently radiate. Using an integral antenna (like a wire whip antenna) in an enclosed
metal box will greatly reduce the range of a radio. For this type of application an external antenna would be a
better choice.
External antennas should be positioned away from metal objects as much as possible. Metal objects next to
the antenna or between transmitting and receiving antennas can often block or reduce the transmission
distance. Some objects that are often overlooked are metal poles, metal studs or beams in structures,
concrete (it is usually reinforced with metal rods), metal enclosures, vehicles, elevators, ventilation ducts,
refrigerators and microwave ovens.
The Wire Whip Antenna should be straight and perpendicular to the ground plane and/or chassis. It should
reside above or away from any metal objects like batteries, tall electrolytic capacitors or metal enclosures. If
the antenna is bent to fit into a tight space, it should be bent so that as much of the antenna as possible is
away from metal. Caution should be used when bending the antenna, since this will weaken the solder joint
where the antenna connects to the module. Antenna elements radiate perpendicular to the direction they
point. Thus a vertical antenna emits across the horizon.
Embedded PCB or Chip Antennas should not have any ground planes or metal objects above or below the
module at the antenna location. For best results the module should be in a plastic enclosure, instead of metal
one. It should be placed at the edge of the PCB to which it is mounted. The ground, power and signal planes
should be vacant immediately below the antenna section (See drawing for recommended keepout area).
©2011DigiInternational,Inc. 15
XBee®/XBee‐PRO®ZBRFModules
©2011DigiInternational,Inc. 16
XBee®/XBee‐PRO®ZBRFModules
Electrical Characteristics
DCCharacteristicsoftheXBee/XBee‐PRO
Symbol Parameter Condition Min Typical Max Units
V
IL
V
IH
V
OL
V
OH
I
IIN
I
OHS
I
OHH
I
OLS
I
OLH
I
OH + IOL
V
REFI
V
IADC
R
IS
R
I
Note – The signal-ended ADC measurements are limited in their range and only guaranteed for accuracy in
the range 0 to VREFI. The nature of the ADC’s internal design allows for measurements outside of this range
(+/- 200mV), but the accuracy of such measurements are not guaranteed.
Input Low Voltage All Digital Inputs - - 0.2 * VCC V
Input High Voltage All Digital Inputs 0.8 * VCC - - V
Output Low Voltage VCC >= 2.7 V - - 0.18*VCC V
Output High Voltage VCC >= 2.7 V 0.82*VCC - - V
Input Leakage Current
Output source current (standard)
Output source current (high
current)
Output sink current (standard
Output sink current (high current) RSSI/PWM, DIO10, DIO4 digital outputs 8 mA
Total output current for all I/O pins All digital outputs 40 mA
VREF Internal
ADC input voltage range 0 VREFI V
Input impedance When taking a sample 1 M Ohm
Input Impedance When not taking a sample 10 M Ohm
= VCC or GND, all inputs, per pin
V
IN
All digital outputs except
RSSI/PWM, DIO10, DIO4
- - 0.5uA uA
4mA
RSSI/PWM, DIO10, DIO4 digital outputs 8 mA
All digital inputs except
RSSI/PWM, DIO10, DIO4
EM250 has an internal reference that is
fixed
1.19 1.2 1.21 V
4mA
Module Operation for Programmable Variant
The S2B modules that have the programmable option populated have a secondary processor with 32k of flash
and 2k of RAM. This allows module integrators to put custom code on the XBEE module to fit their own unique
needs. The DIN, DOUT, RTS, CTS, and RESET lines are intercepted by the secondary processor to allow it to be
in control of the data transmitted and received. All other lines are in parallel and can be controlled by either
the EM250 or the MC9S08QE micro (see Block Diagram for details). The EM250 by default has control of
certain lines. These lines can be released by the EM250 by sending the proper command(s) to disable the
desired DIO line(s) (see XBEE Command Reference Tables).
In order for the secondary processor to sample with ADCs, the XBEE pin 14 (VREF) needs to be connected to
a reference voltage.
Digi provides a bootloader that can take care of programming the processor over the air or through the serial
interface. This means that over the air updates can be supported through an XMODEM protocol. The processor
can also be programmed and debugged through a one wire interface BKGD (Pin 8).
©2011DigiInternational,Inc. 17
XBee®/XBee‐PRO®ZBRFModules
©2011DigiInternational,Inc. 18
XBee®/XBee‐PRO®ZBRFModules
XBEE Programmable Bootloader
Overview
The Xbee Programmable module is equipped with a Freescale MC9S08QExx application processor. This
application processor comes with a supplied bootloader. The following section describes how to interface the
customer's application code running on this processor to the XBee Programmable module's supplied
bootloader.
This section discusses how to initiate firmware updates using the supplied bootloader for wired and over-theair updates.
Bootloader Software Specifics
Memory Layout
Figure 1 shows the memory map for the MC9S08QE32 application processor.
The supplied bootloader occupies the bottom pages of the flash from 0xF200 to 0xFFFF. Application
code cannot write to this space.
The application code can exist in Flash from address 0x8400 to 0xF1BC. 1k of Flash from 0x8000 to
0x83FF is reserved for Non Volatile Application Data that will not be erased by the bootloader during a
flash update.
A portion of RAM is accessible by both the application and the bootloader. Specifically, there is a
shared data region used by both the application and the bootloader that is located at RAM address
0x200 to 0x215. Application code should not write anything to AppResetCause or BLResetCause unless
informing the bootloader of the impending reset reason.
©2011DigiInternational,Inc. 19
XBee®/XBee‐PRO®ZBRFModules
©2011DigiInternational,Inc. 20
XBee®/XBee‐PRO®ZBRFModules
©2011DigiInternational,Inc. 21
XBee®/XBee‐PRO®ZBRFModules
Operation
Upon reset of any kind, the execution control begins with the bootloader.
If the reset cause is Power-On reset (POR), Pin reset (PIN), or Low Voltage Detect(LVD) reset the
bootloader will not jump to the application code if the override bits are set to RTS(D7)=1, DTR(D5)=0,
and DIN(B0)=0. Otherwise, the bootloader writes the reset cause "NOTHING" to the shared data
region, and jumps to the Application.
Reset causes are defined in the file common. h in an enumeration with the following definitions:
typedef enum {
BL_CAUSE_NOTHING = 0x0000, //PIN, LVD, POR
BL_CAUSE_NOTHING_COUNT = 0x0001,//BL_Reset_Cause counter
// Bootloader increments cause every reset
BL_CAUSE_BAD_APP = 0x0010,//Bootloader considers APP invalid
} BL_RESET_CAUSES;
typedef enum {
APP_CAUSE_NOTHING = 0x0000,
APP_CAUSE_USE001 = 0x0001,
// 0x0000 to 0x00FF are considered valid for APP use.
APP_CAUSE_USE255 = 0x00FF,
APP_CAUSE_FIRMWARE_UPDATE = 0x5981,
APP_CAUSE_BYPASS_MODE = 0x4682,
APP_CAUSE_BOOTLOADER_MENU = 0x6A18,
} APP_RESET_CAUSES;
Otherwise, if the reset cause is a "watchdog" or other reset, the bootloader checks the shared memory
region for the APP_RESET_CAUSE. If the reset cause is:
1."APP_CAUSE_NOTHING" or 0x0000 to 0x00FF, the bootloader increments the
BL_RESET_CAUSES, verifies that it is still less than BL_CAUSE_BAD_APP, and jumps back to
the application. If the Application does not clear the BL_RESET_CAUSE, it can prevent an
infinite loop of running a bad application that continues to perform illegal instructions or
watchdog resets.
2."APP_CAUSE_FIRMWARE_UPDATE", the bootloader has been instructed to update the
application "over-the-air" from a specific 64 bit address. In this case, the bootloader will
attempt to initiate an Xmodem transfer from the 64 bit address located in Shared RAM.
3."APP_CAUSE_BYPASS_MODE", the bootloader executes bypass mode. This mode passes the
local UART data directly to the EM250 allowing for direct communication with the EM250.
The only way to exit bypass mode is to reset or power cycle the module.
If none of the above is true, the bootloader will enter "Command mode". In this mode, users can
initiate firmware downloads both wired and over-the-air, check application/bootloader version strings,
and enter Bypass mode.
Application version string
Figure 1 shows an "Application version string pointer" area in application flash which holds the pointer
to where the application version string resides. The application's linker command file ultimately
determines where this string is placed in application flash.
It is preferable that the application version string be located at address 0x8400 for MC9S08QE32 parts.
The application string can be any characters terminated by the NULL character (0x00). There is not a
strict limit on the number of characters in the string, but for practical purposes should be kept under
100 bytes including the terminating NULL character. During an update the bootloader erases the entire
application from 0x8400 on. The last page has the vector table specifically the redirected reset vector.
The version string pointer and reset vector are used to determine if the application is valid.
©2011DigiInternational,Inc. 22
XBee®/XBee‐PRO®ZBRFModules
Application Interrupt Vector table and Linker Command File
Since the bootloader flash region is read-only, the interrupt vector table is redirected to the region
0xF1C0 to 0xF1FD so that application developers can use hardware interrupts. Note that in order for
Application interrupts to function properly, the Application's linker command file (*.prm extension)
must be modified appropriately to allow the linker to place the developers code in the correct place in
memory. For example, the developer desires to use the serial communications port SCI1 receive
interrupt. The developer would add the following line to the Codewarrior linker command file for the
project…
VECTOR ADDRESS 0x0000F1E0 vSci1Rx
This will inform the linker that the interrupt function "vSci1Rx()" should be placed at address
0x0000F1E0. Next, the developer should add a file to their project "vector_table.c" that creates an
array of function pointers to the ISR routines used by the application…Eg.
extern void _Startup(void);/* _Startup located in Start08.c */
extern void vSci1Rx(void);/* sci1 rx isr */
extern short iWriteToSci1(unsigned char *);
void vDummyIsr(void);
#pragma CONST_SEG VECTORS
void (* const vector_table[])(void) = /* Relocated Interrupt vector table */{
vDummyIsr,/* Int.no. 0 Vtpm3ovf (at F1C0)Unassigned */
vDummyIsr, /* Int.no. 1 Vtpm3ch5 (at F1C2) Unassigned */
vDummyIsr, /* Int.no. 2 Vtpm3ch4 (at F1C4) Unassigned */
vDummyIsr, /* Int.no. 3 Vtpm3ch3 (at F1C6) Unassigned */
vDummyIsr, /* Int.no. 4 Vtpm3ch2 (at F1C8) Unassigned */
vDummyIsr, /* Int.no. 5 Vtpm3ch1 (at F1CA) Unassigned */
vDummyIsr, /* Int.no. 6 Vtpm3ch0 (at F1CC) Unassigned */
vDummyIsr, /* Int.no. 7 Vrtc (at F1CE) Unassigned */
vDummyIsr, /* Int.no. 8 Vsci2tx (at F1D0) Unassigned */
vDummyIsr, /* Int.no. 9 Vsci2rx (at F1D2) Unassigned */
vDummyIsr, /* Int.no. 10 Vsci2err (at F1D4) Unassigned */
vDummyIsr, /* Int.no. 11 Vacmpx (at F1D6) Unassigned */
vDummyIsr, /* Int.no. 12 Vadc (at F1D8) Unassigned */
vDummyIsr, /* Int.no. 13 Vkeyboard (at F1DA) Unassigned */
vDummyIsr, /* Int.no. 14 Viic (at F1DC) Unassigned */
vDummyIsr, /* Int.no. 15 Vsci1tx (at F1DE) Unassigned */
vSci1Rx, /* Int.no. 16 Vsci1rx (at F1E0) SCI1RX */
vDummyIsr, /* Int.no. 17 Vsci1err (at F1E2) Unassigned */
vDummyIsr, /* Int.no. 18 Vspi (at F1E4) Unassigned */
vDummyIsr, /* Int.no. 19 VReserved12 (at F1E6) Unassigned */
vDummyIsr, /* Int.no. 20 Vtpm2ovf (at F1E8) Unassigned */
vDummyIsr, /* Int.no. 21 Vtpm2ch2 (at F1EA) Unassigned */
vDummyIsr, /* Int.no. 22 Vtpm2ch1 (at F1EC) Unassigned */
vDummyIsr, /* Int.no. 23 Vtpm2ch0 (at F1EE) Unassigned */
vDummyIsr, /* Int.no. 24 Vtpm1ovf (at F1F0) Unassigned */
vDummyIsr, /* Int.no. 25 Vtpm1ch2 (at F1F2) Unassigned */
vDummyIsr, /* Int.no. 26 Vtpm1ch1 (at F1F4) Unassigned */
vDummyIsr, /* Int.no. 27 Vtpm1ch0 (at F1F6) Unassigned */
©2011DigiInternational,Inc. 23
XBee®/XBee‐PRO®ZBRFModules
};
void vDummyIsr(void){
for(;;){
if(iWriteToSci1("STUCK IN UNASSIGNED ISR\n\r>"));
}
}
The interrupt routines themselves can be defined in separate files. The "vDummyIsr" function is used
in conjunction with "iWritetoSci1" for debugging purposes.
Bootloader Menu Commands
The bootloader accepts commands from both the local UART and OTA. All OTA commands sent must be
Unicast with only 1 byte in the payload for each command. A response will be returned to the sender. All
Broadcast and multiple byte OTA packets are dropped to help prevent general OTA traffic from being
interpreted as a command to the bootloader while in the menu.
Bypass Mode - "B"
vDummyIsr, /* Int.no. 28 Vlvd (at F1F8) Unassigned */
vDummyIsr, /* Int.no. 29 Virq (at F1FA) Unassigned */
vDummyIsr, /* Int.no. 30 Vswi (at F1FC) Unassigned */
_Startup /* Int.no. 31 Vreset (at F1FE) Reset vector */
The bootloader provides a "bypass" mode of operation that essentially connects the SCI1 serial
communications peripheral of the freescale mcu to the EM250's serial Uart channel. This allows direct
communication to the EM250 radio for the purpose of firmware and radio configuration changes. Once
in bypass mode, the XCTU utility can change modem configuration and/or update EM250 firmware.
Bypass mode automatically handles any baud rate up to 115.2kbps. Note that this command is
unavailable when module is accessed remotely.
Update Firmware - "F"
The "F" command initiates a firmware download for both wired and over-the-air configurations.
Depending on the source of the command (received via Over the Air or local UART), the download will
proceed via wired or over-the-air respectively.
Adjust Timeout for Update Firmware - "T"
The "T" command changes the timeout before sending a NAK by Base-Time*2^(T). The Base-Time for
the local UART is different than the Base-Time for Over the Air. During a firmware update, the
bootloader will automatically increase the Timeout if repeat packets are received or multiple NAKs for
the same packet without success occur.
Application Version String - "A"
The "A" command provides the version of the currently loaded application. If no application is present,
"Unkown" will be returned.
Bootloader Version String - "V"
The "V" command provides the version of the currently loaded bootloader.
The version will return a string in the format BLFFF-HHH-XYZ_DDD where FFF represents the Flash size
in kilo bytes, HHH is the hardware, XYZ is the version, and DDD is the preferred XMODEM packet size
for updates. Double the preferred packet size is also possible, but not guaranteed. For example
"BL032-2B0-023_064" will take 64 byte CRC XMODEM payloads and may take 128 byte CRC XMODEM
payloads also. In this case, both 64 and 128 payloads are handled, but the 64 byte payload is
preferred for better Over the Air reliability.
©2011DigiInternational,Inc. 24
XBee®/XBee‐PRO®ZBRFModules
Firmware Updates
Wired Updates
A user can update their application using the bootloader in a wired configuration with the following
steps…
a. Plug XBee programmable module into a suitable serial port on a PC.
b. Open a hyperterminal (or similar dumb terminal application) session with 9600 baud, no parity,
and 8 data bits with one stop bit.
c. Hit Enter to display the bootloader menu.
d. Hit the "F" key to initiate a wired firmware update.
e. A series of "C" characters Will be displayed within the hyperterminal window. At this point,
select the "transfer->send file" menu item. Select the desired flat binary output file. (The file
should start at 0x8400 not 0x0000).
f. Select "Xmodem" as the protocol.
g. Click "Send" on the "Send File" dialog. The file will be downloaded to the XBee Programmable
module. Upon a successful update, the bootloader will jump to the newly loaded application.
Over-The-Air updates
A user can update their application using the bootloader in an "over-the-air" configuration with the
following steps…(This procedure assumes that the bootloader is running and not the application. The
EM250 baud rate must be set to 9600 baud. The bootloader only operates at 9600 baud. The
application must be programmed with some way to support returning to the bootloader in order to
support Over the Air (OTA) updates without local intervention.)
a. The XBee module sending the file OTA (Host module) should be set up with a series 2 Xbee
module with transparent mode firmware.
b. The XBee Programmable module receiving the update (remote module) is configured with API
firmware.
c. Open a hyperterminal session to the host module with 9600 baud, no parity, no hardwareflow
control, 8 data bits and 1 stop bit.
d.Enter 3 pluses "+++" to place the EM250 in command mode.
e. Set the Host Module destination address to the target module’s 64 bit address that the host
module will update (ATDH aabbccdd, ATDL eeffgghh, ATCN, where aabbccddeeffgghh is the hexadecimal 64 bit address of the target module).
f. Hit Enter and the bootloader command menu will be displayed from the remote module. (Note
that the option "B" doesn't exist for OTA)
g. Hit the "F" key to cause the remote module to request the new firmware file over-the-air.
h. The host module will begin receiving "C" characters indicating that the remote module is
requesting an Xmodem CRC transfer. Using XCTU or another terminal program, Select "XMODEM"
file transfer. Select the Binary file to upload/transfer. Click Send to start the transfer. At the conclusion of a successful transfer, the bootloader will jump to the newly loaded application.
Output File configuration
BKGD Programming
P&E Micro provides a background debug tool that allows flashing applications on the MC9S08QE parts
through their background debug mode port. By default, the Codewarrior tool produces an "ABS"
output file for use in programming parts through the background debug interface. The programmable
XBee from the factory has the BKGD debugging capability disabled. In order to debug, a bootloader
with the debug interface enabled needs to be loaded on the secondary processor or a stand-alone app
needs to be loaded.
©2011DigiInternational,Inc. 25
XBee®/XBee‐PRO®ZBRFModules
Bootloader updates
The supplied bootloader requires files in a "flat binary" format which differs from the default ABS file
produced. The Codewarrior tool also produces a S19 output file. In order to successfully flash new
applications, the S19 file must be converted into the flat binary format. Utilities are available on the
web that will convert S19 output to "BIN" outputs. Often times, the "BIN" file conversion will pad the
addresses from 0x0000 to the code space with the same number. (Often 0x00 or 0xFF) These extra
bytes before the APP code starts will need to be deleted from the bin file before the file can be
transferred to the bootloader.
©2011DigiInternational,Inc. 26
2.RFModuleOperation
DIN (data in)
DIN (data in)
DOUT (data out )
DOUT (data out)
Serial Communications
The XBee RF Modules interface to a host device through a logic-level asynchronous serial port. Through its serial
port, the module can communicate with any logic and voltage compatible UART; or through a level translator to any
serial device (for example: through a RS-232 or USB interface board).
UART Data Flow
Devices that have a UART interface can connect directly to the pins of the RF module as shown in the figure
below.
SystemDataFlowDiagraminaUART‐interfacedenvironment
Serial Data
(Low‐assertedsignalsdistinguishedwithhorizontallineoversignalname.)
Data enters the module UART through the DIN (pin 3) as an asynchronous serial signal. The signal should
idle high when no data is being transmitted.
Each data byte consists of a start bit (low), 8 data bits (least significant bit first) and a stop bit (high). The
following figure illustrates the serial bit pattern of data passing through the module.
UARTdatapacket0x1F(decimalnumberʺ31ʺ)astransmittedthroughtheRFmodule
ExampleDataFormatis8‐N‐1(bits‐parity‐#ofstopbits)
Serial communications depend on the two UARTs (the microcontroller's and the RF module's) to be
configured with compatible settings (baud rate, parity, start bits, stop bits, data bits).
The UART baud rate, parity, and stop bits settings on the XBee module can be configured with the BD, NB,
and SB commands respectively. See the command table in chapter 10 for details.
Serial Buffers
The XBee modules maintain small buffers to collect received serial and RF data, which is illustrated in the figure
below. The serial receive buffer collects incoming serial characters and holds them until they can be processed.
The serial transmit buffer collects data that is received via the RF link that will be transmitted out the UART.
©2011DigiInternational,Inc. 27
XBee®/XBee‐PRO®ZBRFModules
Serial
Receiver
Buffer
RF TX
Buffer
Transmitter
RF Switch
Antenna
Port
Receiver
Serial Transmit
Buffer
RF RX
Buffer
Processor
DIN
DOUT
CTS
RTS
TInternalDataFlowDiagram
Serial Receive Buffer
When serial data enters the RF module through the DIN Pin (pin 3), the data is stored in the serial receive
buffer until it can be processed. Under certain conditions, the module may not be able to process data in
the serial receive buffer immediately. If large amounts of serial data are sent to the module, CTS
control may be required to avoid overflowing the serial receive buffer.
Cases in which the serial receive buffer may become full and possibly overflow:
1. If the module is receiving a continuous stream of RF data, the data in the serial receive buffer
will not be transmitted until the module is no longer receiving RF data.
2. If the module is transmitting an RF data packet, the module may need to discover the destination address or establish a route to the destination. After transmitting the data, the module may
need to retransmit the data if an acknowledgment is not received, or if the transmission is a broadcast. These issues could delay the processing of data in the serial receive buffer.
flow
Serial Transmit Buffer
When RF data is received, the data is moved into the serial transmit buffer and sent out the UART. If the
serial transmit buffer becomes full enough such that all data in a received RF packet won’t fit in the serial
transmit buffer, the entire RF data packet is dropped.
Serial Flow Control
The RTS and CTS module pins can be used to provide RTS and/or CTS flow control. CTS flow control provides an
indication to the host to stop sending serial data to the module. RTS flow control allows the host to signal the
module to not send data in the serial transmit buffer out the uart. RTS
the D6 and D7 commands.
CTS Flow Control
If CTS flow control is enabled (D7 command), when the serial receive buffer is 17 bytes away from being
full, the module de-asserts CTS
re-asserted after the serial receive buffer has 34 bytes of space.
RTS Flow Control
If RTS flow control is enabled (D6 command), data in the serial transmit buffer will not be sent out the
DOUT pin as long as RTS
Cases in which the serial transmit buffer may become full resulting in dropped RF packets
1. If the RF data rate is set higher than the interface data rate of the module, the module could
receive data faster than it can send the data to the host.
2. If the host does not allow the module to transmit data out from the serial transmit buffer
because of being held off by hardware flow control.
and CTS flow control are enabled using
(sets it high) to signal to the host device to stop sending serial data. CTS is
is de-asserted (set high). The host device should not de-assert RTS for long
©2011DigiInternational,Inc. 28
XBee®/XBee‐PRO®ZBRFModules
periods of time to avoid filling the serial transmit buffer. If an RF data packet is received, and the serial
transmit buffer does not have enough space for all of the data bytes, the entire RF data packet will be
discarded.
Note: If the XBee is sending data out the UART when RTS
up to 5 characters out the UART after RTS
Serial Interface Protocols
The XBee modules support both transparent and API (Application Programming Interface) serial interfaces.
Transparent Operation
When operating in transparent mode, the modules act as a serial line replacement. All UART data received
through the DIN pin is queued up for RF transmission. When RF data is received, the data is sent out
through the DOUT pin. The module configuration parameters are configured using the AT command mode
interface.
Data is buffered in the serial receive buffer until one of the following causes the data to be packetized and
transmitted:
•No serial characters are received for the amount of time determined by the RO (Packetization Timeout) parameter. If RO = 0, packetization begins when a character is received.
•The Command Mode Sequence (GT + CC + GT) is received. Any character buffered in the serial
receive buffer before the sequence is transmitted.
•The maximum number of characters that will fit in an RF packet is received.
RF modules that contain the following firmware versions will support Transparent Mode:
20xx (AT coordinator), 22xx (AT router), and 28xx (AT end device).
is de-asserted (set high), the XBee could send
is de-asserted.
API Operation
API operation is an alternative to transparent operation. The frame-based API extends the level to which a
host application can interact with the networking capabilities of the module. When in API mode, all data
entering and leaving the module is contained in frames that define operations or events within the module.
Transmit Data Frames (received through the DIN pin (pin 3)) include:
•RF Transmit Data Frame
•Command Frame (equivalent to AT commands)
Receive Data Frames (sent out the DOUT pin (pin 2)) include:
•RF-received data frame
•Command response
•Event notifications such as reset, associate, disassociate, etc.
The API provides alternative means of configuring modules and routing data at the host application layer. A
host application can send data frames to the module that contain address and payload information instead
of using command mode to modify addresses. The module will send data frames to the application
containing status packets; as well as source, and payload information from received data packets.
The API operation option facilitates many operations such as the examples cited below:
-> Transmitting data to multiple destinations without entering Command Mode
-> Receive success/failure status of each transmitted RF packet
-> Identify the source address of each received packet
RF modules that contain the following firmware versions will support API operation: 21xx (API coordinator),
23xx (API router), and 29xx (API end device).
©2011DigiInternational,Inc. 29
XBee®/XBee‐PRO®ZBRFModules
A Comparison of Transparent and API Operation
The following table compares the advantages of transparent and API modes of operation:
Simple Interface All received serial data is transmitted unless the module is in command mode.
Easy to support It is easier for an application to support transparent operation and command mode
Easy to manage data
transmissions to multiple
destinations
Received data frames
indicate the sender's
address
Advanced ZigBee
addressing support
Advanced networking
diagnostics
Remote Configuration
Transparent Operation Features
API Operation Features
Transmitting RF data to multiple remotes only requires changing the address in the API frame. This
process is much faster than in transparent operation where the application must enter AT command
mode, change the address, exit command mode, and then transmit data.
Each API transmission can return a transmit status frame indicating the success or reason for
failure.
All received RF data API frames indicate the source address.
API transmit and receive frames can expose ZigBee addressing fields including source and
destination endpoints, cluster ID and profile ID. This makes it easy to support ZDO commands and
public profile traffic.
API frames can provide indication of IO samples from remote devices, and node identification
messages.
Set / read configuration commands can be sent to remote devices to configure them as needed
using the API.
As a general rule of thumb, API firmware is recommended when a device:
•sends RF data to multiple destinations
•sends remote configuration commands to manage devices in the network
•receives IO samples from remote devices
•receives RF data packets from multiple devices, and the application needs to know which device sent
which packet
•must support multiple ZigBee endpoints, cluster IDs, and/or profile IDs
•uses the ZigBee Device Profile services.
If the above conditions do not apply (e.g. a sensor node, router, or a simple application), then AT firmware
might be suitable. It is acceptable to use a mixture of devices running API and AT firmware in a network.
©2011DigiInternational,Inc. 30
Loading...