From 97e54b64d26836270932f2d3ec4cff8f57be45a8 Mon Sep 17 00:00:00 2001 From: Scott Lawson Date: Tue, 27 Dec 2016 21:30:51 -0700 Subject: [PATCH] Added setup and configuration instructions to the README --- README.md | 24 +++++++++++++++++-- .../ws2812_controller/ws2812_controller.ino | 1 + 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ac979d3..84549eb 100644 --- a/README.md +++ b/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. \ No newline at end of file diff --git a/arduino/ws2812_controller/ws2812_controller.ino b/arduino/ws2812_controller/ws2812_controller.ino index c38c4df..1632d1b 100644 --- a/arduino/ws2812_controller/ws2812_controller.ino +++ b/arduino/ws2812_controller/ws2812_controller.ino @@ -5,6 +5,7 @@ #include #include +// Set this to the number of LEDs in your LED strip #define NUM_LEDS 260 #define BUFFER_LEN 1024