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:
8:862b0a362754
Parent:
7:51ed72b695a5
Child:
9:1f7793af2f64
--- a/keypad.h	Sat Sep 19 09:17:07 2015 +0000
+++ b/keypad.h	Sat Sep 19 16:28:14 2015 +0000
@@ -77,49 +77,50 @@
                      
 class Keypad{    
     public:
-    /** Create a 4x4 (col, row) or 4x4 keypad interface\n
-     *\n
-     *@table
+    /**  @brief Create a 4x4 (col, row) or 4x4 keypad interface\n
+     * \n
+     * @table
      *          | Col0 | Col1 | Col2 | Col3   \n
      *   -------+------+------+------+-----   \n
      *   Row 0  |   x  |   x  |   x  |  x     \n
      *   Row 1  |   x  |   x  |   x  |  x     \n
      *   Row 2  |   x  |   x  |   x  |  x     \n
      *   Row 3  |   x  |   x  |   x  |  x     \n
-     *@endtabl
+     * @endtable
      *
      *  @param col<0..3>     Row data lines
      *  @param row<0..3>     Column data lines
      */
         Keypad(PinName col0, PinName col1, PinName col2, PinName col3, PinName row0,PinName row1, PinName row2, PinName row3);
     
-       /** User-defined function that returns the letter of the pressed key
-        *      if no walid key was pressed
-        *      the value -1 is returned
+       /** @brief  Returns the letter of the pressed key \n
+        *      if no walid key was pressed\n
+        *      the value -1 is returned\n
         *          
-        *  returns char
+        *  @return char - The pressed character or -1 if no char was pressed
         */
         char getKey();
         
-        /** User-defined function that returns true if any key is pressed 
+        /** @brief Detects if any key was pressed   
         *          
-        *  returns bool
+        *   @return bool - true is returned if any key is pressed
         */
         bool getKeyPressed();
-        /** User-defined function enables PullUp resistors on the 
+        /**  Enables internal PullUp resistors on the coloums pins 
         *          
-        *  returns bool
+        *  @return void
         */
         void enablePullUp();
 
     protected:
         BusIn  _cols;    
         BusOut _rows;
-         /** User-defined function that return the index value 
-        *      representating the pressed key if no walid key was pressed
-        *      the value 0 is returned
+         /** @brief return the index value \n
+        *      representating the pressed key \n 
+        *      if no walid key was pressed \n
+        *      the value -1 is returned
         *          
-        *  returns int
+        *  @return int 
         */
         int getKeyIndex();