rf24-rs 0.3.1

A pure-rust driver for the nRF24L01 wireless transceiver
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205

use embedded_hal::{delay::DelayNs, digital::OutputPin, spi::SpiDevice};

use crate::radio::{prelude::EsbPipe, RF24};

use super::registers;

impl<SPI, DO, DELAY> EsbPipe for RF24<SPI, DO, DELAY>
where
    SPI: SpiDevice,
    DO: OutputPin,
    DELAY: DelayNs,
{
    fn open_rx_pipe(&mut self, pipe: u8, address: &[u8]) -> Result<(), Self::Error> {
        if pipe > 5 {
            return Ok(());
        }

        if pipe < 2 {
            // Clamp the address length used: min(self._address_length, address.len());
            // This means that we only write the bytes that were passed
            let width = address.len().min(self.feature.address_length() as usize);

            // If this is pipe 0, cache the address.  This is needed because
            // open_tx_pipe() will overwrite the pipe 0 address, so
            // as_rx() will have to restore it.
            if pipe == 0 {
                let mut cached_addr = self.pipe0_rx_addr.unwrap_or_default();
                cached_addr[..width].copy_from_slice(&address[..width]);
                self.pipe0_rx_addr = Some(cached_addr);
            }
            if self.config_reg.is_rx() || pipe != 0 {
                // skip this if radio is in TX mode and the specified `pipe` is 0
                // NOTE: as_rx() will restore the cached address for pipe 0 (if any)
                self.spi_write_buf(registers::RX_ADDR_P0 + pipe, &address[..width])?;
            }
        }
        // For pipes 2-5, only write the MSB
        else {
            self.spi_write_byte(registers::RX_ADDR_P0 + pipe, address[0])?;
        }

        self.spi_read(1, registers::EN_RXADDR)?;
        let out = self.buf[1] | (1 << pipe);
        self.spi_write_byte(registers::EN_RXADDR, out)
    }

    /// If the given `pipe` number is  not in range [0, 5], then this function does nothing.
    fn close_rx_pipe(&mut self, pipe: u8) -> Result<(), Self::Error> {
        if pipe > 5 {
            return Ok(());
        }
        self.spi_read(1, registers::EN_RXADDR)?;
        let out = self.buf[1] & !(1 << pipe);
        self.spi_write_byte(registers::EN_RXADDR, out)?;
        if pipe == 0 {
            self.pipe0_rx_addr = None;
        }
        Ok(())
    }

    fn set_address_length(&mut self, length: u8) -> Result<(), Self::Error> {
        let width = length.clamp(2, 5);
        self.spi_write_byte(registers::SETUP_AW, width - 2)?;
        self.feature.set_address_length(width);
        Ok(())
    }

    fn get_address_length(&mut self) -> Result<u8, Self::Error> {
        self.spi_read(1, registers::SETUP_AW)?;
        let addr_length = self.buf[1].min(0xFD) + 2;
        self.feature.set_address_length(addr_length);
        Ok(addr_length)
    }
}

/////////////////////////////////////////////////////////////////////////////////
/// unit tests
#[cfg(test)]
mod test {
    extern crate std;
    use super::{registers, EsbPipe};
    use crate::{radio::rf24::commands, spi_test_expects, test::mk_radio};
    use embedded_hal_mock::eh1::spi::Transaction as SpiTransaction;
    use std::vec;

