diff --git a/README.md b/README.md index 13e98f1..bdb52e0 100644 --- a/README.md +++ b/README.md @@ -77,14 +77,15 @@ For the NodeMCU v3 and Adafruit Feather HUZZAH, the location of the RX1 pin is s 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): +4. Connect the RX1 pin of your ESP8266 module to the data input pin of the ws2812b LED strip. Ensure that your LED strip is properly connected to a 5V power supply and that the ESP8266 and LED strip share a common electrical ground connection. +5. 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. Upload the [ws2812_controller.ino](arduino/ws2812_controller/ws2812_controller.ino) firmware to the ESP8266. Ensure that you have selected the correct ESP8266 board from the boards menu. In the dropdown menu, set `CPU Frequency` to 160 MHz for optimal performance. -6. In [config.py](python/config.py): +6. Upload the [ws2812_controller.ino](arduino/ws2812_controller/ws2812_controller.ino) firmware to the ESP8266. Ensure that you have selected the correct ESP8266 board from the boards menu. In the dropdown menu, set `CPU Frequency` to 160 MHz for optimal performance. +7. 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. Most of the time you will not need to change this.