yanp 0.1.1

A no_std nmea sentence parser
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
use crate::errors::NmeaSentenceError;
use crate::parsers;
use crate::sentences::{GeneralSentence, SentenceType};

macro_rules! status {
    ($($name:ident, $type:ty : [$($input:tt => $status:ident),+ error: $error:ident]),+) => {
        #[derive(Debug, Clone, Copy, PartialEq)]
        pub enum StatusParsingError {
            $(
                $error,
            )+
        }
        $(
            #[derive(Debug, Clone, Copy, PartialEq)]
            pub enum $name {
                $(
                    $status,
                )+
            }

            impl $name {
                #[allow(unused)]
                pub (crate) fn try_from<'a>(num: $type) -> Result<Self, NmeaSentenceError<'a>> {
                    match num {
                        $(
                            $input => Ok($name::$status),
                        )+
                        _ => Err(NmeaSentenceError::StatusParsingError(StatusParsingError::$error)),
                    }
                }
            }
        )+
    }
}

status! {
    RmStatus, char: [
        'A' => Active,
        'V' => Warning,
        'P' => Precise
        error: RmStatusError
    ],
    LatitudeDirection, char: [
        'N' => North,
        'S' => South
        error: LatitudeDirectionError
    ],
    LongitudeDirection, char: [
        'E' => East,
        'W' => West
        error: LongitudeDirectionError
    ],
    GpsQuality, u8: [
        0 => FixNotAvailable,
        1 => Fix,
        2 => DifferentialFix
        error: GpsQualityError
    ],
    GllStatus, char: [
        'A' => DataValid,
        'V' => DataInvalid,
        'P' => Precise
        error: GllStatusError
    ],
    GsaMode, u8: [
        1 => FixNotAvailable,
        2 => Fix2D,
        3 => Fix3D
        error: GsaModeError
    ],
    GsaSelectionMode, char: [
        'M' => Manual,
        'A' => Automatic
        error: GsaSelectionModeError
    ],
    SteerDirection, char: [
        'L' => Left,
        'R' => Right
        error: SteerDirectionError
    ],
    ArrivalStatus, char: [
        'A' => Arrived,
        'V' => NotArrived
        error: ArrivalStatusError
    ],
    RteMode, char: [
        'c' => CompleteRoute,
        'w' => WorkingRoute
        error: RteModeError
    ],
    DataValidity, char: [
        'A' => DataValid
        error: DataValidityError
    ],
    GnsMode, char: [
        'N' => NoFix,
        'A' => AutonomousFix,
        'D' => DifferentialFix,
        'P' => Precise,
        'R' => RealTime,
        'F' => FloatRTK,
        'E' => Estimated,
        'M' => Manual,
        'S' => Simulator
        error: GnsModeError
    ]
}

