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 NeoPixelBus object API (markdown)

Michael Miller
2023-04-03 10:33:05 -07:00
parent 3fc8c04ff6
commit 8ca89156d4
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
NeoPixelBus-object-API.md

@@ -12,6 +12,13 @@ This will define the object with the given Feature and Method, and construct it
> * _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\<T_COLOR_FEATURE, T_METHOD\>(uint16_t countPixels, uint8_t pin, NeoBusChannel channel)
This will define the object with the given Feature and Method, and construct it to handle the countPixels on the given pin. Further, it takes the Methods multiplex channel to use for this instance. Not all methods support the channel feature.
> * _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.
> * _channel_ - The channel number defined by the enum NeoBusChannel to use.
### NeoPixelBus\<T_COLOR_FEATURE, T_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.