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.13.tar.gz (29.7 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-trellis-1.3.13.tar.gz
Algorithm Hash digest
SHA256 c9c51c490f8a4142200ee28bd38aac1d97acaf10484a5d537b86f28d5b1ce210
MD5 ea248edbddea7c357fad0552f63ae84d
BLAKE2b-256 ab4326e1b1d92cf13a31cf3a1beb354a188f9040889e57b397c41436793c6f9b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_trellis-1.3.13-py3-none-any.whl
Algorithm Hash digest
SHA256 96f6bc7dc41643b08a854837d7043506163608805ebdd159cbc4c19ba56d722d
MD5 88c97edfcf93b08d8545d7b0eec2fc47
BLAKE2b-256 f2fb47fe8ee1afcb2d89d2f54ac95b9f5f628e28542613b357b0f346c85e5171

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