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
2018-09-25 11:35:36 -07:00
parent 11a45af69f
commit 887261417d
1 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
NeoPixelBus-object.md

@@ -69,18 +69,23 @@ NOTE: Use of any luminance other than 31 will cause the update rate on the LEDs
These platform methods will define "how" the pixels are updated. While primarily used to define how fast the data is sent out to support older pixels; for the Esp8266 it also defines the several methods required based on different form factors due to pin restrictions and exposed pins on the boards.
## Neo800KbpsMethod
The Neo800KbpsMethod is the standard one to use with most Arduino boards.
The Neo800KbpsMethod is the standard one to use with most Arduino boards and for most NeoPixel led models.
It will automatically pick board specific defaults and this should be the one used unless otherwise needed.
On the Esp8266 using this Method has a Pin restriction. Please review [NeoEsp8266Dma800KbpsMethod](https://github.com/Makuna/NeoPixelBus/wiki/ESP8266-NeoMethods#neoesp8266dma800kbpsmethod) below for details.
On the Esp8266 using this Method has a Pin restriction. Please review [NeoEsp8266Dma800KbpsMethod](https://github.com/Makuna/NeoPixelBus/wiki/ESP8266-NeoMethods#neoesp8266dma800kbpsmethod) for details.
## 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/ESP8266-NeoMethods#neoesp8266dmaws2813method) below for details.
## NeoPixel LED model specific Methods
If you are wanting to gain the slightest more frame rate, then you can provide methods that are more specific to the NeoPixel LED model that you have. Generally you should not need these but they are listed for advanced users to test with.
## Platform specific
**NeoWs2812Method** - This method has a short reset time compared to Neo800KbpsMethod, saving 250us per frame. But it is primarily compatible with older model LEDs.
**NeoWs2812xMethod** - WS2812b or other letter variances to the WS2812. While the name is more specific, there is no difference between this and Neo800KbpsMethod.
**NeoWs2813Method** - While the name is more specific, there is no difference between this and Neo800KbpsMethod.
**NeoSk6812Method** - This method has a short reset time compared to Neo800KbpsMethod, saving 220us per frame.
**NeoLc8812Method** - This method has a short reset time compared to Neo800KbpsMethod, saving 220us per frame.
## Platform specific Methods
In most cases the above should be all the methods you need to use for all platforms. In a few cases, there are alternative methods that are useful to use on some platforms. Below are links to the platform specific methods.
* [Esp32 Platform specific methods](https://github.com/Makuna/NeoPixelBus/wiki/ESP32-NeoMethods)
* [Esp8266 Platform specific methods](https://github.com/Makuna/NeoPixelBus/wiki/ESP8266-NeoMethods)