Matrix Keypad routine

**mister_e** · - 7th February 2006, 03:18

Here's a simple INCLUDE file wich allow to scan any matrix KeyPad format on any PORT you decide. Yeah i know, a bit code hungry but simple to use and it's free...

The defaults setings are

Keypad ROW are connected to PORTB<3:0>
Keypad COL are connected to PORTB<7:4>
Debounce delay = 200 mSec
No auto-repeat
Keypad type 4X4

Code example using the default setting

Code:

    INCLUDE "KeyPad.bas"         
    myvar                    var byte

start:
    @ READKEYPAD _myvar
    hserout ["Key=",dec myvar,13,10]
    goto start

NOT MUCH!
If you decide to change default settings, here's the DEFINEs list

Code:

        DEFINE KEYPAD_ROW        4        ' 4 ROW keypad       
        DEFINE KEYPAD_ROW_PORT   PORTB    ' ROW port = PORTB
        DEFINE KEYPAD_ROW_BIT    4        ' ROW0 = PORTB.4
        DEFINE KEYPAD_COL        4        ' 4 COL keypad
        DEFINE KEYPAD_COL_PORT   PORTB    ' COL port = PORTB
        DEFINE KEYPAD_COL_BIT    0        ' COL0 = PORTB.0
        DEFINE KEYPAD_DEBOUNCEMS 200      ' debounce delay = 200 mSec
        DEFINE KEYPAD_AUTOREPEAT 1        ' use auto-repeat feature

When using the auto-repeat feature, the delay is the debounce delay (DEBOUNCEMS)

Code example #2: Using a 8X4 keypad

Code:

    INCLUDE "KeyPad.bas"         

    '                      
    '    Hardware connection
    '    ===================
    DEFINE KEYPAD_ROW        8       ' 8 row 
    define KEYPAD_ROW_PORT   PORTB   '   on PORTB
    DEFINE KEYPAD_ROW_BIT    0       '      <7:0>
    DEFINE KEYPAD_COL        4       ' 4 col 
    DEFINE KEYPAD_COL_PORT   PORTA   '   on PORTA
    DEFINE KEYPAD_COL_BIT    0       '      <3:0>
    DEFINE KEYPAD_DEBOUNCEMS 200     ' debounce delay = 200 mSec
    define KEYPAD_AUTOREPEAT 1       ' use auto-repeat
    
    '
    '    Serial Communication definition
    '    ===============================
    DEFINE HSER_TXSTA 24h            ' enable transmit, BRGH=1
    DEFINE HSER_SPBRG 129            ' 9600 Bauds

    '   
    '    Variables definition 
    '    ===================
    myvar                    var byte

    '    ---------------------------------[Program Start]----------------------------------------------
start:
    @ READKEYPAD _myvar
    hserout ["Key=",dec myvar,13,10]
    goto start

It set the according TRIS register for you everytime you call the MACRO.. kinda bullet-proof

Everything is explain in the attach file... don't forget to rename it

**Squibcakes** · - 24th April 2006, 11:16

Hi Steve,

What value do you use for the Pull Up resistors?

What value do you use for the series resistors?

Cheers
J

**mister_e** · - 24th April 2006, 14:47

Could be almost everything but usually i use 10K as pull-up, serie resistor could be remove but usualy 100-300 ohm is perfect.

**Srigopal007** · - 8th June 2006, 22:23

Hi Steve,

With the code that you have posted, Will this be able to recognize if the user presses more than one button at a time, or is it limited to only one button pushed at a time. If the later is true, then how can I implement a 4x4 matrix so that it allows multiple button pressed at one time .

Srig

**mister_e** · - 9th June 2006, 01:16

Hi Srig!

Long time we didn't heard from you

I do remember you asked that question awhile back but, sorry, only one button at the time for that one.

But as pushing two button exacty at the same time is an impossible human thing, we can modify the actual one and add some feature to. It will have to check once a button is press, wait few ms, set a flag, then RESCAN the whole keyboard and see if things changed. Not impossible.

I'll check what i can do with it somewhere next week. I have some project for some user here (those who pay for

) and i promise to deliver by the end of this weekend... Mister_E rule#1 : always respect delay even if i must stop to sleep, avoid beer and ladies.

Sure i'll have an eye on it next week. See ya!

