nmea-kit 0.5.2

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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

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

/// XTE — Cross Track Error.
///
/// Wire: `gwarn,lccwarn,ctrkerr,dirs,disunit[,mode]`
#[derive(Debug, Clone, PartialEq)]
pub struct Xte {
    /// General warning flag ('A' = OK, 'V' = warning).
    pub gwarn: Option<char>,
    /// Loran-C cycle lock warning ('A' = OK, 'V' = warning).
    pub lccwarn: Option<char>,
    /// Cross-track error magnitude in nautical miles.
    pub ctrkerr: Option<f32>,
    /// Direction to steer ('L' = left, 'R' = right).
    pub dirs: Option<char>,
    /// Distance unit ('N' = nautical miles).
    pub disunit: Option<char>,
    /// Mode indicator ('A' = autonomous, 'D' = differential, etc.).
    pub mode: Option<char>,
}

impl Xte {
    /// 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);
        Some(Self {
            gwarn: r.char(),
            lccwarn: r.char(),
            ctrkerr: r.f32(),
            dirs: r.char(),
            disunit: r.char(),
            mode: r.char(),
        })
    }
}

impl NmeaEncodable for Xte {
    const SENTENCE_TYPE: &str = "XTE";

    fn encode(&self) -> Vec<String> {
        let mut w = FieldWriter::new();
        w.char(self.gwarn);
        w.char(self.lccwarn);
        w.f32(self.ctrkerr);
        w.char(self.dirs);
        w.char(self.disunit);
        w.char(self.mode);
        w.finish()
    }
}

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

    #[test]
    fn xte_empty() {
        let f = Xte {
            gwarn: None,
            lccwarn: None,
            ctrkerr: None,
            dirs: None,
            disunit: None,
            mode: None,
        }
        .to_sentence("GP");
        let frame = parse_frame(f.trim()).expect("valid");
        let x = Xte::parse(&frame.fields).expect("parse");
        assert!(x.gwarn.is_none());
        assert!(x.ctrkerr.is_none());
        assert!(x.mode.is_none());
    }

    #[test]
    fn xte_encode_roundtrip() {
        let original = Xte {
            gwarn: Some('A'),
            lccwarn: Some('A'),
            ctrkerr: Some(0.67),
            dirs: Some('L'),
            disunit: Some('N'),
            mode: Some('D'),
        };
        let sentence = original.to_sentence("GP");
        let frame = parse_frame(sentence.trim()).expect("re-parse");
        let parsed = Xte::parse(&frame.fields).expect("re-parse XTE");
        assert_eq!(original, parsed);
    }

    #[test]
    fn xte_faa_mode_gonmea() {
        let frame = parse_frame("$GPXTE,V,V,,,N,S*43").expect("valid go-nmea XTE frame");
        let xte = Xte::parse(&frame.fields).expect("parse XTE");
        assert_eq!(xte.gwarn, Some('V'));
        assert_eq!(xte.lccwarn, Some('V'));
        assert!(xte.ctrkerr.is_none());
        assert!(xte.dirs.is_none());
        assert_eq!(xte.disunit, Some('N'));
        assert_eq!(xte.mode, Some('S'));
    }

    #[test]
    fn xte_pynmeagps() {
        let frame = parse_frame("$GPXTE,A,A,0.67,L,N*6F").expect("valid pynmeagps XTE frame");
        let xte = Xte::parse(&frame.fields).expect("parse XTE");
        assert_eq!(xte.gwarn, Some('A'));
        assert_eq!(xte.lccwarn, Some('A'));
        assert!((xte.ctrkerr.expect("ctrkerr") - 0.67).abs() < 0.01);
        assert_eq!(xte.dirs, Some('L'));
        assert_eq!(xte.disunit, Some('N'));
        assert!(xte.mode.is_none());
    }
}