binex 0.5.2

BINEX encoder and decoder for real-time GNSS
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
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
mod checksum;
mod meta; // message Meta Data
mod mid; // message ID
mod record; // Record: message content
mod time; // Epoch encoding/decoding // checksum calc.

pub use record::{
    EphemerisFrame, GALEphemeris, GLOEphemeris, GPSEphemeris, GPSRaw, GeoStringFrame,
    MonumentGeoMetadata, MonumentGeoRecord, PositionEcef3d, PositionGeo3d, Record, SBASEphemeris,
    Solutions, SolutionsFrame, TemporalSolution, Velocity3d, VelocityNED3d,
};

pub use meta::Meta;

pub(crate) use mid::MessageID;

use crate::{ClosedSourceMeta, Error, stream::Provider};
use checksum::Checksum;

#[derive(Debug, Clone, PartialEq, Default)]
pub struct Message {
    /// [Meta] data
    pub meta: Meta,
    /// [Record]
    pub record: Record,
}

impl Message {
    /// Keep going byte mask in the BNXI algorithm,
    /// as per [https://www.unavco.org/data/gps-gnss/data-formats/binex/conventions.html/#ubnxi_details]
    const BNXI_KEEP_GOING_MASK: u8 = 0x80;

    /// Data byte mask in the BNXI algorithm,
    /// as per [https://www.unavco.org/data/gps-gnss/data-formats/binex/conventions.html/#ubnxi_details]
    const BNXI_BYTE_MASK: u8 = 0x7f;

    /// Creates a new [Message] ready to be encoded.
    pub fn new(meta: Meta, record: Record) -> Self {
        Self { meta, record }
    }

    /// Returns total size required to encode this [Message].
    /// Use this to fulfill [Self::encode] requirements.
    pub fn encoding_size(&self) -> usize {
        let mut total = 1; // SYNC

        let mid = self.record.to_message_id() as u32;
        let mid_1_4 = Self::bnxi_encoding_size(mid);
        total += mid_1_4;

        let mlen = self.record.encoding_size();
        let mlen_1_4 = Self::bnxi_encoding_size(mlen as u32);
        total += mlen_1_4;
        total += mlen;

        let ck = Checksum::from_len(mlen_1_4 + mlen + mid_1_4, self.meta.enhanced_crc);
        total += ck.len();

        total
    }

    /// [Message] decoding attempt from buffered content.
    /// Buffer must contain sync byte and the following frame must match
    /// the specification if an open source BINEX [Message].
    /// For closed source [Message]s, we return [Error::ClosedSourceMessage]
    /// with header information.
    pub fn decode(buf: &[u8]) -> Result<Self, Error> {
        let buf_len = buf.len();

        // 1. locate SYNC byte
        let meta = Meta::find_and_parse(buf, buf_len);
        if meta.is_none() {
            return Err(Error::NoSyncByte);
        }

        let (meta, sync_off) = meta.unwrap();

        let reversed = meta.reversed;
        let big_endian = meta.big_endian;
        let enhanced_crc = meta.enhanced_crc;

        /////////////////////////////////////
        // TODO: current library limitations
        /////////////////////////////////////
        if reversed {
            // Reversed streams: not understood
            return Err(Error::ReversedStream);
        }
        if enhanced_crc {
            // Enhanced CRC scheme not implemented
            return Err(Error::EnhancedCrc);
        }

        // make sure we can parse up to 4 byte MID
        if buf_len - sync_off < 4 {
            return Err(Error::NotEnoughBytes);
        }

        let mut ptr = sync_off + 1;

        // 2. parse MID
        let (bnxi, mid_1_4) = Self::decode_bnxi(&buf[ptr..], big_endian);
        let mid = MessageID::from(bnxi);

        if mid == MessageID::Unknown {
            return Err(Error::UnknownMessage);
        }
        ptr += mid_1_4;

        // make sure we can parse up to 4 byte MLEN
        if buf_len - ptr < 4 {
            return Err(Error::NotEnoughBytes);
        }

        // 3. parse MLEN
        let (mlen, mlen_1_4) = Self::decode_bnxi(&buf[ptr..], big_endian);
        let mlen = mlen as usize;
        //println!("mid={:?}/mlen={}/ptr={}", mid, mlen, ptr);

        if ptr + mlen > buf_len {
            // buffer does not contain complete message!
            return Err(Error::IncompleteMessage(mlen));
        }
        ptr += mlen_1_4;

        // 4. parse RECORD
        let record = match mid {
            MessageID::SiteMonumentMarker => {
                let rec = MonumentGeoRecord::decode(mlen, big_endian, &buf[ptr..])?;
                Record::new_monument_geo(rec)
            },
            MessageID::Ephemeris => {
                let fr = EphemerisFrame::decode(big_endian, &buf[ptr..])?;
                Record::new_ephemeris_frame(fr)
            },
            MessageID::ProcessedSolutions => {
                let solutions = Solutions::decode(mlen, big_endian, &buf[ptr..])?;
                Record::new_solutions(solutions)
            },
            MessageID::Unknown => {
                return Err(Error::UnknownMessage);
            },
            _ => {
                // check whether this message is undisclosed or not
                if let Some(provider) = Provider::match_any(mid.into()) {
                    return Err(Error::ClosedSourceMessage(ClosedSourceMeta {
                        mlen,
                        provider,
                        size: mlen,
                        offset: ptr,
                        open_meta: meta,
                        mid: mid.into(),
                    }));
                } else {
                    // println!("found unsupported msg id={:?}", id);
                    return Err(Error::NonSupportedMesssage(mlen));
                }
            },
        };

        // 5. CRC
        let checksum = Checksum::from_len(mlen, enhanced_crc);
        let ck_len = checksum.len();

        if ptr + mlen + ck_len > buf_len {
            return Err(Error::MissingCRC);
        }

        // decode
        let ck = checksum.decode(&buf[ptr + mlen..], ck_len, big_endian);

        // verify
        let expected = checksum.calc(&buf[sync_off + 1..], mlen + mid_1_4 + mlen_1_4);

        if expected != ck {
            Err(Error::CorrupctBadCRC)
        } else {
            Ok(Self { meta, record })
        }
    }

