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
2019-12-09 10:50:36 -08:00
parent 48cba84642
commit 05dbc794b5
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
NeoPixelBus-object.md

@@ -1,6 +1,6 @@
See [NeoPixelBus object API Reference](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBus-object-API) for more details on the methods exposed.
This object will be used to set colors on the pixels. When constructed, a ["feature"](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBus-object#neo-features) and a ["method"](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBus-object#neo-methods) object must be supplied to define which pixels you are using and how they are updated.
This is the primary object that is used to set colors on the pixels. When constructed, a ["feature"](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBus-object#neo-features) and a ["method"](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBus-object#neo-methods) object must be supplied to define which pixels you are using and how they are updated.
```
NeoPixelBus<FEATURE, METHOD> strip(pixelCount, pixelPin);
```
@@ -25,7 +25,7 @@ NeoPixelBus<DotStarBgrFeature, DotStarMethod> strip(32, clockPin, dataPin);
# Neo Features
These "feature" objects will be used to define what color order is used for the pixels and what color size (rgb, or rgbw).
Currently there are only a few sizes and color formats.
If you do not see what you require, request it by creating an issue on GitHub.
**If you do not see what you require, request it by creating an issue on GitHub.**
## NeoGrbFeature
A three element color in the order of Green, Red, and then Blue. The most common three element format. This is used for SK6812(grb), WS2811, and WS2812.
@@ -47,9 +47,8 @@ A three element color in the order of Red, Blue, and then Green.
# DotStar Features
These "feature" objects will be used to define what color order is used for the pixels and what color size (rgb, or rgbw).
Currently there are only a few sizes and color formats. Used only with DotStar methods.
If you do not see what you require, request it by creating an issue on GitHub.
Currently there are only a few sizes and color formats. Used only with DotStar methods.
**If you do not see what you require, request it by creating an issue on GitHub.**
## DotStarBgrFeature
A three element color in the order of Blue, Green, and then Red. Used only with DotStar methods.
@@ -69,7 +68,7 @@ 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 and for most NeoPixel led models.
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) for details.
@@ -79,6 +78,7 @@ Same as Neo800KbpsMethod but running at the older and slower data rate.
## 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.
**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.
**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.