diff options
| author | Christopher Baines <cbaines8@gmail.com> | 2011-08-31 19:45:00 +0100 |
|---|---|---|
| committer | Christopher Baines <cbaines8@gmail.com> | 2011-08-31 19:45:00 +0100 |
| commit | 96654ea19b12be4b43230f3ff9f908eebcb416ca (patch) | |
| tree | d6c6100302db17c73e4d75673d637796cee9ffd6 /Arduino/Libraies/Keypad/Keypad.h | |
| parent | 4667303e15c534d390abee467eeaaee850e2d6f5 (diff) | |
| download | punchingbag-96654ea19b12be4b43230f3ff9f908eebcb416ca.tar punchingbag-96654ea19b12be4b43230f3ff9f908eebcb416ca.tar.gz | |
Initial commit for the modified libaries used and the ButtonMatrix arduino code. I have just cleaned this up, but not tested it.
Diffstat (limited to 'Arduino/Libraies/Keypad/Keypad.h')
| -rwxr-xr-x | Arduino/Libraies/Keypad/Keypad.h | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/Arduino/Libraies/Keypad/Keypad.h b/Arduino/Libraies/Keypad/Keypad.h new file mode 100755 index 0000000..bab6132 --- /dev/null +++ b/Arduino/Libraies/Keypad/Keypad.h @@ -0,0 +1,108 @@ +/*
+||
+|| @file Keypad.h
+|| @version 1.8
+|| @author Mark Stanley, Alexander Brevig
+|| @contact mstanley@technologist.com, alexanderbrevig@gmail.com
+||
+|| @description
+|| | This library provides a simple interface for using matrix
+|| | keypads. It supports the use of multiple keypads with the
+|| | same or different sets of keys. It also supports user
+|| | selectable pins and definable keymaps.
+|| #
+||
+|| @license
+|| | This library 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; version
+|| | 2.1 of the License.
+|| |
+|| | This library 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 library; if not, write to the Free Software
+|| | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+|| #
+||
+*/
+
+#ifndef KEYPAD_H
+#define KEYPAD_H
+
+#include <WProgram.h>
+
+#define makeKeymap(x) ((char*)x)
+
+typedef char KeypadEvent;
+
+typedef enum {
+ IDLE=0,
+ PRESSED,
+ RELEASED,
+ HOLD
+} KeypadState;
+
+// : 8 refers to the variable occupying 8 bits of memory
+typedef struct {
+ byte rows : 8;
+ byte columns : 8;
+} KeypadSize;
+
+const char NO_KEY = '\0';
+#define KEY_RELEASED NO_KEY
+
+class Keypad {
+public:
+ /*
+ Keypad();
+ Keypad(byte row[], byte col[], byte rows, byte cols);
+ */
+ Keypad(char *userKeymap, byte *row, byte *col, byte rows, byte cols);
+
+ //void begin(); //DEPRECATED!
+ void begin(char *userKeymap);
+ char getKey();
+ KeypadState getState();
+ void setDebounceTime(unsigned int debounce);
+ void setHoldTime(unsigned int hold);
+ void addEventListener(void (*listener)(char));
+
+private:
+ void transitionTo(KeypadState newState);
+ void initializePins();
+
+ char *keymap;
+ byte *rowPins;
+ byte *columnPins;
+ KeypadSize size;
+ KeypadState state;
+ char currentKey;
+ unsigned long lastUpdate;
+ unsigned int debounceTime;
+ unsigned int holdTime;
+ void (*keypadEventListener)(char);
+};
+
+#endif
+
+/*
+|| @changelog
+|| | 1.8 2009-07-08 - Alexander Brevig : No longer uses arrays
+|| | 1.7 2009-06-18 - Alexander Brevig : This library is a Finite State Machine
+|| | every time a state changes the keypadEventListener will trigger, if set
+|| | 1.7 2009-06-18 - Alexander Brevig : Added setDebounceTime
+|| | setHoldTime specifies the amount of microseconds before a HOLD state triggers
+|| | 1.7 2009-06-18 - Alexander Brevig : Added transitionTo
+|| | 1.6 2009-06-15 - Alexander Brevig : Added getState() and state variable
+|| | 1.5 2009-05-19 - Alexander Brevig : Added setHoldTime()
+|| | 1.4 2009-05-15 - Alexander Brevig : Added addEventListener
+|| | 1.3 2009-05-12 - Alexander Brevig : Added lastUdate, in order to do simple debouncing
+|| | 1.2 2009-05-09 - Alexander Brevig : Changed getKey()
+|| | 1.1 2009-04-28 - Alexander Brevig : Modified API, and made variables private
+|| | 1.0 2007-XX-XX - Mark Stanley : Initial Release
+|| #
+*/
|