Home
Digi
Control Unit
XBee3 802.15.4
Digi XBee3 802.15.4 User Manual
4
of 1
of 1 rating
185 pages
Give review
Manual
Specs
To Previous Page
To Previous Page
Loading...
O
TA
f
irm
wa
r
e
upgr
ad
e
pr
oc
e
ss
for
8
02
.1
5
.4
O
TA
err
or
handl
ing
Digi
X
B
e
e3
®
80
2.
15
.4
R
F
Modul
e
U
se
r
G
uide
1
8
5
ar
e
:
ZCL
O
TA
Co
m
ma
n
d
S
tatu
s
Er
ro
r
Message
0
x0
6
U
p
g
r
ade
End
Re
qu
e
s
t
0
x9
4
Cli
e
nt
Timed
O
ut
0
x9
6
I
nv
a
li
d
O
TA
I
mag
e
0
x9
5
Cli
e
nt
Ab
ort
ed
Upgr
ade
0
x0
5
Stor
ag
e
Er
as
e
F
a
il
e
d
0
x8
7
Conta
ct
Tech
Su
pp
ort
(H
ighl
y
u
nl
ik
e
l
y
t
o
occu
r
)
184
Table of Contents
Default Chapter
4
Table of Contents
4
Digi Xbee3® 802.15.4 RF Module User Guide
11
Applicable Firmware and Hardware
12
Change the Firmware Protocol
12
Regulatory Information
12
Get Started
14
Verify Kit Contents
14
Assemble the Hardware
14
Plug in the Xbee3 802.15.4 RF Module
15
Unplug an Xbee3 802.15.4 RF Module
16
Configure the Device Using XCTU
16
Configure Remote Devices
16
Configure the Devices for a Range Test
18
Perform a Range Test
18
Configure the Xbee3 802.15.4 RF Module
24
Software Libraries
25
Over-The-Air (OTA) Firmware Update
25
Custom Defaults
25
Set Custom Defaults
25
Restore Factory Defaults
25
Limitations
25
Xbee Network Assistant
26
Modes
27
Transparent Operating Mode
28
Serial-To-RF Packetization
28
API Operating Mode
28
Command Mode
28
Enter Command Mode
29
Troubleshooting
29
Send at Commands
29
Response to at Commands
30
Apply Command Changes
30
Make Command Changes Permanent
30
Exit Command Mode
30
Idle Mode
31
Transmit Mode
31
Receive Mode
31
Serial Communication
32
Serial Interface
33
Serial Receive Buffer
33
Serial Transmit Buffer
33
UART Data Flow
33
Serial Data
33
Flow Control
34
Clear-To-Send (CTS) Flow Control
34
RTS Flow Control
35
SPI Operation
36
SPI Communications
37
Full Duplex Operation
38
Low Power Operation
38
Select the SPI Port
39
Force UART Operation
39
I/O Support
41
Legacy Support
42
Mixed Network Considerations
43
Digital I/O Support
43
Analog I/O Support
44
Monitor I/O Lines
45
I/O Sample Data Format
45
Legacy Data Format
45
Enhanced Data Format
47
API Frame Support
47
On-Demand Sampling
48
Example: Command Mode
48
Example: Local at Command in API Mode
49
Example: Remote at Command in API Mode
50
Periodic I/O Sampling
51
Source
51
Destination
51
Multiple Samples Per Packet
51
Example: Remote at Command in API Mode
52
Digital I/O Change Detection
53
I/O Line Passing
54
Digital Line Passing
54
Example: Digital Line Passing
54
Analog Line Passing
55
Example: Analog Line Passing
55
Output Sample Data
56
Output Control
56
I/O Behavior During Sleep
56
Digital I/O Lines
56
Analog and PWM I/O Lines
56
Networking
57
Networking Terms
58
MAC Mode Configuration
58
Clear Channel Assessment (CCA)
59
CCA Operations
59
Retries Configuration
59
Transmit Status Based on MAC Mode and Xbee Retries Configurations
60
Addressing
61
Send Packets to a Specific Device in Transparent API Mode
61
Addressing Modes
61
Peer-To-Peer Networks
62
Master/Slave Networks
62
End Device Association
62
Coordinator Association
63
Association Indicators
64
Modem Status Messages
64
Association Indicator Status Codes
65
Direct and Indirect Transmission
65
Configure an Indirect Messaging Coordinator
66
Send Indirect Messages
66
Receive Indirect Messages
66
Encryption
67
Maximum Payload
68
Maximum Payload Rules
68
Maximum Payload Summary Tables
69
Working with Legacy Devices
69
Network Commissioning and Diagnostics
71
Remote Configuration Commands
72
Send a Remote Command
72
Apply Changes on Remote Devices
72
Remote Command Responses
72
Node Discovery
72
About Node Discovery
73
Node Discovery in Compatibility Mode
73
Directed Node Discovery
73
Directed Node Discovery in Compatibility Mode
73
Destination Node
74
Sleep Support
75
Sleep Modes
76
Pin Sleep Mode (SM = 1)
76
Cyclic Sleep Mode (SM = 4)
76
Cyclic Sleep with Pin Wake-Up Mode (SM = 5)
77
Sleep Parameters
77
Sleep Current
77
Sleep Pins
77
Sleep Conditions
78
Atcommands
80
Network and Security Commands
80
CH Command
80
ID Command
80
C8 Command
80
NI Command
82
ND Command
82
DN Command
83
NT Command
83
NO Command
84
MM (MAC Mode)
84
NP Command
85
Coordinator/End Device Configuration Commands
85
CE Command
85
A1 (End Device Association)
85
A2 (Coordinator Association)
86
SC Command
87
Force Disassociation)
88
AI Command
88
802.15.4 Addressing Commands
88
SH Command
88
SL Command
89
MY Command
89
DH Command
89
DL Command
90
RR Command
90
TO Command
90
Security Commands
91
EE Command
91
KY Command
91
RF Interfacing Commands
92
PL Command
92
PP Command
92
CA (CCA Threshold)
92
RN Command
93
DB Command
93
MAC Diagnostics Commands
93
AS Command
94
ED Command
94
EA Command
95
EC (CCA Failures)
95
Sleep Settings Commands
95
SM Command
95
SP Command
96
ST Command
96
DP (Disassociated Cyclic Sleep Period)
97
SO Command
97
FP (Force Poll)
98
UART Interface Commands
98
BD Command
98
NB Command
99
SB Command
99
FT Command
100
RO Command
100
AP Command
100
AO Command
101
AZ (Extended API Options)
101
Command Mode Options
102
CC Command
102
CT Command
102
GT Command
102
CN Command
102
UART Pin Configuration Commands
103
D6 Command
103
D7 Command
103
P3 Command
104
P4 Command
104
SPI Interface Commands
104
P5 Command
105
P6 Command
105
P7 Command
105
P8 Command
106
P9 Command
106
I/O Settings Commands
107
D0 Command
107
CB Command
107
D1 Command
108
D2 Command
108
D3 Command
109
D4 Command
109
D5 Command
110
D8 Command
110
D9 Command
111
P0 Command
111
P1 Command
112
P2 Command
112
PR Command
113
PD Command
114
M0 Command
114
M1 Command
115
RP Command
115
LT Command
115
I/O Sampling Commands
116
IS Command
116
IR Command
117
IC Command
117
AV (Analog Voltage Reference)
118
Samples before TX)
118
IF Command
118
IO Command
119
I/O Line Passing Commands
119
IA (I/O Input Address)
119
IU Command
119
T0 Command
120
T1 Command
120
T2 Command
120
T3 Command
120
T4 Command
120
T5 Command
121
T6 Command
121
T7 Command
121
T8 Command
121
T9 Command
122
Q0 Command
122
Q1 Command
122
Q2 Command
122
PWM Output Timeout)
122
Diagnostic Commands - Firmware/Hardware Information
123
VR Command
123
VL Command
123
VH Command
123
HV Command
123
C (Hardware/Software Compatibility)
124
Command
124
TP Command
124
DD Command
124
CK Command
124
FR Command
125
Memory Access Commands
125
AC (Apply Changes)
125
WR Command
125
RE Command
126
Custom Default Commands
126
F (Set Custom Default)
126
C (Clear Custom Defaults)
126
R1 (Restore Factory Defaults)
127
Operate in API Mode
129
API Mode Overview
129
Use the AP Command to Set the Operation Mode
129
API Frame Format
129
API Operation (AP Parameter = 1)
129
API Operation with Escaped Characters (AP Parameter = 2)
130
Frame Descriptions
134
TX Request: 64-Bit Address Frame - 0X00
134
TX Request: 16-Bit Address - 0X01
135
AT Command Frame - 0X08
136
AT Command - Queue Parameter Value Frame - 0X09
138
Transmit Request Frame - 0X10
138
Explicit Addressing Command Frame - 0X11
140
Remote at Command Request Frame - 0X17
144
RX Packet: 64-Bit Address Frame - 0X80
145
Receive Packet: 16-Bit Address Frame - 0X81
146
RX (Receive) Packet: 64-Bit Address IO Frame - 0X82
147
RX Packet: 16-Bit Address I/O Frame - 0X83
149
AT Command Response Frame - 0X88
151
TX Status Frame - 0X89
153
Modem Status Frame - 0X8A
155
Transmit Status Frame - 0X8B
156
Receive Packet Frame - 0X90
158
Explicit Rx Indicator Frame - 0X91
160
I/O Data Sample Rx Indicator Frame - 0X92
162
Remote Command Response Frame - 0X97
164
OTA Firmware Upgrade Process for 802.15.4
165
OTA/OTB File
166
The OTA Header
166
Hardware/Software Compatibility
167
Parse the Image Blocks
167
Storage
167
ZCL OTA Messaging
167
ZCL Message Output
168
Image Notify
168
Create the Image Notify Request
169
Query Next Image Request
170
Query Next Image Response
172
Image Block Request
174
Image Block Response
176
Upgrade End Request
179
Upgrade End Response
180
OTA Error Handling
183
Default Response Commands
183
Upgrade End Request Error Statuses
184
4
Based on 1 rating
Ask a question
Give review
Questions and Answers:
Need help?
Do you have a question about the Digi XBee3 802.15.4 and is the answer not in the manual?
Ask a question
Digi XBee3 802.15.4 Specifications
General
Brand
Digi
Model
XBee3 802.15.4
Category
Control Unit
Language
English
Related product manuals
Digi XBee
307 pages
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 ConnectCore Series
151 pages
Digi ConnectCore
151 pages