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

Updated NeoPixelBus object (markdown)

Michael Miller
2022-03-03 13:16:17 -08:00
parent 70c51a6edc
commit 8e7e596258
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
NeoPixelBus-object.md

@@ -85,23 +85,23 @@ strip.SetPixelSettings(NeoTm1814Settings(165,165,165,165));
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. 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 ## Neo800KbpsMethod
The Neo800KbpsMethod is the standard one to use with most Arduino boards and for most NeoPixel LED models. The Neo800KbpsMethod _was_ 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. It is now recommended to use the newer LED model specific methods, like NeoWs2811xMethod.
On the Esp8266 using this Method has a Pin restriction. Please review [NeoEsp8266Dma800KbpsMethod](https://github.com/Makuna/NeoPixelBus/wiki/ESP8266-NeoMethods#neoesp8266dma800kbpsmethod) 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 ## Neo400KbpsMethod
Same as Neo800KbpsMethod but running at the older and slower data rate. Same as Neo800KbpsMethod but running at the older and slower data rate. It will be very rare that you need to use this method.
## NeoPixel LED model specific Methods ## NeoPixel LED model specific Methods
If you are having issues with the general speed methods, then you can use one of these methods that are more specific to the NeoPixel LED model that you have. Generally you should use these but often they are not required. Use one of these methods that are more specific to the NeoPixel LED model that you have.
**NeoWs2811Method** - This method is meant to be used with the external chip Ws2811 that drives separate LEDs. You will see a surface mount chip mounted on the strip. **NeoWs2811Method** - This method is meant to be used with the external chip Ws2811 that drives separate LEDs. You will see a surface mount chip mounted on the strip.
**NeoWs2812Method** - This method has a short reset time compared to Neo800KbpsMethod, saving 250us per frame. But it is primarily compatible with older model LEDs. **NeoWs2812Method** - This method has a short reset time compared to NeoWs2812xMethod, 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. **NeoWs2812xMethod** - WS2812b or other latter variances to the WS2812.
**NeoWs2813Method** - 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 NeoWs2812xMethod.
**NeoSk6812Method** - This method has a short reset time compared to Neo800KbpsMethod, saving 220us per frame. **NeoSk6812Method** - This method has a short reset time compared to NeoWs2812xMethod, saving 220us per frame.
**NeoLc8812Method** - This method has a short reset time compared to Neo800KbpsMethod, saving 220us per frame. **NeoLc8812Method** - This method has a short reset time compared to NeoWs2812xMethod, saving 220us per frame.
**NeoApa106Method** - This method has a short reset time and pulse lengths that sit between 800Kbps and 400Kbps. **NeoApa106Method** - This method has a short reset time and pulse lengths that sit between 800Kbps and 400Kbps bus speeds that are commonly found.
**NeoTm1814Method** - This method is specific to Tm1814 unique protocol and must be used with the Tm1814 features. **NeoTm1814Method** - This method is specific to Tm1814 unique protocol and must be used with the Tm1814 features.
## Platform specific Methods ## Platform specific Methods