Examples and docs.

Author: kattni

adafruit_led_animation/helper.py

@@ -58,20 +58,42 @@ class PixelMap:
     :param iterable pixel_ranges: Pixel ranges (or individual pixels).
     :param bool individual_pixels: Whether pixel_ranges are individual pixels.
 
+    To use with ranges of pixels:
+
     .. code-block:: python
 
         import board
         import neopixel
         from adafruit_led_animation.helper import PixelMap
-        pixels = neopixel.NeoPixel(board.D12, 307, auto_write=False)
+        pixels = neopixel.NeoPixel(board.D6, 32, auto_write=False)
 
-        tree = PixelMap(pixels, [
-            (0, 21), (21, 48), (48, 71), (71, 93),(93, 115), (115, 135), (135, 153),
-            (153, 170), (170, 188), (188, 203), (203, 217), (217, 228), (228, 240),
-            (240, 247), (247, 253), (253, 256), (256, 260), (260, 307)]
-        )
-        tree[0] = (255, 255, 0)
-        tree.show()
+        pixel_wing_horizontal = PixelMap(pixels, [(0, 8), (8, 16), (16, 24), (24, 32)])
+
+        pixel_wing_horizontal[0] = (255, 255, 0)
+        pixel_wing_horizontal.show()
+
+    To use with individual pixels:
+
+    .. code-block:: python
+
+        import board
+        import neopixel
+        from adafruit_led_animation.helper import PixelMap
+        pixels = neopixel.NeoPixel(board.D6, 32, auto_write=False)
+
+        pixel_wing_vertical = PixelMap(pixels, [
+            (0, 8, 16, 24),
+            (1, 9, 17, 25),
+            (2, 10, 18, 26),
+            (3, 11, 19, 27),
+            (4, 12, 20, 28),
+            (5, 13, 21, 29),
+            (6, 14, 22, 30),
+            (7, 15, 23, 31),
+        ], individual_pixels=True)
+
+        pixel_wing_vertical[0] = (255, 255, 0)
+        pixel_wing_vertical.show()
 
     """
 
@@ -138,6 +160,7 @@ def brightness(self, brightness):
     def fill(self, color):
         """
         Fill the used pixel ranges with color.
+
         :param color: Color to fill all pixels referenced by this PixelMap definition with.
         """
         if self._individual_pixels:
@@ -222,6 +245,7 @@ def horizontal_lines(cls, pixels, width, height, gridmapper):
 def vertical_strip_gridmap(height, alternating=True):
     """
     Returns a function that determines the pixel number for a grid with strips arranged vertically.
+
     :param height: strip height in pixels
     :param alternating: strips alternate directions in a zigzag
     :return: mapper(x, y)
@@ -238,6 +262,7 @@ def mapper(x, y):
 def horizontal_strip_gridmap(width, alternating=True):
     """
     Determines the pixel number for a grid with strips arranged horizontally.
+
     :param width: strip width in pixels
     :param alternating: strips alternate directions in a zigzag
     :return: mapper(x, y)

examples/led_animation_all_animations.py

@@ -0,0 +1,48 @@
+"""
+This example repeatedly displays all available animations, at a five second interval.
+
+For NeoPixel FeatherWing. Update pixel_pin and pixel_num to match your wiring if using
+a different form of NeoPixels.
+"""
+import board
+import neopixel
+from adafruit_led_animation.animation import *
+from adafruit_led_animation.helper import AnimationSequence
+from adafruit_led_animation.color import PURPLE, WHITE, AMBER, JADE
+
+# Update to match the pin connected to your NeoPixels
+pixel_pin = board.D6
+# Update to match the number of NeoPixels you have connected
+pixel_num = 32
+
+pixels = neopixel.NeoPixel(pixel_pin, pixel_num, brightness=0.2, auto_write=False)
+
+blink = Blink(pixels, speed=0.1, color=JADE)
+comet = Comet(pixels, speed=0.01, color=PURPLE, tail_length=10, bounce=True)
+chase = Chase(pixels, speed=0.1, size=3, spacing=6, color=WHITE)
+pulse = Pulse(pixels, speed=0.1, period=3, color=AMBER)
+sparkle = Sparkle(pixels, speed=0.1, color=PURPLE, num_sparkles=10)
+solid = Solid(pixels, color=JADE)
+rainbow = Rainbow(pixels, speed=0.1, period=2)
+sparkle_pulse = SparklePulse(pixels, speed=0.1, period=3, color=JADE)
+rainbow_comet = RainbowComet(pixels, speed=0.1, tail_length=7, bounce=True)
+rainbow_chase = RainbowChase(pixels, speed=0.1, size=3, spacing=2, wheel_step=8)
+
+
+animations = AnimationSequence(
+    blink,
+    comet,
+    chase,
+    pulse,
+    sparkle,
+    solid,
+    rainbow,
+    sparkle_pulse,
+    rainbow_comet,
+    rainbow_chase,
+    advance_interval=5,
+    auto_clear=True,
+)
+
+while True:
+    animations.animate()

examples/led_animation_gridmap.py

@@ -0,0 +1,50 @@
+"""
+This example shows usage of the gridmap helper to easily treat a single strip as a horizontal or
+vertical grid for animation purposes.
+
+For NeoPixel FeatherWing. Update pixel_pin and pixel_num to match your wiring if using
+a different form of NeoPixels.
+"""
+import board
+import neopixel
+from adafruit_led_animation.animation import *
+from adafruit_led_animation.helper import *
+from adafruit_led_animation.color import PURPLE, JADE, AMBER
+
+
+pixels = neopixel.NeoPixel(board.D6, 32, brightness=0.2, auto_write=False)
+
+pixel_wing_vertical = PixelMap.vertical_lines(
+    pixels, 8, 4, horizontal_strip_gridmap(8, alternating=False)
+)
+pixel_wing_horizontal = PixelMap.horizontal_lines(
+    pixels, 8, 4, horizontal_strip_gridmap(8, alternating=False)
+)
+
+comet_h = Comet(
+    pixel_wing_horizontal, speed=0.1, color=PURPLE, tail_length=3, bounce=True
+)
+comet_v = Comet(pixel_wing_vertical, speed=0.1, color=AMBER, tail_length=6, bounce=True)
+chase_h = Chase(pixel_wing_horizontal, speed=0.1, size=3, spacing=6, color=JADE)
+rainbow_chase_v = RainbowChase(
+    pixel_wing_vertical, speed=0.1, size=3, spacing=2, wheel_step=8
+)
+rainbow_comet_v = RainbowComet(
+    pixel_wing_vertical, speed=0.1, tail_length=7, bounce=True
+)
+rainbow_v = Rainbow(pixel_wing_vertical, speed=0.1, period=2)
+rainbow_chase_h = RainbowChase(pixel_wing_horizontal, speed=0.1, size=3, spacing=3)
+
+animations = AnimationSequence(
+    rainbow_v,
+    comet_h,
+    rainbow_comet_v,
+    chase_h,
+    rainbow_chase_v,
+    comet_v,
+    rainbow_chase_h,
+    advance_interval=5,
+)
+
+while True:
+    animations.animate()

examples/led_animation_simpletest.py

@@ -1,7 +1,8 @@
 """
-This example repeatedly displays two animations, Comet and Chase, at a five second interval.
+This simpletest example repeatedly displays two animations, Comet and Chase, at a five second
+interval.
 
-Designed for NeoPixel FeatherWing. Update pixel_pin and pixel_num to match your wiring if using
+For NeoPixel FeatherWing. Update pixel_pin and pixel_num to match your wiring if using
 a different form of NeoPixels.
 """
 import board