nmea-parser 0.3.1

NMEA parser for AIS and GNSS sentences
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

# NMEA Parser for Rust

[![NMEA Parser on crates.io][cratesio-image]][cratesio]
[![NMEA Parser on docs.rs][docsrs-image]][docsrs]

[cratesio-image]: https://img.shields.io/crates/v/nmea-parser.svg
[cratesio]: https://crates.io/crates/nmea-parser
[docsrs-image]: https://docs.rs/nmea-parser/badge.svg
[docsrs]: https://docs.rs/nmea-parser

This Rust crate aims to cover the most important [AIS] and [GNSS] sentences. It 
supports both class A and B types of AIS.

## Usage

Include the following fragment in your `Cargo.toml` file:

```toml
[dependencies]
nmea-parser = "0.3.1"
```

The following sample program uses the crate to parse the given NMEA sentence 
and to print some  fields of the resulting data object:

```rust
use nmea_parser::*;

let mut store = NmeaStore::new();
let sentences = vec![
  "!AIVDM,1,1,,A,H42O55i18tMET00000000000000,2*6D",
  "!AIVDM,1,1,,A,H42O55lti4hhhilD3nink000?050,0*40",
  "$GAGGA,123519,4807.038,N,01131.000,E,1,08,0.9,545.4,M,46.9,M,,*56",
];

for sentence in sentences {    
    match nmea_parser::parse_sentence(sentence, &mut store)? {
        ParsedSentence::VesselDynamicData(vdd) => {
            println!("MMSI:  {}",        vdd.mmsi);
            println!("Speed: {:.1} kts", vdd.sog_knots.unwrap());
            println!("");
        },
        ParsedSentence::VesselStaticData(vds) => {
            println!("MMSI:  {}", vds.mmsi);
            println!("Flag:  {}", vds.country().unwrap());
            println!("Name:  {}", vds.name.unwrap());
            println!("Type:  {}", vds.ship_type);
            println!("");
        },
        ParsedSentence::Gga(gga) => {
            println!("Source:    {}",     gga.source);
            println!("Latitude:  {:.3}°", gga.latitude.unwrap());
            println!("Longitude: {:.3}°", gga.longitude.unwrap());
            println!("");
        },
        ParsedSentence::Rmc(rmc) => {
            println!("Source:  {}",        rmc.source);
            println!("Speed:   {:.1} kts", rmc.sog_knots.unwrap());
            println!("Bearing: {}°",       rmc.bearing.unwrap());
            println!("Time:    {}",        rmc.timestamp.unwrap());
            println!("");
        },
        _ => {
        }
    }
}
```

The program outputs the following lines:

```
MMSI:  271041815
Flag:  TR
Name:  PROGUY
Type:  passenger

System:    Galileo
Latitude:  48.117°
Longitude: 11.517°

```

## Features

The following features are included in the current version of the crate.

|Feature          |Description                                                                        |
|-----------------|-----------------------------------------------------------------------------------|
|AIS sentences    |VDM/VDO types 1-3, 5, 18-19 and 24                                                 |
|GNSS sentences   |GGA, RMC, GSA, GSV, VTG, GLL                                                       |
|Satellite systems|GPS, GLONASS, Galileo, BeiDou, NavIC and QZSS                                      | 

## Roadmap

Until version 1.0 refactoring and renaming of crate's code elements is likely to happen.

|Version |Category    |Goal                                                                 |
|--------|------------|---------------------------------------------------------------------|
|0.4     |AIS         |AIS VDM/VDO t4, t6-t17, t20-t23, t25-27                              |
|1.0     |meta        |Stable API, optimizations, enhanced documentation                    |
|1.1     |GNSS        |ALM, TRF, STN, VBW, XTC, XTE, ZDA                                    |
|1.2     |GNSS, route |AAM, BOD, BWC, R00, RMB, RTE, WPL, ZTG                               |
|1.3     |GNSS, misc  |APB, DTM, RMA, GRS, GST, MSK, MSS, STN, VBW                          |

[AIS]: https://en.wikipedia.org/wiki/Automatic_identification_system
[GNSS]: https://en.wikipedia.org/wiki/Satellite_navigation