/elec/propeller-clock

To get this branch, use:
bzr branch http://bzr.ed.am/elec/propeller-clock

« back to all changes in this revision

Viewing changes to src/button.h

  • Committer: Tim Marston
  • Date: 2013-03-31 17:07:36 UTC
  • Revision ID: tim@ed.am-20130331170736-hphm2hg0y6l7w6z1
made rtc-test's DS1307 library a symlink to the main one in src/util

Show diffs side-by-side

added added

removed removed

src/button.h
1
 
#include <map>
 
1
/*
 
2
 * button.h
 
3
 *
 
4
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
 
5
 *
 
6
 * This file is part of propeller-clock (hereafter referred to as "this
 
7
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
 
8
 * information.
 
9
 *
 
10
 * This program is free software: you can redistribute it and/or modify
 
11
 * it under the terms of the GNU Lesser General Public License as published
 
12
 * by the Free Software Foundation, either version 3 of the License, or
 
13
 * (at your option) any later version.
 
14
 *
 
15
 * This program is distributed in the hope that it will be useful,
 
16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
18
 * GNU Lesser General Public License for more details.
 
19
 *
 
20
 * You should have received a copy of the GNU Lesser General Public License
 
21
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
22
 */
 
23
#ifndef _BUTTON_H_
 
24
#define _BUTTON_H_
 
25
 
2
26
 
3
27
class Button
4
28
{
12
36
        Button( int pin );
13
37
 
14
38
        /**
15
 
         * Add a duration at which the specified event id should be triggered.
16
 
         *
17
 
         * @oaram duration the time at which the event should be triggered
18
 
         * @param event_id a unique identifier for the event (not 0)
19
 
         */
20
 
        void add_event_at( int duration, int event_id );
21
 
 
22
 
        /**
23
 
         * Update internal state
24
 
         */
25
 
        int update();
26
 
 
27
 
        /**
28
 
         * Retrieve the event id of the event that was triggered at the last
29
 
         * update, if there was one.
30
 
         *
31
 
         * @return event id, or 0
32
 
         */
33
 
        int get_triggered_event();
 
39
         * Set event times.
 
40
         *
 
41
         * @oaram pointer to ordered, zero-terminated array of event times
 
42
         */
 
43
        void set_event_times( int *event_times );
 
44
 
 
45
        /**
 
46
         * Set button press mode
 
47
         *
 
48
         * @param send_interim send interim presses during a long press?
 
49
         */
 
50
        void set_press_mode( bool send_interim );
 
51
 
 
52
        /**
 
53
         * Update internal state (call as regularly sa possible!)
 
54
         */
 
55
        void update();
 
56
 
 
57
        /**
 
58
         * Get the first pending event.
 
59
         *
 
60
         * @return event id, 0 if there isn't any
 
61
         */
 
62
        int get_event();
 
63
 
 
64
        /**
 
65
         * Get the current button state.
 
66
         *
 
67
         * @return true if the button is pressed
 
68
         */
 
69
        bool get_state();
34
70
 
35
71
protected:
36
72
 
37
73
        /** pin */
38
74
        int _pin;
39
75
 
40
 
        /** last state */
41
 
        bool _last_state;
42
 
 
43
 
        /** milliseconds since last state change */
44
 
        int _last_millis;
45
 
 
46
 
        /** triggered event */
47
 
        int _event_id;
48
 
 
49
 
        /** press events durations -> event ids */
50
 
        std::map< int, int > _press_events;
51
 
 
 
76
        /** last real state */
 
77
        bool _last_real_state;
 
78
 
 
79
        /** time when the real state began */
 
80
        unsigned long _millis_real_state;
 
81
 
 
82
        /** accepted state */
 
83
        bool _state;
 
84
 
 
85
        /** time when the accepted state began */
 
86
        unsigned long _millis_state;
 
87
 
 
88
        /** amount of time that we've already triggered events for this press */
 
89
        unsigned long _millis_done;
 
90
 
 
91
        /** pointer to event times */
 
92
        int *_event_times;
 
93
 
 
94
        /** pending event */
 
95
        int _pending_event;
52
96
};
 
97
 
 
98
 
 
99
#endif //_BUTTON_H_