GNSS API

API for accessing the GNSS module on the modem. More...

Topics
	A-GNSS data request bitmask values
	Bitmask values for the data_flags member in the nrf_modem_gnss_agnss_data_frame.
	A-GNSS data type enumerator
	Use these values to indicate the type of A-GNSS data written using nrf_modem_gnss_agnss_write.
	Bitmask values for flags in the PVT notification
	Bitmask values for the flags member in the nrf_modem_gnss_pvt_data_frame.
	Data type enumerator
	Use these values to indicate the type of data read using nrf_modem_gnss_read.
	Delete bitmask values
	Bitmask values to be used as an argument for function nrf_modem_gnss_nv_data_delete.
	Dynamics mode enumerator
	Dynamics mode values to be used as an argument for function nrf_modem_gnss_dyn_mode_change.
	Event type enumerator
	Event types that trigger the handler function.
	GNSS signal IDs
	Used to indicate the GNSS signal type.
	GNSS signal bitmask values
	Use these bitmask values to enable different GNSS signals.
	GNSS system IDs
	Used to indicate the GNSS system type.
	NMEA string bitmask values
	Use these bitmask values to enable different type of NMEA output strings.
	Power save mode enumerator
	Use these values to select which power save mode GNSS should use. This only affects continuous navigation mode. When GNSS engages duty-cycled tracking, it only tracks for 20% of time and spends the rest of the time in sleep. The different modes control how aggressively GNSS engages duty-cycled tracking, but the duty-cycling itself is the same with both modes.
	QZSS NMEA mode enumerator
	Use these values to select if QZSS satellites are reported in NMEA sentences or not.
	Satellite flags bitmask values
	Bitmask values for the flags member in the SV elements in the PVT notification struct.
	Sleep timing source enumerator
	Used to select which sleep timing source GNSS uses.
	Use case bitmask values
	Use these bit values to select which use case mode GNSS should use. A use case mode is a combination of the values of all of the bits.

Data Structures
struct	nrf_modem_gnss_1pps_config
	Configuration for the nrf_modem_gnss_1pps_enable function. More...
struct	nrf_modem_gnss_datetime
	Date and time. More...
struct	nrf_modem_gnss_sv
	Space Vehicle (SV) information. More...
struct	nrf_modem_gnss_pvt_data_frame
	Position, Velocity and Time (PVT) data frame. More...
struct	nrf_modem_gnss_nmea_data_frame
	Single null-terminated NMEA sentence. More...
struct	nrf_modem_gnss_agnss_system_data_need
	Ephemeris and almanac data need for a system. More...
struct	nrf_modem_gnss_agnss_data_frame
	A-GNSS notification data frame used by GNSS to let the application know it needs new assistance data. More...
struct	nrf_modem_gnss_agnss_sv_expiry
	Ephemeris and almanac expiry times for a satellite. More...
struct	nrf_modem_gnss_agnss_expiry
	A-GNSS data expiry. More...
struct	nrf_modem_gnss_agnss_gps_data_utc
	A-GNSS GPS UTC parameters. More...
struct	nrf_modem_gnss_agnss_gps_data_ephemeris
	A-GNSS GPS/QZSS ephemeris data. More...
struct	nrf_modem_gnss_agnss_gps_data_almanac
	A-GNSS GPS/QZSS almanac data. More...
struct	nrf_modem_gnss_agnss_data_klobuchar
	A-GNSS Klobuchar ionospheric correction data. More...
struct	nrf_modem_gnss_agnss_data_nequick
	A-GNSS NeQuick ionospheric correction data. More...
struct	nrf_modem_gnss_agnss_gps_data_tow_element
	A-GNSS GPS TOW assistance data for a satellite. More...
struct	nrf_modem_gnss_agnss_gps_data_system_time_and_sv_tow
	A-GNSS GPS system time and satellite TOW data. More...
struct	nrf_modem_gnss_agnss_data_location
	A-GNSS location data. More...
struct	nrf_modem_gnss_agps_data_integrity
	A-GPS satellite integrity data. More...
struct	nrf_modem_gnss_agnss_data_signal_integrity
	A-GNSS satellite integrity mask for a signal. More...
