diff options
| author |  James Young <18669334+noroadsleft@users.noreply.github.com> | 2020-04-15 13:31:09 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2020-04-15 22:31:09 +0200 |
| commit | 3cc68543ca8c69048ffc0655d92be238afcee376 (patch) | |
| tree | 93a3e3208c8980c68ad50ea36de50e63f8974456 /keyboards/kc60/mod_rgb_underglow.md | |
| parent | daf6dedb02d96af789deccc2f96fe281486207c0 (diff) | |
| download | qmk_firmware-3cc68543ca8c69048ffc0655d92be238afcee376.tar.gz | |
KC60 Refactor (#8782)
Diffstat (limited to 'keyboards/kc60/mod_rgb_underglow.md')
| -rw-r--r-- | keyboards/kc60/mod_rgb_underglow.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/keyboards/kc60/mod_rgb_underglow.md b/keyboards/kc60/mod_rgb_underglow.md new file mode 100644 index 000000000..6aab1e1d2 --- /dev/null +++ b/keyboards/kc60/mod_rgb_underglow.md @@ -0,0 +1,31 @@ +# Adding RGB Underglow to the KC60 + + + +The KC60 has breakout pins to which one may wire a strip of WS2812-compatible LEDs. + +By default, the source is set up for 16 LEDs on the F5 breakout pin. See [included image](https://i.imgur.com/TcKL2Sn.jpg) for wiring reference. If you attach a different number of LEDs, configure your source for the correct number of LEDs by adding a `config.h` file alongside your `keymap.c` file, with the following contents: + +```c +#pragma once + +#undef RGBLED_NUM +#define RGBLED_NUM <number of leds> +``` + +To enable RGB Underglow, simply add a `rules.mk` file containing `RGBLIGHT_ENABLE = yes` alongside your `keymap.c` file, and compile as normal: + +```shell +make kc60:<keymap> +``` + +The [ws2812 keymap](keymaps/ws2812/) may be copied and used as a starting point. + +RGB Underglow is a fairly large feature, and your firmware may be too large to be flashed with it enabled. Adding `CONSOLE_ENABLE = no` or `COMMAND_ENABLE = no` to your `rules.mk` file will reduce the size of the firmware greatly, and if you don't use either feature, is a very low impact change. + + +## Reference Images + + + + |