/// An enum storing consisting of all NMEA sentence types
/// together with their corresponding data structs
#[derive(Debug, Clone, PartialEq)]
pub enum SentenceData<'a> {
    AAM(AamData),
    ABK(AbkData),
    ACK(AckData),
    ALM(AlmData),
    APA(ApaData),
    APB(ApbData),
    BEC(BecData),
    BOD(BodData<'a>),
    BWC(BwcData<'a>),
    BWR(BwrData),
    BWW(BwwData),
    DBK(DbkData),
    DBS(DbsData),
    DBT(DbtData),
    DCN(DcnData),
    DPT(DptData),
    DTM(DtmData),
    FSI(FsiData),
    GBS(GbsData),
    GGA(GgaData),
    GLC(GlcData),
    GLL(GllData),
    GNS(GnsData),
    GRS(GrsData),
    GST(GstData),
    GSA(GsaData),
    GSV(GsvData),
    GTD(GtdData),
    GXA(GxaData),
    HDG(HdgData),
    HDM(HdmData),
    HDT(HdtData),
    HSC(HscData),
    LCD(LcdData),
    MSK(MskData),
    MTW(MtwData),
    MWV(MwvData),
    OLN(OlnData),
    OSD(OsdData),
    ROO(RooData),
    RMA(RmaData),
    RMB(RmbData<'a>),
    RMC(RmcData),
    ROT(RotData),
    RPM(RpmData),
    RSA(RsaData),
    RSD(RsdData),
    RTE(RteData),
    SFI(SfiData),
    STN(StnData),
    TLL(TllData),
    TTM(TtmData),
    VBW(VbwData),
    VDR(VdrData),
    VHW(VhwData),
    VLW(VlwData),
    VPW(VpwData),
    VTG(VtgData),
    VWR(VwrData),
    WCV(WcvData),
    WNC(WncData),
    WPL(WplData<'a>),
    XDR(XdrData),
    XTE(XteData),
    XTR(XtrData),
    ZDA(ZdaData),
    ZFO(ZfoData),
    ZTG(ZtgData),
}

#[derive(Debug, Clone, Copy, PartialEq)]
/// Represents a UTC timestamp
pub struct GpsTime {
    pub hour: u8,
    pub minute: u8,
    pub second: f32,
}

#[derive(Debug, Clone, Copy, PartialEq)]
/// Represents a geographical position
pub struct GpsPosition {
    pub lat: f32,
    pub lat_dir: LatitudeDirection,
    pub lon: f32,
    pub lon_dir: LongitudeDirection,
}

#[derive(Debug, Clone, Copy, PartialEq)]
/// Represents the current date
pub struct GpsDate {
    pub day: u8,
    pub month: u8,
    pub year: u64,
}

#[derive(Debug, Clone, Copy, PartialEq)]
/// Represents a GSV satellite
pub struct GsvSatellite {
    pub sat_id: Option<u8>,
    pub elevation: Option<f32>,
    pub true_azimuth: Option<f32>,
    pub snr: Option<u8>,
}

#[derive(Debug, Clone, Copy, PartialEq)]
pub struct AamData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct AbkData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct AckData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct AlmData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct ApaData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct ApbData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct BecData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct BodData<'a> {
    pub bearing_true: Option<f32>,
    pub bearing_magnetic: Option<f32>,
    pub to_waypoint: Option<&'a [u8]>,
    pub from_waypoint: Option<&'a [u8]>,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct BwcData<'a> {
    pub time: Option<GpsTime>,
    pub waypoint_position: GpsPosition,
    pub bearing_true: Option<f32>,
    pub bearing_magnetic: Option<f32>,
    pub nautical_miles: Option<f32>,
    pub waypoint: Option<&'a [u8]>,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct BwrData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct BwwData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct DbkData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct DbsData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct DbtData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct DcnData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct DptData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct DtmData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct FsiData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GbsData {
    pub time: Option<GpsTime>,
    pub lat_error: Option<f32>,
    pub lon_error: Option<f32>,
    pub alt_error: Option<f32>,
    pub most_likely_failed_sat: Option<u8>,
    pub missed_probability: Option<f32>,
    pub bias_estimate: Option<f32>,
    pub bias_standard_deviation: Option<f32>,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GgaData {
    pub time: Option<GpsTime>,
    pub position: GpsPosition,
    pub quality: Option<GpsQuality>,
    pub sats_in_view: Option<u8>,
    pub hdop: Option<f32>,
    pub altitude: Option<f32>,
    pub geoid_altitude: Option<f32>,
    pub age_of_differential: Option<f32>,
    pub differential_station_id: Option<u16>,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GlcData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GllData {
    pub position: GpsPosition,
    pub time: Option<GpsTime>,
    pub status: Option<GllStatus>,
}
#[cfg(feature = "alloc")]
#[derive(Debug, Clone, PartialEq)]
pub struct GnsData {
    pub time: Option<GpsTime>,
    pub position: GpsPosition,
    pub mode: Option<alloc::vec::Vec<GnsMode>>,
    pub sats_in_use: Option<u8>,
    pub hdop: Option<f32>,
    pub orthometric_height: Option<f32>,
    pub geoid_seperation: Option<f32>,
    pub age_of_differential: Option<f32>,
    pub differential_station_id: Option<u16>,
}

#[cfg(not(feature = "alloc"))]
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GnsData {}

#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GrsData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GstData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GsaData {
    pub selection_mode: Option<GsaSelectionMode>,
    pub mode: Option<GsaMode>,
    pub satellites: [Option<u8>; 12],
    pub pdob: Option<f32>,
    pub hdop: Option<f32>,
    pub vdop: Option<f32>,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GtdData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GsvData {
    pub number_of_sentences: Option<u16>,
    pub sentence_num: Option<u16>,
    pub sats_in_view: Option<u8>,
    pub sats_info: [Option<GsvSatellite>; 4],
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GxaData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct HdgData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct HdmData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct HdtData {
    pub heading_true: Option<f32>,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct HscData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct LcdData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct MskData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct MtwData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct MwvData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct OlnData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct OsdData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct RooData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct RmaData {
    pub status: Option<RmStatus>,
    pub position: GpsPosition,
    pub time_diff_a: Option<f32>,
    pub time_diff_b: Option<f32>,
    pub speed: Option<f32>,
    pub heading: Option<f32>,
    pub magnetic_variation: Option<f32>,
    pub magnetic_direction: Option<LongitudeDirection>,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct RmbData<'a> {
    pub status: Option<RmStatus>,
    pub cross_error: Option<f32>,
    pub steer_direction: Option<SteerDirection>,
    pub to_waypoint: Option<&'a [u8]>,
    pub from_waypoint: Option<&'a [u8]>,
    pub dest_position: GpsPosition,
    pub range_to_dest: Option<f32>,
    pub bearing: Option<f32>,
    pub closing_velocity: Option<f32>,
    pub arrival_status: Option<ArrivalStatus>,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct RmcData {
    pub time: Option<GpsTime>,
    pub status: Option<RmStatus>,
    pub position: GpsPosition,
    pub speed: Option<f32>,
    pub heading: Option<f32>,
    pub date: Option<GpsDate>,
    pub magnetic_variation: Option<f32>,
    pub magnetic_direction: Option<LongitudeDirection>,
}

#[derive(Debug, Clone, Copy, PartialEq)]
pub struct RotData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct RpmData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct RsaData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct RsdData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct RteData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct SfiData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct StnData {
    pub talker_id: u8,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct TllData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct TtmData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct VbwData {
    pub lon_water_speed: Option<f32>,
    pub transverse_water_speed: Option<f32>,
    pub water_validity: Option<DataValidity>,
    pub lon_ground_speed: Option<f32>,
    pub transverse_ground_speed: Option<f32>,
    pub ground_validity: Option<DataValidity>,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct VdrData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct VhwData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct VlwData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct VpwData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct VtgData {
    pub bearing_true: Option<f32>,
    pub bearing_magnetic: Option<f32>,
    pub speed_knots: Option<f32>,
    pub speed_kmh: Option<f32>,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct VwrData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct WcvData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct WncData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct WplData<'a> {
    pub position: Option<GpsPosition>,
    pub waypoint_name: Option<&'a [u8]>,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct XdrData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct XteData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct XtrData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct ZdaData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct ZfoData {}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct ZtgData {}

macro_rules! sentence_parse_generator {
    ($sentence:ident : [$($TYPE:ident => $function:path,)+]) => {
        match $sentence.sentence_type {
            $(
                SentenceType::$TYPE => Ok(SentenceData::$TYPE(parse_result_to_data($function($sentence.data))?)),
            )+
            _ => Err(NmeaSentenceError::TypeNotImplementedError($sentence.sentence_type)),
        }
    }
}

fn parse_result_to_data<'a, Data>(
    parse_result: Result<(&'a [u8], Data), nom::Err<(&'a [u8], nom::error::ErrorKind)>>,
) -> Result<Data, NmeaSentenceError<'a>> {
    match parse_result {
        Ok(value) => Ok(value.1),
        Err(val) => Err(NmeaSentenceError::DataParsingError(val)),
    }
}

pub(crate) fn parse_sentence_data<'a>(
    general_sentence: GeneralSentence<'a>,
) -> Result<SentenceData, NmeaSentenceError<'a>> {
    sentence_parse_generator!(
        general_sentence: [
            //AAM => parse_aam,
            //ABK => parse_abk,
            //ACK => parse_ack,
            //ALM => parse_alm,
            //APA => parse_apa,
            //APB => parse_apb,
            //BEC => parse_bec,
            BOD => parsers::bod::parse_bod,
            BWC => parsers::bwc::parse_bwc,
            //BWR => parse_bwr,
            //BWW => parse_bww,
            //DBK => parse_dbk,
            //DBS => parse_dbs,
            //DBT => parse_dbt,
            //DCN => parse_dcn,
            //DPT => parse_dpt,
            //DTM => parse_dtm,
            //FSI => parse_fsi,
            GBS => parsers::gbs::parse_gbs,
            GGA => parsers::gga::parse_gga,
            //GLC => parse_glc,
            GLL => parsers::gll::parse_gll,
            GNS => parsers::gns::parse_gns,
            //GRS => parse_grs,
            //GST => parse_gst,
            GSA => parsers::gsa::parse_gsa,
            GSV => parsers::gsv::parse_gsv,
            //GTD => parse_gtd,
            //GXA => parse_gxa,
            //HDG => parse_hdg,
            //HDM => parse_hdm,
            HDT => parsers::hdt::parse_hdt,
            //HSC => parse_hsc,
            //LCD => parse_lcd,
            //MSK => parse_msk,
            //MTW => parse_mtw,
            //MWV => parse_mwv,
            //OLN => parse_oln,
            //OSD => parse_osd,
            //ROO => parse_roo,
            RMA => parsers::rma::parse_rma,
            RMB => parsers::rmb::parse_rmb,
            RMC => parsers::rmc::parse_rmc,
            //ROT => parse_rot,
            //RPM => parse_rpm,
            //RSA => parse_rsa,
            //RSD => parse_rsd,
            //RTE => parse_rte,
            //SFI => parse_sfi,
            STN => parsers::stn::parse_stn,
            //TLL => parse_tll,
            //TTM => parse_ttm,
            VBW => parsers::vbw::parse_vbw,
            //VDR => parse_vdr,
            //VHW => parse_vhw,
            //VLW => parse_vlw,
            //VPW => parse_vpw,
            VTG => parsers::vtg::parse_vtg,
            //VWR => parse_vwr,
            //WCV => parse_wcv,
            //WNC => parse_wnc,
            WPL => parsers::wpl::parse_wpl,
            //XDR => parse_xdr,
            //XTE => parse_xte,
            //XTR => parse_xtr,
            //ZDA => parse_zda,
            //ZFO => parse_zfo,
            //ZTG => parse_ztg,
        ]
    )
}