Skip to content

Commit fdf71f1

Browse files
filterpaperfauxparkdrashnafilterpaper
authored
[Docs] RGB Matrix Caps Lock and Layer indicator example (qmk#13367)
Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: filterpaper <filterpaper@localhost>
1 parent 4b285d3 commit fdf71f1

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

docs/feature_rgb_matrix.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -624,6 +624,39 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
624624
}
625625
```
626626
627+
### Indicator Examples :id=indicator-examples
628+
629+
Caps Lock indicator on alphanumeric flagged keys:
630+
```c
631+
void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
632+
if (host_keyboard_led_state().caps_lock) {
633+
for (uint8_t i = led_min; i <= led_max; i++) {
634+
if (g_led_config.flags[i] & LED_FLAG_KEYLIGHT) {
635+
rgb_matrix_set_color(i, RGB_RED);
636+
}
637+
}
638+
}
639+
}
640+
```
641+
642+
Layer indicator on all flagged keys:
643+
```c
644+
void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
645+
for (uint8_t i = led_min; i <= led_max; i++) {
646+
switch(get_highest_layer(layer_state|default_layer_state)) {
647+
case RAISE:
648+
rgb_matrix_set_color(i, RGB_BLUE);
649+
break;
650+
case LOWER:
651+
rgb_matrix_set_color(i, RGB_YELLOW);
652+
break;
653+
default:
654+
break;
655+
}
656+
}
657+
}
658+
```
659+
627660
### Suspended state :id=suspended-state
628661
To use the suspend feature, make sure that `#define RGB_DISABLE_WHEN_USB_SUSPENDED true` is added to the `config.h` file.
629662

0 commit comments

Comments
 (0)