bg96 gnss at commands manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7....

28
BG96 GNSS AT Commands Manual LTE Module Series Rev. BG96_GNSS_AT_Commands_Manual_V1.0 Date: 2017-06-28 www.quectel.com

Upload: others

Post on 01-Aug-2021

6 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

BG96 GNSS

AT Commands Manual

LTE Module Series

Rev. BG96_GNSS_AT_Commands_Manual_V1.0

Date: 2017-06-28

www.quectel.com

Page 2: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 1 / 27

Our aim is to provide customers with timely and comprehensive service. For any

assistance, please contact our company headquarters:

Quectel Wireless Solutions Co., Ltd.

7th Floor, Hongye Building, No.1801 Hongmei Road, Xuhui District, Shanghai 200233, China

Tel: +86 21 5108 6236

Email: [email protected]

Or our local office. For more information, please visit:

http://www.quectel.com/support/salesupport.aspx

For technical support, or to report documentation errors, please visit:

http://www.quectel.com/support/techsupport.aspx

Or email to: [email protected]

GENERAL NOTES

QUECTEL OFFERS THE INFORMATION AS A SERVICE TO ITS CUSTOMERS. THE INFORMATION

PROVIDED IS BASED UPON CUSTOMERS’ REQUIREMENTS. QUECTEL MAKES EVERY EFFORT

TO ENSURE THE QUALITY OF THE INFORMATION IT MAKES AVAILABLE. QUECTEL DOES NOT

MAKE ANY WARRANTY AS TO THE INFORMATION CONTAINED HEREIN, AND DOES NOT ACCEPT

ANY LIABILITY FOR ANY INJURY, LOSS OR DAMAGE OF ANY KIND INCURRED BY USE OF OR

RELIANCE UPON THE INFORMATION. ALL INFORMATION SUPPLIED HEREIN IS SUBJECT TO

CHANGE WITHOUT PRIOR NOTICE.

COPYRIGHT

THE INFORMATION CONTAINED HERE IS PROPRIETARY TECHNICAL INFORMATION OF

QUECTEL CO., LTD. TRANSMITTING, REPRODUCTION, DISSEMINATION AND EDITING OF THIS

DOCUMENT AS WELL AS UTILIZATION OF THE CONTENT ARE FORBIDDEN WITHOUT

PERMISSION. OFFENDERS WILL BE HELD LIABLE FOR PAYMENT OF DAMAGES. ALL RIGHTS

ARE RESERVED IN THE EVENT OF A PATENT GRANT OR REGISTRATION OF A UTILITY MODEL

OR DESIGN.

Copyright © Quectel Wireless Solutions Co., Ltd. 2017. All rights reserved.

Quectel

Preliminary

Page 3: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 2 / 27

About the Document

History

Revision Date Author Description

1.0 2017-06-28 Matt YE Initial

Quectel

Preliminary

Page 4: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 3 / 27

Contents

About the Document ................................................................................................................................... 2

Contents ....................................................................................................................................................... 3

Table Index ................................................................................................................................................... 4

1 Introduction .......................................................................................................................................... 5

1.1. GNSS Turning on/off Procedures ............................................................................................... 5

1.2. NMEA Sentences Type ............................................................................................................... 6

2 Description of GNSS AT Commands ................................................................................................. 7

2.1. AT+QGPSCFG GNSS Configurations ..................................................................................... 7

2.1.1. AT+QGPSCFG=“outport”[,<outport>]* Configure NMEA Sentences Output Port ...... 7

2.1.2. AT+QGPSCFG=“nmeasrc”[,<nmeasrc>] Enable/Disable Acquisition of NMEA

Sentences via AT+QGPSGNMEA .................................................................................................. 8

2.1.3. AT+QGPSCFG=“gpsnmeatype”[,<gpsnmeatype>] Configure Output Type of GPS

NMEA Sentences ............................................................................................................................ 9

2.1.4. AT+QGPSCFG=“glonassnmeatype”[,<glonassnmeatype>] Configure Output Type of

GLONASS NMEA Sentences ....................................................................................................... 10

2.1.5. AT+QGPSCFG=“galileonmeatype”[,<galileonmeatype>] Configure Output Type of

Galileo NMEA Sentences ............................................................................................................. 11

2.1.6. AT+QGPSCFG=“beidounmeatype”[,<beidounmeatype>] Configure Output Type of

BeiDou NMEA Sentences ............................................................................................................. 11

