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
2017-06-18 10:57:01 -07:00
parent 0cca9b659e
commit 140ee24ce6
1 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
NeoPixelBus-object.md

@@ -70,6 +70,10 @@ On the Esp8266 using this Method has a Pin restriction. Please review [NeoEsp826
## Neo400KbpsMethod
Same as Neo800KbpsMethod but running at the older and slower data rate.
## NeoWs2813Method
The NeoWs2813Method primarily expands the delay time to support these new chips. It is fully compatible with Ws2812 and some newer Ws2812b chips may require this method.
On the Esp8266 using this Method has a Pin restriction. Please review [NeoEsp8266DmaWs2813Method](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBus-object#neoesp8266dmaws2813method) below for details.
## NeoEsp32BitBang800KbpsMethod
The NeoEsp32BitBang800KbpsMethod is the underlying method that gets used if you use Neo800KbpsMethod on Esp32 platforms. There should be no need to use it directly.
@@ -80,6 +84,10 @@ This method uses only the CPU to send data to the NeoPixels.
Same as NeoEsp32BitBang800KbpsMethod but running at the older and slower data rate.
The NeoEsp32400KbpsMethod is the underlying method that gets used if you use Neo400KbpsMethod on Esp32 platforms. There should be no need to use it directly.
## NeoEsp32BitBangWs2813Method
Same as NeoEsp32BitBang800KbpsMethod but has the longer delay required these chips.
The NeoEsp32BitBangWs2813Method is the underlying method that gets used if you use NeoWs2813Method on Esp32 platforms. There should be no need to use it directly.
## 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.
@@ -106,6 +114,9 @@ _Thanks to g3gg0.de for porting the initial DMA support from the original which
Same as NeoEsp8266Dma800KbpsMethod but running at the older and slower data rate.
The NeoEsp8266Dma400KbpsMethod is the underlying method that gets used if you use Neo400KbpsMethod on Esp8266 platforms. There should be no need to use it directly.
## NeoEsp8266DmaWs2813Method
Same as NeoEsp8266Dma800KbpsMethod but using a longer delay as required by this chips.
## NeoEsp8266Uart800KbpsMethod
NeoEsp8266Uart800KbpsMethod only supports the TXD1/GPIO2 pin. The Pin argument is omitted.
@@ -123,6 +134,9 @@ 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.
## NeoEsp8266UartWs2813Method
Same as NeoEsp8266Uart800KbpsMethod but using a longer delay as required by this chips.
## NeoEsp8266AsyncUart800KbpsMethod
NeoEsp8266AsyncUart800KbpsMethod only supports the TXD1/GPIO2 pin. The Pin argument is omitted.
@@ -144,6 +158,9 @@ Use this instead of Neo800KbpsMethod to force your sketch to use the Uart to sen
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.
## NeoEsp8266AsyncUartWs2813Method
Same as NeoEsp8266AsyncUart800KbpsMethod but using a longer delay as required by this chips.
## 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.
@@ -154,6 +171,8 @@ Use this instead of Neo800KbpsMethod to force your sketch to use the Bit Banging
Same as NeoEsp8266BitBang800KbpsMethod but running at the older and slower data rate.
Use this instead of Neo400KbpsMethod to force your sketch to use the Bit Banging to send data.
## NeoEsp8266BitBangWs2813Method
Same as NeoEsp8266BitBang800KbpsMethod but using a longer delay as required by this chips.
## NeoAvr800KbpsMethod
The NeoAvr800KbpsMethod is the underlying method that gets used if you use Neo800KbpsMethod on AVR platforms. There should be no need to use it directly.
@@ -164,6 +183,9 @@ Same as NeoAvr800KbpsMethod but running at the older and slower data rate.
The NeoAvr400KbpsMethod is the underlying method that gets used if you use Neo400KbpsMethod on AVR platforms. There should be no need to use it directly.
This work is directly taken from AdaFruit's NeoPixel library and all credit should go to them.
## NeoAvrWs2813Method
Same as NeoAvr800KbpsMethod but using a longer delay as required by this chips.
The NeoAvrWs2813Method is the underlying method that gets used if you use NeoWs2813Method on AVR platforms. There should be no need to use it directly.
## NeoArm800KbpsMethod
The NeoArm800KbpsMethod is the underlying method that gets used if you use Neo800KbpsMethod on ARM platforms. There should be no need to use it directly.
@@ -174,6 +196,9 @@ Same as NeoArm800KbpsMethod but running at the older and slower data rate.
The NeoArm400KbpsMethod is the underlying method that gets used if you use Neo400KbpsMethod on AVR platforms. There should be no need to use it directly.
This work is directly taken from AdaFruit's NeoPixel library and all credit should go to them.
## NeoArmWs2813Method
Same as NeoArm800KbpsMethod but using a longer delay as required by this chips.
The NeoArmWs2813Method is the underlying method that gets used if you use NeoWs2813Method on ARM platforms. There should be no need to use it directly.
## DotStarSpiMethod
This method should only be used with DotStar color features.