Sphinx and example updates to match API.

Author: kattni

adafruit_led_animation/animation/rainbowsparkle.py

@@ -53,6 +53,8 @@ class RainbowSparkle(Rainbow):
     :param pixel_object: The initialised LED object.
     :param float speed: Animation refresh rate in seconds, e.g. ``0.1``.
     :param float period: Period to cycle the rainbow over in seconds.  Default 5.
+    :param int num_sparkles: The number of sparkles to display. Defaults to 1/20 of the pixel
+                             object length.
     :param float step: Color wheel step.  Default 1.
     :param str name: Name of animation (optional, useful for sequences and debugging).
     :param float background_brightness: The brightness of the background rainbow. Defaults to

adafruit_led_animation/animation/sparklepulse.py

@@ -21,10 +21,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`adafruit_led_animation.animation.sparklepluse`
+`adafruit_led_animation.animation.sparklepulse`
 ================================================================================
 
-Sparklepulse animation for CircuitPython helper library for LED animations.
+Sparkle-pulse animation for CircuitPython helper library for LED animations.
 
 * Author(s): Roy Hooper, dmolavi
 

docs/api.rst

@@ -4,7 +4,7 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
-.. automodule:: adafruit_led_animation.animation.animation
+.. automodule:: adafruit_led_animation.animation
    :members:
 
 .. automodule:: adafruit_led_animation.color
@@ -19,40 +19,37 @@
 .. automodule:: adafruit_led_animation.sequence
    :members:
 
-.. automodule:: adafruit_led_animation.animation.rainbow
+.. automodule:: adafruit_led_animation.animation.blink
    :members:
 
-.. automodule:: adafruit_led_animation.animation.sparkle
+.. automodule:: adafruit_led_animation.animation.solid
    :members:
 
-.. automodule:: adafruit_led_animation.animation.blink
+.. automodule:: adafruit_led_animation.animation.colorcycle
    :members:
 
 .. automodule:: adafruit_led_animation.animation.chase
    :members:
 
-.. automodule:: adafruit_led_animation.animation.colorcycle
-   :members:
-
 .. automodule:: adafruit_led_animation.animation.comet
    :members:
 
 .. automodule:: adafruit_led_animation.animation.pulse
    :members:
 
-.. automodule:: adafruit_led_animation.animation.rainbowchase
+.. automodule:: adafruit_led_animation.animation.rainbow
    :members:
 
-.. automodule:: adafruit_led_animation.animation.rainbowcomet
+.. automodule:: adafruit_led_animation.animation.sparkle
    :members:
 
-.. automodule:: adafruit_led_animation.animation.rainbowsparkle
+.. automodule:: adafruit_led_animation.animation.rainbowchase
    :members:
 
-.. automodule:: adafruit_led_animation.animation.solid
+.. automodule:: adafruit_led_animation.animation.rainbowcomet
    :members:
 
-.. automodule:: adafruit_led_animation.animation.sparkle
+.. automodule:: adafruit_led_animation.animation.rainbowsparkle
    :members:
 
 .. automodule:: adafruit_led_animation.animation.sparklepulse

docs/conf.py

