Struct nrfxlib::gnss::GnssSocket

pub struct GnssSocket(_);

Represents a connection to the GPS sub-system.

Implementations

impl GnssSocket

pub fn new() -> Result<GnssSocket, Error>

Create a new GNSS socket.

pub fn start(&self, delete_mask: DeleteMask) -> Result<(), Error>

Deletes the specified information from non-volatile memory, then starts the GNSS sub-system.

pub fn stop(&self) -> Result<(), Error>

Stop the GNSS system.

pub fn set_fix_interval(&self, interval: u16) -> Result<(), Error>

Set the Fix Interval.

Defines the interval between each fix in seconds. The default is 1. A value of 0 means single-fix mode.

pub fn set_fix_retry(&self, interval: u16) -> Result<(), Error>

Set the Fix Retry time.

Defines how long (in seconds) the receiver should try to get a fix. The default is 60 seconds and a value of 0 means wait forever.

pub fn get_fix_interval(&self) -> Result<u16, Error>

Get the current Fix Interval (in seconds).

See set_fix_interval for more information.

pub fn get_fix_retry(&self) -> Result<u16, Error>

Get the Fix Retry time (in seconds).

See set_fix_retry for more information.

pub fn set_nmea_mask(&self, mask: NmeaMask) -> Result<(), Error>

Set the NMEA mask.

You can select which particular NMEA strings you want from the GNSS socket here.

If you pass a default NmeaMask, you get no NMEA frames (only GnssData::Position or GnssData::Agps frames).

pub fn get_nmea_mask(&self) -> Result<NmeaMask, Error>

Get the current NMEA mask.

See set_nmea_mask.

pub fn get_fix(&self) -> Result<Option<GnssData>, Error>

Get a fix from the GNSS system.

Performs a read on the GNSS socket. The Nordic library determines which frame type you get on each read. You will get None if there is no fix to be read.

pub fn get_fix_blocking(&self) -> Result<Option<GnssData>, Error>

Wait for a fix from the GNSS system.

Performs a read on the GNSS socket and returns either a GnssData::Nmea, if an NMEA string has been returned, or a GnssData::Position. The Nordic library determines which you get on each read. You will get None if there is no fix to be read.

Trait Implementations

impl Debug for GnssSocket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for GnssSocket

type Target = Socket

The resulting type after dereferencing.

fn deref(&self) -> &Socket

Dereferences the value.

impl DerefMut for GnssSocket

fn deref_mut(&mut self) -> &mut Socket

Mutably dereferences the value.

impl Drop for GnssSocket

fn drop(&mut self)

Executes the destructor for this type.

impl Pollable for GnssSocket

fn get_fd(&self) -> i32