Struct lora_e5_bsp::RfSwitch

pub struct RfSwitch { /* private fields */ }

RF switch

Implementations

impl RfSwitch

pub fn new(a4: A4, a5: A5, cs: &CriticalSection) -> RfSwitch

Create a new RfSwitch struct from GPIOs.

Example

use lora_e5_bsp::{
    hal::{cortex_m, gpio::PortA, pac},
    RfSwitch,
};

let mut dp: pac::Peripherals = pac::Peripherals::take().unwrap();

let gpioa: PortA = PortA::split(dp.GPIOA, &mut dp.RCC);
let rfs: RfSwitch = cortex_m::interrupt::free(|cs| RfSwitch::new(gpioa.a4, gpioa.a5, cs));

pub unsafe fn steal() -> Self

Steal the RF switch from whatever is currently using it.

Safety

1. Ensure that the code stealing the RF switch has exclusive access. Singleton checks are bypassed with this method.
2. You must set up the RF switch pins. No setup will occur when using this method.

Example

use lora_e5_bsp::{
    hal::{
        cortex_m,
        gpio::{pins, Output, PortA},
        pac,
    },
    RfSwitch,
};

let mut dp: pac::Peripherals = pac::Peripherals::take().unwrap();

let pa: PortA = PortA::split(dp.GPIOA, &mut dp.RCC);
cortex_m::interrupt::free(|cs| {
    let _: Output<pins::A4> = Output::default(pa.a4, cs);
    let _: Output<pins::A5> = Output::default(pa.a5, cs);
});

// safety:
// 1. we have exclusive access to the underlying pins
// 2. the pins have been setup
let rfs: RfSwitch = unsafe { RfSwitch::steal() };

pub fn set_rx(&mut self)

Set the RF switch to receive.

Example

use lora_e5_bsp::{
    hal::{cortex_m, gpio::PortA, pac},
    RfSwitch,
};

let mut dp: pac::Peripherals = pac::Peripherals::take().unwrap();

let gpioa: PortA = PortA::split(dp.GPIOA, &mut dp.RCC);
let mut rfs: RfSwitch = cortex_m::interrupt::free(|cs| RfSwitch::new(gpioa.a4, gpioa.a5, cs));
rfs.set_rx();

pub fn set_tx_hp(&mut self)

Set the RF switch to high power transmit.

Example

use lora_e5_bsp::{
    hal::{cortex_m, gpio::PortA, pac},
    RfSwitch,
};

let mut dp: pac::Peripherals = pac::Peripherals::take().unwrap();

let gpioa: PortA = PortA::split(dp.GPIOA, &mut dp.RCC);
let mut rfs: RfSwitch = cortex_m::interrupt::free(|cs| RfSwitch::new(gpioa.a4, gpioa.a5, cs));
rfs.set_tx_hp();

Trait Implementations

impl Debug for RfSwitch

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

Formats the value using the given formatter.