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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_trellis-1.3.26.tar.gz
Algorithm Hash digest
SHA256 2fbf60700c82841082f10e608d954f99dab5e008c44b0730f4c1cab7b2f3eb83
MD5 c0f8f66138c07368619d1687291ac8a2
BLAKE2b-256 e9cd357c9c8afda26f406345135ca2105858fcb484eab36baacac3c564ed0949

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_trellis-1.3.26-py3-none-any.whl
Algorithm Hash digest
SHA256 1a885bff81356aa3cdca3362c043460cad02b4b494e8ffc10effb8b49cd50273
MD5 d7c7d7674fadf3bf7a1e3681194f0e86
BLAKE2b-256 79da397a96ba766f563f22f4bce79d8d3e71b71e7fe044d2a19817318017d58b

See more details on using hashes here.

Supported by

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