2.1.7. AT+QGPSCFG=“gsvextnmeatype”[,<gsvextnmeatype>]* Enable/Disable Output of

GSVEXT NMEA Sentences .......................................................................................................... 12

2.1.8. AT+QGPSCFG=“gnssconfig”[,<gnssconfig>] Configure Supported GNSS

Constellation ................................................................................................................................. 13

2.1.9. AT+QGPSCFG=“autogps”[,<autogps>]* Enable/Disable GNSS to Run Automatically14

2.2. AT+QGPSDEL Delete Assistance Data ................................................................................. 15

2.3. AT+QGPS Turn on GNSS ...................................................................................................... 16

2.4. AT+QGPSEND Turn off GNSS .............................................................................................. 17

2.5. AT+QGPSLOC* Acquire Positioning Information .................................................................. 17

2.6. AT+QGPSGNMEA Acquire NMEA Sentences ....................................................................... 19

2.7. AT+QGPSXTRA* Enable gpsOneXTRA Assistance Function ............................................... 21

2.8. AT+QGPSXTRATIME* Inject gpsOneXTRA Time ................................................................. 22

2.9. AT+QGPSXTRADATA* Inject gpsOneXTRA Data File .......................................................... 23

3 Examples ............................................................................................................................................ 24

3.1. Turn on and off the GNSS ......................................................................................................... 24

3.2. Application of GNSS <nmeasrc> .............................................................................................. 24

4 Appendix A References ..................................................................................................................... 25

5 Appendix B Summary of Error Codes ............................................................................................. 27

Quectel

Preliminary

Page 5: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 4 / 27

Table Index

TABLE 1: RELATED DOCUMENT .................................................................................................................... 25

TABLE 2: TERMS AND ABBREVIATIONS ........................................................................................................ 25

TABLE 3: SUMMARY OF ERROR CODES ...................................................................................................... 27

Quectel

Preliminary

Page 6: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 5 / 27

1 Introduction

Quectel BG96 module integrates a GNSS engine which supports GPS, BeiDou, Galileo and GLONASS

systems, and also it supports gpsOneXTRA* Assistance technology. The high performance GNSS engine

is suitable for various applications where lowest-cost and accurate positioning is needed, and it supports

position tracking without network assistance. BG96 GNSS can be applied in the following applications:

turn-by-turn navigation, asset tracking, buddy tracking, location-aware games, as well as home and fleet

management.

“*” means under development.

1.1. GNSS Turning on/off Procedures

BG96 GNSS supports location calculation without any assistance from the network. GNSS turning on/off

procedures are shown below:

Step 1: Configure GNSS parameters via AT+QGPSCFG.

Step 2: Turn on GNSS via AT+QGPS.

Step 3: After GNSS is turned on and position is fixed successfully, the positioning information can be

obtained in three ways:

1) NMEA sentences are output to "usbnmea" port by default; customers can read the port to obtain

NMEA sentences.

2) Customers can use AT+QGPSLOC to obtain positioning information directly, such as latitude,

longitude, height, GNSS positioning mode, time, number of satellites, and so on.

3) After enabling <nmeasrc> via AT+QGPSCFG=“nmeasrc”,1, customers can acquire the

specified NMEA sentence via AT+QGPSGNMEA. If <nmeasrc> is disabled, this command

cannot be used.

Step 4: GNSS can be turned off in two ways:

1) If the parameter <fixcount> of AT+QGPS is set to 0 in Step 2, GNSS will get position

continuously, and it can be turned off via AT+QGPSEND.

2) If <fixcount> reaches the specified value, the GNSS will stop automatically.

NOTE

Quectel

Preliminary

Page 7: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 6 / 27

1.2. NMEA Sentences Type

The NMEA sentences are compatible with NMEA-0183 Protocol, and all standard NMEA sentences have

four kinds of prefix.

For GPS sentences, the prefix is “GP”, as below:

GPGGA - Global positioning system fix data, such as time, position, etc.

GPRMC - Recommended minimum data

GPGSV - Detailed satellite data

GPGSA - Overall satellite data

GPVTG - Vector track and speed over the ground

For GLONASS sentences, the prefixes are "GL" and "GN", as below:

GLGSV - Detailed satellite data

GNGSA - Overall satellite data

GNGNS - Positioning system

For Galileo sentences, the prefixes are "GA" and "GN", as below:

GAGSV - Detailed satellite data

GNGSA - Overall satellite data

GNGNS - Positioning system

For BeiDou sentences, the prefix is "PQ", as below:

