summaryrefslogtreecommitdiff
path: root/docs/feature_rgb_matrix.md
diff options
context:
space:
mode:
authorDasky <32983009+daskygit@users.noreply.github.com>2022-06-21 18:53:34 +0100
committerGitHub <noreply@github.com>2022-06-21 10:53:34 -0700
commitbe42c5fb9885d3bcbf47f99ad6cef343ba2b0b97 (patch)
tree5a34a2a56110950cca22b4beddc2e3563575da02 /docs/feature_rgb_matrix.md
parent2d7a2dfad0308c06c81d53af2d1ddbd2330e8294 (diff)
downloadqmk_firmware-be42c5fb9885d3bcbf47f99ad6cef343ba2b0b97.tar.gz
qmk_firmware-be42c5fb9885d3bcbf47f99ad6cef343ba2b0b97.zip
Fix RGB heatmap to use XY positions and use correct led limits (#17184)
* Fix RGB heatmap to use XY positions * lower effect area limit and make configurable * tidy up macro * Fix triggering in both directions. * add docs * fix bug when decreasing value * performance tweak
Diffstat (limited to 'docs/feature_rgb_matrix.md')
-rw-r--r--docs/feature_rgb_matrix.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index 2e88ae4727..9eaf63d710 100644
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -667,7 +667,22 @@ In order to change the delay of temperature decrease define `RGB_MATRIX_TYPING_H
#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:
+As heatmap uses the physical position of the leds set in the g_led_config, you may need to tweak the following options to get the best effect for your keyboard. Note the size of this grid is `224x64`.
+
+Limit the distance the effect spreads to surrounding keys.
+
+```c
+#define RGB_MATRIX_TYPING_HEATMAP_SPREAD 40
+```
+
+Limit how hot surrounding keys get from each press.
+
+```c
+#define RGB_MATRIX_TYPING_HEATMAP_AREA_LIMIT 16
+```
+
+Remove the spread effect entirely.
+
```c
#define RGB_MATRIX_TYPING_HEATMAP_SLIM
```