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
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

/// Line delimiter in ARDOP control messages (str)
pub const NEWLINE_STR: &'static str = "\r";

/// TNC "true" value
pub const TRUE: &'static str = "TRUE";

/// TNC "false" value
pub const FALSE: &'static str = "FALSE";

custom_derive! {
    /// ARDOP protocol modes
    #[derive(Debug, PartialEq, Eq, EnumFromStr, EnumDisplay, Clone)]
    pub enum ProtocolMode {
        /// Connectionless, forward error-corrected packets
        FEC,

        /// Reliable, connection-oriented protocol with retransmits
        ARQ
    }
}

custom_derive! {
    /// ARDOP command verbs
    #[derive(Debug, PartialEq, Eq, EnumFromStr, EnumDisplay, Clone)]
    pub enum CommandID {
        /// Unclean disconnect
        ABORT,

        /// Attempt link turnover when remote buffer empties
        AUTOBREAK,

        /// Report buffer status
        BUFFER,

        /// Set ARQ call bandwidth
        ARQBW,

        /// Set ARQ timeout
        ARQTIMEOUT,

        /// Attempt ARQ connection
        ARQCALL,

        /// Reports that the RF channel is busy
        BUSY,

        /// Block connection requests when the channel has been busy
        BUSYBLOCK,

        /// Set busy detector threshold (0 -- 10)
        BUSYDET,

        /// Reports successful connection attempt
        CONNECTED,

        /// Send CW ID after a SENDID
        CWID,

        /// Initiate clean disconnect
        DISCONNECT,

        /// TNC command error
        FAULT,

        /// Set Maidenhead grid square
        GRIDSQUARE,

        /// Clear TNC states
        INITIALIZE,

        /// Set leader tone duration (120 -- 2500)
        LEADER,

        /// Enable/disable listening for incoming
        LISTEN,

        /// Reports transitioning to a new State
        NEWSTATE,

        /// Sets my tactical callsigns for listening
        MYAUX,

        /// Sets my callsign and SSID
        MYCALL,

        /// Send a ping request
        PING,

        /// Change the ProtocolMode
        PROTOCOLMODE,

        /// Reports connection rejected by peer
        REJECTED,

        /// Transmit an ID/beacon frame now
        SENDID,

        /// Reports an incoming call directed at this callsign (MYCALL or one of MYAUX)
        TARGET,

        /// Perform a two-tone test for audio calibration
        TWOTONETEST,

        /// Requests and reports TNC software version
        VERSION
    }
}

/// Map a truth value to a TNC string
#[inline]
pub fn truth_str(v: bool) -> &'static str {
    match v {
        true => TRUE,
        false => FALSE,
    }
}

#[cfg(test)]
mod test {
    use std::str;

    use super::*;

    #[test]
    fn test_protocol_mode() {
        assert_eq!(b"FEC", format!("{}", ProtocolMode::FEC).as_bytes());
        assert_eq!(ProtocolMode::ARQ, str::parse("ARQ").unwrap());
    }

    #[test]
    fn test_command() {
        assert_eq!(
            b"PROTOCOLMODE",
            format!("{}", CommandID::PROTOCOLMODE).as_bytes()
        );
        assert_eq!(CommandID::ABORT, str::parse("ABORT").unwrap());
    }
}