Struct DebouncedInput

pub struct DebouncedInput<Switch: InputSwitch, Config: DebouncedInputConfig> { /* private fields */ }

Concrete implementation of debounced input.

Type Params

Switch - InputSwitch that provides input for debouncing.

Config - DebouncedInputConfig that provides configs for debouncing.

Example

debounced_input_config!(
    SomeDebouncedInputConfig,
    debounce_timer: MyElapsedTimer = MyElapsedTimer::new(20.millis())
);

type MyDebouncedInput<Switch> = DebouncedInput<Switch, SomeDebouncedInputConfig>;

let mut debounced_input = MyDebouncedInput::new(pin.into_active_low_switch());

loop {
    match debounced_input.update().unwrap() {
        DebouncedInputEvent::Low => do_something_when_low(),
        DebouncedInputEvent::High => do_something_when_high(),
        DebouncedInputEvent::Rise => do_something_upon_rise(),
        DebouncedInputEvent::Fall => do_something_upon_fall(),
    }
}

Implementations

impl<Switch: InputSwitch, Config: DebouncedInputConfig> DebouncedInput<Switch, Config>

pub fn new(input_switch: Switch) -> Self

Creates a new DebouncedInput<Switch, Config> from a concrete Switch.

input_switch - an concrete instance of Switch.

pub fn is_high(&self) -> bool

Returns the is stable high state.

pub fn is_low(&self) -> bool

Returns the is stable low state.

pub fn borrow_input_switch(&self) -> &Switch

Borrow Switch.

pub fn release_input_switch(self) -> Switch

Consumes self and release Switch.

Trait Implementations

impl<Switch: InputSwitch, Config: DebouncedInputConfig> Control for DebouncedInput<Switch, Config>

type Event = DebouncedInputEvent

type Error = Error<<<<Config as DebouncedInputConfig>::Timer as ElapsedTimer>::Timestamp as Timestamp>::Error, <Switch as InputSwitch>::Error>

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

Update a control and return an current event or error after update.