Digi XBee 3 Cellular LTE-M User Manual page 92

Update the firmware
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.
Best practices
For best results, you should ensure the following:
Notify your host processor that an update is occurring.
n
Exit your Micropython code if it is currently running.
n
Make sure your device is not in any Power Saving Mode or Sleep Mode.
n
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: fota.py [-h] [--type {auto,es2,ip}] [--ftp_server FTP_SERVER]
[--ftp_port FTP_PORT] [--ftp_user FTP_USER]
[--ftp_password FTP_PASSWORD] [--ftp_basedir FTP_BASEDIR]
<IMEI> [<IMEI> ...]
Perform Over The Air Firmware update (FOTA) on XBee Cellular LTE-M/NB-IoT
positional arguments:
<IMEI> IMEI of device on which to perform update.
optional arguments:
-h, --help show this help message and exit
--type {auto,es2,ip} Type of modules (default: auto)
--ftp_server FTP_SERVER
FTP server (default: ftp1.digi.com)
--ftp_port FTP_PORT FTP port (default: 21)
--ftp_user FTP_USER FTP username (default: anonymous)
--ftp_password FTP_PASSWORD
FTP password (default: fota@digi.com)
--ftp_basedir FTP_BASEDIR
FTP base directory (default: /support/ublox)
Script version: 2.0
Run the update script
The IMEI values for the modules you want to update are entered as arguments when you run the
script. See Script usage
1. Download the script.
a. Go to the
b. Scroll down to the Firmware Updates section.
c. Locate and click u-blox Module Over the Air Update Script to download the zip file: over-
the-air.zip.
d. Unzip the downloaded file.
Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide
for information about the arguments.
Digi XBee 3 Cellular LTE-M support
Update the cellular firmware
page.
92