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

Public Member Functions

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

Member Function Documentation

◆ set() [1/2]

String set ( int  )
Description
This api acquires positioning information.
Syntax
bg77.qgpsloc.set(mode)
Parameters
modeint Integer type. Latitude and longitude display format.
  • If <mode> ≤ 2, the timer periodically queries and reports. In this case, the command has to be executed only after getting the position fix.
    • 0 <latitude>,<longitude> format: ddmm.mmmmN/S,dddmm.mmmmE/W
    • 1 <latitude>,<longitude> format: ddmm.mmmmmm,N/S,dddmm.mmmmmm,E/W
    • 2 <latitude>,<longitude> format: (-)dd.ddddd,(-)ddd.ddddd
  • If <mode> ≥ 3, the positioning information is reported according to the frequency of RMC NMEA sentences. There is no restriction regarding the command execution ─ the command can be executed at any time.
    • 3 <latitude>,<longitude> format: ddmm.mmmmN/S,dddmm.mmmmE/W
    • 4 <latitude>,<longitude> format: ddmm.mmmmmm,N/S,dddmm.mmmmmm,E/W
    • 5 <latitude>,<longitude> format: (-)dd.ddddd,(-)ddd.ddddd
Returns
String response

◆ set() [2/2]

String set ( int  ,
int   
)
Description
This api acquires positioning information.
Syntax
bg77.qgpsloc.set(mode,para)
Parameters
modeint Integer type. Latitude and longitude display format.
  • If <mode> ≤ 2, the timer periodically queries and reports. In this case, the command has to be executed only after getting the position fix.
    • 0 <latitude>,<longitude> format: ddmm.mmmmN/S,dddmm.mmmmE/W
    • 1 <latitude>,<longitude> format: ddmm.mmmmmm,N/S,dddmm.mmmmmm,E/W
    • 2 <latitude>,<longitude> format: (-)dd.ddddd,(-)ddd.ddddd
  • If <mode> ≥ 3, the positioning information is reported according to the frequency of RMC NMEA sentences. There is no restriction regarding the command execution ─ the command can be executed at any time.
    • 3 <latitude>,<longitude> format: ddmm.mmmmN/S,dddmm.mmmmE/W
    • 4 <latitude>,<longitude> format: ddmm.mmmmmm,N/S,dddmm.mmmmmm,E/W
    • 5 <latitude>,<longitude> format: (-)dd.ddddd,(-)ddd.ddddd
paraint Integer type.
  • If <mode> <=2, the parameter specifies the time period when the queried results are reported. Range: 0–3600. Default value: 0. Unit: second.
    • 0 Disable reporting.
  • If <mode> >=3, the parameter specifies the reporting mode of the positioning information. Range: 0–2.
    • 0 Disable reporting
    • 1 Report once only when the fix status is changed: from “not fixed” to “fixed”, or vice versa.
    • 2 Always report. Report according to the output frequency of NMEA sentences.
Returns
String response

◆ get()

String get ( )
Description
This api acquires positioning information.
Syntax
bg77.qgpsloc.get()
Returns
String response