]> git.donarmstrong.com Git - qmk_firmware.git/blob - users/drashna/readme_rgb.md
[Keymap] Jarred's Plaid keymap (#6049)
[qmk_firmware.git] / users / drashna / readme_rgb.md
1 # Layer Indication Code 
2
3 At least for RGB Light, the `layer_state_set` function is used to detect the current highest layer, and change the underglow based on that layer.  
4
5 This works for both the regular layers, and for the default layers, too.
6
7 I use the sethsv variants of the commands, so that different modes can be used, as well. 
8
9 RGB Matrix uses a custom, per board implementation, at the moment. 
10
11 # RGB Light Startup Animation
12
13 On startup, if enabled, the board will cycle through the entire hue wheel, starting and ending on the default layer color. 
14
15 ```c
16 void keyboard_post_init_rgb(void) {
17 #if defined(RGBLIGHT_ENABLE) && defined(RGBLIGHT_STARTUP_ANIMATION)
18     if (userspace_config.rgb_layer_change) { rgblight_enable_noeeprom(); }
19     if (rgblight_config.enable) {
20         layer_state_set_user(layer_state);
21         uint16_t old_hue = rgblight_config.hue;
22         rgblight_mode_noeeprom(RGBLIGHT_MODE_STATIC_LIGHT);
23         for (uint16_t i = 255; i > 0; i--) {
24             rgblight_sethsv_noeeprom( ( i + old_hue) % 255, 255, 255);
25             matrix_scan();
26             wait_ms(10);
27         }
28     }
29 #endif
30     layer_state_set_user(layer_state);
31 }
32 ```
33
34 This could probably benefit from some cleanup and better handling. 
35
36
37 # RGB Light Twinkling 
38
39 This enables random twinkling of the LEDs when typing. 
40
41 # RGB Light Mod Indicators
42
43 Allows feedback of which mods (oneshot or otherwise) are enabled.