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-07-03 18:07:15 -07:00
parent daaca9ede5
commit bd4438bdc0
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
NeoPixelBus-object.md

@@ -80,6 +80,8 @@ NOTE: Due to the varied board layouts for Esp8266, even though the pin maybe ex
This method uses the CPU to manage a small hardware managed UART buffer to send the data to the NeoPixels. Thus it requires more CPU overhead than the Dma method but it does NOT require an extra buffer. Its main benefit is that it is usable on ESP-01.
If cpu cycles are an issue in your project, see NeoEsp8266AsyncUart800KbpsMethod below.
Due to using the TXD1/GPIO2 pin, the Serial1 object can not be used with the method and must be avoided. The primary serial object "Serial" is available for both read and write.
Use this instead of Neo800KbpsMethod to force your sketch to use the Uart to send data.
@@ -88,6 +90,23 @@ Use this instead of Neo800KbpsMethod to force your sketch to use the Uart to sen
Same as NeoEsp8266Uart800KbpsMethod but running at the older and slower data rate.
Use this instead of Neo400KbpsMethod to force your sketch to use the Uart to send data.
## NeoEsp8266AsyncUart800KbpsMethod
NeoEsp8266AsyncUart800KbpsMethod only supports the TXD1/GPIO2 pin. The Pin value passed into the constructor is ignored.
NOTE: Due to the varied board layouts for Esp8266, even though the pin maybe exposed, it may not be usable due to some custom feature on the board you use. If you find it not working, you should review the hardware schematic of your board and confirm the pin is not used for other purposes that interferes with it being used for NeoPixelBus.
This method uses the UART interrupt to read from a secondary buffer to send the data to the NeoPixels. It requires very little CPU overhead but does require an extra buffer similar to the Dma method. Its main benefit is that it is usable on ESP-01 or other projects where the pin used by the DMA method is not available.
If memory is an issue for your project, see the NeoEsp8266Uart800KbpsMethod above.
Due to using the TXD1/GPIO2 pin, the Serial1 object can not be used with the method and must be avoided. The primary serial object "Serial" is available for both read and write.
Use this instead of Neo800KbpsMethod to force your sketch to use the Uart to send data asynchronously.
## NeoEsp8266AsyncUart400KbpsMethod
Same as NeoEsp8266AsyncUart800KbpsMethod but running at the older and slower data rate.
Use this instead of Neo400KbpsMethod to force your sketch to use the Uart to send data asynchronously.
## NeoEsp8266BitBang800KbpsMethod
NeoEsp8266BitBang800KbpsMethod supports any available pin between 0 and 15.
This method uses only the CPU to send data to the NeoPixels. But due to WiFi interrupts it is not stable when used with WiFi features of the Esp8266.