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

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

/// ROT — Rate of Turn.
///
/// Wire: `rot,valid`
#[derive(Debug, Clone, PartialEq)]
pub struct Rot {
    /// Rate of turn in degrees per minute (negative = port).
    pub rate_of_turn: Option<f32>,
    /// Data validity ('A' = valid, 'V' = invalid).
    pub valid: Option<char>,
}

impl Rot {
    /// 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 {
            rate_of_turn: r.f32(),
            valid: r.char(),
        })
    }
}

impl NmeaEncodable for Rot {
    const SENTENCE_TYPE: &str = "ROT";

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

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

    #[test]
    fn rot_empty() {
        let f = parse_frame("$IIROT,,*49").expect("valid");
        let r = Rot::parse(&f.fields).expect("parse");
        assert!(r.rate_of_turn.is_none());
        assert!(r.valid.is_none());
    }

    #[test]
    fn rot_encode_roundtrip() {
        let rot = Rot {
            rate_of_turn: Some(35.6),
            valid: Some('A'),
        };
        let sentence = rot.to_sentence("GP");
        assert!(sentence.starts_with("$GPROT,"));
        let frame = parse_frame(sentence.trim()).expect("re-parse");
        let rot2 = Rot::parse(&frame.fields).expect("re-parse ROT");
        assert_eq!(rot.rate_of_turn, rot2.rate_of_turn);
        assert_eq!(rot.valid, rot2.valid);
    }

    #[test]
    fn rot_negative_pynmeagps() {
        let frame = parse_frame("$IIROT,-7.3,A*0F").expect("valid");
        let rot = Rot::parse(&frame.fields).expect("parse ROT");
        assert!((rot.rate_of_turn.expect("rot") - (-7.3)).abs() < 0.1);
        assert_eq!(rot.valid, Some('A'));
    }

    #[test]
    fn rot_positive_gpsd() {
        let frame = parse_frame("$GPROT,35.6,A*01").expect("valid");
        let rot = Rot::parse(&frame.fields).expect("parse ROT");
        assert!((rot.rate_of_turn.expect("rot") - 35.6).abs() < 0.1);
        assert_eq!(rot.valid, Some('A'));
    }

    #[test]
    fn rot_zero_gpsd() {
        let frame = parse_frame("$HEROT,0.0,A*2B").expect("valid");
        let rot = Rot::parse(&frame.fields).expect("parse ROT");
        assert!((rot.rate_of_turn.expect("rot") - 0.0).abs() < 0.01);
        assert_eq!(rot.valid, Some('A'));
    }
}