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

Normalize API doc style

Nick Benik
2018-12-21 17:01:26 -05:00
parent 5f3a08d20b
commit 51febe86aa
1 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
NeoPixelBus-object-API.md

@@ -1,20 +1,20 @@
# Constructors
### NeoPixelBus\<FEATURE, METHOD\>(uint16_t countPixels, uint8_t pin)
This will define the object with the given Feature and Method, and construct it to handle the countPixels on the given pin.
_countPixels_ - The number of pixels on the physical bus. This is limited primarily by memory to contain a buffer for them.
_pin_ - The output pin to use. Note that some platforms and Methods restrict the Pin and thus this constructor should not be used on them. On Esp8266 use the constructor that omits the pin.
> * _countPixels_ - The number of pixels on the physical bus. This is limited primarily by memory to contain a buffer for them.
> * _pin_ - The output pin to use. Note that some platforms and Methods restrict the Pin and thus this constructor should not be used on them. On Esp8266 use the constructor that omits the pin.
### NeoPixelBus\<FEATURE, METHOD\>(uint16_t countPixels)
This will define the object with the given Feature and Method, and construct it to handle the countPixels using a hardware defined pin.
For Esp8266 this is the constructor to use.
For DotStar using SPI this is the constructor to use.
_countPixels_ - The number of pixels on the physical bus. This is limited primarily by memory to contain a buffer for them. Some Methods (ex. NeoEsp8266Dma800KbpsMethod) require more buffer than others and you should refer to their documentation.
> * _countPixels_ - The number of pixels on the physical bus. This is limited primarily by memory to contain a buffer for them. Some Methods (ex. NeoEsp8266Dma800KbpsMethod) require more buffer than others and you should refer to their documentation.
### NeoPixelBus\<FEATURE, METHOD\>(uint16_t countPixels, uint8_t pinClock, uint8_t pinData)
This will define the object with the given Feature and Method, and construct it to handle the countPixels on the given clock and data pins. This is used with DotStars only.
_countPixels_ - The number of pixels on the physical bus. This is limited primarily by memory to contain a buffer for them.
_pinClock_ - The clock output pin to use.
_pinData_ - The data output pin to use.
> * _countPixels_ - The number of pixels on the physical bus. This is limited primarily by memory to contain a buffer for them.
> * _pinClock_ - The clock output pin to use.
> * _pinData_ - The data output pin to use.
# Methods
### void Begin()
@@ -53,60 +53,60 @@ This will return the number pixels the NeoPixelBus manages. This value was pass
### void SetPixelColor(uint16_t indexPixel, ColorObject color)
This will set the color for the given pixel.
_indexPixel_ - the pixel number
_color_ - a color object to use, RgbColor, HslColor, and HsbColor will all work and if the NeoPixelBus object was created with the NeoRgbwFeature the RgbwColor will also work.
> * _indexPixel_ - the pixel number
> * _color_ - a color object to use, RgbColor, HslColor, and HsbColor will all work and if the NeoPixelBus object was created with the NeoRgbwFeature the RgbwColor will also work.
### ColorObject GetPixelColor(uint16_t indexPixel)
This will return the color for the given pixel.
_indexPixel_ - the pixel number
\<return\>, a color object, RgbColor or RgbwColor.
> * _indexPixel_ - the pixel number
> * \<return\>, a color object, RgbColor or RgbwColor.
### void ClearTo(ColorObject color)
This will clear all pixels to the given color.
_color_ - a color object to use, RgbColor, HslColor, and HsbColor will all work and if the NeoPixelBus object was created with the NeoRgbwFeature the RgbwColor will also work.
> * _color_ - a color object to use, RgbColor, HslColor, and HsbColor will all work and if the NeoPixelBus object was created with the NeoRgbwFeature the RgbwColor will also work.
### void ClearTo(ColorObject color, uint16_t first, uint16_t last)
This will clear all pixels from first to last to the given color.
_color_ - a color object to use, RgbColor, HslColor, and HsbColor will all work and if the NeoPixelBus object was created with the NeoRgbwFeature the RgbwColor will also work.
_first_ - the index to the first pixel to start clearing
_last_ - the index to the last pixel that will be cleared
> * _color_ - a color object to use, RgbColor, HslColor, and HsbColor will all work and if the NeoPixelBus object was created with the NeoRgbwFeature the RgbwColor will also work.
> * _first_ - the index to the first pixel to start clearing
> * _last_ - the index to the last pixel that will be cleared
### void RotateLeft(uint16_t rotationCount)
This will rotate all the pixels by the given number of pixels. The pixels on the left will wrap around to the right side.
_rotationCount_ - the number of pixels to rotate left.
> * _rotationCount_ - the number of pixels to rotate left.
### void RotateLeft(uint16_t rotationCount, uint16_t first, uint16_t last)
This will rotate all the pixels in the given range by the given number of pixels. The pixels on the left will wrap around to the right side.
_rotationCount_ - the number of pixels to rotate left.
_first_ - the first pixel to include in the rotation.
_last_ - the last pixel to include in the rotation.
> * _rotationCount_ - the number of pixels to rotate left.
> * _first_ - the first pixel to include in the rotation.
> * _last_ - the last pixel to include in the rotation.
### void ShiftLeft(uint16_t shiftCount)
This will shift all the pixels by the given number of pixels. The first `shiftCount` pixels on right will be left alone.
_shiftCount_ - the number of pixels to shift left.
> * _shiftCount_ - the number of pixels to shift left.
### void ShiftLeft(uint16_t shiftCount, uint16_t first, uint16_t last)
This will shift all the pixels in the given range by the given number of pixels. The first `shiftCount` pixels on right will be left alone.
_shiftCount_ - the number of pixels to shift left.
_first_ - the first pixel to include in the shift.
_last_ - the last pixel to include in the shift.
> * _shiftCount_ - the number of pixels to shift left.
> * _first_ - the first pixel to include in the shift.
> * _last_ - the last pixel to include in the shift.
### void RotateRight(uint16_t rotationCount)
This will rotate all the pixels by the given number of pixels. The pixels on the right will wrap around to the left side.
_rotationCount_ - the number of pixels to rotate left.
> * _rotationCount_ - the number of pixels to rotate left.
### void RotateRight(uint16_t rotationCount, uint16_t first, uint16_t last)
This will rotate all the pixels in the given range by the given number of pixels. The pixels on the right will wrap around to the left side.
_rotationCount_ - the number of pixels to rotate left.
_first_ - the first pixel to include in the rotation.
_last_ - the last pixel to include in the rotation.
> * _rotationCount_ - the number of pixels to rotate left.
> * _first_ - the first pixel to include in the rotation.
> * _last_ - the last pixel to include in the rotation.
### void ShiftRight(uint16_t shiftCount)
This will shift all the pixels by the given number of pixels. The first `shiftCount` pixels on left will be left alone.
_shiftCount_ - the number of pixels to shift right.
> * _shiftCount_ - the number of pixels to shift right.
### void ShiftRight(uint16_t shiftCount, uint16_t first, uint16_t last)
This will shift all the pixels in the given range by the given number of pixels. The first `shiftCount` pixels on left will be left alone.
_shiftCount_ - the number of pixels to shift right.
_first_ - the first pixel to include in the shift.
_last_ - the last pixel to include in the shift.
> * _shiftCount_ - the number of pixels to shift right.
> * _first_ - the first pixel to include in the shift.
> * _last_ - the last pixel to include in the shift.