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
2016-02-28 14:32:55 -08:00
parent 50b55a6b06
commit 9bf69afde2
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

@@ -1,3 +1,10 @@
# 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. Some Methods (ex. NeoEsp8266Dma800KbpsMethod) require more buffer than others and you should refer to their documentation.
pin - The output pin to use. Note that some platforms and Methods restrict the Pin and thus will ignore this parameter. On Esp8266, Neo800KbpsMethod is the same as NeoEsp8266Dma800KbpsMethod; which has the restriction of using GPIO3 pin only and thus it will ignore this parameter.
# Methods
## void Begin()
This will initialize the NeoPixelBus and prepare it for use. Call this first within Setup().