@@ -21,7 +21,7 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-autodoc_mock_imports = ["adafruit_led_animation", "adafruit_led_animation.animation"]
+autodoc_mock_imports = []
 
 
 intersphinx_mapping = {

examples/led_animation_all_animations.py

@@ -9,11 +9,20 @@
 import board
 import neopixel
 
-import adafruit_led_animation.animation.blink
-import adafruit_led_animation.animation.sparklepulse
-from adafruit_led_animation import animation
+import adafruit_led_animation.animation.blink as blink_animation
+import adafruit_led_animation.animation.sparklepulse as sparklepulse_animation
+import adafruit_led_animation.animation.comet as comet_animation
+import adafruit_led_animation.animation.chase as chase_animation
+import adafruit_led_animation.animation.pulse as pulse_animation
+import adafruit_led_animation.animation.sparkle as sparkle_animation
+import adafruit_led_animation.animation.rainbowchase as rainbowchase_animation
+import adafruit_led_animation.animation.rainbowsparkle as rainbowsparkle_animation
+import adafruit_led_animation.animation.rainbowcomet as rainbowcomet_animation
+import adafruit_led_animation.animation.solid as solid_animation
+import adafruit_led_animation.animation.colorcycle as colorcycle_animation
+import adafruit_led_animation.animation.rainbow as rainbow_animation
 from adafruit_led_animation.sequence import AnimationSequence
-from adafruit_led_animation.color import PURPLE, WHITE, AMBER, JADE
+from adafruit_led_animation.color import PURPLE, WHITE, AMBER, JADE, MAGENTA, ORANGE
 
 # Update to match the pin connected to your NeoPixels
 pixel_pin = board.D6
@@ -22,40 +31,33 @@
 
 pixels = neopixel.NeoPixel(pixel_pin, pixel_num, brightness=0.2, auto_write=False)
 
-blink = adafruit_led_animation.animation.animation.blink.Blink(
-    pixels, speed=0.5, color=JADE
-)
-comet = animation.Comet(pixels, speed=0.01, color=PURPLE, tail_length=10, bounce=True)
-chase = animation.Chase(pixels, speed=0.1, size=3, spacing=6, color=WHITE)
-pulse = animation.Pulse(pixels, speed=0.1, period=3, color=AMBER)
-sparkle = adafruit_led_animation.animation.animation.sparkle.Sparkle(
-    pixels, speed=0.1, color=PURPLE, num_sparkles=10
-)
-solid = adafruit_led_animation.animation.animation.solid.Solid(pixels, color=JADE)
-rainbow = adafruit_led_animation.animation.animation.rainbow.Rainbow(
-    pixels, speed=0.1, period=2
-)
-sparkle_pulse = adafruit_led_animation.animation.animation.sparklepulse.SparklePulse(
-    pixels, speed=0.1, period=3, color=JADE
-)
-rainbow_comet = adafruit_led_animation.animation.animation.rainbowcomet.RainbowComet(
-    pixels, speed=0.1, tail_length=7, bounce=True
-)
-rainbow_chase = adafruit_led_animation.animation.animation.rainbowchase.RainbowChase(
+blink = blink_animation.Blink(pixels, speed=0.5, color=JADE)
+colorcycle = colorcycle_animation.ColorCycle(pixels, speed=0.4, colors=[MAGENTA, ORANGE])
+comet = comet_animation.Comet(pixels, speed=0.01, color=PURPLE, tail_length=10, bounce=True)
+chase = chase_animation.Chase(pixels, speed=0.1, size=3, spacing=6, color=WHITE)
+pulse = pulse_animation.Pulse(pixels, speed=0.1, period=3, color=AMBER)
+sparkle = sparkle_animation.Sparkle(pixels, speed=0.1, color=PURPLE, num_sparkles=10)
+solid = solid_animation.Solid(pixels, color=JADE)
+rainbow = rainbow_animation.Rainbow(pixels, speed=0.1, period=2)
+sparkle_pulse = sparklepulse_animation.SparklePulse(pixels, speed=0.1, period=3, color=JADE)
+rainbow_comet = rainbowcomet_animation.RainbowComet(pixels, speed=0.1, tail_length=7, bounce=True)
+rainbow_chase = rainbowchase_animation.RainbowChase(
     pixels, speed=0.1, size=3, spacing=2, wheel_step=8
 )
+rainbow_sparkle = rainbowsparkle_animation.RainbowSparkle(pixels, speed=0.1, num_sparkles=15)
 
 
 animations = AnimationSequence(
     comet,
     blink,
+    rainbow_sparkle,
     chase,
     pulse,
     sparkle,
-    solid,
     rainbow,
-    sparkle_pulse,
+    solid,
     rainbow_comet,
+    sparkle_pulse,
     rainbow_chase,
     advance_interval=5,
     auto_clear=True,

examples/led_animation_gridmap.py

@@ -10,9 +10,12 @@
 import board
 import neopixel
 
-import adafruit_led_animation.animation.rainbow
-import adafruit_led_animation.sequence
-from adafruit_led_animation import animation
+import adafruit_led_animation.animation.comet as comet_animation
+import adafruit_led_animation.animation.rainbowcomet as rainbowcomet_animation
+import adafruit_led_animation.animation.rainbowchase as rainbowchase_animation
+import adafruit_led_animation.animation.chase as chase_animation
+import adafruit_led_animation.animation.rainbow as rainbow_animation
+from adafruit_led_animation.sequence import AnimationSequence
 from adafruit_led_animation import helper
 from adafruit_led_animation.color import PURPLE, JADE, AMBER
 
@@ -26,29 +29,29 @@
     pixels, 8, 4, helper.horizontal_strip_gridmap(8, alternating=False)
 )
 
-comet_h = animation.Comet(
+comet_h = comet_animation.Comet(
     pixel_wing_horizontal, speed=0.1, color=PURPLE, tail_length=3, bounce=True
 )
-comet_v = animation.Comet(
+comet_v = comet_animation.Comet(
     pixel_wing_vertical, speed=0.1, color=AMBER, tail_length=6, bounce=True
 )
-chase_h = animation.Chase(
+chase_h = chase_animation.Chase(
     pixel_wing_horizontal, speed=0.1, size=3, spacing=6, color=JADE
 )
-rainbow_chase_v = adafruit_led_animation.animation.animation.rainbowchase.RainbowChase(
+rainbow_chase_v = rainbowchase_animation.RainbowChase(
     pixel_wing_vertical, speed=0.1, size=3, spacing=2, wheel_step=8
 )
-rainbow_comet_v = adafruit_led_animation.animation.animation.rainbowcomet.RainbowComet(
+rainbow_comet_v = rainbowcomet_animation.RainbowComet(
     pixel_wing_vertical, speed=0.1, tail_length=7, bounce=True
 )
-rainbow_v = adafruit_led_animation.animation.animation.rainbow.Rainbow(
+rainbow_v = rainbow_animation.Rainbow(
     pixel_wing_vertical, speed=0.1, period=2
 )
-rainbow_chase_h = adafruit_led_animation.animation.animation.rainbowchase.RainbowChase(
+rainbow_chase_h = rainbowchase_animation.RainbowChase(
     pixel_wing_horizontal, speed=0.1, size=3, spacing=3
 )
 
-animations = adafruit_led_animation.sequence.AnimationSequence(
+animations = AnimationSequence(
     rainbow_v,
     comet_h,
     rainbow_comet_v,

examples/led_animation_simpletest.py

@@ -9,7 +9,8 @@
 """
 import board
 import neopixel
-from adafruit_led_animation.animation import Comet, Chase
+import adafruit_led_animation.animation.comet as comet_animation
+import adafruit_led_animation.animation.chase as chase_animation
 from adafruit_led_animation.sequence import AnimationSequence
 from adafruit_led_animation.color import PURPLE, WHITE
 
@@ -20,8 +21,8 @@
 
 pixels = neopixel.NeoPixel(pixel_pin, pixel_num, brightness=0.2, auto_write=False)
 
-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)
+comet = comet_animation.Comet(pixels, speed=0.01, color=PURPLE, tail_length=10, bounce=True)
+chase = chase_animation.Chase(pixels, speed=0.1, size=3, spacing=6, color=WHITE)
 
 animations = AnimationSequence(comet, chase, advance_interval=5)