Struct nmea::Nmea

pub struct Nmea {

    pub fix_time: Option<NaiveTime>,
    pub fix_date: Option<NaiveDate>,
    pub fix_type: Option<FixType>,
    pub latitude: Option<f64>,
    pub longitude: Option<f64>,
    pub altitude: Option<f32>,
    pub speed_over_ground: Option<f32>,
    pub true_course: Option<f32>,
    pub num_of_fix_satellites: Option<u32>,
    pub hdop: Option<f32>,
    pub vdop: Option<f32>,
    pub pdop: Option<f32>,
    pub geoid_separation: Option<f32>,
    pub fix_satellites_prns: Option<Vec<u32, 12>>,
    /* private fields */
}

NMEA parser

This struct parses NMEA sentences, including checksum checks and sentence validation.

Examples

use nmea::Nmea;

let mut nmea = Nmea::default();
let gga = "$GPGGA,092750.000,5321.6802,N,00630.3372,W,1,8,1.03,61.7,M,55.2,M,,*76";
// feature `GGA` should be enabled to parse this sentence.
nmea.parse(gga).unwrap();
println!("{}", nmea);

Fields

fix_time: Option<NaiveTime>

fix_date: Option<NaiveDate>

fix_type: Option<FixType>

latitude: Option<f64>

longitude: Option<f64>

altitude: Option<f32>

MSL Altitude in meters

speed_over_ground: Option<f32>

true_course: Option<f32>

num_of_fix_satellites: Option<u32>

hdop: Option<f32>

vdop: Option<f32>

pdop: Option<f32>

geoid_separation: Option<f32>

Geoid separation in meters

fix_satellites_prns: Option<Vec<u32, 12>>

Implementations

impl<'a> Nmea

pub fn create_for_navigation( required_sentences_for_nav: &[SentenceType] ) -> Result<Nmea, Error<'a>>

Constructs a new Nmea for navigation purposes.

Examples

use nmea::{Nmea, SentenceType};

let mut nmea = Nmea::create_for_navigation(&[SentenceType::RMC, SentenceType::GGA]).unwrap();
let gga = "$GPGGA,092750.000,5321.6802,N,00630.3372,W,1,8,1.03,61.7,M,55.2,M,,*76";
// feature `GGA` should be enabled to parse this sentence.
nmea.parse(gga).unwrap();
println!("{}", nmea);

pub fn fix_timestamp(&self) -> Option<NaiveTime>

Returns fix type

pub fn fix_type(&self) -> Option<FixType>

Returns fix type

pub fn latitude(&self) -> Option<f64>

Returns last fixed latitude in degrees. None if not fixed.

pub fn longitude(&self) -> Option<f64>

Returns last fixed longitude in degrees. None if not fixed.

pub fn altitude(&self) -> Option<f32>

Returns altitude above WGS-84 ellipsoid, meters.

pub fn fix_satellites(&self) -> Option<u32>

Returns the number of satellites use for fix.

pub fn hdop(&self) -> Option<f32>

Returns the number fix HDOP

pub fn geoid_altitude(&self) -> Option<f32>

Returns the altitude above MSL (geoid), meters.

pub fn satellites(&self) -> Vec<Satellite, 58>

Returns used satellites

pub fn parse(&mut self, sentence: &'a str) -> Result<SentenceType, Error<'a>>

Parse any NMEA sentence and stores the result of sentences that include:

• altitude
• latitude and longitude
• speed_over_ground
• and other

The type of sentence is returned if implemented and valid.

pub fn parse_for_fix(&mut self, xs: &'a str) -> Result<FixType, Error<'a>>

pub fn last_txt(&self) -> Option<&TxtData>

Trait Implementations

impl Clone for Nmea

fn clone(&self) -> Nmea

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Nmea

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

Formats the value using the given formatter.

impl Default for Nmea

fn default() -> Nmea

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Nmea

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Nmea

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

Formats the value using the given formatter.

impl Serialize for Nmea

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.