adafruit-circuitpython-matrixkeypad

Introduction

This simple helper library lets you create objects that will scan and detect keypresses on passive matrix keypads

Dependencies

This driver depends on:

Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-matrixkeypad

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-matrixkeypad

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-matrixkeypad

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)
    time.sleep(0.1)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

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

Metadata

Release files for adafruit-circuitpython-matrixkeypad 1.2.23

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-matrixkeypad 1.2.23
File	Size	Uploaded
adafruit_circuitpython_matrixkeypad-1.2.23.tar.gz	23.0 kB	Apr 23, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-matrixkeypad 1.2.23
File	Interpreter	ABI	Platform	Reset
adafruit_circuitpython_matrixkeypad-1.2.23-py3-none-any.whl 4.9 kB Apr 23, 2026	Python 3	none	any	Details

Total release size: 28.0 kB

Release files / adafruit_circuitpython_matrixkeypad-1.2.23.tar.gz

Download URL	adafruit_circuitpython_matrixkeypad-1.2.23.tar.gz
Size	23.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`6557f85fb3658bcfe7e8e1bc902e9edea3e942191ca3b86393637b2197212374`
BLAKE2b-256 checksum How to use checksums	`0034f1dd49ae2eff5e66fde9463959b6582f34ef5df6beed66283bdc9c45e4b8`
Upload date	Apr 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.11.15`

Release files / adafruit_circuitpython_matrixkeypad-1.2.23-py3-none-any.whl

Download URL	adafruit_circuitpython_matrixkeypad-1.2.23-py3-none-any.whl
Size	4.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`09b11e8dce48a20daf32d7bdc3b3dc098469ebf033871f3898982ba33475ad3b`
BLAKE2b-256 checksum How to use checksums	`c6be41108f39034b6bb0890e40fd8100655c3dabb62c4a06c06864115ac2823e`
Upload date	Apr 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.11.15`