qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

mod_rgb_underglow.md (1362B)


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