Digi XBee3 802.15.4 User manual

XBee3® 802.15.4
Radio Frequency (RF) Module
User Guide

Revision history—90002273
Revision Date Description
A February 2018 Initial release.
Trademarks and copyright
Digi, Digi International, and the Digi logo are trademarks or registered trademarks in the United
States and other countries worldwide. All other trademarks mentioned in this document are the
property of their respective owners.
© 2018 Digi International Inc. All rights reserved.
Disclaimers
Information in this document is subject to change without notice and does not represent a
commitment on the part of Digi International. Digi provides this document “as is,” without warranty of
any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or
merchantability for a particular purpose. Digi may make improvements and/or changes in this manual
or in the product(s) and/or the program(s) described in this manual at any time.
Warranty
To view product warranty information, go to the following website:
www.digi.com/howtobuy/terms
Send comments
Documentation feedback: To provide feedback on this document, send your comments to
[e-mail].
Customer support
Digi Technical Support: Digi offers multiple technical support plans and service packages to help our
customers get the most out of their Digi product. For information on Technical Support plans and
pricing, contact us at +1 952.912.3444 or visit us at www.digi.com/support.
XBee3® 802.15.4 RF Module User Guide 2

Contents
XBee3® 802.15.4 RF Module User Guide
Applicable firmware and hardware 8
Change the firmware protocol 8
Getting started
Verify kit contents 10
Assemble the hardware 10
Plug in the XBee3 802.15.4 RF Module 11
How to unplug an XBee module 12
Configure the device using XCTU 12
Configure remote devices 12
Configure the devices for a range test 13
Perform a range test 14
Modes
Serial modes 18
Transparent operating mode 18
API operating mode 18
Command mode 18
Enter Command mode 19
Send AT commands 19
Apply command changes 20
Exit Command mode 20
Operation
Software libraries 22
Addressing 22
Send packets to a specific device 22
Addressing modes 22
Maximum payload 23
Maximum payload rules 23
Working with Legacy devices 23
Networking 24
MAC Mode configuration 24
XBee retries configuration 25
Transmit status based on MAC mode and XBee retries configurations 25
XBee3® 802.15.4 RF Module User Guide 3

XBee3® 802.15.4 RF Module User Guide 4
Peer-to-peer networks 26
Clear Channel Assessment (CCA) 26
CCA operations 27
Serial interface 27
Serial receive buffer 27
Serial transmit buffer 27
UART data flow 28
Flow control 28
Sleep support 30
Sleep modes 30
Sleep parameters 30
Sleep current 30
Sleep pins 31
Node discovery 31
Remote configuration commands 31
Send a remote command 31
Apply changes on remote devices 32
Remote command responses 32
AT commands
Network commands 34
ID (Extended PAN ID) 34
C8 (802.15.4 Compatibility) 34
NI (Node Identifier) 36
NT (Node Discover Timeout) 36
ND (Network Discover) 36
NO (Node Discovery Options) 37
NP (Maximum Packet Payload Bytes) 37
Addressing commands 38
SH (Serial Number High) 38
SL (Serial Number Low) 38
MY (16-bit Source Address) 38
DH (Destination Address High) 38
DL (Destination Address Low) 39
RR (XBee Retries) 39
TO (Transmit Options) 39
MM (MAC Mode) 40
DD (Device Type Identifier) 40
RF interfacing commands 41
PL (TX Power Level) 41
PP (Output Power in dBm) 41
CH (Operating Channel) 41
CA (CCA Threshold) 42
RN (Random Delay Slots) 42
DB (Last Packet RSSI) 42
UART serial interfacing 43
BD (Interface Data Rate) 43
NB (Parity) 44
SB (Stop Bits) 44
AP(API Enable) 45
RO (Packetization Timeout) 45
FT command 45
D6 (DIO6/RTS) 46
D7 (DIO7/CTS) 46

