diff options
author | Albert Y <76888457+filterpaper@users.noreply.github.com> | 2022-04-17 02:34:07 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-04-16 11:34:07 -0700 |
commit | e5918cf968f3e2c4a62858ee789748443ba58d10 (patch) | |
tree | 5b1280e32b1a7274eaa4f95e673b805ae91ebd2f /docs | |
parent | 030a96a3f542db7434582d7887c4caafa8756203 (diff) | |
download | qmk_firmware-e5918cf968f3e2c4a62858ee789748443ba58d10.tar.gz qmk_firmware-e5918cf968f3e2c4a62858ee789748443ba58d10.zip |
Heatmap incorrect matrix effect workaround (#16315)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/feature_rgb_matrix.md | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md index a8793be328..b2fc61e51e 100644 --- a/docs/feature_rgb_matrix.md +++ b/docs/feature_rgb_matrix.md @@ -657,18 +657,19 @@ You can enable a single effect by defining `ENABLE_[EFFECT_NAME]` in your `confi ### RGB Matrix Effect Typing Heatmap :id=rgb-matrix-effect-typing-heatmap -This effect will color the RGB matrix according to a heatmap of recently pressed -keys. Whenever a key is pressed its "temperature" increases as well as that of -its neighboring keys. The temperature of each key is then decreased -automatically every 25 milliseconds by default. +This effect will color the RGB matrix according to a heatmap of recently pressed keys. Whenever a key is pressed its "temperature" increases as well as that of its neighboring keys. The temperature of each key is then decreased automatically every 25 milliseconds by default. -In order to change the delay of temperature decrease define -`RGB_MATRIX_TYPING_HEATMAP_DECREASE_DELAY_MS`: +In order to change the delay of temperature decrease define `RGB_MATRIX_TYPING_HEATMAP_DECREASE_DELAY_MS`: ```c #define RGB_MATRIX_TYPING_HEATMAP_DECREASE_DELAY_MS 50 ``` +Heatmap effect may not light up the correct adjacent LEDs for certain key matrix layout such as split keyboards. The following define will limit the effect to pressed keys only: +```c +#define RGB_MATRIX_TYPING_HEATMAP_SLIM +``` + ## Custom RGB Matrix Effects :id=custom-rgb-matrix-effects By setting `RGB_MATRIX_CUSTOM_USER = yes` in `rules.mk`, new effects can be defined directly from your keymap or userspace, without having to edit any QMK core files. To declare new effects, create a `rgb_matrix_user.inc` file in the user keymap directory or userspace folder. |