struct	nrf_modem_gnss_agnss_data_integrity
	A-GNSS satellite integrity data. More...

Macros
#define	NRF_MODEM_GNSS_MAX_SYSTEMS   4
#define	NRF_MODEM_GNSS_MAX_SIGNALS   4
#define	NRF_MODEM_GNSS_MAX_SATELLITES   12
	Maximum number of satellites that can be tracked at the same time.
#define	NRF_MODEM_GNSS_NUM_GPS_SATELLITES   32
#define	NRF_MODEM_GNSS_NMEA_MAX_LEN   83
	Maximum length of an NMEA string including the null-terminator.
#define	NRF_MODEM_GNSS_MAX_SV_EXPIRY_TIMES   127
#define	NRF_MODEM_GNSS_AGNSS_GPS_MAX_SV_TOW   32
	Maximum number of TOW elements in the TOW array.

Typedefs
typedef void(*	nrf_modem_gnss_event_handler_type_t) (int event)
	Event handler prototype.

Functions
int32_t	nrf_modem_gnss_event_handler_set (nrf_modem_gnss_event_handler_type_t handler)
	Sets the GNSS event handler.
int32_t	nrf_modem_gnss_signal_mask_set (uint8_t signal_mask)
	Sets the supported GNSS signals. Signals which have the corresponding bit set are enabled.
int32_t	nrf_modem_gnss_elevation_threshold_set (uint8_t angle)
	Set below which elevation angle GNSS should stop tracking a satellite.
int32_t	nrf_modem_gnss_use_case_set (uint8_t use_case)
	Sets targeted start and runtime performance.
int32_t	nrf_modem_gnss_fix_interval_set (uint16_t fix_interval)
	Sets the GNSS fix interval in seconds.
int32_t	nrf_modem_gnss_fix_retry_set (uint16_t fix_retry)
	Sets the GNSS fix retry period in seconds.
int32_t	nrf_modem_gnss_nmea_mask_set (uint16_t nmea_mask)
	Sets which NMEA strings are enabled.
int32_t	nrf_modem_gnss_power_mode_set (uint8_t power_mode)
	Sets the used power saving mode.
int32_t	nrf_modem_gnss_timing_source_set (uint8_t timing_source)
	Sets the used timing source during GNSS sleep.
int32_t	nrf_modem_gnss_qzss_nmea_mode_set (uint8_t nmea_mode)
	Sets the used QZSS NMEA mode.
int32_t	nrf_modem_gnss_qzss_prn_mask_set (uint16_t prn_mask)
	Sets which QZSS PRNs are enabled.
int32_t	nrf_modem_gnss_start (void)
	Starts GNSS.
int32_t	nrf_modem_gnss_stop (void)
	Stops GNSS.
int32_t	nrf_modem_gnss_nv_data_delete (uint32_t delete_mask)
	Deletes GNSS data from non-volatile memory.
int32_t	nrf_modem_gnss_prio_mode_enable (void)
	Enables GNSS priority over LTE idle mode procedures.
int32_t	nrf_modem_gnss_prio_mode_disable (void)
	Disables GNSS priority over LTE idle mode procedures.
int32_t	nrf_modem_gnss_dyn_mode_change (uint32_t mode)
	Changes GNSS dynamics mode.
int32_t	nrf_modem_gnss_1pps_enable (const struct nrf_modem_gnss_1pps_config *config)
	Enables 1PPS functionality.
int32_t	nrf_modem_gnss_1pps_disable (void)
	Disables 1PPS functionality.
int32_t	nrf_modem_gnss_read (void *buf, int32_t buf_len, int type)
	Reads data from GNSS.
int32_t	nrf_modem_gnss_agnss_write (void *buf, int32_t buf_len, uint16_t type)
	Writes A-GNSS data to GNSS.
int32_t	nrf_modem_gnss_agnss_expiry_get (struct nrf_modem_gnss_agnss_expiry *agnss_expiry)
	Reads the current A-GNSS data need and expiry times from GNSS.

Detailed Description

API for accessing the GNSS module on the modem.