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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

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

/// VBW — Dual Ground/Water Speed.
#[derive(Debug, Clone, PartialEq)]
pub struct Vbw {
    /// Longitudinal water speed in knots.
    pub long_water_spd: Option<f32>,
    /// Transverse water speed in knots.
    pub trans_water_spd: Option<f32>,
    /// Water speed status ('A' = valid, 'V' = invalid).
    pub water_spd_status: Option<char>,
    /// Longitudinal ground speed in knots.
    pub long_ground_spd: Option<f32>,
    /// Transverse ground speed in knots.
    pub trans_ground_spd: Option<f32>,
    /// Ground speed status ('A' = valid, 'V' = invalid).
    pub ground_spd_status: Option<char>,
    /// Stern transverse water speed in knots.
    pub stern_trans_water_spd: Option<f32>,
    /// Stern water speed status ('A' = valid, 'V' = invalid).
    pub stern_water_spd_status: Option<char>,
    /// Stern transverse ground speed in knots.
    pub stern_trans_ground_spd: Option<f32>,
    /// Stern ground speed status ('A' = valid, 'V' = invalid).
    pub stern_ground_spd_status: Option<char>,
}

impl Vbw {
    /// 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 {
            long_water_spd: r.f32(),
            trans_water_spd: r.f32(),
            water_spd_status: r.char(),
            long_ground_spd: r.f32(),
            trans_ground_spd: r.f32(),
            ground_spd_status: r.char(),
            stern_trans_water_spd: r.f32(),
            stern_water_spd_status: r.char(),
            stern_trans_ground_spd: r.f32(),
            stern_ground_spd_status: r.char(),
        })
    }
}

impl NmeaEncodable for Vbw {
    const SENTENCE_TYPE: &str = "VBW";

    fn encode(&self) -> Vec<String> {
        let mut w = FieldWriter::new();
        w.f32(self.long_water_spd);
        w.f32(self.trans_water_spd);
        w.char(self.water_spd_status);
        w.f32(self.long_ground_spd);
        w.f32(self.trans_ground_spd);
        w.char(self.ground_spd_status);
        w.f32(self.stern_trans_water_spd);
        w.char(self.stern_water_spd_status);
        w.f32(self.stern_trans_ground_spd);
        w.char(self.stern_ground_spd_status);
        w.finish()
    }
}

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

    #[test]
    fn vbw_12_pynmeagps() {
        let frame =
            parse_frame("$GPVBW,12.3,0.07,A,11.78,0.12,A*6F").expect("valid pynmeagps VBW frame");
        let vbw = Vbw::parse(&frame.fields).expect("parse VBW");
        assert!((vbw.long_water_spd.expect("long_water") - 12.3).abs() < 0.1);
        assert!((vbw.trans_water_spd.expect("trans_water") - 0.07).abs() < 0.01);
        assert_eq!(vbw.water_spd_status, Some('A'));
        assert!((vbw.long_ground_spd.expect("long_ground") - 11.78).abs() < 0.01);
        assert!((vbw.trans_ground_spd.expect("trans_ground") - 0.12).abs() < 0.01);
        assert_eq!(vbw.ground_spd_status, Some('A'));
    }

    #[test]
    fn vbw_empty() {
        let frame = parse_frame("$IIVBW,,,,,,,,,*6F").expect("valid VBW frame");
        let vbw = Vbw::parse(&frame.fields).expect("parse VBW");
        assert!(vbw.long_water_spd.is_none());
        assert!(vbw.trans_water_spd.is_none());
        assert!(vbw.water_spd_status.is_none());
        assert!(vbw.long_ground_spd.is_none());
        assert!(vbw.trans_ground_spd.is_none());
        assert!(vbw.ground_spd_status.is_none());
        assert!(vbw.stern_trans_water_spd.is_none());
        assert!(vbw.stern_water_spd_status.is_none());
        assert!(vbw.stern_trans_ground_spd.is_none());
        assert!(vbw.stern_ground_spd_status.is_none());
    }

    #[test]
    fn vbw_stern_gonmea() {
        let frame = parse_frame("$VMVBW,-7.1,0.1,A,,,V,,V,,V*65").expect("valid go-nmea VBW frame");
        let vbw = Vbw::parse(&frame.fields).expect("parse VBW");
        assert!((vbw.long_water_spd.expect("long_water") - (-7.1)).abs() < 0.01);
        assert!((vbw.trans_water_spd.expect("trans_water") - 0.1).abs() < 0.01);
        assert_eq!(vbw.water_spd_status, Some('A'));
        assert!(vbw.long_ground_spd.is_none());
        assert!(vbw.trans_ground_spd.is_none());
        assert_eq!(vbw.ground_spd_status, Some('V'));
        assert!(vbw.stern_trans_water_spd.is_none());
        assert_eq!(vbw.stern_water_spd_status, Some('V'));
        assert!(vbw.stern_trans_ground_spd.is_none());
        assert_eq!(vbw.stern_ground_spd_status, Some('V'));
    }

    #[test]
    fn vbw_encode_roundtrip() {
        let original = Vbw {
            long_water_spd: Some(5.2),
            trans_water_spd: Some(0.1),
            water_spd_status: Some('A'),
            long_ground_spd: Some(5.3),
            trans_ground_spd: Some(0.2),
            ground_spd_status: Some('A'),
            stern_trans_water_spd: None,
            stern_water_spd_status: None,
            stern_trans_ground_spd: None,
            stern_ground_spd_status: None,
        };
        let sentence = original.to_sentence("II");
        let f = parse_frame(sentence.trim()).expect("re-parse VBW frame");
        let parsed = Vbw::parse(&f.fields).expect("parse VBW from re-encoded frame");
        assert_eq!(original, parsed);
    }
}