Struct embedded_nrf24l01::NRF24L01

pub struct NRF24L01<CE: OutputPin, CSN: OutputPin, SPI: SpiTransfer<u8>> { /* fields omitted */ }

Driver for the nRF24L01+

Never deal with this directly. Instead, you store one of the following types:

• StandbyMode<D>
• RxMode<D>
• TxMode<D>

where D:Device

Methods

impl<CE: OutputPin, CSN: OutputPin, SPI: SpiTransfer<u8, Error = SPIE>, SPIE: Debug> NRF24L01<CE, CSN, SPI>

pub fn new(ce: CE, csn: CSN, spi: SPI) -> Result<StandbyMode<Self>, SPIE>

Construct a new driver instance.

pub fn is_connected(&mut self) -> Result<bool, SPIE>

Reads and validates content of the SETUP_AW register.

Trait Implementations

impl<CE: OutputPin, CSN: OutputPin, SPI: SpiTransfer<u8, Error = SPIE>, SPIE: Debug> Debug for NRF24L01<CE, CSN, SPI>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<CE: OutputPin, CSN: OutputPin, SPI: SpiTransfer<u8, Error = SPIE>, SPIE: Debug> Device for NRF24L01<CE, CSN, SPI>

type Error = SPIE

Error from the SPI implementation

fn ce_enable(&mut self)

Set CE pin high

fn ce_disable(&mut self)

Set CE pin low

fn send_command<C: Command>(
    &mut self,
    command: &C
) -> Result<(Status, C::Response), Self::Error>

Send a command via SPI

fn write_register<R: Register>(
    &mut self,
    register: R
) -> Result<Status, Self::Error>

Send W_REGISTER command

fn read_register<R: Register>(&mut self) -> Result<(Status, R), Self::Error>

Send R_REGISTER command

fn update_config<F, R>(&mut self, f: F) -> Result<R, Self::Error> where
    F: FnOnce(&mut Config) -> R, 

Modify the (cached) CONFIG register and write if it has changed.

fn with_ce_disabled<F, R>(&mut self, f: F) -> R where
    F: FnOnce(&mut Self) -> R, 

Helper; the receiving during RX and sending during TX require CE to be low.

fn update_register<Reg, F, R>(&mut self, f: F) -> Result<R, Self::Error> where
    Reg: Register + PartialEq + Clone,
    F: FnOnce(&mut Reg) -> R, 

Read, and modify a register, and write it back if it has been changed.