Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-tm1814/badge/?version=latest
:target: https://docs.circuitpython.org/projects/tm1814/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_TM1814/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_TM1814/actions
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
TM1814 RGB(W) LED driver for RP2 microcontrollers
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://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_tm1814
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import board
import rainbowio
import supervisor
from adafruit_tm1814 import TM1814PixelBackground
# The pin where the LED strip data line is connected
TM1814 = board.A0
# The number of TM1814 controllers
NUM_PIXELS = 100
pixels = TM1814PixelBackground(TM1814, NUM_PIXELS, brightness=0.1)
# Cycle the rainbow at about 1 cycle every 4 seconds
while True:
pixels.fill(rainbowio.colorwheel(supervisor.ticks_ms() // 16))
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/tm1814/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_TM1814/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-tm1814",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, tm1814, rgb, rgbw, neopixel, led, leds, pixelbuf",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/37/c6/2b23b2bf8c9beb0f429a7247bd82af71341dab1265ae9ef44c714a707155/adafruit_circuitpython_tm1814-1.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-tm1814/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/tm1814/en/latest/\n :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_TM1814/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_TM1814/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nTM1814 RGB(W) LED driver for RP2 microcontrollers\n\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://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_tm1814\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import rainbowio\n import supervisor\n from adafruit_tm1814 import TM1814PixelBackground\n\n # The pin where the LED strip data line is connected\n TM1814 = board.A0\n # The number of TM1814 controllers\n NUM_PIXELS = 100\n pixels = TM1814PixelBackground(TM1814, NUM_PIXELS, brightness=0.1)\n\n # Cycle the rainbow at about 1 cycle every 4 seconds\n while True:\n pixels.fill(rainbowio.colorwheel(supervisor.ticks_ms() // 16))\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/tm1814/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`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_TM1814/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "TM1814 RGB(W) LED driver for RP2 microcontrollers",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_TM1814"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" tm1814",
" rgb",
" rgbw",
" neopixel",
" led",
" leds",
" pixelbuf"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2dba8abcc55ddb705169ad952bffd914b32181d3fff54df2b7ce7e4eca9468a0",
"md5": "9e02877af56e221d4454442ddc4329e5",
"sha256": "8074e7a2f7d4c3fecd115d5e87f8faac2610e49709531f5b81688a3a957bee6f"
},
"downloads": -1,
"filename": "adafruit_circuitpython_tm1814-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e02877af56e221d4454442ddc4329e5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6351,
"upload_time": "2024-10-23T23:21:55",
"upload_time_iso_8601": "2024-10-23T23:21:55.226368Z",
"url": "https://files.pythonhosted.org/packages/2d/ba/8abcc55ddb705169ad952bffd914b32181d3fff54df2b7ce7e4eca9468a0/adafruit_circuitpython_tm1814-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "37c62b23b2bf8c9beb0f429a7247bd82af71341dab1265ae9ef44c714a707155",
"md5": "9a37293dbefd0f6b7d444b7d6cee49fa",
"sha256": "262c56784c6f97b09ad8fb3d695238857f3fa23902d4b3e461fb0c1974c94aef"
},
"downloads": -1,
"filename": "adafruit_circuitpython_tm1814-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "9a37293dbefd0f6b7d444b7d6cee49fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24808,
"upload_time": "2024-10-23T23:21:56",
"upload_time_iso_8601": "2024-10-23T23:21:56.768304Z",
"url": "https://files.pythonhosted.org/packages/37/c6/2b23b2bf8c9beb0f429a7247bd82af71341dab1265ae9ef44c714a707155/adafruit_circuitpython_tm1814-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 23:21:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_TM1814",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-CircuitPython-pioasm",
"specs": []
},
{
"name": "Adafruit-CircuitPython-pixelbuf",
"specs": []
}
],
"lcname": "adafruit-circuitpython-tm1814"
}
JSON
