You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

31 lines
1.3 KiB

  1. # Adding RGB Underglow to the KC60
  2. ![Image of KC60 with RGB Underglow](https://i.imgur.com/LpUkVqGl.jpg)
  3. The KC60 has breakout pins to which one may wire a strip of WS2812-compatible LEDs.
  4. 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:
  5. ```c
  6. #pragma once
  7. #undef RGBLED_NUM
  8. #define RGBLED_NUM <number of leds>
  9. ```
  10. To enable RGB Underglow, simply add a `rules.mk` file containing `RGBLIGHT_ENABLE = yes` alongside your `keymap.c` file, and compile as normal:
  11. ```shell
  12. make kc60:<keymap>
  13. ```
  14. The [ws2812 keymap](keymaps/ws2812/) may be copied and used as a starting point.
  15. 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.
  16. ## Reference Images
  17. ![Wiring Reference](https://i.imgur.com/TcKL2Sn.jpg)
  18. ![RGB Strip turned on](https://i.imgur.com/21POu4l.jpg)
  19. ![RGB Strip turned off](https://i.imgur.com/vAOLYNV.jpg)