Struct switch_hal::Switch

pub struct Switch<IoPin, ActiveLevel> { /* private fields */ }

Concrete implementation for InputSwitch and OutputSwitch

Type Params

• IoPin must be a type that implements either of the InputPin or OutputPin traits.
• ActiveLevel indicates whether the Switch is ActiveHigh or ActiveLow. ActiveLevel is not actually stored in the struct. It’s PhantomData used to indicate which implementation to use.

Implementations

impl<IoPin, ActiveLevel> Switch<IoPin, ActiveLevel>

pub fn new(pin: IoPin) -> Self

Constructs a new Switch from a concrete implementation of an InputPin or OutputPin

Prefer the IntoSwitch trait over calling new directly.

Examples

Active High

use switch_hal::{ActiveHigh, OutputSwitch, Switch};
let mut led = Switch::<_, ActiveHigh>::new(pin);

ActiveLow

use switch_hal::{ActiveLow, OutputSwitch, Switch};
let mut led = Switch::<_, ActiveLow>::new(pin);

stm32f3xx-hal

// Example for the stm32f303
use stm32f3xx_hal::gpio::gpioe;
use stm32f3xx_hal::gpio::{PushPull, Output};
use stm32f3xx_hal::stm32;

use switch_hal::{ActiveHigh, Switch};

let device_periphs = stm32::Peripherals::take().unwrap();
let gpioe = device_periphs.GPIOE.split(&mut reset_control_clock.ahb);

let led = Switch::<_, ActiveHigh>::new(
    gpioe
    .pe9
    .into_push_pull_output(&mut gpioe.moder, &mut gpioe.otyper)
)

pub fn into_pin(self) -> IoPin

Consumes the Switch and returns the underlying InputPin or OutputPin.

This is useful fore retrieving the underlying pin to use it for a different purpose.

Examples

use switch_hal::{OutputSwitch, Switch, IntoSwitch};
let mut led = pin.into_active_high_switch();
led.on().ok();
let mut pin = led.into_pin();
// do something else with the pin

Trait Implementations

impl<T: InputPin> InputSwitch for Switch<T, ActiveHigh>

type Error = <T as InputPin>::Error

fn is_active(&self) -> Result<bool, Self::Error>

Returns true if the swich has been activated, otherwise false i.e. if a button is currently pressed, returns true

impl<T: InputPin> InputSwitch for Switch<T, ActiveLow>

type Error = <T as InputPin>::Error

fn is_active(&self) -> Result<bool, Self::Error>

Returns true if the swich has been activated, otherwise false i.e. if a button is currently pressed, returns true

impl<T: OutputPin> OutputSwitch for Switch<T, ActiveHigh>

type Error = <T as OutputPin>::Error

fn on(&mut self) -> Result<(), Self::Error>

Turns the switch on

fn off(&mut self) -> Result<(), Self::Error>

Turns the switch off

impl<T: OutputPin> OutputSwitch for Switch<T, ActiveLow>

type Error = <T as OutputPin>::Error

fn on(&mut self) -> Result<(), Self::Error>

Turns the switch on

fn off(&mut self) -> Result<(), Self::Error>

Turns the switch off

impl<T: OutputPin + StatefulOutputPin> StatefulOutputSwitch for Switch<T, ActiveHigh>

type Error = <T as OutputPin>::Error

fn is_on(&mut self) -> Result<bool, Self::Error>

Checks whether the switch is on

fn is_off(&mut self) -> Result<bool, Self::Error>

Checks whether the switch is off

impl<T: OutputPin + StatefulOutputPin> StatefulOutputSwitch for Switch<T, ActiveLow>

type Error = <T as OutputPin>::Error

fn is_on(&mut self) -> Result<bool, Self::Error>

Checks whether the switch is on

fn is_off(&mut self) -> Result<bool, Self::Error>

Checks whether the switch is off

impl<T: OutputPin + ToggleableOutputPin, ActiveLevel> ToggleableOutputSwitch for Switch<T, ActiveLevel>

type Error = <T as ToggleableOutputPin>::Error

fn toggle(&mut self) -> Result<(), Self::Error>

Toggles the current state of the OutputSwitch