PQGSV - Detailed satellite data

PQGSA - Overall satellite data

Quectel

Preliminary

Page 8: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 7 / 27

2 Description of GNSS AT Commands

This chapter mainly introduces the AT commands relating to BG96’s GNSS function. All the commands

marked with “*” are still under development.

2.1. AT+QGPSCFG GNSS Configurations

The command is used to query and configure various GNSS settings, including NMEA sentences output

port, output type of NMEA sentences, and more.

2.1.1. AT+QGPSCFG=“outport”[,<outport>]* Configure NMEA Sentences Output

Port

AT+QGPSCFG GNSS Configurations

Test Command

AT+QGPSCFG=?

Response

+QGPSCFG: “outport”,("none","usbnmea","uartdebug")

+QGPSCFG: “nmeasrc”,(0,1)

+QGPSCFG: “gpsnmeatype”,(0-31)

+QGPSCFG: “glonassnmeatype”,(0-7)

+QGPSCFG: “galileonmeatype”,(0,1)

+QGPSCFG: “beidounmeatype”,(0-3)

+QGPSCFG: “gsvextnmeatype”,(0,1)

+QGPSCFG: “gnssconfig”,(0-6)

+QGPSCFG: “autogps”,(0,1)

OK

Reference

AT+QGPSCFG=“outport”[,<outport>]* Configure NMEA Sentences Output Port

Write Command

AT+QGPSCFG=“outport”[,<outport>]

Response

When there are two parameters:

OK

When the second parameter is omitted, query the current

Quectel

Preliminary

Page 9: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 8 / 27

Parameter

2.1.2. AT+QGPSCFG=“nmeasrc”[,<nmeasrc>] Enable/Disable Acquisition of NMEA

Sentences via AT+QGPSGNMEA

The command enables/disables acquisition of NMEA sentences via AT+QGPSGNMEA.

setting:

+QGPSCFG: “outport”,<outport>

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<outport> Configure the output port of NMEA sentences, and the configuration parameter

will be automatically saved to NVRAM.

“none” Close NMEA sentence output

“usbnmea” Output via USB NMEA port

“uartdebug” Output via UART debug port

<errcode> Integer type. Indicate the error code of operation. If it is not 0, it is the type of

error (Please refer to Chapter 5 for details).

AT+QGPSCFG=“nmeasrc”[,<nmeasrc>] Enable/Disable Acquisition of NMEA

Sentences via AT+QGPSGNMEA

Write Command

AT+QGPSCFG=“nmeasrc”[,<nmeasrc

>]

Response

When there are two parameters:

OK

When the second parameter is omitted, query the current

setting:

+QGPSCFG: “nmeasrc”,<nmeasrc>

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

Quectel

Preliminary

Page 10: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 9 / 27

Parameter

2.1.3. AT+QGPSCFG=“gpsnmeatype”[,<gpsnmeatype>] Configure Output Type of

GPS NMEA Sentences

Parameter

<nmeasrc> If enabled, original NMEA sentences can be acquired via AT+QGPSGNMEA,

and the configuration parameter will be automatically saved to NVRAM.

Meanwhile, sentences are output via the same NMEA ports as before.

0 Disable

1 Enable

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please

refer to Chapter 5 for details).

AT+QGPSCFG=“gpsnmeatype”[,<gpsnmeatype>] Configure Output Type of GPS

NMEA Sentences

Write Command

AT+QGPSCFG=“gpsnmeatype”[,<gps

nmeatype>]

Response

When there are two parameters:

OK

When the second parameter is omitted, query the current

setting:

+QGPSCFG: “gpsnmeatype”,<gpsnmeatype>

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<gpsnmeatype> Output type of GPS NMEA sentences by ORed, and the configuration

parameter will be automatically saved to NVRAM. The default value is 31

which means that all the five types of sentences will be output.

0 Disable

1 GGA

2 RMC

4 GSV

8 GSA

16 VTG

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please

Quectel

Preliminary

Page 11: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 10 / 27

2.1.4. AT+QGPSCFG=“glonassnmeatype”[,<glonassnmeatype>] Configure Output

Type of GLONASS NMEA Sentences

Parameter

refer to Chapter 5 for details).

AT+QGPSCFG=“glonassnmeatype”[,<glonassnmeatype>] Configure Output Type

of GLONASS NMEA Sentences

Write Command

AT+QGPSCFG=“glonassnmeatype”[,

<glonassnmeatype>]

Response

When there are two parameters:

OK

