nmea-kit 0.4.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
89
90
91
92

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

/// DBT — Depth Below Transducer.
///
/// Wire: `depth_f,f,depth_m,M,depth_F,F`
#[derive(Debug, Clone, PartialEq)]
pub struct Dbt {
    /// Depth below transducer in feet.
    pub depth_feet: Option<f32>,
    /// Depth below transducer in meters.
    pub depth_meters: Option<f32>,
    /// Depth below transducer in fathoms.
    pub depth_fathoms: Option<f32>,
}

impl Dbt {
    /// 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 depth_feet = r.f32();
        r.skip();
        let depth_meters = r.f32();
        r.skip();
        let depth_fathoms = r.f32();
        Some(Self {
            depth_feet,
            depth_meters,
            depth_fathoms,
        })
    }
}

impl NmeaEncodable for Dbt {
    const SENTENCE_TYPE: &str = "DBT";

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

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

    #[test]
    fn dbt_empty() {
        let f = parse_frame("$IIDBT,,,,,,*52").expect("valid");
        let d = Dbt::parse(&f.fields).expect("parse");
        assert!(d.depth_feet.is_none());
        assert!(d.depth_meters.is_none());
        assert!(d.depth_fathoms.is_none());
    }

    #[test]
    fn dbt_gpsd() {
        let f = parse_frame("$SDDBT,7.7,f,2.3,M,1.3,F*05").expect("valid DBT frame");
        let d = Dbt::parse(&f.fields).expect("parse DBT");
        assert!((d.depth_meters.expect("depth_meters present") - 2.3).abs() < 0.01);
    }

    #[test]
    fn dbt_encode_roundtrip() {
        let original = Dbt {
            depth_feet: Some(35.53),
            depth_meters: Some(10.83),
            depth_fathoms: Some(5.85),
        };
        let sentence = original.to_sentence("II");
        assert!(sentence.starts_with("$IIDBT,"));

        let frame = parse_frame(sentence.trim()).expect("re-parse DBT sentence");
        let parsed = Dbt::parse(&frame.fields).expect("parse DBT from re-encoded frame");

        assert_eq!(original, parsed);
    }

    #[test]
    fn dbt_signalk() {
        let f = parse_frame("$IIDBT,035.53,f,010.83,M,005.85,F*23").expect("valid DBT frame");
        let d = Dbt::parse(&f.fields).expect("parse DBT");
        assert!((d.depth_meters.expect("depth_meters present") - 10.83).abs() < 0.01);
    }
}