Struct TxMode

pub struct TxMode<D: Device> { /* private fields */ }

Represents TX Mode and the associated TX Settling and Standby-II states

Timing

The datasheet states the follwing:

It is important to never keep the nRF24L01 in TX mode for more than 4ms at a time.

No effects have been observed when exceeding this limit. The warranty could get void.

Implementations

impl<D: Device> TxMode<D>

pub async fn standby(self) -> Result<StandbyMode<D>, D::Error>

Disable CE so that you can switch into RX mode.

pub async fn is_empty(&mut self) -> Result<bool, D::Error>

Is TX FIFO empty?

pub async fn is_full(&mut self) -> Result<bool, D::Error>

Is TX FIFO full?

pub async fn can_send(&mut self) -> Result<bool, D::Error>

Does the TX FIFO have space?

pub async fn send(&mut self, packet: &[u8]) -> Result<Status, D::Error>

Send asynchronously

pub async fn poll_send(&mut self) -> Result<bool, D::Error>

Poll completion of one or multiple send operations and check whether transmission was successful.

This function behaves like wait_empty(), except that it returns whether sending was successful and that it provides an asynchronous interface.

Automatic retransmission (set_auto_retransmit) and acks (set_auto_ack) have to be enabled if you actually want to know if transmission was successful. Else the nrf24 just transmits the packet once and assumes it was received.

pub async fn wait_empty(&mut self) -> Result<(), D::Error>

Wait until TX FIFO is empty

If any packet cannot be delivered and the maximum amount of retries is reached, the TX FIFO is flushed and all other packets in the FIFO are lost.

pub async fn observe(&mut self) -> Result<ObserveTx, D::Error>

Read the OBSERVE_TX register

Trait Implementations

impl<D: Device> Configuration for TxMode<D>

type Inner = D

Underlying trait Device

fn device(&mut self) -> &mut Self::Inner

Get a mutable reference to the underlying device

async fn flush_rx( &mut self, ) -> Result<(), <<Self as Configuration>::Inner as Device>::Error>

Flush RX queue

async fn flush_tx( &mut self, ) -> Result<(), <<Self as Configuration>::Inner as Device>::Error>

Flush TX queue, discarding any unsent packets

async fn get_frequency( &mut self, ) -> Result<u8, <<Self as Configuration>::Inner as Device>::Error>

Get frequency offset (channel)

async fn set_frequency( &mut self, freq_offset: u8, ) -> Result<(), <<Self as Configuration>::Inner as Device>::Error>

Set frequency offset (channel)

async fn set_rf( &mut self, rate: &DataRate, power: u8, ) -> Result<(), <<Self as Configuration>::Inner as Device>::Error>

power: 0: -18 dBm, 3: 0 dBm

async fn set_crc( &mut self, mode: CrcMode, ) -> Result<(), <<Self as Configuration>::Inner as Device>::Error>

Set CRC mode

async fn set_interrupt_mask( &mut self, data_ready_rx: bool, data_sent_tx: bool, max_retransmits_tx: bool, ) -> Result<(), <<Self as Configuration>::Inner as Device>::Error>

Sets the interrupt mask

async fn set_pipes_rx_enable( &mut self, bools: &[bool; 6], ) -> Result<(), <<Self as Configuration>::Inner as Device>::Error>

Configure which RX pipes to enable

async fn set_rx_addr( &mut self, pipe_no: usize, addr: &[u8], ) -> Result<(), <<Self as Configuration>::Inner as Device>::Error>

Set address addr of pipe number pipe_no

async fn set_tx_addr( &mut self, addr: &[u8], ) -> Result<(), <<Self as Configuration>::Inner as Device>::Error>

Set address of the TX pipe

async fn set_auto_retransmit( &mut self, delay: u8, count: u8, ) -> Result<(), <<Self as Configuration>::Inner as Device>::Error>

Configure auto-retransmit

async fn get_auto_ack( &mut self, ) -> Result<[bool; 6], <<Self as Configuration>::Inner as Device>::Error>

Obtain auto-acknowledgment configuration for all pipes

async fn set_auto_ack( &mut self, bools: &[bool; 6], ) -> Result<(), <<Self as Configuration>::Inner as Device>::Error>

Configure auto-acknowledgment for all RX pipes

async fn get_address_width( &mut self, ) -> Result<u8, <<Self as Configuration>::Inner as Device>::Error>

Get address width configuration

async fn set_address_width( &mut self, width: u8, ) -> Result<(), <<Self as Configuration>::Inner as Device>::Error>

Set address width configuration

async fn get_interrupts( &mut self, ) -> Result<(bool, bool, bool), <<Self as Configuration>::Inner as Device>::Error>

Obtain interrupt pending status as (RX_DR, TX_DR, MAX_RT) where RX_DR indicates new data in the RX FIFO, TX_DR indicates that a packet has been sent, and MAX_RT indicates maximum retransmissions without auto-ack.

async fn clear_interrupts( &mut self, ) -> Result<(), <<Self as Configuration>::Inner as Device>::Error>

Clear all interrupts

async fn set_pipes_rx_lengths( &mut self, lengths: &[Option<u8>; 6], ) -> Result<(), <<Self as Configuration>::Inner as Device>::Error>

bools

impl<D: Device> Debug for TxMode<D>

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

Formats the value using the given formatter.