Sierra Wireless AirPrime User manual

AirPrime GNSS Tool
User Guide
41111068
Rev 5.0

User Guide
Rev 5.0 Apr.20 2 41111068
Important
Notice
Due to the nature of wireless communications, transmission and reception of data
can never be guaranteed. Data may be delayed, corrupted (i.e., have errors) or be
totally lost. Although significant delays or losses of data are rare when wireless
devices such as the Sierra Wireless product are used in a normal manner with a
well-constructed network, the Sierra Wireless product should not be used in
situations where failure to transmit or receive data could result in damage of any
kind to the user or any other party, including but not limited to personal injury,
death, or loss of property. Sierra Wireless accepts no responsibility for damages
of any kind resulting from delays or errors in data transmitted or received using
the Sierra Wireless product, or for failure of the Sierra Wireless product to
transmit or receive such data.
Safety and
Hazards
Do not operate the Sierra Wireless product in areas where blasting is in progress,
where explosive atmospheres may be present, near medical equipment, near life
support equipment, or any equipment which may be susceptible to any form of
radio interference. In such areas, the Sierra Wireless product MUST BE
POWERED OFF. The Sierra Wireless product can transmit signals that could
interfere with this equipment.
Do not operate the Sierra Wireless product in any aircraft, whether the aircraft is
on the ground or in flight. In aircraft, the Sierra Wireless product MUST BE
POWERED OFF. When operating, the Sierra Wireless product can transmit
signals that could interfere with various onboard systems.
Note: Some airlines may permit the use of cellular phones while the aircraft is on the
ground and the door is open. Sierra Wireless products may be used at this time.
The driver or operator of any vehicle should not operate the Sierra Wireless
product while in control of a vehicle. Doing so will detract from the driver or
operator's control and operation of that vehicle. In some states and provinces,
operating such communications devices while in control of a vehicle is an offence.
Limitation of
Liability
The information in this manual is subject to change without notice and does not
represent a commitment on the part of Sierra Wireless. SIERRA WIRELESS AND
ITS AFFILIATES SPECIFICALLY DISCLAIM LIABILITY FOR ANY AND ALL
DIRECT, INDIRECT, SPECIAL, GENERAL, INCIDENTAL, CONSEQUENTIAL,
PUNITIVE OR EXEMPLARY DAMAGES INCLUDING, BUT NOT LIMITED TO,
LOSS OF PROFITS OR REVENUE OR ANTICIPATED PROFITS OR REVENUE
ARISING OUT OF THE USE OR INABILITY TO USE ANY SIERRA WIRELESS
PRODUCT, EVEN IF SIERRA WIRELESS AND/OR ITS AFFILIATES HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES OR THEY ARE
FORESEEABLE OR FOR CLAIMS BY ANY THIRD PARTY.
Notwithstanding the foregoing, in no event shall Sierra Wireless and/or its
affiliates aggregate liability arising under or in connection with the Sierra Wireless
product, regardless of the number of events, occurrences, or claims giving rise to
liability, be in excess of the price paid by the purchaser for the Sierra Wireless
product.

Preface
Rev 5.0 Apr.20 3 41111068
Patents This product may contain technology developed by or for Sierra Wireless Inc. This
product is manufactured or sold by Sierra Wireless Inc. or its affiliates under one
or more patents licensed from MMP Portfolio Licensing.
Copyright © 2020 Sierra Wireless. All rights reserved.
Trademarks Sierra Wireless®, AirPrime®, AirLink®, AirVantage® and the Sierra Wireless logo
are registered trademarks of Sierra Wireless.
Windows® and Windows Vista® are registered trademarks of Microsoft
Corporation.
Other trademarks are the property of their respective owners.
Contact
Information
Revision
History
Sales information and technical
support, including warranty and returns
Web: sierrawireless.com/company/contact-us/
Global toll-free number: 1-877-687-7795
6:00 am to 5:00 pm PST
Corporate and product information Web: sierrawireless.com
Revision
number
Release date Changes
1.0 June 23, 2017 Creation
2.0 May 09, 2018 Added Download ROM on page 12
Updated:
•Instances of EPO to AGPS
•UI layout
3.0 November 06, 2018 Added support for XA12xx and XM1210
4.0 February 26, 2019 Overhauled Operation
5.0 April 08, 2020 Updated screenshots
Added support for XS1110 and XP2210
Removed support for Google Map
Revised AGPS to AGNSS

