NMEA

Complete documentation can be found on www.docs.rs/nmea

NMEA 0183 sentence parser for Rust.

Supported sentences:

NMEA Standard Sentences

• AAM
• ALM
• BOD
• BWC
• BWW
• DBK
• GBS
• GGA *
• GLL *
• GNS *
• GSA *
• GSV *
• HDT
• MDA
• MTW
• MWV
• RMC *
• VHW
• VTG *
• ZDA
• ZFO
• ZTG

Other Sentences

• TXT *

Vendor Extensions

• PGRMZ

* Nmea::parse() supported sentences

How to contribute

We have an ongoing effort to support as many sentences from NMEA 0183 as possible, starting with the most well-known. If you'd like to contribute by writing a parser for a given message, check out the Supporting additional sentences (AeroRust/nmea#54) issue and contribute in 3 easy steps:

1. Write a comment - Please write a comment in the issue for the sentence(s) you'd like to implement, you will be mentioned on the task to avoid duplicate implementations.
2. Implement each sentence alongside at least 1 test in its own module under the ./src/sentences directory using the nom crate.
3. Open a PR 🎉

What is NMEA 0183?

NMEA 0183 is a combined electrical and data specification for communication between marine electronics such as echo sounder, sonars, anemometer, gyrocompass, autopilot, GPS receivers and many other types of instruments.

• https://en.wikipedia.org/wiki/NMEA_0183

Usage

Add the nmea dependency in your Cargo.toml:

[dependencies]
nmea = "0.5"

For no_std

This crate support no_std without the use of an allocator ( alloc ), just add the nmea crate without the default features:

[dependencies]
nmea = { version = "0.5", default-features = false }

Parse

To use the NMEA parser create a Nmea struct and feed it with NMEA sentences (only supports GNSS messages, otherwise use the parse_str() and parse_bytes()):

use nmea::Nmea;

fn main() {
    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.
    #[cfg(feature = "GGA")]
    {
        nmea.parse(gga).unwrap();
        println!("{}", nmea);
    }
}

Supported Rust Versions

The Minimum supported Rust version (or MSRV) is 1.60.

Unsafe-free crate

We use #![deny(unsafe_code)] for a fully unsafe-free crate.

License

This project is licensed under the Apache-2.0.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the project by you, shall be licensed as Apache-2.0, without any additional terms or conditions.