nmea-kit 0.5.6

Bidirectional NMEA 0183 parser and encoder with AIS decoding
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

use crate::nmea::field::{FieldReader, FieldWriter, NmeaEncodable};

/// PGRME — Garmin Estimated Position Error.
///
/// Wire: `h_err,M,v_err,M,s_err,M`
///
/// Proprietary sentence: `parse_frame` sets `talker = ""`, `sentence_type = "PGRME"`.
/// Encode with `to_proprietary_sentence()`.
#[derive(Debug, Clone, PartialEq)]
pub struct Pgrme {
    /// Horizontal position error in metres.
    pub horizontal: Option<f32>,
    /// Vertical position error in metres.
    pub vertical: Option<f32>,
    /// Spherical (3D) position error in metres.
    pub spherical: Option<f32>,
}

impl Pgrme {
    /// Parse fields from a decoded NMEA frame.
    /// Always returns `Some`; missing or malformed fields become `None`.
    pub fn parse(fields: &[&str]) -> Option<Self> {
        let mut r = FieldReader::new(fields);
        let horizontal = r.f32();
        r.skip(); // M
        let vertical = r.f32();
        r.skip(); // M
        let spherical = r.f32();
        r.skip(); // M
        Some(Self {
            horizontal,
            vertical,
            spherical,
        })
    }
}

impl NmeaEncodable for Pgrme {
    const SENTENCE_TYPE: &str = "RME";
    const PROPRIETARY_ID: &str = "PGRME";

    fn encode(&self) -> Vec<String> {
        let mut w = FieldWriter::new();
        w.f32(self.horizontal);
        w.fixed('M');
        w.f32(self.vertical);
        w.fixed('M');
        w.f32(self.spherical);
        w.fixed('M');
        w.finish()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::parse_frame;

    #[test]
    fn pgrme_empty() {
        let s = Pgrme {
            horizontal: None,
            vertical: None,
            spherical: None,
        }
        .to_proprietary_sentence();
        let f = parse_frame(s.trim()).expect("valid");
        let p = Pgrme::parse(&f.fields).expect("parse");
        assert!(p.horizontal.is_none());
        assert!(p.vertical.is_none());
        assert!(p.spherical.is_none());
    }

    #[test]
    fn pgrme_encode_roundtrip() {
        let original = Pgrme {
            horizontal: Some(3.3),
            vertical: Some(4.9),
            spherical: Some(6.0),
        };
        let sentence = original.to_proprietary_sentence();
        let frame = parse_frame(sentence.trim()).expect("re-parse");
        let parsed = Pgrme::parse(&frame.fields).expect("parse");
        assert_eq!(original, parsed);
    }

    #[test]
    fn pgrme_pgrme_gonmea() {
        let frame = parse_frame("$PGRME,3.3,M,4.9,M,6.0,M*25").expect("valid");
        let p = Pgrme::parse(&frame.fields).expect("parse");
        assert!((p.horizontal.expect("horizontal") - 3.3).abs() < 0.01);
        assert!((p.vertical.expect("vertical") - 4.9).abs() < 0.01);
        assert!((p.spherical.expect("spherical") - 6.0).abs() < 0.01);
    }
}