Makuna/NeoPixelBus
1
0
Fork 1
mirror of https://github.com/Makuna/NeoPixelBus.git synced 2025-08-10 06:14:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated NeoPixelBus object API (markdown)

Michael Miller
2019-02-05 15:52:43 -08:00
parent 24b2a595d8
commit 94b31d1f9b
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
NeoPixelBus-object-API.md

@@ -20,6 +20,14 @@ This will define the object with the given Feature and Method, and construct it
### void Begin() ### void Begin()
This will initialize the NeoPixelBus and prepare it for use. Call this first within Setup(). This will initialize the NeoPixelBus and prepare it for use. Call this first within Setup().
### void Begin(int8_t sck, int8_t miso, int8_t mosi, int8_t ss)
This will initialize the NeoPixelBus and prepare it for use. Call this first within Setup().
This is used with DotStars only using the `DotStartSpiMethod` only. Defining the pins here due to the SPI also needing the pins on its `begin`.
> * _sck_ - The clock output pin to use.
> * _miso_ - required by SPI, but not directly used
> * _mosi_ - The data output pin to use.
> * _ss_ - required by SPI, but not directly used
### void Show() ### void Show()
This will try to send the pixel information to the physical pixels. If there has been no change since the last time it was called, nothing will be sent. This will try to send the pixel information to the physical pixels. If there has been no change since the last time it was called, nothing will be sent.
Due to the hardware protocol, if you call this quickly after the last time it was called, it may wait up to 50us extra. Due to the hardware protocol, if you call this quickly after the last time it was called, it may wait up to 50us extra.