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 Neo Methods (markdown)

Michael Miller
2023-04-03 15:07:12 -07:00
parent 8ca89156d4
commit a5de2a40e0
1 changed files with 27 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
Neo-Methods.md

@@ -1,27 +1,34 @@
Below you will find the list of Neo Methods. They should only be used with Neo Features. While an attempt has been made to keep this list up to date, new methods may not be listed.
There is a large selection of NeoPixel Methods to pick from. They should only be used with Neo Features. The names of them come in two variety, the basic and the platform specific named. Each with an optional "Inverted" version.
## Neo800KbpsMethod
The Neo800KbpsMethod _was_ the standard one to use with most Arduino boards and for most NeoPixel LED models.
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.
### The basic named:
**"Neo\<insert LED name\>Method"**
Simply insert the model name of your LED between "Neo" and "Method" and more than likely you will find a method that works for you.
* NeoWs2812xMethod - (WS2812a, WS2812b, WS2812c, etc) The most compatible and if yours isn't listed below a good first selection.
* NeoWs2812Method - (WS2812) An older model pre WS2812b.
* NeoWs2813Method - (WS2813)
* NeoWs2811Method - (WS2811) Standalone chip. Also used with a SevenSegmentFeature when several drive a 7-segment LED.
* NeoWs2816Method - (WS2816)
* NeoSk6812Method - (SK6812) A RGBW variant, make sure to use a RGBW color feature.
* NeoLc8812Method - (LC8812)
* NeoApa106Method - (APA106)
* NeoTx1812Method - (TX1812)
* NeoTm1814Method - (TM1814) A RGBW variant, used with NeoWrgbTm1814Feature.
* NeoTm1914Method - (TM1914) used with NeoRgbTm1914Feature.
* NeoTm1829Method - (TM1829)
* Neo400KbpsMethod - old slower speed standard that started this all.
## Neo400KbpsMethod
Same as Neo800KbpsMethod but running at the older and slower data rate. It will be very rare that you need to use this method.
And each of the above will often come in inverted versions that will invert the output signal for the use a simple level shifter solutions.
* NeoWs2812xInvertedMethod - (WS2812a, WS2812b, WS2812c, etc)
* NeoTx1812InvertedMethod - (TX1812)
## NeoPixel LED model specific Methods
Use one of these methods that are more specific to the NeoPixel LED model that you have.
### The platform specific named:
**"Neo\<insert platform\>\<insert hardware detail\>\<insert LED name\>Method"**
In most cases the above basic named methods 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. Here are just a few examples.
* NeoEsp8266BitBangWs2812xMethod - ESP8266 platform, using BitBang to drive output, for the WS2812x model LEDs.
* NeoEsp32Rmt6Ws2812xMethod - ESP32 platform, using RMT peripheral on channel 6, for the WS2812x model LEDs.
* NeoNrf52xPwmNWs2812xMethod - NRF52x platform, using PWM peripheral with a run time selected channel, for the WS2812x model LEDs.
**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 NeoWs2812xMethod, saving 250us per frame. But it is primarily compatible with older model LEDs.
**NeoWs2812xMethod** - WS2812b or other latter variances to the WS2812.
**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 NeoWs2812xMethod, 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 bus speeds that are commonly found.
**NeoTm1814Method** - This method is specific to Tm1814 unique protocol and must be used with the Tm1814 features.
## 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.
Currently supported platforms and their 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)
* [Nano 33 BLE (NRF52840) Platform specific methods](https://github.com/Makuna/NeoPixelBus/wiki/Nano-33-BLE-NeoMethods)