nmea-kit 0.3.0

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

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

/// DPT — Depth of Water.
///
/// Wire: `depth,offset,rangescale`
#[derive(Debug, Clone, PartialEq)]
pub struct Dpt {
    /// Water depth below transducer in meters.
    pub depth: Option<f32>,
    /// Offset from transducer in meters (positive = keel, negative = surface).
    pub offset: Option<f32>,
    /// Maximum range scale in use in meters.
    pub rangescale: Option<f32>,
}

impl Dpt {
    /// 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 {
            depth: r.f32(),
            offset: r.f32(),
            rangescale: r.f32(),
        })
    }
}

impl NmeaEncodable for Dpt {
    const SENTENCE_TYPE: &str = "DPT";

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

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

    #[test]
    fn dpt_empty() {
        let f = parse_frame("$IIDPT,,,*6C").expect("valid");
        let d = Dpt::parse(&f.fields).expect("parse");
        assert!(d.depth.is_none());
        assert!(d.offset.is_none());
        assert!(d.rangescale.is_none());
    }

    #[test]
    fn dpt_gpsd() {
        let f = parse_frame("$INDPT,2.2,0.0*47").expect("valid DPT frame");
        let d = Dpt::parse(&f.fields).expect("parse DPT");
        assert!((d.depth.expect("depth present") - 2.2).abs() < 0.01);
    }

    #[test]
    fn dpt_negative_offset_signalk() {
        let f = parse_frame("$IIDPT,4.1,-1.0*69").expect("valid DPT frame");
        let d = Dpt::parse(&f.fields).expect("parse DPT");
        assert!((d.offset.expect("offset present") - (-1.0)).abs() < 0.01);
    }

    #[test]
    fn dpt_parse_signalk() {
        let f = parse_frame("$IIDPT,4.1,0.0*45").expect("valid DPT frame");
        let d = Dpt::parse(&f.fields).expect("parse DPT");
        assert!((d.depth.expect("depth present") - 4.1).abs() < 0.01);
    }

    #[test]
    fn dpt_encode_roundtrip() {
        let d = Dpt {
            depth: Some(4.1),
            offset: Some(1.0),
            rangescale: None,
        };
        let s = d.to_sentence("II");
        let f = parse_frame(s.trim()).expect("re-parse DPT frame");
        let d2 = Dpt::parse(&f.fields).expect("re-parse DPT");
        assert_eq!(d, d2);
    }
}