Gurkengewuerz/audio-reactive-led-strip
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Greatly expanded the README with project information

Browse Source
This commit is contained in:
Scott Lawson 2016-12-27 02:27:07 -07:00 committed by GitHub
parent 43c6af1adc
commit e454aa93f7
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -12,14 +12,32 @@ Real-time LED strip music visualization using the ESP8266 and Python
# Overview # Overview
The repository includes everything needed to build an LED strip music visualizer (excluding hardware): The repository includes everything needed to build an LED strip music visualizer (excluding hardware):
- Python Real-time visualization, which includes code for: - Python real-time visualization code, which includes code for:
- Recording audio with a microphone ([microphone.py](python/microphone.py)) - Recording audio with a microphone ([microphone.py](python/microphone.py))
- Digital signal processing ([dsp.py](python/dsp.py)) - Digital signal processing ([dsp.py](python/dsp.py))
- Constructing 1D visualizations ([visualization.py](python/visualization.py)) - Constructing 1D visualizations ([visualization.py](python/visualization.py))
- Sending pixel information to the ESP8266 over WiFi ([led.py](python/led.py)) - Sending pixel information to the ESP8266 over WiFi ([led.py](python/led.py))
- Arduino firmware for the ESP8266 ([ws2812_controller.ino](arduino/ws2812_controller/ws2812_controller.ino)) - Arduino firmware for the ESP8266 ([ws2812_controller.ino](arduino/ws2812_controller/ws2812_controller.ino))
# What do I need to make one?
The following hardware is needed to build an LED strip music visualizer:
- Computer with Python 2.7 or 3.5 ([Anaconda](https://www.continuum.io/downloads) is recommended on Windows)
- Any ESP8266 module with RX1 pin exposed. These modules are known to be compatible (but many others work too):
- NodeMCU v3
- Adafruit HUZZAH
- Adafruit Feather HUZZAH
- Any ws2812b LED strip (such as Adafruit Neopixels)
# Dependencies
## Python
There are only a handful of Python dependencies:
- Numpy
- Scipy (for digital signal processing)
- PyQtGraph (for GUI visualization)
- PyAudio (for recording audio with microphone)
On Windows machines, the use of [Anaconda](https://www.continuum.io/downloads) is **highly recommended**. Anaconda simplifies the installation of Python dependencies, which is sometimes difficult on Windows.
# Arduino dependencies
The [ws2812b i2s library](https://github.com/JoDaNl/esp8266_ws2812_i2s) must be downloaded and installed in the Arduino libraries folder.