**Leonardo** · - 22nd June 2006, 01:54

Serious very good to publish an example with this code that is very interesting, when trying to compile the code "KeyPad.txt" it generates an error.

Greetings

Leonard

Originally Posted by mister_e

Here's a simple INCLUDE file wich allow to scan any matrix KeyPad format on any PORT you decide. Yeah i know, a bit code hungry but simple to use and it's free...

The defaults setings are

Keypad ROW are connected to PORTB<3:0>
Keypad COL are connected to PORTB<7:4>
Debounce delay = 200 mSec
No auto-repeat
Keypad type 4X4

Code example using the default setting

Code:

    INCLUDE "KeyPad.bas"         
    myvar                    var byte

start:
    @ READKEYPAD _myvar
    hserout ["Key=",dec myvar,13,10]
    goto start

NOT MUCH!
If you decide to change default settings, here's the DEFINEs list

Code:

        DEFINE KEYPAD_ROW        4        ' 4 ROW keypad       
        DEFINE KEYPAD_ROW_PORT   PORTB    ' ROW port = PORTB
        DEFINE KEYPAD_ROW_BIT    4        ' ROW0 = PORTB.4
        DEFINE KEYPAD_COL        4        ' 4 COL keypad
        DEFINE KEYPAD_COL_PORT   PORTB    ' COL port = PORTB
        DEFINE KEYPAD_COL_BIT    0        ' COL0 = PORTB.0
        DEFINE KEYPAD_DEBOUNCEMS 200      ' debounce delay = 200 mSec
        DEFINE KEYPAD_AUTOREPEAT 1        ' use auto-repeat feature

When using the auto-repeat feature, the delay is the debounce delay (DEBOUNCEMS)

Code example #2: Using a 8X4 keypad

Code:

    INCLUDE "KeyPad.bas"         

    '                      
    '    Hardware connection
    '    ===================
    DEFINE KEYPAD_ROW        8       ' 8 row 
    define KEYPAD_ROW_PORT   PORTB   '   on PORTB
    DEFINE KEYPAD_ROW_BIT    0       '      <7:0>
    DEFINE KEYPAD_COL        4       ' 4 col 
    DEFINE KEYPAD_COL_PORT   PORTA   '   on PORTA
    DEFINE KEYPAD_COL_BIT    0       '      <3:0>
    DEFINE KEYPAD_DEBOUNCEMS 200     ' debounce delay = 200 mSec
    define KEYPAD_AUTOREPEAT 1       ' use auto-repeat
    
    '
    '    Serial Communication definition
    '    ===============================
    DEFINE HSER_TXSTA 24h            ' enable transmit, BRGH=1
    DEFINE HSER_SPBRG 129            ' 9600 Bauds

    '   
    '    Variables definition 
    '    ===================
    myvar                    var byte

    '    ---------------------------------[Program Start]----------------------------------------------
start:
    @ READKEYPAD _myvar
    hserout ["Key=",dec myvar,13,10]
    goto start

It set the according TRIS register for you everytime you call the MACRO.. kinda bullet-proof

Everything is explain in the attach file... don't forget to rename it

**mister_e** · - 23rd June 2006, 23:15

yeah.. read the last lines of my post...

... don't forget to rename it

so the .txt have to be renamed .bas

once it's done, i can't imagine it's not working. If so, let me know here!

**Leonardo** · - 24th June 2006, 01:12

Hello,

It already renames it but it is not allowed to compile because it shows an error, try to compile you the code "KeyPad.txt to KeyPad.bas" and that doesn't work.

Thank you
-------------------------------------------------------------------

Originally Posted by mister_e

Here's a simple INCLUDE file wich allow to scan any matrix KeyPad format on any PORT you decide. Yeah i know, a bit code hungry but simple to use and it's free...

The defaults setings are

Keypad ROW are connected to PORTB<3:0>
Keypad COL are connected to PORTB<7:4>
Debounce delay = 200 mSec
No auto-repeat
Keypad type 4X4

Code example using the default setting

Code:

    INCLUDE "KeyPad.bas"         
    myvar                    var byte

start:
    @ READKEYPAD _myvar
    hserout ["Key=",dec myvar,13,10]
    goto start

