Skip to main content

ButtonEsp

Struct ButtonEsp 

Source
pub struct ButtonEsp<'d> { /* private fields */ }
Expand description

A device abstraction for a button with debouncing and press duration detection.

§Hardware Requirements

The button can be wired in two ways:

§Usage

Use Button::wait_for_press when you only need a debounced press event. It returns on the down edge and does not wait for release.

Use Button::wait_for_press_duration when you need to distinguish short vs. long presses. It returns as soon as it can decide, so long presses are reported before the button is released.

§Example


use device_envoy_esp::{
    button::{Button as _, ButtonEsp, PressDuration, PressedTo},
    init_and_start, Result,
};

async fn example() -> Result<Infallible> {
    init_and_start!(p);
    let mut button = ButtonEsp::new(p.GPIO6, PressedTo::Ground);

    // Wait for a press without measuring duration.
    button.wait_for_press().await;

    // Measure press durations in a loop
    loop {
        match button.wait_for_press_duration().await {
            PressDuration::Short => {
                // Handle short press
            }
            PressDuration::Long => {
                // Handle long press (fires before button is released)
            }
        }
    }
}

Implementations§

Source§

impl<'d> ButtonEsp<'d>

Source

pub fn new(button_pin: impl InputPin + 'd, pressed_to: PressedTo) -> Self

Creates a new ButtonEsp instance from a pin.

The pin is configured based on the connection type:

Trait Implementations§

Source§

impl Button for ButtonEsp<'_>

Available on target_os=none only.
Source§

fn is_pressed(&self) -> bool

Returns whether the button is currently pressed.
Source§

async fn wait_for_press(&mut self)

Waits for the next press (button goes down, debounced). Does not wait for release. Read more
Source§

async fn wait_for_press_duration(&mut self) -> PressDuration

Waits for the next press and returns whether it was short or long (debounced). Read more

Auto Trait Implementations§

§

impl<'d> Freeze for ButtonEsp<'d>

§

impl<'d> RefUnwindSafe for ButtonEsp<'d>

§

impl<'d> Send for ButtonEsp<'d>

§

impl<'d> Sync for ButtonEsp<'d>

§

impl<'d> Unpin for ButtonEsp<'d>

§

impl<'d> UnsafeUnpin for ButtonEsp<'d>

§

impl<'d> !UnwindSafe for ButtonEsp<'d>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.