Skip to content

adafruit/Adafruit_CircuitPython_TM1814

Repository files navigation

Introduction

Documentation Status Discord Build Status Code Style: Ruff

TM1814 RGB(W) LED driver for RP2 microcontrollers

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 or individual libraries can be installed using circup.

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_tm1814

Or the following command to update an existing version:

circup update

Usage Example

import board
import rainbowio
import supervisor
from adafruit_tm1814 import TM1814PixelBackground

# The pin where the LED strip data line is connected
TM1814 = board.A0
# The number of TM1814 controllers
NUM_PIXELS = 100
pixels = TM1814PixelBackground(TM1814, NUM_PIXELS, brightness=0.1)

# Cycle the rainbow at about 1 cycle every 4 seconds
while True:
    pixels.fill(rainbowio.colorwheel(supervisor.ticks_ms() // 16))

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.