NOT MUCH!
If you decide to change default settings, here's the DEFINEs list

Code:

        DEFINE KEYPAD_ROW        4        ' 4 ROW keypad       
        DEFINE KEYPAD_ROW_PORT   PORTB    ' ROW port = PORTB
        DEFINE KEYPAD_ROW_BIT    4        ' ROW0 = PORTB.4
        DEFINE KEYPAD_COL        4        ' 4 COL keypad
        DEFINE KEYPAD_COL_PORT   PORTB    ' COL port = PORTB
        DEFINE KEYPAD_COL_BIT    0        ' COL0 = PORTB.0
        DEFINE KEYPAD_DEBOUNCEMS 200      ' debounce delay = 200 mSec
        DEFINE KEYPAD_AUTOREPEAT 1        ' use auto-repeat feature

When using the auto-repeat feature, the delay is the debounce delay (DEBOUNCEMS)

Code example #2: Using a 8X4 keypad

Code:

    INCLUDE "KeyPad.bas"         

    '                      
    '    Hardware connection
    '    ===================
    DEFINE KEYPAD_ROW        8       ' 8 row 
    define KEYPAD_ROW_PORT   PORTB   '   on PORTB
    DEFINE KEYPAD_ROW_BIT    0       '      <7:0>
    DEFINE KEYPAD_COL        4       ' 4 col 
    DEFINE KEYPAD_COL_PORT   PORTA   '   on PORTA
    DEFINE KEYPAD_COL_BIT    0       '      <3:0>
    DEFINE KEYPAD_DEBOUNCEMS 200     ' debounce delay = 200 mSec
    define KEYPAD_AUTOREPEAT 1       ' use auto-repeat
    
    '
    '    Serial Communication definition
    '    ===============================
    DEFINE HSER_TXSTA 24h            ' enable transmit, BRGH=1
    DEFINE HSER_SPBRG 129            ' 9600 Bauds

    '   
    '    Variables definition 
    '    ===================
    myvar                    var byte

    '    ---------------------------------[Program Start]----------------------------------------------
start:
    @ READKEYPAD _myvar
    hserout ["Key=",dec myvar,13,10]
    goto start

It set the according TRIS register for you everytime you call the MACRO.. kinda bullet-proof

Everything is explain in the attach file... don't forget to rename it

**mister_e** · - 24th June 2006, 08:48

what are/is the error(s) message you get?

**Leonardo** · - 25th June 2006, 01:23

Hello Mister E,

I attach him the image of the error that generates when trying to compile, I have attempted it with several pics but with none it is allowed to compile.

Greetings

Leonard

Originally Posted by mister_e

what are/is the error(s) message you get?

**Acetronics2** · - 25th June 2006, 09:54

Hi, Leonardo

Just copiying and pasting Steve's code gives ( lower left ) the following message :

SUCCESS - 366 WORDS USED

So, I think the problem is in your computer ...

Alain

**mister_e** · - 25th June 2006, 11:30

probable cause.. there's 2 KeyPad.bas files opened in your editor as per your picture. It must be a MCS error... this 'feature' is not available in the MCSP version as i can't do it here... sorry.

**Leonardo** · - 26th June 2006, 13:52

Hello Acetronis,

It can place an image of the code when it compiles it, the truth not you that to make since has the it finishes version of the PBP.

Greetings

Originally Posted by Acetronics

Hi, Leonardo

Just copiying and pasting Steve's code gives ( lower left ) the following message :

SUCCESS - 366 WORDS USED

So, I think the problem is in your computer ...

Alain

np123 · - 14th September 2006, 00:08

I am new to PIC programming,, have been fiddling with BLINK.Bas
and managed to make the LCD show a message "LED Blinking"
just before the LED blinks.

I am using the MCS PICBasic Pro for the sake of compiling and am using the
DIY K149 Pic Micro Programmer to program my PIC16F877A.

Now I was wondering how would I be able to use the Keypad as an input
and display things on the LCD.

I am sure my question is very newbie, but if someone could explain me
how I could manage my inputs and storing into registers and then output
it to whatever port pin etc., then it would be of great help.

Thank you!

**precision** · - 14th September 2006, 03:43

Hello Mister E
Great works for newbie, Thanks again.

