From 8ca89156d47b5f013179219fb89617e27a16abdd Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Mon, 3 Apr 2023 10:33:05 -0700 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 a262cab..5fedb4e 100644 --- a/NeoPixelBus-object-API.md +++ b/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\(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\(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.