Skip to content

updating_API_documentation #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 27, 2021
Merged

updating_API_documentation #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ee6902
updating_API_documentation
jposada202020 Apr 27, 2021
84320ff
correcting_title
jposada202020 Apr 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions adafruit_tlc59711.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
# SPDX-License-Identifier: MIT

"""
`adafruit_tlc59711`.

`adafruit_tlc59711`
====================================================

CircuitPython module for the
Expand All @@ -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"
Expand Down
50 changes: 50 additions & 0 deletions docs/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
2 changes: 2 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Table of Contents
.. toctree::
:caption: Tutorials

Adafruit 12-Channel 16-bit PWM LED Driver - SPI Interface - TLC59711 Learning Guide <https://learn.adafruit.com/tlc5947-tlc59711-pwm-led-driver-breakout/downloads-and-links>

.. toctree::
:caption: Related Products

Expand Down