Skip to main content

CircuitPython library for passive matrix keypads.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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 .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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file adafruit-circuitpython-matrixkeypad-1.2.15.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-matrixkeypad-1.2.15.tar.gz
Algorithm Hash digest
SHA256 6ad81eeee6d297d72d2ab8c55c255483ffefaaf16c2fbc8aa5f3c1ea56757a1b
MD5 26614d91d2eedde2cd0bda6c37b40910
BLAKE2b-256 e487280f44e96f71c47b720592beceebd206e8eb1536c439462036554af1c9e3

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_matrixkeypad-1.2.15-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_matrixkeypad-1.2.15-py3-none-any.whl
Algorithm Hash digest
SHA256 5b245bfe120a15f100814a22577b4de5098f2c007df3821920d7cabe00b7048e
MD5 df344906ab5dfa381b7ee7748672f2c3
BLAKE2b-256 71cf66c2148d00907481f1f8a89080319f37756bcaf0965c829af799580163e7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page