Digi ConnectPort X4, ConnectPort X4H User Manual

Page 1
Digi ConnectPort® X4/X4H
Telit HE910-D Modem Firmware Update Guide
Page 2
Revision history—90002414
Revision Date Description
A September 2020
Trademarks and copyright
© 2020 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
Initial release.
Send comments
Documentation feedback: To provide feedback on this document, send your comments to
techcomm@digi.com.
Technical support
Digi Technical Support: Digi offers multiple technical support plans and service packages to help our
customers get the most out of their Digi product. For information on Technical Support plans and pricing, visit us at www.digi.com/support. For questions or assistance contact Technical Support at
tech.support@digi.com.
Digi ConnectPort®X4/X4H
2
Page 3
Contents
Digi ConnectPort® X4/X4H: Upgrade the Telit HE910-D modem firmware
Step 1: Find the Telit modem revision to determine if an update is needed
Method 1: Command line 6 Method 2: Web interface 6 Method 3: Digi Remote Manager 6
Step 2: Update the Digi ConnectPort X4/X4H firmware
Step 3: Update the Telit modem firmware
Method 1: Update the Telit modem firmware using Digi Remote Manager 9
Step 1: Install Python update application 9 Step 2:Configure Python auto-start 9 Step 3: Perform update 10 Step 4: Verify that the update was successful 10 Step 5: Finalize 11
Method 2: Update the Telit modem firmware using a wired Ethernet connection 12
Step 1: Install Python update application 12 Step 2:Manually run the update application 13 Step 3: Verify the update was successful 13 Step 4: Remove update application 13
Digi ConnectPort®X4/X4H
3
Page 4
Digi ConnectPort® X4/X4H: Upgrade the Telit HE910­D modem firmware
This document describes how to update the cellular modem firmware of a Digi ConnectPort X4/X4H device that contains a Telit HE910-D modem. The update fixes an issue where it is possible for the Telit HE910-D modem to permanently stop connecting to the network.
To fix this issue, you should update the Telit modem from revision 12.00.028 or 12.91.028 to revision
12.01.020.
Digi ConnectPort®X4/X4H
4
Page 5

Step 1: Find the Telit modem revision to determine if an update is needed

You need to perform this update only for Telit HE910-D modems at revision 12.00.028 or 12.91.028. This section explains how to determine the revision of the Telit HE910-D modem on your device. You can use one of the following methods to determine the revision.
Note If the revision is not 12.00.028 or 12.91.028, you do not need to perform this update.
Method 1: Command line 6 Method 2: Web interface 6 Method 3: Digi Remote Manager 6
Digi ConnectPort®X4/X4H
5
Page 6
Step 1: Find the Telit modem revision to determine if an update is needed Method 1: Command line

Method 1: Command line

1. Perform the command : display mobile
2. The revision number is in the Revision ID field in the output.

Method 2: Web interface

1. Open the web interface.
2. Click Administration > System Information.
3. Open the Mobile header of the page.
4. In the Mobile Information section, the revision number is in the Revision ID field.

Method 3: Digi Remote Manager

1. Open Digi Remote Manager and log in.
2. Click Devices in the left-hand pane and find your device.
3. Double-click on the device entry to display the Devices page.
4. Click Settings in the toolbar.
5. On the right side of the page, click the Settings icon.
6. From the drop-down menu, click Status > Mobile. The Mobile page displays.
7. Scroll down to view the revision number in the Revision ID field.
Digi ConnectPort®X4/X4H
6
Page 7

Step 2: Update the Digi ConnectPort X4/X4H firmware

