Digi XBee 3 Cellular LTE-M User Manual page 94

Update the firmware
Each module must be configured to use unescaped API mode:
n
Each module must be configured to use the same baud rate on the UART interface (same
n
value).
The machine that will be performing the update must have Python 3.6 or higher installed and
n
the script must be run using Python 3.
Note If installing on Windows, ensure that the checkbox for "Add Python to PATH" is checked.
If Python is not added to the PATH, you will need to manually specify the directory in which
Python is installed in order to proceed.
The machine that will be performing the update must have visibility to an HTTP server hosting
n
the files.
The script dependencies must be satisfied by running pip install --user -r
n
requirements.txt in the directory containing the script. Creating and using a Python
virtual environment with the virtualenv command is recommended as a best practice. If
using virtualenv, install the script dependencies using pip install -r
requirements.txt once the environment is activated. Refer to the instructions in the rest
of this section for when to run this command.
Script usage
The arguments and default values for the script are shown below. By default, Digi hosts the update
files on a public FTP server and the script attempts to apply the appropriate update files based on
intelligence built into the script. The optional arguments should only rarely need to be changed and
generally only if the Digi FTP server is not accessible on a private APN, or by direction of Digi Technical
Support.
usage: update.py [-h] [--baud <BAUD>] [--type {auto,es2,ip}]
[--remote BASE_URL | --local BASE_DIRECTORY] [-f FILE] [-v]
<PORT> [<PORT> ...] [<BAUD>]
Update the u-blox SARA-R410M cellular module used by the Digi XBee 3 Cellular
LTE-M/NB-IoT device to a firmware version using a serial link to one or XBee 3 Cellular devices. Script
version: 1.1.
optional arguments:
-h, --help show this help message and exit
Serial port:
Arguments which control how the script interfaces with the XBee
<PORT>
Cellular device. Can be specified multiple times to
update multiple devices.
--baud <BAUD>
(default: 9600)
Firmware update:
Arguments which control the firmware update process
--type {auto,es2,ip} Type of modules (default: auto)
--remote BASE_URL
(default: http://ftp1.digi.com/support/ublox)
--local BASE_DIRECTORY
Local directory where update files are located
(overrides --remote) (default: None)
Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide
COM port (or /dev/ttyUSBx device) for the XBee 3
Current baud rate of the XBee 3 Cellular device(s)
HTTP server base path where update files are located
Update the cellular firmware
ATAP set to 1.
ATBD
94