Crate rf24

rf24-rs

This crate is a rust driver library for the nRF24L01 wireless transceivers.

Examples

Examples are located in the rf24-rs repository.

Basic API

• RF24::new()
• RF24::init()
• RF24::is_rx()
• RF24::as_rx()
• RF24::as_tx()
• RF24::open_tx_pipe()
• RF24::open_rx_pipe()
• RF24::close_rx_pipe()
• RF24::available()
• RF24::available_pipe()
• RF24::read()
• RF24::send()
• RF24::resend()
• RF24::set_channel()
• RF24::get_channel()

Advanced API

• RF24::write_ack_payload()
• RF24::write()
• RF24::rewrite()
• RF24::get_fifo_state()
• RF24::clear_status_flags()
• RF24::update()
• RF24::get_status_flags()
• RF24::flush_rx()
• RF24::flush_tx()
• RF24::start_carrier_wave()
• RF24::stop_carrier_wave()
• RF24::rpd()
• RF24::get_last_arc()
• RF24::get_dynamic_payload_length()

Configuration API

• RF24::with_config()
• RF24::set_status_flags()
• RF24::set_auto_ack()
• RF24::set_auto_ack_pipe()
• RF24::set_auto_retries()
• RF24::set_dynamic_payloads()
• RF24::allow_ask_no_ack()
• RF24::allow_ack_payloads()
• RF24::set_address_length()
• RF24::get_address_length()
• RF24::set_payload_length()
• RF24::get_payload_length()
• RF24::set_data_rate()
• RF24::get_data_rate()
• RF24::set_pa_level()
• RF24::get_pa_level()
• RF24::set_lna()
• RF24::set_crc_length()
• RF24::get_crc_length()
• RF24::is_powered()
• RF24::power_up()
• RF24::power_down()
• RF24::tx_delay
• RF24::is_plus_variant()

Modules

radio

A module to encapsulate all things related to radio operation.

Structs

StatusFlags

A struct used to describe the different interrupt events.

Enums

CrcLength

The length of a CRC checksum that is used (if any).

DataRate

How fast data moves through the air. Units are in bits per second (bps).

FifoState

The possible states of a FIFO.

PaLevel

Power Amplifier level. The units dBm (decibel-milliwatts or dB_mW) represents a logarithmic signal loss.