From fdf71f1aa7c4720b469d0e11ec8169796cdf3930 Mon Sep 17 00:00:00 2001
From: Albert Y <76888457+filterpaper@users.noreply.github.com>
Date: Sat, 3 Jul 2021 16:07:01 +0800
Subject: [PATCH] [Docs] RGB Matrix Caps Lock and Layer indicator example
(#13367)
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: filterpaper <filterpaper@localhost>
---
docs/feature_rgb_matrix.md | 33 +++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index bfb3688b67..08d5c9c4c6 100644
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -624,6 +624,39 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
}
```
+### Indicator Examples :id=indicator-examples
+
+Caps Lock indicator on alphanumeric flagged keys:
+```c
+void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+ if (host_keyboard_led_state().caps_lock) {
+ for (uint8_t i = led_min; i <= led_max; i++) {
+ if (g_led_config.flags[i] & LED_FLAG_KEYLIGHT) {
+ rgb_matrix_set_color(i, RGB_RED);
+ }
+ }
+ }
+}
+```
+
+Layer indicator on all flagged keys:
+```c
+void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+ for (uint8_t i = led_min; i <= led_max; i++) {
+ switch(get_highest_layer(layer_state|default_layer_state)) {
+ case RAISE:
+ rgb_matrix_set_color(i, RGB_BLUE);
+ break;
+ case LOWER:
+ rgb_matrix_set_color(i, RGB_YELLOW);
+ break;
+ default:
+ break;
+ }
+ }
+}
+```
+
### Suspended state :id=suspended-state
To use the suspend feature, make sure that `#define RGB_DISABLE_WHEN_USB_SUSPENDED true` is added to the `config.h` file.