adafruit-circuitpython-matrixkeypad

CircuitPython library for passive matrix keypads.


Keywords
adafruit matrix keypad hardware micropython circuitpython
License
MIT
Install
pip install adafruit-circuitpython-matrixkeypad==1.2.0

Documentation

Introduction

Documentation Status Discord Build Status

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

Dependencies

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.

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 .env
source .env/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)

Contributing

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

Documentation

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