/Circuitpython_Multi_Keypad

A library to manage multiple keypad instances (and compatible) as one.

Primary LanguagePythonMIT LicenseMIT

Introduction

Documentation Status Discord Build Status Code Style: Black

A library to manage multiple keypad instances (and compatible) as a single event queue.

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 or individual libraries can be installed using circup.

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install multi_keypad

Or the following command to update an existing version:

circup update

Usage Example

import board
from multi_keypad import MultiKeypad
keys1 = keypad.Keys((board.GP3, board.GP7), value_when_pressed=False, pull=True)
keys2 = keypad.Keys((board.GP11,), value_when_pressed=False, pull=True)

mkp = MultiKeypad(keys1, keys2)
while True:
    event = mkp.next_event()
    if event:
        print(event)

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.