    /// Tries to encode [Message] into provided buffer.
    /// Returns total encoded size, which is equal to the message size (in bytes).
    /// ## Inputs:
    ///  - buf: byte slice
    ///  - size: size of this byte slice.
    ///  [Self::encoding_size] must fit in
    pub fn encode(&self, buf: &mut [u8], buf_size: usize) -> Result<usize, Error> {
        let total = self.encoding_size();

        if buf_size < total {
            return Err(Error::NotEnoughBytes);
        }

        // grab meta definitions
        let big_endian = self.meta.big_endian;
        // let reversed = self.meta.reversed;
        let enhanced_crc = self.meta.enhanced_crc;

        // Encode SYNC byte
        buf[0] = self.meta.sync_byte();
        let mut ptr = 1;

        // Encode MID
        let mid = self.record.to_message_id() as u32;
        let mid_1_4 = Self::encode_bnxi(mid, big_endian, &mut buf[ptr..])?;
        ptr += mid_1_4;

        // Encode MLEN
        let mlen = self.record.encoding_size();
        let mlen_1_4 = Self::encode_bnxi(mlen as u32, big_endian, &mut buf[ptr..])?;
        ptr += mlen_1_4;

        // Encode message
        match &self.record {
            Record::EphemerisFrame(fr) => {
                ptr += fr.encode(big_endian, &mut buf[ptr..])?;
            },
            Record::MonumentGeo(geo) => {
                ptr += geo.encode(big_endian, &mut buf[ptr..])?;
            },
            Record::Solutions(fr) => {
                ptr += fr.encode(big_endian, &mut buf[ptr..])?;
            },
        }

        // encode CRC
        let ck = Checksum::from_len(mlen, enhanced_crc);
        let ck_len = ck.len();
        let crc_u128 = ck.calc(&buf[1..], mlen + mid_1_4 + mlen_1_4);

        if ck_len == 1 {
            buf[ptr] = crc_u128 as u8;
        } else if ck_len == 2 {
            let crc_bytes = if big_endian {
                (crc_u128 as u16).to_be_bytes()
            } else {
                (crc_u128 as u16).to_le_bytes()
            };

            for i in 0..ck_len {
                buf[ptr + i] = crc_bytes[i];
            }
        } else if ck_len == 4 {
            let crc_bytes = if big_endian {
                (crc_u128 as u32).to_be_bytes()
            } else {
                (crc_u128 as u32).to_le_bytes()
            };
            for i in 0..ck_len {
                buf[ptr + i] = crc_bytes[i];
            }
        } else {
            let crc_bytes = if big_endian {
                crc_u128.to_be_bytes()
            } else {
                crc_u128.to_le_bytes()
            };
            for i in 0..ck_len {
                buf[ptr + i] = crc_bytes[i];
            }
        }

        Ok(ptr + ck_len)
    }

