This library provides an asynchronous way to wait for buttons to be pressed. It also provides detection of single, double and triple clicks, and also long presses.
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.
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:
pip3 install circuitpython-async-button
To install system-wide (this may be required in some cases):
sudo pip3 install circuitpython-async-button
To install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-async-button
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 async_button
Or the following command to update an existing version:
circup update
There are two classes:
SimpleButton
: This allows toawait
for presses and releasesbutton = async_button.SimpleButton(board.D5, True) await button.pressed
Button
: This has much more features. It creates a background process to monitor the button and allows the user toawait
for single clicks, double clicks, long clicks etc. It must be instantiated in an asynchronous environmentbutton = async_button.Button(board.D5, True) click = await button.wait_for_click() if click == button.DOUBLE: print("Double click!")
See the examples folder for full demonstrations
API documentation for this library can be found on Read the Docs.
For information on building library documentation, please check out this guide.
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.