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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

use claims::{assert_matches, assert_none, assert_some_eq};
use embedded_hal_mock::eh1::digital::{
    Mock, State as PinState, Transaction, TransactionKind as Kind,
};

use crate::{Button, ButtonConfig, ButtonEvent, Duration, Mode, State};

// Use shorter times to speed up test execution
const CONFIG: ButtonConfig = ButtonConfig {
    debounce: Duration::from_millis(10),
    double_click: Duration::from_millis(100),
    long_press: Duration::from_millis(200),
    mode: Mode::PullUp,
};

const IMMEDIATELY: Duration = Duration::from_millis(0);

#[tokio::test(start_paused = true)]
async fn start_idle() {
    let expectations = [Transaction::new(Kind::Get(PinState::High))];
    let pin = Mock::new(&expectations);
    let mut button = Button::new(pin, CONFIG);

    button.update_step().await;

    assert_matches!(button.state, State::Idle);

    button.pin.done();
}

#[tokio::test]
async fn start_pressed() {
    let expectations = [Transaction::get(PinState::Low)];
    let pin = Mock::new(&expectations);
    let mut button = Button::new(pin, CONFIG);

    let event = button.update_step().await;
    assert_none!(event);
    assert_matches!(button.state, State::Pressed);

    button.pin.done();
}

#[tokio::test]
async fn single_press() {
    let expectations = [
        Transaction::wait_for_state(PinState::Low, IMMEDIATELY),
        Transaction::get(PinState::Low),
        Transaction::wait_for_state(PinState::High, IMMEDIATELY),
        Transaction::get(PinState::High),
    ];
    let pin = Mock::new(&expectations);
    let mut button = Button::new(pin, CONFIG);
    button.state = State::Idle;

    let event = button.update_step().await;
    assert_none!(event);
    assert_matches!(button.state, State::Pressed);

    let event = button.update_step().await;
    assert_none!(event);
    assert_matches!(button.state, State::Released);
    assert_eq!(button.count, 1);

    button.pin.done();
}

#[tokio::test]
async fn long_press() {
    let expectations = [
        Transaction::wait_for_state(PinState::Low, IMMEDIATELY),
        Transaction::get(PinState::Low),
        Transaction::wait_for_state(PinState::High, Duration::from_millis(250)),
        Transaction::wait_for_state(PinState::High, IMMEDIATELY),
        Transaction::get(PinState::High),
    ];
    let pin = Mock::new(&expectations);
    let mut button = Button::new(pin, CONFIG);
    button.state = State::Idle;

    let _ = button.update_step().await;

    let event = button.update_step().await;
    assert_some_eq!(event, ButtonEvent::LongPress);
    assert_matches!(button.state, State::PendingRelease);
    assert_eq!(button.count, 0);

    let event = button.update_step().await;
    assert_none!(event);
    assert_matches!(button.state, State::Idle);
    assert_eq!(button.count, 0);

    button.pin.done();
}

#[tokio::test]
async fn debounce_press() {
    let expectations = [
        Transaction::wait_for_state(PinState::Low, IMMEDIATELY),
        Transaction::get(PinState::High),
    ];
    let pin = Mock::new(&expectations);
    let mut button = Button::new(pin, CONFIG);
    button.state = State::Idle;

    let event = button.update_step().await;
    assert_none!(event);
    assert_matches!(button.state, State::Idle);

    button.pin.done();
}

#[tokio::test]
async fn debounce_release() {
    let expectations = [
        Transaction::wait_for_state(PinState::High, IMMEDIATELY),
        Transaction::get(PinState::Low),
    ];
    let pin = Mock::new(&expectations);
    let mut button = Button::new(pin, CONFIG);
    button.state = State::Pressed;

    let event = button.update_step().await;
    assert_none!(event);
    assert_matches!(button.state, State::Pressed);

    button.pin.done();
}

#[tokio::test]
async fn double_click() {
    let expectations = [
        Transaction::wait_for_state(PinState::Low, IMMEDIATELY),
        Transaction::get(PinState::Low),
        Transaction::wait_for_state(PinState::High, IMMEDIATELY),
        Transaction::get(PinState::High),
        Transaction::wait_for_state(PinState::Low, IMMEDIATELY),
        Transaction::get(PinState::Low),
        Transaction::wait_for_state(PinState::High, IMMEDIATELY),
        Transaction::get(PinState::High),
        Transaction::wait_for_state(PinState::Low, Duration::from_millis(250)),
    ];
    let pin = Mock::new(&expectations);
    let mut button = Button::new(pin, CONFIG);
    button.state = State::Idle;

    let event = button.update_step().await;
    assert_none!(event);
    assert_matches!(button.state, State::Pressed);

    let event = button.update_step().await;
    assert_none!(event);
    assert_matches!(button.state, State::Released);

    let event = button.update_step().await;
    assert_none!(event);
    assert_matches!(button.state, State::Pressed);

    let event = button.update_step().await;
    assert_none!(event);
    assert_matches!(button.state, State::Released);

    let event = button.update_step().await;
    assert_some_eq!(event, ButtonEvent::ShortPress { count: 2 });
    assert_matches!(button.state, State::Idle);

    button.pin.done();
}