From 1190ffe24474f9a6963177c752cadc33f20ff136 Mon Sep 17 00:00:00 2001 From: gamblor21 Date: Mon, 28 Sep 2020 15:58:53 -0500 Subject: [PATCH 1/7] Initial commit --- adafruit_led_animation/animation/volume.py | 38 ++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 adafruit_led_animation/animation/volume.py diff --git a/adafruit_led_animation/animation/volume.py b/adafruit_led_animation/animation/volume.py new file mode 100644 index 0000000..85bcd7a --- /dev/null +++ b/adafruit_led_animation/animation/volume.py @@ -0,0 +1,38 @@ +from adafruit_led_animation.animation import Animation + +class Volume(Animation): + """ + Animate the brightness and number of pixels based on volume. + :param pixel_object: The initialised LED object. + :param float speed: Animation update speed in seconds, e.g. ``0.1``. + :param brightest_color: Color at max volume ``(r, g, b)`` tuple, or ``0x000000`` hex format + """ + + def __init__(self, pixel_object, speed, brightest_color, decoder, max_volume=500, name=None): + self._decoder = decoder + self._num_pixels = len(pixel_object) + self._max_volume = max_volume + self._brigthest_color = brightest_color + super().__init__(pixel_object, speed, brightest_color, name=name) + + def _set_color(self, brightest_color): + self.colors = [brightest_color] + + def map_range(self, x, in_min, in_max, out_min, out_max): + mapped = (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min + if out_min <= out_max: + return max(min(mapped, out_max), out_min) + + return min(max(mapped, out_max), out_min) + + def draw(self): + red = int(self.map_range(self._decoder.rms_level, 0, self._max_volume, 0, self._brigthest_color[0])) + green = int(self.map_range(self._decoder.rms_level, 0, self._max_volume, 0, self._brigthest_color[1])) + blue = int(self.map_range(self._decoder.rms_level, 0, self._max_volume, 0, self._brigthest_color[2])) + + lit_pixels = int(self.map_range(self._decoder.rms_level, 0, self._max_volume, 0, self._num_pixels)) + if lit_pixels > self._num_pixels: + lit_pixels = self._num_pixels + + self.pixel_object[0:lit_pixels] = [(red,green,blue)] * lit_pixels + self.pixel_object[lit_pixels:self._num_pixels] = [(0,0,0)] * (self._num_pixels-lit_pixels) From d12b7fb50b74aabfc603b710a39bac6e78fa5533 Mon Sep 17 00:00:00 2001 From: gamblor21 Date: Mon, 28 Sep 2020 16:03:36 -0500 Subject: [PATCH 2/7] Added license and documentation --- adafruit_led_animation/animation/volume.py | 36 ++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/adafruit_led_animation/animation/volume.py b/adafruit_led_animation/animation/volume.py index 85bcd7a..6d61bdb 100644 --- a/adafruit_led_animation/animation/volume.py +++ b/adafruit_led_animation/animation/volume.py @@ -1,3 +1,37 @@ +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +""" +`adafruit_led_animation.animation.volume` +================================================================================ +Volume animation for CircuitPython helper library for LED animations. +* Author(s): Mark Komus +Implementation Notes +-------------------- +**Hardware:** +* `Adafruit NeoPixels `_ +* `Adafruit DotStars `_ +**Software and Dependencies:** +* Adafruit CircuitPython firmware for the supported boards: + https://circuitpython.org/downloads +""" + from adafruit_led_animation.animation import Animation class Volume(Animation): @@ -6,6 +40,8 @@ class Volume(Animation): :param pixel_object: The initialised LED object. :param float speed: Animation update speed in seconds, e.g. ``0.1``. :param brightest_color: Color at max volume ``(r, g, b)`` tuple, or ``0x000000`` hex format + :param decoder: a MP3Decoder object that the volume will be taken from + :param float max_volume: what volume is considered maximum where everything is lit up """ def __init__(self, pixel_object, speed, brightest_color, decoder, max_volume=500, name=None): From eb86bf0b4eb038a4c1d1a47bb171af4099d569e2 Mon Sep 17 00:00:00 2001 From: gamblor21 Date: Mon, 28 Sep 2020 16:32:30 -0500 Subject: [PATCH 3/7] Fixed errors from pylint and black --- adafruit_led_animation/animation/volume.py | 76 +++++++++++++++++----- 1 file changed, 59 insertions(+), 17 deletions(-) diff --git a/adafruit_led_animation/animation/volume.py b/adafruit_led_animation/animation/volume.py index 6d61bdb..5827ba1 100644 --- a/adafruit_led_animation/animation/volume.py +++ b/adafruit_led_animation/animation/volume.py @@ -34,6 +34,20 @@ from adafruit_led_animation.animation import Animation + +def map_range(x, in_min, in_max, out_min, out_max): + """ + Maps a number from one range to another. + :return: Returns value mapped to new range + :rtype: float + """ + mapped = (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min + if out_min <= out_max: + return max(min(mapped, out_max), out_min) + + return min(max(mapped, out_max), out_min) + + class Volume(Animation): """ Animate the brightness and number of pixels based on volume. @@ -44,31 +58,59 @@ class Volume(Animation): :param float max_volume: what volume is considered maximum where everything is lit up """ - def __init__(self, pixel_object, speed, brightest_color, decoder, max_volume=500, name=None): + # pylint: disable=too-many-arguments + def __init__( + self, pixel_object, speed, brightest_color, decoder, max_volume=500, name=None + ): self._decoder = decoder self._num_pixels = len(pixel_object) self._max_volume = max_volume - self._brigthest_color = brightest_color + self._brightest_color = brightest_color super().__init__(pixel_object, speed, brightest_color, name=name) - def _set_color(self, brightest_color): - self.colors = [brightest_color] - - def map_range(self, x, in_min, in_max, out_min, out_max): - mapped = (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min - if out_min <= out_max: - return max(min(mapped, out_max), out_min) - - return min(max(mapped, out_max), out_min) + def set_brightest_color(self, brightest_color): + """ + Animate the brightness and number of pixels based on volume. + :param brightest_color: Color at max volume ``(r, g, b)`` tuple, or ``0x000000`` hex format + """ + self._brightest_color = brightest_color def draw(self): - red = int(self.map_range(self._decoder.rms_level, 0, self._max_volume, 0, self._brigthest_color[0])) - green = int(self.map_range(self._decoder.rms_level, 0, self._max_volume, 0, self._brigthest_color[1])) - blue = int(self.map_range(self._decoder.rms_level, 0, self._max_volume, 0, self._brigthest_color[2])) + red = int( + map_range( + self._decoder.rms_level, + 0, + self._max_volume, + 0, + self._brightest_color[0], + ) + ) + green = int( + map_range( + self._decoder.rms_level, + 0, + self._max_volume, + 0, + self._brightest_color[1], + ) + ) + blue = int( + map_range( + self._decoder.rms_level, + 0, + self._max_volume, + 0, + self._brightest_color[2], + ) + ) - lit_pixels = int(self.map_range(self._decoder.rms_level, 0, self._max_volume, 0, self._num_pixels)) + lit_pixels = int( + map_range(self._decoder.rms_level, 0, self._max_volume, 0, self._num_pixels) + ) if lit_pixels > self._num_pixels: lit_pixels = self._num_pixels - self.pixel_object[0:lit_pixels] = [(red,green,blue)] * lit_pixels - self.pixel_object[lit_pixels:self._num_pixels] = [(0,0,0)] * (self._num_pixels-lit_pixels) + self.pixel_object[0:lit_pixels] = [(red, green, blue)] * lit_pixels + self.pixel_object[lit_pixels : self._num_pixels] = [(0, 0, 0)] * ( + self._num_pixels - lit_pixels + ) From 766b22615336808f0c339f02e874c90310bd8f4b Mon Sep 17 00:00:00 2001 From: gamblor21 Date: Mon, 28 Sep 2020 17:08:26 -0500 Subject: [PATCH 4/7] Initial commit --- adafruit_led_animation/timedsequence.py | 100 ++++++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 adafruit_led_animation/timedsequence.py diff --git a/adafruit_led_animation/timedsequence.py b/adafruit_led_animation/timedsequence.py new file mode 100644 index 0000000..cc97f9a --- /dev/null +++ b/adafruit_led_animation/timedsequence.py @@ -0,0 +1,100 @@ +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +""" +`adafruit_led_animation.timedsequence` +================================================================================ + +Animation timed sequence helper for CircuitPython helper library for LED animations. + + +* Author(s): Mark Komus + +Implementation Notes +-------------------- + +**Hardware:** + +* `Adafruit NeoPixels `_ +* `Adafruit DotStars `_ + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://circuitpython.org/downloads + +""" + +from adafruit_led_animation.sequence import AnimationSequence +from . import MS_PER_SECOND + + +class TimedAnimationSequence(AnimationSequence): + """ + A sequence of Animations to run in succession, each animation running for an + individual amount of time. + :param members: The animation objects or groups followed by how long the animation + should run in seconds. + :param bool auto_clear: Clear the pixels between animations. If ``True``, the current animation + will be cleared from the pixels before the next one starts. + Defaults to ``False``. + :param bool random_order: Activate the animations in a random order. Defaults to ``False``. + :param bool auto_reset: Automatically call reset() on animations when changing animations. + .. code-block:: python + import board + import neopixel + from adafruit_led_animation.timedsequence import TimedAnimationSequence + import adafruit_led_animation.animation.comet as comet_animation + import adafruit_led_animation.animation.sparkle as sparkle_animation + import adafruit_led_animation.animation.blink as blink_animation + import adafruit_led_animation.color as color + strip_pixels = neopixel.NeoPixel(board.A1, 30, brightness=1, auto_write=False) + blink = blink_animation.Blink(strip_pixels, 0.2, color.RED) + comet = comet_animation.Comet(strip_pixels, 0.1, color.BLUE) + sparkle = sparkle_animation.Sparkle(strip_pixels, 0.05, color.GREEN) + animations = AnimationSequence(blink, 5, comet, 3, sparkle, 7) + while True: + animations.animate() + """ + + # pylint: disable=too-many-instance-attributes + def __init__( + self, *members, auto_clear=True, random_order=False, auto_reset=False, name=None + ): + self._animation_members = [] + self._animation_timings = [] + for x, item in enumerate(members): + if not x % 2: + self._animation_members.append(item) + else: + self._animation_timings.append(item) + + super().__init__( + *self._animation_members, + auto_clear=auto_clear, + random_order=random_order, + auto_reset=auto_reset, + advance_on_cycle_complete=False, + name=name + ) + self._advance_interval = self._animation_timings[self._current] * MS_PER_SECOND + + def activate(self, index): + super().activate(index) + self._advance_interval = self._animation_timings[self._current] * MS_PER_SECOND From 27f313650b337092e240273417cfb4f60b20cb52 Mon Sep 17 00:00:00 2001 From: gamblor21 Date: Mon, 28 Sep 2020 17:10:29 -0500 Subject: [PATCH 5/7] Fixed example code --- adafruit_led_animation/timedsequence.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_led_animation/timedsequence.py b/adafruit_led_animation/timedsequence.py index cc97f9a..f4530dd 100644 --- a/adafruit_led_animation/timedsequence.py +++ b/adafruit_led_animation/timedsequence.py @@ -68,7 +68,7 @@ class TimedAnimationSequence(AnimationSequence): blink = blink_animation.Blink(strip_pixels, 0.2, color.RED) comet = comet_animation.Comet(strip_pixels, 0.1, color.BLUE) sparkle = sparkle_animation.Sparkle(strip_pixels, 0.05, color.GREEN) - animations = AnimationSequence(blink, 5, comet, 3, sparkle, 7) + animations = TimedAnimationSequence(blink, 5, comet, 3, sparkle, 7) while True: animations.animate() """ From 63ab8dae843947f7b9f39f937150d17435082158 Mon Sep 17 00:00:00 2001 From: gamblor21 Date: Mon, 28 Sep 2020 19:09:44 -0500 Subject: [PATCH 6/7] Fixed black error --- adafruit_led_animation/timedsequence.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_led_animation/timedsequence.py b/adafruit_led_animation/timedsequence.py index f4530dd..42773c6 100644 --- a/adafruit_led_animation/timedsequence.py +++ b/adafruit_led_animation/timedsequence.py @@ -91,7 +91,7 @@ def __init__( random_order=random_order, auto_reset=auto_reset, advance_on_cycle_complete=False, - name=name + name=name, ) self._advance_interval = self._animation_timings[self._current] * MS_PER_SECOND From e23e57b421901d66b7fe0b60cc42d2f54c679b7b Mon Sep 17 00:00:00 2001 From: foamyguy Date: Thu, 29 Jun 2023 19:36:32 -0500 Subject: [PATCH 7/7] reuse formatting. add examples for new functionality --- adafruit_led_animation/animation/volume.py | 20 ++----------- adafruit_led_animation/timedsequence.py | 20 ++----------- examples/led_animation_timedsequence.py | 21 +++++++++++++ examples/led_animation_volume.py | 34 ++++++++++++++++++++++ 4 files changed, 59 insertions(+), 36 deletions(-) create mode 100644 examples/led_animation_timedsequence.py create mode 100644 examples/led_animation_volume.py diff --git a/adafruit_led_animation/animation/volume.py b/adafruit_led_animation/animation/volume.py index 5827ba1..cbfb8d1 100644 --- a/adafruit_led_animation/animation/volume.py +++ b/adafruit_led_animation/animation/volume.py @@ -1,22 +1,6 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2020 Gamblor21 # -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. +# SPDX-License-Identifier: MIT """ `adafruit_led_animation.animation.volume` ================================================================================ diff --git a/adafruit_led_animation/timedsequence.py b/adafruit_led_animation/timedsequence.py index 42773c6..a08c5e1 100644 --- a/adafruit_led_animation/timedsequence.py +++ b/adafruit_led_animation/timedsequence.py @@ -1,22 +1,6 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2020 Gamblor21 # -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. +# SPDX-License-Identifier: MIT """ `adafruit_led_animation.timedsequence` ================================================================================ diff --git a/examples/led_animation_timedsequence.py b/examples/led_animation_timedsequence.py new file mode 100644 index 0000000..b6e05bf --- /dev/null +++ b/examples/led_animation_timedsequence.py @@ -0,0 +1,21 @@ +# SPDX-FileCopyrightText: 2020 Gamblor21 +# +# SPDX-License-Identifier: MIT +""" +Example for TimedSequence +""" +import board +import neopixel +from adafruit_led_animation.timedsequence import TimedAnimationSequence +import adafruit_led_animation.animation.comet as comet_animation +import adafruit_led_animation.animation.sparkle as sparkle_animation +import adafruit_led_animation.animation.blink as blink_animation +from adafruit_led_animation import color + +strip_pixels = neopixel.NeoPixel(board.D6, 32, brightness=0.1, auto_write=False) +blink = blink_animation.Blink(strip_pixels, 0.3, color.RED) +comet = comet_animation.Comet(strip_pixels, 0.1, color.BLUE) +sparkle = sparkle_animation.Sparkle(strip_pixels, 0.05, color.GREEN) +animations = TimedAnimationSequence(blink, 2, comet, 4, sparkle, 5) +while True: + animations.animate() diff --git a/examples/led_animation_volume.py b/examples/led_animation_volume.py new file mode 100644 index 0000000..2448636 --- /dev/null +++ b/examples/led_animation_volume.py @@ -0,0 +1,34 @@ +# SPDX-FileCopyrightText: 2023 Tim Cocks +# +# SPDX-License-Identifier: MIT + +"""Volume Animation Example""" +import board +from audiomp3 import MP3Decoder +import neopixel +from adafruit_led_animation.animation import volume + +try: + from audioio import AudioOut +except ImportError: + try: + from audiopwmio import PWMAudioOut as AudioOut + except ImportError: + pass # not always supported by every board! + +# Fill in your own MP3 file or use the one from the learn guide: +# https://learn.adafruit.com/circuitpython-essentials/circuitpython-mp3-audio#installing-project-code-3067700 +mp3file = "happy.mp3" +with open(mp3file, "rb") as mp3: + decoder = MP3Decoder(mp3) + audio = AudioOut(board.SPEAKER) + + strip_pixels = neopixel.NeoPixel(board.D4, 30, brightness=0.1, auto_write=False) + volume_anim = volume.Volume(strip_pixels, 0.3, (0, 255, 0), decoder, 400) + + while True: + audio.play(decoder) + print("playing", mp3file) + + while audio.playing: + volume_anim.animate()