CircuitPython library for passive matrix keypads.
This simple helper library lets you create objects that will scan and detect keypresses on passive matrix keypads
This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.
import adafruit_matrixkeypad from digitalio import DigitalInOut import board # Classic 3x4 matrix keypad cols = [DigitalInOut(x) for x in (board.D2, board.D0, board.D4)] rows = [DigitalInOut(x) for x in (board.D1, board.D6, board.D5, board.D3)] keys = ((1, 2, 3), (4, 5, 6), (7, 8, 9), ('*', 0, '#')) keypad = adafruit_matrixkeypad.Matrix_Keypad(rows, cols, keys) while True: keys = keypad.pressed_keys if keys: print("Pressed: ", keys) time.sleep(0.1)
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Zip release files
To build this library locally you’ll need to install the circuitpython-build-tools package.
python3 -m venv .env source .env/bin/activate pip install circuitpython-build-tools
Once installed, make sure you are in the virtual environment:
Then run the build:
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-matrixkeypad --library_location .
Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):
python3 -m venv .env source .env/bin/activate pip install Sphinx sphinx-rtd-theme
Now, once you have the virtual environment activated:
cd docs sphinx-build -E -W -b html . _build/html
This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.