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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-trellis-1.3.14.tar.gz
Algorithm Hash digest
SHA256 e4d343ab7740949e8c686cbe25481bdfb5eeb65c3a1803d5bf3619516962f88a
MD5 42a2009e3dda8cabcdee86801f7a06b7
BLAKE2b-256 ae309b42790ea8dc9aea8bf44b2c3ee68add4c2857da2a223136504643cdb9b0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_trellis-1.3.14-py3-none-any.whl
Algorithm Hash digest
SHA256 6cbefeba8241ca1e9797274add2432df2a5f31a2106af7555f8fc9ad7cf392cb
MD5 e1e617c59d82afcd07c72c5b20a0ebf0
BLAKE2b-256 44ee808606c78ed5f086377a4703109bd1bf2e0cd401c8ab687686079ad59191

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