Merge branch 'master' of https://github.com/rorosaurus/esp32-hub75-driver

Author: rorosaurus

README.md

@@ -1,23 +1,67 @@
 # Use a ESP32-DEVKIT-V1 to drive HUB75 LED panels using SmartMatrix library
 
+Inspired by Adafruit's [RGB Matrix Featherwing Kit](https://www.adafruit.com/product/3036) or [Teensy SmartMatrix Shield](https://www.adafruit.com/product/1902)! But cheaper and more powerful, with Wifi/BT!
+
+This shield only works with [SmartMatrix](https://github.com/pixelmatix/SmartMatrix/tree/teensylc), not [PxMatrix](https://github.com/2dom/PxMatrix).
+
+If you want to work with PxMatrix, I highly recommend checking out [Brian Lough's shields](https://www.tindie.com/stores/brianlough/)! They are designed much better than mine!
+
+I simply prefer SmartMatrix, which is why I designed this shield. There are [some shields in the SmartMatrix repo](https://github.com/pixelmatix/SmartMatrix/tree/teensylc/extras/hardware) but these appear to be active and require extra components. My shield is passive and just connects the pins to the right place. It lacks a proper level-shifter, so it assumes your panel will accept the 3.3V logic from the ESP32. It also lacks an external latch, which those active shields use to free up a few more pins on your ESP32.
+
 ## Features
 * Connects all necessary pins to drive HUB75 panels using `ESP32_FORUM_PINOUT` from [MatrixHardware_ESP32_V0.h](https://github.com/pixelmatix/SmartMatrix/blob/teensylc/src/MatrixHardware_ESP32_V0.h)
 * 2x screw terminals to allow you to share 5V from the microUSB to your panels.
   * Traces are wide enough to support 5V@3A total
 * Optional room for 1x Electrolytic Capacitor (I use a 16V 1000uF) to smooth the 5V power
 * 2x4 pins for additional GPIO use: 
   * 2x GND
-  * 2x 3.3V
+  * 2x 3.3V (The devkit's LDO supplies up to 1A total.  ESP-WROOM-32 module uses 1A max but Espressif recommends assuming 0.5A.)
   * 4x GPIO with ADC functionality (for buttons, potentiometers, etc.)
 * Only one 16 pin IDC output, but this should support multiple HUB75 panels daisy-chained in series
 
+## Hardware
+
+### Required:
+* ESP32-DEVKIT-V1: [Amazon ($7)](https://smile.amazon.com/gp/product/B07Q576VWZ/), [AliExpress ($4)](https://www.aliexpress.com/item/32902307791.html)
+* If you want this PCB to plug directly into the panel:
+  * Female Pin Header 2X8 (connects this driver to the HUB75 panel): [Amazon](https://smile.amazon.com/gp/product/B07VJ3JCLT/), [AliExpress](https://www.aliexpress.com/item/32747224548.html)
+* If you want this PCB to plug into your panel via a IDC ribbon cable:
+  * 16P IDC Socket: [Amazon](https://smile.amazon.com/gp/product/B010V43ACO/), [AliExpress](https://www.aliexpress.com/item/32841491526.html)
+  * 16P IDC Cable (might have come with your panel): [AliExpress](https://www.aliexpress.com/item/32873766356.html)
+* Any HUB75 type scan LED panel (E pin is connected, so should work with 1/32 panels too)
+
+### Optional:
+* If you want easy disconnect for ESP32:
+  * 15 Pin Single Row Female Pin Header (buy 2): [AliExpress](https://www.aliexpress.com/item/32962790286.html)
+* If you want easy disconnect for panel power:
+  * Power cables for HUB75 panels (might have come with your panel): [AliExpress](https://www.aliexpress.com/item/32832930794.html)
+  * Screw terminals (up to 2 can be used to easily wire power to the panels): [AliExpress](https://www.aliexpress.com/item/32993227789.html)
+* If you want easy jumper wire access to the 8 extra GPIO and power pins:
+  * Female Pin Header 2X4: [AliExpress](https://www.aliexpress.com/item/32785938092.html)
+* If you want to smooth the power spikes (might prolong device lifespan or prevent brownouts):
+  * Electrolytic Capacitor 16V 1000uF: [AliExpress](https://www.aliexpress.com/item/32812085542.html)
+
 ## Software
 I would recommend using the following software with this board:
-* https://github.com/espressif/arduino-esp32 - To program ESP32 boards using Arduino
-* https://github.com/pixelmatix/SmartMatrix/tree/teensylc - The library that helps you talk to the LED panel
-* https://github.com/marcmerlin/AnimatedGIFs - Marc worked hard to make it relatively simple to use SmartMatrix to output animated .gifs
-* https://github.com/me-no-dev/arduino-esp32fs-plugin - This plugin makes it simple to upload .gifs to your ESP32
-* Use your preferred image editor to make your animated .gifs!
+* https://www.arduino.cc/en/Main/Software - The Arduino IDE, to program everything!
+  * https://github.com/espressif/arduino-esp32 - Install board manager support for ESP32
+  * https://github.com/me-no-dev/arduino-esp32fs-plugin - This Arduino IDE plugin makes it simple to upload .gifs to your ESP32
+* https://github.com/marcmerlin/AnimatedGIFs - This code is a good starting point for your program. It uses the above software and libraries to playback animated .gifs for you! You can easily adjust things like the time between switching .gifs. You'll need to install (by downloading and copying to `My Documents/Arduino/libraries`) a few libraries that it uses:
+  * https://github.com/pixelmatix/SmartMatrix/tree/teensylc
+  * https://github.com/adafruit/Adafruit-GFX-Library
+  * https://github.com/marcmerlin/Framebuffer_GFX
+  * https://github.com/FastLED/FastLED
+  * https://github.com/marcmerlin/SmartMatrix_GFX
+
+* Use your preferred image editor to make your animated .gifs! I used Photoshop, but you could also use GIMP or something!
 
 ## Design
+Gerber file download: [/gerber/esp32-hub75-driver.zip](https://github.com/rorosaurus/esp32-hub75-driver/blob/master/gerber/esp32-hub75-driver.zip)
 ![](gerber/esp32-hub75-driver.png)
+
+## Other hardware you might want
+* Project Mc2 LED Purse (harvest a cheap 16x32px LED display): [Amazon](https://smile.amazon.com/dp/B071LQR2QG/), [Adafruit article](https://blog.adafruit.com/2019/03/06/issue-16-hackspace-magazine-can-i-hack-it-a-smart-pixel-purse-neopixels-making-hackspacemag-biglesp/)
+  * If you want to daisy-chain this display, it's missing an output socket:
+    * SMT 2x8 Male IDC Socket: [AliExpress](https://www.aliexpress.com/item/32989866598.html)
+* If you want to daisy-chain other displays:
+  * 16P IDC Cable (might have come with your panel): [AliExpress](https://www.aliexpress.com/item/32873766356.html)