Makuna/NeoPixelBus
1
0
Fork 1
mirror of https://github.com/Makuna/NeoPixelBus.git synced 2025-08-07 12:54:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated Home (markdown)

Michael Miller
2016-02-23 13:21:38 -08:00
parent bd8dbc79dd
commit cddad781f5
1 changed files with 2 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
Home.md

@@ -4,28 +4,13 @@ This is an Arduino Library that supports sending out data to update a series of
## Supported Platforms
## Supported Pixels
# API
# Objects exposed
## [NeoPixelBus object](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBus-object)
This object will be used to set colors on the pixels. When constructed a "feature" and a "method" object must be supplied to define which pixels you are using and how they are updated.
### Color objects
## [Color objects](https://github.com/Makuna/NeoPixelBus/wiki/Color-objects)
There are several color objects that can be used to define and blend colors. While all can be directly used to set the pixel color, the RgbwColor can only be used with a NeoPixelBus that has been declared with NeoRgbw feature.
#### RgbColor object
This represents a color as RGB model and exposes useful methods to manipulate colors. This is the native color used and is the most efficient.
The color components are Red, Green, and Blue.
#### RgbwColor object
This represents a color as RGBW model and exposes useful methods to manipulate colors. This is the native color used and is the most efficient.
The color components are Red, Green, Blue, and White.
This can only be used with NeoPixelBus that was declared with a four element color feature like NeoRgbw.
#### HslColor object
This represents a color as HSL model and exposes useful methods to manipulate colors. While not the native color used, the extra overhead will be offset by intuitive color components and effects.
The color components are Hue, Saturation, and Lightness, in the range of 0.0 to 1.0.
To darken the color, just reduce the L property and to brighten the color, just increase the L property.
To randomly pick a color, just randomly pick a Hue and leave Saturation and Lightness the same.
## NeoPixelAnimator object
(still under development)
This manages the animations for a single NeoPixelBus. All time values are by default in milliseconds but can be changed by the timeScale argument on the constructor.