When the second parameter is omitted, query the current

setting:

+QGPSCFG: “glonassnmeatype”,<glonassnmeatype>

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<glonassnmeatype> Configure output type of GLONASS NMEA sentences by ORed, and the

configuration parameter will be automatically saved to NVRAM. The default

value is 0.

0 Disable

1 GSV

2 GSA

4 GNS

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please

refer to Chapter 5 for details).

Quectel

Preliminary

Page 12: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 11 / 27

2.1.5. AT+QGPSCFG=“galileonmeatype”[,<galileonmeatype>] Configure Output

Type of Galileo NMEA Sentences

Parameter

2.1.6. AT+QGPSCFG=“beidounmeatype”[,<beidounmeatype>] Configure Output

Type of BeiDou NMEA Sentences

AT+QGPSCFG=“galileonmeatype”[,<galileonmeatype>] Configure Output Type of

Galileo NMEA Sentences

Write Command

AT+QGPSCFG=“galileonmeatype”[,<

galileonmeatype>]

Response

When there are two parameters:

OK

When the second parameter is omitted, query the current

setting:

+QGPSCFG: “galileonmeatype”,<galileonmeatype>

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<galileonmeatype> Configure output type of Galileo NMEA sentences by ORed, and the

configuration parameter will be automatically saved to NVRAM. The default

value is 0.

0 Disable

1 GSV

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please

refer to Chapter 5 for details).

AT+QGPSCFG=“beidounmeatype”[,<beidounmeatype>] Configure Output Type of

BeiDou NMEA Sentences

Write Command

AT+QGPSCFG=“beidounmeatype”[,<

beidounmeatype>]

Response

When there are two parameters:

OK

When the second parameter is omitted, query the current

setting:

Quectel

Preliminary

Page 13: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 12 / 27

Parameter

2.1.7. AT+QGPSCFG=“gsvextnmeatype”[,<gsvextnmeatype>]* Enable/Disable

Output of GSVEXT NMEA Sentences

+QGPSCFG: “beidounmeatype”,<beidounmeatype>

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<beidounmeatype> Configure output type of BeiDou NMEA sentences via ORed, and the

configuration parameter will be automatically saved to NVRAM. The default

value is 0.

0 Disable

1 GSA

2 GSV

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please

refer to Chapter 5 for details).

AT+QGPSCFG=“gsvextnmeatype”[,<gsvextnmeatype>]* Enable/Disable Output of

GSVEXT NMEA Sentences

Write Command

AT+QGPSCFG=“gsvextnmeatype”[,<

gsvextnmeatype>]

Response

When there are two parameters:

OK

When the second parameter is omitted, query the current

setting:

+QGPSCFG: “gsvextnmeatype”,<gsvextnmeatype>

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

Quectel

Preliminary

Page 14: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 13 / 27

Parameter

2.1.8. AT+QGPSCFG=“gnssconfig”[,<gnssconfig>] Configure Supported GNSS

Constellation

Parameter

<gsvextnmeatype> Enable/disable output of extended GSV information. Elevation/Azimuth/SNR

(C/No) will be displayed as decimals when extended information is enabled,

otherwise they will be displayed as integers. The configuration parameter will

be automatically saved to NVRAM. The default value is 0.

0 Disable

1 Enable

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please

refer to Chapter 5 for details).

AT+QGPSCFG=“gnssconfig”[,<gnssconfig>] Configure Supported GNSS

Constellation

Write Command

AT+QGPSCFG=“gnssconfig”[,<gnssc

onfig>]

Response

When there are two parameters:

OK

When the second parameter is omitted, query the current

setting:

+QGPSCFG: “gnssconfig”,<gnssconfig>

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<gnssconfig> Supported GNSS constellation.

GPS is always on.

0 GLONASS off/BeiDou off/Galileo off

1 GLONASS on/BeiDou on/Galileo on

2 GLONASS on/BeiDou on/Galileo off

3 GLONASS on/BeiDou off/Galileo on

4 GLONASS on/BeiDou off/Galileo off

5 GLONASS off/BeiDou on/Galileo on

6 GLONASS off/BeiDou off/Galileo on

Quectel

Preliminary

Page 15: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 14 / 27

The command will be effective after restart.

2.1.9. AT+QGPSCFG=“autogps”[,<autogps>]* Enable/Disable GNSS to Run

Automatically

Parameter

The command is only valid in Stand-alone Solution.

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please

refer to Chapter 5 for details).

