Keypad Library

mikroBasic PRO for dsPIC30/33 and PIC24 provides a library for working with 4x4 keypad. The library routines can also be used with 4x1, 4x2, or 4x3 keypad. For connections explanation see schematic at the bottom of this page.

External dependencies of Keypad Library

The following variable must be defined in all projects using Keypad Library:	Description :	Example :
`dim keypadPort as word sfr external`	Keypad Port.	`dim keypadPort as word at PORTB`
`dim keypadPort_Direction as word sfr external`	Keypad Port.	`dim keypadPort_Direction as word at TRISB`

Keypad_Init

Prototype	sub procedure Keypad_Init()
Description	Initializes given port for working with keypad.
Parameters	None.
Returns	Nothing.
Requires	Global variable : `keypadPort` - Keypad port must be defined before using this function.
Example	' Keypad module connections dim keypadPort as word at PORTB dim keypadPort_Direction as word at TRISB ' End Keypad module connections ... Keypad_Init()
Notes	The Keypad library uses lower byte (bits <7..0>) of `keypadPort`.

Keypad_Key_Press

Prototype	sub function Keypad_Key_Press() as word
Description	Reads the key from keypad when key gets pressed.
Parameters	None.
Returns	The code of a pressed key (1..16). If no key is pressed, returns 0.
Requires	Port needs to be initialized for working with the Keypad library, see Keypad_Init.
Example	dim kp as word ... kp = Keypad_Key_Press()
Notes	None.

Keypad_Key_Click

Prototype	sub function Keypad_Key_Click() as word
Description	Call to `Keypad_Key_Click` is a blocking call: the function waits until some key is pressed and released. When released, the function returns 1 to 16, depending on the key. If more than one key is pressed simultaneously the function will wait until all pressed keys are released. After that the function will return the code of the first pressed key.
Parameters	None.
Returns	The code of a clicked key (1..16). If no key is clicked, returns 0.
Requires	Port needs to be initialized for working with the Keypad library, see Keypad_Init.
Example	kp = Keypad_Key_Click()
Notes	None.

Library Example

The following code can be used for testing the keypad. It is written for keypad_4x3 or _4x4. The code returned by the keypad functions (1..16) is transformed into ASCII codes [0..9,A..F], and then sent via UART1.

Copy Code To Clipboard

program Keypad_Test
dim kp, oldstate as byte
    txt as char[6]

' Keypad module connections
dim keypadPort as word at PORTB
dim keypadPort_Direction as word at TRISB
' End Keypad module connections

main:
  ADPCFG = 0xFFFF
  oldstate = 0
  UART1_Init(9600)
  Delay_ms(100)
  Keypad_Init()                           ' Initialize Keypad
  
  UART1_Write_Text("Press any key on your kaypad...")
  UART1_Write(10)
  UART1_Write(13)

  while TRUE
    kp = 0                             ' Reset key code variable

    ' Wait for key to be pressed and released
    while ( kp = 0 )
      kp = Keypad_Key_Click()          ' Store key code in kp variable
    wend
    ' Prepare value for output, transform key to it's ASCII value
    select case kp
'    case 10
'      kp = 42  ' "*"       ' Uncomment this block for keypad4x3
'    case 11
'      kp = 48  ' "0"
'    case 12
'      kp = 35  ' "#"
'    case else
'      kp = kp + 48

    case 1
      kp = 49  ' 1                    ' Uncomment this block for keypad4x4
    case 2
      kp = 50  ' 2
    case 3
      kp = 51  ' 3
    case 4
      kp = 65  ' A
    case 5
      kp = 52  ' 4
    case 6
      kp = 53  ' 5
    case 7
      kp = 54  ' 6
    case 8
      kp = 66  ' B
    case 9
      kp = 55  ' 7
    case 10
      kp = 56  ' 8
    case 11
      kp = 57  ' 9
    case 12
      kp = 67  ' C
    case 13
      kp = 42  ' *
    case 14
      kp = 48  ' 0
    case 15
      kp = 35  ' #
    case 16
      kp = 68  ' D

    end select
    
    UART1_Write_Text("Key pressed: ")
    UART1_Write(kp)                       ' Send value of pressed button to UART
    UART1_Write(10)
    UART1_Write(13)
  wend
end.

HW Connection

4x4 Keypad connection scheme

Want more examples and libraries?
Find them on