Before you can update the HE910-D Telit modem firmware, the Digi ConnectPort X4/X4H device firmware must be at version 2.26.0 (PN 82001536_W) or later.
To update the XBee firmware on a gateway:
1. Download the appropriate firmware file from the Digi Support site.
a. Navigate to the Digi Support site.
b. Download this file: Gateway OS Firmware: ConnectPort X4 V2.26.0 (EOS)
2. Access the web interface.
3. From the web interface, select Configuration > XBee Network > XBee Configuration and
then click the Gateway Firmware Update link.
4. The Gateway Firmware Update page shows the type of XBee radio in the gateway and the
current firmware level.
5. Type or browse to the file name containing the firmware update for the gateway’s XBee
module.
6. Click the Update button. After the firmware loads successfully, the XBee module will be
restarted.
Digi ConnectPort®X4/X4H
7
Page 8

Step 3: Update the Telit modem firmware

Choose one of the following options to update the Telit modem firmware.
Method 1: Update the Telit modem firmware using Digi Remote Manager 9 Method 2: Update the Telit modem firmware using a wired Ethernet connection 12
Digi ConnectPort®X4/X4H
8
Page 9
Step 3: Update the Telit modem firmware
Method 1: Update the Telit modem firmware using Digi Remote
Manager

Method 1: Update the Telit modem firmware using Digi Remote Manager

This section describes how to remotely update the Telit modem firmware on a device. Physical access is not needed to perform the update in this fashion, but the device needs to exist in Digi Remote Manager and must have network access.
Updating with this process is not recommended if the alternate wired approach will work. Due to the lack of feedback from the update this process will take significantly longer with no ability to report on progress and final status.
Prerequisites
n Digi ConnectPort X4H firmware version 2.26.0 (PN 82001536_W) or later installed on X4H (PN
82001536)
n Python update application (PN 83000129) downloaded onto your hard drive.
n Digi Remote Manager (DRM) account
n Cellular connection with access to the server ftp1.digi.com

Step 1: Install Python update application

The 83000129 archive contains two files: t_update.py and t_update.zip. These files must be placed in the Python application storage of the gateway.
1. Make sure you have downloaded the Python update application (PN 83000129) onto your hard
drive.
2. Open Digi Remote Manager and log in.
3. Click Devices in the left-hand pane and find your device.
4. Double-click on the device entry to display information about the device.
5. Click the Files tab.
6. Click the Python folder.
Click the Upload icon to upload the t_update.py and t_update.zip files that you had
7.
previously downloaded onto your hard drive.
Step 2:Configure Python auto-start
1. Navigate to the Python auto-start page.
a. Click Devices in the left-hand pane and find your device.
Digi ConnectPort®X4/X4H
b. Double-click on the device entry to display information about the device.
c. Click Settings in the toolbar.
9
Page 10
Step 3: Update the Telit modem firmware
d. On the right side of the page, click the Settings icon.
e. From the drop-down menu, click Config > Python auto-start.
2. Disable all currently configured Python scripts that are set to auto-start.
a. Expand a Python script.
b. De-select the Python auto-start enable option.
3. Set up a command line to run at startup.
a. Expand a Python script, either an unused field or replace an existing entry.
b. In the Python command to run at startup field, enter: t_update.py –c
c. Make sure that the value for the Action taken on exit of program field is set to No
action taken.
d. Select the Python auto-start enable option to enable auto-start.
Method 1: Update the Telit modem firmware using Digi Remote
Manager
4. Click Apply to save the changes.

Step 3: Perform update

1. Click Devices in the left-hand pane and find your device.
2. Click the check box next to the device.
3. Click Actions > Reboot to reboot the device and start the update process.
4. Please be patient, as the update process can take up to 30 minutes.

Step 4: Verify that the update was successful

After waiting about 30 minutes, you can verify that the process was successful.
1. Click Devices in the left-hand pane and find your device.
2. Double-click on the device entry to display information about the device.
3. Click Settings in the toolbar.
4. On the right side of the page, click the Settings icon.
5. From the drop-down menu, click Status > Mobile. The Mobile page displays
Click the Refresh button twice.
6.
Note that the button is at the top of the screen and you may have to scroll up to see it.
Digi ConnectPort®X4/X4H
10
Page 11
Step 3: Update the Telit modem firmware
7. Locate the Revision ID field. If the revision ID is:
n 12.01.020: The updated was successful. Move on to Step 5.
n A revision earlier than 12.01.020: Click the Refresh button again, to make sure the
page has updated.
n 12.00.028: The update has most likely failed. Review the device logs to determine why
the update was not successful.
n 12.91.028: The update may have partially succeeded or the update may still be in
progress. Review the device logs for more information.

