RUI3 (RAK Unified Interface 3) - RAK4631
Public Member Functions
bg77::qgpscfg

Public Member Functions

String get (String)
 
String set (String, String)
 
String set (String, String, int)
 
String set (String, int)
 
String set (String, int, int)
 
String set (String, int, String)
 

Member Function Documentation

◆ get()

String get ( String  )
Description
This api queries and configures various GNSS settings, including the NMEA output port and output types of NMEA sentences.
Syntax
bg77.qgpscfg.get(para)
Parameters
paraString String type.
  • "outport"
  • "gnssconfig"
  • "nmeafmt"
  • "gpsnmeatype"
  • "glonassnmeatype"
  • "galileonmeatype"
  • "beidounmeatype"
  • "qzssnmeatype"
  • "nmeasrc"
  • "autogps"
  • "priority"
  • "xtra_info"
  • "gpsdop"
  • "nmea_epe"
  • "estimation_error"
  • "xtra_apn"
  • "xtra_download"
  • "test_mode"
Returns
String response

◆ set() [1/5]

String set ( String  ,
String   
)
Description
This api queries and configures various GNSS settings, including the NMEA output port and output types of NMEA sentences.
Syntax
bg77.qgpscfg.set(para,conf)
Parameters
paraString String type.
  • "outport"
confString
  • "outport" String type. NMEA output port.
    • "none" Close NMEA sentence output
    • "usbnmea" Output via USB NMEA port
    • "uartnmea" Output via GNSS UART port
    • "auxnmea" Output via debug UART port
Returns
String response

◆ set() [2/5]

String set ( String  ,
String  ,
int   
)
Description
This api queries and configures various GNSS settings, including the NMEA output port and output types of NMEA sentences.
Syntax
bg77.qgpscfg.set(para,conf1,conf2)
Parameters
paraString String type.
  • "outport"
conf1String
  • "outport" String type. NMEA output port.
    • "none" Close NMEA sentence output
    • "usbnmea" Output via USB NMEA port
    • "uartnmea" Output via GNSS UART port
    • "auxnmea" Output via debug UART port
conf2int
  • "outport" Integer type. Baud rate of GNSS UART and debug UART port. Unit: bps.
    • 4800
    • 9600
    • 19200
    • 38400
    • 57600
    • 115200
    • 230400
    • 460800
    • 921600
Returns
String response

◆ set() [3/5]

String set ( String  ,
int   
)
Description
This api queries and configures various GNSS settings, including the NMEA output port and output types of NMEA sentences.
Syntax
bg77.qgpscfg.set(para,conf)
Parameters
paraString String type.
  • "gnssconfig"
  • "nmeafmt"
  • "gpsnmeatype"
  • "glonassnmeatype"
  • "galileonmeatype"
  • "beidounmeatype"
  • "qzssnmeatype"
  • "nmeasrc"
  • "autogps"
  • "priority"
  • "xtrafilesize"
  • "nmea_epe"
  • "xtra_download"
  • "test_mode"
confint
  • "gnssconfig" Integer type. Supported GNSS constellation.
    • 1 GPS + GLONASS
    • 2 GPS + BeiDou
    • 3 GPS + Galileo
    • 4 GPS + QZSS
    • 5 Variable. One of the options (1–4) is selected based on MCC of the camped network
  • "nmeafmt" Integer type. NMEA protocol standards.
    • 0 The NMEA output sentences conform to Qualcomm standards.
    • 1 The NMEA output sentences conform to the NMEA 0183 version 4.10
  • "gpsnmeatype" Integer type. Output type of GPS NMEA sentences by ORed. Range: 0–31.
    • 0 Disable
    • 1 GGA
    • 2 RMC
    • 4 GSV
    • 8 GSA
    • 16 VTG
    • 31 All the five types above
  • "glonassnmeatype" Integer type. Output type of GLONASS NMEA sentences by ORed. Range: 0–3.
    • 0 Disable
    • 1 GSV
    • 2 GSA
    • 3 GSV + GSA
  • "galileonmeatype" Integer type. Output type of Galileo NMEA sentences by ORed. Range: 0–3.
    • 0 Disable
    • 1 GSV
    • 2 GSA
    • 3 GSV + GSA
  • "beidounmeatype" Integer type. Output type of BeiDou NMEA sentences by ORed. Range: 0–3.
    • 0 Disable
    • 1 GSA
    • 2 GSV
    • 3 GSA + GSV
  • "qzssnmeatype" Integer type. Output type of QZSS NMEA sentences by ORed. Range: 0–1.
    • 0 Disable
    • 1 GSA
  • "nmeasrc" Integer type. Sets whether to acquire the original NMEA sentences via AT+QGPSGNMEA.
    • 0 Disable
    • 1 Enable
  • "autogps" Integer type. Enable/disable GNSS to run automatically after the module is powered on.
    • 0 Disable GNSS to run automatically
    • 1 Enable GNSS to run automatically
  • "priority" Integer type. Switch between GNSS and WWAN priority mode.
    • 0 GNSS priority mode
    • 1 WWAN priority mode
  • "xtrafilesize" Integer type. The XTRA file type.
    • 1 Download the XTRA file with 1-day validity
    • 3 Download the XTRA file with 3-day validity
    • 7 Download the XTRA file with 7-day validity
  • "nmea_epe" Integer type. Enable/disable the NMEA message output of the receiver’s estimated accuracy.
    • 0 Disable
    • 1 Enable. Sentence format:
      $PQEPE,<timestamp>,<status>,<HDOP>,<hori_unc>,<vert_unc>,<speed_u nc>="">,<head_unc>*<checksum>
  • "xtra_download" Integer type. Operation mode.
    • 1 Trigger the download of the XTRA file
  • "test_mode" Integer type. Enable/disable the XTRA test mode.
    • 0 Disable
    • 1 Enable.
Returns
String response

◆ set() [4/5]

String set ( String  ,
int  ,
int   
)
Description
This api queries and configures various GNSS settings, including the NMEA output port and output types of NMEA sentences.
Syntax
bg77.qgpscfg.set(para,conf1,conf2)
Parameters
paraString String type.
  • "priority"
conf1int
  • "priority" Integer type. Switch between GNSS and WWAN priority mode.
    • 0 GNSS priority mode
    • 1 WWAN priority mode
conf2int
  • "priority" Integer type. Choose whether to save the configuration to NVRAM.
    • 0 Do not save to NVRAM
    • 1 Save to NVRAM
Returns
String response

◆ set() [5/5]

String set ( String  ,
int  ,
String   
)
Description
This api queries and configures various GNSS settings, including the NMEA output port and output types of NMEA sentences.
Syntax
bg77.qgpscfg.set(para,conf1,conf2)
Parameters
paraString String type.
  • "priority"
conf1int
  • "xtra_apn" Integer type. IP family type.
    • 0 IPv4
    • 1 IPv6
conf2String
  • "priority" String type. Access point name.
Returns
String response