location at command interface guide gpsone (2)
TRANSCRIPT
4111879
1.1
November 6, 2012
AirPrime SL808xT Built-In gpsOne
Location Library 1.4 AT Commands Interface User Guide
4111879 Rev 1.1 November 6, 2012 2
Location Library 1.4 AT Commands Interface User Guide
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 modem are used
in a normal manner with a well-constructed network, the Sierra Wireless modem 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 modem, or for failure of the Sierra Wireless modem to transmit or
receive such data.
Safety and Hazards
Do not operate the Sierra Wireless modem in areas where cellular modems are not advised without
proper device certifications. These areas include environments where cellular radio can interfere
such as explosive atmospheres, medical equipment, or any other equipment which may be
susceptible to any form of radio interference. The Sierra Wireless modem can transmit signals that
could interfere with this equipment. Do not operate the Sierra Wireless modem in any aircraft, whether
the aircraft is on the ground or in flight. In aircraft, the Sierra Wireless modem MUST BE POWERED
OFF. When operating, the Sierra Wireless modem 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 modems may be used at this time.
The driver or operator of any vehicle should not operate the Sierra Wireless modem 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.
Limitations of Liability
This manual is provided “as is”. Sierra Wireless makes no warranties of any kind, either expressed or
implied, including any implied warranties of merchantability, fitness for a particular purpose, or
noninfringement. The recipient of the manual shall endorse all risks arising from its use.
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.
Customer understands that Sierra Wireless is not providing cellular or GPS (including A-GPS)
services. These services are provided by a third party and should be purchased directly by the
Customer.
4111879 Rev 1.1 November 6, 2012 3
Location Library 1.4 AT Commands Interface User Guide
SPECIFIC DISCLAIMERS OF LIABILITY: CUSTOMER RECOGNIZES AND ACKNOWLEDGES
SIERRA WIRELESS IS NOT RESPONSIBLE FOR AND SHALL NOT BE HELD LIABLE FOR ANY
DEFECT OR DEFICIENCY OF ANY KIND OF CELLULAR OR GPS (INCLUDING A-GPS)
SERVICES.
Patents
This product may contain technology developed by or for Sierra Wireless Inc.
This product includes technology licensed from QUALCOMM®.
This product is manufactured or sold by Sierra Wireless Inc. or its affiliates under one or more patents
licensed from InterDigital Group.
Copyright
© 2012 Sierra Wireless. All rights reserved.
Trademarks
AirCard® is a registered trademark of Sierra Wireless. Sierra Wireless™, AirPrime™, AirLink™,
AirVantage™, Watcher™ and the Sierra Wireless logo are trademarks of Sierra Wireless.
, ®, inSIM®, WAVECOM®, WISMO®, Wireless Microprocessor®, Wireless CPU®, Open AT® are
filed or registered trademarks of Sierra Wireless S.A. in France and/or in other countries.
Windows® and Windows Vista® are registered trademarks of Microsoft Corporation.
Macintosh and Mac OS are registered trademarks of Apple Inc., registered in the U.S. and other
countries.
QUALCOMM® is a registered trademark of QUALCOMM Incorporated. Used under license.
Other trademarks are the property of the respective owners.
Contact Information
Sales Desk:
Phone: 1-604-232-1488
Hours: 8:00 AM to 5:00 PM Pacific Time
E-mail: [email protected]
Post:
Sierra Wireless
13811 Wireless Way
Richmond, BC
Canada V6V 3A4
Technical Support: [email protected]
RMA Support: [email protected]
Fax: 1-604-231-1109
Web: www.sierrawireless.com
Consult our website for up-to-date product descriptions, documentation, application notes, firmware
upgrades, troubleshooting tips, and press releases: www.sierrawireless.com
4111879 Rev 1.1 November 6, 2012 4
Location Library 1.4 AT Commands Interface User Guide
Document History
Version Date Updates
1.0 June 20, 2012 Creation document based on Location Library 1.51 for Open AT Application Framework AT Command Interface Guide (along with SiRF-GSD4t) and updated for AirPrime SL808xT built-in gpsOne.
1.1 November 6, 2012 New interface for the aid_event
4111879 Rev 1.1 November 6, 2012 5
Contents
CONTENTS ............................................................................................................... 5
1. INTRODUCTION .................................................................................................. 8
1.1. Purpose ............................................................................................................................. 8
1.2. Related Documents ........................................................................................................... 8
1.3. Abbreviations and Glossary .............................................................................................. 8
1.3.1. Abbreviations ............................................................................................................. 8
1.3.2. Glossary ..................................................................................................................... 9
2. USER GUIDE ..................................................................................................... 10
2.1. Restriction of Use ............................................................................................................ 10
2.2. Features .......................................................................................................................... 10
2.3. AT command sequence to start Location Services ......................................................... 10
2.3.1. Factory default configuration .................................................................................... 10
2.3.2. AT command sequence ........................................................................................... 11
2.3.3. Example of start sequence ....................................................................................... 11
2.4. GPS receiver specific capabilities and restrictions .......................................................... 11
2.4.1. AirPrime SL808x gpsOne ......................................................................................... 12
3. LOCATION SERVICES STATES ....................................................................... 14
3.1. State Machine.................................................................................................................. 14
3.2. AT Commands Calls Requirements ................................................................................ 14
4. AT COMMAND SYNTAX ................................................................................... 16
4.1. Command Line ................................................................................................................ 16
4.2. Information Responses and Result Codes ...................................................................... 16
5. AT COMMANDS REFERENCE .......................................................................... 17
5.1. Command +GPSHELP .................................................................................................... 17
5.1.1. Description ............................................................................................................... 17
5.1.2. Syntax ...................................................................................................................... 17
5.1.3. Parameters and Defined Values .............................................................................. 17
5.1.4. Examples .................................................................................................................. 17
5.2. Command +GPSNMEA ................................................................................................... 18
5.2.1. Description ............................................................................................................... 18
5.2.2. Syntax ...................................................................................................................... 18
5.2.3. Parameters and Defined Values .............................................................................. 19
5.2.4. Examples .................................................................................................................. 20
5.3. Command +GPSSAVE .................................................................................................... 21
5.3.1. Description ............................................................................................................... 21
5.3.2. Syntax ...................................................................................................................... 21
5.3.3. Parameters and Defined Values .............................................................................. 21
5.3.4. Examples .................................................................................................................. 22
4111879 Rev 1.1 November 6, 2012 6
Location Library 1.4 AT Commands Interface User Guide
5.3.5. Diagram for settings management ........................................................................... 22
5.4. Command +GPSSTART ................................................................................................. 23
5.4.1. Description ............................................................................................................... 23
5.4.2. Syntax ...................................................................................................................... 23
5.4.3. Parameters and Defined Values .............................................................................. 24
5.4.4. Examples .................................................................................................................. 24
6. ADVANCED AT COMMANDS REFERENCE .................................................... 25
6.1. Command +GPSSTATE .................................................................................................. 25
6.1.1. Description ............................................................................................................... 25
6.1.2. Syntax ...................................................................................................................... 25
6.1.3. Parameters and Defined Values .............................................................................. 25
6.1.4. Examples .................................................................................................................. 26
6.2. Command +GPSINIT ...................................................................................................... 26
6.2.1. Description ............................................................................................................... 26
6.2.2. Syntax ...................................................................................................................... 26
6.2.3. Parameters and Defined Values .............................................................................. 27
6.2.4. Examples .................................................................................................................. 27
6.2.5. Hardware Configuration ........................................................................................... 27
6.3. Command +GPSSTOP ................................................................................................... 28
6.3.1. Description ............................................................................................................... 28
6.3.2. Syntax ...................................................................................................................... 28
6.3.3. Parameters and Defined Values .............................................................................. 28
6.3.4. Examples .................................................................................................................. 29
6.4. Command +GPSSLEEP .................................................................................................. 29
6.4.1. Description ............................................................................................................... 29
6.4.2. Syntax ...................................................................................................................... 29
6.4.3. Parameters and Defined Values .............................................................................. 30
6.4.4. Examples .................................................................................................................. 30
6.5. Command +GPSTTFF .................................................................................................... 30
6.5.1. Description ............................................................................................................... 30
6.5.2. Syntax ...................................................................................................................... 31
6.5.3. Parameters and Defined Values .............................................................................. 31
6.5.4. Examples .................................................................................................................. 31
6.6. Command +GPSRELEASE ............................................................................................ 32
6.6.1. Description ............................................................................................................... 32
6.6.2. Syntax ...................................................................................................................... 32
6.6.3. Parameters and Defined Values .............................................................................. 32
6.6.4. Examples .................................................................................................................. 33
6.7. Command +GPSVERS ................................................................................................... 33
6.7.1. Description ............................................................................................................... 33
6.7.2. Syntax ...................................................................................................................... 33
6.7.3. Parameters and Defined Values .............................................................................. 33
6.7.4. Examples .................................................................................................................. 34
6.8. Command +GPSCONF ................................................................................................... 34
6.8.1. Description ............................................................................................................... 34
4111879 Rev 1.1 November 6, 2012 7
Location Library 1.4 AT Commands Interface User Guide
6.8.2. Syntax ...................................................................................................................... 34
6.8.3. Parameters and Defined Values .............................................................................. 35
6.8.4. Location service configuration restrictions ............................................................... 35
6.8.5. Examples .................................................................................................................. 36
6.9. Command +GPSAID ....................................................................................................... 36
6.9.1. Foreword .................................................................................................................. 36
6.9.2. Description ............................................................................................................... 36
6.9.3. Syntax ...................................................................................................................... 37
6.9.4. Parameters and Defined Values .............................................................................. 38
6.9.5. Aiding Service Configuration Restrictions ................................................................ 39
6.9.6. Examples .................................................................................................................. 40
6.9.7. Examples of AT Command Sequence ..................................................................... 40
6.10. Command +GPSCORE ................................................................................................... 41
6.10.1. Description ............................................................................................................... 41
6.10.2. Syntax ...................................................................................................................... 41
6.10.3. Parameters and Defined Values .............................................................................. 42
7. ASYNCHRONOUS EVENTS .............................................................................. 43
7.1. Description ....................................................................................................................... 43
7.2. Syntax .............................................................................................................................. 43
7.3. Parameters and Defined Values ..................................................................................... 45
8. LOCATION AT COMMANDS ERROR CODES ................................................. 46
INDEX ...................................................................................................................... 47
4111879 Rev 1.1 November 6, 2012 8
1. Introduction
The following subsections present introductory information regarding the Location AT Commands.
1.1. Purpose
This document provides Sierra Wireless customers with a full description of the AT Commands for
Location Services, available when using the AirPrime SL808xT built-in gpsOne.
1.2. Related Documents
[1] Open AT Framework AT Commands Interface Guide for Firmware 7.50.A1 for AirPrime
SL808xT
Reference: 4112152
[5] AirPrime – SL808xT - Product Technical Specification & Customer Design Guidelines
Reference: 2400058
1.3. Abbreviations and Glossary
1.3.1. Abbreviations
Abbreviation Definition
CW Continuous Waveform
DR Dead Reckoning
ECEF Reference used in GNSS is called Earth-Centered, Earth-Fixed (ECEF)
GPIO General Purpose Input Output
GPS Global Positioning System
HW Hardware
ID Identifier
IO Input/Output
KF Kalman Filter
LNA Low-Noise Amplifier
LSQ Least SQuare (approximation)
NMEA National Marine Electronics Association standard
NV Non-Volatile
PPS Pulse-Per-Second
PVT The primary GPS outputs: Position, Velocity, Time
TTFF Time To First Fix
UTC Coordinated Universal Time
4111879 Rev 1.1 November 6, 2012 9
Location Library 1.4 AT Commands Interface User Guide
1.3.2. Glossary
1.3.2.1. Embedded Module
Sierra Wireless’ AirPrime Embedded Module running OS, on which Location AT commands are
executed.
1.3.2.2. gpsOne GPS module
QCT built-in GPS module.
1.3.2.3. NMEA sentences
The National Marine Electronics Association (NMEA) standard defines an electrical interface and data
protocol for communications between marine instrumentation. The NMEA-0183, scope of this
document, defines a set of frame prefixed by $GP and concerning Global Positioning System.
For more details about NMEA standards, please refer to http://www.nmea.org/.
1.3.2.4. WGS 84
The World Geodetic System is a standard for use in cartography, geodesy, and navigation. The latest
revision is WGS 84 (dating from 1984 and last revised in 2004).
4111879 Rev 1.1 November 6, 2012 10
2. User Guide
This section provides introduction and high level description of the Location Services features and AT
command set.
2.1. Restriction of Use
The use of the Location AT software described in this document is strictly limited to the use in
combination with the Sierra Wireless AirPrime SL808xT embedded module. Use of this software to
operate or enable any other position-fix or location hardware is prohibited. Please contact a Sierra
Wireless representative in case of any question or concerns.
2.2. Features
The Location AT command set extends the AirPrime™ Intelligent Embedded Module command set to
allow users to:
Control the Location feature and GPS receiver.
Get the NMEA frames on a specified port (UART1, UART2, or USB), configure the NMEA
rate and select the NMEA sentences.
Modify and save the default configuration, including default GPS receiver hardware
configuration if needed.
Get the TTFF value.
2.3. AT command sequence to start Location Services
2.3.1. Factory default configuration
The default configuration used by the application is:
Configuration Factory default value How to change it?
Hardware configuration
Refer to document [5] for complete information.
Also refer to the command +GPSINIT for more information. AT+GPSINIT command
NMEA mode
UART number 1
All supported NMEA frames are displayed
1 second NMEA frames update
AT+GPSNMEA command
Starting Mode “HOT” start with all previous NV stored data. AT+GPSSTART command
To start the Location Services for the first time, if you don’t use the default settings you must specify
your settings through the advanced AT commands described in this document.
For more information about factory default settings, please refer to +GPSSAVE AT command.
4111879 Rev 1.1 November 6, 2012 11
Location Library 1.4 AT Commands Interface User Guide
2.3.2. AT command sequence
The AT command sequence to type to start receiving NMEA frames on the specified port is:
1. AT+WOPEN=1 (activate AT command extension set. Needed only the first time).
2. AT+GPSINIT=<hw> (only if the Factory default hardware configuration must be changed,
specifies the GPS receiver hardware type or the hardware configuration on which the
application will be run).
3. AT+GPSNMEA=<output> (only if the Factory default configuration should be changed)
4. AT+GPSSTART (Starts the GPS).
After few seconds, NMEA frames will be received every second on the requested port.
You can then type AT+GPSSAVE=1 to save the current setting configured through AT commands
(+GPSINIT, +GPSSTART, +GPSNMEA…), and, make sure that the application automatically restarts
to reach the same state with same settings when the Embedded Module is reset.
2.3.3. Example of start sequence
2.3.3.1. Start sequence for the default configuration (e.g. SL808x + gpsOne-Gen7)
AT+GPSSTART
OK
+GPSEVINIT: 1
+GPSEVSTART: 1
+GPSEVPOS: 0
$GPGGA,160254.000,4849.9404,N,00216.0929,E,1,09,0.9,61.8,M,47.3,M,,*68
$GPRMC,160254.000,A,4849.9404,N,00216.0929,E,0.0,68.6,110412,,,A*5A
$GPGSA,A,3,09,12,15,17,18,22,26,27,28,,,,1.7,0.9,1.4*32
$GPVTG,68.6,T,,M,0.0,N,0.0,K,A*35
$GPGSV,3,1,10,09,54,282,45,15,77,222,44,17,30,090,44,18,32,282,41*74
$GPGSV,3,2,10,22,12,321,37,26,39,136,38,27,76,313,44,28,32,049,42*7A
$GPGSV,3,3,10,12,24,211,36,24,43,295,00*75
…
2.4. GPS receiver specific capabilities and restrictions
The features supported by the Location Services may depend on the GPS receiver type. The
following sections provide the GPS receiver specificities.
4111879 Rev 1.1 November 6, 2012 12
Location Library 1.4 AT Commands Interface User Guide
2.4.1. AirPrime SL808x gpsOne
2.4.1.1. Supported NMEA Sentences
The following NMEA sentences are provided by the GPS receiver:
$GPGGA (GPS Fix Data)
$GPGSA (GNSS DOPS and Active Satellites)
$GPRMC (Recommended Minimum GNSS Sentence)
$GPVTG (Course Over Ground and Ground Speed): Magnetic course (field #3) is not
available, left empty
$GPGSV (GNSS Satellites in View)
2.4.1.2. Restriction on use of Embedded Module AT commands
2.4.1.3. Start-up time
The startup time is the duration between the +GPSSTART command and the +GPSEVSTART event.
After the +GPSEVSTART event, the Location Service has been correctly started, GPS receiver
hardware and software resources are activated, and GPS acquisition phase is starting.
The startup time includes the GPS receiver firmware download time if applicable.
2.4.1.4. Starting mode
Starting modes are used only for test purposes and allow start performance measurement.
The Start mode parameter is specified for each start using the +GPSSTART AT command. Please
refer to +GPSSTART AT command for more information.
The following table describes minimum required data for each starting mode:
Starting mode Broadcasted Ephemeris
Approximate Time and Position
Almanac Calibration Data
HOT X X Updated X
WARM X Updated X
COLD Updated X
FACTORY Factory X
Note: Ephemeris data (Broadcasted) are used if data are available and valid. For example, a hot start performed without broadcasted ephemeris will be treated as a warm star
The following table describes supported starting mode(s) from each Location Services application
state:
4111879 Rev 1.1 November 6, 2012 13
Location Library 1.4 AT Commands Interface User Guide
Description From INITIALIZED state
From SLEEP state/ IDLE mode
From SLEEP state /HIBERNATE mode
From SLEEP state /DEEP SLEEP mode
Supported start performances
HOT
WARM
COLD
FACTORY
HOT
WARM
COLD
FACTORY
HOT
WARM
COLD
FACTORY
HOT
WARM
COLD
FACTORY
2.4.1.5. GPS data management
GPS Data are required to improve next GPS start performances. GPS data are mainly made up of:
Ephemeris data (Broadcasted)
Time and Position
Broadcasted Almanac
Calibration data
GPS Data are stored to NV memory (Embedded Module NVRAM) in the following transition(s):
Location Library state transition GPS Data stored to NV memory
UNINITIALIZED to INITIALIZED state (+GPSINIT) N/A
INITIALIZED to UNINITIALIZED state (+GPSRELEASE) N/A
INITIALIZED to RUNNING state (+GPSSTART) N/A
RUNNING to INITIALIZED state (+GPSSTOP) YES
RUNNING to SLEEP/IDLE state (+GPSSLEEP=0) NO
RUNNING to SLEEP/HIBERNATE state (+GPSSLEEP=1) YES
RUNNING to SLEEP/DEEP SLEEP state (+GPSSLEEP=2) YES
Note: Please refer State Machine for more information about state transitions.
4111879 Rev 1.1 November 6, 2012 14
3. Location Services States
This section provides information of the Location Services states, their transitions and allowed AT
commands for each state.
3.1. State Machine
Below is a diagram of states and transitions of the Location Services application.
GPS_UNINITIALIZED
GPS_INITIALIZED
AT+GPSINIT
+GPSEVINIT: 1
Airprime Embedded Module Power On / Reset
GPS_RUNNING
AT+GPSSTART
+GPSEVSTART: 1
AT+GPSSLEEP
+GPSEVSLEEP: 1
AT+GPSSTOP
+GPSEVSTOP: 1
AT+GPSRELEASE
+GPSEVRELEASE: 1
+GPSEVAAAA: Event that triggers the transition
AT+GPSXXXX : AT command initially called by the user
GPS_SLEEP
AT+GPSSTOP
+GPSEVSTOP: 1
AT+GPSSTART
+GPSEVSTART: 1
+GPSEVABORT:
AT+GPSSTART
+GPSEVINIT: 1
+GPSEVSTART: 1
Quick start with default configuration
Figure 1. Location Services state diagram
Note: “GPSEVXXXX: 0” events are not represented, as they do not trigger any state transition.
3.2. AT Commands Calls Requirements
The following table shows the prerequisites when using the Location AT commands.
‘X’ means the AT Command is authorized in the corresponding state.
‘-’ means the AT Command is NOT authorized in the corresponding state.
Table 1: Location AT commands prerequisites
Function
GP
S_
UN
INIT
IAL
IZE
D
GP
S_
INIT
IAL
IZE
D
GP
S_
RU
NN
ING
GP
S_
SL
EE
P
AT+GPSINIT X - - -
4111879 Rev 1.1 November 6, 2012 15
Location Library 1.4 AT Commands Interface User Guide
Function
GP
S_
UN
INIT
IAL
IZE
D
GP
S_
INIT
IAL
IZE
D
GP
S_
RU
NN
ING
GP
S_
SL
EE
P
AT+GPSSTART X X - X
AT+GPSSTOP - - X X
AT+GPSRELEASE - X - -
AT+GPSSLEEP - - X -
AT+GPSCONF - X X* X*
AT+GPSSTATE X X X X
AT+GPSVERS X X X X
AT+GPSNMEA - X X X
AT+GPSTTFF - X X X
AT+GPSSAVE X X X X
AT+GPSDEBUG - X X X
AT+GPSHELP X X X X
* Some configurations cannot be set in this state. See the +GPSCONF command section for more information.
4111879 Rev 1.1 November 6, 2012 16
4. AT Command Syntax
This section describes the AT command format and the default value for their parameters.
4.1. Command Line
Commands always start by the standard prefix “AT+GPS” and end with the <CR> character. Optional
parameters are shown in brackets [ ].
Example:
AT+GPScmd=<Param1>[,<Param2>]
<Param2> is optional. When the AT+GPScmd is executed without <Param2> the default value of
<param2> is used.
Default value is the last configured parameter or the last saved parameter value after the Embedded
Module reset or factory default value if parameters were not saved.
The factory default configuration can be changed with +GPSSAVE Command.
4.2. Information Responses and Result Codes
Responses start and end with <CR><LF>.
If command syntax is incorrect, the "ERROR" string is returned.
If command syntax is correct but transmitted with wrong parameters, the "+GPS ERROR:
<Err>" string is returned with adequate error codes. Please refer to Location AT commands
error codes description for more details about error code values.
If the command line has been executed successfully, an "OK" string is returned.
In the following examples <CR> and <CR><LF> are intentionally.
Note: The unsolicited AT command responses are sent through the AT port.
4111879 Rev 1.1 November 6, 2012 17
5. AT Commands Reference
The following AT commands allow the control of Location Services for basic operation.
5.1. Command +GPSHELP
5.1.1. Description
This AT Command is used to display the Location AT commands help.
Note: +GPSHELP command syntax is subject to change with application evolution.
5.1.2. Syntax
Action command
AT+GPSHELP=[<at_command>]
OK
Test command
AT+GPSHELP=?
+GPSHELP: (list of supported <at_command>s)
OK
5.1.3. Parameters and Defined Values
<at_command >: The string parameter specifies the AT command described by help display.
5.1.4. Examples
Command Responses
AT+GPSHELP
Note: displays all supported Location Services AT command format.
+GPSINIT= <hw>[,<spi>,<cs>,<reset>,<enable>,
<clock32k>]
…
OK
4111879 Rev 1.1 November 6, 2012 18
Location Library 1.4 AT Commands Interface User Guide
Command Responses
AT+GPSHELP=GPSSTART
Note: displays information about the +GPSINIT AT command.
+GPSSTART=[<starting_mode>]
<starting_mode>: 0 [GPS_HOT_START]
<starting_mode>: 1 [GPS_WARM_START]
<starting_mode>: 2 [GPS_COLD_START]
<starting_mode>: 3 [GPS_FACTCOLD_START]
OK
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT commands error codes description.
AT+GPSHELP=?
Note: displays all supported Location AT command.
+GPSHELP:
(GPSINIT,GPSNMEA,GPSSTART,GPSSTOP,GPSSTATE,GPSTTFF,GPSS
AVE, etc.)OK
5.2. Command +GPSNMEA
5.2.1. Description
This AT command configures the NMEA frames flow, the output port and the NMEA sentences
encode mask.
The list of supported NMEA frames depends on the GPS receiver. Please refer to 2.4 for more details.
Please refer to the State Machine and AT Commands Calls Requirements for more information about
call state and transition mode.
Note: NMEA sentences are output as unsolicited AT command responses. In consequence, in case the output port is not dedicated but shared with AT commands, NMEA frames output will be suspended while an AT command is being processed, and resume once the AT command has returned. In case of significant delay, some NMEA sentences may be partially or totally lost.
5.2.2. Syntax
Action command
AT+GPSNMEA=[<output>][,[<rate>][,<nmea_mask>]]
OK
4111879 Rev 1.1 November 6, 2012 19
Location Library 1.4 AT Commands Interface User Guide
Read command
AT+GPSNMEA?
+GPSNMEA: <output>,<rate>,<nmea_mask>
OK
Test command
AT+GPSNMEA=?
+GPSNMEA: (list of supported <output>s),(list of supported <rate>s), (list
of supported <nmea_mask>s)
OK
5.2.3. Parameters and Defined Values
<output>: This parameter specifies the port which is to be used by the application to transmit the NMEA frames. (Hexadecimal value entered without the prefix “0x”). This port can also be used simultaneously as the PVT sentences output port if need be.
If omitted: last known value within current session. Please refer to Diagram for settings management for more information.
Factory default value: 1.
0 NMEA frames are not output.
1 NMEA frames output on UART 1.
2 NMEA frames output on UART 2.
3 NMEA frames output on USB.
<rate>: This parameter defines the NMEA frames update rate in seconds.
If omitted: last known value within current session. Please refer to Diagram for settings management for more information.
Factory default value: 1.
Range: 0-65535
Note: If this parameter is equal to 0, the NMEA frames will be sent only once, on the next occurrence of the NMEA frames update.
<nmea_mask>: NMEA sentences list encode mask (Hexadecimal value entered without the prefix “0x”).
This parameter defines the NMEA sentences encode mask as described hereunder.
If omitted: last known value within current session. Please refer to Diagram for settings management for more information.
Factory default value: 0xFFFF.
Range: 0x0-0xFFFF
Note: All NMEA frames may not be supported depending on GPS receiver type. Refer to 2.4.1.1 for more information.
0: GPS_NMEA_NONE_EN - All NMEA frames output are disabled
4111879 Rev 1.1 November 6, 2012 20
Location Library 1.4 AT Commands Interface User Guide
(1 << 0): GPS_NMEA_GGA_EN - NMEA $GPGGA (GPS Fix Data) output enabled
(1 << 1): GPS_NMEA_GGSA_EN - NMEA $GPGSA (GNSS DOPS and Active Satellites) output enabled.
(1 << 2): GPS_NMEA_RMC_EN - NMEA $GPRMC (Recommended Minimum GNSS Sentence) output enabled.
(1 << 3): GPS_NMEA_VTG_EN - NMEA $GPVTG (Course Over Ground and Ground Speed) output enabled.
(1 << 6): GPS_NMEA_GSV_EN - NMEA $GPGSV (GNSS Satellites in View) output enabled.
0xFFFF: GPS_NMEA_ALL_EN - ALL NMEA frames output supported by the GPS receiver are enabled.
5.2.4. Examples
Command Responses
AT+GPSNMEA=1 Note: request NMEA frames output on port 1).
OK
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT commands error codes description.
AT+GPSNMEA=1,5 Note: request NMEA frames output on port 1 (1) with an update rate of 5 seconds.
OK
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT commands error codes description.
AT+GPSNMEA=1,1,FFFF Note: request all NMEA frames output on port 1 (1) with an update rate of 1 second.
OK
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT commands error codes description.
AT+GPSNMEA=?
+GPSNMEA: (0-4,11-14,21-24),(0-65535),(0-FFFF)
OK
AT+GPSNMEA? Note: Allow to retrieve the current default configuration.
+GPSNMEA: 1,1,FFFF
OK
4111879 Rev 1.1 November 6, 2012 21
Location Library 1.4 AT Commands Interface User Guide
5.3. Command +GPSSAVE
5.3.1. Description
The current setting is stored in FLASH memory as the new default settings when the command
+GPSSAVE=1 is entered. All the parameters of +GPS AT commands are saved. These settings will
be used after each Embedded Module reset as default configuration.
If the user wants the application to retrieve the default factory configuration (refer to each AT
command description), the command AT+GPSSAVE = 0 should be given and the Embedded Module
should be reset.
The application state (Please refer to State Machine for more information) is also saved as default
configuration and used at the start (after the Embedded Module reset) to put the application in this
state. This configuration is used for the automatic start.
Please refer to Diagram for settings management for more information.
5.3.2. Syntax
Action command
AT+GPSSAVE= <mode>
OK
Read command
AT+GPSSAVE?
+GPSSAVE:<mode>
OK
Test command
AT+GPSSAVE=?
+GPSSAVE: (list of supported <mode>s)
OK
5.3.3. Parameters and Defined Values
<mode>: Saving mode.
0 The application should reset all settings to their factory default values for the next Embedded Module reset.
1 The application should save the current settings as new default settings. If the Embedded Module is reset, the application uses these settings at restart.
4111879 Rev 1.1 November 6, 2012 22
Location Library 1.4 AT Commands Interface User Guide
5.3.4. Examples
Command Responses
AT+GPSSAVE? +GPSSAVE: 0
OK
Note: 0 if no saved settings or 1 if settings have been saved.
AT+GPSSAVE=1
Note: The current settings are saved.
OK
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT commands error codes description.
AT+GPSSAVE=?
+GPSSAVE: (0-1)
OK
5.3.5. Diagram for settings management
The following diagram describes the Location AT application settings management:
Factory Default values are
applied
+GPSSAVE: 0
(NO)
+GPSSAVE?
(Does Location Application
Flash Object exist?)
Last know values within
current session
Location AT application
started
Values modified through
Location AT command
Last stored values when
+GPSSAVE command has
been enterred
+GPSSAVE: 1
(YES)
Values modified through
Location AT command
AT+GPSSAVE=0
Location Library Flash object
deleted
Values of current session
saved in Location Library
Flash object
AT+GPSSAVE=1
AirPrime Embedded Module Power On / Reset
Impact on
next start
Impact on
next start
Note: The factory default values are described for each field in tables describing Location AT commands.
Note: If +GPSSAVE already equals 1 and a setting is modified through an AT command (for example +GPSCONF), the modified setting is not saved until the +GPSSAVE=1 command is entered.
4111879 Rev 1.1 November 6, 2012 23
Location Library 1.4 AT Commands Interface User Guide
Note: The configuration of current session can be retrieved with the read command of each +GPS AT command, for example AT+GPSCONF?.
5.4. Command +GPSSTART
5.4.1. Description
This AT command starts the GPS or restarts the GPS after the +GPSSTOP or +GPSSLEEP
command. The input parameter specifies the type of START command
When AT+GPSSTART (without parameter) is entered, the GPS start with the default mode is selected
by default.
OK is returned if the request has been processed. The final result will be sent to the associated event
through an unsolicited response after the action has been completed.
Please refer to the State Machine and AT Commands Calls Requirements for more information about
call state and transition mode.
5.4.2. Syntax
Action command
AT+GPSSTART= [<starting_mode>]
OK
Read command
AT+GPSSTART?
+GPSSTART:<starting_mode>
OK
Test command
AT+GPSSTART=?
+GPSSTART: (list of supported <starting_mode>s)
OK
4111879 Rev 1.1 November 6, 2012 24
Location Library 1.4 AT Commands Interface User Guide
Unsolicited response
+GPSEVSTART: <status>
5.4.3. Parameters and Defined Values
<starting_mode>: The parameter specifies the GPS starting mode of the application. These
starting modes are used for test purposes.
If omitted: last known value within current session. Please refer to Diagram for settings management for more information.
Factory default value: 0.
0 "HOT" start with all previous NV stored data.
1 “WARM" start with previous NV stored data except Broadcasted Ephemeris.
2 "COLD" start with NO previous NV store data except calibration data, updated Almanac. Time and last location are unknown.
3 "FACTCOLD" start with Factory Default Data instead of previous run data.
<status> Event status
0 The action has failed. Application state is unchanged.
1 The action has been successfully completed.
Note: Please refer to Starting mode for more information about starting modes.
Note: GPS Data are stored to NV memory during specific Location Services Application transition. Please refer to GPS data management for more information.
5.4.4. Examples
Command Responses
AT+GPSSTART? +GPSSTART: 0
OK
Note: The current starting mode is the “HOT” start.
AT+GPSSTART=1 Note: Starts GPS in WARM mode.
OK
+GPSEVSTART: 1
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT commands error codes description.
AT+GPSSTART=?
+GPSSTART: (0-3)
OK
4111879 Rev 1.1 November 6, 2012 25
6. Advanced AT Commands Reference
The following specific AT commands are defined to finely control and monitor the Location Services.
These commands can be used to assess performances of the system.
6.1. Command +GPSSTATE
6.1.1. Description
This AT command returns the current application state.
Please refer to the State Machine and AT Commands Calls Requirements for more information about
call state and transition mode.
6.1.2. Syntax
Read command
AT+GPSSTATE?
+GPSSTATE:<state>
OK
Test command
AT+GPSSTATE=?
OK
6.1.3. Parameters and Defined Values
<state>: Application state as described below
0 Application is in GPS_UNINITIALIZED state 1.
1 Application is in GPS_INITIALIZED state 2.
2 Application is in GPS_RUNNING state 3.
3 Application is in GPS_SLEEP state 4.
4111879 Rev 1.1 November 6, 2012 26
Location Library 1.4 AT Commands Interface User Guide
6.1.4. Examples
Command Responses
AT+GPSSTATE? +GPSSTATE: 0
OK
AT+GPSSTATE=? OK
6.2. Command +GPSINIT
6.2.1. Description
This AT command initializes the Location Services. It is accepted only if application is in
GPS_UNINITIALIZED state. It allows specifying the hardware setup of the system.
If this command is omitted, last saved hardware setup is used. If no hardware setup was saved,
default factory configuration is used.
Please refer to the State Machine and AT Commands Calls Requirements for more information about
call state and transition mode.
OK is returned if the request has been processed. The final result will be sent to the associated event
through an unsolicited response after the request has been processed.
6.2.2. Syntax
Action command
AT+GPSINIT= <hw>
[,<bus_type>,<bus_number>,<on_off>,<reset>,<gps_wakeup>,<host_wakeup
>,<clock32k>,<appli_led>]
OK
Read command
AT+GPSINIT?
+GPSINIT:2
OK
Test command
AT+GPSINIT=?
+GPSINIT: (list of supported <hw>s), (list of supported <bus_type>s), (list
of supported <bus_number>s), (list of supported <on_off>s),(list of
supported < reset >s),(list of supported <gps_wakeup>s),(list of supported
<host_wakeup >s),(list of supported <clock32k>s),(list of supported
4111879 Rev 1.1 November 6, 2012 27
Location Library 1.4 AT Commands Interface User Guide
<appli_led>s)
OK
Unsolicited response
+GPSEVINIT: <status>
6.2.3. Parameters and Defined Values
<hw >: Hardware value: Hardware Type or Hardware Configuration for initialization.
If a Hardware Configuration is provided, no other parameter can be specified.
If a Hardware Type is provided, the other hardware settings should be specified or previously specified parameters apply.
See the Hardware Configuration section for more details on default hardware settings.
2 Hardware Type: SL808xT gpsOne
<status> Event status
0 The action has failed. Application state is unchanged.
1 The action has been successfully completed.
6.2.4. Examples
<hw>
[,<bus_type>,<bus_number>,<on_off>,<reset>,<gps_wakeup>,<host_wakeup
>,<clock32k>,<appli_led>]
Command Responses
AT+GPSINIT?
+GPSINIT: 2
OK
Note: Default configuration response
AT+GPSINIT=2 Note: For default configuration applied on SL808xT gpsOne
OK
+GPSEVINIT: 1
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT commands error codes description.
6.2.5. Hardware Configuration
The default hardware resources settings according to the Hardware Type and Hardware Configuration
are described below:
4111879 Rev 1.1 November 6, 2012 28
Location Library 1.4 AT Commands Interface User Guide
Hardware Type 2 (<hw>=2)
Hardware setup compatibility SL808xT gpsOne.
<hw> 2
6.3. Command +GPSSTOP
6.3.1. Description
This AT command stops the Location Services.
Please refer to the State Machine and AT Commands Calls Requirements for more information about
call state and transition mode.
OK is returned if the request has been processed. The final result will be sent to the associated event
through an unsolicited response after the action has been completed.
GPS Data are stored to NV memory during specific Location Services Application transitions. Please
refer to GPS data management for more information.
6.3.2. Syntax
Action command
AT+GPSSTOP
OK
Test command
AT+GPSSTOP=?
OK
Unsolicited response
+GPSEVSTOP: <status>
6.3.3. Parameters and Defined Values
<status> Event status
0 The action has failed. Application state is unchanged.
1 The action has been successfully completed.
4111879 Rev 1.1 November 6, 2012 29
Location Library 1.4 AT Commands Interface User Guide
6.3.4. Examples
Command Responses
AT+GPSSTOP OK
+GPSEVSTOP: 1
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT commands error codes description.
AT+GPSSTOP=?
OK
6.4. Command +GPSSLEEP
6.4.1. Description
This AT command puts the GPS receiver into the specified GPS sleep mode i.e. it disables the
gpsOne.
This command stops the GPS processing mode. This consumes slightly more power than complete
off mode, but allows for faster restarts when the GPS is restarted with the +GPSSTART command.
OK is returned if the request has been processed. The final result will be sent to the associated event
through an unsolicited response after the action has been completed.
GPS Data are stored to NV memory during specific Location Services Application transitions. Please
refer to GPS data management for more information.
Please refer to the State Machine and AT Commands Calls Requirements for more information about
call state and transition mode.
6.4.2. Syntax
Action command
AT+GPSSLEEP = [<sleep_mode>]
OK
Read command
AT+GPSSLEEP?
+GPSSLEEP:<sleep_mode>
OK
Test command
AT+GPSSLEEP=?
+GPSSLEEP: (list of supported <sleep_mode>s)
4111879 Rev 1.1 November 6, 2012 30
Location Library 1.4 AT Commands Interface User Guide
OK
Unsolicited response
+GPSEVSLEEP: <status>
6.4.3. Parameters and Defined Values
<sleep_mode>: GPS sleep mode
If omitted: last known value within current session. Please refer to Diagram for settings management for more information.
Factory default value: 0.
0 GPS Idle mode (gpsOne is disabled) 5.
1 GPS Hibernate mode 6.
2 GPS Deep Sleep mode 7.
<status> Event status
0 The action has failed. Application state is unchanged.
1 The action has been successfully completed.
6.4.4. Examples
Command Responses
AT+GPSSLEEP OK
+GPSEVSLEEP: 1
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT commands error codes description.
AT+GPSSLEEP=?
+GPSSLEEP: (0,2)
OK
6.5. Command +GPSTTFF
6.5.1. Description
This command reports the calculated TTFF (2-Dimensional Position Fix and 3-Dimensional Position
Fix) of the last run if no new run has started, an error if the current run has no fix yet, or the calculated
TTFF of this run if it has fixed.
4111879 Rev 1.1 November 6, 2012 31
Location Library 1.4 AT Commands Interface User Guide
Please refer to the State Machine and AT Commands Calls Requirements for more information about
call state and transition mode.
Note: 2D TTFF value can be equal to 3D TTFF value if 3-Dimensional Position is directly fixed. This is subjected to GPS conditions.
Note: GPS_ERR_GPS_POS_NOT_FIXED (-30) is returned if the current run is not fixed.
6.5.2. Syntax
Read command
AT+GPSTTFF?
+GPSTTFF:<2D_time>,<3D_time>
OK
Test command
AT+GPSTTFF=?
OK
6.5.3. Parameters and Defined Values
<2D_time>: 2-Dimensional Position Time To First Fix, defined in ms.
<3D_time>: 3-Dimensional Position Time To First Fix, defined in ms.
6.5.4. Examples
Command Responses
AT+GPSTTFF? +GPSTTFF: 32051,32051
OK
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT commands error codes description.
AT+GPSTTFF? +GPSTTFF: -30,-30
OK
Note: The current run is not fixed.
AT+GPSTTFF=? OK
4111879 Rev 1.1 November 6, 2012 32
Location Library 1.4 AT Commands Interface User Guide
6.6. Command +GPSRELEASE
6.6.1. Description
This AT Command releases the Location Services hardware and software resources.
OK is returned if the request has been processed. The final result will be sent to the associated event
through an unsolicited response after the action has been completed.
Please refer to the State Machine and AT Commands Calls Requirements for more information about
call state and transition mode.
6.6.2. Syntax
Action command
AT+GPSRELEASE
OK
Test command
AT+GPSRELEASE=?
OK
Unsolicited response
+GPSEVRELEASE: <status>
6.6.3. Parameters and Defined Values
<status> Event status
0 The action has failed. Application state is unchanged.
1 The action has been successfully completed.
4111879 Rev 1.1 November 6, 2012 33
Location Library 1.4 AT Commands Interface User Guide
6.6.4. Examples
Command Responses
AT+GPSRELASE OK
+GPSEVRELEASE: 1
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT commands error codes description.
AT+GPSRELEASE=?
OK
6.7. Command +GPSVERS
6.7.1. Description
This AT Command reports the Software Version of the Location AT command set.
6.7.2. Syntax
Read command
AT+GPSVERS?
+GPSVERS:<version>
OK
Test command
AT+GPSVERS=?
OK
6.7.3. Parameters and Defined Values
<version>: Location Services version including:
AT command set version
Location Library version
4111879 Rev 1.1 November 6, 2012 34
Location Library 1.4 AT Commands Interface User Guide
6.7.4. Examples
Command Responses
AT+GPSVERS? +GPSVERS: “Location Services version string”
OK
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT commands error codes description.
AT+GPSVERS=?
OK
6.8. Command +GPSCONF
No need to port that command on top of AirPrime SL808x-gpsOne for the first Location AT commands
porting step (NMEA service support only).
6.8.1. Description
This AT command configures the Location service and GPS receiver.
Please refer to the State Machine and AT Commands Calls Requirements for more information about
call state and transition mode.
6.8.2. Syntax
Action command
AT+GPSCONF= <config_type>,<config_value>
OK
Read command
AT+GPSCONF?
+GPSCONF: <config_type>,<config_value>
[+GPSCONF: <config_type>,<config_value>]
OK
Test command
AT+GPSCONF=?
+GPSCONF:<config_type>,(list of supported <config_value>s)
[+GPSCONF:<config_type>,(list of supported <config_value>s)]
OK
4111879 Rev 1.1 November 6, 2012 35
Location Library 1.4 AT Commands Interface User Guide
6.8.3. Parameters and Defined Values
<config_type>: This parameter specifies the configuration type on which the configuration value is applied.
8 Define if GPS feature is allowed at the next boot
<config_value>:
Requested value of configuration type.
For <config_type> = 8 Define if GPS feature is allowed at the next boot.
If omitted: last known value within current session. Please refer to Diagram for settings management for more information. If value has been changed, +GPSSAVE=1 AT Command must be send, and reset must be issued after using this command.
Factory default value: 1.
0: GPS feature disabled
1: GPS feature enabled
6.8.4. Location service configuration restrictions
Some options cannot be configured while in GPS_RUNNING state, or in GPS_SLEEP state
depending on the GPS sleep mode. In this case, GPS_ERR_BAD_STATE is returned by the
+GPSCONF AT command.
Restrictions are listed in the table below:
Option
GP
S_
RU
NN
ING
GP
S_
SL
EE
P /
GP
S_
IDL
E_
MO
DE
GP
S_
SL
EE
P /
GP
S_
HIB
ER
NA
TE
_M
OD
E
GP
S_
INIT
IAL
IZE
D
<config_type> = 8 (GPS enable)
Allowed Allowed Allowed Allowed
4111879 Rev 1.1 November 6, 2012 36
Location Library 1.4 AT Commands Interface User Guide
6.8.5. Examples
Command Responses
AT+GPSCONF=8,0 Note: disable GPS feature at next boot
OK
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT commands error codes description.
AT+GPSCONF=? +GPSCONF: 8,(0-1)
AT+GPSCONF? Note: Allow to retrieve the current default configuration.
+GPSCONF: 8,1
6.9. Command +GPSAID
6.9.1. Foreword
Intention has been to limit as much as possible the Location Library GPS Aiding Service AT
commands changes while porting to SL808s gpsOne GPS solution. As a consequence some
terminology may not be as accurate as it could be when considering gpsOne iso XM GPS solution.
For example, “Assistance data” or “Predicted Orbit data” would have been more appropriate than
Downloaded Extended Ephemeris as in gpsOne case those data are not only Ephemeris.
6.9.2. Description
This AT command activates and configures the Aiding modes.
Please refer to the State Machine and AT Commands Calls Requirements for more information about
call state and transition mode.
6.9.2.1. Downloaded Extended Ephemeris
DEE (Downloaded Extended Ephemeris) improves start-up GPS performance by employing Extended
Ephemeris data. The Extended Ephemeris data should be downloaded from an Extended Ephemeris
server and outlast a standard broadcast ephemeris.
SL808xT gpsOne GPS solution supports DEE thru the gpsOne XTRA (XTRA for short) feature.
In order to compute a position XTRA requires 1°) XTRA servers that provide assistance data so called
XTRA data and 2°) the ability to acquire GPS satellites in order to compute a position (No Sattelites
then NO Fix)
4111879 Rev 1.1 November 6, 2012 37
Location Library 1.4 AT Commands Interface User Guide
6.9.2.1.1. Server and Assistance data download
Three servers are provided (URL set by default) so that the requests are load balanced. XTRA
Servers and XTRA data are fully hosted by QC and provided as free service.
XTRA Data is downloaded using an http get as a binary file that must be injected into the gpsOne
GPS Engine using specific PDAPI function calls (Practically it appears that the XTRA data files are
updated each day).
Both bearer and communication socket management are encapsulated within SL808xT gpsOne
XTRA assisted GPS,
6.9.2.1.2. Assistance data validity
XTRA Data is valid for seven days.
6.9.2.1.3. SL808x assisted GPS operation using XTRA
First, gpsOneXTRA feature must be enabled on the device.
Any time a fix is requested, and XTRA is enabled, the device will do a check to determine if it’s
assistance data is valid (XTRA data valid for 7 days once downloaded/injected).
If it is valid, it uses the assistance data to compute the fix. If the data is not valid, the GPS Engine will
send an event via a registered client event handler to download the assistance data.
The assistance data is stored in the device EFS (CGPS_PE Folder in EFS Explorer) for later use.
While the XTRA download/injection is in progress, the standalone fix will continue to be processed. If
the XTRA download/injection fails, the standalone fix in progress may still return successful if
satellites are acquired during the standalone search.
6.9.3. Syntax
For <config_type> = 1
Action command
AT+GPSAID=<config_type>,<dee_mode>[, [<dee_period>]
[,[<dee_server_address>] [,[<dee_sever_port>]
[,[<dee_sever_code>][,[<dee_socket_type>][,[<dee_timeout>]]]]]]]
OK
For <config_type> = 2
Action command
AT+GPSAID=<config_type>,<dee_command>
OK
4111879 Rev 1.1 November 6, 2012 38
Location Library 1.4 AT Commands Interface User Guide
Read command
AT+GPSAID?
+GPSAID:1,<dee_mode>,
<dee_period>,<dee_server_address>,<dee_sever_port>,<dee_sever_code>,<dee_so
cket_type>,<dee_timeout>
+GPSAID:2,<dee_command>
OK
Test command
AT+GPSAID=?
+GPSAID:1,(list of supported <dee_mode>s),(list of supported
<dee_period>s),(list of supported <dee_server_address>s),(list of supported
<dee_sever_port>s), (list of supported <dee_sever_code>s),(list of
supported <dee_socket_type>s),(list of supported <dee_timeout>s)
+GPSAID:2,(list of supported <dee_command>s)
OK
6.9.4. Parameters and Defined Values
<config_type>: This parameter specifies the configuration type on which the configuration is applied.
1 DEE configuration.
2 DEE command.
<dee_mode>: This parameter specifies the DEE (Downloaded Extended Ephemeris) mode.
If omitted: last known value within current session. Please refer to Diagram for settings management for more information.
Factory default value: 0.
0: DEE is deactivated.
1: DEE is activated.
<dee_period> DEE period in day(s).
If omitted: last known value within current session. Please refer to Diagram for settings management for more information.
Factory default value: 3.
Range: 0-65535
<dee_server_address> Address of the DEE servers (up to 3) are URL Can be one of the 3 following pre-set assistance data server:
- Primary Server: http://xtra1.gpsonextra.net/xtra.bin
- Secondary Server: http://xtra2.gpsonextra.net/xtra.bin
- Tertiary Server: "http://xtra3.gpsonextra.net/xtra.bin"
If omitted: last known value within current session.
Factory default value: “http://xtra1.gpsonextra.net/xtra.bin”.
<dee_server_port> Read Only parameter: returns GPS_ERR_NOT_AVAILABLE(- 4) error.
<dee_server_code> Read Only parameter: returns GPS_ERR_NOT_AVAILABLE(- 4) error
4111879 Rev 1.1 November 6, 2012 39
Location Library 1.4 AT Commands Interface User Guide
<dee_socket_type> Read Only parameter: returns GPS_ERR_NOT_AVAILABLE(- 4) error
<dee_timeout> Socket connection timeout value in second(s).
If omitted: last known value within current session. Please refer to Diagram for settings management for more information.
Factory default value: 10
Range: 0 - 65535
<dee_command>
0: This command has no effect, but indicates that no command is pending.
1: This command requests EE file update
2: This command stops EE download if any.
3: This command forces EE file download. This command is used only
for test purpose.
<dee_mode> : RESET must be issued after this command is used. If <dee_period> is not supported, the error GPS_ERR_INVALID_PARAMETER is returned.
<dee_command> is automatically configured to 0 when the command is performed. If the command is pending, for example in GPS_INITIALIZED state, the read of this parameter returns the last entered DEE command.
<dee_command> = 1 does not assume any service aiding configuration (neither Assistance data server URLs nor connection settings nor credential for server access… etc)
<dee_command> = 1 allows DEE file update as described hereunder.
o Anytime a fix is requested (assuming XTRA is enabled) the device will check validity of assistance data (XTRA data valid for 7 days once downloaded/injected).
o If it is valid, it uses the assistance data to compute the fix. If the data is not valid, the Location library will request to download the assistance data.
o The FW is capable to download the XTRA data thru an embedded client,
o Once the XTRA data is downloaded, it is injected into the GPS Engine and the assistance data flags is show that assistance data is valid (download and injection have been successful). The assistance data is stored in the device NV memory for later use.
o While the XTRA download/injection is in progress, the standalone fix will continue to be processed. If the XTRA download/injection fails, the standalone fix in progress may still return successful if satellites are acquired during the standalone search.
o Factory start (please refer to gps_startingMode_e) removes DEE file. To retrieve it, DEE file
download should be requested once again.
o XTRA data file download started immediately (for example in GPS_INITIALIZED state). Download is always forced: same as dee_command=3 (Force download)
<dee_command> = 2
Stop ongoing XTRA data file download not possible. This command stops aiding sequencer and returns related stop event. Download process is not aborted.
6.9.5. Aiding Service Configuration Restrictions
Some options cannot be configured while in some state(s). In this case, GPS_ERR_BAD_STATE is
returned by the +GPSAID AT command.
4111879 Rev 1.1 November 6, 2012 40
Location Library 1.4 AT Commands Interface User Guide
Restrictions are listed in the table below:
Option
GP
S_
NIT
IAL
IZE
D
GP
S_
RU
NN
ING
GP
S_
SL
EE
P /
GP
S_
IDL
E_
MO
DE
GP
S_
SL
EE
P /
GP
S_
HIB
ER
NA
TE
_M
OD
E
<config_type> = 1 (DEE configuration) Allowed Not allowed
Not allowed
Allowed
<config_type> = 2 (DEE command) Authorized Allowed Allowed Authorized
6.9.6. Examples
Command Responses
AT+GPSAID=1,1 Note: activates the DEE mode.
OK
or
+GPS ERROR: X
Note: For more information about X value, please
refer to Location AT commands error codes
description.
AT+GPSAID=2,1 Note: requests EE file download.
OK
or
+GPS ERROR: X
Note: For more information about X value, please
refer to Location AT commands error codes
description.
AT+GPSAID=?
+GPSAID: 1,(0-1),(0-65535),””,(0-
65535),””,(“TCP”),(0-65535)
+GPSAID: 2,(0-2)
OK
AT+GPSAID? Note: Allow to retrieve the current configuration.
+GPSAID:
1,1,3,”ServerAddress”,0,”ServerAuthCode”,TCP,10
+GPSAID: 2,0
OK
6.9.7. Examples of AT Command Sequence
...
AT+GPSSAVE=0 /* reset the whole of gps settings */
4111879 Rev 1.1 November 6, 2012 41
Location Library 1.4 AT Commands Interface User Guide
AT+CFUN=1 or HW reset
AT+GPSINIT=2
AT+GPSAID=1,1
AT+GPSSAVE=1 /* save gps settings */
AT+CFUN=1 or HW reset
AT+CGDCONT= «PDP Profile» /* if not define */
AT+GPSAID=2,1
+GPSEVAID: 1,2,10080
...
AT+GPSSTART=3
OK
+GPSEVSTART: 1
+GPSEVPOS: 0
+GPSEVPOS: 3
…
6.10. Command +GPSCORE
6.10.1. Description
This AT command configures core information mode and the output port of the core information.
Please refer to the State Machine and AT Commands Calls Requirements for more information about
call state and transition mode.
6.10.2. Syntax
Action command
AT+GPSCORE=[<output>][,[<rate>][,<core_info>]]
OK
Read command
AT+GPSCORE?
+GPSCORE: <output>,<rate>,<core_info>
OK
Test command
AT+GPSCORE=?
+GPSCORE: (list of supported <output>s) ,(list of supported <rate>s)
,(list of supported <core_info>s)
OK
4111879 Rev 1.1 November 6, 2012 42
Location Library 1.4 AT Commands Interface User Guide
6.10.3. Parameters and Defined Values
<output>: This parameter specifies the port to be used by the application to transmit the core information. (Hexadecimal value entered without the prefix “0x”).
If omitted: last known value within current session. Please refer to Diagram for settings management for more information.
Factory default value: 0.
0 Core information output disabled.
1 Core information output on UART 1.
2 Core information output on UART 2.
3 Core information output on USB.
4 Core information output on port where the +GPSCORE command was received.
<rate>: This parameter defines the core information update rate in seconds.
If omitted: last known value within current session. Please refer to Diagram for settings management for more information.
Factory default value: 1.
Range: 0-65535
Note: If this parameter equals 0, the core information frames will be sent only once, on the next occurrence of the core information frames update.
<core info>: Core information list encode mask. Hexadecimal value entered without the prefix “0x”.
If omitted: last known value within current session. Please refer to Diagram for settings management for more information.
Factory default value: 0.
(0<<0): Core information data output disabled.
Note: Core information is received through +GPSEVCORE asynchronous event. Please refer to Asynchronous_Events for more information.
4111879 Rev 1.1 November 6, 2012 43
7. Asynchronous Events
The asynchronous events inform about Location Services events.
7.1. Description
The following asynchronous events can be received as unsolicited responses:
+GPSEVABORT: Following error detection, the Location Services are aborted and the application is
stopped. After this event the application state is automatically changed to GPS_INITIALIZED.
+GPSEVERROR: An error has been detected. Please refer to Location AT commands error codes for
more details.
The others events are associated to the following AT Commands described in this document:
+GPSINIT, +GPSSTART, +GPSSTOP, +GPSSLEEP and +GPSRELEASE.
7.2. Syntax
Unsolicited response
+GPSEVPOS: <pos_event>
Unsolicited response
+GPSEVABORT: <abort_cause>
Unsolicited response
+GPSEVERROR: <error>
Unsolicited response
+GPSEVINIT: <status>
Unsolicited response
+GPSEVSTART: <status>
4111879 Rev 1.1 November 6, 2012 44
Location Library 1.4 AT Commands Interface User Guide
Unsolicited response
+GPSEVSTOP: <status>
Unsolicited response
+GPSEVSLEEP: <status>
Unsolicited response
+GPSEVAID: <aid_mode>,<aid_event>
For <aid_mode> = 1 and <aid_event> = 2
Unsolicited response
+GPSEVAID: <aid_mode>,<aid_event>
Note: This event informs the user that DEE files are valid.
For <aid_mode> = 1 and <aid_event> = 4 and <aid_event_display> = 1
Unsolicited response
+GPSEVAID:
<aid_mode>,<aid_event>,<aid_event_display>,<dee_validity_start>,<dee_validity_stop>
Note: <dee_validity_start> and <dee_validity_stop> are printed with the following format: “yy/MM/dd,hh:mm:ss”
Unsolicited response
+GPSEVAIDERROR: <aid_error>,<aid_ext_error>
4111879 Rev 1.1 November 6, 2012 45
Location Library 1.4 AT Commands Interface User Guide
Unsolicited response
+GPSEVRELEASE: <status>
7.3. Parameters and Defined Values
<error> Error number (Please refer to Location AT Application error codes)
<pos_event>
0 The GPS fix position has been detected lost.
1 GPS fix state has been changed to estimated (ie forward predicted) Position.
2 GPS fix state has been changed to 2-Dimensional Position.
3 GPS fix state has been changed to 3-Dimensional Position.
4 GPS fix state has been changed to invalid Position.
<abort_cause> Error number (Please refer to Location AT Application error codes)
<status> Event status
0 The action has failed. Application state is unchanged.
1 The action has been successfully completed.
<aid_mode> GPS Aiding mode
1 Downloaded Extended Ephemeris
<aid_event>
0 DEE is stopped
1 DEE is started
2 DEE is valid :
3 DEE is aborted : not supported
4 DEE information :
Returned deeValidity is given as two timestamps (first corresponding to the time the validity of the DEE begins, second corresponding to the time the validity of the DEE ends)
4111879 Rev 1.1 November 6, 2012 46
8. Location AT Commands Error Codes
The following error codes could be returned from Location AT commands.
Table 2: Location AT commands error codes
Error Code
Error name Description
-1 GPS_ERR_BAD_STATE The function has been called in an unauthorized application state
-2 GPS_ERR_STATE_ALREADY The requested action has been already performed and the target application state is currently activated.
-3 GPS_ERR_INVALID_PARAMETER Invalid input parameter.
-4 GPS_ERR_NOT_AVAILABLE This feature or configuration is not available for software and/or hardware version.
-5 GPS_ERR_STATE_TRANSITION A state transition is in progress.
-10 GPS_ERR_PORTING_LAYER_INIT The initialization of the porting layer failed (Internal error)
-11 GPS_ERR_INIT Application initialization error
-12 GPS_ERR_IO_INIT IO initialization error
-13 GPS_ERR_BUS_INIT Bus initialization error
-14 GPS_ERR_SCHED_INIT Scheduler initialization error
-15 GPS_ERR_CORE_SW_INIT Application core software initialization error
-16 GPS_ERR_NV_MEMORY_INIT Non-Volatile memory initialization error
-20 GPS_ERR_SCHED_TASK Application task schedule error.
-21 GPS_ERR_BUS Bus error
-22 GPS_ERR_IO_MNGT IO management error
-23 GPS_ERR_CORE_SW Application core software error
-24 GPS_ERR_NV_DATA_ACCESS Non-Volatile store media (Embedded Module FLASH memory) access error for the GPS Non-Volatile data.
-25 GPS_ERR_INTERNAL Internal error.
-26 GPS_ERR_SERVICE The asked service is not performed.
-30 GPS_ERR_GPS_POS_NOT_FIXED The current run is not fixed
-40 GPS_ERR_ABORT_INTERNAL Internal abort.
-41 GPS_ERR_ABORT_NMEA NMEA update rate Watchdog.
-42 GPS_ERR_ABORT_RESET Reset Watchdog.
-60 GPS_AT_ERR_INTERNAL Application internal error.
-61 GPS_AT_ERR_INVALID_PARAMETER Application invalid input parameter.
-62 GPS_AT_ERR_FLASH_DATA_ACCESS Application Flash access error.
-63 GPS_AT_ERR_PORT Application port configuration error.
-64 GPS_AT_ERR_APPLI_LED Application Led management error.
-65 GPS_AT_ERR_SCHED_TASK Application task schedule error.
4111879 Rev 1.1 November 6, 2012 47
Index
+GPSAID, 36
+GPSCONF, 34
+GPSCORE, 41
+GPSHELP, 17
+GPSINIT, 26
+GPSNMEA, 18
+GPSRELEASE, 32
+GPSSAVE, 21
+GPSSLEEP, 29
+GPSSTART, 23
+GPSSTATE, 25
+GPSSTOP, 28
+GPSTTFF, 30
+GPSVERS, 33