AT+QGPSCFG=“autogps”[,<autogps>]* Enable/Disable GNSS to Run Automatically

Write Command

AT+QGPSCFG=”autogps”[,<autogps

>]

Response

When there are two parameters:

OK

When the second parameter is omitted, query the current

setting:

+QGPSCFG: “autogps”,<autogps>

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<autogps> Enable/disable GNSS to run automatically after the module is powered on.

Configuration parameter will be automatically saved to NVRAM. The default

value is 0.

0 Disable GNSS to run automatically

1 Enable GNSS to run automatically

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please

refer to Chapter 5 for details).

NOTE

NOTE

Quectel

Preliminary

Page 16: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 15 / 27

2.2. AT+QGPSDEL Delete Assistance Data

Delete assistance data to operate cold start, hot start and warm start of GNSS. The command can only be

executed when GNSS is turned off. After deleting the assistance data via this command, cold start of

GNSS can be enforced via AT+QGPS. Hot/warm start can also be performed if the corresponding

conditions are satisfied.

Parameter

“*” means under development.

AT+QGPSDEL Delete Assistance Data

Test Command

AT+QGPSDEL=?

Response

+QGPSDEL: (0-3)

OK

Write Command

AT+QGPSDEL=<deletetype>

Response

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<deletetype> The type of GNSS assistance data to be deleted.

0 Delete all assistance data except gpsOneXTRA data. Enforce cold start after

starting GNSS.

1 Do not delete any data. Perform hot start if the conditions are permitted after

starting GNSS.

2 Delete some related data. Perform warm start if the conditions are permitted after

starting GNSS.

3* Delete the gpsOneXTRA assistance data injected into GNSS engine.

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please refer to

Chapter 5 for details).

NOTE

Quectel

Preliminary

Page 17: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 16 / 27

2.3. AT+QGPS Turn on GNSS

The command is used to turn on GNSS function. Currently <gnssmode> only supports turning on GNSS

in Stand-alone Solution. When <fixcount> is 0, GNSS will fix position continuously, and it can be turned

off via AT+QGPSEND. When <fixcount> is non-zero and reaches the specified value, GNSS will be

turned off automatically.

Parameter

AT+QGPS Turn on GNSS

Test Command

AT+QGPS=?

Response

+QGPS: (1-4),(1-255),(1-1000),(0-1000),(1-65535)

OK

Read Command

Read current GNSS state

AT+QGPS?

Response

+QGPS: <gnssstate>

OK

Write Command

AT+QGPS=<gnssmode>[,<fixmaxtim

e>[,<fixmaxdist>[,<fixcount>[,<fixrate

>]]]]

Response

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<gnssstate> GNSS state.

0 GNSS OFF

1 GNSS ON

<gnssmode> GNSS working mode

1 Stand-alone

2 MS-based

3 MS-assisted

4 Speed-optimal

<fixmaxtime> The maximum positioning time (unit: s). Indicate the response time of GNSS

receiver while measuring the GNSS pseudo range, and the upper time limit of

GNSS satellite searching. It also includes the time for demodulating the

ephemeris data and calculating the position.

1-30-255 Maximum positioning time

<fixmaxdist> Accuracy threshold of positioning. Unit: m.

1-50-1000

<fixcount> Number of attempts for positioning.

Quectel

Preliminary

Page 18: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 17 / 27

2.4. AT+QGPSEND Turn off GNSS

When GNSS is turned on and <fixcount> is 0, GNSS fixes position continuously. In this case, GNSS can

be turned off compulsorily via AT+QGPSEND. When <fixcount> is non-zero, GNSS will be turned off

automatically when the parameter reaches the specified value, and thus the command can be ignored.

Parameter

2.5. AT+QGPSLOC* Acquire Positioning Information

Before executing the command, GNSS must be turned on via AT+QGPS. If it fails in position fix, +CME

ERROR: <errcode> will be returned to indicate the corresponding situation.

0–1000 0 indicates continuous positioning. Non-zero values indicate the

actual number of attempts for positioning.

<fixrate> The interval time between the first and second time positioning. Unit: s.

1–65535

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please refer

to Chapter 5 for details).

AT+QGPSEND Turn off GNSS

Test Command

AT+QGPSEND=?

Response

OK

Execution Command

AT+QGPSEND

Response

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please refer to

Chapter 5 for details).

AT+QGPSLOC* Acquire Positioning Information

Test Command

AT+QGPSLOC=?

Response

+QGPSLOC:

<UTC>,<latitude>,<longitude>,<hdop>,<altitude>,<fix>,<c

