From 1e0325c2e9ec9bc9d89cde83805f7a6c5be21279 Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Thu, 30 Mar 2023 13:50:34 -0700 Subject: [PATCH] Created DotStar Methods (markdown) --- DotStar-Methods.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 DotStar-Methods.md diff --git a/DotStar-Methods.md b/DotStar-Methods.md new file mode 100644 index 0000000..36ed544 --- /dev/null +++ b/DotStar-Methods.md @@ -0,0 +1,26 @@ +Below you will find the list of DotStar Methods. They should only be used with DotStar Features. While an attempt has been made to keep this list up to date, new methods may not be listed. + +## DotStarSpiMethod +This method should only be used with DotStar color features. +It will use the available hardware SPI support for the board you build with. +Generally the clock and data pins are not changeable for hardware support and thus the Pins argument is omitted on the constructor. If the pins are changeable like on the ESP32, then provide the pins to `Begin`. +The hardware pins on the board are often labeled as MOSI for data, and MSCLK or CLK for the clock. + +The default SPI clock speed is 10MHz. To use another clock speed, choose one of the following instead of `DotStarSpiMethod`: + +``` +DotStarSpi40MhzMethod +DotStarSpi20MhzMethod +DotStarSpi10MhzMethod +DotStarSpi2MhzMethod +DotStarSpi1MhzMethod +DotStarSpi500KhzMethod +``` + +## DotStarMethod +This method should only be used with DotStar color features. It will use two provided pins for clock and data to implement a software SPI. + +## Platform specific Methods +In most cases the above should be all the methods you need to use for all platforms. In a few cases, there are alternative methods that are useful to use on some platforms. Below are links to the platform specific methods. +* [Esp32 Platform specific methods](https://github.com/Makuna/NeoPixelBus/wiki/ESP32-DotStar-Methods) +