Rev 5.0 Apr.20 4 41111068
Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
USB Driver Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Main Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Initial Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
File Menu and Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Open and Close Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Recording NMEA Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Load NMEA Log (NMEA Stream) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
RTCM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Download ROM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Firmware Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
Download AGNSS Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
DR Sensor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Recording Debug Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
EPH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Simple Restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Google Earth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
View Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Command Tx and Rx List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
NMEA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
CNR Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Sky View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
Statistics Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
CEP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34
Satellite Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Quick Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
Raw Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
TTFF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Arrangement of Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Target Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44

Rev 5.0 Apr.20 5 41111068
1
1: Introduction
The GNSS tool is a graphic user interface (GUI) to be used with XA11xx, XA12xx,
XM11xx and XM12xx GNSS modules.
This GUI allows you to monitor GNSS information and execute commands to the
module for analysis and toadjust settings for the listed features.
System Requirements
•Microsoft Windows OS
·Windows 7 (32-bit and 64-bit)
·Windows 8 (64-bit)
·Windows 10 (32-bit and 64-bit)
•Microsoft .NET Framework 4.6
•Microsoft Visual C++ 2015 Redistributable Package (x86)

Rev 5.0 Apr.20 6 41111068
2
2: Operation
USB Driver Installation
Before setting up the connection, please make sure the proper driver is installed in
your PC. For Sierra Wireless’ Development Kit, please download the VCP driver
(CP210x USB to UART Bridge VCP Drivers) from https://source.sierrawireless.com/
resources/airprime/software/cp210x-windows-drivers/.
If the Development Kit you use is not from Sierra Wireless, please make sure you
have the appropriate driver.
XA12xx and XM12xx USB driver (not location sensor driver) installation is optional.
USB drivers can be downloaded from:
•https://source.sierrawireless.com/resources/airprime/software/xm-xa12xx-usb-
driver---boot-mode
•https://source.sierrawireless.com/resources/airprime/software/xm-xa12xx-usb-
driver---user-mode
Main Screen
When the GNSS Tool software is launched, you will see the screen below.
Figure 2-1: Main Program Screen

Operation
Rev 5.0 Apr.20 7 41111068
Initial Setup
After the Development Kit and PC are connected, the first step is to set up the
COM port and baud rate.
1. Click the combo box at the bottom of the screen to select either COM Port or
USB Port.
2. Select the port number of the Development Kit.
3. Select the baud rate of the Development Kit. (You don’t need to select the
baud rate if you’ve previously selected USB port in step 1.)
File Menu and Toolbar
Open and Close Communication
Click the cable button on the toolbar to open communication.
Figure 2-2: Cable Button
To disconnect signal reception, click the cable button again.
If using a USB connection with the XA12xx or XM12xx, ensure that the firmware
version indicated in the lower left corner of the window is correct. If the firmware
version is not detected, reconnect the Development Kit and PC.
Figure 2-3: Series Model and Firmware Version on the Status Bar
Note: Click the port combo box again to refresh the port list.

User Guide
Rev 5.0 Apr.20 8 41111068
Recording NMEA Stream
The GNSS tool allows you to record NMEA sentences. There are two ways to do
so:
1. Click the recording button on the toolbar:
or
2. Click Start Recording NMEA on the File dropdown menu:
Once Start Recording NMEA or the recording button is clicked, a dialog will pop
up allowing you to save the file in the desired directory. Click the Save button and
the recording button will change to , to show that recording is in progress.
To stop recording, click the recording button again, or click Stop Recording
NMEA on the File dropdown menu.

