diff options
author | Ryan <[email protected]> | 2024-10-06 19:01:07 +1100 |
---|---|---|
committer | GitHub <[email protected]> | 2024-10-06 21:01:07 +1300 |
commit | 208ebf54a905ce6e4e563a6811eca8c8dc8b17e1 (patch) | |
tree | 7bb6a8bdb5a641263c39236d0b655825ac37307b /docs | |
parent | 43e82ed5c72b7386ca91d1bd363ee092f77c1b9a (diff) | |
download | qmk_firmware-208ebf54a905ce6e4e563a6811eca8c8dc8b17e1.tar.gz qmk_firmware-208ebf54a905ce6e4e563a6811eca8c8dc8b17e1.zip |
WS2812 API rework (#24364)
* Begin WS2812 API rework
* Move RGBW conversion, clean up color.h, fix RGBW for AVR bitbang
* Formatting & update PS2AVRGB I2C driver (untested)
* Tested ARM bitbang RGB+RGBW
* Tested ARM SPI RGB - RGBW not working
* Tested ARM PWM RGB+RGBW
* Tested RP2040 PIO driver RGB+RGBW
* Update RGBLight
* Formatting
* Fix BM60HSRGB rev2
* Fix oddforge/vea
* Fix 1k and XD002 RGBLite
* Fix model_m/mschwingen
* Fix handwired/promethium
* Rename `WS2812_LED_TOTAL` for BM60HSRGB
* Fix work_louder boards
* Fix dawn60
* Fix rgbkb/pan
* Fix neson_design/700e and n6
* Fix ergodox_ez/shine
* ergodox_ez/shine: invert indices for left half
* Fix matrix/abelx
* Fix matrix/m20add
* Remove custom rgblight driver for matrix/noah - should be done with lighting layers
* Fix LED indexes for RGBLight split
* Rename `convert_rgb_to_rgbw()` to `ws2812_rgb_to_rgbw()`
* Update WS2812 API docs
* `ergodox_ez/shine`: simplify LED index calculation
* LED/RGB Matrix: Add weak function for LED index resolution
* Bandaid fix for RGB Matrix splits not using WS2812
* `steelseries/prime_plus`: redo custom RGBLight driver
* Update keyboards/steelseries/prime_plus/rgblight_custom.c
Co-authored-by: Dasky <[email protected]>
---------
Co-authored-by: Dasky <[email protected]>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/drivers/ws2812.md | 45 |
1 files changed, 38 insertions, 7 deletions
diff --git a/docs/drivers/ws2812.md b/docs/drivers/ws2812.md index 64343d3c6a..036ea40d1d 100644 --- a/docs/drivers/ws2812.md +++ b/docs/drivers/ws2812.md @@ -241,13 +241,44 @@ Using a complementary timer output (`TIMx_CHyN`) is possible only for advanced-c ## API {#api} -### `void ws2812_setleds(rgb_led_t *ledarray, uint16_t number_of_leds)` {#api-ws2812-setleds} +### `void ws2812_init(void)` {#api-ws2812-init} -Send RGB data to the WS2812 LED chain. +Initialize the LED driver. This function should be called first. -#### Arguments {#api-ws2812-setleds-arguments} +--- - - `rgb_led_t *ledarray` - A pointer to the LED array. - - `uint16_t number_of_leds` - The length of the LED array. +### `void ws2812_set_color(int index, uint8_t red, uint8_t green, uint8_t blue)` {#api-ws2812-set-color} + +Set the color of a single LED. This function does not immediately update the LEDs; call `ws2812_flush()` after you are finished. + +#### Arguments {#api-ws2812-set-color-arguments} + + - `int index` + The LED index in the WS2812 chain. + - `uint8_t red` + The red value to set. + - `uint8_t green` + The green value to set. + - `uint8_t blue` + The blue value to set. + +--- + +### `void ws812_set_color_all(uint8_t red, uint8_t green, uint8_t blue)` {#api-ws2812-set-color-all} + +Set the color of all LEDs. + +#### Arguments {#api-ws2812-set-color-all-arguments} + + - `uint8_t red` + The red value to set. + - `uint8_t green` + The green value to set. + - `uint8_t blue` + The blue value to set. + +--- + +### `void ws2812_flush(void)` {#api-ws2812-flush} + +Flush the PWM values to the LED chain. |