RUI3 (RAK Unified Interface 3) - RAK4631
bg77::qgps

Public Member Functions

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

Member Function Documentation

◆ get()

String get ( )
Description
This api turns on the GNSS function.
Syntax
bg77.qgps.get()
Returns
String response

◆ set() [1/5]

String set ( int  )
Description
This api turns on the GNSS function.
Syntax
bg77.qgps.set(GNSS_mode)
Parameters
GNSS_modeint Integer type. GNSS working mode.
  • 1 Stand-alone mode
Returns
String response

◆ set() [2/5]

String set ( int  ,
int   
)
Description
This api turns on the GNSS function.
Syntax
bg77.qgps.set(GNSS_mode,accuracy)
Parameters
GNSS_modeint Integer type. GNSS working mode.
  • 1 Stand-alone mode
accuracyint Integer type. The desired level of accuracy that is acceptable for fix computation.
  • 1 Low Accuracy (1000 m)
  • 2 Medium Accuracy (500 m)
  • 3 High Accuracy (50 m)
Returns
String response

◆ set() [3/5]

String set ( int  ,
int  ,
int   
)
Description
This api turns on the GNSS function.
Syntax
bg77.qgps.set(GNSS_mode,accuracy,fix_count)
Parameters
GNSS_modeint Integer type. GNSS working mode.
  • 1 Stand-alone mode
accuracyint Integer type. The desired level of accuracy that is acceptable for fix computation.
  • 1 Low Accuracy (1000 m)
  • 2 Medium Accuracy (500 m)
  • 3 High Accuracy (50 m)
fix_countint Integer type. Number of attempts for positioning or continuous positioning. Range: 0–1000. Default value: 0. 0 indicates continuous positioning. Other values indicate the number of attempts for positioning. When the value reaches the specified number of attempts, the GNSS will be stopped.
Returns
String response

◆ set() [4/5]

String set ( int  ,
int  ,
int  ,
float   
)
Description
This api turns on the GNSS function.
Syntax
bg77.qgps.set(GNSS_mode,accuracy,fix_count,fix_rate)
Parameters
GNSS_modeint Integer type. GNSS working mode.
  • 1 Stand-alone mode
accuracyint Integer type. The desired level of accuracy that is acceptable for fix computation.
  • 1 Low Accuracy (1000 m)
  • 2 Medium Accuracy (500 m)
  • 3 High Accuracy (50 m)
fix_countint Integer type. Number of attempts for positioning or continuous positioning. Range: 0–1000. Default value: 0. 0 indicates continuous positioning. Other values indicate the number of attempts for positioning. When the value reaches the specified number of attempts, the GNSS will be stopped.
fix_ratefloat The interval time between the first- and second-time positioning. Unit: second.
  • If <fix_rate> < 1, it is a float type. Available options:
    • 0.1
    • 0.2
    • 0.5
  • If <fix_rate> ≥ 1, it is an integer type. Range: 1–65535. Default value: 1.
Returns
String response

◆ set() [5/5]

String set ( int  ,
int  ,
int  ,
float  ,
int   
)
Description
This api turns on the GNSS function.
Syntax
bg77.qgps.set(GNSS_mode,accuracy,fix_count,fix_rate,HEPE)
Parameters
GNSS_modeint Integer type. GNSS working mode.
  • 1 Stand-alone mode
accuracyint Integer type. The desired level of accuracy that is acceptable for fix computation.
  • 1 Low Accuracy (1000 m)
  • 2 Medium Accuracy (500 m)
  • 3 High Accuracy (50 m)
fix_countint Integer type. Number of attempts for positioning or continuous positioning. Range: 0–1000. Default value: 0. 0 indicates continuous positioning. Other values indicate the number of attempts for positioning. When the value reaches the specified number of attempts, the GNSS will be stopped.
fix_ratefloat The interval time between the first- and second-time positioning. Unit: second.
  • If <fix_rate> < 1, it is a float type. Available options:
    • 0.1
    • 0.2
    • 0.5
  • If <fix_rate> ≥ 1, it is an integer type. Range: 1–65535. Default value: 1.
HEPEint Integer type. Accuracy threshold. GNSS NMEA sentences will not be outputted if the accuracy is less than <HEPE>. 0 means disable this function. Range: 0–1000. Default value: 0. Unit: meter
Returns
String response