Struct embedded_nrf24l01::RxMode

pub struct RxMode<D: Device> { /* fields omitted */ }

Represents RX Mode

Implementations

impl<D: Device> RxMode<D>

pub fn standby(self) -> StandbyMode<D>

Disable CE so that you can switch into TX mode.

pub fn can_read(&mut self) -> Result<Option<u8>, D::Error>

Is there any incoming data to read? Return the pipe number.

This function acknowledges all interrupts even if there are more received packets, so the caller must repeat the call until the function returns None before waiting for the next RX interrupt.

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

Is an in-band RF signal detected?

The internal carrier detect signal must be high for 40μs (NRF24L01+) or 128μs (NRF24L01) before the carrier detect register is set. Note that changing from standby to receive mode also takes 130μs.

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

Is the RX queue empty?

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

Is the RX queue full?

pub fn read(&mut self) -> Result<Payload, D::Error>

Read the next received packet

Trait Implementations

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

type Inner = D

Underlying trait Device

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

Get a mutable reference to the underlying device

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

Flush RX queue

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

Flush TX queue, discarding any unsent packets

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

Get frequency offset (channel)

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

Set frequency offset (channel)

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

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

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

Set CRC mode

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

Sets the interrupt mask

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

Configure which RX pipes to enable

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

Set address addr of pipe number pipe_no

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

Set address of the TX pipe

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

Configure auto-retransmit

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

Obtain auto-acknowledgment configuration for all pipes

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

Configure auto-acknowledgment for all RX pipes

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

Get address width configuration

fn get_interrupts(
    &mut self
) -> Result<(bool, bool, bool), <Self::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.

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

Clear all interrupts

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

bools * None: Dynamic payload length * Some(len): Static payload length len

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

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

Formats the value using the given formatter.