embedded-nrf24l01

Features

• Designed for use with the embedded-hal crate
• Safe and declarative register definitions
• Chip operation modes lifted to the type-level
• Lets you go straight into RX/TX with the default config

Still missing

• Auto-ack support

Reference datasheets

• nRF24L01+

Usage

Parameters

Get the *-hal crate for your micro-controller unit. Figure out how to get to the peripherals implementing these embedded-hal traits:

• embedded_hal::blocking::spi::Transfer for the SPI peripheral

  We provide a mod setup with a few constants for SPI.

• embedded_hal::digital::OutputPin for the CE pin

• embedded_hal::digital::OutputPin for the CSN pin

  (Although that one belongs to the SPI, we found it much more reliable to implement in software.)

Constructor

let mut nrf24 = NRF24L01::new(ce, csn, spi).unwrap();

This will provide an instance of Standby. You can use .rx() or .tx() to transfer into a RXMode and TXMode instances. They implement .standby() methods to get back to Standby and then switch to the other mode.

Configuration

Before you start transmission, the device must be configured. Example:

nrf24.set_channel(8)?;
nrf24.set_auto_retransmit(0, 0)?;
nrf24.set_rf(&nrf24::DataRate::R2Mbps, 3)?;
nrf24.set_pipes_rx_enable(&[true, false, false, false, false, false])?;
nrf24.set_auto_ack(&[false; 6])?;
nrf24.set_crc(&nrf24::CrcMode::Disabled)?;
nrf24.set_tx_addr(&b"fnord"[..])?;

Before first use, it's recommended to call nb::block!(rf24.wait_tx_empty()) to flush after a soft restart.

Use nrf24.wait_rx_ready() to poll (returning the pipe number). Use nrf24.read() to receive a packet.

Use nrf24.wait_tx_ready() to wait for space in tx queue. Use nrf24.send() to enqueue a packet. Use nrf24.wait_tx_empty() to flush the tx queue.