2021-01-29 06:31:58 -05:00
|
|
|
|
|
|
|
|
[](https://github.com/marketplace/actions/arduino_ci)
|
2021-12-12 09:08:09 -05:00
|
|
|
[](https://github.com/RobTillaart/AnalogKeypad/actions/workflows/arduino-lint.yml)
|
|
|
|
|
[](https://github.com/RobTillaart/AnalogKeypad/actions/workflows/jsoncheck.yml)
|
2021-01-29 06:31:58 -05:00
|
|
|
[](https://github.com/RobTillaart/AnalogKeypad/blob/master/LICENSE)
|
|
|
|
|
[](https://github.com/RobTillaart/AnalogKeypad/releases)
|
|
|
|
|
|
2021-10-17 11:47:04 -04:00
|
|
|
|
2020-11-27 05:10:47 -05:00
|
|
|
# AnalogKeypad
|
|
|
|
|
|
2021-12-12 09:08:09 -05:00
|
|
|
Library for (Robotdyn) 4x4 and 4x3 analog keypad.
|
2020-11-27 05:10:47 -05:00
|
|
|
|
2021-10-17 11:47:04 -04:00
|
|
|
|
2020-11-27 05:10:47 -05:00
|
|
|
## Description
|
2021-01-29 06:31:58 -05:00
|
|
|
|
2021-12-12 09:08:09 -05:00
|
|
|
AnalogKeypad is a simple library to read the keys from a (Robotdyn) 4x4 or 4x3 keypad.
|
2020-11-27 05:10:47 -05:00
|
|
|
No other keypads are tested, but they should work with this library after adjusting
|
|
|
|
|
the **MAGIC NUMBERS** in the function **rawRead()**.
|
|
|
|
|
|
2021-10-17 11:47:04 -04:00
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
## Interface
|
|
|
|
|
|
2021-10-17 11:47:04 -04:00
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
### Constructor
|
|
|
|
|
|
2021-12-12 09:08:09 -05:00
|
|
|
- **AnalogKeypad(const uint8_t pin, const uint8_t bits = 10)** constructor, pin is typical A0 etc.
|
2021-10-17 11:47:04 -04:00
|
|
|
Bits has a default of 10, but need to be set to match the platform.
|
2021-12-12 09:08:09 -05:00
|
|
|
If bits < 8 then the internal shift would be large causing all reads to return 0 or so.
|
2021-10-17 11:47:04 -04:00
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
|
|
|
|
|
### polling interface
|
|
|
|
|
|
2021-12-12 09:08:09 -05:00
|
|
|
- **uint8_t pressed()** returns 0 if no key pressed, otherwise returns key pressed (may fluctuate).
|
|
|
|
|
- **uint8_t read()** read the key pressed returns 0 .. 16 where 0 means NOKEY.
|
2021-10-17 11:47:04 -04:00
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
|
|
|
|
|
### event interface
|
|
|
|
|
|
2021-10-17 11:47:04 -04:00
|
|
|
- **uint8_t event()** checks if a change has occurred since last time.
|
2021-12-12 09:08:09 -05:00
|
|
|
- **uint8_t key()** returns the key involved with last event.
|
2021-01-29 06:31:58 -05:00
|
|
|
|
|
|
|
|
Switch(int e = event())
|
|
|
|
|
|
2021-10-17 11:47:04 -04:00
|
|
|
| Event | value |
|
|
|
|
|
|:--------:|:-----:|
|
|
|
|
|
| PRESSED | 0x80 |
|
|
|
|
|
| RELEASED | 0x40 |
|
|
|
|
|
| REPEATED | 0x20 |
|
|
|
|
|
| CHANGED | 0x10 |
|
|
|
|
|
| NOKEY | 0x00 |
|
2021-01-29 06:31:58 -05:00
|
|
|
|
|
|
|
|
|
2020-11-27 05:10:47 -05:00
|
|
|
## Operation
|
2021-01-29 06:31:58 -05:00
|
|
|
|
2020-11-27 05:10:47 -05:00
|
|
|
The simplest usage is to use the **read()** function.
|
|
|
|
|
This will return a 0 (NOKEY) when no key is pressed and
|
|
|
|
|
a number 1 to 16 for the keys pressed. Note the return value may
|
|
|
|
|
fluctuate randomly when multiple keys are pressed.
|
|
|
|
|
|
|
|
|
|
The **pressed()** function is a bit more robust.
|
|
|
|
|
It returns the key pressed first, so multiple key presses simultaniously
|
2021-12-12 09:08:09 -05:00
|
|
|
are less likely to disturb your program.
|
2020-11-27 05:10:47 -05:00
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
See Examples
|
2020-11-27 05:10:47 -05:00
|
|
|
|
2021-12-12 09:08:09 -05:00
|
|
|
|
2021-10-17 11:47:04 -04:00
|
|
|
## Future
|
|
|
|
|
|
|
|
|
|
- more examples
|
|
|
|
|
- self-learning example?
|
2021-12-12 09:08:09 -05:00
|
|
|
- make internal mapping array runtime adaptable?
|
|
|
|
|
- store in RAM, accessor functions
|
|
|
|
|
-
|
2021-10-17 11:47:04 -04:00
|
|
|
|
