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
2020-05-14 13:25:09 -07:00
parent e053f74099
commit bb7feacc01
1 changed files with 21 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
NeoPixelBus-object.md

@@ -45,25 +45,38 @@ 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.
# DotStar Features
# 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. Used only with DotStar methods.
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
### DotStarBgrFeature
A three element color in the order of Blue, Green, and then Red. Used only with DotStar methods.
## DotStarLbgrFeature
### 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
### DotStarGrbFeature
A three element color in the order of Green, Red, and then Blue. Used only with DotStar methods.
## DotStarLgrbFeature
### 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.
# 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.
@@ -84,7 +97,8 @@ If you are having issues with the general speed methods, then you can use one of
**NeoWs2813Method** - While the name is more specific, there is no difference between this and Neo800KbpsMethod.
**NeoSk6812Method** - This method has a short reset time compared to Neo800KbpsMethod, saving 220us per frame.
**NeoLc8812Method** - This method has a short reset time compared to Neo800KbpsMethod, 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.
**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.