Skip to main content

CircuitPython library for Adafruit Trellis boards.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_trellis-1.3.23.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_trellis-1.3.23.tar.gz
Algorithm Hash digest
SHA256 a6034d1943680ce36c1c55e49d8887861c467acb44e830fb75d036928f2dfe06
MD5 dd39ab128ddfd25f811116514f9a4999
BLAKE2b-256 9da97f6fba184e6f9f5ba56b1287e445fa9b4b5f954fc3593e0f9e18ee4ed15c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_trellis-1.3.23-py3-none-any.whl
Algorithm Hash digest
SHA256 36ff26015d8c0d6e2fb3e312429f0d4fd96d9f9c3322feaf0bb7e51888fbf30e
MD5 d232fbac902b278db590e3d854caf960
BLAKE2b-256 cdab54ed936ce2ec775dfbcc8431d7ee313e90be3fe69d0ef28c7020880bfbb0

See more details on using hashes here.

Supported by

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