summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2020-12-06 06:16:19 +0000
committerQMK Bot <hello@qmk.fm>2020-12-06 06:16:19 +0000
commite199fb619081dddaf76f203b77660f9ba41a30bd (patch)
tree0c439b9a336e9215c5e9580098a1820747bfc49a /docs
parent5cfbfc2c52aabd02733c14ba66c0c77f55506049 (diff)
parentc59f87a5d73a2d8a2085663ae329c4d7c75c83e3 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/ws2812_driver.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/ws2812_driver.md b/docs/ws2812_driver.md
index c1b96329e9..da5db01dbd 100644
--- a/docs/ws2812_driver.md
+++ b/docs/ws2812_driver.md
@@ -28,6 +28,17 @@ The default setting is 280 µs, which should work for most cases, but this can b
#define WS2812_TRST_US 80
```
+#### Byte Order
+
+Some variants of the WS2812 may have their color components in a different physical or logical order. For example, the WS2812B-2020 has physically swapped red and green LEDs, which causes the wrong color to be displayed, because the default order of the bytes sent over the wire is defined as GRB.
+In this case, you can change the byte order by defining `WS2812_BYTE_ORDER` as one of the following values:
+
+| Byte order | Known devices |
+|-----------------------------------|-------------------------------|
+| `WS2812_BYTE_ORDER_GRB` (default) | Most WS2812's, SK6812, SK6805 |
+| `WS2812_BYTE_ORDER_RGB` | WS2812B-2020 |
+
+
### Bitbang
Default driver, the absence of configuration assumes this driver. To configure it, add this to your rules.mk: