Skip to content

Commit 6f522ac

Browse files
committed
add docs
1 parent 71cc6f1 commit 6f522ac

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

adafruit_led_animation/animation.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,18 @@ def draw(self):
340340

341341

342342
class Pulse(Animation):
343+
"""
344+
Pulse all pixels a single color.
345+
346+
:param pixel_object: The initialised LED object.
347+
:param int speed: Animation refresh rate in seconds, e.g. ``0.1``.
348+
:param color: Animation color in ``(r, g, b)`` tuple, or ``0x000000`` hex format.
349+
:param period: Period to pulse the LEDs over. Default 5.
350+
:param max_intensity: The maximum intensity to pulse, between 0 and 1.0. Default 1.
351+
:param min_intensity: The minimum intensity to pulse, between 0 and 1.0. Default 0.
352+
"""
343353

354+
# pylint: disable=too-many-arguments
344355
def __init__(self, pixel_object, speed, color, period=5, max_intensity=1, min_intensity=0):
345356
self._intensity = min_intensity
346357
self.max_intensity = max_intensity

0 commit comments

Comments
 (0)