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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-trellis-1.3.18.tar.gz
Algorithm Hash digest
SHA256 3aa4ea4259c3a938af8317d1abb6d3227a4e9398ca2f04ffd4cc545e6850ff08
MD5 b3750f0e52f5d49e70f785c0ebee51e6
BLAKE2b-256 8c8fff8dd01d083dc7c5cef6f67898743a9e9dc6836e6be7d8c0eb98528020d0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_trellis-1.3.18-py3-none-any.whl
Algorithm Hash digest
SHA256 f922de6731626f3f71c20b51a209b8a29104ad92af94a528743003273a081980
MD5 dd0394b62fc7f4bb7ad8273cbe8188a3
BLAKE2b-256 1d1070cb271979a85a19aebe8fd798ef72e283681a19b35f9f8c30e7884d1b30

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