Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-trellis/badge/?version=latest
:target: https://docs.circuitpython.org/projects/trellis/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_Trellis/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Trellis/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 will allow you to control the LEDs and read button presses on the `Adafruit Trellis
Board <https://www.adafruit.com/product/1616>`_. It will work with a single Trellis board, or
with a matrix of up to 8 Trellis boards.
For more details, see the `Adafruit Trellis Learn Guide <https://learn.adafruit.com/adafruit-trellis-diy-open-source-led-keypad>`_.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython 2.0.0+ <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
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-trellis/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-trellis
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-trellis
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-trellis
Usage Example
=============
See `examples/trellis_simpletest.py <https://github.com/adafruit/Adafruit_CircuitPython_Trellis/examples/trellis_simpletest.py>`_ for full
usage example.
.. code:: python
import time
import busio
from board import SCL, SDA
from adafruit_trellis import Trellis
# Create the I2C interface
i2c = busio.I2C(SCL, SDA)
# Create a Trellis object for each board
trellis = Trellis(i2c) # 0x70 when no I2C address is supplied
# Turn on every LED
print('Turning all LEDs on...')
trellis.led.fill(True)
time.sleep(2)
# Turn off every LED
print('Turning all LEDs off...')
trellis.led.fill(False)
time.sleep(2)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/trellis/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_Trellis/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-trellis",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,trellis,button,led,board,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/5d/d1/b8c965ad7cd63ef6a935aefc34acd07bbbf9e5ff4102228a58719010e193/adafruit-circuitpython-trellis-1.3.19.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-trellis/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/trellis/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_Trellis/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Trellis/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 library will allow you to control the LEDs and read button presses on the `Adafruit Trellis\nBoard <https://www.adafruit.com/product/1616>`_. It will work with a single Trellis board, or\nwith a matrix of up to 8 Trellis boards.\n\nFor more details, see the `Adafruit Trellis Learn Guide <https://learn.adafruit.com/adafruit-trellis-diy-open-source-led-keypad>`_.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython 2.0.0+ <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\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-trellis/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-trellis\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-trellis\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-trellis\n\nUsage Example\n=============\nSee `examples/trellis_simpletest.py <https://github.com/adafruit/Adafruit_CircuitPython_Trellis/examples/trellis_simpletest.py>`_ for full\nusage example.\n\n.. code:: python\n\n import time\n import busio\n from board import SCL, SDA\n from adafruit_trellis import Trellis\n\n # Create the I2C interface\n i2c = busio.I2C(SCL, SDA)\n\n # Create a Trellis object for each board\n trellis = Trellis(i2c) # 0x70 when no I2C address is supplied\n\n # Turn on every LED\n print('Turning all LEDs on...')\n trellis.led.fill(True)\n time.sleep(2)\n\n # Turn off every LED\n print('Turning all LEDs off...')\n trellis.led.fill(False)\n time.sleep(2)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/trellis/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_Trellis/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for Adafruit Trellis boards.",
"version": "1.3.19",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_trellis"
},
"split_keywords": [
"adafruit",
"trellis",
"button",
"led",
"board",
"hardware",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eade9bb3bbd5853776596edcd45f42982e2caed7dd1aff561312b640fd7d4924",
"md5": "c569a5dbcf90284f4c0f5bfa9cc11718",
"sha256": "d9ebfd38bc8f07fae29ac242eba81bb32a8fc4c836265d1e153ea13de8efe28e"
},
"downloads": -1,
"filename": "adafruit_circuitpython_trellis-1.3.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c569a5dbcf90284f4c0f5bfa9cc11718",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6801,
"upload_time": "2023-12-09T17:35:57",
"upload_time_iso_8601": "2023-12-09T17:35:57.118442Z",
"url": "https://files.pythonhosted.org/packages/ea/de/9bb3bbd5853776596edcd45f42982e2caed7dd1aff561312b640fd7d4924/adafruit_circuitpython_trellis-1.3.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5dd1b8c965ad7cd63ef6a935aefc34acd07bbbf9e5ff4102228a58719010e193",
"md5": "678334284d32750bd6cf67b6338195be",
"sha256": "3810dd433d4b43d6a4ffaf6b6a138db6e3322f4326e762eccb564289f4c9ca52"
},
"downloads": -1,
"filename": "adafruit-circuitpython-trellis-1.3.19.tar.gz",
"has_sig": false,
"md5_digest": "678334284d32750bd6cf67b6338195be",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28253,
"upload_time": "2023-12-09T17:35:59",
"upload_time_iso_8601": "2023-12-09T17:35:59.688546Z",
"url": "https://files.pythonhosted.org/packages/5d/d1/b8c965ad7cd63ef6a935aefc34acd07bbbf9e5ff4102228a58719010e193/adafruit-circuitpython-trellis-1.3.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:35:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_trellis",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-trellis"
}
JSON
