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

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

/// PCDIN — SeaSmart.Net NMEA 2000 to NMEA 0183 Protocol.
///
/// Wire: `pgn,timestamp,source,data`
///
/// Proprietary sentence: `parse_frame` sets `talker = ""`, `sentence_type = "PCDIN"`.
/// Encode with `to_proprietary_sentence()`.
#[derive(Debug, Clone, PartialEq)]
pub struct Pcdin {
    /// PGN (Parameter Group Number) in hex.
    pub pgn: Option<String>,
    /// Timestamp in hex milliseconds.
    pub timestamp: Option<String>,
    /// Source address in hex.
    pub source: Option<String>,
    /// Raw data payload in hex.
    pub data: Option<String>,
}

impl Pcdin {
    /// 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 pgn = r.string();
        let timestamp = r.string();
        let source = r.string();
        let data = r.string();
        Some(Self {
            pgn,
            timestamp,
            source,
            data,
        })
    }
}

impl NmeaEncodable for Pcdin {
    const SENTENCE_TYPE: &str = "DIN";
    const PROPRIETARY_ID: &str = "PCDIN";

    fn encode(&self) -> Vec<String> {
        let mut w = FieldWriter::new();
        w.string(self.pgn.as_deref());
        w.string(self.timestamp.as_deref());
        w.string(self.source.as_deref());
        w.string(self.data.as_deref());
        w.finish()
    }
}

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

    #[test]
    fn pcdin_empty() {
        let s = Pcdin {
            pgn: None,
            timestamp: None,
            source: None,
            data: None,
        }
        .to_proprietary_sentence();
        let f = parse_frame(s.trim()).expect("valid");
        let p = Pcdin::parse(&f.fields).expect("parse");
        assert!(p.pgn.is_none());
        assert!(p.data.is_none());
    }

    #[test]
    fn pcdin_encode_roundtrip() {
        let original = Pcdin {
            pgn: Some("01F112".to_string()),
            timestamp: Some("000C72EA".to_string()),
            source: Some("09".to_string()),
            data: Some("28C36A0000B40AFD".to_string()),
        };
        let sentence = original.to_proprietary_sentence();
        let frame = parse_frame(sentence.trim()).expect("re-parse");
        let parsed = Pcdin::parse(&frame.fields).expect("parse");
        assert_eq!(original, parsed);
    }

    #[test]
    fn pcdin_pcdin_gonmea() {
        let frame =
            parse_frame("$PCDIN,01F112,000C72EA,09,28C36A0000B40AFD*56").expect("valid");
        let p = Pcdin::parse(&frame.fields).expect("parse");
        assert_eq!(p.pgn.as_deref(), Some("01F112"));
        assert_eq!(p.timestamp.as_deref(), Some("000C72EA"));
        assert_eq!(p.source.as_deref(), Some("09"));
        assert_eq!(p.data.as_deref(), Some("28C36A0000B40AFD"));
    }
}