/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: edam
  • Date: 2012-02-25 01:31:43 UTC
  • Revision ID: tim@ed.am-20120225013143-9fet2y2d3fjlrwez
added ulibc

Show diffs side-by-side

added added

removed removed

src/button.h
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
 
 
 
1
#include <map>
26
2
 
27
3
class Button
28
4
{
36
12
        Button( int pin );
37
13
 
38
14
        /**
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
 
         * Update internal state (call as regularly sa possible!)
47
 
         */
48
 
        void update();
49
 
 
50
 
        /**
51
 
         * Get the first pending event.
52
 
         *
53
 
         * @return event id, 0 if there isn't any
54
 
         */
55
 
        int get_event();
 
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();
56
34
 
57
35
protected:
58
36
 
59
37
        /** pin */
60
38
        int _pin;
61
39
 
62
 
        /** current state */
63
 
        bool _state;
64
 
 
65
 
        /** time when current state began */
66
 
        unsigned long _state_millis;
67
 
 
68
 
        /** milliseconds that have been accountred for (in terms of
69
 
         * triggering events) since current state began */
70
 
        unsigned long _state_duration;
71
 
 
72
 
        /** pointer to event times */
73
 
        int *_event_times;
74
 
 
75
 
        /** pending event */
76
 
        int _pending_event;
 
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;
77
51
 
78
52
};
79
 
 
80
 
 
81
 
#endif //_BUTTON_H_