Struct ButtonConfig 

pub struct ButtonConfig {
    pub debounce_ms: Millis,
    pub double_click_ms: Millis,
    pub hold_ms: Millis,
    pub multi_click_count: u8,
    pub multi_click_timeout_ms: Millis,
    pub active_level: ActiveLevel,
}

Button timing and polarity configuration.

Fields

debounce_ms: Millis

Time the raw pin state must remain unchanged before it is accepted as the stable debounced state.

double_click_ms: Millis

Maximum interval between two short releases that still counts as a double click.

hold_ms: Millis

Time after which a continuously pressed button reports a hold event.

multi_click_count: u8

Number of short clicks required to emit ButtonEvents::multi_click.

Values 0 and 1 disable the multi-click detector.

multi_click_timeout_ms: Millis

Maximum pause between short clicks in one multi-click sequence.

active_level: ActiveLevel

Electrical level that represents the pressed state.

Implementations

impl ButtonConfig

pub const DEFAULT_DEBOUNCE_MS: Millis = 20

Default debounce time.

pub const DEFAULT_DOUBLE_CLICK_MS: Millis = 300

Default double-click interval.

pub const DEFAULT_HOLD_MS: Millis = 800

Default hold threshold.

pub const DEFAULT_MULTI_CLICK_COUNT: u8 = 0

Default multi-click target count. 0 keeps the detector disabled.

pub const DEFAULT_MULTI_CLICK_TIMEOUT_MS: Millis = 3_000

Default timeout for the multi-click detector.

pub const fn active_low() -> Self

Creates a configuration for the common pull-up wiring where the pressed state is low.

pub const fn active_high() -> Self

Creates a configuration where the pressed state is high.

pub const fn with_debounce_ms(self, debounce_ms: Millis) -> Self

Returns the configuration with a different debounce time.

pub const fn with_double_click_ms(self, double_click_ms: Millis) -> Self

Returns the configuration with a different double-click interval.

pub const fn with_hold_ms(self, hold_ms: Millis) -> Self

Returns the configuration with a different hold threshold.

pub const fn with_multi_click_count(self, multi_click_count: u8) -> Self

Returns the configuration with a different multi-click target count.

Values 0 and 1 disable the detector. Use 2 for a configurable double click, 5 for five short clicks, and so on.

pub const fn with_multi_click_timeout_ms( self, multi_click_timeout_ms: Millis, ) -> Self

Returns the configuration with a different multi-click timeout.

The timeout is the maximum pause between two short clicks in the same sequence. If the pause is greater than this value, the sequence count is reset.

pub const fn with_multi_click( self, multi_click_count: u8, multi_click_timeout_ms: Millis, ) -> Self

Returns the configuration with a multi-click target and timeout.

Trait Implementations

impl Clone for ButtonConfig

fn clone(&self) -> ButtonConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ButtonConfig

impl Debug for ButtonConfig

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

Formats the value using the given formatter.

impl Default for ButtonConfig

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ButtonConfig

impl PartialEq for ButtonConfig

fn eq(&self, other: &ButtonConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ButtonConfig