    #[test]
    pub fn open_rx_pipe() {
        let spi_expectations = spi_test_expects![
            // open_rx_pipe(5)
            (
                vec![(registers::RX_ADDR_P0 + 5) | commands::W_REGISTER, 0x55],
                vec![0xEu8, 0],
            ),
            // set EN_RXADDR
            (vec![registers::EN_RXADDR, 0], vec![0xEu8, 1]),
            (
                vec![registers::EN_RXADDR | commands::W_REGISTER, 0x21],
                vec![0xEu8, 0],
            ),
            // open_rx_pipe(0)
            (
                vec![
                    registers::RX_ADDR_P0 | commands::W_REGISTER,
                    0x55,
                    0x55,
                    0x55,
                    0x55,
                    0x55
                ],
                vec![0xEu8, 0, 0, 0, 0, 0],
            ),
            // set EN_RXADDR
            (vec![registers::EN_RXADDR, 0], vec![0xEu8, 2]),
            (
                vec![registers::EN_RXADDR | commands::W_REGISTER, 3],
                vec![0xEu8, 0],
            ),
        ];
        let mocks = mk_radio(&[], &spi_expectations);
        let (mut radio, mut spi, mut ce_pin) = (mocks.0, mocks.1, mocks.2);
        let address = [0x55; 5];
        radio.open_rx_pipe(9, &address).unwrap();
        radio.open_rx_pipe(5, &address).unwrap();
        radio.close_rx_pipe(9).unwrap();
        radio.config_reg = radio.config_reg.as_rx();
        radio.open_rx_pipe(0, &address).unwrap();
        spi.done();
        ce_pin.done();
    }

    #[test]
    fn open_rx_pipe0() {
        let spi_expectations = spi_test_expects![
            // open_rx_pipe(5)
            (
                vec![(registers::RX_ADDR_P0 + 5) | commands::W_REGISTER, 0x55],
                vec![0xEu8, 0],
            ),
            // set EN_RXADDR
            (vec![registers::EN_RXADDR, 0], vec![0xEu8, 1]),
            (
                vec![registers::EN_RXADDR | commands::W_REGISTER, 0x21],
                vec![0xEu8, 0],
            ),
        ];
        let mocks = mk_radio(&[], &spi_expectations);
        let (mut radio, mut spi, mut ce_pin) = (mocks.0, mocks.1, mocks.2);
        let address = [0x55u8; 5];
        radio.open_rx_pipe(9, &address).unwrap();
        radio.open_rx_pipe(5, &address).unwrap();
        radio.close_rx_pipe(9).unwrap();
        spi.done();
        ce_pin.done();
    }

    #[test]
    pub fn set_address_length() {
        let spi_expectations = spi_test_expects![
            // for 2 byte addresses
            // write the SETUP_AW register value
            (
                vec![registers::SETUP_AW | commands::W_REGISTER, 0],
                vec![0xEu8, 0],
            ),
            // read the SETUP_AW register value
            (vec![registers::SETUP_AW, 0], vec![0xEu8, 0]),
            // for 3 byte addresses
            // write the SETUP_AW register value
            (
                vec![registers::SETUP_AW | commands::W_REGISTER, 1],
                vec![0xEu8, 0],
            ),
            // read the SETUP_AW register value
            (vec![registers::SETUP_AW, 0], vec![0xEu8, 1]),
            // for 4 byte addresses
            // write the SETUP_AW register value
            (
                vec![registers::SETUP_AW | commands::W_REGISTER, 2],
                vec![0xEu8, 0],
            ),
            // read the SETUP_AW register value
            (vec![registers::SETUP_AW, 0], vec![0xEu8, 2]),
            // for 5 byte addresses
            // write the SETUP_AW register value
            (
                vec![registers::SETUP_AW | commands::W_REGISTER, 3],
                vec![0xEu8, 0],
            ),
            // read the SETUP_AW register value
            (vec![registers::SETUP_AW, 0], vec![0xEu8, 3]),
        ];
        let mocks = mk_radio(&[], &spi_expectations);
        let (mut radio, mut spi, mut ce_pin) = (mocks.0, mocks.1, mocks.2);
        radio.set_address_length(2).unwrap();
        assert_eq!(radio.get_address_length().unwrap(), 2);
        radio.set_address_length(3).unwrap();
        assert_eq!(radio.get_address_length().unwrap(), 3);
        radio.set_address_length(4).unwrap();
        assert_eq!(radio.get_address_length().unwrap(), 4);
        radio.set_address_length(5).unwrap();
        assert_eq!(radio.get_address_length().unwrap(), 5);
        spi.done();
        ce_pin.done();
    }
}