CircuitPython_RGBLED
====================
.. image:: https://readthedocs.org/projects/rgbled/badge/?version=latest
:target: https://docs.circuitpython.org/projects/rgbled/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_RGBLED/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_RGBLED/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
CircuitPython driver for RGB LEDs. Works with native microcontroller pins,
`Adafruit Blinka <https://github.com/adafruit/Adafruit_Blinka>`_, or the `PCA9685 PWM driver <https://www.adafruit.com/product/815>`_.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
--------------------
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-rgbled/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-rgbled
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-rgbled
To install in a virtual environment in your current project:
.. code-block:: shell
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.
.. code-block:: python
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
.. code-block:: python
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).
.. code-block:: python
led.color = (255, 0, 0)
Set the RGB LED's color to a 24-bit integer (in hex syntax), 0x100000.
.. code-block:: python
led.color = 0x100000
Setting a common-anode RGB LED using a ContextManager:
.. code-block:: python
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 <https://docs.circuitpython.org/projects/rgbled/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_RGBLED/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-rgbled",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, rgbled, rgb, , led, , driver, , pwm",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/03/68/b573409febb80babdaba40d8999c1b0aab3315add8fc4fd22df3142eb89c/adafruit_circuitpython_rgbled-1.2.1.tar.gz",
"platform": null,
"description": "CircuitPython_RGBLED\n====================\n.. image:: https://readthedocs.org/projects/rgbled/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/rgbled/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_RGBLED/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_RGBLED/actions\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython driver for RGB LEDs. Works with native microcontroller pins,\n`Adafruit Blinka <https://github.com/adafruit/Adafruit_Blinka>`_, or the `PCA9685 PWM driver <https://www.adafruit.com/product/815>`_.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n--------------------\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-rgbled/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-rgbled\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-rgbled\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-rgbled\n\nUsage Example\n==============\n\nInitialize a common-cathode RGB LED with three PWM-capable pins.\n\n.. code-block:: python\n\n import board\n import adafruit_rgbled\n\n # Pin the Red LED is connected to\n RED_LED = board.D5\n\n # Pin the Green LED is connected to\n GREEN_LED = board.D6\n\n # Pin the Blue LED is connected to\n BLUE_LED = board.D7\n\n # Create a RGB LED object\n led = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED)\n\nInitialize a common-anode RGB LED with three PWM-capable pins\n\n.. code-block:: python\n\n import board\n import adafruit_rgbled\n\n # Pin the Red LED is connected to\n RED_LED = board.D5\n\n # Pin the Green LED is connected to\n GREEN_LED = board.D6\n\n # Pin the Blue LED is connected to\n BLUE_LED = board.D7\n\n # Create a RGB LED object\n led = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED, invert_pwm = True)\n\nSet the RGB LED's color to a RGB Tuple (Red, Green, Blue).\n\n.. code-block:: python\n\n led.color = (255, 0, 0)\n\nSet the RGB LED's color to a 24-bit integer (in hex syntax), 0x100000.\n\n.. code-block:: python\n\n led.color = 0x100000\n\nSetting a common-anode RGB LED using a ContextManager:\n\n.. code-block:: python\n\n import board\n import adafruit_rgbled\n with adafruit_rgbled.RGBLED(board.D5, board.D6, board.D7, invert_pwm = True) as rgb_led:\n rgb_led.color = (0, 255, 0)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/rgbled/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_RGBLED/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython driver for RGB LEDs",
"version": "1.2.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_RGBLED"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" rgbled",
" rgb",
" ",
" led",
" ",
" driver",
" ",
" pwm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b78e9ab857823cb1155e6826eba4f633021c7d9070bf88be78b0344dc3d59d57",
"md5": "de87e941295d0f647966f8760bc5ac66",
"sha256": "0b3de2cb2cc1e0473231bf77dd78f6352c0f8e6d929a85f6307da6c811ca2b11"
},
"downloads": -1,
"filename": "adafruit_circuitpython_rgbled-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "de87e941295d0f647966f8760bc5ac66",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5659,
"upload_time": "2024-10-07T22:34:54",
"upload_time_iso_8601": "2024-10-07T22:34:54.519591Z",
"url": "https://files.pythonhosted.org/packages/b7/8e/9ab857823cb1155e6826eba4f633021c7d9070bf88be78b0344dc3d59d57/adafruit_circuitpython_rgbled-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0368b573409febb80babdaba40d8999c1b0aab3315add8fc4fd22df3142eb89c",
"md5": "4e1d28a31dda70e5381d8f7a7b3214bf",
"sha256": "6054cfb0331c32dfcf399ed543e57c260578177e368f957fa9726dbb795748d0"
},
"downloads": -1,
"filename": "adafruit_circuitpython_rgbled-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "4e1d28a31dda70e5381d8f7a7b3214bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27099,
"upload_time": "2024-10-07T22:34:56",
"upload_time_iso_8601": "2024-10-07T22:34:56.136185Z",
"url": "https://files.pythonhosted.org/packages/03/68/b573409febb80babdaba40d8999c1b0aab3315add8fc4fd22df3142eb89c/adafruit_circuitpython_rgbled-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:34:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_RGBLED",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-typing",
"specs": [
[
"~=",
"1.4"
]
]
},
{
"name": "adafruit-circuitpython-pca9685",
"specs": []
}
],
"lcname": "adafruit-circuitpython-rgbled"
}
JSON
