From 9bf69afde2b4e763ff6a6caf32813046481c045b Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Sun, 28 Feb 2016 14:32:55 -0800 Subject: [PATCH] Updated NeoPixelBus object API (markdown) --- NeoPixelBus-object-API.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/NeoPixelBus-object-API.md b/NeoPixelBus-object-API.md index bf653ef..b499653 100644 --- a/NeoPixelBus-object-API.md +++ b/NeoPixelBus-object-API.md @@ -1,3 +1,10 @@ +# Constructors +## NeoPixelBus\(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().