    /// Number of bytes to encode U32 using the 1-4 BNXI algorithm.
    pub(crate) const fn bnxi_encoding_size(val: u32) -> usize {
        if val < 128 {
            1
        } else if val < 16384 {
            2
        } else if val < 2097152 {
            3
        } else {
            4
        }
    }

    /// Decodes 1-4 BNXI encoded unsigned U32 integer with selected endianness,
    /// according to [https://www.unavco.org/data/gps-gnss/data-formats/binex/conventions.html/#ubnxi_details].
    /// ## Outputs
    ///    * u32: decoded U32 integer
    ///     * usize: number of bytes consumed in this process
    ///       ie., last byte contributing to the BNXI encoding.
    ///       The next byte is the following content.
    pub(crate) fn decode_bnxi(buf: &[u8], big_endian: bool) -> (u32, usize) {
        let min_size = buf.len().min(4);

        // handle bad op
        if min_size == 0 {
            return (0, 0);
        }

        // single byte case
        if buf[0] & Self::BNXI_KEEP_GOING_MASK == 0 {
            let val32 = buf[0] as u32;
            return (val32 & 0x7f, 1);
        }

        // multi byte case
        let (val, size) = if buf[1] & Self::BNXI_KEEP_GOING_MASK == 0 {
            let mut val;

            let (byte0, byte1) = if big_endian {
                (buf[0], buf[1])
            } else {
                (buf[1], buf[0])
            };

            val = (byte0 & Self::BNXI_BYTE_MASK) as u32;
            val <<= 7;
            val |= byte1 as u32;

            (val, 2)
        } else if buf[2] & Self::BNXI_KEEP_GOING_MASK == 0 {
            let mut val;

            let (byte0, byte1, byte2) = if big_endian {
                (buf[0], buf[1], buf[2])
            } else {
                (buf[2], buf[1], buf[0])
            };

            val = (byte0 & Self::BNXI_BYTE_MASK) as u32;
            val <<= 8;

            val |= (byte1 & Self::BNXI_BYTE_MASK) as u32;
            val <<= 7;

            val |= byte2 as u32;
            (val, 3)
        } else {
            let mut val;

            let (byte0, byte1, byte2, byte3) = if big_endian {
                (buf[0], buf[1], buf[2], buf[3])
            } else {
                (buf[3], buf[2], buf[1], buf[0])
            };

            val = (byte0 & Self::BNXI_BYTE_MASK) as u32;
            val <<= 8;

            val |= (byte1 & Self::BNXI_BYTE_MASK) as u32;
            val <<= 8;

            val |= (byte2 & Self::BNXI_BYTE_MASK) as u32;
            val <<= 7;

            val |= byte3 as u32;
            (val, 4)
        };

        (val, size)
    }

