Skip to main content

CircuitPython driver for RGB LEDs

Project description

CircuitPython_RGBLED

Documentation Status Discord Build Status Code Style: Ruff

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

Uploaded Source

Built Distribution

adafruit_circuitpython_rgbled-1.2.4-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file adafruit_circuitpython_rgbled-1.2.4.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_rgbled-1.2.4.tar.gz
Algorithm Hash digest
SHA256 64ff2190a8202fe847e7351aff86abafed5eec1d281a86c5acbe5685e0fb4b75
MD5 aade47ac369c7a6f729ebf9c896fd323
BLAKE2b-256 b2954f7a69f988b98f8aa085b36d7ca3a8a20a7522bb092ba8d2f0505da7a266

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_rgbled-1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 af33d0ca27645279b90e18cb9afb7b85220b31591911a34c590c6c8fdc79b7e3
MD5 32acb408b2d9627a981f0fea7103e2ce
BLAKE2b-256 054ee8e4d4bb9e0a10d3f40f3bac2cc5e245797b4d902ce44f9362a71c2b4b84

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