Makuna/NeoPixelBus
1
0
Fork 1
mirror of https://github.com/Makuna/NeoPixelBus.git synced 2025-08-07 04:44:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated NeoPixelBus object (markdown)

Michael Miller
2016-02-28 14:21:11 -08:00
parent 96a21a76fa
commit 50b55a6b06
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
NeoPixelBus-object.md

@@ -36,14 +36,14 @@ These platform methods will define "how" the pixels are updated. While primaril
## Neo800KbpsMethod
The Neo800KbpsMethod is the standard one to use with most Arduino boards.
It will automatically pick board specific defaults and this should be the one used unless otherwise needed.
For Esp8266, this has a Pin restriction, so please see NeoEsp8266Dma800KbpsMethod below.
On the Esp8266 using this Method has a Pin restriction. Please review NeoEsp8266Dma800KbpsMethod below for details.
## Neo400KbpsMethod
Same as Neo800KbpsMethod but running at the older and slower data rate.
## NeoEsp8266Dma800KbpsMethod
The NeoEsp8266Dma800KbpsMethod is the underlying method that gets used if you use Neo800KbpsMethod on Esp8266 platforms. There should be no need to use it directly.
The NeoEsp8266Dma800KbpsMethod only supports the RDX0/GPIO3 pin. The Pin value passed into the constructor is ignored.
The NeoEsp8266Dma800KbpsMethod only supports the RDX0/GPIO3 pin. The Pin value passed into the constructor is ignored.
This method uses very little CPU for actually sending the data to NeoPixels but it requires an extra buffer for the DMA to read from. Thus there is a trade off of CPU use versus memory use. The extra buffer needed is four times the size of the primary pixel buffer.
It also requires the use of the RDX0/GPIO3 pin which is not exposed on the ESP-01. See other esp8266 methods below if you don't have this pin available.
Thanks to g3gg0.de for porting the initial DMA support from the original. The original was located at https://github.com/cnlohr/esp8266ws2812i2s. It has been modified dramatically since those originals but credit is due.