    /// U32 to BNXI encoder according to [https://www.unavco.org/data/gps-gnss/data-formats/binex/conventions.html/#ubnxi_details].
    /// Encodes into given buffer, returns encoding size.
    /// Will fail if buffer is too small.
    pub(crate) fn encode_bnxi(val: u32, big_endian: bool, buf: &mut [u8]) -> Result<usize, Error> {
        let size = Self::bnxi_encoding_size(val);
        if buf.len() < size {
            return Err(Error::NotEnoughBytes);
        }

        // single byte case
        if size == 1 {
            buf[0] = (val as u8) & 0x7f;
            return Ok(1);
        }

        // multi byte case
        let mut val32 = (val & 0xffffff80) << 1;
        val32 |= val & 0xff;

        if size == 2 {
            val32 |= 0x8000;
            val32 &= 0xff7f;

            if big_endian {
                buf[0] = ((val32 & 0xff00) >> 8) as u8;
                buf[1] = val32 as u8;
            } else {
                buf[1] = ((val32 & 0xff00) >> 8) as u8;
                buf[0] = val32 as u8;
            }
        } else if size == 3 {
            val32 |= 0x808000;
            val32 &= 0xffff7f;

            if big_endian {
                buf[0] = ((val32 & 0xffff00) >> 16) as u8;
                buf[1] = ((val32 & 0xff00) >> 8) as u8;
                buf[2] = val32 as u8;
            } else {
                buf[2] = ((val32 & 0xffff00) >> 16) as u8;
                buf[1] = ((val32 & 0xff00) >> 8) as u8;
                buf[0] = val32 as u8;
            }
        } else {
            val32 |= 0x80808000;
            val32 &= 0xffffff7f;

            if big_endian {
                buf[0] = ((val32 & 0xffffff00) >> 24) as u8;
                buf[1] = ((val32 & 0xffff00) >> 16) as u8;
                buf[2] = ((val32 & 0xff00) >> 8) as u8;
                buf[3] = val32 as u8;
            } else {
                buf[3] = ((val32 & 0xffffff00) >> 24) as u8;
                buf[2] = ((val32 & 0xffff00) >> 16) as u8;
                buf[1] = ((val32 & 0xff00) >> 8) as u8;
                buf[0] = val32 as u8;
            }
        }

        Ok(size)
    }
}

#[cfg(test)]
mod test {
    use super::Message;
    use crate::Error;
    use crate::message::{
        EphemerisFrame, GALEphemeris, GPSEphemeris, GPSRaw, Meta, MonumentGeoMetadata,
        MonumentGeoRecord, PositionEcef3d, Record, Solutions, SolutionsFrame, Velocity3d,
    };
    use crate::prelude::Epoch;

    #[test]
    fn big_endian_bnxi() {
        let buf = [0];
        let (decoded, size) = Message::decode_bnxi(&buf, true);
        assert_eq!(size, 1);
        assert_eq!(decoded, 0);

        let mut encoded = [0; 4];
        let size = Message::encode_bnxi(decoded, true, &mut encoded).unwrap();

        assert_eq!(size, 1);
        assert_eq!(encoded, [0, 0, 0, 0]);

        let buf = [0, 0, 0, 0];
        let (decoded, size) = Message::decode_bnxi(&buf, true);
        assert_eq!(size, 1);
        assert_eq!(decoded, 0);

        let mut encoded = [0; 4];
        let size = Message::encode_bnxi(decoded, true, &mut encoded).unwrap();

        assert_eq!(size, 1);
        assert_eq!(encoded, [0, 0, 0, 0]);

        let buf = [1, 0, 0, 0];
        let (decoded, size) = Message::decode_bnxi(&buf, true);
        assert_eq!(size, 1);
        assert_eq!(decoded, 1);

        let mut encoded = [0; 4];
        let size = Message::encode_bnxi(decoded, true, &mut encoded).unwrap();

        assert_eq!(size, 1);
        assert_eq!(encoded, [1, 0, 0, 0]);

        let buf = [2, 0, 0, 0];
        let (decoded, size) = Message::decode_bnxi(&buf, true);
        assert_eq!(size, 1);
        assert_eq!(decoded, 2);

        let mut encoded = [0; 4];
        let size = Message::encode_bnxi(decoded, true, &mut encoded).unwrap();

        assert_eq!(size, 1);
        assert_eq!(encoded, [2, 0, 0, 0]);

        let buf = [127, 0, 0, 0];
        let (decoded, size) = Message::decode_bnxi(&buf, true);
        assert_eq!(size, 1);
        assert_eq!(decoded, 127);

        let mut encoded = [0; 4];
        let size = Message::encode_bnxi(decoded, true, &mut encoded).unwrap();

        assert_eq!(size, 1);
        assert_eq!(encoded, [127, 0, 0, 0]);

        let buf = [129, 0, 0, 0];
        let (decoded, size) = Message::decode_bnxi(&buf, true);
        assert_eq!(size, 2);
        assert_eq!(decoded, 128);

        let mut encoded = [0; 4];
        let size = Message::encode_bnxi(decoded, true, &mut encoded).unwrap();

        assert_eq!(size, 2);
        assert_eq!(encoded, buf);

        let buf = [0x83, 0x7a, 0, 0];
        let (decoded, size) = Message::decode_bnxi(&buf, true);
        assert_eq!(size, 2);
        assert_eq!(decoded, 0x1fa);

        let mut encoded = [0; 4];
        let size = Message::encode_bnxi(decoded, true, &mut encoded).unwrap();

        assert_eq!(size, 2);
        assert_eq!(encoded, buf);

        let buf = [0x83, 0x83, 0x7a, 0];
        let (decoded, size) = Message::decode_bnxi(&buf, true);
        assert_eq!(size, 3);
        assert_eq!(decoded, 0x181fa);

        let mut encoded = [0; 4];
        let size = Message::encode_bnxi(decoded, true, &mut encoded).unwrap();

        assert_eq!(size, 3);
        assert_eq!(encoded, buf);

        let buf = [0x83, 0x83, 0x83, 0x7a];
        let (decoded, size) = Message::decode_bnxi(&buf, true);
        assert_eq!(size, 4);
        assert_eq!(decoded, 0x18181fa);

        let mut encoded = [0; 4];
        let size = Message::encode_bnxi(decoded, true, &mut encoded).unwrap();

        assert_eq!(size, 4);
        assert_eq!(encoded, buf);
    }

