├── .gitignore ├── LICENSE ├── README.md ├── docs └── fire1clip1.gif ├── fire1 ├── code.py └── fire_leds.py └── ulab_speedup ├── fire_no_ulab.py └── fire_with_ulab.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # circuitpython_led_effects 2 | 3 | Some fun with Neopixel / WS2812 LEDs in CircuitPython 4 | 5 | 6 | A growing list of LED effects. So far: 7 | 8 | * fire1 -- simple fire simulation, uses ulab 9 | 10 | 11 | * ulab_speedup -- how to use ulab (CircuitPython Numpy) to speed up LED animations by 10x 12 | 13 | Also, see [my write up on it here](https://todbot.com/blog/2022/10/21/speed-up-circuitpython-led-animations-10x/) 14 | 15 | https://user-images.githubusercontent.com/274093/197255523-daec8bce-d1b5-4f5f-9d76-aac2ad72de7a.mp4 16 | 17 | -------------------------------------------------------------------------------- /docs/fire1clip1.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/todbot/circuitpython_led_effects/10dab5ae5629017327a41aef2b1c93866589863a/docs/fire1clip1.gif -------------------------------------------------------------------------------- /fire1/code.py: -------------------------------------------------------------------------------- 1 | # code.py for fire1 -- demonstrate using the "fire_leds" library 2 | # 10 Oct 2022 - @todbot / Tod Kurt 3 | # Drop this code.py and fire_leds.py into your CIRCUITPY drive 4 | # part of https://github.com/todbot/circuitpython_led_effects 5 | 6 | import time, board, neopixel, rainbowio 7 | 8 | import fire_leds 9 | 10 | fire_color = 0xff5500 11 | fire_fade = (-2,-2,-2) # how much to fade R,G,B each udpate 12 | 13 | num_leds = 64 * 1 14 | led_pin = board.GP28 15 | 16 | leds = neopixel.NeoPixel(led_pin, num_leds, brightness=0.4, auto_write=False) 17 | 18 | # make up our fire 19 | #fire_leds = fire_leds.FireLEDs(leds, fade_by=fire_fade, fire_rate=0.1 ) 20 | fire_leds = fire_leds.FireLEDs(leds, fade_by=fire_fade) 21 | 22 | while True: 23 | #fire_leds.update( rainbowio.colorwheel(time.monotonic()*40), 3 ) # rainbow fire 24 | fire_leds.update( fire_color, 3 ) # standard fire effect 25 | fire_leds.show() 26 | -------------------------------------------------------------------------------- /fire1/fire_leds.py: -------------------------------------------------------------------------------- 1 | # fire_leds.py -- simple LED fire simulation for CircuitPython 2 | # 10 Oct 2022 - @todbot / Tod Kurt 3 | # part of https://github.com/todbot/circuitpython_led_effects 4 | # 5 | # Note: requires boards with ulab (Numpy for CircuitPython) support 6 | 7 | import time, random 8 | from ulab import numpy as np 9 | 10 | # a little class to help us do a fire simulation 11 | class FireLEDs: 12 | def __init__(self,leds, fade_by, update_rate=0.01, fire_rate=0.1): 13 | self.leds = leds 14 | self.n = len(leds) 15 | self.leds_np = np.array( leds, dtype=np.int16) # gets length from 'leds' 16 | self.fade_by = np.array( fade_by, dtype=np.int16 ) 17 | self.last_time = time.monotonic() 18 | self.update_rate = update_rate 19 | self.last_fire_time = self.last_time 20 | self.fire_rate = fire_rate 21 | 22 | # call "update()" as fast as you want 23 | def update(self, new_color, update_num=3): 24 | now = time.monotonic() 25 | if now - self.last_time < self.update_rate: 26 | return 27 | self.last_time = now 28 | # using numpy, this global fade takes 4 msec for 256 LEDs on RP2040, otherwise takes 40 msec 29 | self.leds_np += self.fade_by # fade down the working numpy array 30 | self.leds_np = np.clip(self.leds_np, 0,255) # constrain all elements to 0-255 31 | if now - self.last_fire_time > self.fire_rate: 32 | self.last_fire_time = now + random.uniform(-self.fire_rate, self.fire_rate) 33 | c = (new_color>>16 & 0xff, new_color>>8 & 0xff, new_color & 0xff) # turn color into list 34 | for i in range(update_num): 35 | self.leds_np[ random.randint(0,self.n-1) ] = c # update random LEDs with new color 36 | self.leds[:] = self.leds_np.tolist() # copy working numpy array to leds 37 | 38 | # call 'show()' whenever you want to update the actual LEDs 39 | def show(self): 40 | self.leds.show() 41 | -------------------------------------------------------------------------------- /ulab_speedup/fire_no_ulab.py: -------------------------------------------------------------------------------- 1 | # fire_no_ulab.py -- simple Neopixel fire animation using Python lists 2 | # 10 Oct 2022 - @todbot / Tod Kurt 3 | # part of https://github.com/todbot/circuitpython_led_effects 4 | 5 | import time, random 6 | import board, neopixel 7 | 8 | num_leds = 256 # 256 even though we're only showing 64 9 | led_pin = board.GP28 10 | 11 | leds = neopixel.NeoPixel(led_pin, num_leds, brightness=0.4, auto_write=False) 12 | 13 | fade_by = -3 14 | 15 | fire_color = 0xff6600 16 | 17 | while True: 18 | # pick a new random set of LEDs to light up with fire 19 | c = fire_color 20 | c = (c>>16 & 0xff, c>>8 & 0xff, c & 0xff) # turn into tuple 21 | for i in range(3): 22 | leds[ random.randint(0,num_leds-1) ] = c 23 | 24 | start_time = time.monotonic() 25 | 26 | # fade down all LEDs, using Python lists, takes ~40 msec for 256 LEDs on RP2040 27 | leds[:] = [[min(max(i+fade_by,0),255) for i in l] for l in leds] # dim all by fade_by 28 | 29 | elapsed_time = time.monotonic() - start_time 30 | print(int(elapsed_time*1000)) # print out how long calculation took 31 | 32 | # update the strip 33 | leds.show() 34 | -------------------------------------------------------------------------------- /ulab_speedup/fire_with_ulab.py: -------------------------------------------------------------------------------- 1 | # fire_with_ulab.py -- simple Neopixel fire animation using ulab (numpy) 2 | # 10 Oct 2022 - @todbot / Tod Kurt 3 | # part of https://github.com/todbot/circuitpython_led_effects 4 | 5 | import time, random 6 | import board, neopixel 7 | from ulab import numpy as np 8 | 9 | num_leds = 256 # 256 even though we're only showing 64 10 | led_pin = board.GP28 11 | 12 | leds = neopixel.NeoPixel(led_pin, num_leds, brightness=0.4, auto_write=False) 13 | leds_np = np.array(leds, dtype=np.int16) # numpy working copy of LED data 14 | 15 | fade_by = np.array( (-3,-3,-3), dtype=np.int16 ) # amount to fade by 16 | 17 | fire_color = 0xff6600 18 | 19 | while True: 20 | # pick a new random set of LEDs to light up with fire 21 | c = fire_color 22 | c = (c>>16 & 0xff, c>>8 & 0xff, c & 0xff) # turn into tuple 23 | for i in range(3): 24 | leds_np[ random.randint(0,num_leds-1) ] = c 25 | 26 | start_time = time.monotonic() 27 | 28 | # fade down all LEDs, using numpy, takes 4 msec for 256 LEDs on RP2040 29 | leds_np += fade_by # fade down the working numpy array 30 | leds_np = np.clip(leds_np, 0,255) # constrain everyting to 0-255 31 | leds[:] = leds_np.tolist() # copy working array to leds 32 | 33 | elapsed_time = time.monotonic() - start_time 34 | print(int(elapsed_time*1000)) # print out how long calculation took 35 | 36 | # update the strip 37 | leds.show() 38 | --------------------------------------------------------------------------------