Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-async-button/badge/?version=latest
:target: https://circuitpython-async-button.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/furbrain/CircuitPython_async_button/workflows/Build%20CI/badge.svg
:target: https://github.com/furbrain/CircuitPython_async_button/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
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.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `CircuitPython asyncio module <https://github.com/adafruit/Adafruit_CircuitPython_asyncio>`_
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-async-button/>`_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-async-button
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-async-button
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-async-button
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 async_button
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage
=====
There are two classes:
* ``SimpleButton``: This allows to ``await`` for presses and releases
.. code-block:: python
button = 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 to ``await`` for single clicks, double clicks, long clicks etc. It must be instantiated
in an asynchronous environment
.. code-block:: python
button = 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
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-async-button.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/furbrain/CircuitPython_async_button/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "circuitpython-async-button",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,async_button,async,asyncio,countio,keypad,button,press",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/b1/82/e90b79ced9a1feafe99c2f1b428c85b5322783d9c607aa2d9ff068f91717/circuitpython-async-button-1.2.3.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-async-button/badge/?version=latest\n :target: https://circuitpython-async-button.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/furbrain/CircuitPython_async_button/workflows/Build%20CI/badge.svg\n :target: https://github.com/furbrain/CircuitPython_async_button/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nThis library provides an asynchronous way to wait for buttons to be pressed. It also provides\ndetection of single, double and triple clicks, and also long presses.\n\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `CircuitPython asyncio module <https://github.com/adafruit/Adafruit_CircuitPython_asyncio>`_\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-async-button/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-async-button\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-async-button\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-async-button\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 async_button\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage\n=====\n\nThere are two classes:\n\n* ``SimpleButton``: This allows to ``await`` for presses and releases\n\n .. code-block:: python\n\n button = async_button.SimpleButton(board.D5, True)\n await button.pressed\n\n* ``Button``: This has much more features. It creates a background process to monitor the button\n and allows the user to ``await`` for single clicks, double clicks, long clicks etc. It must be instantiated\n in an asynchronous environment\n\n .. code-block:: python\n\n button = async_button.Button(board.D5, True)\n click = await button.wait_for_click()\n if click == button.DOUBLE:\n print(\"Double click!\")\n\nSee the examples folder for full demonstrations\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-async-button.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/furbrain/CircuitPython_async_button/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "a library for reading buttons using asyncio",
"version": "1.2.3",
"project_urls": {
"Homepage": "https://github.com/furbrain/CircuitPython_async_button"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"async_button",
"async",
"asyncio",
"countio",
"keypad",
"button",
"press"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "24b836b4c2deec9acb2c0daa97fd50275ac41e94bc73b075bed326d7e90d1eb0",
"md5": "1abb932e92376ec61bed234edb560c60",
"sha256": "bda63bef65ea0477092c8a9ab8b0d831350617817c1d812cc53f8e08e3110f5b"
},
"downloads": -1,
"filename": "circuitpython_async_button-1.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1abb932e92376ec61bed234edb560c60",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8152,
"upload_time": "2023-09-01T16:21:36",
"upload_time_iso_8601": "2023-09-01T16:21:36.518261Z",
"url": "https://files.pythonhosted.org/packages/24/b8/36b4c2deec9acb2c0daa97fd50275ac41e94bc73b075bed326d7e90d1eb0/circuitpython_async_button-1.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b182e90b79ced9a1feafe99c2f1b428c85b5322783d9c607aa2d9ff068f91717",
"md5": "f6c80c68a34dc72827e2fa1e7e747178",
"sha256": "66b31e3faba1912bcacfa20d82916212e5dd560d561e2300b4acc5d182f15630"
},
"downloads": -1,
"filename": "circuitpython-async-button-1.2.3.tar.gz",
"has_sig": false,
"md5_digest": "f6c80c68a34dc72827e2fa1e7e747178",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34515,
"upload_time": "2023-09-01T16:21:38",
"upload_time_iso_8601": "2023-09-01T16:21:38.745496Z",
"url": "https://files.pythonhosted.org/packages/b1/82/e90b79ced9a1feafe99c2f1b428c85b5322783d9c607aa2d9ff068f91717/circuitpython-async-button-1.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-01 16:21:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "furbrain",
"github_project": "CircuitPython_async_button",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-async-button"
}
JSON