Operation
Rev 5.0 Apr.20 9 41111068
Load NMEA Log (NMEA Stream)
To review the recorded NMEA log:
1. Click the folder button from the toolbar:
or
2. Click Load NMEA Log from the File dropdown menu:
Once Load NMEA Log or the folder button is clicked, a dialog will pop up
allowing you to choose the recorded NMEA file from the directory.
After the NMEA file is selected and loaded, the playback control bar will appear in
the toolbar area, as shown in Figure 2-4:
Figure 2-4: Playback Control Bar
: Play the NMEA sentences continuously.
: Play speed. The speed range is from 1 to 10.
: Pause the play.
: Stop the play (note that once the NMEA sentence is stopped from play-
ing, the file will start from the beginning when Play is clicked again).
: Jump to the indicated step and play it.
: Step counter. Displays the current step and total steps. In
this example the step comes from "XXGGA" in the loaded NMEA sentence.
The program will calculate the summation of the "XXGGA" in the loaded

User Guide
Rev 5.0 Apr.20 10 41111068
NMEA log file for the step reference. The program will also load every NMEA
sentence and display all information to the corresponding windows.
RTCM
Note: This feature is only available on the XA11xx and XM11xx.
The ntrip client function can connect to the specified ntrip caster and stream
RTCM. Before connecting to an ntrip caster, please set up the required
parameters properly.
Click the down arrow next to the RTCM button and click Settings.
Figure 2-5: RTCM Settings
The Ntrip Client Settings dialog is then displayed, as shown in Figure 2-5:
Figure 2-6: Ntrip Client Settings
• Ntrip Stream: if the computer has a connection to the Internet, the program
will download the source table automatically. You can also get the source
table manually by clicking the Get Source Table button. You must then
choose a proper stream which meets your RTCM version.
• Ntrip Caster: specifies the address and port number of the specified caster
with the authorized username and password to log in.
• Location: designates fixed location (latitude and longitude), or a dynamic
location which reads from the GPS location. Such location information will
send an ntrip caster to acquire more accurate RTCM-correct data.

Operation
Rev 5.0 Apr.20 11 41111068
• Serial Port: specifies the serial port and baud rate of the computer to output
the RTCM data to the GPS module.
After the set up is complete, click the RTCM button to start. You can observe the
screens marked by red rectangles as shown in Figure 2-7 to understand the
result.
Click the RTCM button again to disconnect streaming.
Figure 2-7: Fixed Quality after RTCM is Enabled
You can also launch a command prompt and input the "netstat —a" command to
monitor the status of a network connection as show in Figure 2-8. If the
connection is successful, the caster name and port number will be listed.
Figure 2-8: Status of a Network Connection

User Guide
Rev 5.0 Apr.20 12 41111068
Download ROM
This function allows you to update the firmware of the GNSS module. Click the
download button from the toolbar to display the Download ROM dialog.
Figure 2-9: Download Button
For XA11xx and XM11xx
The Download ROM dialog for XA11xx and XM11xx modules is shown in
Figure 2-10:
Figure 2-10: Download ROM Dialog for XA11xx and XM11xx
• Download Agent: choose a proper download agent binary file corresponding
to the model of the GNSS module.
Note: Once the GNSS tool is installed, the related DA files will be stored in the default
install directory.
• ROM: choose desired firmware file to download.
• COM Port: specify the COM port which connects to the GNSS module.
• Baud Rate: specify the baud rate of the COM port above for ROM
downloading.
• NMEA Baud Rate: Specify the baud rate of the COM port for NMEA output.
For example, if the baud rate is 115200bps for NMEA output before
downloading, then choose 115200 here.

