Home
Digi
Control Unit
XBee 3 ZigBee
Digi XBee 3 ZigBee User Manual
4
of 1
of 1 rating
347 pages
Give review
Manual
Specs
To Next Page
To Next Page
To Previous Page
To Previous Page
Loading...
O
TA
file
s
yst
e
m
upg
r
ade
s
OTA
f
ile
s
yst
e
m
upd
at
es
us
ing
X
CTU
Digi
X
B
e
e®
3
Zigb
e
e®
R
F
M
odule
3
4
3
Per
fo
rm
the
OTA
f
il
e
system
u
p
da
te
1
.
To
add
t
he
t
a
r
g
e
t
d
e
vice,
cli
ck
D
i
sco
ver
radi
os
i
n
th
e
sam
e
n
etwo
rk
fr
om
t
he
sou
r
ce
d
e
vice.
2
.
Ente
r
C
on
f
igurat
io
n
mod
e
o
n
t
he
r
e
mot
e
d
e
vice.
3
.
C
l
ick
t
he
d
ow
n
a
r
r
ow
ne
xt
t
o
t
he
U
p
date
bu
t
t
on
a
nd
ch
oose
Up
d
ate
Fi
le
S
ystem
.
4
.
C
ho
ose
t
he
O
TA
fil
e
sys
t
e
m
image
(.fs.ota
)
t
hat
t
he
t
ar
g
e
t
no
d
e
n
e
e
ds
t
o
be
up
d
at
e
d
t
o.
5
.
C
l
ick
Op
en
.
342
344
Table of Contents
Default Chapter
4
Table of Contents
4
Digi Xbee® 3 Zigbee® RF Module
15
Applicable Firmware and Hardware
16
Change the Firmware Protocol
16
Regulatory Information
16
Get Started
17
Configure the Xbee 3 Zigbee RF Module
19
Configure the Device Using XCTU
19
Custom Defaults
19
Set Custom Defaults
19
Restore Factory Defaults
19
Limitations
19
Custom Configuration: Create a New Factory Default
19
Set a Custom Configuration
20
Clear All Custom Configuration on a Device
20
Xbee Bootloader
20
Send a Firmware Image
21
Software Libraries
21
Xbee Network Assistant
21
Xbee Multi Programmer
22
Update the Firmware Over-The-Air
23
Add the Device to XCTU
24
Update to the Latest Firmware
24
Get Started with Micropython
26
About Micropython
26
Micropython on the Xbee 3 Zigbee RF Module
26
Use XCTU to Enter the Micropython Environment
26
Use the Micropython Terminal in XCTU
27
Micropython Examples
27
Example: Hello World
27
Example: Enter Micropython Paste Mode
27
Example: Use the Time Module
28
Example: at Commands Using Micropython
28
Micropython Networking and Communication Examples
29
Zigbee Networks with Micropython
29
Example: Forming and Joining a Zigbee Network Using Micropython
30
Example: Network Discovery Using Micropython
31
Examples: Transmitting Data
32
Receiving Data
33
Example: Communication between Two Xbee 3 Zigbee Modules
34
Exit Micropython Mode
37
Other Terminal Programs
37
Tera Term for Windows
37
Use Picocom in Linux
38
Micropython Help ()
39
Secure Access
42
Secure Sessions
42
Configure the Secure Session Password for a Device
42
Start a Secure Session
42
End a Secure Session
43
Secured Remote at Commands
43
Secure a Node against Unauthorized Remote Configuration
43
Remotely Configure a Node that Has Been Secured
44
Send Data to a Secured Remote Node
45
End a Session from a Server
45
Secure Session API Frames
46
Secure Transmission Failures
47
Data Frames - 0X10 and 0X11 Frames
47
Remote at Commands- 0X17 Frames
47
File System
48
Overview of the File System
49
Directory Structure
49
Paths
49
Limitations
49
XCTU Interface
50
Get Started with BLE
51
Enable BLE on the Xbee 3 Zigbee RF Module
52
Enable BLE and Configure the BLE Password
52
Get the Digi Xbee Mobile Phone Application
53
Connect with BLE and Configure Your Xbee 3 Device
54
BLE Reference
55
BLE Advertising Behavior and Services
56
Device Information Service
56
Xbee API BLE Service
56
API Request Characteristic
56
API Response Characteristic
57
Serial Communication
59
Serial Interface
59
UART Data Flow
59
Serial Data
59
Serial Buffers
60
Serial Receive Buffer
60
Serial Transmit Buffer
61
UART Flow Control
61
CTS Flow Control
61
RTS Flow Control
61
Break Control
61
I2C
61
SPI Operation
62
SPI Communications
63
Full Duplex Operation
64
Low Power Operation
64
Select the SPI Port
65
Force UART Operation
66
Modes
67
Transparent Operating Mode
68
Serial-To-RF Packetization
68
API Operating Mode
68
Command Mode
68
Enter Command Mode
69
Troubleshooting
69
Send at Commands
69
Response to at Commands
70
Apply Command Changes
70
Make Command Changes Permanent
70
Exit Command Mode
70
Idle Mode
71
Transmit Mode
71
Receive Mode
72
Sleep Mode
72
Zigbee Networks
74
The Zigbee Specification
74
Zigbee Stack Layers
74
Zigbee Networking Concepts
75
Device Types
75
Pan ID
77
Operating Channels
77
Zigbee Application Layers: in Depth
78
Application Support Sublayer (APS)
78
Application Profiles
78
Zigbee Coordinator Operation
80
Form a Network
80
Security Policy
80
Channel Selection
80
PAN ID Selection
80
Persistent Data
80
Coordinator Startup
81
Permit Joining
82
Reset the Coordinator
82
Leave a Network
83
Replace a Coordinator (Security Disabled Only)
83
Example: Start a Coordinator
84
Example: Replace a Coordinator (Security Disabled)
84
Router Operation
85
Discover Zigbee Networks
85
Join a Network
85
Authentication
85
Persistent Data
85
Router Joining
86
Router Network Connectivity
87
End Device Operation
89
Discover Zigbee Networks
89
Join a Network
90
Parent Child Relationship
90
End Device Capacity
90
Authentication
90
Persistent Data
91
Orphan Scans
91
End Device Joining
91
Parent Connectivity
92
Reset the End Device
92
Channel Scanning
92
Manage Multiple Zigbee Networks
93
Filter PAN ID
93
Configure Security Keys
93
Prevent Unwanted Devices from Joining
93
Application Messaging Framework
94
Transmission, Addressing, and Routing
96
Addressing
96
64-Bit Device Addresses
96
Application Layer Addressing
96
Data Transmission
96
Broadcast Transmissions
97
Unicast Transmissions
97
Address Resolution
97
Address Table
98
Group Table
99
Binding Transmissions
99
Multicast Transmissions
99
Address Resolution
99
Binding Table
100
Fragmentation
100
Data Transmission Examples
100
Send a Packet in Transparent Mode
100
Send Data in API Mode
101
API Frame Examples
102
RF Packet Routing
102
Link Status Transmission
103
AODV Mesh Routing
104
Many-To-One Routing
107
High/Low RAM Concentrator Mode
107
Source Routing
107
Encrypted Transmissions
112
Maximum RF Payload Size
112
Throughput
114
ZDO Transmissions
114
Send a ZDO Command
115
Receiving ZDO Command and Responses
115
Transmission Timeouts
118
Unicast Timeout
119
Extended Timeout
119
Transmission Examples
120
Zigbee Security
123
Security Overview
123
Network Key
123
Link Key
123
Preconfigured Link Key - Moderate Security
123
Well-Known Default Link Key - Low Security
124
Install Code Derived Link Key - High Security
124
Join Window
124
Key Management
125
Centralized Security
125
Distributed Security
125
Device Registration
125
Centralized Trust Center
126
Distributed Trust Center
126
Example: Form a Secure Network
126
Example: Join a Secure Network Using a Preconfigured Link Key
127
Example: Register a Joining Node Without a Preconfigured Link Key
128
Example: Register a Joining Node Using an Install Code
129
Example: Deregister a Previously Registered Device
129
Registration Scenario
130
Network Commissioning and Diagnostics
132
Place Devices
132
Test Links in a Network - Loopback Cluster
132
Transparent Operating Mode Configuration (AP = 0)
132
RSSI Indicators
132
Device Discovery
133
Network Discovery
133
ZDO Discovery
133
Joining Announce
133
Commissioning Pushbutton and Associate LED
133
Xbee 3 SMT
134
Xbee 3 Micro
134
Xbee 3 Through-Hole
135
Commissioning Pushbutton
135
Associate LED
136
Binding
137
End_Device_Bind_Req
139
Example of a End_Device_Bind_Req
139
Group Table API
140
Add Group Command
140
View Group
141
Get Group Membership (1 of 2)
142
Get Group Membership (2 of 2)
144
Remove Group
145
Remove All Groups
146
Default Responses
147
Common Status Codes
147
Manage End Devices
150
End Device Operation
150
Parent Operation
150
End Device Poll Timeouts
151
End Device Child Table
151
Packet Buffer Usage
151
Non-Parent Device Operation
152
End Device Configuration
152
Pin Sleep
153
Cyclic Sleep
155
Recommended Sleep Current Measurements
161
Achieve the Lowest Sleep Current
161
Compensate for Switching Time
161
Internal Pin Pull-Ups
161
Transmit RF Data
162
Receiving RF Data
162
I/O Sampling
162
Wake End Devices with the Commissioning Pushbutton
162
Parent Verification
162
Rejoining
163
Router/Coordinator Configuration
163
RF Packet Buffering Timeout
163
Child Poll Timeout
164
Adaptive Polling
164
Transmission Timeout
164
Short Sleep Periods
164
Extended Sleep Periods
164
Sleep Examples
165
Example 2: Configure an End Device to Sleep for 20 Seconds, Send 4 I/O Samples in
165
Seconds, and Return to Sleep
165
Example 3: Configure a Device for Extended Sleep: to Sleep for 4 Minutes
166
I/O Support
167
Digital I/O Support
168
Analog I/O Support
168
Monitor I/O Lines
169
I/O Sample Data Format
170
API Frame Support
171
On-Demand Sampling
171
Example: Command Mode
171
Example: Local at Command in API Mode
172
Example: Remote at Command in API Mode
173
Periodic I/O Sampling
174
Source
174
Destination
174
Digital I/O Change Detection
174
I/O Behavior During Sleep
175
Digital I/O Lines
175
Analog and PWM I/O Lines
175
AT Commands
176
Networking Commands
177
CE (Device Role)
177
ID (Extended PAN ID)
177
Initial 16-Bit PAN ID)
177
ZS (Zigbee Stack Profile)
178
CR (Conflict Report)
178
NJ (Node Join Time)
178
DJ (Disable Joining)
179
NW (Network Watchdog Timeout)
180
JV (Coordinator Join Verification)
180
JN (Join Notification)
180
DO (Miscellaneous Device Options)
181
DC (Joining Device Controls)
181
C8 (Compatibility Options)
182
CB (Commissioning Pushbutton)
183
NR (Network Reset)
183
Operational Network Parameters Commands
183
AI (Association Indication)
184
OP (Operating Extended PAN ID)
184
OI (Operating 16-Bit PAN ID)
185
Operating Channel)
185
NC (Number of Remaining Children)
185
Security Commands
185
EE (Encryption Enable)
185
EO (Encryption Options)
186
DM (Disable Features)
186
KY (Link Key)
187
NK (Trust Center Network Key)
187
KT (Trust Center Link Key Registration Timeout)
188
I? (Install Code)
188
SA (Secure Access)
188
Zigbee Addressing Commands
189
SH (Serial Number High)
189
Serial Number Low)
189
MY (16-Bit Network Address)
189
MP (16-Bit Parent Network Address)
190
DH (Destination Address High)
190
DL (Destination Address Low)
190
NI (Node Identifier)
191
NH (Maximum Unicast Hops)
191
BH (Broadcast Hops)
191
AR (Aggregate Routing Notification)
191
DD (Device Type Identifier)
192
ND (Network Discovery)
192
DN (Discover Node)
193
NT (Node Discover Timeout)
193
Network Discovery Options)
194
NP (Maximum Packet Payload Bytes)
194
Zigbee Addressing Commands
194
TO (Transmit Options)
194
SE (Source Endpoint)
195
Destination Endpoint)
195
CI (Cluster ID)
196
RF Interfacing Commands
196
TX Power Level)
196
PP (Power at PL4)
197
SC (Scan Channels)
197
SD (Scan Duration)
198
AS (Active Scan)
198
ED (Energy Detect)
199
DB Command
199
Serial Interfacing Commands
199
BD (UART Baud Rate)
199
NB (Parity)
200
SB (Stop Bits)
200
AP (API Enable)
201
AO (API Options)
201
AZ (Extended API Options)
202
Packetization Timeout)
203
D6 (Dio6/Rts)
203
D7 (Dio7/Cts)
203
P3 (DIO13/DOUT Configuration)
204
P4 (DIO14/DIN Configuration)
204
Command Mode Options
205
CN (Exit Command Mode)
205
CT (Command Mode Timeout)
205
GT (Guard Times)
205
CC (Command Character)
205
Micropython Commands
206
PS (Python Startup)
206
PY (Micropython Command)
206
File System Commands
207
FS (File System)
207
FK (File System Public Key)
209
BLE Commands
209
BL (Bluetooth Address)
209
BT (Bluetooth Enable)
210
BI (Bluetooth Identifier)
210
S (SRP Salt)
210
V, $W, $X, $Y Commands (SRP Salt Verifier)
211
Sleep Commands
211
SM (Sleep Mode)
211
SP (Cyclic Sleep Period)
212
ST (Cyclic Sleep Wake Time)
212
SN (Number of Cycles between ON_SLEEP)
212
SO (Sleep Options)
212
WH (Wake Host Delay)
213
PO (Polling Rate)
213
End Device Timeout)
213
Sleep Immediately)
214
I/O Settings Commands
214
D0 (Dio0/Ad0/Commissioning Button Configuration)
214
D1 (AD1/DIO1/TH_SPI_ATTN Configuration)
215
D2 (DIO2/AD2/TH_SPI_CLK Configuration)
215
D3 (DIO3/AD3/TH_SPI_SSEL Configuration)
216
D4 (DIO4/TH_SPI_MOSI Configuration)
216
D5 (Dio5/Associate Configuration)
217
D8 (Dio8/Dtr/Slp_Rq)
217
D9 (Dio9/On_Sleep)
218
P0 (DIO10/RSSI Configuration)
218
P1 (DIO11 Configuration)
219
P2 (DIO12/TH_SPI_MISO Configuration)
219
P5 (DIO15/SPI_MISO Configuration)
219
P6 (DIO16/SPI_MOSI Configuration)
220
P7 (DIO17/SPI_SSEL Configuration)
220
P8 (DIO18/SPI_CLK Configuration)
221
P9 (DIO19/SPI_ATTN Configuration)
221
PR (Pull-Up/Down Resistor Enable)
222
PD (Pull Up/Down Direction)
223
M0 (PWM0 Duty Cycle)
223
M1 (PWM1 Duty Cycle)
223
Associate LED Blink Time)
224
RP (RSSI PWM Timer)
224
I/O Sampling Commands
224
IR (I/O Sample Rate)
224
IC (Digital Change Detection)
225
AV (Analog Voltage Reference)
225
IS (Force Sample)
226
Supply Voltage Threshold)
226
Location Commands
226
LX (Location X)
227
LY (Location Y)
227
LZ (Location Z)
227
Diagnostic Commands
227
VR (Firmware Version)
227
VL (Version Long)
227
VH (Bootloader Version)
228
HV (Hardware Version)
228
C (Hardware/Software Compatibility)
228
P (Invoke Bootloader)
228
Voltage Supply Monitoring)
229
EA (MAC ACK Failure Count)
229
TP (Temperature)
229
CK (Configuration Checksum)
229
Software Reset)
230
Memory Access Commands
230
AC (Apply Changes)
230
WR (Write)
230
RE (Restore Defaults)
231
Custom Default Commands
231
F (Set Custom Default)
231
C (Clear Custom Defaults)
231
R1 (Restore Factory Defaults)
231
Secure Session Commands
232
S (Secure Session Salt)
232
V, *W, *X, *Y (Secure Session Verifier)
232
SA (Secure Access)
232
API Operation
234
API Serial Exchanges
235
AT Commands
235
Transmit and Receive RF Data
236
Remote at Commands
236
Source Routing
236
Device Registration
237
API Frame Format
237
API Operation (AP Parameter = 1)
237
API Operation with Escaped Characters (AP Parameter = 2)
237
Send ZDO Commands with the API
240
Example
242
Send Zigbee Cluster Library (ZCL) Commands with the API
243
Example
246
Send Public Profile Commands with the API
248
Frame Specific Data
248
Example
251
Framedescriptions
255
AT Command Frame - 0X08
255
AT Command - Queue Parameter Value Frame - 0X09
257
Transmit Request Frame - 0X10
259
Explicit Addressing Command Frame - 0X11
262
Remote at Command Request Frame - 0X17
265
Create Source Route - 0X21
268
Register Joining Device - 0X24
270
BLE Unlock API Frame - 0X2C
274
Example Sequence to Perform at Command Xbee API Frames over BLE
276
User Data Relay Frame - 0X2D
277
Example Use Cases
278
Example
278
Secure Session Control Frame - 0X2E
279
AT Command Response Frame - 0X88
283
Modem Status Frame - 0X8A
285
Transmit Status Frame - 0X8B
287
TX Status Frame - 0X89
288
Receive Packet Frame - 0X90
290
Explicit Rx Indicator Frame - 0X91
292
I/O Data Sample Rx Indicator Frame - 0X92
295
Node Identification Indicator Frame - 0X95
298
Remote Command Response Frame - 0X97
301
Extended Modem Status Frame - 0X98
303
Verbose Join Status Code Descriptions
306
Route Record Indicator - 0Xa1
312
Register Device Status - 0Xa4
313
Many-To-One Route Request Indicator - 0Xa3
315
BLE Unlock Response Frame - 0Xac
316
User Data Relay Output - 0Xad
316
Example
317
Secure Session Response Frame - 0Xae
317
Over-The-Air Firmware/File System Upgrade Process for Zigbee 3.0
320
FOTA Upgrade Image File Formats
320
OTA/OTB File
320
Fs.ota File
320
The OTA Header
320
Hardware/Software Compatibility
320
Sub-Elements and Tags
320
Parse the Image Blocks
321
Storage
321
ZCL OTA Messaging
321
Image Notify
322
Create the Image Notify Request
322
Query Next Image Request
324
Query Next Image Response
326
Image Block Request
328
Image Block Response
330
Upgrade End Request
333
Upgrade End Response
334
ZCL OTA Cluster Status Codes
337
OTA File System Upgrades
339
OTA File System Update Process
340
OTA File System Updates Using XCTU
340
Generate a Public/Private Key Pair
340
Set the Public Key on the Xbee 3 Device
341
Create the OTA File System Image
342
Perform the OTA File System Update
343
OTA File System Updates: OEM
344
Generate a Public/Private Key Pair
345
Set the Public Key on the Xbee 3 Device
345
Create the OTA File System Image
345
Perform the OTA File System Update
346
4
Based on 1 rating
Ask a question
Give review
Questions and Answers:
Need help?
Do you have a question about the Digi XBee 3 ZigBee and is the answer not in the manual?
Ask a question
Digi XBee 3 ZigBee Specifications
General
Brand
Digi
Model
XBee 3 ZigBee
Category
Control Unit
Language
English
Related product manuals
Digi XBee
307 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 XBEE2
195 pages
Digi XBee3 802.15.4
185 pages
Digi ConnectCore Series
151 pages
Digi ConnectCore
151 pages
To Next PageTo Next PageTo Previous PageTo Previous Page
Loading...
Need help?
General
