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

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

/// HBT — Heartbeat Supervision.
///
/// Wire: `interval,operation_status,msg_id`
#[derive(Debug, Clone, PartialEq)]
pub struct Hbt {
    /// Configured repeat interval in seconds.
    pub interval: Option<f32>,
    /// Equipment operation status ('A' = normal).
    pub operation_status: Option<char>,
    /// Sequential message identifier (0–9).
    pub msg_id: Option<u8>,
}

impl Hbt {
    /// 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 interval = r.f32();
        let operation_status = r.char();
        let msg_id = r.u8();
        Some(Self {
            interval,
            operation_status,
            msg_id,
        })
    }
}

impl NmeaEncodable for Hbt {
    const SENTENCE_TYPE: &str = "HBT";

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

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

    #[test]
    fn hbt_empty() {
        let s = Hbt {
            interval: None,
            operation_status: None,
            msg_id: None,
        }
        .to_sentence("HC");
        let f = parse_frame(s.trim()).expect("valid");
        let h = Hbt::parse(&f.fields).expect("parse");
        assert!(h.interval.is_none());
        assert!(h.operation_status.is_none());
        assert!(h.msg_id.is_none());
    }

    #[test]
    fn hbt_encode_roundtrip() {
        let original = Hbt {
            interval: Some(1.5),
            operation_status: Some('A'),
            msg_id: Some(1),
        };
        let sentence = original.to_sentence("HC");
        let frame = parse_frame(sentence.trim()).expect("re-parse");
        let parsed = Hbt::parse(&frame.fields).expect("parse");
        assert_eq!(original, parsed);
    }

    #[test]
    fn hbt_hchbt_gonmea() {
        let frame = parse_frame("$HCHBT,1.5,A,1*23").expect("valid");
        let h = Hbt::parse(&frame.fields).expect("parse");
        assert!((h.interval.expect("interval") - 1.5).abs() < 0.01);
        assert_eq!(h.operation_status, Some('A'));
        assert_eq!(h.msg_id, Some(1));
    }
}