ardop_interface 0.4.0

Interface to the Amateur Radio Digital Open Protocol (ARDOP)
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

use std::convert::Into;
use std::fmt;
use std::string::String;

#[derive(Debug, Clone, PartialEq)]
pub enum PingFailedReason {
    /// RF channel is busy, and waiting period expired
    ///
    /// Nothing was transmitted.
    Busy,

    /// One or more pings was sent, but the peer did not answer
    NoAnswer,
}

/// ARDOP Ping Response
///
/// Indicates that a *solicited* ping reply has been
/// received from a remote peer.
#[derive(Debug, Clone)]
pub struct PingAck {
    peer: String,
    snr: u16,
    decode_quality: u16,
}

impl PingAck {
    // Construct
    pub(crate) fn new<S>(peer: S, snr: u16, decode_quality: u16) -> Self
    where
        S: Into<String>,
    {
        Self {
            peer: peer.into(),
            snr,
            decode_quality,
        }
    }

    /// Peer callsign, with optional -SSID portion
    pub fn peer(&self) -> &String {
        &self.peer
    }

    /// Signal-to-noise ratio (SNR)
    ///
    /// SNR in dB, relative to a 3 kHz noise bandwidth. A value of
    /// of 21 indicates that the SNR is above 20 dB.
    pub fn snr(&self) -> u16 {
        self.snr
    }

    /// Symbol constellation decoding quality
    ///
    /// Quality values range from 30 ­ 100.
    pub fn decode_quality(&self) -> u16 {
        self.decode_quality
    }
}

impl fmt::Display for PingAck {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "Ping {}: SNR {} dB - Quality {}",
            &self.peer, self.snr, self.decode_quality
        )
    }
}

impl fmt::Display for PingFailedReason {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            PingFailedReason::Busy => write!(f, "busy channel"),
            PingFailedReason::NoAnswer => write!(f, "no answer from peer"),
        }
    }
}