diff --git a/NeoPixelBus-object.md b/NeoPixelBus-object.md index 6de302d..e653a28 100644 --- a/NeoPixelBus-object.md +++ b/NeoPixelBus-object.md @@ -21,65 +21,7 @@ If you want to drive DotStars using software SPI, use the following to create a ``` NeoPixelBus 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.** - -## 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. - -## NeoGrbwFeature -A four element color in the order of Green, Red, Blue, and then White. A common four element format. This is used for SK6812rgbw pixels that have the separate white led in them. - -## NeoRgbFeature -A three element color in the order of Red, Green, and then Blue. Some older pixels used this. Also used by pixels that come in a traditional LED shape rather than the surface mount chip we often see today. - -## NeoRgbwFeature -A four element color in the order of Red, Green, Blue, and then White. A common four element format. - -## NeoBrgFeature -A three element color in the order of Blue, Red, and then Green. - -## NeoRbgFeature -A three element color in the order of Red, Blue, and then Green. - -# Custom Features -These "feature" objects are used in parallel with specific "methods". - -## 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. -These are only used 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. - -### DotStarLbgrFeature -Similar to the DotStarBgrFeature, except that it exposes the DotStar feature of a "luminance" value of 0-31. This will require the use of the RgbwColor object and the W element must be set to provide a luminance override on the pixel. -NOTE: Use of any luminance other than 31 will cause the update rate on the LEDs to be slowed, and thus not useful for POV displays. - -### DotStarGrbFeature -A three element color in the order of Green, Red, and then Blue. Used only with DotStar methods. - -### DotStarLgrbFeature -Similar to the DotStarGrbFeature, except that it exposes the DotStar feature of a "luminance" value of 0-31. This will require the use of the RgbwColor object and the W element must be set to provide a luminance override on the pixel. -NOTE: Use of any luminance other than 31 will cause the update rate on the LEDs to be slowed, and thus not useful for POV displays. - -## Tm1814 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. -These are only used with Tm1814 methods. -**If you do not see what you require, request it by creating an issue on GitHub.** - -### NeoWrgbTm1814Feature -A four element color in the order of White, Red, Green, and then Blue. -This will require that you apply settings that define the power usage of your LEDs. You can set this after calling `Begin()` by using the following code snippit. The values are in 1/10th milliamps and should be updated to the rating of your LEDs. -``` -strip.SetPixelSettings(NeoTm1814Settings(165,165,165,165)); -``` +### [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.