Matrix Keypad routine

[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

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

Code example using the default setting

    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

        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

    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]

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]

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]

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]

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]

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

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

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

Code example using the default setting

    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

        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

    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]

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]

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
-------------------------------------------------------------------

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

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

Code example using the default setting

    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

        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

    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]

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

[Leonardo]

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

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

[Acetronics2]

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]

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]

Hello,

That version of PBP is using?.

Leonard

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]

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

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

[Acetronics2]

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

Sorry, Leonardo

I do not understand anything in your sentence ... try to be a bit more explicit.

I opened Twice "keypad.bas" ... it compiles also ...

may also be Too many files opened ???

Alain

[mister_e]

i use PBP V2.46 but it should work with most previous one. MPASM version shouldn't be much of a problem.

<img src="http://www.picbasic.co.uk/forum/attachment.php?attachmentid=938&stc=1&d=1151334864 ">

Be sure the INCLUDE file is in the same directory of your project and it should compile as is. Unless add the path in the INCLUDE line.
<img src="http://www.picbasic.co.uk/forum/attachment.php?attachmentid=939&stc=1&d=1151335131 ">

[np123]

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]

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]

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

need the file to text my keypad code

can i help me?

[mister_e]

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

drop me your e-mail address on my PM.

[mpardinho]

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

my test:

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:

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

[mister_e]

seems you forgot to add external pull-ups....

i don't know wich pic you are using but try

OPTION_REG.7=0

[mpardinho]

i use 16f628a with pull-ups ..... for test

in circuit row and col have voltage around 0,5 to 3,5v (oscillating ... i don't know why)

than i press one button, 2 pins have 0,0v

[Ioannis]

Hi. While testing Steve's routine, I get many fatal errors. The attached Screen Capture gives the state. Steve if you can have a look...

Includes are OK about names and paths.

Ioannis

[mister_e]

Ioannis,
You have to compile with MPASM, not PM.

mpardinho,
You probably miswired something. with your exact program it works fine here. Also.. there's no PORTC on PIC16F628 but you should already know that.

i used this line for my config fuses

@   __CONFIG  _INTRC_OSC_NOCLKOUT & _MCLRE_OFF  &  _LVP_OFF & _WDT_OFF & _PWRTE_ON  & _BODEN_ON

Did you tried with OPTION_REG.7=0 without resistor?

wich value of pull-up?

[Ioannis]

Ioannis,
You have to compile with MPASM, not PM.

Ohh! dear....

Thanks,
Ioannis

[charudatt]

Hello Steve,

Any idea in getting your code to work (compile) with PM. ?

That would be a big help.

thank you for the shareing the code.

regards

[mister_e]

Nope, i have no idea and no plan to do it.

I NEVER use PM, it really don't worth to use it anyways... sorry

[Darrel Taylor]

I know of NO reason why anyone should still be using PM.

If you don't use ASM then it'll handle PBP just fine. But if you do use ASM, PM will cause nothing but problems. I never use it anymore either.

However, before I found out how much better MPASM is, I used PM for a year or 2, and am probably more familiar with it than Steve.

So here's Steve's Kepad.bas, modified to work with PM.exe

This version will NOT work with MPASM

Don't forget to remove the .txt extension.

HTH,

[T.Jackson]

Looks good Steve. Worth a vote *****

[mister_e]

i has the advantages to be 'user configurable' and support many matrix Keypad type... up to 8X8.

Can be used in a Timer interrupt as well, so you can read from it when you want, etc etc.

Enjoy!

[T.Jackson]

It looks quite comprehensive.

I tend to base most of my algorithms around direct logic - boolean algebraic structures - rather than continuous mathematics, i.e calculations. PIC's are not as well equipped for calculations.

[mister_e]

If that was true... ASM additions, substraction, bit shifting functions and few STATUS register bits wouldn't exist...(carry/Borrow, Z)

[charudatt]

I know of NO reason why anyone should still be using PM.

If you don't use ASM then it'll handle PBP just fine. But if you do use ASM, PM will cause nothing but problems. I never use it anymore either.

However, before I found out how much better MPASM is, I used PM for a year or 2, and am probably more familiar with it than Steve.

So here's Steve's Kepad.bas, modified to work with PM.exe

This version will NOT work with MPASM

Don't forget to remove the .txt extension.

HTH,

Thanks Darrel.

Unfortunately I still use PM and maybe I am facing all problems because of that. I shall shift over to MPASM and see the difference.

Today my biggest problem is to get a 16F628A to sleep and wake it on INT on Change B4...B7. This is in conjuction with a keypad rotuine I am working on for a keylock project.

I think I must change over and see (experience) the difference myself

Thank you steve for this wonderful thread.

regards

[T.Jackson]

If that was true... ASM additions, substraction, bit shifting functions and few STATUS register bits wouldn't exist...(carry/Borrow, Z)

So, you believe that a PIC performs on par with: A = (100 / I) + (J * 2) Vs IF B = 1 THEN A = 120 ?
Huge amount of work for the PIC to do something like this: A = (100 / I) + (J * 2)
100 x the num of clock cycles perhaps?

[mister_e]

Trent, If your example was right i could agree with some part of it... programming method and code optimization is an endless story... i'm not going to argument on which is better, which is worst... it's not what the actual thread is about anyway.

100X ??? NAH, i don't think so. Depending the Value of I, few times maybe... but not 100 for sure. and * 2, is just a Byte shifting, one position to the left... not much... 1-2 cycle not much.
-----------------------------

Charudatt,
before going in sleep mode, make sure those PINs are set to input (with pull-up) and the others are set LOW and OUTPUT (or input but with pull-down resistor). Once you'll press a key, RB<7:4> should see the LOW signal... which should wake your PIC, then you call the keypad scan.

[paul borgmeier]

I tend to base most of my algorithms around direct logic - boolean algebraic structures - rather than continuous mathematics, i.e calculations. PIC's are not as well equipped for calculations.

Huh? Lookups have their place (and I love them when needed) but to say PICs are not equipped for calculations is just plain silly.

For all your projects (that you have posted), was time of the issue or code space? (answer = the latter). With your example equation, which one takes less code space? Which one is faster for larger I? (answer = calculation based approach).

' Calculation based equation A = 100/I +J*2
If I > 100 then
A = J<<1
ELSE
A = 100
FOR X = 1 to 100
A = A – I
IF A < I then OUT
NEXT X
OUT:
A = X+ J<<1
ENDIF

or

' lookup based equation A = 100/I +J*2
IF I = 1 then A = 100+J<<1
If I = 2 then A = 50 +J<<1
If I = 3 then A = 33+J<<1
If I = 4 then A = 25+J<<1
...
' (a bunch more  if-thens)
...
if I =100 then A = 1+J<<1
If I > 100 then A = J<<1

[CluckShot]

I know the Pull up Resistor attaches to Vss but where does it go else wise? Also... What happens to other test programs etc by its presence?

Paul

[Ioannis]

To port B.

As for the programs, what programs? Depends on what are the programs doing... Usually the port B with PU enabled, reads as all 1s.

Ioannis

[T.Jackson]

Huh? Lookups have their place (and I love them when needed) but to say PICs are not equipped for calculations is just plain silly.

I didn't say not equipped - I said not as well equipped. And, I'm more so referring to something that's more so "hard coded" over calculations. When I say hard coded I'm talking about something that's direct as in (a = 100) Vs (a = b x 10 / 2) No prizes for guessing which is faster and uses less resource.