XBee Shield Technical document

XBee Shield Hookup Guide a learn.sparkfun.com
tutorial
Available online at: http://sfe.io/t230
Contents
Introduction
Hardware Overview
Example: Communication Test
Example: Remote Control Arduino
Resources and Going Further
Introduction
Heads up! Originally, this tutorial was written to configure an XBee Series 1 to communicate in
transparency mode. However, this can apply to the XBee Series 3 module as long as you configure
the firmware to the legacy 802.15.4 protocol. For more information, check out the Exploring XBees
and XCTU tutorial.
The XBee Shield gives your Arduino a seamless interface to XBee -- one of the most popular
wireless platforms around. With XBee, instead of being tied down by a serial cable -- inches away
from a paired device -- your Arduino can pass data over the air to another device hundreds of feet
away.
Page 1 of 24

SparkFun XBee Shield
WRL-12847
$16.95
26
Favorited Favorite 25
Wish List
Page 2 of 24

SparkFun XBee 3 Wireless Kit
KIT-15936
$78.95
2
Favorited Favorite 13
Wish List
Page 3 of 24

Part of what makes XBee so popular is its simplicity. XBees are controlled over a serial UART
interface -- in the most basic operation they can be used as a wireless serial cable. Setting up
XBee networks and addresses is also simplified with Digi's free software -- XCTU -- which we
explain in a separate tutorial.
Covered In This Tutorial
The goal of this tutorial is to set up wireless XBee communication between a computer and an
Arduino/XBee Shield combo. Then, using a terminal program, we can remotely send data to an
Arduino, or read data off of it.
We'll begin by examining the schematics and hardware of the XBee Shield, then move on to
example code. First we'll set up a test program to make sure our XBees are communicating with
Page 4 of 24

each other. Then we'll move on to the remote control Arduino sketch.
Required Materials
To follow along with this tutorial, you will need the following materials. You may not need everything
though depending on what you have. Add it to your cart, read through the guide, and adjust the cart
as necessary.
1x XBee Shield -- The star of this tutorial.
You'll also need headers to install into your shield. We recommend stackable headers.
1x Arduino -- The XBee Shield should work with any Arduino-compatible board -- Uno,
RedBoard, Mega, you name it.
2x XBees -- XBees exist in a variety of series, frequencies, and ranges. If you're just getting
started with XBee, we highly recommend going with Series 1 models -- either with a trace
antenna, wire antenna or u.fl connector.
For more help picking an XBee, check out our XBee Buying Guide.
Heads up! While this tutorial was written for XBee Series 1, you can still follow along using
XBee Series 3 modules. Just make sure to configure it with the 802.15.4 (Series 1) firmware.
For more information, check out the Exploring XBees and XCTU tutorial.
1x Explorer -- The Explorer board allows you to connect an XBee to your computer. You can
use either the Explorer USB, Explorer USB Dongle, or Explorer Serial.
Depending on which explorer you have, you may also need a matching mini-B USB or
serial cables.
At least one computer with X-CTU installed.
The latest version of X-CTU is available for both Mac and Windows!
Tools
You will need a soldering iron, solder, and general soldering accessories.
Solder Lead Free - 100-gram Spool
TOL-09325
$8.95
7
Favorited Favorite 33
Page 5 of 24

Wish List
Weller WLC100 Soldering Station
TOL-14228
$44.95
2
Favorited Favorite 16
Wish List
Suggested Reading
Before reading through this tutorial, we highly recommend checking out the Exploring XBees and
XCTU tutorial.
Exploring XBees and XCTU
March 12, 2015
How to set up an XBee using your computer, the X-CTU software, and an XBee Explorer interface
board.
Favorited Favorite 13
That tutorial will introduce you to XCTU and explain how to configure XBee networks and
addresses. In addition to that tutorial, we also recommend checking these guides out:
Serial Communication -- Serial communication is critical to controlling and managing XBees.
Arduino Shields -- The basics of Arduino Shields, including how to assemble a shield.
XBee Buying Guide -- We highly recommend Series 1 XBee's, if this is your first time playing
with them. If you're curious about other XBee classes, check out this guide!
How to Solder: Through-Hole Soldering
This tutorial covers everything you need to know about through-hole soldering.
Favorited Favorite 61
Serial Communication
Page 6 of 24

Asynchronous serial communication concepts: packets, signal levels, baud rates, UARTs and more!
Favorited Favorite 91
Arduino Shields v2
An update to our classic Arduino Shields Tutorial! All things Arduino shields. What they are and
how to assemble them.
Favorited Favorite 5
Hardware Overview
Here's a quick overview of the most components of the XBee Shield:
Below we'll go more in-depth on the most important components of the shield.
UART/Software Serial Switch
One of the most important components on the XBee Shield is the DLINE/UART switch. This switch
controls which Arduino pins interface with the XBee.
Page 7 of 24

The Arduino Uno has a single hardware UART, which is usually either used for programming (via
the Arduino's serial bootloader) or communication with the serial monitor. That serial port can only
be used to communicate with one device at any time, lest you run into problems of bus contention.
There's also a chance that, during program upload, spurious -- even harmful -- data might be sent
to any device attached to the Arduino's hardware UART.
So to avoid any problems that might arise from connecting the XBee to the Arduino's hardware
UART, we usually take advantage of the Software Serial library, connecting the XBee's RX and TX
pins to a pair of free digital pins on the Arduino.
To select between software and hardware serial, the XBee Shield includes a small, surface-mount
slide switch. This switch allows you to select between the hardware serial port (UART position) and
a software serial port connected to pins 2 (Arduino-side RX) and 3 (Arduino-side TX).
Page 8 of 24

The switch configuration from the XBee Shield schematic. "D_TX" connects to Arduino pin 3, and
"D_RX" connects to Arduino pin 2.
For all of our example sketches we'll assume the switch is in the DLINE position. At the very least,
make sure the switch is in the "DLINE" position when uploading sketches.
Status LED Indicators
There are 5 LEDs on the XBee Shield. Each of these LEDs connects to a pin on the XBee, which
does most of the LED driving. Here's a table explaining the operation of each LED:
LED
Label
LED
Color
XBee Pin
Connection Default Operation Notes
PWR Red 3.3V Indicates power is present.
DIO5 Green Associate/DIO5 Associated indicator -- blinks when the XBee is associated
with another XBee.
DOUT Red DOUT Indicates wireless data is being received.
DIN Green DIN Indicates wireless data is being transmitted.
RSSI Green PWM0/RSSI Indicates relative signal strength (RSSI) of last received
transmission.
These LEDs can be very useful for debugging. The DIO5/Associate indicator should blink when the
XBee is paired with a compatible device. The RSSI LED is actually PWM'd so it will be brighter
Page 9 of 24

when the paired XBee is closer (sending a stronger signal).
Assembly Tips
Before you can use the XBee Shield with your Arduino, you'll need to solder in some headers.
Check out the assembly page of our Shield tutorial for all of the tips and tricks related to header
installation.
XBee Socket
There is some white silkscreen on the Shield PCB to help orient your XBee as you're plugging it in.
Make sure to match up the XBee's two diagonal edges with the two diagonal lines on the PCB.
With everything installed, you're ready for the next step! Time to code...
Example: Communication Test
Note: This example assumes you are using the latest version of the Arduino IDE on your desktop.
If this is your first time using Arduino, please review our tutorial on installing the Arduino IDE.
Page 10 of 24