Skip to main content

gnss-session.configure(settingName, settingValue)

Configure the GNSS sub-system for NMEA output

Availability

Device (from impOS™ 43)
Only available on imps with cellular modems

Parameters

Name Type Description
settingName String The GNSS NMEA setting’s name
settingValue String or integer The GNSS NMEA setting’s value

Returns

Table — see below

Description

This method is used to set or to query the configuration of the NMEA (National Marine Electronics Association) output of the GNSS sub-system. If you pass the name of a setting and a corresponding value, the value will be applied, provided it is valid. If you pass only a setting name, not an accompanying value, the method will return the current value of that key.

Values are returned as a table with at least two keys: config and status. The value of its config key is a table of zero or more key-value pairs representing the requested settings and their values.

For the Quectel BG96, the possible values of settingName and of settingValue are:

Setting Name Setting Value Description
output none, usbnmea or uartnmea Set the NMEA sentences output port:
none — No output
usbnmea — USB (default)
uartnmeahardware.uart3 on imp006
nmeasrc 0-1 Enable/disable acquisition of NMEA sentences:
0 — disable
1 — enable (default)
gpsnmeatype 0-31 Configure output type of GPS NMEA sentences:
0 — disable
1 — GGA
2 — RMC
4 — GSV
8 — GSA
16 — VTG
OR all the types you require. Default: 31 (all types)
glonassnmeatype 0-7 Configure output type of GLONASS NMEA sentences:
0 — disable (default)
1 — GSV
2 — GSA
4 — GNS
galileonmeatype 0-1 Configure output type of Galileo NMEA sentences:
0 — disable (default)
1 — GSV
beidounmeatype 0-3 Configure output type of BeiDou NMEA sentences:
0 — disable (default)
1 — GSA
2 — GSV
gsvextnmeatype 0-1 Enable/disable output of GSVEXT NMEA sentences:
0 — disable (default)
1 — enable
gnssconfig 0-6 Configure GNSS constellation:
See table below. Default: 1
Note GPS is always on
autogps 0-1 Enable/disable GNSS to run automatically:
0 — disable (default)
1 — enable

GNSS Constellation Values

Gnssconfig Value Glonass BeiDou Galileo
0 OFF OFF OFF
1 (default) ON ON ON
2 ON ON OFF
3 ON OFF ON
4 ON OFF OFF
5 OFF ON ON
6 OFF OFF ON

Note GPS is always on

For further details, please see Quectel BG96 GNSS AT Commands Manual, page 9.

The returned table also contains the key status. Its value will be zero if no error occurred, or an error code (see gnss-session for details).