Struct RfSetup 

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

RF_SETUP register

Set RF air data rate and output power.

Address = 0x06

Fields

cont_wave | bit 7

Enables continuous carrier transmit.

rf_dr_low | bit 5

Set RF data rate to 250kbps. See rf_dr_high.

pll_lock | bit 4

Force PLL lock signal. Only used in test.

rf_dr_high | bit 3

Select between the high speed data rates. This bit is don’t care if rf_dr_low is set. Enum: RfDrHigh. Default value: 1 (2 Mbps).

Encoding [RF_DR_LOW, RF_DR_HIGH]:

00 - 1Mbps

01 - 2Mbps

10 - 250kbps

11 - Reserved

rf_pwr | bits 2:1

RF output power in TX mode. Enum: RfPower. Default value: 11 (0 dBm).

Example

use nrf24l01_commands::{fields, registers};

// Default value
let reg = registers::RfSetup::new();
assert_eq!(reg.into_bits(), 0b0000_1110);

// Write fields
let reg = registers::RfSetup::new()
    .with_pll_lock(false)
    .with_rf_dr_low(true)
    .with_rf_dr_high(fields::RfDrHigh::Mbps1)
    .with_rf_pwr(fields::RfPower::Neg6Dbm);
assert_eq!(reg.into_bits(), 0b0010_0100);

// Read fields
assert_eq!(reg.rf_pwr(), fields::RfPower::Neg6Dbm);

Implementations

impl RfSetup

pub const fn new() -> Self

Creates a new default initialized bitfield.

pub const fn from_bits(bits: u8) -> Self

Convert from bits.

pub const fn into_bits(self) -> u8

Convert into bits.

pub const fn cont_wave(&self) -> bool

Enables continuous carrier transmit.

Bits: 7..8

pub const fn with_cont_wave_checked(self, value: bool) -> Result<Self, ()>

Enables continuous carrier transmit.

Bits: 7..8

pub const fn with_cont_wave(self, value: bool) -> Self

Enables continuous carrier transmit.

Bits: 7..8

pub const fn set_cont_wave(&mut self, value: bool)

Enables continuous carrier transmit.

Bits: 7..8

pub const fn set_cont_wave_checked(&mut self, value: bool) -> Result<(), ()>

Enables continuous carrier transmit.

Bits: 7..8

pub const fn rf_dr_low(&self) -> bool

Set RF data rate to 250kbps. See rf_dr_high.

Bits: 5..6

pub const fn with_rf_dr_low_checked(self, value: bool) -> Result<Self, ()>

Set RF data rate to 250kbps. See rf_dr_high.

Bits: 5..6

pub const fn with_rf_dr_low(self, value: bool) -> Self

Set RF data rate to 250kbps. See rf_dr_high.

Bits: 5..6

pub const fn set_rf_dr_low(&mut self, value: bool)

Set RF data rate to 250kbps. See rf_dr_high.

Bits: 5..6

pub const fn set_rf_dr_low_checked(&mut self, value: bool) -> Result<(), ()>

Set RF data rate to 250kbps. See rf_dr_high.

Bits: 5..6

pub const fn pll_lock(&self) -> bool

Force PLL lock signal. Only used in test.

Bits: 4..5

pub const fn with_pll_lock_checked(self, value: bool) -> Result<Self, ()>

Force PLL lock signal. Only used in test.

Bits: 4..5

pub const fn with_pll_lock(self, value: bool) -> Self

Force PLL lock signal. Only used in test.

Bits: 4..5

pub const fn set_pll_lock(&mut self, value: bool)

Force PLL lock signal. Only used in test.

Bits: 4..5

pub const fn set_pll_lock_checked(&mut self, value: bool) -> Result<(), ()>

Force PLL lock signal. Only used in test.

Bits: 4..5

pub const fn rf_dr_high(&self) -> RfDrHigh

Select between the high speed data rates. This bit is don’t care if rf_dr_low is set. Enum: RfDrHigh. Default value: 1 (2 Mbps).

Encoding [RF_DR_LOW, RF_DR_HIGH]:

00 - 1Mbps

01 - 2Mbps

10 - 250kbps

11 - Reserved

Bits: 3..4

pub const fn with_rf_dr_high_checked(self, value: RfDrHigh) -> Result<Self, ()>

Select between the high speed data rates. This bit is don’t care if rf_dr_low is set. Enum: RfDrHigh. Default value: 1 (2 Mbps).

Encoding [RF_DR_LOW, RF_DR_HIGH]:

00 - 1Mbps

01 - 2Mbps

10 - 250kbps

11 - Reserved

Bits: 3..4

pub const fn with_rf_dr_high(self, value: RfDrHigh) -> Self

Select between the high speed data rates. This bit is don’t care if rf_dr_low is set. Enum: RfDrHigh. Default value: 1 (2 Mbps).

Encoding [RF_DR_LOW, RF_DR_HIGH]:

00 - 1Mbps

01 - 2Mbps

10 - 250kbps

11 - Reserved

Bits: 3..4

pub const fn set_rf_dr_high(&mut self, value: RfDrHigh)

Select between the high speed data rates. This bit is don’t care if rf_dr_low is set. Enum: RfDrHigh. Default value: 1 (2 Mbps).

Encoding [RF_DR_LOW, RF_DR_HIGH]:

00 - 1Mbps

01 - 2Mbps

10 - 250kbps

11 - Reserved

Bits: 3..4

pub const fn set_rf_dr_high_checked( &mut self, value: RfDrHigh, ) -> Result<(), ()>

Select between the high speed data rates. This bit is don’t care if rf_dr_low is set. Enum: RfDrHigh. Default value: 1 (2 Mbps).

Encoding [RF_DR_LOW, RF_DR_HIGH]:

00 - 1Mbps

01 - 2Mbps

10 - 250kbps

11 - Reserved

Bits: 3..4

pub const fn rf_pwr(&self) -> RfPower

RF output power in TX mode. Enum: RfPower. Default value: 11 (0 dBm).

Bits: 1..3

pub const fn with_rf_pwr_checked(self, value: RfPower) -> Result<Self, ()>

RF output power in TX mode. Enum: RfPower. Default value: 11 (0 dBm).

Bits: 1..3

pub const fn with_rf_pwr(self, value: RfPower) -> Self

RF output power in TX mode. Enum: RfPower. Default value: 11 (0 dBm).

Bits: 1..3

pub const fn set_rf_pwr(&mut self, value: RfPower)

RF output power in TX mode. Enum: RfPower. Default value: 11 (0 dBm).

Bits: 1..3

pub const fn set_rf_pwr_checked(&mut self, value: RfPower) -> Result<(), ()>

RF output power in TX mode. Enum: RfPower. Default value: 11 (0 dBm).

Bits: 1..3

Trait Implementations

impl Clone for RfSetup

fn clone(&self) -> RfSetup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RfSetup

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

Formats the value using the given formatter.

impl Default for RfSetup

fn default() -> Self

Returns the “default value” for a type.

impl From<RfSetup> for u8

fn from(v: RfSetup) -> u8

Converts to this type from the input type.

impl From<u8> for RfSetup

fn from(v: u8) -> Self

Converts to this type from the input type.

impl Register for RfSetup

const ADDRESS: u8 = 6u8

Register address.

fn into_bits(self) -> u8

Convert register to bits.

impl Copy for RfSetup