async-button 0.2.0

Async button handling crate for no_std environments
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

use super::Duration;

/// [`Button`](super::Button) configuration.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct ButtonConfig {
    /// Time the button should be down in order to count it as a press.
    pub debounce: Duration,
    /// Time between consecutive presses to count as a press in the same sequence instead of a new
    /// sequence.
    pub double_click: Duration,
    /// Time the button is held before a long press is detected.
    pub long_press: Duration,
    /// Button direction.
    pub mode: Mode,
}

impl ButtonConfig {
    /// Returns a new [ButtonConfig].
    pub fn new(
        debounce: Duration,
        double_click: Duration,
        long_press: Duration,
        mode: Mode,
    ) -> Self {
        Self {
            debounce,
            double_click,
            long_press,
            mode,
        }
    }
}

impl Default for ButtonConfig {
    fn default() -> Self {
        Self {
            debounce: Duration::from_millis(10),
            double_click: Duration::from_millis(350),
            long_press: Duration::from_millis(1000),
            mode: Mode::default(),
        }
    }
}

/// Button direction.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum Mode {
    /// Button is connected to a pin with a pull-up resistor. Button pressed it logic 0.
    #[default]
    PullUp,
    /// Button is connected to a pin with a pull-down resistor. Button pressed it logic 1.
    PullDown,
}

impl Mode {
    /// Is button connected to a pin with a pull-up resistor?
    pub const fn is_pullup(&self) -> bool {
        matches!(self, Mode::PullUp)
    }

    /// Is button connected to a pin with a pull-down resistor?
    pub const fn is_pulldown(&self) -> bool {
        !self.is_pullup()
    }
}