summaryrefslogtreecommitdiffstats
path: root/docs/feature_split_keyboard.md
diff options
context:
space:
mode:
authorsouvlakeeb <109096368+souvlakeeb@users.noreply.github.com>2023-03-06 12:24:56 -0700
committerGitHub <noreply@github.com>2023-03-06 11:24:56 -0800
commitf067f4230538ee1efbeaebf13c92106f973ffe93 (patch)
tree0fe80bd0fba85f301a51565ccd25c55eff8e9713 /docs/feature_split_keyboard.md
parentca5eb9f664cd58cf4e396c54f5fc16c44224fdea (diff)
[Docs] Discuss layout macro (#19803)
Co-authored-by: jack <0x6a73@protonmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'docs/feature_split_keyboard.md')
-rw-r--r--docs/feature_split_keyboard.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/feature_split_keyboard.md b/docs/feature_split_keyboard.md
index 25f7473bda..c095c8712f 100644
--- a/docs/feature_split_keyboard.md
+++ b/docs/feature_split_keyboard.md
@@ -79,6 +79,16 @@ If you're using a custom transport (communication method), then you will also ne
SPLIT_TRANSPORT = custom
```
+### Layout Macro
+
+Configuring your layout in a split keyboard works slightly differently to a non-split keyboard. Take for example the following layout. The top left numbers refer to the matrix row and column, and the bottom right are the order of the keys in the layout:
+
+![Physical layout](https://i.imgur.com/QeY6kMQ.png)
+
+Since the matrix scanning procedure operates on entire rows, it first populates the left half's rows, then the right half's. Thus, the matrix as QMK views it has double the rows instead of double the columns:
+
+![Matrix](https://i.imgur.com/4wjJzBU.png)
+
### Setting Handedness
By default, the firmware does not know which side is which; it needs some help to determine that. There are several ways to do this, listed in order of precedence.