application: Add the button module.
[gps-watch.git] / src / application / button.rs
1 /*
2  * Copyright (c) 2020 Tilman Sauerbeck (tilman at code-monkey de)
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files (the
6  * "Software"), to deal in the Software without restriction, including
7  * without limitation the rights to use, copy, modify, merge, publish,
8  * distribute, sublicense, and/or sell copies of the Software, and to
9  * permit persons to whom the Software is furnished to do so, subject to
10  * the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  */
23
24 use common::gpio;
25 use common::systick;
26
27 enum State {
28     WaitPress,
29     WaitRelease,
30     WaitTimeout,
31 }
32
33 pub struct Button {
34     gpio: u32,
35     pin: u32,
36     state: State,
37     start_press_ticks: u32,
38 }
39
40 impl Button {
41     pub fn new(gpio: u32, pin: u32) -> Button {
42         Button {
43             gpio: gpio,
44             pin: pin,
45             state: State::WaitPress,
46             start_press_ticks: 0,
47         }
48     }
49
50     pub fn has_been_held_for_ms(&mut self, delay_ms: u32) -> bool {
51         let mut has_been_held = false;
52
53         self.state = match self.state {
54             State::WaitPress => {
55                 if (gpio::get(self.gpio) & self.pin) != 0 {
56                     State::WaitPress
57                 } else {
58                     self.start_press_ticks = systick::now();
59
60                     State::WaitTimeout
61                 }
62             },
63             State::WaitRelease => {
64                 if (gpio::get(self.gpio) & self.pin) == 0 {
65                     State::WaitRelease
66                 } else {
67                     State::WaitPress
68                 }
69             },
70             State::WaitTimeout => {
71                 if (gpio::get(self.gpio) & self.pin) != 0 {
72                     State::WaitPress
73                 } else if systick::has_timeout_ms(self.start_press_ticks,
74                                                   delay_ms) {
75                     has_been_held = true;
76
77                     State::WaitRelease
78                 } else {
79                     State::WaitTimeout
80                 }
81             },
82         };
83
84         has_been_held
85     }
86 }