From 6c7450dad7c3651e0aae7ebaeb6c3cf15bde5112 Mon Sep 17 00:00:00 2001
From: Matthes W <48785515+matthesinator@users.noreply.github.com>
Date: Mon, 17 May 2021 02:59:02 +0200
Subject: Add function to allow repeated blinking of one layer (#12237)

* Implement function rgblight_blink_layer_repeat to allow repeated blinking of one layer at a time

* Update doc

* Rework rgblight blinking according to requested change

* optimize storage
---
 docs/feature_rgblight.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'docs/feature_rgblight.md')

diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 8e8d6b81c3..292176548f 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -310,6 +310,18 @@ void post_process_record_user(uint16_t keycode, keyrecord_t *record) {
 }
 ```
 
+You can also use `rgblight_blink_layer_repeat` to specify the amount of times the layer is supposed to blink. Using the layers from above,
+```c
+void post_process_record_user(uint16_t keycode, keyrecord_t *record) {
+    switch (keycode) {
+        case DEBUG:
+            rgblight_blink_layer_repeat(debug_enable ? 0 : 1, 200, 3);
+            break;
+    }
+}
+```
+would turn the layer 0 (or 1) on and off again three times when `DEBUG` is pressed.
+
 ### Overriding RGB Lighting on/off status
 
 Normally lighting layers are not shown when RGB Lighting is disabled (e.g. with `RGB_TOG` keycode). If you would like lighting layers to work even when the RGB Lighting is otherwise off, add `#define RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF` to your `config.h`.
-- 
cgit v1.2.3