CircuitPython library for matrix (multiplexed) passive keypads
Switch branches/tags
Clone or download
Latest commit d236928 Nov 12, 2018
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs PyPi setup. Aug 5, 2018
examples Rename file Nov 12, 2018
.gitignore PyPi setup. Aug 5, 2018
.pylintrc ignore the board module imports in .pylintrc Aug 25, 2018
.readthedocs.yml init May 29, 2018
.travis.yml PyPi setup. Aug 5, 2018 updated CoC Aug 1, 2018
LICENSE init May 29, 2018
README.rst Fix url for badge. Aug 6, 2018 Sphinx update to docstring Jun 4, 2018
requirements.txt PyPi setup. Aug 5, 2018 PyPi setup. Aug 5, 2018



Documentation Status Discord Build Status

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.

Usage Example

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)


Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

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:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-matrixkeypad --library_location .

Sphinx documentation

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.