Added setup and configuration instructions to the README
This commit is contained in:
parent
7b3f95af18
commit
97e54b64d2
24
README.md
24
README.md
@ -73,5 +73,25 @@ For the NodeMCU v3 and Adafruit Feather HUZZAH, the location of the RX1 pin is s
|
||||
![nodemcu-pinout](images/NodeMCUv3-small.png)
|
||||
![feather-huzzah-pinout](images/FeatherHuzzah-small.png)
|
||||
|
||||
# Setup / Getting Started
|
||||
Information coming soon. README is currently under active development.
|
||||
# Setup and Configuration
|
||||
1. Install Python and Python dependencies
|
||||
2. [Install Arduino IDE and ESP8266 addon](https://learn.sparkfun.com/tutorials/esp8266-thing-hookup-guide/installing-the-esp8266-arduino-addon)
|
||||
3. Download and extract all of the files in this repository onto your computer
|
||||
4. In [ws2812_controller.ino](arduino/ws2812_controller/ws2812_controller.ino):
|
||||
- Set `const char* ssid` to your router's SSID
|
||||
- Set `const char* password` to your router's password
|
||||
- Set `IPAddress gateway` to match your router's gateway
|
||||
- Set `IPAddress ip` to the IP address that you would like your ESP8266 to use (your choice)
|
||||
- Set `#define NUM_LEDS` to the number of LEDs in your LED strip
|
||||
5. In [config.py](python/config.py):
|
||||
- Set `N_PIXELS` to the number of LEDs in your LED strip (must match `NUM_LEDS` in [ws2812_controller.ino](arduino/ws2812_controller/ws2812_controller.ino))
|
||||
- Set `UDP_IP` to the IP address of your ESP8266 (must match `ip` in [ws2812_controller.ino](arduino/ws2812_controller/ws2812_controller.ino))
|
||||
- If needed, set `MIC_RATE` to your microphone sampling rate in Hz
|
||||
|
||||
# Running the Visualization
|
||||
Once everything has been configured, run [visualization.py](python/visualization.py) to start the visualization. The visualization will automatically use your default recording device (microphone) as the audio input.
|
||||
|
||||
A PyQtGraph GUI will open to display the output of the visualization on the computer.
|
||||
|
||||
|
||||
If you encounter any issues or have questions about this project, feel free to open a new issue.
|
@ -5,6 +5,7 @@
|
||||
#include <WiFiUdp.h>
|
||||
#include <ws2812_i2s.h>
|
||||
|
||||
// Set this to the number of LEDs in your LED strip
|
||||
#define NUM_LEDS 260
|
||||
#define BUFFER_LEN 1024
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user