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

use crate::radio::{prelude::EsbPayloadLength, Nrf24Error, RF24};
use embedded_hal::{delay::DelayNs, digital::OutputPin, spi::SpiDevice};

use super::{commands, registers, Feature};

impl<SPI, DO, DELAY> EsbPayloadLength for RF24<SPI, DO, DELAY>
where
    SPI: SpiDevice,
    DO: OutputPin,
    DELAY: DelayNs,
{
    fn set_payload_length(&mut self, length: u8) -> Result<(), Self::Error> {
        let len = length.clamp(1, 32);
        for i in 0..6 {
            self.spi_write_byte(registers::RX_PW_P0 + i, len)?;
        }
        self.payload_length = len;
        Ok(())
    }

    fn get_payload_length(&mut self) -> Result<u8, Self::Error> {
        self.spi_read(1, registers::RX_PW_P0)?;
        Ok(self.buf[1])
    }

    fn set_dynamic_payloads(&mut self, enable: bool) -> Result<(), Self::Error> {
        self.spi_read(1, registers::FEATURE)?;
        self.feature =
            Feature::from_bits(self.feature.into_bits() & !Feature::REG_MASK | self.buf[1])
                .with_dynamic_payloads(enable);
        self.spi_write_byte(
            registers::FEATURE,
            self.feature.into_bits() & Feature::REG_MASK,
        )?;
        self.spi_write_byte(registers::DYNPD, 0x3F * enable as u8)?;
        Ok(())
    }

    fn get_dynamic_payloads(&self) -> bool {
        self.feature.dynamic_payloads()
    }

    fn get_dynamic_payload_length(&mut self) -> Result<u8, Self::Error> {
        self.spi_read(1, commands::R_RX_PL_WID)?;
        if self.buf[1] > 32 {
            return Err(Nrf24Error::BinaryCorruption);
        }
        Ok(self.buf[1])
    }
}

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

    const EN_ACK_PAY: u8 = 1 << 1;
    const EN_DPL: u8 = 1 << 2;

    #[test]
    fn dynamic_payloads() {
        let spi_expectations = spi_test_expects![
            // set_dynamic_payloads(true)
            (vec![registers::FEATURE, 0], vec![0xEu8, 0],),
            (
                vec![registers::FEATURE | commands::W_REGISTER, EN_DPL],
                vec![0xEu8, 0],
            ),
            (
                vec![registers::DYNPD | commands::W_REGISTER, 0x3F],
                vec![0xEu8, 0],
            ),
            // read dynamic payload length invalid value
            (vec![commands::R_RX_PL_WID, 0], vec![0xEu8, 0xFF]),
            // read dynamic payload length valid value
            (vec![commands::R_RX_PL_WID, 0xFF], vec![0xEu8, 32]),
            // set_dynamic_payloads(false)
            (
                vec![registers::FEATURE, 32],
                vec![0xEu8, EN_ACK_PAY | EN_DPL],
            ),
            (
                vec![registers::FEATURE | commands::W_REGISTER, 0],
                vec![0xEu8, 0],
            ),
            (
                vec![registers::DYNPD | commands::W_REGISTER, 0],
                vec![0xEu8, 0],
            ),
        ];

        let mocks = mk_radio(&[], &spi_expectations);
        let (mut radio, mut spi, mut ce_pin) = (mocks.0, mocks.1, mocks.2);
        radio.set_dynamic_payloads(true).unwrap();
        assert!(radio.get_dynamic_payloads());
        assert_eq!(
            radio.get_dynamic_payload_length(),
            Err(Nrf24Error::BinaryCorruption)
        );
        assert_eq!(radio.get_dynamic_payload_length().unwrap(), 32);
        radio.set_dynamic_payloads(false).unwrap();
        assert!(!radio.get_dynamic_payloads());
        assert!(!radio.get_ack_payloads());
        spi.done();
        ce_pin.done();
    }

    #[test]
    pub fn set_payload_length() {
        let mut spi_expectations = vec![];
        for pipe in 0..6 {
            spi_expectations.extend(spi_test_expects![
                // set payload length to 32 bytes on all pipes
                (
                    vec![(registers::RX_PW_P0 + pipe) | commands::W_REGISTER, 32],
                    vec![0xEu8, 0]
                ),
            ]);
        }
        spi_expectations.extend(spi_test_expects![
            // get payload length for all pipe 0 (because all pipes will use the same static length)
            (vec![registers::RX_PW_P0, 0], vec![0xEu8, 32]),
        ]);

        let mocks = mk_radio(&[], &spi_expectations);
        let (mut radio, mut spi, mut ce_pin) = (mocks.0, mocks.1, mocks.2);
        radio.set_payload_length(76).unwrap();
        assert_eq!(radio.get_payload_length().unwrap(), 32);
        spi.done();
        ce_pin.done();
    }
}