DIGI.’
XCTU
Configuration and Test Utility Software
User Guide
Revision history—90001458-13
Revision Date Description
J April 2018 Added support for all XBee3 variants.
K June 2018 Added support for File System Manager. Updated with XCTU 6.4.0.X
information.
L September
2018
6.4.1.X release.
M November
2018
6.4.2.X release.
N April 2019 6.4.3.X 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.
© 2019 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
Customer support
Gather support information: Before contacting Digi technical support for help, gather the following
information:
Product name and model
Product serial number (s)
Firmware version
Operating system/browser (if applicable)
Logs (from time of reported issue)
Trace (if possible)
XCTU User Guide 2
Description of issue
Steps to reproduce
Contact Digi technical support: Digi offers multiple technical support plans and service packages.
Contact us at +1 952.912.3444 or visit us at www.digi.com/support.
Feedback
To provide feedback on this document, email your comments to
techcomm@digi.com
Include the document title and part number (XCTU User Guide, 90001458-13 B) in the subject line of
your email.
XCTU User Guide 3
Contents
Download and install XCTU
XCTU requirements 11
Operating systems 11
System requirements 11
Supported RF modules 11
Install XCTU - Windows 12
XCTU updates 12
Install XCTU - Linux 12
XCTU updates 13
Install XCTU - OSX 13
XCTU updates 13
Optional: Manually install USB drivers 13
RF concepts and terminology
RF modules 16
XBee RF modules 16
XTend RF modules 16
XLR PRO radio solutions 16
Radio firmware 16
Radio communication protocols 17
Radio module operating modes 17
AT operating mode 18
API operating mode 18
API escaped operating mode 19
API frames 19
AT settings or commands 20
Configuring in AT mode 20
Configuring in API mode 21
Local radio modules 21
Remote radio modules 21
XCTU overview
Menu bar 22
Main toolbar 23
Devices list 23
Working area 24
Status bar 24
XCTU preferences 24
XCTU User Guide 4
XCTU User Guide 5
Appearance 24
Automatic updates 25
Consoles 25
Firmware updates 25
Network 25
Radio firmware library 27
XCTU working modes 27
Configuration working mode 27
Consoles working mode 27
Network working mode 28
Add radio modules to XCTU
Add a radio module manually 30
Add a programmable radio module 31
Discover local radio modules 33
Radio module information panel 35
Module Icon 36
New firmware indicator 38
Remove a radio module 39
Expand/Collapse radio modules list 39
Module information box 40
Organize your modules 40
Find radio modules 40
Sort radio modules 40
Clear radio modules 40
Discover remote radio modules 40
Find radio modules 42
Search expressions 42
Configure your modules
Configuration working mode 45
Configuration toolbar 45
Firmware information panel 46
Firmware settings 46
Setting status 48
Setting types 49
Special functions 50
Read radio module configuration 53
Write module settings 53
Load default firmware settings 53
Update firmware 54
Cellular modem firmware updates 55
Remote firmware updates 55
Bootloader updates 55
Work with configuration profiles 56
Create a configuration profile 56
Apply a configuration profile 61
Load and edit a configuration profile 63
Search for a firmware setting 63
Configure remote modules securely 64
Configure a Wi-Fi access point 64
Enable and configure Bluetooth 66
XCTU User Guide 6
View firmware release notes 68
Communicate with your modules
Consoles working mode 70
Console status 70
Consoles toolbar 71
Line status indicator 71
Console overview 72
Connect and disconnect the console 72
Record a console session 73
Attach and detach the console 73
Communicate with modules running in API or API escaped mode 74
API console 74
Filter sent and received frames 78
Add an API frame 82
Manage API frames 85
Send a single API frame 87
Send a sequence of API frames 88
Save an API console session 89
Communicate with modules running in AT mode 89
AT console 90
Add a data packet 93
Manage data packets 94
Send a single packet 95
Send a sequence of packets 96
Save an AT console session 97
Console log files 97
Console session records 97
Data records 98
View your radio network
Network working mode 100
Network toolbar 100
Network scan status 101
Graph view 101
Table view 105
Scan the network for available modules 107
Search for network nodes 107
Change network perspective 107
Set network layout 108
Filter network connections by quality 108
Take a screenshot of the network 109
Set zoom level in Graph view 110
Export a network table 110
Configure XCTU
Set general preferences 112
Set appearance preferences 112
Set automatic software update preferences 113
Set console preferences 115
XCTU User Guide 7
Set firmware update preferences 116
Set network discovery preferences 117
Set network appearance preferences 120
Set radio firmware library preferences 122
Set MicroPython Terminal preferences 123
Update software
Update radio firmware library 126
Install legacy radio firmware 127
Install XCTU updates 128
Open change log 129
Use the XCTU command line
Understanding the XCTU command line interface 131
List all commands 131
Program arguments 131
List ports via command line 131
Options 132
Load profile via command line 132
Options 132
Examples 133
Update firmware via command line 133
Set options 134
Examples 134
XCTU tools
Frames generator tool 137
XBee APIFrame generator dialog 138
ASCII/HEX conversion 140
Generate an API frame 140
Frames interpreter tool 142
XBee API Frames interpreter dialog 143
Decode a frame 145
XBee recovery tool 147
Recover a radio module dialog 148
Recover a radio module 150
Load console session tool 151
Console session viewer dialog 152
Load a console session 155
Range test tool 156
Radio range test dialog 157
Device Selection 158
Range Test Configuration 160
Data representation 161
Supported products 162
Special considerations 163
Range test 164
Perform a range test 165
Firmware explorer tool 166
Firmware explorer dialog 167
XCTU User Guide 8
Firmware selection panel 168
Firmware toolbar 169
Firmware settings panel 169
Inspect a firmware version 169
Serial console tool 170
Serial console dialog 171
Open a serial console session 173
Configure the serial port settings 173
Open a serial console session 174
Spectrum analyzer tool 175
Spectrum analyzer dialog 176
Device selection 177
Analysis configuration 177
Channels Chart 178
Channel summary values 179
Number of samples 180
Analyze the spectrum of a radio band 180
Throughput tool 180
Throughput dialog 182
Device selection 182
Throughput session configuration 183
Data representation 188
Supported products 189
Special considerations 189
Measure the transfer ratio between two radio modules 190
MicroPython Terminal tool 192
Configure the serial port settings - MicroPython Terminal tool 194
Open a MicroPython Terminal session 195
File system manger tool 196
File system manager dialog 197
File System Manager sections 198
Interact with XBee file system 198
Update the file system of remote devices 200
Profile Editor tool 204
Profile Editor dialog 204
Profile Editor toolbar 205
How-to articles and videos
How to update the firmware of your modules 208
Step 1: Add the module to XCTU 208
Step 2: Update the firmware 209
Over-the-air firmware update considerations 210
How to visualize your network 210
Step 1:Scan the network 211
Step 2:Explore the network 212
212
Troubleshooting for XCTU
Troubleshooting: General 214
Troubleshooting: Networking 215
Troubleshooting: Firmware update 215
Troubleshooting: Add radio module 216
XCTU User Guide 9
Known issues
Download and install XCTU
This section contains download and install instructions based on operating system. XCTU is
compatible with Linux, OSX, and Windows. It may be necessary to configure your system prior to
installing XCTU for the first time.
XCTU requirements 11
Install XCTU - Windows 12
Install XCTU - Linux 12
Install XCTU - OSX 13
Optional: Manually install USB drivers 13
XCTU User Guide 10
Download and install XCTU XCTU requirements
XCTU User Guide 11
XCTU requirements
Operating systems
XCTU is compatible with the following operating systems:
nWindows Vista/7/8/10 (32-bit or 64-bit versions)
nMac OS X v10.6 and higher versions (64-bit only)
nLinux with KDE or GNOME window managers (32-bit or 64-bit versions)
System requirements
Property Minimum Recommended
HDD space 500 MB 1 GB
RAM memory 2 GB 4 GB
CPU Dual-core processor Quad-core processor
Supported RF modules
XCTU supports configuration and communication for most Digi RF modules. XCTU uses a serial link to
interact with these radio modules, providing an easy-to-use and intuitive graphical interface. The
following is a complete list of XCTU-compatible RF modules:
nXBee®/XBee-PRO® RF Module Family
lXBee SX
lXBee-PRO SX
lXBee 802.15.4
lXBee-PRO 802.15.4
lXBee ZB
lXBee-PRO ZB
lProgrammable XBee-PRO ZB
lXBee ZB SMT
lXBee-PRO ZB SMT
lProgrammable XBee-PRO ZB SMT
lXBee-PRO 900HP
lProgrammable XBee-PRO 900HP
lXBee-PRO XSC
lXBee-PRO 900
lXBee-PRO DigiMesh 900
lXBee DigiMesh 2.4
lXBee-PRO DigiMesh 2.4
lXBee-PRO 868
Download and install XCTU Install XCTU - Windows
XCTU User Guide 12
lXBee Wi-Fi
lXBee 865LP
lProgrammable XBee 865LP
lXBee Cellular
lXBee 868LP SX
lXBee Thread
lXBee3 (Zigbee, DigiMesh 2.4, 802.15.4 and Cellular)
nXTend® RF Module family
nXLR PRO radio solution
nXLR Module
Install XCTU - Windows
Follow the steps below to download and install XCTU on your computer.
1. Visit www.digi.com/xctu.
2. Click Download XCTU.
3. Under Utilities, click the Windows installer link.
4. When the file has finished downloading, run the executable file and follow the steps in the XCTU
Setup Wizard.
A “Whats new” dialog appears when XCTU opens the first time after the installation.
XCTU updates
You may be notified about XCTU software updates once XCTUhas loaded. You should always update
XCTU to the latest available version. See Install XCTU updates.
Install XCTU - Linux
By default, access to the serial and USB ports in Linux is restricted to root and dialout group users. To
access your XBee devices and use XCTU to communicate with them, your Linux user must belong to
this group.
To add your Linux user to the dialout group:
1. Open a terminal console.
2. Execute this command:
sudo usermod -a -G dialout <user>
where <user> is the user you want to add to the dialout group.
3. Log out and log in again with your user in the system.
Then download and install XCTU:
Download and install XCTU Install XCTU - OSX
XCTU User Guide 13
4. Visit www.digi.com/xctu.
5. Click Download XCTU.
6. Under Utilities, click the Linux installer link.
7. When the file has finished downloading, run the executable file and follow the steps in the XCTU
Setup Wizard.
A “Whats new” dialog appears when XCTU opens the first time after the installation.
XCTU updates
You may be notified about XCTU software updates once XCTUhas loaded. You should always update
XCTU to the latest available version. See Install XCTU updates.
Install XCTU - OSX
OSX version 10.8 (Mountain Lion) and greater only allows you to install applications downloaded from
the Apple Store. To install XCTU, you must temporarily disable this setting.
Follow these steps to enable installation of "unsigned" software:
1. Click the Apple icon in the top-left corner of your screen and choose System Preferences.
2. Click the Security & Privacy icon.
3. To edit security settings, click the padlock icon in the bottom left of the window.
4. Enter your Mac credentials and click Unlock. The Allow applications downloaded from dialog
appears.
5. Click the Anywhere radio button and, in the confirmation window, click Allow From
Anywhere.
Note We recommend you set this option back to Mac App Store or Mac App Store and identified
developers once you have finished installing XCTU.
Then download and install XCTU:
6. Visit www.digi.com/xctu.
7. Click Download XCTU.
8. Under Utilities, click the OSX installer link.
9. When the file has finished downloading, unzip and run the executable file and follow the steps
in the XCTU Setup Wizard.
A “Whats new” dialog appears when XCTU opens the first time after the installation.
XCTU updates
You may be notified about XCTU software updates once XCTUhas loaded. You should always update
XCTU to the latest available version. See Install XCTU updates.
Optional: Manually install USB drivers
When you connect the XBee board to your computer for the first time, USB drivers are installed
automatically. There are times when this does not occur, and you need to install device drivers
Download and install XCTU Optional: Manually install USB drivers
XCTU User Guide 14
manually:
1. Find the appropriate USB drivers on the Digi support site.
2. Choose your operating system.
3. Download and run the file.
4. Follow the steps in the installation wizard.
RF concepts and terminology
This section contains concepts regarding radio frequency modules and the XCTU application itself.
Understanding these concepts will help you work most effectively with XCTU.
RF modules 16
Radio firmware 16
Radio communication protocols 17
Radio module operating modes 17
API frames 19
AT settings or commands 20
Local radio modules 21
Remote radio modules 21
XCTU User Guide 15
RF concepts and terminology RF modules
XCTU User Guide 16
RF modules
A radio frequency (RF) module is a small electronic circuit used to transmit and receive radio signals
on different frequencies. Digi produces a wide variety of RF modules to meet the requirements of
almost any wireless solution, such as long-range, low-cost, and low-power modules. The most popular
wireless products are the XBee RF modules.
XCTU is compatible with Digi's XBee and XTend RF modules and XLR PRO. For a complete list of XCTU-
compatible modules, see XCTU requirements.
XBee RF modules
XBee is the brand name of a family of RF modules produced by Digi. They are
modular products that make deploying wireless technology easy and cost-
effective. Digi has made multiple protocols and RF features available in the
popular XBee footprint, giving customers enormous flexibility to choose the best
technology for their needs.
XBee RF modules are available in two form-factors, Through-Hole and Surface Mount, with different
antenna options. One of the most popular features of these modules is that almost all of them are
available in the Through-Hole form factor and share the same footprint.
XTend RF modules
XTend family devices are long-range RF modules produced by Digi that provide
unprecedented range in a low-cost wireless data solution. They were engineered
to provide customers with an easy-to-use RF solution that provides reliable
delivery of critical data between remote devices. These modules transfer
standard asynchronous serial data streams, operate within the ISM 900 MHz
frequency band, and sustain up to 115.2 Kbps data throughput.
XLR PRO radio solutions
The XLR PRO is an ultra long-range, rugged 900MHz radio solution designed for
optimal performance even in the most challenging RF environments. Leveraging
Digi's patent-pending Chirp Spread Spectrum technology, the XLR PRO provides
industry-leading receive sensitivity and interference immunity, making it ideal for
deployments in noisy RF environments like oil fields. The XLR PRO includes 2
Ethernet ports and 1 serial port, enabling wireless data communications
between Ethernet and/or serial devices up to distances of over 90 miles.
Radio firmware
Radio firmware is program code stored in a radio module's persistent memory that provides the
control program for the device. Digi periodically releases new radio firmware versions to fix bugs or
improve functionality. You may need to add these firmware files to XCTU's radio firmware library. You
can use XCTU to update or change the firmware of a module if, for example, you want to change the
role of a device or you want to use the latest firmware version.
N 032‘”. . f"?f\‘. S. v’ .QET/‘V ZigBee .KY?“ DigiMesh Multipoint
RF concepts and terminology Radio communication protocols
XCTU User Guide 17
Radio communication protocols
A radio communication protocol is a set of rules for data exchange between radio devices. An RF
module supports a specific radio communication protocol depending on the module and its radio
firmware.
The following is the complete list of protocols supported by the XBee radio modules:
nIEEE 802.15.4
nZigBee
nZigBee Smart Energy
nDigiMesh (Digi proprietary)
nZNet
nIEEE 802.11 (Wi-Fi)
nPoint-to-multipoint (Digi proprietary)
nXSC (XStream-compatible)
Not all XBee devices can run all listed communication protocols. The combination of XBee hardware
and radio firmware determines the protocol that an XBee device can execute. For more information
about the available XBee RF modules and the protocols they support, see XBee RF Family Comparison
Matrix.
Radio module operating modes
The operating mode of an XBee radio module establishes the way a user or any microcontroller
attached to the XBee communicates with the module through the Universal Asynchronous
Receiver/Transmitter (UART) or serial interface.
Depending on the firmware and its configuration, radio modules can work in three different operating
modes:
RF concepts and terminology Radio module operating modes
XCTU User Guide 18
nApplication Transparent (AT) operating mode
nAPI operating mode
nAPI escaped operating mode
In some cases, the operating mode of a radio module is established by the firmware version, which
determines whether the operating mode is AT or API, and the AP setting of the firmware, which
determines if the API mode is escaped (2) or not (1). In other cases, the operating mode is only
determined by the AP setting, which allows you to configure the mode to be AT (AP=0), API (AP=1), or
API escaped (AP=2).
AT operating mode
In AT (Application Transparent) or transparent operating mode, all serial data received by the radio
module is queued up for RF transmission. When RF data is received by the module, the data is sent out
through the serial interface.
To configure an XBee module operating in AT, you must put it in command mode to send the
configuration commands.
AT Command mode
When the radio module is working in AT operating mode, you must use the command mode interface
to configure settings.
To enter AT command mode, send the three-character command sequence (usually "+++") within one
second. Once AT command mode has been instigated, the module sends an "OK\r", the command
mode timer is started, and the radio module is able to receive AT commands.
AT command structure
The structure of an AT command is:
AT[ASCII command][Space (optional)][Parameter (optional)][Carriage return]
For example:
ATNI MyDevice\r
If no valid AT commands are received within the command mode timeout, the radio module
automatically exits AT command mode. You can also exit command mode by issuing the CN command:
(ATCN\r)
API operating mode
API (Application Programming Interface) operating mode is an alternative to AT mode. API operating
mode requires that communication with the module be done through a structured interface. In other
words, data is communicated via API frames.
The API specifies how commands, command responses, and module status messages are sent and
received from the module using the serial interface. With API operating mode, you can:
nConfigure the XBee module itself.
nConfigure remote modules in the network.
nManage data transmission to multiple destinations.
Stan Delimiler Length Frame Dale Checksum (Byle 1) (Bytes 2-3) (Bytes 4-nl (Ber n + 1| 0X7E MSB LSB APl-speclflc Structure 1 Byte
RF concepts and terminology API frames
XCTU User Guide 19
nReceive success/failure status of each transmitted RF packet.
nIdentify the source address of each received packet.
Depending on the AP parameter value, the radio module can operate in one of two modes: API (AP=1)
or API escaped (AP=2) operating mode.
API escaped operating mode
API escaped operating mode (AP=2) is similar to API mode except that when working in API escaped
mode, some bytes of the API frame specific data must be escaped. Since XCTU is compatible with both
API and API escaped operating modes, you do not need to manually escape characters.
API escaped operating mode increases the reliability of RF transmission by preventing conflicts with
special characters such as the start-of-frame byte (0x7E). API non-escaped (API=1) operation relies
solely on the start delimiter and length bytes to differentiate API frames. In API escaped mode, on the
other hand, those special bytes are escaped. Since 0x7E can only appear at the start of an API packet,
a module can always "assume" that a new packet has started if 0x7E is received at any time while in
API escaped mode.
Escape characters
When sending or receiving an API frame in API escaped mode, specific data values must be escaped
(flagged) so they do not interfere with the data frame sequence.
To escape a data byte, insert 0x7D and follow it with the byte to be escaped XOR'd with 0x20. The
data bytes that need to be escaped are as follows:
n0x7E: Frame delimiter
n0x7D: Escape
n0x11: XON
n0x13: XOFF
Note XCTU automatically escapes the appropriate characters when interacting with API escaped
radio modules.
API frames
An API frame is the structured data sent and received through the serial interface of the radio module
when it is configured in API or API escaped operating modes. API frames are used to communicate
with the module or with other modules in the network. An API frame has the following structure:
Stan Delimiur Length Frem- Date Checksum (Byte 1) (Bytes 2-3) (Bytes 4-") (Byte n + 1) 0x7E MSB LSB APl-speclfic Structure 1 Byte | Characters Escaped lf Needed
RF concepts and terminology AT settings or commands
XCTU User Guide 20
Field Description
Start
delimeter
The first byte of a frame consisting of a special sequence of bits which indicate the
beginning of a data frame. Its value is always 0x7E. This allows for easy detection of a
new incoming frame.
Length Specifies the total number of bytes included in the frame data field. Its two-byte value
excludes the start delimiter, the length, and the checksum.
Frame
data
Composed by the API identifier and the API identifier-specific data. The content of the
specific data depends on the API identifier (also called API frame type).
Checksum The last byte of the frame. It helps test data integrity and is calculated by taking the
hash sum of all the API frame bytes that came before it, excluding the first three bytes
(start delimiter and length).
If your module is operating in API escaped operating mode, some bytes in the Length, Frame data, and
Checksum frame fields may need to be escaped. XCTU automatically performs this step and escapes
the appropriate characters. See API escaped operating mode.
Note There are many different types of API frames. You can use the Frames generator tool to learn
the specific data contained within a determined API frame as well as to build and fill any type of API
frame. See Frames generator tool.
AT settings or commands
The firmware running in RF modules contains a set of settings and commands that can be configured
to change the behavior of the module or to perform any action related to it. Depending on the
protocol, the number of settings and their meanings varies, but all XBee RF modules can be configured
with AT commands.
All firmware settings or commands are identified with two ASCII characters. Applications and
documents refer to them as either AT settings or AT commands.
The configuration process of these AT settings varies depending on the operating mode of the RF
module.
Configuring in AT mode
In AT operating mode, you must put the module in a special mode called command mode so it can
receive AT commands. For more information about configuring RF modules working in AT operating
mode, see AT operating mode.
RF concepts and terminology Local radio modules
XCTU User Guide 21
Configuring in API mode
To configure or execute AT commands when the RF module is in API operating mode, you must
generate an AT command API frame containing the AT setting identifier and the value of that setting,
and send it to the RF module. See API frames.
Local radio modules
A local radio module is any module added to the device list using the Add a radio module or Discover
radio modules buttons.
XCTU communicates directly with local modules, and they are physically attached to the PC through a
serial or USB port. A local radio module can discover remote modules in the same network if their
protocol is ZigBee or DigiMesh. A local module is configurable if Configuration working mode is active,
and you can communicate with a local module through its console when Consoles working mode is
active.
Remote radio modules
You can locate remote radio modules in the same network as a local module. A remote module is not
physically attached to your computer. Remote modules are displayed in a sub-list under the local
module, and that local module functions as an interpreter; without it, XCTUis unable to communicate
with the remote module. See Discover remote radio modules.
Communication between XCTU and a remote module takes place in two stages: serial communication
from XCTU to the local module, and wireless communication between the local module and the
remote module. XCTU uses the serial port to send a message intended for the remote module, along
with delivery specifics, to the local module. The local module then transmits the message wirelessly to
the remote module.
If the local device containing remote modules is configured in AT (transparent) operating mode, you
cannot configure its remote radio modules due to a protocol limitation. If the local radio module is
configured in API operating mode, you can configure its remote radio modules like any local module.
Since a remote radio module is not physically connected to the PC, it does not have a communication
console in Consoles working mode. For the same reason, you also cannot obtain a remote radio
module's network topology in Network working mode. See Consoles working mode and Network
working mode.
mum—aura.” (“dun .mmu Imam-mud mmmmun. mmficamwn. G mmuem Malinda to m M tummy!- “Wm. mmm‘ofltlflp
XCTU overview
XCTUis divided into five main sections: the menu bar, main toolbar, devices list, working area, and
status bar.
Menu bar
The menu bar is located at the top of the application. You can use the menu bar to access all
XCTUfeatures, tools, and working modes.
XCTU User Guide 22
I Rama Moflnlss @ 9 V 0 Click on Q. Add devices or a Discover devices to add radio modules to the list,
XCTU overview Main toolbar
XCTU User Guide 23
Main toolbar
The main toolbar is located at the top of the application and is divided into three sections.
nThe first section contains two icons used to add radio modules to the radio modules list. See
Add radio modules to XCTU.
nThe second section contains the static XCTU functionality that does not require a radio module.
This section includes the XCTU tools, the XCTU configuration, the feedback form, and the help
and updates functions. See XCTU tools and Configure XCTU.
nThe third section contains tabs corresponding to the three XCTU working modes. To use this
functionality, you must have added one or more radio modules to the list. See XCTU working
modes.
Devices list
The radio modules list, or devices list, is located on the left side of the tool and displays the radio
modules that are connected to your computer. If you know the serial port configuration of a radio
module, you can add it to the list directly. You can also use the discovery feature of XCTU to find radio
modules connected to your PC and add them to the list. See Add radio modules to XCTU.
Depending on the protocol of the local radio modules added, you can also add remote radio modules
to the list using the module's search feature.
1;; Mn mm“ Change between fil- Configuration, 5 Consoles and :e Network working modes to display their functionalwty m the working area.
XCTU overview Working area
XCTU User Guide 24
Working area
The working area is the largest section and is located at the right side of the application. The contents
of the working area depend on the working mode selected in the toolbar. To interact with the controls
displayed in the working area, you must have added one or more radio modules to the list and one of
the modules must be selected.
Status bar
The status bar is located at the bottom of the application and displays the status of specific tasks,
such as the firmware download process.
XCTU preferences
To configure XCTUsettings, click the Preferences button on the XCTU toolbar.
Configuration preferences are grouped into categories listed on the left-hand side of the preferences
dialog box. You can configure settings in the following XCTU categories:
Appearance
You can configure some graphic aspects of the tool and how some elements are displayed.
Field Description
Font size Change all the XCTU texts size in percentage, from 50 to 120%.
Show top bar
menu
Displays an application top bar menu with texts.
Show text on
toolbar actions
Displays the name of the action below each toolbar element for a better
understanding of the meaning of each action.
Use reduced
toolbars size
Changes the size of the application toolbars reducing them.
XCTU overview XCTU preferences
XCTU User Guide 25
Automatic updates
Field Description
Automatically find
new updates and
notify me
Enables or disables automatic XCTUupdates. Uncheck if you do not want
XCTUto update automatically.
Update schedule Sets a schedule to search for updates or to update when XCTU is started. If you
select Look for updates on the following schedule, you must also specify
the search interval and hour.
Download options Establishes when new updates should download and sets permissions for
whether updates are automatically downloaded.
When updates are
found
Sets the frequency of update notification.
Consoles
Field Description
API
console
Configures the maximum number of API frames that can be displayed in the frames log
during a session. When the maximum limit is reached, the session starts overwriting
frames.
AT
console
Configures the maximum number of bytes that can be displayed during a session. When
the maximum limit is reached, the session starts overwriting bytes.
MadCap:autonum="<span style="color: #84c361;" class="mcFormatColor"><b>Note
</b></span>">If you set high values for maximum API frames and/or ATbytes, you may notice
performance issues in the consoles.
Firmware updates
Field Description
Remote
firmware
update
timeout
Configures the remote firmware update timeout in milliseconds. This value is the
maximum time the application will wait for answers sent by the remote node during
remote firmware update before concluding that there was an error during the process.
Network
You can configure Network view in the Network preferences dialog. The first four options are
common to all networks:
XCTU overview XCTU preferences
XCTU User Guide 26
Field Description
Always clear the Network view
before starting
Clears Network view before each new network scan.
Remove nodes if they were not
discovered in the last performed
scan
Removes any nodes not discovered in the last scan.
Stop after scan Sets the number of scans to perform before stopping the
discovery process. A value of '0' means the process will not stop
automatically.
Time between scans Sets the duration of time XCTU waits before starting a new
network scan. The value must be between 0 and 300 seconds.
The remainder of the options are specific to 802.15.4, DigiMesh, and ZigBee network types:
Field Description
Discovery
mode
Sets the method used by the network discovery process.
nFlood: The neighbor discovery process is performed for every node at the
moment it is found. Several discovery processes may be running at the same
time. This method may be faster, but it may also generate a lot of traffic and
saturate the network.
nCascade: The neighbor discovery process is performed for every node as soon as
the discovery process finishes. Only one discovery process runs at a time. This
method may be slower, but it is likely to generate less traffic.
Neighbor
discovery
timeout
Sets the maximum duration, in seconds, the discovery process should spend finding
neighbors of a module. Value must be between 5 and 1800 seconds (30 minutes).
This timeout is highly dependent on the nature of the network. For DigiMesh, the value
should be greater than the highest NT (Node Discover Timeout) and include enough time
to let the message propagate, depending on the sleep cycle of your devices.
Time
between
requests
Sets the wait time between node neighbor requests. The value must be between 0 and
300 seconds (5 minutes).
For the Cascade method, this is the number of seconds to wait after completion of the
neighbor discovery process of the previous node.
For the Flood method, this is the minimum time to wait between each radio module's
neighbor requests.
Note The Cascade discovery method is recommended for large networks.
Network appearance
You can configure how node links are represented in Network graphic view.
XCTU overview XCTU working modes
XCTU User Guide 27
Field Description
Connection default
color
Defines the default color of the node's connection lines.
Show colored
connections based
on their quality
Enables or disables the coloring of node connection lines based on their link
quality.
DigiMesh / ZigBee
network
Enables you to modify the maximum and minimum values and RGB colors for
each quality range. Click in the cell, type the value, and click Enter to change a
value.
Ranges include minimum values but not maximum values. When you change
the minimum value of a quality range, the maximum value of the next range
adopts a corresponding value.
Radio firmware library
You can instruct XCTU to look for new radio firmware when it starts up by checking Automatically
update the XBee Firmware Library each time XCTU is started. If this option is disabled, you can
only check for firmware updates manually.
XCTU working modes
XCTU operations are grouped into three working modes—Configuration, Consoles, and Network. The
selected working mode determines which specific operations you can perform with a radio module or
modules in your device list. You can only select one working mode at a time. By default, XCTU launches
in Configuration mode.
Configuration working mode
Use configuration working mode to configure a radio module selected from your device list. See
Configure your modules.
Consoles working mode
Use consoles working mode to interact or communicate with the selected radio module. See
Communicate with your modules.
XCTU overview XCTU working modes
XCTU User Guide 28
Network working mode
Use network working mode to discover and visualize the topology and interconnections of your
network. See View your radio network.
Add radio modules to XCTU
This section describes how to add, discover and organize your radio modules in XCTU.
Add a radio module manually 30
Add a programmable radio module 31
Discover local radio modules 33
Radio module information panel 35
Organize your modules 40
Discover remote radio modules 40
Find radio modules 42
XCTU User Guide 29
IS Mk! I ndlo module Selen Ind mnfigme the SevilVUSB pun whemhe "din module .5 conn=d=d m. © Sdectflu Saw/USE pun: E COMI Communiafinns Part ‘ COME Imel(R) Miv: Managemmt Tuhnology - COW USE Saill Pan 5 COME USB Serial Port COM14 USB Selial For! v mesh pom 0 Provide a you name manually: Baud Rate 9600 7 am- we an: :1 M cm The radio module is progiammabk.
Add radio modules to XCTU Add a radio module manually
XCTU User Guide 30
Add a radio module manually
If you know the serial configuration of your radio module, you can add it to the list manually.
1. Click the Add a radio module button from the toolbar. The Add a radio module
dialog opens.
2. Select the serial port where the radio module is connected (or enter its name manually) and
configure the serial settings of the port.
Note Custom baud rates can only be typed under Windows OS.
3. Click Finish to add the radio module to the list of radio modules.
mine: ULTRON Function ZigBe: RnuterAPI Port COW - 9600/8/N/1/N - APIl £3 8 Could not llnd any Kaila module Could nmflnd iny ndlo madnl: (unuednd mhe speeilied pm and mu v d smlngs It "fight be caused by one olme lollowmg msans: Radio module not mum/Invalid mugs Mike swam: deme is eonnened and me Senil purl mung; are mum. Then, try agaln. Slooplng rodlo module The dance muld be sleeplng; plessllle (ammisxionmg human and mryme dlseoveugaln. Programmable radio module The devlc: could be a proglammable vidlo module. Add me link: manually ind selemne 'pmgvimmible‘ (hukbox Damaged radio module The ladle module mlghl be damaged. cllckthe 'Remvel‘ blmon lo Iiundl m: remvery mol. Recwery El cm 1
Add radio modules to XCTU Add a programmable radio module
XCTU User Guide 31
4. If the settings were configured correctly and the radio module was connected to the selected
port, the module is displayed in the device list. For more information about the device list, see
Radio module information panel.
5. If the settings were configured incorrectly, an Action Required dialog asks you to reset the
module. Reset the module. The action required dialog should close and your module should be
added to the list.
6. If your module could not be found, XCTU displays the Could not find any radio module dialog
providing possible reasons why the module could not be added. To resolve the issue, see
Troubleshooting for XCTU.
Note You can also use the Add a radio module dialog to add programmable radio modules. See Add a
programmable radio module.
For more information, see Local radio modules and Radio module information panel.
Add a programmable radio module
Some radio module variants are programmable, which means they are able to run applications
written in C. Normally, they are known as Programmable XBee modules and can be identified by a
Add a radio module sum and configuv: m Semi/USE pm whmme vadm + madule 6 (Wanted m. - j‘ 521mm Serial/U58 pan: (own Communications PM L E? (0M3 Imam) Actm Management Tedmology- COW USB SeualPort 5 B COMB USB SenalPort D COMII USB SenalPort v ; ‘ vaid: 3 port name manuulw: Baud Rate 9600 v SW D The nu.» modul: is pvogrammablz. Se! ddmms Cancel
Add radio modules to XCTU Add a programmable radio module
XCTU User Guide 32
part number ending in B on the back label.
XBee-PRO modules are often confused with Programmable XBee modules. The -PRO suffix
does not mean that the module is programmable.
To add a programmable radio module:
1. Click the Add a radio module button from the toolbar. The Add a radio module
dialog opens.
2. Select the serial port to which the radio module is connected (or enter its name manually) and
configure the serial settings of the port.
3. Check the My radio module is programmable setting.
4. Click Finish.
Hindi-n ZigBe: Roma API 23 Fun: COMIC » llsmfl/Nfl/N - AP] 1 MAI: OOBAMTDSFS 1: Select the ports to sun Selen me usa/Seml pm; of ynuv vc m be sunned when dixwuing for radlo moduls. Salad me pnnsm be sunnad: COM! Communiminns Pm cow usa Semi pm COMB use Serial Port com: usa Semi Pm cows use Serial Port cow Intel(R) Actwe Management Technology - 50L < back="" _="" mesh="" l="">
Add radio modules to XCTU Discover local radio modules
XCTU User Guide 33
5. Reset your radio module when prompted. The module appears in the device list.
For more information, see Local radio modules and Radio module information panel.
Discover local radio modules
XCTU can discover radio modules that are connected directly to your computer. You can use the
discovery tool if you don't know the serial configuration of your radio module, don't know the port it is
connected to, or want to add multiple modules at once.
1. Click the Discover radio modules button on the XCTUtoolbar. The Discover radio
modules dialog box opens.
2. Select the serial ports you would like to scan for radio modules. Click Next.
54: port W Configure m: SeviaI/USB port pavamotemo discovev vadio modules. q om an: Palily: ‘ 7 None E E 3 Ban Mark Odd 5px: Flow Cannot E None sum-u ”""’”" — mun Xnn/Xoff Estimated discovery rim: W210
Add radio modules to XCTU Discover local radio modules
XCTU User Guide 34
3. Select any port parameters you would like to include in the search process.
Note XCTU displays estimated discovery time in the Set port parameters dialog. Adding more
port parameters to the search increases discovery time.
Seavzh finished. 2 dances) found 2 device(s) found Denim «(Emmet Pun: COW‘QGOOIE/N/l/N4W1 g rum: ULTRON mus oouAmomsa Pom C0m3-9600/8/N/1/N-AVI1 93 "mu: HULKBUYI'ER mute-s oomzommla D=select all View device was not inund? CIKk here Cancel ‘Add seltdéd dance: ULTRON x ZigBee Rome! m cow - 9600/s/N/1/H - AP” «2' MAC. mmmmsa v HULKBUSTER x ZigBee Route! AV! I: COME - mlfi/N/l/H - API 1 MIL WASHIB 1
Add radio modules to XCTU Radio module information panel
XCTU User Guide 35
4. Click Finish to initiate the discovery scan.
A new dialog opens, displaying devices found and estimated time remaining. You can click Stop
to halt the discovery process at any time. For example, you can stop the process if the modules
you were looking for are already found.
5. Select the box next to the module(s) you want to add to your device list and click Add selected
devices. The modules appear in the device list.
For more information, see Local radio modules and Radio module information panel.
Radio module information panel
Local radio modules appear as big buttons in the modules list. Each module displays identifying
information about itself.
k 255: "-1: ULTRON Radian: 2595: Route! A?! M COW - m/l/N/l/N - APIl MAC: BOISWADEBSB X 48:
Add radio modules to XCTU Radio module information panel
XCTU User Guide 36
To work with a radio module, you must select it from the list of devices. When you hover over a
module, the background color changes to yellow.
Selecting a radio module refreshes the contents of the working area, displaying the information or
actions you can perform on the selected module. The contents of the working area depend on the
active working mode.
Module Icon
An icon on the left side of the information panel identifies the module type and protocol.
Icon Module type Protocol
XBee ZigBee
XBee DigiMesh (Digi's proprietary protocol)
XBee 802.15.4
XBee Point-to-multipoint
XBee Smart Energy
XLR
Add radio modules to XCTU Radio module information panel
XCTU User Guide 37
Icon Module type Protocol
XBee ZNet
XBee Wi-Fi
XBee XStream Compatibility
XTend XTend native
XTend DigiMesh (Digi's proprietary protocol)
XLR XLR-PRO native
XLR Module XLR Module
XBee SX
Add radio modules to XCTU Radio module information panel
XCTU User Guide 38
Icon Module type Protocol
XBee Cellular
XBee Thread
Each icon may contain a small image in the lower-right corner that identifies the role of that module
within its network:
Icon Description
Coordinator
Router
End device
Buttons along the right-hand side of the module information panel perform actions on the selected
module:
Button Name Description
Remove Removes the radio module from the list of devices. Also removes the
associated communication console and network view of that module.
Removes the local module and any associated remote modules.
Search Discovers remote radio modules in the same network. Dependent on
radio module protocol. Performs an SSID discovery for Wi-Fi modules,
and for any other protocol performs a discovery of remote radio
modules. See Discover remote radio modules and Active scan.
Expand/collapse Expands and collapses the remote radio modules list.
New firmware indicator
When a radio module is not running the latest firmware version it is able to run, the New Firmware
control displays next to the name label for the information panel.
lune: LOCAL x W XBEE momma 802 Pod: COMB ~9600/3/N/1/N - API1 a MAC: WISAZWOA1D138 A
Add radio modules to XCTU Radio module information panel
XCTU User Guide 39
This control indicates that there is a newer firmware version that can be flashed in the radio module.
If you click New Firmware, the Update firmware dialog is automatically opened for that radio
module. All of the available firmware versions for the radio module are listed in the dialog.
Remove a radio module
Click Remove to remove a selected radio module from the list of devices. Removing a module
from the list also disables the associated communication console and network view of the module.
Note Clicking the Remove button of a remote module removes only that radio module from the sub-
list of remote modules. Click the Remove button of a local module with a sub-list of remote modules
removes the local module as well as all of its remote modules.
Expand/Collapse radio modules list
If the protocol of the radio module is ZigBee or DigiMesh and you have found remote modules in the
same network, you can use the expand/collapse button to expand or collapse the list of remote
modules under the local device.
Note This button is only enabled for local radio modules.
Module type XBZl-ZB Famiy: XBEE Pmlncut IIche Device lype: Route! Fume: 23A7 Hill": 0x19 a Rama Modules @9'0
Add radio modules to XCTU Organize your modules
XCTU User Guide 40
Module information box
When you hover over the icon, XCTU displays additional information about the selected module,
including module type, family, protocol, device type, firmware, and hardware.
Organize your modules
The Radio Modules view contains a toolbar with options to manage radio modules in the list. These
options are only enabled when the list contains at least one radio module.
Find radio modules
Click the Find radio modules button to find local and remote radio modules in your list. For
details, see Find radio modules.
Sort radio modules
Radio modules are displayed in the order in which you added them to XCTU. Click the Sort radio
modules list button to sort radio modules by name, function, serial port, or MAC address. Or
you can select a specific device and move it up/down in the list.
Note The sorting feature affects both local and remote radio modules.
Clear radio modules
Click Clear radio modules list to remove all discovered modules from the radio modules list.
For more information, see Local radio modules and Remote radio modules.
Discover remote radio modules
You can execute a discovery process to locate remote radio modules in the same network as the local
(selected) module. To discover remote modules:
1. Select a module from your device list. If you do not have any modules in the list, see Add a radio
module manually or Discover local radio modules.
Move-hug mm: min modules m 0.. mm a Wining to: ram «vim m mm“ 2 new devioe(s) found lava-marksman: IE "Ins mm a “WWI [1] Ian: umon x F-du: EMMA“ 23 M CM-m/B/N/l/N-Ml I: ‘
Add radio modules to XCTU Discover remote radio modules
XCTU User Guide 41
2. Click the Discover radio nodes in the same network button . As XCTU discovers new
remote radio modules, they appear in the discovery process dialog box.
3. Click Stop to halt the discovery process at any time.
4. Check the box next to the module(s) you want to add to your device list and click Add selected
devices. The discovered remote modules appear in the list of remote modules.
Note XBee Wi-Fi modules do not support the remote radio modules discovery feature. Instead, they
can look for access points.
For more information, see Remote radio modules.
Find radio modules E! | (9 I Radio new»: 6 9 ' 6 Find radio modula Marne: uukoN M: magenta-mum E! m: ()3) M com—mamm- m mm“ A
Add radio modules to XCTU Find radio modules
XCTU User Guide 42
Find radio modules
To find local or remote radio modules, you must have already discovered the network they are on. You
can then use the Find radio modules search box to find radio modules by MAC address, name, network
address, and other search expressions.
1. On the Radio Modules toolbar, click the Find radio modules button.
The Find radio modules search box appears.
2. Enter your search expression to find one or more modules.
For a list of search prefixes and wildcards, as well as sample searches, see Search expressions.
3. Press Enter.
The background color of the search box and search icon indicates status. Yellow indicates
matches found by XCTU, and red indicates no matches. Modules found along the list are also
highlighted in yellow.
Search expressions
You can enter the following search prefixes in the Find radio modules dialog box.
Search prefix Search by
MAC: (or no prefix) MACaddress
Add radio modules to XCTU Find radio modules
XCTU User Guide 43
Search prefix Search by
SH: Serial Number High
SL: Serial Number Low
NI: Node Identifier (only available in 802.15.4 and DigiMesh)
MY: 16-bit Network Address (only available in 802.15.4 and ZigBee)
You can also use a wildcard if you do not want to specify the entire parameter or if you want to find
more than one node.
Wildcard Equals
* any string
? any character
\ escape for literals (i.e. *, ?, or \)
Sample searches:
nTo search for a module with node identifier (NI) "NODE1" and network address (MY) 0831,
enter
NI:NODE1, or MY:0831
nTo find all nodes whose MAC starts with 00 and ends with B, enter
MAC:00*B
Configure your modules
This section describes how to use Configuration working mode to configure your modules and change
application settings once you have added a radio module or modules to your list of devices.
Configuration working mode 45
Read radio module configuration 53
Write module settings 53
Load default firmware settings 53
Update firmware 54
Work with configuration profiles 56
Search for a firmware setting 63
Configure remote modules securely 64
Configure a Wi-Fi access point 64
Enable and configure Bluetooth 66
View firmware release notes 68
XCTU User Guide 44
E0 ”‘5 § ix Dd“ é "In" ”pd-n .9. . Cl Parametev n: IFEQIH llvvvvv
Configure your modules Configuration working mode
XCTU User Guide 45
Configuration working mode
When you launch XCTU, Configuration working mode opens as the default operating mode.
The Configuration working mode allows you to configure any radio module that has been added to
your device list. When you select a module from the list, XCTU loads the firmware information of the
selected radio module and displays the firmware settings in the working area. It automatically reads
the values and fills in the fields.
Configuration toolbar
The Configuration toolbar presents the configuration actions you can perform with the selected radio
module and firmware settings.
Button Name Description
Read module
settings
Reads the firmware settings for the selected radio module.
Write module
settings
Writes new firmware values to the selected radio module.
Load default
firmware
settings
Loads the default firmware values on to the selected radio module
but does not write them.
Update
firmware
Opens the Update the radio module firmware dialog, displaying
available compatible firmware for the selected radio module.
Product famiy: XBP24BZ7 Furdiorl set: ZigBee Router API Firmware version: 23A]
Configure your modules Configuration working mode
XCTU User Guide 46
Button Name Description
Load/save
configuration
profile
Opens the Load configuration profile or Save configuration
profile dialog.
Search Enables you to search firmware settings by AT parameter.
Expand/collapse
settings
Expands or collapses all firmware settings sections.
Firmware information panel
The firmware information panel is located below the Configuration toolbar and displays information
about the firmware running in the selected radio module.
Firmware settings
XCTU displays firmware settings of the radio module below the firmware information panel. They are
divided into sections or categories with a short description in each. Read-only settings are displayed
with a gray label.
v Networking Change networkmg sefilngs i In PANID D161 A e o i SCSanChInnals Yr’rr Bilfield E 9 o i SDScan Duvation 3 eipment e 0 i BZigEeesnek Profile 0 e o i mNodeJoinTnne FF usee E 6 0 i WWWMIdogfimeom o— xlmirwk e o i wen-imam A e o i Mum-son e o 0 i or Operating PANlD e i oi apeming 16-bit PAN ID rm 6 i cu Opeating Channel 0 e 6 i I“: Numba of Raming Children C i so San Duration 3 mull! e o i so Scam Dumiou 3 exponent 9 0 Range M - M7 (Default: 3) Set/teatime Scan Dulatlon «permit. The expanent tonflgules me . duvatinn of the active scan (PAN scan) on each channel in me sc channel nwskwhen attempting to join a PAN. Scan Time = sc ' (2 A 50) ~ 1536mm (sces channels) -
Configure your modules Configuration working mode
XCTU User Guide 47
The following table provides descriptions for the setting controls.
Field Description
Information
button
Clicking the information button displays a short description of the setting, including
the default value and the valid range, if the setting is numeric.
AT
parameter
Displays the associated AT parameter of the setting. Some settings, such as actions,
may not have an associated AT parameter.
In the example above, the ATparameter is SD.
Setting
name
Displays the name of the setting.
In the example above, the setting name is Scan Duration.
“—5— 6 O ntdr-pvilng-im.“ wmuumnummrqumflml . «mummmummMMWWMnm duuflwMWthdanMSwlfm=x-a. ”'15-‘60“th i ‘SCSGIIM 7TH— m mm 15 14 13 12 11 10 09 08 [ 'l'lnecdcllator B)": 1- 0706050403020100 9mm ”DECIDED Hanvaluc 7gp;— Tim: (ms): 6000 Hex. value 56
Configure your modules Configuration working mode
XCTU User Guide 48
Field Description
Setting
configuration
control
Contains the text box or combo box where the setting value must be entered or
configured. You can hover over the text box of a numeric setting to display the valid
range for that setting. Always enter numeric values in hexadecimal format (without
the '0x' prefix), unless the hover text indicates that an ASCII value is required.
If the setting is configured with an invalid value, an explanation for the error
appears.
Units label Displays the units of measure for that setting. Not all settings have a units label.
In the example above, the unit is exponent.
Value
calculator
icon Clicking the value calculator icon launches a time or bitfield calculator for numeric
settings that are difficult to compute. The content of the calculator panel depends
on the setting.
Refresh and
write
buttons
Clicking the refresh button or write button allows you to read or write the
value of the setting. Some settings, such as the read-only settings, do not have a
write button.
Setting status
XCTU delineates the status of each setting with background color and/or the color of a triangle
located next to the setting value. These are the possible statuses of a setting:
Green triangle The value of the setting has changed but it has
not been written in the radio module yet.
IIIL
Configure your modules Configuration working mode
XCTU User Guide 49
Blue triangle The value of the setting is written in the radio
module but is different from the default value.
Gray background The value of the setting is written in the radio
module and matches the default value.
Yellow background Indicates that the setting is highlighted
because it has been found using the Search
parameter control.
Red background The value of the setting is not valid.
Setting types
There are different kind of settings that you can configure in a radio firmware. Depending on the
setting type they display different controls and options.
nNumeric settings: These settings must always be configured with a numeric value in
hexadecimal format (without the '0x' prefix). Hovering over the text box of a numeric setting
displays the valid range for the setting. There are several types of settings:
nText settings: Text settings are very similar to the numeric settings, but they can be
configured with hexadecimal or ASCII characters. If you hover over the text box of a text
setting, a dialog displays the minimum and maximum characters and whether they must be an
ASCII or hexadecimal value.
nCombo settings: A combo box displays all the possible values of the setting with symbolic text,
to help you to choose the correct option.
nRead-only settings: These settings cannot be modified. They can only be read from the radio
module and their values are displayed in a label.
nAction settings: These settings can be neither read nor written. The main purpose of the
action settings is to execute a task or process in XCTU that implies some interaction with the
i Mile San Sdmm: KKBS pomnn connect SSIDnime 1mm"... Secunly Channd Quzlny i oNo1A1F 24 WPAZ 1 43% a amniojasoormpem." 19 0pm 1 39% i DAPrGUEST 15 WPA 1 30% a hulk/outta 11 0pm 7 21% 3 WLANADGEA 14 mm a 28% 3 WLAN_SB 6 WEP 9 11% i mm_bg 30 WPAZ 1o 60% AnessPolmmtings Emuthe password lonheselenad “cm pom chmnSSlD configuration m m. module.
Configure your modules Configuration working mode
XCTU User Guide 50
radio module. To learn more about the Action settings see the Special functions topic.
Special functions
Some settings within XCTU cannot be read or written. Instead, they execute tasks or processes in
XCTU related to interaction with the radio module. The processes that these settings execute are
called special functions. At this time, XCTU has two special functions: Active scan and Bluetooth
Authentication.
Active Scan
The Active Scan function discovers and configures the access point for an XBee Wi-Fi module.
When you click the Active Scan button, XCTU reads the SSID configuration of the Wi-Fi module. If the
module has an SSID already configured, you need to clear the configuration and perform a new SSID
discovery. If the SSID configuration is empty, the nearby SSIDs are displayed in a new dialog.
The dialog displays all the nearby access points as well as their security protocols and signal quality.
Select the Access Point you want the Wi-Fi module to connect to and, if necessary, configure the
password of the Access Point. The Access Point settings also have a check box that allows you to
permanently save the SSID configuration in the Wi-Fi module. If you uncheck this option, the next time
you reset the module the SSID configuration is cleared.
i Bluetooth Authentication Configure
Configure your modules Configuration working mode
XCTU User Guide 51
Click Connect to connect the Wi-Fi module to that Access Point and refresh the settings of the radio
module.
Enable BLEand configure the BLEpassword
The Bluetooth Authentication function allows you to configure the security parameters of your XBee
device with Bluetooth Low Energy (BLE)support. This step is mandatory if you want to enable
Bluetooth on the module.
XBee BLE security is based on the Secure Remote Password protocol. When you click the Configure
button, XCTU displays a dialog asking you to either:
1. Type a password, which you are asked for when you connect to the XBee via Bluetooth Low
Energy.
2. Enter a random salt and a password verifier generated from a password and that salt (as
specified in the SRP protocol).
CAUTION! Only use the advanced configuration if you are familiar with the SRP protocol. You
must know the password which originated the verifier since you will be asked for it when you
connect to the XBee via BLE.
i Puma-II: I 0 OMvalullmliglliion i Salt: 06031928 E A Verifier: 43061E546A72MDIBBB937E330805748F5FF65 9:007mzummzaozsoscrnccsnrs AD7303BZE14A67000661730C946308010A2242 Aemrzmrscsssemmzuuemmsn OAZE140A73M2AC08F67DA2C6C15262E141901 010697emor297mgsecao32m37oesm53£9 sssoezzzmusurmssosam9 IE} Note that you must know the password which originated this verifier. Connecting to the XBee via BLE requires the known password, _c-«='l
Configure your modules Configuration working mode
XCTU User Guide 52
When you enter the password or the salt/verifier combination, click OK to save the settings to the
module.
For more information about Bluetooth security, see the user guide for your XBee device.
ME
Configure your modules Read radio module configuration
XCTU User Guide 53
Read radio module configuration
You can refresh a radio module's firmware settings once you have added the module to your device
list. To read a module's configuration settings:
1. Switch to Configuration working mode .
2. Select a radio module from the device list. XCTU displays the current firmware settings for that
module.
Note If the selected module is remote and the Remote AT Command password (KZ) is set, you
may be asked to enter that password in order to access the module configuration.
3. From the configuration toolbar, click the Read module settings button to refresh the
selected radio module's firmware settings.
Write module settings
You can configure a radio module's firmware settings once you have the module to your device list. To
configure a radio module:
1. Switch to Configuration working mode .
2. Select a radio module from the device list. XCTU displays the current firmware settings for that
module.
Tip To refresh the selected radio module's firmware settings, click the Read module settings
button on the configuration toolbar.
Note If the selected module is remote and the Remote AT Command password (KZ) is set, you
may be asked to enter that password in order to access the module configuration.
3. Change the value of the setting or settings to be configured.
4. Click the Write module settings button to write any newly configured firmware values to
the module.
Load default firmware settings
You can load default radio firmware settings in a module in your device list.
1. Switch to Configuration working mode .
2. Select a radio module from the device list. XCTU displays the current firmware settings for that
module.
3. On the Configuration toolbar, click the Load default firmware settings button to load the
default values established by the firmware.
4. Firmware settings are loaded but not written to the radio module. In order to write them in
the module, click the Write module settings button on the toolbar.
X Updat: fivmwar: D x Updah the radio modulo flrmvlan Configure the filmwale that will be flashed to the ladio module. 'VV'I" Select the product fimiOy 0f your duke. H»: new function set and the fivmware vusion m flash: (3 mm hilly Funnlm sec film-x: m 802.1 5.4 TH PRO Di Mesh 2.4 TH PRO 405F _ 405E 4059 4055 Can't find your finnwam'! Sljska: View Reins: Notes IZ Forcethe module to maintain its tum! configuration. Camel
Configure your modules Update firmware
XCTU User Guide 54
Update firmware
You can use XCTU to update a module's radio firmware.
1. Switch to Configuration working mode .
2. Select a radio module from the device list.
3. Click the Update firmware button . A dialog box appears displaying the available and
compatible firmware for the selected module.
4. Choose the firmware family, function, and version.
Note If you do not remember the firmware version that is currently installed in your radio
module, click Select current to automatically select it.
5. Click Update. A dialog box displays update progress. You can click the Show details button to
view a detailed progress log, and Hide details to hide it.
Note During the firmware update process, XCTU attempts to obtain the module information
again, as some critical settings such as the operating mode could have changed. If the
Maintain current module configuration setting is checked, XCTU writes the old configuration
to the module and then reads the setting's values.
Configure your modules Update firmware
XCTU User Guide 55
Cellular modem firmware updates
When you update the firmware of an XBee Cellular module, XCTU may need to update the modem
firmware. This process is completely transparent, but note that XCTU requires an Internet connection
to download the modem firmware.
Note The system prompts you for confirmation when the module requires a modem firmware update,
as this process may take up to 30 minutes.
Remote firmware updates
You can use XCTU to perform firmware updates on remote modules because once you add a remote
module to XCTU's device list, the update process is exactly the same whether you are updating a local
module or a remote module. To perform a remote firmware update, the local module must be working
in API or API escaped operating mode.
Remote firmware updates can be performed on the following radio modules:
nXBee/XBee PRO SX
nXLR Module
nXBee/XBee PRO 802.15.4 (S2C module versions only)
nXBee/XBee-PRO DigiMesh 2.4 (S2C module versions only)
nXTend RF Module Family (SX module versions only)
nXLR PRO Radio Solution
nXBee/XBee-PRO ZB and Programmable XBee-PRO ZB
nXBee/XBee-PRO ZB SMT and Programmable XBee-PRO ZB SMT
nXBee-PRO 900HP and Programmable XBee-PRO 900HP
nXBee 865LP and Programmable XBee 865LP
nXBee 868LP SX
nXBee3 (Zigbee, DigiMesh 2.4, and 802.15.4)
Note If something goes wrong during an over-the-air firmware update on a remote module—for
example, communication is lost because the remote device is disconnectedyou must perform a
manual recovery. See Recover a radio module.
Bootloader updates
Some firmware versions require a specific bootloader version in order to work properly. The
bootloader is the software running in the module that, among other things, launches the firmware as
soon as the module boots.
The bootloader update takes place during the firmware update process. If the firmware to be flashed
requires a bootloader update, XCTU updates the bootloader first and then the module's firmware.
Note The system prompts you for confirmation when the firmware requires a bootloader update, as
this process erases the configuration of the module. You must accept it in order to continue with the
firmware update process. If you decline the bootloader update, the overall firmware update process is
canceled.
i Load configuration plofile a Save configumion pwfile
Configure your modules Work with configuration profiles
XCTU User Guide 56
Work with configuration profiles
A configuration profile is a snapshot of a specific radio firmware configuration, including firmware,
settings values and other configuration information. XCTU allows you to create, inspect and and apply
configuration profiles to the radio module. This feature is useful in a production environment when you
need to set the same parameters on multiple radios.
These are the actions that XCTU allows you to perform related to configuration profiles:
nCreate a configuration profile
nApply a configuration profile
nLoad and edit a configuration profile
Create a configuration profile
You can create a configuration profile from two different places within XCTU. You can either create a
profile based on the configuration of an XBee device or create a profile from scratch.
Create a profile based on the configuration of an XBee device
The first way to create a profile is to create a representative model upon which to base the
configuration profile and then save the profile. To do this, you need to have a radio module added in
XCTU.
Note You only need to configure the values; it is not necessary to write the settings to the module.
To do so follow these steps:
1. Switch to Configuration working mode .
2. Select a radio module from the device list.
3. Configure the radio module with your desired values.
4. Click the Configuration profiles drop-down menu on the Configuration toolbar and select
Save configuration profile.
5. Create profile wizard displays.
Create a new profile from scratch
It is also possible to create a new profile without any pre-configured firmware or settings. To create a
new profile from scratch:
Configure your modules Work with configuration profiles
XCTU User Guide 57
1. Launch the Profile editor tool by selecting Profile Editor from the Tools drop-down menu on
the main toolbar.
2. Click the Create button from the toolbar. The Create profile wizard displays.
In either case, the Create profile wizard displays. Follow the steps provided there to create the
configuration profile.
nCreate profile wizard
Create profile wizard
The Create profile wizard allows you to create a new configuration profile to be used later in XCTU or
other XBee management applications. You can access this wizard either from the Profile editor tool
or from the toolbar of the Configuration working mode view. See Create a configuration profile for
more information.
Once the wizard is open, follow these steps to configure and create a new configuration profile:
1. In the first page of the profile you can set the profile description and the configuration
features:
a. Flash radio firmware. With this setting you can decide if the profile will flash the
firmware in the XBee module or not. If you check it you can choose one of the
following flash options:
i. Flash if firmware is different. Firmware is flashed in the module only
if the firmware version that the module is running is different from the
one specified in the profile.
ii. Flash always. Firmware is always flashed regardless of the version
running in the device.
b. Reset module to factory defaults before applying settings. Check this option if
you want to reset the XBee module to its default values (equivalent to send an RE
command) before configuring the firmware parameters.
c. Flash a file system. With this setting you can attach a file system to the profile
that will be transferred to the XBee module when applying the profile.
5: Cum: 5 pmfile 5:: a: man: mnflglnlflon PM a dar‘wbw and umfigureflle profill was, mm: mnfigumm Flash © Flash flflmwam is dfluenl 0 Flash always [:1 [an module m hdmy ddauhs Mm upprying settings [I rm. 3 me symm a flmwan mm: datum: (m cmmk Cm.
Configure your modules Work with configuration profiles
XCTU User Guide 58
2. Click Next to configure the XBee firmware of the profile. Choose the desired firmware
selecting its corresponding properties:
a. Product family of the firmware.
b. Function set that determine the functionality of the firmware (mode of operation,
special sensor and adapter settings, and so forth).
c. Firmware version. The most recent firmware version appears at the top of the list.
3-: cm. mm: Sdld u- III-m Sdmhxluflmmmpmdm Main" ammmm panic. Sdmmfimmlndmlzmfllg (3) mm mg mm “0W5”! ”warm-warm CIH‘WYW'WWKLKKEB \r-urduum Celuhvflmlwave mm. Czflulal mmkm llmlwive
Configure your modules Work with configuration profiles
XCTU User Guide 59
Note If you accessed the wizard from the Configuration working mode, the firmware should already
be selected with the firmware that the XBee device is running.
3. Click Next to configure the XBee firmware parameters. This page displays all the firmware
settings split in categories. Each configurable setting has a checkbox at the left side. Check
and edit the value of those settings you want to be configured by the profile.
Ham-m , mama-enema!» Mmmkw-mdkflafimhk‘hkpfl @- l v Mun-liq ~ Any-ppmmmgammmmlnmmmmyamlnmnm (mm 9000000000 ‘IIDEIDEIEIEIEIEIEI O l
Configure your modules Work with configuration profiles
XCTU User Guide 60
Note If you accessed the wizard from the Configuration working mode, the firmware settings
should be already checked and selected with the ones configured in the XBee device.
4. Click Next to set a file system to the profile. If the profile is configured to attach a file system
(first page of the wizard) you can specify it here using the Browse button.
3cm.pmm u x nun-mum o Sdm-hldumruiningmfiksyaunlokfllshedmlhewk. .‘+ rag/mum hum} mmmm (M Mn) ‘a—gpukfl c-uzl
Configure your modules Work with configuration profiles
XCTU User Guide 61
5. When you have all the profile parameters configured, click Create profile to open the save file
dialog.
6. Select the destination path and click Save to create the profile.
Apply a configuration profile
Follow these steps to apply a configuration profile to an XBee device:
1. Switch to the Configuration working mode .
2. Select a radio module.
3. Click the Configuration profiles drop-down menu on the Configuration toolbar and select
Apply configuration profile.
3.. i Load configuration plofile a Save configuration .plofik mfimmmfimtalhespxifidmdoesnmmhmm Wuemmhginmmxmdnmomm Doywwmmopdnemlinmmoflhendhmflbdlhepmfik sax-Ms: WE mar-mmonapondingmmspxm pdkknmmmmnu sdedednfiomodflc DoymeMUpmkhmfimmeIp‘omm? EE
Configure your modules Work with configuration profiles
XCTU User Guide 62
An Open file dialog appears, asking for the configuration profile file to load.
4. Locate the configuration profile (an XPRO file) and click Open. Depending on the firmware
compatibility with your radio module and the firmware flash action configured in the profile, a
dialog box may appear:
nIf the firmware of the configuration profile does not match the firmware running in the radio
module but is compatible with the module and the profile is configured to always flash the
firmware or flash when it is different, click Yes to update the module's firmware so the profile
will load correctly.
nIf the firmware of the configuration profile is not compatible with the radio module, click Yes to
open the profile in the Profile editor tool.
nIf the firmware of the configuration profile matches the firmware running in the radio module
but the profile is configured to always flash the firmware, click Yes to update the module's
firmware so the profile will load correctly.
mrmumngmmmmmmmmm mmhmmmm.mmkmfiwuhmm Madam; mmmmmmhnmedmmmmmmm sdfngfl GEE
Configure your modules Search for a firmware setting
XCTU User Guide 63
nIf the firmware of the profile you are loading and the firmware running in the radio module
match or the profile is configured to don't flash the radio firmware, XCTU applies the settings
saved in the profile to the radio module.
Load and edit a configuration profile
Note This topic explains how to load a configuration profile to inspect and modify it using the Profile
editor tool. For an explanation of how to apply a configuration profile in a module, see Apply a
configuration profile instead.
Follow these steps to load and inspect a configuration profile:
1. Launch the Profile editor tool by selecting Profile Editor from the Tools drop-down menu
on the main toolbar.
2. Click Load from the toolbar.
3. Look for the configuration profile (xpro extension) you want to load. Click Open.
4. The Profile editor tool loads the profile information and displays it along the different tabs of
the view:
a. Configuration. Contains the configured profile features and description.
b. XBee firmware. Displays the product family, function set and version of the
firmware corresponding to the profile.
c. Firmware settings. Contains the list of firmware settings configured for the profile.
d. File system. If the profile is configured to include a file system, this tab displays its
structure.
If you want to modify the firmware, change any setting you want and click Save. You can then choose
between one of the following Save options:
nSave profile. Overwrites the loaded profile.
nSave as new profile... Allows you to save a new profile with the changes made in the loaded
one.
Search for a firmware setting
The configuration toolbar includes a search box. To search for a firmware setting in the list of settings,
search for the AT parameter associated with the setting. If the setting is found, it is highlighted in
yellow.
mmmhmlfllflummmm at: Pmrd 72un Pm
Configure your modules Configure remote modules securely
XCTU User Guide 64
Configure remote modules securely
Some new firmware versions allow you to add an extra protection layer to encrypted networks in
order to prevent an intruder from hijacking a module and making changes in the network. This feature
requires you to enter a pre-configured password every time you want to configure a remote module.
Note To learn more about this feature and how it works, refer to the user guide for your XBee module.
To enable the secured remote configuration, set a password with the KZ parameter. To do so, enter
the old password ('0' by default), followed by a blank space and the new password. For example, if
your password is "1234" and you want to change it to "7a$b3l1", you should enter:
1234 7a$b3l1
After the password has been set, Password required dialog appears when you try to configure a
remote module and the password is set on your local one (KZ is not set to '0'). The same dialog
appears if you perform a range or throughput test with a remote module.
You must enter the password and click OK before you can configure the module.
Configure a Wi-Fi access point
The Active scan special function discovers and configures the access point for the XBee Wi-Fi module.
The feature is only enabled for Wi-Fi modules.
Mitre Sun TnexaeeM-F. madute already has an access point eonfiguved, Du you wanna clear it and configure a new access point? _E Select the access point to connect. 551:) mm Link Mir... Secunty Channel Qullity 3 ONOIA7F 24 prz 1 45% R amato_A5300H_0pen_... 19 Open 1 38% i DAP-GUEST 1; WM 1 30% R IonRoutefl 11 Open 1 22% i WlANjGEA 14 WM 3 23% i WLAN_SB 6 wzv 9 12% i mm_bg so pr2 1o 60% Access Paint settings Enter the passwmd for the selected accss point. Save the SSlD cunfignmion in the module.
Configure your modules Configure a Wi-Fi access point
XCTU User Guide 65
1. Switch to Configuration working mode .
2. Select a Wi-Fi-enabled radio module from the device list.
3. Click the Active scan button. XCTU reads the SSID configuration of the Wi-Fi module.
nIf the module already has an SSID configured, click Yes to clear the configuration and
perform a new SSID discovery.
nIf the SSID configuration is empty, XCTU displays all nearby access points as well as
their security protocols and signal quality.
Configure your modules Enable and configure Bluetooth
XCTU User Guide 66
4. Select the SSID you want the Wi-Fi module to connect to.
For S6 Wi-Fi modules, the table displays the following fields:
Field Description
SSID name Name of the access point
RSSI (dBm) RSSI of the access point (negated hex value)
Security Security type of the access point
Quality Link quality (based on the RSSI) with the access point
For S6B Wi-Fi modules, the table displays the following fields
Field Description
SSID name Name of the access point
Link margin (dBm) Signal strength in dBm above sensitivity
Security Security type of the access point
Channel Channel number in use by the access point
Quality Link quality (based on the link margin) of the access point
5. If necessary, ent