    #[test]
    fn bigend_bnxi_1() {
        for val in [0, 1, 10, 120, 122, 127] {
            let mut buf = [0; 1];
            let size = Message::encode_bnxi(val, true, &mut buf).unwrap();

            assert_eq!(size, 1);
            assert_eq!(buf[0], val as u8);

            let mut buf = [0; 4];

            let size = Message::encode_bnxi(val, true, &mut buf).unwrap();

            assert_eq!(size, 1);

            assert_eq!(buf[0], val as u8);
            assert_eq!(buf[1], 0);
            assert_eq!(buf[2], 0);
            assert_eq!(buf[3], 0);

            let (decoded, size) = Message::decode_bnxi(&buf, true);
            assert_eq!(size, 1);
            assert_eq!(decoded, val);
        }
    }

    #[test]
    fn decode_no_sync_byte() {
        let buf = [0, 0, 0, 0, 0];
        match Message::decode(&buf) {
            Err(Error::NoSyncByte) => {},
            Err(e) => panic!("returned unexpected error: {:?}", e),
            _ => panic!("should have paniced"),
        }
        let buf = [0, 0, 0, 0, 0];
        match Message::decode(&buf) {
            Err(Error::NoSyncByte) => {},
            Err(e) => panic!("returned unexpected error: {:?}", e),
            _ => panic!("should have paniced"),
        }
    }

    #[test]
    fn test_monument_geo() {
        let mut meta = Meta::default();

        meta.reversed = false;
        meta.big_endian = true;
        meta.enhanced_crc = false;

        let mut geo = MonumentGeoRecord::default().with_comment("simple");

        geo.epoch = Epoch::from_gpst_seconds(1.0);
        geo.meta = MonumentGeoMetadata::RNX2BIN;

        let geo_len = geo.encoding_size();
        let record = Record::new_monument_geo(geo);

        let msg = Message::new(meta, record);

        // SYNC + MID(1) +FID + MLEN + CRC(8)
        assert_eq!(msg.encoding_size(), 1 + 1 + 1 + geo_len + 1);

        let mut encoded = [0; 256];
        msg.encode(&mut encoded, 256).unwrap();

        assert_eq!(encoded[17], 3);

        // parse back
        let parsed = Message::decode(&encoded).unwrap();
        assert_eq!(parsed, msg);
    }

    #[test]
    fn test_gps_raw() {
        let mut meta = Meta::default();

        meta.reversed = false;
        meta.big_endian = true;
        meta.enhanced_crc = false;

        let gps_raw = EphemerisFrame::GPSRaw(GPSRaw::default());
        let gps_raw_len = gps_raw.encoding_size();
        let record = Record::new_ephemeris_frame(gps_raw);

        let msg = Message::new(meta, record);

        // SYNC + MID(1) + MLEN(1) + RLEN + CRC(1)
        assert_eq!(msg.encoding_size(), 1 + 1 + 1 + gps_raw_len + 1);

        let mut encoded = [0; 256];
        msg.encode(&mut encoded, 256).unwrap();

        assert_eq!(encoded[78 + 1 + 1 + 1], 0);

        // parse back
        let parsed = Message::decode(&encoded).unwrap();
        assert_eq!(parsed, msg);
    }