I config. keypad on portd of 877a, becoz portb is allready config on my dev. board V3(metrixmultimedia) for LCD rutine.

its working fine for me.

INCLUDE "KeyPad.bas"
INCLUDE "MYLCD.BAS"
myvar var byte

start:
@ READKEYPAD _myvar
lcdout $fe,1
lcdout " Key Value = ",DEC2 myvar
goto start

Thanks

**mpardinho** · - 18th October 2006, 21:10

the file keypad.txt not download ... error in forum server

need the file to text my keypad code

can i help me?

**mister_e** · - 19th October 2006, 00:07

seems to be a server problem since this morning (october 18/2006)

drop me your e-mail address on my PM.

**mpardinho** · - 19th October 2006, 15:20

keypad complied 100%,
but in terminal i receive many keys without press any key

my test:

Code:

Include "modedefs.bas"
INCLUDE "KeyPad.bas"  

DEFINE KEYPAD_ROW        4        ' 4 ROW keypad       
DEFINE KEYPAD_ROW_PORT   PORTB    ' ROW port = PORTB
DEFINE KEYPAD_ROW_BIT    4        ' ROW0 = PORTB.4
DEFINE KEYPAD_COL        3        ' 3 COL keypad
DEFINE KEYPAD_COL_PORT   PORTB    ' COL port = PORTB
DEFINE KEYPAD_COL_BIT    1        ' COL0 = PORTB.1
DEFINE KEYPAD_DEBOUNCEMS 200      ' debounce delay = 200 mSec
DEFINE KEYPAD_AUTOREPEAT 0        ' use auto-repeat feature 

Serial_Saida       Var     PORTC.2           'Pic 13  - >  Max232   10       
myvar                    var byte

