Struct nrf24_rs::config::NrfConfig

pub struct NrfConfig { /* fields omitted */ }

Configuration builder struct for NRF chip.

Always created with the default() method and modified through the builder pattern.

Example: default

use nrf24::Nrf24l01;
use nrf24::config::NrfConfig;

let config = NrfConfig::default();

let mut chip = Nrf24l01::new(spi, ce, ncs, delay, config)?;

Example: custom configuration

use nrf24::Nrf24l01;
use nrf24::config::{PALevel, DataRate, NrfConfig, PayloadSize};

let config = NrfConfig::default()
    .payload_size(PayloadSize::Dynamic) // set dynamic payload size
    .channel(7)
    .addr_width(3),
    .data_rate(DataRate::R2Mbps)
    .pa_level(PALevel::Max)
    .crc_encoding_scheme(None) // disable crc
    .ack_payloads_enabled(true)
    .auto_retry((15, 15));

let mut chip = Nrf24l01::new(spi, ce, ncs, delay, config)?;

Implementations

impl NrfConfig

pub fn payload_size<T: Into<PayloadSize>>(self, payload_size: T) -> Self

Set Payload Size A value of 0 means dynamic payloads will be enabled. Values greater than MAX_PAYLOAD_SIZE will be floored.

pub fn channel(self, channel: u8) -> Self

Set RF channel Must be a number in [0..125], values outside will be clipped

pub fn addr_width<T: Into<AddressWidth>>(self, addr_width: T) -> Self

Set the Address Width If using a number, it must be in [3..5], values outside will be clipped

pub fn data_rate(self, data_rate: DataRate) -> Self

Set the Data Rate

pub fn pa_level(self, pa_level: PALevel) -> Self

Set the Power Amplification Level

pub fn crc_encoding_scheme(
    self,
    crc_encoding_scheme: Option<EncodingScheme>
) -> Self

Set the Cyclic Redundancy Check Encodign Scheme None will disable the CRC.

pub fn ack_payloads_enabled(self, ack_payloads_enabled: bool) -> Self

Configure if auto acknowledgements are enabled

pub fn auto_retry<T: Into<AutoRetransmission>>(self, auto_retry: T) -> Self

Set the automatic retransmission config

Trait Implementations

impl Clone for NrfConfig

fn clone(&self) -> NrfConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NrfConfig

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

Formats the value using the given formatter.

impl Default for NrfConfig

fn default() -> Self

Returns the “default value” for a type.

impl Copy for NrfConfig