Quectel

Preliminary

Page 19: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 18 / 27

Parameter

og>,<spkm>,<spkn>,<date>,<nsat>

OK

Write Command

AT+QGPSLOC=<mode>

Response

+QGPSLOC:

<UTC>,<latitude>,<longitude>,<hdop>,<altitude>,<fix>,<c

og>,<spkm>,<spkn>,<date>,<nsat>

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<mode> Latitude and longitude display format.

0 <latitude>,<longitude> format: ddmm.mmmm N/S,dddmm.mmmm E/W

1 <latitude>,<longitude> format: ddmm.mmmmmm N/S,dddmm.mmmmmm E/W

2 <latitude>,<longitude> format: (-)dd.ddddd,(-)ddd.ddddd

<UTC> UTC time.

Format: hhmmss.sss (Quoted from GPGGA sentence).

<latitude> Latitude.

If <mode> is 0:

Format: ddmm.mmmm N/S (Quoted from GPGGA sentence)

dd 00-89 (degree)

mm.mmmm 00.0000-59.9999 (minute)

N/S North latitude/South latitude

If <mode> is 1:

Format: ddmm.mmmmmm N/S (Quoted from GPGGA sentence)

dd 00-89 (degree)

mm.mmmmmm 00.000000-59.999999 (minute)

N/S North latitude/South latitude

If <mode> is 2:

Format: (-)dd.ddddd (Quoted from GPGGA sentence)

dd.ddddd -89.99999-89.99999 (degree)

- South latitude

<longitude> Longitude.

If <mode> is 0:

Format: dddmm.mmmm E/W (Quoted from GPGGA sentence)

ddd 000-179 (degree)

mm.mmmm 00.0000-59.9999 (minute)

E/W East longitude/West longitude

Quectel

Preliminary

Page 20: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 19 / 27

2.6. AT+QGPSGNMEA Acquire NMEA Sentences

Before using this command, GNSS must be turned on via AT+QGPS, and <nmeasrc> has to enabled via

AT+QGPSCFG=“nmeasrc”,1.

If parameters <gpsnmeatype>, <glonassnmeatype>, <galileonmeatype> and <beidounmeatype> are

all 0, the command can be used to acquire NMEA sentences. If the GNSS has already acquired

sentences via this command after its activation, customers can disable sentences output via

AT+QGPSCFG=“gpsnmeatype”/“glonassnmeatype”/“galileonmeatype”/“beidounmeatype”,0.

Then the sentences obtained via AT+QGPSGNMEA are the last sentences.

If <mode> is 1:

Format: dddmm.mmmmmm E/W (Quoted from GPGGA sentence)

ddd 000-179 (degree)

mm.mmmmmm 00.000000-59.999999 (minute)

E/W East longitude/West longitude

If <mode> is 2:

Format: (-)dd.ddddd Quoted from GPGGA sentence)

dd.ddddd -179.99999-179.99999 (degree)

- West longitude

<hdop> Horizontal precision: 0.5-99.9 (Quoted from GPGGA sentence).

<altitude> The altitude of the antenna away from the sea level (unit: m), accurate to one decimal

place (Quoted from GPGGA sentence)

<fix> GNSS positioning mode (Quoted from GNGSA/GPGSA sentence).

2 2D positioning

3 3D positioning

<cog> Course Over Ground based on true north.

Format: ddd.mm (Quoted from GPVTG sentence).

ddd 000-359 (degree)

mm 00-59 (minute)

<spkm> Speed over ground.

Format: xxxx.x; unit: Km/h; accurate to one decimal place (Quoted from GPVTG

sentence).

<spkn> Speed over ground.

Format: xxxx.x; unit: knots; accurate to one decimal place (Quoted from GPVTG

sentence).

<date> UTC time when fixing position.

Format: ddmmyy (Quoted from GPRMC sentence).

<nsat> Number of satellites, from 00 (The first 0 should be retained) to 12 (Quoted from

GPGGA sentence).

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please refer to

Chapter 5 for details).

Quectel

Preliminary

Page 21: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 20 / 27

AT+QGPSGNMEA Acquire NMEA Sentences

Test Command

AT+QGPSGNMEA=?

Response

+QGPSGNMEA:

(“GGA”,“RMC”,“GSV”,“GSA”,“VTG”,“GNS”)

OK

Inquiry Command

Query GGA sentence

AT+QGPSGNMEA=“GGA”

Response