Inicio:
    @ READKEYPAD _myvar
    Serout Serial_Saida, T2400, [#myvar, 13, 10] 
goto Inicio

Terrminal:

Code:

Received: 15
Received: 15
Received: 1
Received: 3
Received: 15
Received: 15
Received: 3
Received: 2
Received: 3
...... withou press any key

**RFsolution** · - 14th October 2007, 09:41

Hi Steve,

Some time ago you modified your code for pbp243 (if you remember)
Meanwhile I have updated to 2.50

After playing with your code I have a strange behavior
If I want to serout something in the main loop it is not working
any idea how to fix this

INCLUDE "KeyPad.bas"
myvar var byte

start:
Hserout ["test",10,13] 'does not do anything
@ READKEYPAD _myvar
hserout ["Key=",dec myvar,13,10]
if myvar =1 then
Hserout ["test2",10,13] 'does work if button 1 pressed
endif
goto start

Originally Posted by mister_e

Here's a simple INCLUDE file wich allow to scan any matrix KeyPad format on any PORT you decide. Yeah i know, a bit code hungry but simple to use and it's free...

The defaults setings are

Keypad ROW are connected to PORTB<3:0>
Keypad COL are connected to PORTB<7:4>
Debounce delay = 200 mSec
No auto-repeat
Keypad type 4X4

Code example using the default setting

Code:

    INCLUDE "KeyPad.bas"         
    myvar                    var byte

start:
    @ READKEYPAD _myvar
    hserout ["Key=",dec myvar,13,10]
    goto start

NOT MUCH!
If you decide to change default settings, here's the DEFINEs list

Code:

        DEFINE KEYPAD_ROW        4        ' 4 ROW keypad       
        DEFINE KEYPAD_ROW_PORT   PORTB    ' ROW port = PORTB
        DEFINE KEYPAD_ROW_BIT    4        ' ROW0 = PORTB.4
        DEFINE KEYPAD_COL        4        ' 4 COL keypad
        DEFINE KEYPAD_COL_PORT   PORTB    ' COL port = PORTB
        DEFINE KEYPAD_COL_BIT    0        ' COL0 = PORTB.0
        DEFINE KEYPAD_DEBOUNCEMS 200      ' debounce delay = 200 mSec
        DEFINE KEYPAD_AUTOREPEAT 1        ' use auto-repeat feature

When using the auto-repeat feature, the delay is the debounce delay (DEBOUNCEMS)

Code example #2: Using a 8X4 keypad

Code:

    INCLUDE "KeyPad.bas"         

    '                      
    '    Hardware connection
    '    ===================
    DEFINE KEYPAD_ROW        8       ' 8 row 
    define KEYPAD_ROW_PORT   PORTB   '   on PORTB
    DEFINE KEYPAD_ROW_BIT    0       '      <7:0>
    DEFINE KEYPAD_COL        4       ' 4 col 
    DEFINE KEYPAD_COL_PORT   PORTA   '   on PORTA
    DEFINE KEYPAD_COL_BIT    0       '      <3:0>
    DEFINE KEYPAD_DEBOUNCEMS 200     ' debounce delay = 200 mSec
    define KEYPAD_AUTOREPEAT 1       ' use auto-repeat
    
    '
    '    Serial Communication definition
    '    ===============================
    DEFINE HSER_TXSTA 24h            ' enable transmit, BRGH=1
    DEFINE HSER_SPBRG 129            ' 9600 Bauds

    '   
    '    Variables definition 
    '    ===================
    myvar                    var byte

    '    ---------------------------------[Program Start]----------------------------------------------
start:
    @ READKEYPAD _myvar
    hserout ["Key=",dec myvar,13,10]
    goto start

It set the according TRIS register for you everytime you call the MACRO.. kinda bullet-proof

Everything is explain in the attach file... don't forget to rename it

da_cure_4_u · - 31st March 2009, 18:13

I would like to scan a 4x4 keypad to use as a calculator on PIC16F88.

anyone can help please???

**mister_e** · - 1st April 2009, 04:49

Try something by yourself first.

Download the Keypad Include file,
Find LCDOUT in your manual,
Use the example I gave in POST #1 and you're almost half done if you replace HSEROUT with LCDOUT.

**Dennis** · - 18th November 2009, 22:18

Hi all

Please would somebody be so kind as to shed some light on the problem I am experiencing.

I am busy re-kindling my hobby and interest in PIC programming, I think these forums are an excellent resource, somehow all roads lead back here after many a google search and reading post after post and numerous articles.
After 3 weeks of late nights and sore eyes and a lot of reading later I have finally gotten to a stage where I have a functional (perhaps a very under-utilized PIC 18F4530).
After having blinked LED's and read switches and getting my LCD working I would like to implement a keypad as opposed to a bank of dip switches.

I am trying to implement the keypad.bas file submitted by mister_e (Thanks mister e ... your code looks fantastic, I'm dying to use it properly :-)

So here's where I'm at now....

I am trying to connect a 4 x 4 matrix keypad to my 18F4520 PIC.

Ultimately I would like to be able to be able to type in a number, end it with a # to signify completed input and then transmit the inputted number to another pic either wired or wireless.

The keypad layout is as follows.
my keypad matrix

1 2 3 A
4 5 6 B
7 8 9 C
* 0 # D

I have connected the keypad to the pic as follows.

Keypad PIC

Column 0 PortA.0
Column 0 PortA.1
Column 0 PortA.2
Column 0 PortA.
Row 0 PortC.0
Row 1 PortC.1
Row 2 PortC.2
Row 3 PortC.3

10K pullups set on column inputs
100 Ohm resistors in series with rows

When I have the above configured my LCD just produces blocks

If I remove either the pullups and/or the series resistors I just get "Key Value" 20 continuously appearing on the LCD and if I press a key on the keypad I get the "key Value" changing on the LCD but it is not the correct value according to my keypad.

I could also use the whole of Port A but when I tried it but had the same results :-(

Initially I tried to connect on PortB and had the same results, so I assumed it was because I was getting inputs from pin 39 and pin 40 of the pic where the PICkit 2 is connected for ICSP.

I have attached my code below.

Please could someone advise as to where I am going wrong or what I could look at to fix the problem !

I think it could be a possible CONFIG problem or coding issue in my code.

Any help would be greatly appreciated.

Kind regards

Dennis

Code:

'*************************************
'LCD code for 16 X 2  HD4x lcd
'*************************************

'Ocsillator selections here
OSCCON = $70            'Int CLK 8MHz
OSCTUNE.6 = 1           'PLL 4x
ADCON1= %00001111       '$0F = disable A/D converter
'END of oscillator selections


'Port IO directions and presets for port pins begin here
'TRISA = %11111111       'All pins are outputs
TRISA.0 = 1
TRISA.1 = 1
TRISA.2 = 1
TRISA.3 = 1
TRISB = %00000000           
'TRISC = %00000000
TRISC.0 = 1           
TRISC.1 = 1
TRISC.2 = 1
TRISC.3 = 1

TRISD = %00000000
TRISE.0 = 0
TRISE.1 = 0
TRISE.2 = 0
'End of Port IO directions and presets for port pins begin here

'timer/oscillator defines 
DEFINE OSC 32            '4x 8MHz
'END of timer/oscillator defines
                      
'variables begin here
myvar var byte

'LCD defines begin here   
DEFINE LCD_BITS 4 	'defines the number of data interface lines (4 or 8) 
DEFINE LCD_DREG PORTD 	'defines the port where data lines are connected to
DEFINE LCD_DBIT 4 	'defines the position of data lines for 4-bit interface (0 or 4)
DEFINE LCD_RSREG PORTD 	'defines the port where RS line is connected to
DEFINE LCD_RSBIT 2 	'defines the pin where RS line is connected to 
DEFINE LCD_EREG PORTD 	'defines the port where E line is connected to 
DEFINE LCD_EBIT 3 	'defines the pin where E line is connected 
DEFINE LCD_RWREG 0 	'defines the port where R/W line is connected to (set to 0 if not used)
DEFINE LCD_RWBIT 0 	'defines the pin where R/W line is connected to (set to 0 if not used)
DEFINE LCD_COMMANDUS 2000 	'defines the delay after LCDOUT statement 
DEFINE LCD_DATAUS 200 		'delay in micro seconds
'END of LCD DEFINES

'KEYPAD 4x4 defines begin here
      DEFINE KEYPAD_ROW        4        ' 4 ROW keypad       
      DEFINE KEYPAD_ROW_PORT   PORTC    ' ROW port = PORTB
      DEFINE KEYPAD_ROW_BIT    0        ' ROW0 = PORTB.4
      DEFINE KEYPAD_COL        4        ' 4 COL keypad
      DEFINE KEYPAD_COL_PORT   PORTA    ' COL port = PORTB
      DEFINE KEYPAD_COL_BIT    0        ' COL0 = PORTB.0
      DEFINE KEYPAD_DEBOUNCEMS 200      ' debounce delay = 200 mSec
      DEFINE KEYPAD_AUTOREPEAT 1        ' use auto-repeat feature  
'End of KEYPAD defines

'*********************Includes******

include "C:\PBP\SAMPLES\KeyPad.bas"
'Includes end here

'Code begins here
   Pause 500       ' Wait for LCD to startup
 
start:
@ READKEYPAD _myvar
lcdout $fe, 1
lcdout " Key Value = ",DEC2 myvar
goto start

**Dennis** · - 21st November 2009, 13:50

My problem in the previous post here is now solved.
The keypad is working.

But I now am trying to solve 2 more problems

1. I need the keypresses to reflect the correct label
My matrix is
1 2 3 A
4 5 6 B
7 8 9 C
* 0 # D

At the moment I get the following 1,2,3,4 as opposed to 1,2,3,A

2. I would like to capture a number of keystrokes as I type them in for example 135 completing input with a #
So the number stored will be the number decimal 135

Any help or suggestions will be most appreciated.

Kind regards

Dennis
For example keypress1

**Ioannis** · - 23rd November 2009, 08:42

An idea would be to use the lookup command for your translation from numbers to numbers-ASCII conversion.

Now about the numbers to assebly in a byte. What is the range of your input?

0-255 or 0-999?

Ioannis

Thread: Matrix Keypad routine

Thread Tools

Search Thread

Display

Hybrid View

Matrix Keypad routine

Row / col resistor Values

Problem code

Problem code

Error code

Da vinci code ....once more ???

Code problem

Input via Matrix Keypad and Output onto LCD

Thanks

problem with serout and keypad routin Mister_E

Scan

4x4 keypad on an 184520 - newbie help

Solved !!

Similar Threads

calculator-like code entry with matrix keypad and display

Need help in matrix keypad coding

I2C PCF8574 4X4 Keypad routine

Inconsistent output on a 4x4 matrix keypad

very basic matrix keypad question

Members who have read this thread : 3

Bookmarks

Bookmarks

Posting Permissions