rfe 0.1.0

Communicate with RF Explorer spectrum analyzers and signal generators over USB serial
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

use std::{convert::TryFrom, fmt::Display};

use nom::Parser;
use nom::{bytes::complete::tag, combinator::map_res};
use num_enum::{IntoPrimitive, TryFromPrimitive};

use crate::common::MessageParseError;
use crate::rf_explorer::parsers::*;

#[derive(Debug, Copy, Clone, Eq, PartialEq, TryFromPrimitive, IntoPrimitive, Default)]
#[repr(u8)]
/// Digital signal processing mode used by the spectrum analyzer.
pub enum DspMode {
    /// Automatically select the DSP mode.
    #[default]
    Auto = 0,
    /// Filtered DSP mode.
    Filter,
    /// Fast DSP mode.
    Fast,
    /// No image rejection DSP mode.
    NoImg,
}

impl DspMode {
    pub(crate) const PREFIX: &'static [u8] = b"DSP:";
}

impl<'a> TryFrom<&'a [u8]> for DspMode {
    type Error = MessageParseError<'a>;

    fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error> {
        // Parse the prefix of the message
        let (bytes, _) = tag(DspMode::PREFIX)(bytes)?;

        // Parse the DSP mode
        let (bytes, dsp_mode) = map_res(num_parser::<u8>(1u8), DspMode::try_from).parse(bytes)?;

        // Consume \r or \r\n line ending and make sure there aren't any bytes left
        let _ = parse_opt_line_ending(bytes)?;

        Ok(dsp_mode)
    }
}

impl Display for DspMode {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let dsp_mode = match self {
            Self::Auto => "Auto",
            Self::Filter => "Filter",
            Self::Fast => "Fast",
            Self::NoImg => "NoImg",
        };
        write!(f, "{dsp_mode}")
    }
}

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

    #[test]
    fn accept_valid_dsp_mode_message() {
        let bytes = b"DSP:0";
        let dsp_mode = DspMode::try_from(bytes.as_ref()).unwrap();
        assert_eq!(dsp_mode, DspMode::Auto);
    }
}