CircuitPython_RGBLED¶
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 .env
source .env/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)
Contributing¶
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Documentation¶
For information on building library documentation, please check out this guide.