diff --git a/README.md b/README.md index c0d7f88..ac979d3 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,15 @@ If `pip` is not found try using `python -m pip install` instead. ## Arduino dependencies ESP8266 firmare is uploaded using the Arduino IDE. See [this tutorial](https://learn.sparkfun.com/tutorials/esp8266-thing-hookup-guide/installing-the-esp8266-arduino-addon) to setup the Arduino IDE for ESP8266. -cThis [ws2812b i2s library](https://github.com/JoDaNl/esp8266_ws2812_i2s) must be downloaded and installed in the Arduino libraries folder. +This [ws2812b i2s library](https://github.com/JoDaNl/esp8266_ws2812_i2s) must be downloaded and installed in the Arduino libraries folder. -# Setup / Getting Started +# Hardware Connections +The ESP8266 has hardware support for [I²S](https://en.wikipedia.org/wiki/I%C2%B2S) and this peripheral is used by the [ws2812b i2s library](https://github.com/JoDaNl/esp8266_ws2812_i2s) to control the ws2812b LED strip. This signficantly improves performance compared to bit-banging the IO pin. Unfortunately, this means that the LED strip **must** be connected to the RX1 pin, which is not accessible in some ESP8266 modules (such as the ESP-01). + +For the NodeMCU v3 and Adafruit Feather HUZZAH, the location of the RX1 pin is shown in the images below. Many other modules also expose the RX1 pin. + +![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.