Skip to main content

CircuitPython library for Adafruit Trellis boards.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

This library will allow you to control the LEDs and read button presses on the Adafruit Trellis Board. 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.

Dependencies

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.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-trellis

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-trellis

To install in a virtual environment in your current project:

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 for full usage example.

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.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-trellis-1.3.16.tar.gz (28.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-trellis-1.3.16.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-trellis-1.3.16.tar.gz
Algorithm Hash digest
SHA256 229b1992f1dde10e8e76788adf804def50e2a6158832f52dc463b466bb633138
MD5 bc8bbe4284f0e4e0ccf325951cd40d9e
BLAKE2b-256 7348497d79d76c22068f0a171cbb633081d53d8686e1bf8afccaa84a4fdd53bc

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_trellis-1.3.16-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_trellis-1.3.16-py3-none-any.whl
Algorithm Hash digest
SHA256 e31149e926c58e1abbb0fa523f5b4c7288dbdda0ebe9e87771b40bbfa13f122e
MD5 33d3d74baa09eadb10980d7b4353e665
BLAKE2b-256 46eae23f630f4a1474fa8b161072a14b8bb741827ce820f2cc871268456f5b83

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page