dw3000-ng 0.6.1

A modernized driver for DW3000 Ultra Wide Band module
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

use crate::Config;

/// Indicates that the `DW3000` instance is not initialized yet
#[derive(Debug)]
pub struct Uninitialized;

/// Indicates that the `DW3000` instance is ready to be used
#[derive(Debug)]
pub struct Ready;

/// Indicates that the `DW3000` instance is currently sending
#[derive(Debug)]
pub struct Sending {
    pub(super) finished: bool,
}
impl Sending {
    /// Mark the receiving state as finished
    pub fn mark_finished(&mut self) {
        self.finished = true;
    }

    /// Return true if the receiving state has been marked as finished
    pub fn is_finished(&self) -> bool {
        self.finished
    }
}

/// Indicates that the `DW3000` instance is currently receiving in single buffer
/// mode (default)
#[derive(Debug)]
pub struct SingleBufferReceiving {
    pub(super) finished: bool,
    pub(super) config: Config,
}

/// Indicates that the `DW3000` instance is currently receiving in double buffer
/// mode
#[derive(Debug)]
pub struct AutoDoubleBufferReceiving {
    pub(super) finished: bool,
    pub(super) config: Config,
}

/// Indicates that the `DW3000` instance is currently sleeping
#[derive(Debug)]
pub struct Sleeping {
    // Tx antenna delay isn't stored in AON, so we'll do it ourselves.
    //pub(super) tx_antenna_delay: Duration,
}

/// Any state struct that implements this trait signals that the radio is
/// **not** sleeping.
pub trait Awake {}
impl Awake for Uninitialized {}
impl Awake for Ready {}
impl Awake for Sending {}
impl Awake for SingleBufferReceiving {}
impl Awake for AutoDoubleBufferReceiving {}
/// Any state struct that implements this trait signals that the radio is
/// sleeping.
pub trait Asleep {}
impl Asleep for Sleeping {}

/// Any state struct that implements this trait shares a number of rx operations
pub trait Receiving: Awake {
    /// When true, the radio will re-enable the receive operation after it has
    /// received a message
    const AUTO_RX_REENABLE: bool;
    /// When true, the radio will use both receive buffers.
    /// This can help decrease the downtime between receiving messages.
    const DOUBLE_BUFFERED: bool;

    /// Mark the receiving state as finished
    fn mark_finished(&mut self);
    /// Return true if the receiving state has been marked as finished
    fn is_finished(&self) -> bool;
    /// Get the rx radio config
    fn get_rx_config(&self) -> &Config;
}

impl Receiving for SingleBufferReceiving {
    const AUTO_RX_REENABLE: bool = false;
    const DOUBLE_BUFFERED: bool = false;

    fn mark_finished(&mut self) {
        self.finished = true;
    }

    fn is_finished(&self) -> bool {
        self.finished
    }

    fn get_rx_config(&self) -> &Config {
        &self.config
    }
}

impl Receiving for AutoDoubleBufferReceiving {
    const AUTO_RX_REENABLE: bool = true;
    const DOUBLE_BUFFERED: bool = true;

    fn mark_finished(&mut self) {
        self.finished = true;
    }

    fn is_finished(&self) -> bool {
        self.finished
    }

    fn get_rx_config(&self) -> &Config {
        &self.config
    }
}