Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-trellism4/badge/?version=latest
:target: https://docs.circuitpython.org/projects/trellism4/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_TrellisM4/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_TrellisM4/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 high level library provides objects that represent Trellis M4 hardware.
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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
--------------------
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-trellism4/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-trellism4
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-trellism4
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-trellism4
Usage Example
=============
This example prints out the coordinates of a button each time it is pressed and released:
.. code-block:: python
import time
import adafruit_trellism4
trellis = adafruit_trellism4.TrellisM4Express()
current_press = set()
while True:
pressed = set(trellis.pressed_keys)
for press in pressed - current_press:
print("Pressed:", press)
for release in current_press - pressed:
print("Released:", release)
time.sleep(0.08)
current_press = pressed
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/trellism4/en/latest/>`_.
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/adafruit/Adafruit_CircuitPython_TrellisM4/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-trellism4",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,trellism4,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/9a/f8/a4865dacaed9fef7ec52ada5b6e7aece95f77d2b9fbfdecd39382ba43455/adafruit-circuitpython-trellism4-1.5.18.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-trellism4/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/trellism4/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_TrellisM4/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_TrellisM4/actions/\n :alt: Build Status\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 high level library provides objects that represent Trellis M4 hardware.\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\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/adafruit-circuitpython-trellism4/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-trellism4\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-trellism4\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 .venv/bin/activate\n pip3 install adafruit-circuitpython-trellism4\n\nUsage Example\n=============\n\nThis example prints out the coordinates of a button each time it is pressed and released:\n\n.. code-block:: python\n\n import time\n import adafruit_trellism4\n\n trellis = adafruit_trellism4.TrellisM4Express()\n\n current_press = set()\n while True:\n pressed = set(trellis.pressed_keys)\n for press in pressed - current_press:\n print(\"Pressed:\", press)\n for release in current_press - pressed:\n print(\"Released:\", release)\n time.sleep(0.08)\n current_press = pressed\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/trellism4/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_TrellisM4/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library Trellis M4 Express.",
"version": "1.5.18",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_TrellisM4"
},
"split_keywords": [
"adafruit",
"trellism4",
"hardware",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f8d99ee427aee2dd8e2c4a2a0003e6e56864fd9f58c3529430be9425713b15f",
"md5": "aa22e5a7746fc9f212f070b979cf783f",
"sha256": "686c4188f2a5893df26a3d5ecccb9f8946967e5e8ab0551c1ff9e6291192aacc"
},
"downloads": -1,
"filename": "adafruit_circuitpython_trellism4-1.5.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa22e5a7746fc9f212f070b979cf783f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6463,
"upload_time": "2023-12-09T17:36:09",
"upload_time_iso_8601": "2023-12-09T17:36:09.071007Z",
"url": "https://files.pythonhosted.org/packages/7f/8d/99ee427aee2dd8e2c4a2a0003e6e56864fd9f58c3529430be9425713b15f/adafruit_circuitpython_trellism4-1.5.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9af8a4865dacaed9fef7ec52ada5b6e7aece95f77d2b9fbfdecd39382ba43455",
"md5": "cdc0636a45d83192203bf90db110bd21",
"sha256": "eb0327af537105641afc32859760ccb556b7c20452124bbd14ba3aad92157ea9"
},
"downloads": -1,
"filename": "adafruit-circuitpython-trellism4-1.5.18.tar.gz",
"has_sig": false,
"md5_digest": "cdc0636a45d83192203bf90db110bd21",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 164507,
"upload_time": "2023-12-09T17:36:10",
"upload_time_iso_8601": "2023-12-09T17:36:10.359261Z",
"url": "https://files.pythonhosted.org/packages/9a/f8/a4865dacaed9fef7ec52ada5b6e7aece95f77d2b9fbfdecd39382ba43455/adafruit-circuitpython-trellism4-1.5.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:36:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_TrellisM4",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-trellism4"
}
JSON