XBee3® 802.15.4 RF Module User Guide 5
Command mode options 46
CN (Exit Command mode) 47
CT (Command Mode Timeout) 47
GT (Guard Times) 47
CC (Command Character) 47
Sleep settings 47
SM (Sleep Mode) 48
D8 (DIO8/DTR/SLP_RQ) 48
D9 (DIO9/ON_SLEEP) 48
I/O settings commands 49
D0 (DIO0 Configuration) 49
D1 (DIO1 Configuration) 49
D2 (DIO2 Configuration) 50
D3 (DIO3 Configuration) 50
D4 (DIO4 Configuration) 51
D5 (DIO5/Associate Configuration) 51
P0 (DIO10/PWM0 Configuration 52
P1 (DIO11 Configuration) 52
P5 (DIO15 Configuration) 53
PR (Pull-up/Down Resistor Enable) 53
PD (Pull Up/Down Direction) 54
LT command 54
Diagnostic commands 55
AI (Association Indication) 55
EA (ACK Failures) 55
EC (CCA Failures) 55
VR (Firmware Version) 56
VL (Version Long) 56
VH command 56
HV (Hardware Version) 56
%V command 56
TP command 57
CK (Configuration CRC) 57
FR (Software Reset) 57
Memory access commands 57
AC (Apply Changes) 57
WR (Write) 58
RE (Restore Defaults) 58
Operate in API mode
API mode overview 60
API frame specifications 60
API operation (AP parameter = 1) 60
API operation-with escaped characters (AP parameter = 2) 60
API frame format 61
Calculate and verify checksums 62
Frame descriptions 64
API frames 64
TX Request: 64-bit address frame - 0x00 64
TX Request: 16-bit address - 0x01 66
AT Command Frame - 0x08 67
AT Command - Queue Parameter Value frame - 0x09 69
Remote AT Command Request frame - 0x17 70
RX Packet: 64-bit Address frame - 0x80 71

XBee3® 802.15.4 RF Module User Guide 6
Receive Packet: 16-bit address frame - 0x81 72
AT Command Response frame - 0x88 73
TX Status frame - 0x89 75
Modem Status frame - 0x8A 77
Remote Command Response frame - 0x97 78

XBee3® 802.15.4 RF Module User Guide
XBee3 802.15.4 RF Modules are embedded solutions providing wireless end-point connectivity to
devices. These devices use the IEEE 802.15.4 networking protocol for fast point-to-multipoint or peer-
to-peer networking. They are designed for high-throughput applications requiring low latency and
predictable communication timing.
The XBee3 802.15.4 RF Module supports the needs of low-cost, low-power wireless sensor networks.
The devices require minimal power and provide reliable delivery of data between devices. The devices
operate within the ISM 2.4 GHz frequency band.
The XBee3 802.15.4 RF Module uses XBee3 hardware and the Silicon Labs EFR32 chipset. As the name
suggests, the 802.15.4 module is over-the-air compatible with our Legacy 802.15.4 modules (S1 and
S2C hardware).
For information about XBee3 hardware, see the XBee3 RF Module Hardware Reference Manual.
Applicable firmware and hardware 8
Change the firmware protocol 8
XBee3® 802.15.4 RF Module User Guide 7

XBee3® 802.15.4 RF Module User Guide Applicable firmware and hardware
XBee3® 802.15.4 RF Module User Guide 8
Applicable firmware and hardware
This manual supports the following firmware:
n802.15.4 version 20xx
It supports the following hardware:
nXBee3
Change the firmware protocol
You can switch the firmware loaded onto the XBee3 hardware to run either of the following protocols:
nZigbee
n802.15.4
To change protocols, use the Update firmware feature in XCTU and select the firmware. See the
XCTU User Guide.

Getting started
This section covers the following tasks and features:
Verify kit contents 10
Assemble the hardware 10
Configure the device using XCTU 12
Configure remote devices 12
Configure the devices for a range test 13
Perform a range test 14
XBee3® 802.15.4 RF Module User Guide 9

Getting started Verify kit contents
XBee3® 802.15.4 RF Module User Guide 10
Verify kit contents
The XBee3 802.15.4 RF Module development kit contains the following components:
Part
XBee3 Zigbee SMT module (3)
XBee Grove development board (3)
Micro USB cable (3)
Antenna - 2.4 GHz, half-wave dipole, 2.1 dBi, U.FL female, articulating
(3)
XBee stickers
Assemble the hardware
This guide walks you through the steps required to assemble and disassemble the hardware
components of your kit.
nPlug in the XBee3 802.15.4 RF Module
nHow to unplug an XBee module
The kit includes several XBee Grove Development Boards. For more information about this hardware,