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

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

/// PMTK001 — MTK GNSS Module Acknowledgement.
///
/// Wire: `cmd,flag`
///
/// Proprietary sentence: `parse_frame` sets `talker = ""`, `sentence_type = "PMTK001"`.
/// Encode with `to_proprietary_sentence()`.
#[derive(Debug, Clone, PartialEq)]
pub struct Pmtk {
    /// Command packet number being acknowledged.
    pub cmd: Option<u32>,
    /// Acknowledgement flag (0=invalid, 1=unsupported, 2=failed, 3=succeeded).
    pub flag: Option<u8>,
}

impl Pmtk {
    /// 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 cmd = r.u32();
        let flag = r.u8();
        Some(Self { cmd, flag })
    }
}

impl NmeaEncodable for Pmtk {
    const SENTENCE_TYPE: &str = "001";
    const PROPRIETARY_ID: &str = "PMTK001";

    fn encode(&self) -> Vec<String> {
        let mut w = FieldWriter::new();
        w.u32(self.cmd);
        w.u8(self.flag);
        w.finish()
    }
}

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

    #[test]
    fn pmtk_empty() {
        let s = Pmtk { cmd: None, flag: None }.to_proprietary_sentence();
        let f = parse_frame(s.trim()).expect("valid");
        let p = Pmtk::parse(&f.fields).expect("parse");
        assert!(p.cmd.is_none());
        assert!(p.flag.is_none());
    }

    #[test]
    fn pmtk_encode_roundtrip() {
        let original = Pmtk {
            cmd: Some(604),
            flag: Some(3),
        };
        let sentence = original.to_proprietary_sentence();
        let frame = parse_frame(sentence.trim()).expect("re-parse");
        let parsed = Pmtk::parse(&frame.fields).expect("parse");
        assert_eq!(original, parsed);
    }

    #[test]
    fn pmtk_pmtk001_gonmea() {
        let frame = parse_frame("$PMTK001,604,3*32").expect("valid");
        let p = Pmtk::parse(&frame.fields).expect("parse");
        assert_eq!(p.cmd, Some(604));
        assert_eq!(p.flag, Some(3));
    }
}