libsbf 0.15.5

A no_std rust crate to parse Septentrio SBF Messages.
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

use alloc::vec::Vec;
use binrw::BinRead;
use bitflags::bitflags;

bitflags! {
    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
    pub struct ExtError: u8 {
        const SIS = 0x01;
        const DIFF_CORR = 0x02;
        const EXT_SENSOR = 0x04;
        const SETUP = 0x08;
    }
}

bitflags! {
    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
    pub struct RxState: u32 {
        const ACTIVE_ANTENNA = 1 << 1;
        const EXT_FREQ = 1 << 2;
        const EXT_TIME = 1 << 3;
        const WN_SET = 1 << 4;
        const TOW_SET = 1 << 5;
        const FINE_TIME = 1 << 6;
        const INTERNAL_DISK_ACTIVITY = 1 << 7;
        const INTERNAL_DISK_FULL = 1 << 8;
        const INTERNAL_DISK_MOUNTED = 1 << 9;
        const INT_ANT = 1 << 10;
        const REFOUT_LOCKED = 1 << 11;
        const EXTERNAL_DISK_ACTIVITY = 1 << 13;
        const EXTERNAL_DISK_FULL = 1 << 14;
        const EXTERNAL_DISK_MOUNTED = 1 << 15;
        const PPS_IN_CAL = 1 << 16;
        const DIFFCORR_IN = 1 << 17;
        const INTERNET = 1 << 18;
    }
}

bitflags! {
    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
    pub struct RxError: u32 {
        const SOFTWARE = 1 << 3;
        const WATCHDOG = 1 << 4;
        const ANTENNA = 1 << 5;
        const CONGESTION = 1 << 6;
        const MISSED_EVENT = 1 << 8;
        const CPU_OVERLOAD = 1 << 9;
        const INVALID_CONFIG = 1 << 10;
        const OUT_OF_GEOFENCE = 1 << 11;
    }
}

// ReceiverStatus Block 4014
#[derive(Debug, BinRead)]
pub struct ReceiverStatus {
    #[br(map = |x: u32| if x == crate::DO_NOT_USE_U4 { None } else { Some(x) })]
    pub tow: Option<u32>,
    #[br(map = |x: u16| if x == crate::DO_NOT_USE_U2 { None } else { Some(x) })]
    pub wnc: Option<u16>,
    #[br(map = |x: u8| if x == crate::DO_NOT_USE_U1 { None } else { Some(x) })]
    pub cpu_load: Option<u8>,
    #[br(map = |x: u8| ExtError::from_bits_truncate(x))]
    pub ext_error: ExtError,
    pub up_time: u32,
    #[br(map = |x: u32| RxState::from_bits_truncate(x))]
    pub rx_state: RxState,
    #[br(map = |x: u32| RxError::from_bits_truncate(x))]
    pub rx_error: RxError,
    pub n: u8,
    pub sb_length: u8,
    pub cmd_count: u8,
    pub temperature: u8,
    #[br(count = usize::from(n))]
    pub agc_state: Vec<AGCState>,
    #[br(parse_with = binrw::helpers::until_eof)]
    pub padding: Vec<u8>,
}

#[derive(Debug, BinRead)]
pub struct AGCState {
    pub frontend_id: u8,
    #[br(map = |x: i8| if x == -128 { None } else { Some(x) })]
    pub gain: Option<i8>,
    pub sample_var: u8,
    pub blanking_stat: u8,
}

impl AGCState {
    pub fn frontend_code(&self) -> u8 {
        self.frontend_id & 0x1F
    }

    pub fn antenna_id(&self) -> u8 {
        (self.frontend_id >> 5) & 0x07
    }
}

impl ReceiverStatus {
    // RxError helper methods
    pub fn software_error(&self) -> bool {
        self.rx_error.contains(RxError::SOFTWARE)
    }

    pub fn watchdog_error(&self) -> bool {
        self.rx_error.contains(RxError::WATCHDOG)
    }

    pub fn antenna_error(&self) -> bool {
        self.rx_error.contains(RxError::ANTENNA)
    }

    pub fn congestion_error(&self) -> bool {
        self.rx_error.contains(RxError::CONGESTION)
    }

    pub fn cpu_overload_error(&self) -> bool {
        self.rx_error.contains(RxError::CPU_OVERLOAD)
    }

    // ExtError helper methods
    pub fn sis_error(&self) -> bool {
        self.ext_error.contains(ExtError::SIS)
    }

    pub fn diff_corr_error(&self) -> bool {
        self.ext_error.contains(ExtError::DIFF_CORR)
    }

    pub fn ext_sensor_error(&self) -> bool {
        self.ext_error.contains(ExtError::EXT_SENSOR)
    }

    pub fn setup_error(&self) -> bool {
        self.ext_error.contains(ExtError::SETUP)
    }
}