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
96
97
98
99
100
101
102
103
104
105
106
107

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

/// THS — True Heading and Status.
///
/// Wire: `heading_true,mode`
#[derive(Debug, Clone, PartialEq)]
pub struct Ths {
    /// True heading in degrees (0–359.9).
    pub heading_true: Option<f32>,
    /// Mode indicator ('A' = autonomous, 'E' = estimated, 'M' = manual,
    /// 'S' = simulated, 'V' = void/invalid).
    pub mode: Option<char>,
}

impl Ths {
    /// 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 {
            heading_true: r.f32(),
            mode: r.char(),
        })
    }
}

impl NmeaEncodable for Ths {
    const SENTENCE_TYPE: &str = "THS";

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

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

    #[test]
    fn ths_autonomous_gonmea() {
        let frame = parse_frame("$INTHS,123.456,A*20").expect("valid go-nmea THS frame");
        let ths = Ths::parse(&frame.fields).expect("parse THS");
        assert!((ths.heading_true.expect("hdg") - 123.456).abs() < 0.001);
        assert_eq!(ths.mode, Some('A'));
    }

    #[test]
    fn ths_empty() {
        let f = Ths {
            heading_true: None,
            mode: None,
        }
        .to_sentence("GP");
        let frame = parse_frame(f.trim()).expect("valid");
        let t = Ths::parse(&frame.fields).expect("parse");
        assert!(t.heading_true.is_none());
        assert!(t.mode.is_none());
    }

    #[test]
    fn ths_encode_roundtrip() {
        let original = Ths {
            heading_true: Some(77.52),
            mode: Some('E'),
        };
        let sentence = original.to_sentence("GP");
        let frame = parse_frame(sentence.trim()).expect("re-parse");
        let parsed = Ths::parse(&frame.fields).expect("re-parse THS");
        assert_eq!(original, parsed);
    }

    #[test]
    fn ths_invalid_gonmea() {
        let frame = parse_frame("$INTHS,,V*1E").expect("valid go-nmea THS void frame");
        let ths = Ths::parse(&frame.fields).expect("parse THS");
        assert!(ths.heading_true.is_none());
        assert_eq!(ths.mode, Some('V'));
    }

    #[test]
    fn ths_manual_gonmea() {
        let frame = parse_frame("$INTHS,123.456,M*2C").expect("valid go-nmea THS frame");
        let ths = Ths::parse(&frame.fields).expect("parse THS");
        assert!((ths.heading_true.expect("hdg") - 123.456).abs() < 0.001);
        assert_eq!(ths.mode, Some('M'));
    }

    #[test]
    fn ths_pynmeagps() {
        let frame = parse_frame("$GPTHS,77.52,E*34").expect("valid pynmeagps THS frame");
        let ths = Ths::parse(&frame.fields).expect("parse THS");
        assert!((ths.heading_true.expect("hdg") - 77.52).abs() < 0.01);
        assert_eq!(ths.mode, Some('E'));
    }

    #[test]
    fn ths_simulator_gonmea() {
        let frame = parse_frame("$INTHS,123.456,S*32").expect("valid go-nmea THS frame");
        let ths = Ths::parse(&frame.fields).expect("parse THS");
        assert!((ths.heading_true.expect("hdg") - 123.456).abs() < 0.001);
        assert_eq!(ths.mode, Some('S'));
    }
}