summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTrevor Elliott <awesomelyawesome@gmail.com>2021-03-01 21:29:11 -0800
committerGitHub <noreply@github.com>2021-03-01 21:29:11 -0800
commitd0108869ee1431182574184ba11f064916369139 (patch)
tree992e5c481e03600431d6ed4afa7dc5f61f17efdc /docs
parent58d043b0d0888dc74654c61fb9ca35df428589b6 (diff)
[Docs] MATRIX_MASKED docs for SPLIT_HAND_MATRIX_GRID (#11974)
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_split_keyboard.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/feature_split_keyboard.md b/docs/feature_split_keyboard.md
index 90af3930f9..dc081ff3ae 100644
--- a/docs/feature_split_keyboard.md
+++ b/docs/feature_split_keyboard.md
@@ -109,6 +109,10 @@ Normally, when a diode is connected to an intersection, it is judged to be left.
#define SPLIT_HAND_MATRIX_GRID_LOW_IS_RIGHT
```
+Note that adding a diode at a previously unused intersection will effectively tell the firmware that there is a key held down at that point. You can instruct qmk to ignore that intersection by defining `MATRIX_MASKED` and then defining a `matrix_row_t matrix_mask[MATRIX_ROWS]` array in your keyboard config. Each bit of a single value (starting form the least-significant bit) is used to tell qmk whether or not to pay attention to key presses at that intersection.
+
+While `MATRIX_MASKED` isn't necessary to use `SPLIT_HAND_MATRIX_GRID` successfully, without it you may experience issues trying to suspend your computer with your keyboard attached as the matrix will always report at least one key-press.
+
#### Handedness by EEPROM
This method sets the keyboard's handedness by setting a flag in the persistent storage (`EEPROM`). This is checked when the controller first starts up, and determines what half the keyboard is, and how to orient the keyboard layout.