diff --git a/NeoPixelBus-object.md b/NeoPixelBus-object.md index 2a9672e..a5df234 100644 --- a/NeoPixelBus-object.md +++ b/NeoPixelBus-object.md @@ -12,6 +12,14 @@ And this will create one that is compatible with an ESP-01. It will manage 32 p ``` NeoPixelBus strip(32, 2); ``` +If you want to drive DotStars instead, use the following to create a bus that uses hardware SPI. +``` +NeoPixelBus strip(32); +``` +If you want to drive DotStars using software SPI, use the following to create a bus and provide the pins for clock and data lines. +``` +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). @@ -36,6 +44,18 @@ 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. +## 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. + +## 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. + # 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. @@ -136,4 +156,11 @@ This work is directly taken from AdaFruit's NeoPixel library and all credit shou ## NeoArm400KbpsMethod Same as NeoArm800KbpsMethod but running at the older and slower data rate. The NeoArm400KbpsMethod is the underlying method that gets used if you use Neo400KbpsMethod on AVR platforms. There should be no need to use it directly. -This work is directly taken from AdaFruit's NeoPixel library and all credit should go to them. \ No newline at end of file +This work is directly taken from AdaFruit's NeoPixel library and all credit should go to them. + +## 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. The clock and data pins are not changeable for hardware support. +The pins are often labeled as MOSI for data, and MSCLK or CLK for the clock. + +## 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. \ No newline at end of file