Struct ConfigBuilder

pub struct ConfigBuilder(/* private fields */);

Available on crate feature esb only.

A builder for an Config structure

The builder is converted into an Config by calling the check() method.

Example

use esb::ConfigBuilder;

let config_result = ConfigBuilder::default()
    .wait_for_ack_timeout(50)
    .retransmit_delay(240)
    .maximum_transmit_attempts(4)
    .enabled_pipes(0x01)
    .check();

assert!(config_result.is_ok());

Default Config Contents

By default, the following settings will be used:

Field	Default Value
Ack Timeout	120 us
Retransmit Delay	500 us
Maximum number of transmit attempts	3
Enabled Pipes	0xFF
Tx Power	0dBm
Maximum payload size	252 bytes

Implementations

impl ConfigBuilder

pub fn wait_for_ack_timeout(self, micros: u16) -> ConfigBuilder

Sets number of microseconds to wait for an acknowledgement before timing out

pub fn retransmit_delay(self, micros: u16) -> ConfigBuilder

Sets retransmit delay, must be bigger than wait_for_ack_timeout field plus 62 and bigger than the ramp-up time (140us without fast-ru and 40us with fast-ru)

pub fn maximum_transmit_attempts(self, n: u8) -> ConfigBuilder

Sets maximum number of transmit attempts

pub fn enabled_pipes(self, enabled_pipes: u8) -> ConfigBuilder

Sets enabled pipes for receiving

pub fn tx_power(self, tx_power: Txpower) -> ConfigBuilder

Sets the tx power

pub fn max_payload_size(self, payload_size: u8) -> ConfigBuilder

Sets the maximum payload size

pub fn check(self) -> Result<Config, Error>

Trait Implementations

impl Default for ConfigBuilder

fn default() -> ConfigBuilder

Returns the “default value” for a type.