Operation
Rev 5.0 Apr.20 13 41111068
Click the Download button to start downloading. Download Result will show
"Pass" or "Fail", depending on whether the download was successful or not.
Figure 2-11: Download Result for XA11xx and XM11xx
For XA12xx and XM12xx
The Download ROM dialog for XA12xx and XM12xx modules is shown in
Figure 2-12:
Figure 2-12: Download ROM Dialog for XA12xx and XM12xx
• ROM: choose desired firmware file to download.
• COM Port: specify the COM port which connects to the GNSS module.
• Baud Rate: specify the baud rate of the COM port above for ROM
downloading.
• Mode: mode (User Mode or Boot Mode) is automatically determined by the
tool.
Click the Download button to start downloading. Download Result will show
"Pass" or "Fail", depending on whether the download was successful or not.
When the update is completed, the module will automatically restart in User
Mode. If you are in Boot Mode, you have to press the reset button manually.

User Guide
Rev 5.0 Apr.20 14 41111068
Note that regardless of mode, when connected via USB, you must reconnect to
read NMEA normally.
Figure 2-13: Download Result for XA12xx and XM12xx

Operation
Rev 5.0 Apr.20 15 41111068
For XP2210 and XS1110
The Download ROM dialog for XP2210 and XS1110 modules is shown in
Figure 2-14.
Figure 2-14: Download ROM Dialog (For XP2210 and XS1110)
• FIRMWARE1: choose desired first firmware file to download.
• FIRMWARE2: choose desired second firmware file to download.
• FIRMWARE3: choose desired third firmware file to download.
• FIRMWARE4: choose desired fourth firmware file to download.
• USER BINARY: choose desired bin file to download.
• All use the same filename: if all of the four firmware have the same
filenames and file paths, you can select all of them at the same time by
selecting the first firmware and then selecting this check box.
• Erase firmware: Select this if you want to upgrade the firmware. If the
module is in BOOT mode, there is no need to select this.
Click the Run button to start downloading. Download Result will show "Pass" or
"Fail", depending on whether the download was successful or not. When the
update is completed, the module will automatically restart in User Mode. If you
are in Boot Mode, you have to press the reset button manually.

User Guide
Rev 5.0 Apr.20 16 41111068

Operation
Rev 5.0 Apr.20 17 41111068
Firmware Version
Clicking the FW Ver. button allows you to check the firmware version of the
Development Kit (when the PC and Development Kit are connected).
Figure 2-15: Firmware Version Button
Information is then displayed in the command window.
Figure 2-16: Firmware Version Information Example for XM / XA11xx
.
Firmware Version Information Example for XM / XA12xx

User Guide
Rev 5.0 Apr.20 18 41111068
.
Firmware Version Information Example for XP2210 / XS1110
Download AGNSS Data
This function obtains the desired period of AGNSS file from Sierra Wireless and
downloads it to the module to reduce the TTFF time.
To download AGNSS data:
1. Click the AGNSS button from the toolbar:
or
2. Click Download AGNSS Data from the File dropdown menu:

Operation
Rev 5.0 Apr.20 19 41111068
Once Download AGNSS Data or the AGNSS button is clicked, a dialog will pop up
allowing you to input the AGNSS FTP settings and select the desired period of
AGNSS data. Click Download or Start (for AGNSS) button to start downloading.
Note: For the XM / XA12xx series, you can do the TTFF test in the AGNSS window.
Figure 2-17: Download AGNSS Data Dialog Boxes

User Guide
Rev 5.0 Apr.20 20 41111068
Select the desired period of LLE data then click Run to start downloading.
Note: Get the expiration date by clicking the GET button.
Figure 2-18: Download LLE Data Dialog
DR Sensor
Note: This feature is only available on the XP2210.
This feature allows you to get the DR sensor details. Clicking on this menu item
will bring out a window with DR Sensor information.
To launch, click DR Sensor from the File dropdown menu: