add examples to documentation

s-light · Nov 29, 2018 · df1e10d · df1e10d
1 parent d78e776
commit df1e10d
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -8,6 +8,17 @@ Ensure your device works with this simple test.
     :linenos:
 
 
+Simple HW test
+------------------------------------------
+
+This example lights up every LED after each other.
+Its great for production testing your boards.
+
+.. literalinclude:: ../examples/pixel_checker.py
+    :caption: examples/pixel_checker.py
+    :linenos:
+
+
 TLC5957 with FancyLED
 ------------------------------------------
 
@@ -16,3 +27,12 @@ Example how to combine TLC5957 with FancyLED.
 .. literalinclude:: ../examples/tlc5957_fancyled.py
     :caption: examples/tlc5957_fancyled.py
     :linenos:
+
+TLC5957 with custom 2D-Array mapping
+------------------------------------------
+
+Example how to create a pixel-mapping with TLC5957.
+
+.. literalinclude:: ../examples/tlc5957_2d_array.py
+    :caption: examples/tlc5957_2d_array.py
+    :linenos:
diff --git a/examples/tlc5957_simpletest.py b/examples/tlc5957_simpletest.py
@@ -23,6 +23,7 @@
 # spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
 spi = bitbangio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
 
+# 6MHz for the grayscale clock
 gsclk = pulseio.PWMOut(
     board.D9, duty_cycle=(2 ** 15), frequency=(6000 * 1000))