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

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

/// HDM — Heading Magnetic.
///
/// Wire: `headingM,M`
#[derive(Debug, Clone, PartialEq)]
pub struct Hdm {
    /// Magnetic heading in degrees.
    pub heading_mag: Option<f32>,
}

impl Hdm {
    /// 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 heading_mag = r.f32();
        r.skip(); // M
        Some(Self { heading_mag })
    }
}

impl NmeaEncodable for Hdm {
    const SENTENCE_TYPE: &str = "HDM";

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

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

    #[test]
    fn hdm_empty() {
        let f = parse_frame("$IIHDM,,*41").expect("valid");
        let m = Hdm::parse(&f.fields).expect("parse");
        assert!(m.heading_mag.is_none());
    }

    #[test]
    fn hdm_full_signalk() {
        let frame = parse_frame("$04HDM,186.5,M*2C").expect("valid");
        let hdm = Hdm::parse(&frame.fields).expect("parse HDM");
        assert!((hdm.heading_mag.expect("hdg") - 186.5).abs() < 0.1);
    }

    #[test]
    fn hdm_gp_pynmeagps() {
        let frame = parse_frame("$GPHDM,223.12,M*05").expect("valid pynmeagps GP HDM");
        let hdm = Hdm::parse(&frame.fields).expect("parse HDM");
        assert!((hdm.heading_mag.expect("hdg") - 223.12).abs() < 0.01);
    }

    #[test]
    fn hdm_ii_pynmeagps() {
        let frame = parse_frame("$IIHDM,70.6,M*13").expect("valid pynmeagps II HDM");
        let hdm = Hdm::parse(&frame.fields).expect("parse HDM");
        assert!((hdm.heading_mag.expect("hdg") - 70.6).abs() < 0.1);
    }
    #[test]
    fn hdm_encode_roundtrip() {
        let hdm = Hdm {
            heading_mag: Some(186.5),
        };
        let sentence = hdm.to_sentence("04");
        let frame = parse_frame(sentence.trim()).expect("re-parse");
        let hdm2 = Hdm::parse(&frame.fields).expect("re-parse HDM");
        assert_eq!(hdm, hdm2);
    }
}