diff --git a/adafruit_tlc59711.py b/adafruit_tlc59711.py index d99d2ad..3e844d7 100644 --- a/adafruit_tlc59711.py +++ b/adafruit_tlc59711.py @@ -4,8 +4,7 @@ # SPDX-License-Identifier: MIT """ -`adafruit_tlc59711`. - +`adafruit_tlc59711` ==================================================== CircuitPython module for the @@ -28,8 +27,8 @@ * The API is mostly compatible to the DotStar / NeoPixel Libraries and is therefore also compatible with FancyLED. -* Adafruit CircuitPython firmware for the ESP8622, M0 or M4-based boards: - https://github.com/adafruit/circuitpython/releases +* Adafruit CircuitPython firmware for the supported boards: + https://circuitpython.org/downloads """ __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_TLC59711.git" diff --git a/docs/examples.rst b/docs/examples.rst index d3cdab7..9d3e3c0 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -6,3 +6,53 @@ Ensure your device works with this simple test. .. literalinclude:: ../examples/tlc59711_simpletest.py :caption: examples/tlc59711_simpletest.py :linenos: + + +FancyLED +------------ + +this is an example for combining the TLC5957 library with FancyLED. +Enjoy the colors :-) + +.. literalinclude:: ../examples/tlc59711_fancyled.py + :caption: examples/tlc59711_fancyled.py + :linenos: + + +Animations Example +------------------ + +You should have a plethora of functions to animate your lights. + +.. literalinclude:: ../examples/tlc59711_dev.py + :caption: examples/tlc59711_dev.py + :linenos: + + +Single Chip Autoshow +-------------------- + +This makes it very slow on lots of pixel changes but is convenient for only a handful of pixels. + +.. literalinclude:: ../examples/tlc59711_singlechip_autoshow.py + :caption: examples/tlc59711_singlechip_autoshow.py + :linenos: + + +Brightness Correction Data +-------------------------- + +Test brightness correction data (BC) + +.. literalinclude:: ../examples/tlc59711_simpletest.py + :caption: examples/tlc59711_simpletest.py + :linenos: + +Fastset test +------------ + +Showcases the usage of set_pixel_16bit_value for fastest setting of values. + +.. literalinclude:: ../examples/tlc59711_fastset.py + :caption: examples/tlc59711_fastset.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst index 26974ec..18241fd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,6 +23,8 @@ Table of Contents .. toctree:: :caption: Tutorials + Adafruit 12-Channel 16-bit PWM LED Driver - SPI Interface - TLC59711 Learning Guide + .. toctree:: :caption: Related Products