Skip to main content

CircuitPython driver for RGB LEDs

Project description

CircuitPython_RGBLED

Documentation Status Discord Build Status Code Style: Black

CircuitPython driver for RGB LEDs. Works with native microcontroller pins, Adafruit Blinka, or the PCA9685 PWM driver.

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-rgbled

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-rgbled

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-rgbled

Usage Example

Initialize a common-cathode RGB LED with three PWM-capable pins.

import board
import adafruit_rgbled

# Pin the Red LED is connected to
RED_LED = board.D5

# Pin the Green LED is connected to
GREEN_LED = board.D6

# Pin the Blue LED is connected to
BLUE_LED = board.D7

# Create a RGB LED object
led = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED)

Initialize a common-anode RGB LED with three PWM-capable pins

import board
import adafruit_rgbled

# Pin the Red LED is connected to
RED_LED = board.D5

# Pin the Green LED is connected to
GREEN_LED = board.D6

# Pin the Blue LED is connected to
BLUE_LED = board.D7

# Create a RGB LED object
led = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED, invert_pwm = True)

Set the RGB LED’s color to a RGB Tuple (Red, Green, Blue).

led.color = (255, 0, 0)

Set the RGB LED’s color to a 24-bit integer (in hex syntax), 0x100000.

led.color = 0x100000

Setting a common-anode RGB LED using a ContextManager:

import board
import adafruit_rgbled
with adafruit_rgbled.RGBLED(board.D5, board.D6, board.D7, invert_pwm = True) as rgb_led:
    rgb_led.color = (0, 255, 0)

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-rgbled-1.1.15.tar.gz (26.8 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-rgbled-1.1.15.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-rgbled-1.1.15.tar.gz
Algorithm Hash digest
SHA256 a29dd595de528c3b589c0ae867f340878956b8a4621292ead37c82e5cfcaf90e
MD5 45bbc3f2dc1d72a1867e79bfe25df01d
BLAKE2b-256 7cda591b49a6d5d97bd4e990100a2bbfc26c8e30275fdc2509823bd46ef29c46

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_rgbled-1.1.15-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_rgbled-1.1.15-py3-none-any.whl
Algorithm Hash digest
SHA256 962f1fd798fab89a62ba034a6db1ea16bde9bad3a56e0d85d5f8d81ca2513a94
MD5 c84bac6940f172984321206a617e94a2
BLAKE2b-256 6ec29b4dc7b73a7d5a907907b1aa0eb404e15b843a89c895a0160da6546ff85d

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