+QGPSGNMEA: GGA sentence

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Inquiry Command

Query RMC sentence

AT+QGPSGNMEA=“RMC”

Response

+QGPSGNMEA: RMC sentence

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Inquiry Command

Query GSV sentence

AT+QGPSGNMEA=“GSV”

Response

+QGPSGNMEA: GSV sentence

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Inquiry Command

Query GSA sentence

AT+QGPSGNMEA=“GSA”

Response

+QGPSGNMEA: GSA sentence

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Inquiry Command

Query VTG sentence

AT+QGPSGNMEA=“VTG”

Response

+QGPSGNMEA: VTG sentence

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Inquiry Command

Query GNS sentence

Response

+QGPSGNMEA: GNS sentence

Quectel

Preliminary

Page 22: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 21 / 27

Parameter

2.7. AT+QGPSXTRA* Enable gpsOneXTRA Assistance Function

This command can be used to enable gpsOneXTRA Assistance function, and the function can be

activated after restarting the module.

Parameter

AT+QGPSGNMEA=“GNS”

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please refer to

Chapter 5 for details).

AT+QGPSXTRA* Enable gpsOneXTRA Assistance Function

Test Command

AT+QGPSXTRA=?

Response

+QGPSXTRA: (0,1)

OK

Read Command

AT+QGPSXTRA?

Response

+QGPSXTRA: <xtraenable>

OK

Write Command

AT+QGPSXTRA=<xtraenable>

Response

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<xtraenable> Enable gpsOneXTRA Assistance function, and the configuration parameter will be

automatically saved to NVRAM.

0 Disable gpsOneXTRA Assistance

1 Enable gpsOneXTRA Assistance

Quectel

Preliminary

Page 23: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 22 / 27

2.8. AT+QGPSXTRATIME* Inject gpsOneXTRA Time

This command can be used to inject gpsOneXTRA time to GNSS engine. Before using it, customers must

enable gpsOneXTRA Assistance function via AT+QGPSXTRA=1 command. After activating the function,

the GNSS engine will ask for gpsOneXTRA time and assistance data file. Before injecting gpsOneXTRA

data file, gpsOneXTRA time must be injected first via this command.

Parameter

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please refer to

Chapter 5 for details).

AT+QGPSXTRATIME* Inject gpsOneXTRA Time

Test Command

AT+QGPSXTRATIME=?

Response

+QGPSXTRATIME: 0,<xtratime>,(0,1),(0,1),<uncrtn>

OK

Write Command

Inject gpsOneXTRA time

AT+QGPSXTRATIME=<op>,<xtratime

>[,<utc>[,<force>,<uncrtn>]]

Response

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<op> Operation type.

0 Inject gpsOneXTRA time

<xtratime> Current UTC/GPS time.

Format: YYYY/MM/DD,hh:mm:ss. e.g. 2016/01/03,15:34:50.

<utc> The type of time.

0 GPS time

1 UTC time

<force> Allow or force GPS subsystem to accept the time injected.

0 Allow acceptance

1 Force acceptance

<uncrtn> Uncertainty of time. Unit: ms. Default value: 3500ms. It indicates the time

difference between sending a request to the SNTP server and receiving a

response from the SNTP server. If the set time is less than 3.5s, it will be counted

as 3.5s.

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please refer

to Chapter 5 for details).

Quectel

Preliminary

Page 24: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 23 / 27

2.9. AT+QGPSXTRADATA* Inject gpsOneXTRA Data File

This command can be used to inject gpsOneXTRA assistance data file to GNSS engine. Before operating

this command, customers must enable gpsOneXTRA, store the valid gpsOneXTRA data file into RAM or

UFS (RAM is recommended) of the mudule and inject gpsOneXTRA time to GNSS engine. After

operating this command successfully, gpsOneXTRA data file can be deleted from RAM file, and

customers can query whether the gpsOneXTRA data is injected successfully via AT+QGPSXTRADATA?.

Parameter

AT+QGPSXTRADATA* Inject gpsOneXTRA Data File

Test Command

AT+QGPSXTRADATA=?

Response

+QGPSXTRADATA: <xtradatafilename>

OK

Read Command

Query the status of gpsOneXTRA data

file

AT+QGPSXTRADATA?

Response

+QGPSXTRADATA:

<xtradatadurtime>,<injecteddatatime>

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Write Command

Inject gpsOneXTRA data file

AT+QGPSXTRADATA=<xtradatafilena

me>

Response

OK

If there is an error related to ME functionality:

