Home
Digi
Control Unit
XBee
Digi XBee User Manual
5
of 1
of 1 rating
307 pages
Give review
Manual
Specs
To Next Page
To Next Page
To Previous Page
To Previous Page
Loading...
AT
com
m
and
s
Se
r
ial
int
erf
acing
c
om
mands
X
Bee
/
X
Bee
-PR
O®
S2C
Z
igBe
e®
RF
Modul
e
2
36
Param
eter
Descr
i
p
tion
0
x3
19
2
00
b/s
0
x4
38
4
00
b/s
0
x5
57
6
00
b/s
0
x6
11
5
20
0
b
/
s
(no
n-st
a
nd
ar
d
baud
r
at
e
s)
0
x8
23
0
40
0
b
/
s
0
x9
46
0
80
0
b
/
s
0
xA
9
2
1
60
0
b
/s
D
e
fau
l
t
0
x03
(9
6
00
b/s
)
N
B
(Par
ity)
Set
or
r
e
a
d
t
he
se
r
ial
par
i
t
y
s
e
t
t
i
ngs
for
U
ART
co
mmu
ni
ca
t
i
on
s
.
Param
eter
range
Param
eter
Desc
rip
tion
0
x00
N
o
p
ar
it
y
0
x01
Even
par
ity
0
x02
Odd
par
i
t
y
0
x03
Ma
r
k
p
a
r
i
t
y
D
e
fau
l
t
0
x00
S
B
(
Sto
p
Bi
ts)
Set
s
or
r
e
a
d
s
t
he
nu
mb
e
r
of
s
t
op
b
its
for
U
AR
T
commu
ni
ca
t
io
ns
.
Param
eter
range
0
x00
-
0
x01
Param
eter
Conf
i
guration
0
x00
O
ne
s
t
op
bi
t
0
x01
Tw
o
s
t
op
bi
t
s
D
e
fau
l
t
0
x00
235
237
Table of Contents
Default Chapter
4
Table of Contents
4
Note on Product Naming
14
Applicable Firmware and Hardware
14
Firmware Release Notes
14
Technical Specifications
16
Performance Specifications
16
Power Requirements
16
General Specifications
16
Networking and Security Specifications
17
Communication Interface Specifications
17
Regulatory Conformity Summary
18
Serial Communication Specifications
19
UART Pin Assignments
19
SPI Pin Assignments
19
GPIO Specifications
19
Hardware Specifications for the Programmable Variant
20
Hardware
22
Mechanical Drawings
23
Pin Signals for the Surface-Mount Module
24
Pin Signals for the Through-Hole Module
26
EM357 Pin Mappings
27
Design Notes
28
Power Supply Design
28
Board Layout
29
Antenna Performance
29
Recommended Pin Connections
30
Design Notes for PCB Antenna Devices
30
Design Notes for SMT RF Pad Devices
32
Module Operation for the Programmable Variant
35
Programmable Xbee SDK
36
Programmable Connections
37
Operation
40
Serial Interface
40
UART Data Flow
40
Serial Data
40
SPI Communications
41
SPI Operation
41
Serial Port Selection
42
Serial Buffers
42
Serial Receive Buffer
42
Serial Transmit Buffer
43
UART Flow Control
43
CTS Flow Control
43
RTS Flow Control
43
Break Control
44
Serial Interface Protocols
44
Transparent Operating Mode
44
API Operating Mode
44
Compare Transparent and API Operation
45
Modes of Operation
47
Idle Mode
48
Transmit Mode
48
Receive Mode
49
Command Mode
49
Sleep Mode
50
Zigbee Networks
52
About the Zigbee Specification
52
Zigbee Stack Layers
52
Zigbee Networking Concepts
53
Device Types
53
Pan ID
55
Operating Channels
56
Zigbee Application Layers: in Depth
56
Application Support Sublayer (APS)
56
Application Profiles
56
Zigbee Coordinator Operation
58
Form a Network
58
Security Policy
58
Channel Selection
58
PAN ID Selection
58
Persistent Data
58
Coordinator Startup
59
Permit Joining
60
Reset the Coordinator
60
Leave a Network
61
Replace a Coordinator (Security Disabled Only)
61
Example: Start a Coordinator
62
Example: Replace a Coordinator (Security Disabled)
62
Zigbee Router Operation
62
Discover Zigbee Networks
63
Join a Network
63
Persistent Data
63
Zigbee Router Joining
64
Permit Joining
65
Router Network Connectivity
65
End Device Operation
68
Discover Zigbee Networks
69
Join a Network
69
End Device Capacity
69
Persistent Data
70
Orphan Scans
70
End Device Joining
70
Parent Connectivity
71
Reset the End Device
71
Leave a Network
72
Example: Join a Network
72
Zigbee Channel Scanning
73
Manage Multiple Zigbee Networks
73
Filter PAN ID
73
Configure Security Keys
73
Prevent Unwanted Devices from Joining
73
Application Messaging Framework
74
Transmission, Addressing, and Routing
76
Addressing
76
64-Bit Device Addresses
76
Application Layer Addressing
76
Data Transmission
76
Broadcast Transmissions
76
Unicast Transmissions
77
Address Resolution
78
Address Table
78
Group Table
79
Binding Transmissions
79
Address Resolution
79
Binding Table
80
Multicast Transmissions
80
Address Resolution
80
Fragmentation
80
Data Transmission Examples
80
AT Firmware
81
API Firmware
81
API Frame
82
RF Packet Routing
83
Link Status Transmission
83
AODV Mesh Routing
84
Many-To-One Routing
87
High/Low RAM Concentrator Mode
87
Source Routing
87
Encrypted Transmissions
92
Maximum RF Payload Size
92
Throughput
94
ZDO Transmissions
95
Zdo
95
Sending a ZDO Command
95
Receiving ZDO Command and Responses
95
Transmission Timeouts
97
Unicast Timeout
98
Extended Timeout
98
Transmission Examples
99
Zigbee Security
101
Security Modes
102
Zigbee Security Model
102
Network Layer Security
102
APS Layer Security
103
Trust Center
105
Forming or Joining a Secure Network
105
Implementing Security on the Xbee/Xbee-PRO Zigbee RF Module
105
Enabling Security
106
Setting the Network Security Key
106
Set the APS Trust Center Link Key
106
Enable APS Encryption
106
Use a Trust Center
107
Security Examples
107
Network Commissioning and Diagnostics
109
Place Devices
109
Test Links in a Network - Loopback Cluster
109
RSSI Indicators
110
Device Discovery
110
Network Discovery
110
ZDO Discovery
110
Joining Announce
111
Commissioning Pushbutton and Associate LED
111
Commissioning Pushbutton
111
Associate LED
112
Binding
113
End_Device_Bind_Req
113
Example of a End_Device_Bind_Req
116
Group Table API
116
Add Group Command
116
View Group
118
Get Group Membership
119
Remove Group
121
Remove All Groups
123
Default Responses
124
Common Status Codes
125
Manage End Devices
126
End Device Operation
127
Parent Operation
127
End Device Poll Timeouts
128
Packet Buffer Usage
128
Non-Parent Device Operation
129
End Device Configuration
129
Pin Sleep
130
Cyclic Sleep
131
Recommended Sleep Current Measurements
136
Achieve the Lowest Sleep Current
136
Compensate for Switching Time
136
Internal Pin Pull-Ups
137
Transmitting RF Data
137
Receiving RF Data
137
I/O Sampling
138
Waking End Devices with the Commissioning Pushbutton
138
Parent Verification
138
Rejoining
138
Router/Coordinator Configuration
139
RF Packet Buffering Timeout
139
Child Poll Timeout
139
Transmission Timeout
140
Putting It All Together
141
Short Sleep Periods
141
Extended Sleep Periods
141
Sleep Examples
141
Analog and Digital I/O Lines
143
Configurable I/O Pins and Configuration Commands
144
Xbee ZB Through-Hole RF Module
144
I/O Configuration
145
I/O Sampling
146
Queried Sampling
147
Periodic I/O Sampling
148
Change Detection Sampling
148
Rssi Pwm
148
I/O Examples
149
Pwm1
149
API Operation
150
API Frame Format
151
API Operation (AP Parameter = 1)
151
API Operation-With Escaped Characters (AP Parameter = 2)
151
Data Bytes that Need to be Escaped
152
Length
152
Frame Data
152
Calculate and Verify Checksums
153
API Examples
154
API Serial Exchanges
155
AT Commands
155
Transmit and Receive RF Data
156
Remote at Commands
156
Source Routing
157
Frame Descriptions
158
AT Command Frame - 0X08
158
AT Command - Queue Parameter Value Frame - 0X09
160
Transmit Request Frame - 0X10
162
Explicit Addressing Command Frame - 0X11
166
Remote at Command Request Frame - 0X17
169
Create Source Route - 0X21
171
AT Command Response Frame - 0X88
174
Modem Status Frame - 0X8A
176
Transmit Status Frame - 0X8B
177
Receive Packet Frame - 0X90
179
Explicit Rx Indicator Frame - 0X91
181
Data Sample Rx Indicator Frame - 0X92
183
Xbee Sensor Read Indicator - 0X94
186
Node Identification Indicator Frame - 0X95
189
Remote Command Response Frame - 0X97
192
Extended Modem Status Frame - 0X98
194
Over-The-Air Firmware Update Status - 0Xa0
201
Route Record Indicator - 0Xa1
203
Many-To-One Route Request Indicator - 0Xa3
205
Send ZDO Commands with the API
206
Example
208
Send Zigbee Cluster Library (ZCL) Commands with the API
209
Example
212
Send Public Profile Commands with the API
214
Frame Specific Data
214
Example
217
AT Commands
220
Addressing Commands
221
DH (Destination Address High)
221
DL (Destination Address Low)
221
MY (16-Bit Network Address)
221
MP (16-Bit Parent Network Address)
221
NC (Number of Remaining Children)
222
SH (Serial Number High)
222
SL (Serial Number Low)
222
NI (Node Identifier)
222
SE (Source Endpoint)
223
DE (Destination Endpoint)
223
CI (Cluster ID)
223
TO (Transmit Options)
223
NP (Maximum Packet Payload Bytes)
224
DD (Device Type Identifier)
224
CR (Conflict Report)
224
Network Commands
225
CH (Operating Channel)
225
CE (Coordinator Enable)
225
ID (Extended PAN ID)
225
OP (Operating Extended PAN ID)
226
NH (Maximum Unicast Hops)
226
BH (Broadcast Hops)
226
OI (Operating 16-Bit PAN ID)
226
NT (Node Discover Timeout)
226
NO (Network Discovery Options)
227
SC (Scan Channels)
227
SD (Scan Duration)
228
ZS (Zigbee Stack Profile)
229
NJ (Node Join Time)
230
JV (Channel Verification)
230
NW (Network Watchdog Timeout)
230
JN (Join Notification)
230
AR (Aggregate Routing Notification)
231
Security Commands
231
EE (Encryption Enable)
231
EO (Encryption Options)
231
NK (Network Encryption Key)
232
KY (Link Key)
232
RF Interfacing Commands
232
PL (TX Power Level)
232
PM (Power Mode)
233
DB (Received Signal Strength)
233
PP (Peak Power)
234
Serial Interfacing Commands
234
API Enable
234
AO (API Options)
234
BD (Interface Data Rate)
235
NB (Parity)
236
SB (Stop Bits)
236
RO (Packetization Timeout)
237
D6 (Dio6/Rts)
237
I/O Settings Commands
238
IR (I/O Sample Rate)
238
IC (Digital Change Detection)
238
P0 (RSSI/PWM0 Configuration)
239
P1 (DIO11/PWM1 Configuration)
239
P2 (DIO12 Configuration)
240
P3 (DIO13/DOUT Configuration)
240
P4 (Dio14/Din)
241
P5 (Dio15/Spi_Miso)
241
P6 (SPI_MOSI Configuration)
241
D0 (AD0/DIO0 Configuration)
243
D1 (Ad1/Dio1/Pti_En Configuration)
243
D2 (AD2/DIO2 Configuration)
244
D3 (AD3/DIO3 Configuration)
244
D4 (DIO4 Configuration)
245
D5 (Dio5/Associate Configuration)
245
D8 (Dio8/Dtr/Slp_Rq)
246
D9 (Dio9/On_Sleep)
246
LT (Associate LED Blink Time)
246
PR (Pull-Up/Down Resistor Enable)
247
PD (Pull Up/Down Direction)
248
RP (RSSI PWM Timer)
248
DC (Device Controls)
248
DO (Device Options)
249
Voltage Supply Monitoring)
249
TP (Temperature)
250
Diagnostic Commands
250
VR (Firmware Version)
250
VL (Version Long)
250
HV (Hardware Version)
250
AI (Association Indication)
251
Command Mode Options
251
CT (Command Mode Timeout)
252
CN (Exit Command Mode)
252
GT (Guard Times)
252
CC (Command Character)
252
Sleep Commands
252
SM (Sleep Mode)
253
SN (Number of Cycles between ON_SLEEP )
253
SP (Sleep Period)
253
ST (Time before Sleep)
254
SO (Sleep Options)
254
WH (Wake Host Delay)
254
PO (Polling Rate)
254
Execution Commands
255
AC (Apply Changes)
255
AS (Active Scan)
255
WR (Write)
255
RE (Restore Defaults)
256
FR (Software Reset)
256
NR (Network Reset)
256
SI (Sleep Immediately)
257
CB (Commissioning Pushbutton)
257
Clear Binding and Group Tables)
257
ND (Node Discovery)
257
DN (Destination Node)
258
IS (Force Sample)
258
Module Support
260
XCTU Configuration Tool
261
Customizing Xbee Zigbee Firmware
261
Xbee Bootloader
261
Programming Xbee Modules
261
Serial Firmware Updates
261
Invoke the Xbee Bootloader
262
Send a Firmware Image
262
Writing Custom Firmware
262
Regulatory Compliance
262
Enable GPIO 1 and 2
263
Detect Xbee Versus Xbee-PRO
263
Special Instructions for Using the JTAG Interface
264
Regulatory Information
265
United States (FCC)
266
OEM Labeling Requirements
266
FCC Notices
267
FCC-Approved Antennas (2.4 Ghz)
268
Associated Antenna Descriptions
284
RF Exposure
284
Europe (CE)
284
Maximum Power and Frequency Specifications
284
OEM Labeling Requirements
285
Declarations of Conformity
285
Antennas
285
IC (Industry Canada)
286
Labeling Requirements
286
For Xbee ZB Surface-Mount
286
For Xbee-PRO ZB Surface-Mount
286
For Xbee ZB Through-Hole
286
For Xbee-PRO ZB Through-Hole
286
Transmitters for Detachable Antennas
286
Detachable Antenna
287
For Xbee S2D SMT
287
RF Exposure
287
Australia (RCM)
288
ANATEL (Brazil)
288
South Korea
291
Migrating from Xbee Through-Hole to Xbee Surface-Mount Devices
295
Pin Mapping
296
Mounting
297
Manufacturing Information
299
Recommended Solder Reflow Cycle
300
Recommended Footprint
300
Flux and Cleaning
302
Reworking
302
Load Zigbee Firmware on 802.15.4 Devices
303
Background
304
Load ZB Firmware
305
Definitions
306
Zigbee Node Types
306
Zigbee Protocol
307
Other manuals for Digi XBee
Manual
121 pages
Getting Started Guide
25 pages
Product Manual
105 pages
User Manual
96 pages
5
Based on 1 rating
Ask a question
Give review
Questions and Answers:
Need help?
Do you have a question about the Digi XBee and is the answer not in the manual?
Ask a question
Digi XBee Specifications
General
Brand
Digi
Model
XBee
Category
Control Unit
Language
English
Related product manuals
Digi XBEE2
195 pages
Digi XBee SX
206 pages
Digi XBee SX 868
212 pages
Digi XBee-PRO S3
269 pages
Digi XBEE-PRO S3B
269 pages
Digi XBee-PRO XSC
269 pages
Digi XBee 3 ZigBee
347 pages
Digi XBee3 802.15.4
185 pages
Digi XBee 3
293 pages
Digi ConnectCore Series
151 pages
Digi ConnectCore
151 pages
Digi XBee3 XB3M1
252 pages
To Next PageTo Next PageTo Previous PageTo Previous Page
Loading...
Need help?
General
