Rune Langoy / KeypadLib

4x4 Keypad easy to use library that pollis the interface width pullups

Dependents:   4x4KeyBoardExample xoxokey 4x4KeyBoardExample ProgettoCassaforte ... more

Fork of keypad by Dimiter K

Simple library for reading a 4x4 keypad width at ability to use internal pullups

Import program
4x4KeyBoardExample - main.cpp

00001 #include "mbed.h"
00002 #include "keypad.h"
00003  
00004 Serial pc(USBTX, USBRX); 
00005 
00006  
00007 int main() {
00008                 //  c0   c1   c2   c3  r0   r1   r2   r3    
00009     Keypad keypad( PC_3,PC_2,PA_0,PA_1,PA_4,PB_0,PC_1,PC_0 );
00010        
00011     keypad.enablePullUp();
00012     char key;
00013     pc.printf("Please touch a key on the keypad\n\r");
00014     while (1) 
00015     {
00016          key = keypad.getKey();    
00017          if(key != KEY_RELEASED)
00018          {
00019              pc.printf("%c\r\n",key);
00020              wait(0.6);
00021          }
00022     }
00023 }

Import library
KeypadLib - Keypad Class Reference

Public Member Functions

Keypad (PinName col0, PinName col1, PinName col2, PinName col3, PinName row0, PinName row1, PinName row2, PinName row3)
Create a 4x4 (col, row) or 4x4 keypad interface
.
char getKey ()
Returns the letter of the pressed key
.
bool getKeyPressed ()
Detects if any key was pressed.
void enablePullUp ()
Enables internal PullUp resistors on the coloums pins.

Protected Member Functions

int getKeyIndex ()
return the index value representating the pressed key

Diff: keypad.h

Revision:
16:ea3c612999ac
Parent:
15:78f9c379a2e1
Child:
17:f9b292067464
--- a/keypad.h	Sat Sep 19 18:35:49 2015 +0000
+++ b/keypad.h	Sat Sep 19 18:45:01 2015 +0000
@@ -33,6 +33,8 @@
 const char NO_KEY = '\0';
 #define KEY_RELEASED NO_KEY
 
+/** @brief table showing the printed layout of the keypad \n
+ */
 const char keys[16] = {'1','2','3','A',
                        '4','5','6','B',
                        '7','8','9','C',
@@ -96,10 +98,10 @@
     Keypad(PinName col0, PinName col1, PinName col2, PinName col3, PinName row0,PinName row1, PinName row2, PinName row3);
 
     /** @brief  Returns the letter of the pressed key \n
-     *      if no walid key was pressed\n
-     *      the value -1 is returned\n
      *
-     *  @return char - The pressed character or -1 if no char was pressed
+     *  @return char
+     *  @retval -1 Error: no keys was pressed
+     *  @retval The pressed character
      */
     char getKey();
 
@@ -124,7 +126,8 @@
     *      if no walid key was pressed \n
     *      the value -1 is returned
     *
-    *  @return int - The index
+    *  @return int
+    *  @retval The index representing the pushed key used in table keys
     */
     int getKeyIndex();