nmea-kit 0.5.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

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

/// PKNSH — Kenwood Short Position Report (Normal format).
///
/// Proprietary Kenwood sentence.
/// Wire: `$PKNSH,lat,ns,lon,ew,time,validity,unit_id`
///
/// Proprietary sentence: `parse_frame` sets `talker = ""`, `sentence_type = "PKNSH"`.
#[derive(Debug, Clone, PartialEq)]
pub struct Pknsh {
    /// Latitude in DDDMM.MMM format.
    pub lat: Option<f64>,
    /// North/South indicator.
    pub ns: Option<char>,
    /// Longitude in DDDMM.MMM format.
    pub lon: Option<f64>,
    /// East/West indicator.
    pub ew: Option<char>,
    /// UTC time (hhmmss).
    pub time: Option<String>,
    /// Validity (A=valid, V=invalid).
    pub validity: Option<char>,
    /// Unit identifier.
    pub unit_id: Option<String>,
}

impl Pknsh {
    /// 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 lat = r.f64();
        let ns = r.char();
        let lon = r.f64();
        let ew = r.char();
        let time = r.string();
        let validity = r.char();
        let unit_id = r.string();
        Some(Self {
            lat,
            ns,
            lon,
            ew,
            time,
            validity,
            unit_id,
        })
    }
}

impl NmeaEncodable for Pknsh {
    const SENTENCE_TYPE: &str = "NSH";
    const PROPRIETARY_ID: &str = "PKNSH";

    fn encode(&self) -> Vec<String> {
        let mut w = FieldWriter::new();
        w.f64(self.lat);
        w.char(self.ns);
        w.f64(self.lon);
        w.char(self.ew);
        w.string(self.time.as_deref());
        w.char(self.validity);
        w.string(self.unit_id.as_deref());
        w.finish()
    }
}

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

    #[test]
    fn pknsh_empty() {
        let s = Pknsh {
            lat: None,
            ns: None,
            lon: None,
            ew: None,
            time: None,
            validity: None,
            unit_id: None,
        }
        .to_proprietary_sentence();
        let f = parse_frame(s.trim()).expect("valid");
        let p = Pknsh::parse(&f.fields).expect("parse");
        assert!(p.lat.is_none());
        assert!(p.unit_id.is_none());
    }

    #[test]
    fn pknsh_encode_roundtrip() {
        let original = Pknsh {
            lat: Some(3926.7952),
            ns: Some('N'),
            lon: Some(12000.5947),
            ew: Some('W'),
            time: Some("022732".to_string()),
            validity: Some('A'),
            unit_id: Some("U00001".to_string()),
        };
        let sentence = original.to_proprietary_sentence();
        let frame = parse_frame(sentence.trim()).expect("re-parse");
        let parsed = Pknsh::parse(&frame.fields).expect("parse");
        assert_eq!(original, parsed);
    }

    #[test]
    fn pknsh_kenwood_gonmea() {
        let f =
            parse_frame("$PKNSH,3926.7952,N,12000.5947,W,022732,A,U00001*63").expect("valid PKNSH");
        let p = Pknsh::parse(&f.fields).expect("parse PKNSH");
        assert!((p.lat.expect("lat") - 3926.7952).abs() < 0.0001);
        assert_eq!(p.ns, Some('N'));
        assert!((p.lon.expect("lon") - 12000.5947).abs() < 0.0001);
        assert_eq!(p.ew, Some('W'));
        assert_eq!(p.time, Some("022732".to_string()));
        assert_eq!(p.validity, Some('A'));
        assert_eq!(p.unit_id, Some("U00001".to_string()));
    }
}