/elec/propeller-clock : contents of src/button.h at revision 86

: (revision 86)

To get this branch, use:

bzr branch
http://bzr.ed.am/elec/propeller-clock

/*
 * 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_


class Button
{
public:

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

	/**
	 * Set event times.
	 *
	 * @oaram pointer to ordered, zero-terminated array of event times
	 */
	void set_event_times( int *event_times );

	/**
	 * Set button press mode
	 *
	 * @param send_interim send interim presses during a long press?
	 */
	void set_press_mode( bool send_interim );

	/**
	 * Update internal state (call as regularly sa possible!)
	 */
	void update();

	/**
	 * Get the first pending event.
	 *
	 * @return event id, 0 if there isn't any
	 */
	int get_event();

protected:

	/** pin */
	int _pin;

	/** last state */
	bool _state_last;

	/** time when this state began */
	unsigned long _millis_state;

	/** amount of time that we've already triggered events for this press */
	unsigned long _millis_done;

	/** pointer to event times */
	int *_event_times;

	/** pending event */
	int _pending_event;

	/** an interim event buffer */
	int _interim_event;

	/** send interim events? */
	bool _send_interim;

	/** when not sending interim events, ignore the next unpress */
	bool _ignore_next_unpress;

};


#endif //_BUTTON_H_

58 by edam removed Bounce library and updated/fixed new code	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
	26
56 by edam updated software to include drawing abstraction infrastructure	27	class Button
	28	{
	29	public:
	30
	31	/**
	32	* Constructor.
	33	*
	34	* @param pin the pin to monitor
	35	*/
	36	Button( int pin );
	37
	38	/**
59 by edam removed ulibc, fixed button, added text rendering	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	/**
76 by edam switch button to no interim presses during settings mode; added NVRAM support	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	/**
59 by edam removed ulibc, fixed button, added text rendering	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();
56 by edam updated software to include drawing abstraction infrastructure	63
	64	protected:
	65
	66	/** pin */
	67	int _pin;
	68
85 by Tim Marston rewrote/fixed button event triggering code	69	/** last state */
	70	bool _state_last;
	71
	72	/** time when this state began */
	73	unsigned long _millis_state;
	74
	75	/** amount of time that we've already triggered events for this press */
	76	unsigned long _millis_done;
56 by edam updated software to include drawing abstraction infrastructure	77
59 by edam removed ulibc, fixed button, added text rendering	78	/** pointer to event times */
	79	int *_event_times;
56 by edam updated software to include drawing abstraction infrastructure	80
59 by edam removed ulibc, fixed button, added text rendering	81	/** pending event */
	82	int _pending_event;
56 by edam updated software to include drawing abstraction infrastructure	83
85 by Tim Marston rewrote/fixed button event triggering code	84	/** an interim event buffer */
	85	int _interim_event;
	86
	87	/** send interim events? */
76 by edam switch button to no interim presses during settings mode; added NVRAM support	88	bool _send_interim;
	89
85 by Tim Marston rewrote/fixed button event triggering code	90	/** when not sending interim events, ignore the next unpress */
76 by edam switch button to no interim presses during settings mode; added NVRAM support	91	bool _ignore_next_unpress;
	92
56 by edam updated software to include drawing abstraction infrastructure	93	};
58 by edam removed Bounce library and updated/fixed new code	94
	95
	96	#endif //_BUTTON_H_