nmea-kit 0.5.3

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
122
123
124

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

/// PSKPDPT — Skipper Depth Sentence.
///
/// Wire: `depth,offset,range_scale,echo_strength,channel,transducer_location`
///
/// Proprietary sentence: `parse_frame` sets `talker = ""`, `sentence_type = "PSKPDPT"`.
/// Encode with `to_proprietary_sentence()`.
#[derive(Debug, Clone, PartialEq)]
pub struct Pskpdpt {
    /// Water depth in metres.
    pub depth: Option<f32>,
    /// Transducer offset in metres.
    pub offset: Option<f32>,
    /// Maximum depth range scale in metres.
    pub range_scale: Option<u32>,
    /// Echo strength (0–100).
    pub echo_strength: Option<u8>,
    /// Channel number.
    pub channel: Option<u8>,
    /// Transducer location description.
    pub transducer_location: Option<String>,
}

impl Pskpdpt {
    /// 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 depth = r.f32();
        let offset = r.f32();
        let range_scale = r.u32();
        let echo_strength = r.u8();
        let channel = r.u8();
        let transducer_location = r.string();
        Some(Self {
            depth,
            offset,
            range_scale,
            echo_strength,
            channel,
            transducer_location,
        })
    }
}

impl NmeaEncodable for Pskpdpt {
    const SENTENCE_TYPE: &str = "DPT";
    const PROPRIETARY_ID: &str = "PSKPDPT";

    fn encode(&self) -> Vec<String> {
        let mut w = FieldWriter::new();
        w.f32(self.depth);
        w.f32(self.offset);
        w.u32(self.range_scale);
        w.u8(self.echo_strength);
        w.u8(self.channel);
        w.string(self.transducer_location.as_deref());
        w.finish()
    }
}

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

    #[test]
    fn pskpdpt_empty() {
        let s = Pskpdpt {
            depth: None,
            offset: None,
            range_scale: None,
            echo_strength: None,
            channel: None,
            transducer_location: None,
        }
        .to_proprietary_sentence();
        let f = parse_frame(s.trim()).expect("valid");
        let p = Pskpdpt::parse(&f.fields).expect("parse");
        assert!(p.depth.is_none());
        assert!(p.transducer_location.is_none());
    }

    #[test]
    fn pskpdpt_encode_roundtrip() {
        let original = Pskpdpt {
            depth: Some(2.5),
            offset: Some(0.0),
            range_scale: Some(10),
            echo_strength: Some(10),
            channel: Some(3),
            transducer_location: None,
        };
        let sentence = original.to_proprietary_sentence();
        let frame = parse_frame(sentence.trim()).expect("re-parse");
        let parsed = Pskpdpt::parse(&frame.fields).expect("parse");
        assert_eq!(original, parsed);
    }

    #[test]
    fn pskpdpt_pskpdpt_gonmea() {
        let frame = parse_frame("$PSKPDPT,0002.5,+00.0,0010,10,03,*77").expect("valid");
        let p = Pskpdpt::parse(&frame.fields).expect("parse");
        assert!((p.depth.expect("depth") - 2.5).abs() < 0.01);
        assert!((p.offset.expect("offset") - 0.0).abs() < 0.01);
        assert_eq!(p.range_scale, Some(10));
        assert_eq!(p.echo_strength, Some(10));
        assert_eq!(p.channel, Some(3));
        assert!(p.transducer_location.is_none());
    }

    #[test]
    fn pskpdpt_with_location_gonmea() {
        let frame = parse_frame("$PSKPDPT,0002.5,-01.1,0010,10,03,AFT*22").expect("valid");
        let p = Pskpdpt::parse(&frame.fields).expect("parse");
        assert!((p.depth.expect("depth") - 2.5).abs() < 0.01);
        assert!((p.offset.expect("offset") - (-1.1)).abs() < 0.01);
        assert_eq!(p.range_scale, Some(10));
        assert_eq!(p.echo_strength, Some(10));
        assert_eq!(p.channel, Some(3));
        assert_eq!(p.transducer_location.as_deref(), Some("AFT"));
    }
}