/elec/propeller-clock

To get this branch, use:
bzr branch http://bzr.ed.am/elec/propeller-clock
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
/*
 * button.h
 *
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
 *
 * This file is part of propeller-clock (hereafter referred to as "this
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
 * information.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef _BUTTON_H_
#define _BUTTON_H_


#include <map>


class Button
{
public:

	/**
	 * Constructor.
	 *
	 * @param pin the pin to monitor
	 */
	Button( int pin );

	/**
	 * Add a duration at which the specified event id should be triggered.
	 *
	 * @oaram duration the time at which the event should be triggered
	 * @param event_id a unique identifier for the event (not 0)
	 */
	void add_event_at( int duration, int event_id );

	/**
	 * Update internal state
	 */
	int update();

	/**
	 * Retrieve the event id of the event that was triggered at the last
	 * update, if there was one.
	 *
	 * @return event id, or 0
	 */
	int get_triggered_event();

protected:

	/** pin */
	int _pin;

	/** current state */
	bool _state;

	/** time when current state began */
	unsigned long _state_millis;

	/** milliseconds that have been accountred for (in terms of
	 * triggering events) since current state began */
	unsigned long _state_duration;

	/** triggered event */
	int _event_id;

	/** press events durations -> event ids */
	std::map< int, int > _press_events;

};


#endif //_BUTTON_H_