rf24-rs 0.3.1

A pure-rust driver for the nRF24L01 wireless transceiver
Documentation
use super::RF24;
use crate::radio::prelude::EsbDetails;
use embedded_hal::{delay::DelayNs, digital::OutputPin, spi::SpiDevice};

#[cfg(any(feature = "defmt", feature = "std"))]
use super::registers;
#[cfg(any(feature = "defmt", feature = "std"))]
use crate::radio::prelude::{
    EsbChannel, EsbCrcLength, EsbDataRate, EsbFifo, EsbPaLevel, EsbPayloadLength, EsbPipe, EsbPower,
};

#[cfg(feature = "std")]
extern crate std;

impl<SPI, DO, DELAY> EsbDetails for RF24<SPI, DO, DELAY>
where
    SPI: SpiDevice,
    DO: OutputPin,
    DELAY: DelayNs,
{
    #[cfg(feature = "defmt")]
    #[cfg(target_os = "none")]
    fn print_details(&mut self) -> Result<(), Self::Error> {
        defmt::println!("Is a plus variant_________{=bool}", self.is_plus_variant());

        let channel = self.get_channel()?;
        defmt::println!(
            "Channel___________________{=u8} ~ {=u16} Hz",
            channel,
            channel as u16 + 2400u16
        );

        defmt::println!("RF Data Rate______________{}", self.get_data_rate()?);
        defmt::println!("RF Power Amplifier________{}", self.get_pa_level()?);

        self.spi_read(1, registers::RF_SETUP)?;
        let rf_setup = self._buf[1];
        defmt::println!("RF LNA enabled____________{=bool}", rf_setup & 1 > 0);

        defmt::println!("CRC Length________________{}", self.get_crc_length()?);

        defmt::println!(
            "Address length____________{=u8} bytes",
            self.get_address_length()?
        );

        defmt::println!(
            "TX Payload lengths________{=u8} bytes",
            self.get_payload_length()?
        );

        self.spi_read(1, registers::SETUP_RETR)?;
        let retry_setup = self._buf[1];
        defmt::println!(
            "Auto retry delay__________{=u16} microseconds",
            (retry_setup >> 4) as u16 * 250 + 250
        );
        defmt::println!(
            "Auto retry attempts_______{=u8} maximum",
            retry_setup & 0x0F
        );

        self.spi_read(1, registers::FIFO_STATUS)?;
        defmt::println!(
            "Re-use TX FIFO____________{=bool}",
            (self._buf[1] & 0x80) > 0
        );

        self.spi_read(1, registers::OBSERVE_TX)?;
        let observer = self._buf[1];
        defmt::println!(
            "Packets lost\n    on current channel____{=u8}",
            observer >> 4
        );
        defmt::println!(
            "Retry attempts made\n    for last transmission_{=u8}",
            observer & 0xF
        );

        self.spi_read(1, registers::CONFIG)?;
        self._config_reg = Config::from_bits(self._buf[1]);
        defmt::println!(
            "IRQ on Data Ready_________{=bool}",
            self._config_reg.rx_dr()
        );
        defmt::println!("    Data Ready triggered__{=bool}", self._status.rx_dr());
        defmt::println!(
            "IRQ on Data Sent__________{=bool}",
            self._config_reg.tx_ds()
        );
        defmt::println!("    Data Sent triggered___{=bool}", self._status.tx_ds());
        defmt::println!(
            "IRQ on Data Fail__________{=bool}",
            self._config_reg.tx_df()
        );
        defmt::println!("    Data Fail triggered___{=bool}", self._status.tx_df());

        let fifo = self.get_fifo_state(true)?;
        defmt::println!("TX FIFO___________________{}", fifo);
        let fifo = self.get_fifo_state(false)?;
        defmt::println!("RX FIFO___________________{}", fifo);

        self.spi_read(1, registers::FEATURE)?;
        let features = self._buf[1];
        defmt::println!("Ask no ACK allowed________{=bool}", features & 1 > 0);
        defmt::println!("ACK Payload enabled_______{=bool}", features & 2 > 0);

        self.spi_read(1, registers::DYNPD)?;
        defmt::println!("Dynamic Payloads__________0b{=0..8}", self._buf[1]);

        self.spi_read(1, registers::EN_AA)?;
        defmt::println!("Auto Acknowledgment_______0b{=0..8}", self._buf[1]);
        let rx = defmt::intern!("R");
        let tx = defmt::intern!("T");
        defmt::println!(
            "Primary Mode______________{=istr}X",
            if self._config_reg & 1 > 0 { rx } else { tx }
        );
        defmt::println!("Powered Up________________{=bool}", self.is_powered());

        // print pipe addresses
        self.spi_read(5, registers::TX_ADDR)?;
        let mut address = [0u8; 4];
        address.copy_from_slice(&self._buf[2..6]);
        address.reverse();
        defmt::println!(
            "TX address_______________{=[u8; 4]:#08X}{=u8:02X}",
            address,
            self._buf[1]
        );
        self.spi_read(1, registers::EN_RXADDR)?;
        let open_pipes = self._buf[1];
        let opened = defmt::intern!(" open ");
        let closed = defmt::intern!("closed");
        for pipe in 0..=5 {
            self.spi_read(if pipe < 2 { 5 } else { 1 }, registers::RX_ADDR_P0 + pipe)?;
            if pipe < 2 {
                address.copy_from_slice(&self._buf[2..6]);
                address.reverse();
            }
            defmt::println!(
                "Pipe {=u8} ({=istr}) bound to {=[u8; 4]:#08X}{=u8:02X}",
                pipe,
                if (open_pipes & (1u8 << pipe)) > 0 {
                    opened
                } else {
                    closed
                },
                // reverse the bytes read to represent how memory is stored
                address,
                self._buf[1],
            );
        }
        Ok(())
    }

    #[cfg(not(any(feature = "defmt", feature = "std")))]
    fn print_details(&mut self) -> Result<(), Self::Error> {
        Ok(())
    }

    #[cfg(not(target_os = "none"))]
    #[cfg(feature = "std")]
    fn print_details(&mut self) -> Result<(), Self::Error> {
        use crate::radio::rf24::ConfigReg;

        std::println!("Is a plus variant_________{}", self.is_plus_variant());

        let channel = self.get_channel()?;
        std::println!(
            "Channel___________________{channel} ~ {} Hz",
            channel as u16 + 2400u16
        );

        std::println!("RF Data Rate______________{}", self.get_data_rate()?);
        std::println!("RF Power Amplifier________{}", self.get_pa_level()?);

        self.spi_read(1, registers::RF_SETUP)?;
        let rf_setup = self.buf[1];
        std::println!("RF LNA enabled____________{}", rf_setup & 1 > 0);

        std::println!("CRC Length________________{}", self.get_crc_length()?);

        std::println!(
            "Address length____________{} bytes",
            self.get_address_length()?
        );

        std::println!(
            "TX Payload lengths________{} bytes",
            self.get_payload_length()?
        );

        self.spi_read(1, registers::SETUP_RETR)?;
        let retry_setup = self.buf[1];
        std::println!(
            "Auto retry delay__________{} microseconds",
            (retry_setup >> 4) as u16 * 250 + 250
        );
        std::println!("Auto retry attempts_______{} maximum", retry_setup & 0x0F);

        self.spi_read(1, registers::FIFO_STATUS)?;
        std::println!("Re-use TX FIFO____________{}", (self.buf[1] & 0x80) > 0);

        self.spi_read(1, registers::OBSERVE_TX)?;
        let observer = self.buf[1];
        std::println!("Packets lost\n    on current channel____{}", observer >> 4);
        std::println!(
            "Retry attempts made\n    for last transmission_{}",
            observer & 0xF
        );

        self.spi_read(1, registers::CONFIG)?;
        self.config_reg = ConfigReg::from_bits(self.buf[1]);
        std::println!("IRQ on Data Ready_________{}", self.config_reg.rx_dr());
        std::println!("    Data Ready triggered__{}", self.status.rx_dr());
        std::println!("IRQ on Data Sent__________{}", self.config_reg.tx_ds());
        std::println!("    Data Sent triggered___{}", self.status.tx_ds());
        std::println!("IRQ on Data Fail__________{}", self.config_reg.tx_df());
        std::println!("    Data Fail triggered___{}", self.status.tx_df());

        let fifo = self.get_fifo_state(true)?;
        std::println!("TX FIFO___________________{fifo}");
        let fifo = self.get_fifo_state(false)?;
        std::println!("RX FIFO___________________{fifo}");

        self.spi_read(1, registers::FEATURE)?;
        let features = self.buf[1];
        std::println!("Ask no ACK allowed________{}", features & 1 > 0);
        std::println!("ACK Payload enabled_______{}", features & 2 > 0);

        self.spi_read(1, registers::DYNPD)?;
        std::println!("Dynamic Payloads__________{:#010b}", self.buf[1]);

        self.spi_read(1, registers::EN_AA)?;
        std::println!("Auto Acknowledgment_______{:#010b}", self.buf[1]);

        std::println!(
            "Primary Mode______________{}X",
            if self.config_reg.is_rx() { "R" } else { "T" }
        );
        std::println!("Powered Up________________{}", self.is_powered());

        // print pipe addresses
        self.spi_read(5, registers::TX_ADDR)?;
        let mut address = [0u8; 4];
        address.copy_from_slice(&self.buf[2..6]);
        std::println!(
            "TX address_______________{:#08X}{:02X}",
            u32::from_le_bytes(address),
            self.buf[1]
        );
        self.spi_read(1, registers::EN_RXADDR)?;
        let open_pipes = self.buf[1];
        for pipe in 0..=5 {
            self.spi_read(if pipe < 2 { 5 } else { 1 }, registers::RX_ADDR_P0 + pipe)?;
            if pipe < 2 {
                address.copy_from_slice(&self.buf[2..6]);
            }
            std::println!(
                "Pipe {pipe} ({}) bound to {:#08X}{:02X}",
                if (open_pipes & (1u8 << pipe)) > 0 {
                    " open "
                } else {
                    "closed"
                },
                // reverse the bytes read to represent how memory is stored
                u32::from_le_bytes(address),
                self.buf[1],
            );
        }
        Ok(())
    }
}

#[cfg(test)]
mod test {
    use super::EsbDetails;
    use crate::test::mk_radio;

    #[test]
    fn print_nothing() {
        let mocks = mk_radio(&[], &[]);
        let (mut radio, mut spi, mut ce_pin) = (mocks.0, mocks.1, mocks.2);
        assert!(radio.print_details().is_ok());
        spi.done();
        ce_pin.done();
    }
}