Skip to main content

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.

Release files for adafruit-circuitpython-rgbled 1.2.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-rgbled 1.2.7
File Size Uploaded
adafruit_circuitpython_rgbled-1.2.7.tar.gz 23.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-rgbled 1.2.7
File Interpreter ABI Platform
adafruit_circuitpython_rgbled-1.2.7-py3-none-any.whl Python 3 none any Details

Total release size: 29.6 kB

Release files / adafruit_circuitpython_rgbled-1.2.7.tar.gz

Download URL adafruit_circuitpython_rgbled-1.2.7.tar.gz
Size 23.9 kB
Tags Source
SHA-256 checksum
How to use checksums
ee2ca5a10759f6a22ec63ca57ce0a3b63f9e9a611bfac0ceef2e2651aaf4a84b
BLAKE2b-256 checksum
How to use checksums
baaa2deef9b1f482524211f0bf2459a47fa551a99a780ffb1115e4ef9a9cf4af
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release files / adafruit_circuitpython_rgbled-1.2.7-py3-none-any.whl

Download URL adafruit_circuitpython_rgbled-1.2.7-py3-none-any.whl
Size 5.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a67804d26ec5ea881a30aeaf817833eedb73e2810a40fffb88c772ceb66e8450
BLAKE2b-256 checksum
How to use checksums
fa15b98186ad8590b01ddf4ed4e8a9aebdc08f71b96d762812e7fc7b11f67007
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

1.2.7 This release

2 release files

1.2.6

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.18

2 release files

1.1.17

2 release files

1.1.15

2 release files

1.1.14

2 release files

1.1.13

2 release files

1.1.11

1 release file

1.1.10

1 release file

1.1.9

1 release file

1.1.8

1 release file

1.1.7

1 release file

1.1.6

1 release file

1.1.5

1 release file

1.1.4

1 release file

1.1.3

1 release file

1.1.2

1 release file

1.1.1

1 release file

1.1.0

1 release file

1.0.2

1 release file

1.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page