    #[test]
    fn test_gps_eph() {
        let mut meta = Meta::default();

        meta.reversed = false;
        meta.big_endian = true;
        meta.enhanced_crc = false;

        let gps_eph = EphemerisFrame::GPS(GPSEphemeris::default());
        let gps_eph_len = gps_eph.encoding_size();
        let record = Record::new_ephemeris_frame(gps_eph);

        assert_eq!(gps_eph_len, 129);

        let msg = Message::new(meta, record);

        // SYNC + MID(1) + MLEN(2) + RLEN + CRC(2)
        assert_eq!(msg.encoding_size(), 1 + 1 + 2 + gps_eph_len + 2);

        let mut encoded = [0; 256];
        msg.encode(&mut encoded, 256).unwrap();

        // parse back
        let parsed = Message::decode(&encoded).unwrap();
        assert_eq!(parsed, msg);
    }

    #[test]
    fn test_gal_eph() {
        let mut meta = Meta::default();

        meta.reversed = false;
        meta.big_endian = true;
        meta.enhanced_crc = false;

        let eph = EphemerisFrame::GAL(GALEphemeris::default());
        let eph_len = eph.encoding_size();
        let record = Record::new_ephemeris_frame(eph);

        assert_eq!(eph_len, 129);

        let msg = Message::new(meta, record);

        // SYNC + MID(1) + MLEN(2) + RLEN + CRC(2)
        assert_eq!(msg.encoding_size(), 1 + 1 + 2 + eph_len + 2);

        let mut encoded = [0; 256];
        msg.encode(&mut encoded, 256).unwrap();

        // parse back
        let parsed = Message::decode(&encoded).unwrap();
        assert_eq!(parsed, msg);
    }

    #[test]
    fn test_pvt_wgs84() {
        let mut meta = Meta::default();

        meta.reversed = false;
        meta.big_endian = true;
        meta.enhanced_crc = false;

        let mut solutions = Solutions::new(Epoch::from_gpst_seconds(1.100));

        solutions.frames.push(SolutionsFrame::AntennaEcefPosition(
            PositionEcef3d::new_wgs84(1.0, 2.0, 3.0),
        ));

        let sol_len = solutions.encoding_size();
        assert_eq!(sol_len, 6 + 1 + 3 * 8 + 1); // ts | fid | 3*8 | wgs

        let mut buf = [0; 32];
        let size = solutions.encode(true, &mut buf).unwrap();
        assert_eq!(size, 6 + 1 + 3 * 8 + 1);

        assert_eq!(
            buf,
            [
                0, 0, 0, 0, 4, 76, 1, 0, 63, 240, 0, 0, 0, 0, 0, 0, 64, 0, 0, 0, 0, 0, 0, 0, 64, 8,
                0, 0, 0, 0, 0, 0
            ]
        );

        let record = Record::new_solutions(solutions.clone());
        let msg = Message::new(meta, record);

        // SYNC + MID(1) + MLEN(1) + RLEN + CRC(1)
        let mlen = 1 + 1 + 1 + sol_len + 1;
        assert_eq!(msg.encoding_size(), mlen);

        let mut encoded = [0; 40];
        msg.encode(&mut encoded, 40).unwrap();

        assert_eq!(
            encoded,
            [
                226, 5, 32, 0, 0, 0, 0, 4, 76, 1, 0, 63, 240, 0, 0, 0, 0, 0, 0, 64, 0, 0, 0, 0, 0,
                0, 0, 64, 8, 0, 0, 0, 0, 0, 0, 171, 0, 0, 0, 0
            ]
        );

        // parse back
        let parsed = Message::decode(&encoded).unwrap();
        assert_eq!(parsed, msg);

        // add velocity
        solutions
            .frames
            .push(SolutionsFrame::AntennaEcefVelocity(Velocity3d {
                x_m_s: 1.0,
                y_m_s: 1.0,
                z_m_s: 1.0,
            }));

        let sol_len = solutions.encoding_size();
        assert_eq!(sol_len, 6 + 1 + 3 * 8 + 1 + 3 * 8 + 1);

        let mut buf = [0; 64];
        let size = solutions.encode(true, &mut buf).unwrap();
        assert_eq!(size, sol_len);

        let record = Record::new_solutions(solutions.clone());
        let msg = Message::new(meta, record);

        // add temporal
        // add system time
        // add comment
        // add extra
    }
}