Step 5: Finalize

1. Navigate to the Python auto-start page.
a. Click Devices in the left-hand pane and find your device.
b. Double-click on the device entry to display information about the device.
c. Click Settings in the toolbar.
d. On the right side of the page, click the Settings icon.
Method 1: Update the Telit modem firmware using Digi Remote
Manager
e. From the drop-down menu, click Config > Python auto-start.
2. Disable Python auto-start for the t_update.py script, as execution on boot will extend boot
times significantly by performing the module update queries.
a. Expand the t_update.py script Python script.
b. De-select the Python auto-start enable option.
3. Click Apply to save the changes.
4. Restore any settings or files changed while preparing to update.
5. Reboot the device.
a. Click Devices in the left-hand pane and find your device.
b. Click the check box next to the device.
c. Click Actions > Reboot to reboot the device.
6. Once the gateway has reconnected to Digi Remote Manager the new patch level should once
again be confirmed using the Find the modem revision procedure. The revision number for the
Telit firmware should be 12.01.020.
Digi ConnectPort®X4/X4H
11
Page 12
Step 3: Update the Telit modem firmware
7. If the update process succeeded it is safe to remove t_update.py and t_update.zip.
a. Click Devices in the left-hand pane and find your device.
b. Double-click on the device entry.
c. Click the Files tab.
d. Click the Python folder.
e. Click the check boxes next to the files that you want to delete: t_update.py and t_
update.zip
f. Click the Remove icon.
Method 2: Update the Telit modem firmware using a wired Ethernet

Method 2: Update the Telit modem firmware using a wired Ethernet connection

This section describes how to update the Telit modem firmware when a physical wired connection is available.
Prerequisites
n Digi ConnectPort X4H firmware version 2.26.0 (PN 82001536_W) or above installed
connection
n Python update application (PN 83000129)
n Wired Ethernet connection with access to the server ftp1.digi.com

Step 1: Install Python update application

The 83000129 archive contains two files: t_update.py and t_update.zip. These files must be placed in the Python application storage of the gateway.
1. Open a browser and navigate to the web interface of the gateway.
2. From the navigation pane on the left side of the page click Applications > Python.
3. Upload the t_update.py and t_update.zip files to the Python storage location.
Digi ConnectPort®X4/X4H
12
Page 13
Step 3: Update the Telit modem firmware
Method 2: Update the Telit modem firmware using a wired Ethernet
connection
4. In the Auto-start settings section, disable any Python applications set to run, as the update
process and these applications may interfere with each other.
Step 2:Manually run the update application
1. Telnet or SSH to gateway.
2. At the command prompt, type: python t_update.py
The script will run and report its progress to the terminal. There are two images on the module that it will query and update if necessary.
3. Success will be indicated in the output by the message “Firmware is at the latest version
12.01.020."

Step 3: Verify the update was successful

A successful update is verified in Step 2, above, as indicated in the output by the message “Firmware s at the latest version 12.01.020”.
You can use the process in Find the modem revision to verify the correct revision has been released.

Step 4: Remove update application

After you have verified that the update was successful, you should remove the update application.
1. Open a browser and navigate to the web interface of the gateway.
2. From the navigation pane on the left side of the page click Application > Python.
Digi ConnectPort®X4/X4H
13
Page 14
Step 3: Update the Telit modem firmware
3. Select the checkboxes for t_update.py and t_update.zip.
4. Click Delete.
Method 2: Update the Telit modem firmware using a wired Ethernet
connection
Digi ConnectPort®X4/X4H
14
Loading...