+CME ERROR: <errcode>

Reference

<xtradatafilename> Filename of the gpsOneXTRA data file, e.g. xtra.bin or xtra2.bin.

<xtradatadurtime> Valid time of injected gpsOneXTRA data file. Unit: min.

0 No gpsOneXTRA file or the file is overdue

1-10080 Valid time of gpsOneXTRA file

<injecteddatatime> Starting time of the valid time of gpsOneXTRA data file.

Format: YYYY/MM/DD,hh:mm:ss, e.g. 2016/01/03,15:34:50.

<errcode> Indicate the error code of operation. If it is not 0, it is the type of error (Please

refer to Chapter 5 for details).

Quectel

Preliminary

Page 25: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 24 / 27

3 Examples

3.1. Turn on and off the GNSS

Default arguments are used in this example to turn on GNSS. After turning on GNSS, NMEA sentences

will be output from “usbnmea” port by default; and GNSS can be turned off via AT+QGPSEND.

AT+QGPS=1 //Turn on GNSS.

OK

//After turning on GNSS, NMEA sentences will be output from “usbnmea” port by default.

AT+QGPSLOC? //Obtain positioning information.

+QGPSLOC: 061951.0,3150.7223N,11711.9293E,0.7,62.2,2,0.0,0.0,0.0,110513,09

OK

AT+QGPSEND //Turn off GNSS.

OK

3.2. Application of GNSS <nmeasrc>

When GNSS is turned on and <nmeasrc> is enabled, NMEA sentences can be acquired directly via

AT+QGPSGNMEA.

AT+QGPSCFG=“nmeasrc”,1 //Enable <nmeasrc> functionality.

OK

AT+QGPSGNMEA=“GGA” //Obtain GGA sentence.

+QGPSGNMEA: $GPGGA,103647.0,3150.721154,N,11711.925873,E,1,02,4.7,59.8,M,-2.0,M,,*77

OK

AT+QGPSCFG=“nmeasrc”,0 //Disable <nmeasrc> functionality.

OK

AT+QGPSGNMEA=“GGA” //Disable <nmeasrc> functionality, and thus GGA sentence

cannot be obtained.

+CME ERROR: 507

Quectel

Preliminary

Page 26: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 25 / 27

4 Appendix A References

Table 1: Related Document

SN Document Name Remark

[1] Quectel_QCOM_User_Guide QCOM user guide

Table 2: Terms and Abbreviations

Abbreviation Description

BeiDou BeiDou Navigation Satellite System

Galileo Galileo Satellite Navigation System

GGA Global Positioning System Fix Data

GLONASS Global Navigation Satellite System

GNS Global Network Service

GNSS Global Navigation Satellite System

GPS Global Positioning System

gpsOneXTRA An Auxiliary Positioning Technology Provided by Qualcomm

GSA GPS DOP and Active Satellites

GSV Satellites in View

MCU Micro Control Unit

ME Mobile Equipment

MS Mobile Station

NMEA National Marine Electronics Association

NVRAM Non-Volatile Random Access Memory

PC Private Computer

Quectel

Preliminary

Page 27: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 26 / 27

RAM Random Access Memory

RMC Recommended Minimum Navigation Information

SNR Signal Noise Ratio

SNTP Simple Network Time Protocol

TTFF Time to First Fix

UART Universal Asynchronous Receiver & Transmitter

URL Uniform Resource Locator

USB Universal Serial Bus

UTC Universal Time Code

VTG Track Made Good and Ground Speed

Quectel

Preliminary

Page 28: BG96 GNSS AT Commands Manuals3.cn-north-1.amazonaws.com.cn/docs.rakwireless.com/en... · 2018. 7. 30. · LTE Module Series BG96 GNSS AT Commands Manual BG96_GNSS_AT_Commands_Manual

LTE Module Series BG96 GNSS AT Commands Manual

BG96_GNSS_AT_Commands_Manual Confidential / Released 27 / 27

5 Appendix B Summary of Error Codes

The <errcode> indicates an error related to GNSS operation. The details about <errcode> are described

in the following table.

Table 3: Summary of Error Codes

<errcode> Meaning

501 Invalid parameter(s)

502 Operation not supported

503 GNSS subsystem busy

504 Session is ongoing

505 Session not active

506 Operation timeout

507 Function not enabled

508 Time information error

512 Validity time is out of range

513 Internal resource error

514 GNSS locked

515 End by E911

516 Not fixed now

549 Unknown error

Quectel

Preliminary