ham 0.2.0

A crate with interfaces for small packet radios, with an implementation for RFM69.
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

use std::thread;
use std::time::{Duration, Instant};

#[cfg(feature = "hp-sleep")]
use spin_sleep;

pub mod rfm69;

#[derive(Debug)]
pub enum Error {
    GpioError(gpio_cdev::errors::Error), // error with Gpio device
    Init(String),                        // error initializing device TODO: should this be removed
    IoError(std::io::Error),             // IO error, typically SPI
    BadInputs(String),                   // input given to message was bad
    BadMessage(String, Option<usize>),   // a mangled message was received
    Timeout(String),                     //
    ChipMalfunction(String),             // chip is behaving unexpectedly
    BufferOverflow(usize),               // a buffer that was passed was to small
    Unrecoverable(String),               // device is unrecoverable state
}
impl From<gpio_cdev::errors::Error> for Error {
    fn from(v: gpio_cdev::errors::Error) -> Self {
        Error::GpioError(v)
    }
}
impl From<std::io::Error> for Error {
    fn from(v: std::io::Error) -> Self {
        Error::IoError(v)
    }
}

#[inline]
fn sleep(dur: Duration) {
    // a high persision sleep version
    if cfg!(feature = "hp-sleep") {
        spin_sleep::sleep(dur)
    } else {
        thread::sleep(dur)
    }
}

#[inline]
fn bit(byte: u8, bit: u8) -> bool {
    byte & (1 << bit) != 0
}
#[inline]
fn set_bit(byte: u8, bit: u8) -> u8 {
    byte | (1 << bit)
}
#[inline]
fn unset_bit(byte: u8, bit: u8) -> u8 {
    byte & 0xFE_u8.rotate_left(bit as u32)
}
#[inline]
fn cond_set_bit(byte: u8, bit: u8, cond: bool) -> u8 {
    byte | ((1 << bit) * (cond as u8))
}

#[inline]
fn set_bit_to(byte: u8, bit: u8, val: bool) -> u8 {
    cond_set_bit(unset_bit(byte, bit), bit, val)
}
/// The methods required by a packet receiver.
///
///
pub trait PacketReceiver {
    fn cur_time(&self) -> u32;
    fn last_time(&self) -> u32;
    fn recv_pkt(&mut self) -> Result<Vec<u8>, Error>;
    fn recv_pkt_to(&mut self, timeout: Duration) -> Result<Vec<u8>, Error>;
    #[inline]
    fn try_recv_pkt(&mut self) -> Result<Vec<u8>, Error> {
        self.recv_pkt_to(Duration::from_secs(0))
    }
    fn start(&mut self) -> Result<(), Error>;
    fn pause(&mut self) -> Result<(), Error>;
    fn mtu(&self) -> usize;
    fn try_iter(&mut self) -> TryIter<'_, Self>
    where
        Self: Sized,
    {
        TryIter { recv: self }
    }
}

pub struct TryIter<'a, T: PacketReceiver> {
    recv: &'a mut T,
}
impl<T: PacketReceiver> Iterator for TryIter<'_, T> {
    type Item = Vec<u8>;
    fn next(&mut self) -> Option<Vec<u8>> {
        self.recv.try_recv_pkt().ok()
    }
}
pub trait IntoPacketReceiver {
    type Recv: PacketReceiver;
    fn into_packet_receiver(self) -> Result<Self::Recv, Error>;
}
impl<T: PacketReceiver> IntoPacketReceiver for T {
    type Recv = T;
    #[inline]
    fn into_packet_receiver(self) -> Result<Self::Recv, Error> {
        Ok(self)
    }
}

trait NetworkPacketReceiver<N>: PacketReceiver {
    fn set_network(&mut self, netaddr: N) -> Result<(), Error>;
}
trait AddressPacketReceiver<N, A>: NetworkPacketReceiver<N> {
    fn recv_pkt_addr(&mut self) -> Result<(Vec<u8>, u8), Error>;
    fn recv_pkt_to_addr(&mut self, timeout: Duration) -> Result<(Vec<u8>, u8), Error>;
    fn set_addr(&mut self, addr: A) -> Result<(), Error>;
}
trait BroadcastPacketReceiver<N, A>: AddressPacketReceiver<N, A> {
    fn set_broadcast(&mut self, addr: A) -> Result<(), Error>;
}
trait VerifiedPacketReceiver: PacketReceiver {
    fn recv_v_packet(&mut self, bytes: &mut [u8]) -> Result<usize, Error>;
}
pub trait PacketSender {
    fn send_packet(&mut self, msg: &[u8], start_time: u32) -> Result<(), Error>;
    fn mtu(&self) -> usize;
}
pub trait IntoPacketSender {
    type Send: PacketSender;
    fn into_packet_sender(self, msg_buf: usize) -> Result<Self::Send, Error>;
}
pub trait NetworkPacketSender<N>: PacketSender {
    fn set_network(&mut self, netaddr: N) -> Result<(), Error>;
}
trait AddressPacketSender<N, A>: NetworkPacketSender<N> {
    fn send_packet_to(&mut self, addr: A) -> Result<(), Error>;
}
trait VerifiedPacketSender: PacketSender {
    fn send_v_packet(&self) -> Result<(), Error>;
}

enum ConfigMessage<N, A> {
    SetNetwork(N),
    SetAddr(A),
    SetBroadcast(A),
    SendMessage(Vec<u8>, Instant),
    Terminate,
    Pause,
    Start,
    Alive, // intended to do nothing, just validate thread is running
    Verbose(u8),
}

pub enum Void {}