README.md (3210B)
1 Blinkenstrip 2 ------------ 3 4 # Overview 5 6 Shows effects on a WS2811 connected to an ESP32. The ESP runs a 7 minimal web server allowing to control the effects. The system is 8 highly configurable: It can show effects both on LED strips of 9 arbitrary length and on LEDs arranged as a matrix. 10 11 # Installation & Operation 12 13 Connect the data line of the WS2811 strip to pin 4 of the 14 ESP32. Install the software the usual way. When powered up, the ESP 15 spawns an AP with ESSID "blinkenstrip" and password 16 "blinkenstrip". Connect to the AP and access the web interface at 17 <http://192.168.4.1>. <http://192.168.4.1/config.html> gives access to 18 system configuration. Here you can set the layout of your 19 strip/matrix, and configure the system to connect to an existing 20 network instead of an access point. If you configure your ESP to join 21 an existing network and don't know its IP address, run `idf.py 22 monitor` and check the debug output. 23 24 # Effects 25 26 - Sequence 27 28 All LEDs show the same, changing color. This is a nice effect if you 29 want to illuminate an object. 30 31 - Blink 32 33 Individual LEDs switch randomly between blue and green color. This 34 effect looks quite nice both on LED strips and on matrices. 35 36 - Running Dot 37 38 An individual red dot "running" on a blue backdrop. 39 40 - Cellular Automaton 41 42 Conway's game of life. While designed for LED matrices, this effect 43 also look surpringsly nice on strips. 44 45 - Changing lines 46 47 This is more of a test effect for LED matrices. 48 49 - Worms 50 51 A configurable number of worms eating blue dots. This is the 52 recommended effect for LED strips. The number of worms can be set in 53 the configuration menu. 54 55 # Changing defaults 56 57 If you want different default values on first startup (i.e. before 58 accessing <http://192.168.4.1/config.html>), you can set different 59 values in sub-menu "Blinkenstrip" of the system configuration executed by 60 `idfy.py menuconfig`. 61 62 63 # Factory reset & Hardware setup 64 65 If pins 12 and 13 are connected on reset, the user configuration is 66 deleted and the factory default values are loaded. 67 68 For installations with a large number of LEDs, it is recommend to 69 chain a suitable fuse (e.g. 6 A for 250 LEDs) into the power line of 70 the LED strip/matrix. 71 72 Directory `case/` provides an OpenSCAD file for a printable case. This 73 case is designed to host a ridiciously overpowered 110 W Mean Well 74 LRS-150F-5 power supply. 75 76 # Bugs 77 78 HTML characters in names (e.g. spaces) are not translated to ASCII. 79 80 ## Changelog 81 82 - v1.0 83 First public version. 84 85 ## Copyright and License 86 87 main/led_strip.(h|c) © 2016 by Lucas Bruder. Parts of 88 main/webserver.c © 2016, 2020 Espressif Systems. 89 90 Everything else: 91 92 Copyright © 2021 Gerd Beuster <gerd@frombelow.net> 93 94 Licensed under the Apache License, Version 2.0 (the "License"); 95 you may not use this file except in compliance with the License. 96 You may obtain a copy of the License at 97 98 http://www.apache.org/licenses/LICENSE-2.0 99 100 Unless required by applicable law or agreed to in writing, software 101 distributed under the License is distributed on an "AS IS" BASIS, 102 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 103 See the License for the specific language governing permissions and 104 limitations under the License.