aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2020-08-25 02:08:09 -0700
committerGitHub <noreply@github.com>2020-08-25 19:08:09 +1000
commitb338a4d8867f69bd6a92ec92e306715a4ae41740 (patch)
treed81d23c6928ef771e3fad133db5f7c1ec0dd8e99 /docs
parent1fd2f2f02227e969d4bde1ae88cd4eaa2f0ab242 (diff)
downloadfirmware-b338a4d8867f69bd6a92ec92e306715a4ae41740.tar.gz
firmware-b338a4d8867f69bd6a92ec92e306715a4ae41740.tar.bz2
firmware-b338a4d8867f69bd6a92ec92e306715a4ae41740.zip
Add noeeprom speed function for RGBLIGHT (#9706)
* [Docs] Add Speed functions to RGB Light docs * Add noeeprom functions for speed * Fix wording in doc Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_rgblight.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index a81b50e82..26e01da50 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -377,6 +377,17 @@ rgblight_sethsv(HSV_GREEN, 2); // led 2
|`rgblight_sethsv(h, s, v)` |Set effect range LEDs to the given HSV value where `h`/`s`/`v` are between 0 and 255 |
|`rgblight_sethsv_noeeprom(h, s, v)` |Set effect range LEDs to the given HSV value where `h`/`s`/`v` are between 0 and 255 (not written to EEPROM) |
+#### Speed functions
+|Function |Description |
+|--------------------------------------------|-------------|
+|`rgblight_increase_speed()` |Increases the animation speed |
+|`rgblight_increase_speed_noeeprom()` |Increases the animation speed (not written to EEPROM) |
+|`rgblight_decrease_speed()` |Decreases the animation speed |
+|`rgblight_decrease_speed_noeeprom()` |Decreases the animation speed (not written to EEPROM) |
+|`rgblight_set_speed()` |Sets the speed. Value is between 0 and 255 |
+|`rgblight_set_speed_noeeprom()` |Sets the speed. Value is between 0 and 255 (not written to EEPROM) |
+
+
#### layer functions
|Function |Description |
|--------------------------------------------|-------------|