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
2023-03-30 13:51:39 -07:00
parent 1e0325c2e9
commit 324b4a5a90
1 changed files with 1 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
NeoPixelBus-object.md

@@ -23,60 +23,5 @@ NeoPixelBus<DotStarBgrFeature, DotStarMethod> strip(32, clockPin, dataPin);
```
### [More on FEATUREs](https://github.com/Makuna/NeoPixelBus/wiki/T_COLOR_FEATURE)
# Neo Methods
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 _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.
## 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.
## NeoPixel LED model specific Methods
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.
**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.
* [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)
# DotStar Methods
These platform methods will define "how" the pixels are updated.
## DotStarSpiMethod
This method should only be used with DotStar color features.
It will use the available hardware SPI support for the board you build with.
Generally the clock and data pins are not changeable for hardware support and thus the Pins argument is omitted on the constructor. If the pins are changeable like on the ESP32, then provide the pins to `Begin`.
The hardware pins on the board are often labeled as MOSI for data, and MSCLK or CLK for the clock.
The default SPI clock speed is 10MHz. To use another clock speed, choose one of the following instead of `DotStarSpiMethod`:
```
DotStarSpi40MhzMethod
DotStarSpi20MhzMethod
DotStarSpi10MhzMethod
DotStarSpi2MhzMethod
DotStarSpi1MhzMethod
DotStarSpi500KhzMethod
```
## DotStarMethod
This method should only be used with DotStar color features. It will use two provided pins for clock and data to implement a software SPI.
## 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-DotStar-Methods)
### [More on METHODs](https://github.com/Makuna/NeoPixelBus/wiki/T_METHOD)