aboutsummaryrefslogtreecommitdiffstats
path: root/docs/ws2812_driver.md
diff options
context:
space:
mode:
authorGravatar Joshua Diamond <josh@windowoffire.com>2020-06-19 22:59:28 -0400
committerGravatar GitHub <noreply@github.com>2020-06-20 12:59:28 +1000
commit18e561b82cdb71bed0162b3ce4083a2d269e5336 (patch)
tree6e016ac5a1e8cbca871b04646e477307dc366280 /docs/ws2812_driver.md
parentc7851484457e5ab604962ae7c914b863b8de0cb2 (diff)
downloadqmk_firmware-18e561b82cdb71bed0162b3ce4083a2d269e5336.tar.gz
Fix incorrect delay when setting WS2812 (and similar) leds (#9302)
* Fix incorrect delay when setting WS2812 (and similar) leds * Add documentation for WS2812_DELAY_MICROSECONDS * Remove improper cast to uint8_t Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * Remove unneeded cast to uint8_t and correct math Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * microseconds -> µs Co-authored-by: Ryan <fauxpark@gmail.com> * Make documentation better match the spec sheet. Co-authored-by: Ryan <fauxpark@gmail.com> * Rename macro to match spec sheet * Further correction to the delay maths for the SPI case. Co-authored-by: Joel Challis <git@zvecr.com> * Move ws2812_common.h to the drivers directory * Revert "Further correction to the delay maths for the SPI case." This reverts commit e61b56a2cfc7dfec9992a7a3af92afa50e5b8ec0. * Remove ws2812_setleds_pin(); consolidate ws2812.h Co-authored-by: Sergey Vlasov <sigprof@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com>
Diffstat (limited to 'docs/ws2812_driver.md')
-rw-r--r--docs/ws2812_driver.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/ws2812_driver.md b/docs/ws2812_driver.md
index fe5f88585..941e1bde0 100644
--- a/docs/ws2812_driver.md
+++ b/docs/ws2812_driver.md
@@ -19,6 +19,15 @@ These LEDs are called "addressable" because instead of using a wire per color, e
## Driver configuration
+### All drivers
+
+Different versions of the addressable LEDs have differing requirements for the T<sub>RST</sub> period between frames.
+The default setting is 280 µs, which should work for most cases, but this can be overridden in your config.h. e.g.:
+
+```c
+#define WS2812_TRST_US 80
+```
+
### Bitbang
Default driver, the absence of configuration assumes this driver. To configure it, add this to your rules.mk: