Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-button-handler/badge/?version=latest
:target: https://circuitpython-button-handler.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/EGJ-Moorington/CircuitPython_Button_Handler/workflows/Build%20CI/badge.svg
:target: https://github.com/EGJ-Moorington/CircuitPython_Button_Handler/actions
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
This helper library simplifies the usage of buttons with CircuitPython, by detecting and differentiating button inputs, returning a set of the inputs and calling their corresponding functions.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-button-handler/>`_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-button-handler
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-button-handler
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-button-handler
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:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install button_handler
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
This simple script showcases the usage of this library using a single button.
+---------------+
| Button wiring |
+===============+
| GND |
+---------------+
| D9 |
+---------------+
.. code-block:: python
import time
import board
from keypad import Keys
from button_handler import ButtonHandler, ButtonInput
def double_press():
print("Double press detected!")
def short_press():
print("Short press detected!")
def long_press():
print("Long press detected!")
def hold():
print("The button began being held down!")
actions = {
ButtonInput(ButtonInput.DOUBLE_PRESS, callback=double_press),
ButtonInput(ButtonInput.SHORT_PRESS, callback=short_press),
ButtonInput(ButtonInput.LONG_PRESS, callback=long_press),
ButtonInput(ButtonInput.HOLD, callback=hold),
}
scanner = Keys([board.D9], value_when_pressed=False)
button_handler = ButtonHandler(scanner.events, actions)
while True:
button_handler.update()
time.sleep(0.0025)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-button-handler.readthedocs.io/>`_.
For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/EGJ-Moorington/CircuitPython_Button_Handler/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "circuitpython-button-handler",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, button_handler, button, short, long, double, triple, multi, keypad, key, press, helper",
"author": "EGJ Moorington",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/7a/96/b741d2e0c218c22ce714aac4f030adcf688892f10be1e80a9c54b975f342/circuitpython_button_handler-3.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-button-handler/badge/?version=latest\n :target: https://circuitpython-button-handler.readthedocs.io/\n :alt: Documentation Status\n\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/EGJ-Moorington/CircuitPython_Button_Handler/workflows/Build%20CI/badge.svg\n :target: https://github.com/EGJ-Moorington/CircuitPython_Button_Handler/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nThis helper library simplifies the usage of buttons with CircuitPython, by detecting and differentiating button inputs, returning a set of the inputs and calling their corresponding functions.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-button-handler/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-button-handler\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-button-handler\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .env/bin/activate\n pip3 install circuitpython-button-handler\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install button_handler\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nThis simple script showcases the usage of this library using a single button.\n\n+---------------+\n| Button wiring |\n+===============+\n| GND |\n+---------------+\n| D9 |\n+---------------+\n\n.. code-block:: python\n\n import time\n\n import board\n from keypad import Keys\n\n from button_handler import ButtonHandler, ButtonInput\n\n\n def double_press():\n print(\"Double press detected!\")\n\n\n def short_press():\n print(\"Short press detected!\")\n\n\n def long_press():\n print(\"Long press detected!\")\n\n\n def hold():\n print(\"The button began being held down!\")\n\n\n actions = {\n ButtonInput(ButtonInput.DOUBLE_PRESS, callback=double_press),\n ButtonInput(ButtonInput.SHORT_PRESS, callback=short_press),\n ButtonInput(ButtonInput.LONG_PRESS, callback=long_press),\n ButtonInput(ButtonInput.HOLD, callback=hold),\n }\n\n scanner = Keys([board.D9], value_when_pressed=False)\n button_handler = ButtonHandler(scanner.events, actions)\n\n\n while True:\n button_handler.update()\n time.sleep(0.0025)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-button-handler.readthedocs.io/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/EGJ-Moorington/CircuitPython_Button_Handler/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "This helper library simplifies the usage of buttons with CircuitPython, by detecting and differentiating button inputs, returning a set of the inputs and calling their corresponding functions.",
"version": "3.0.0",
"project_urls": {
"Homepage": "https://github.com/EGJ-Moorington/CircuitPython_Button_Handler"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" button_handler",
" button",
" short",
" long",
" double",
" triple",
" multi",
" keypad",
" key",
" press",
" helper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "42f19961a314cf2c2b1c167a0c3edbf0109ad3720c0522b4bd9d861d1bfdd963",
"md5": "d2e88ae2ec9967727d18c934596b26b6",
"sha256": "7b5e8eb57931e38b0c2269c78e62bd6e7483fd6df230e4523a37e104c0e467e9"
},
"downloads": -1,
"filename": "circuitpython_button_handler-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2e88ae2ec9967727d18c934596b26b6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9231,
"upload_time": "2024-09-02T13:27:50",
"upload_time_iso_8601": "2024-09-02T13:27:50.186211Z",
"url": "https://files.pythonhosted.org/packages/42/f1/9961a314cf2c2b1c167a0c3edbf0109ad3720c0522b4bd9d861d1bfdd963/circuitpython_button_handler-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7a96b741d2e0c218c22ce714aac4f030adcf688892f10be1e80a9c54b975f342",
"md5": "75e7b6ffcb17a023b277001a05081175",
"sha256": "d5f94d03dca145a0573415e6553340ec6e1b2cbf36f615b4c739a6809856b433"
},
"downloads": -1,
"filename": "circuitpython_button_handler-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "75e7b6ffcb17a023b277001a05081175",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31605,
"upload_time": "2024-09-02T13:27:51",
"upload_time_iso_8601": "2024-09-02T13:27:51.677702Z",
"url": "https://files.pythonhosted.org/packages/7a/96/b741d2e0c218c22ce714aac4f030adcf688892f10be1e80a9c54b975f342/circuitpython_button_handler-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-02 13:27:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "EGJ-Moorington",
"github_project": "CircuitPython_Button_Handler",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-button-handler"
}
JSON
