Skip to content

feat: split: add asymmetric geometry support via split_mapping #1136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
haricane8133 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: split: add asymmetric geometry support via split_mapping #1136

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e7cef4b
feat: split: add asymmetric geometry support via split_mapping
haricane8133 Mar 22, 2026
804874a
Revert "feat: split: add asymmetric geometry support via split_mapping"
haricane8133 Sep 13, 2026
aafb9c2
docs: split: explain coord_mapping for asymmetric halves
haricane8133 Sep 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion docs/en/split_keyboards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,18 @@ split = Split(
```

Note: It is best to stay as consistent as possible, but thanks to the `coord_mapping` feature, none of the `col_pins`, `row_pins` and `diode_orientation` **need** to be the same for both side.
It is however necessary for `len(col_pins) * len(row_pins)` to be the same to calculate the offset of the key number on the left side correctly.
The automatically generated `coord_mapping` does however assume that both halves have the same number of rows and columns.
If they do not (an asymmetric split), set `keyboard.coord_mapping` yourself: keys on the left half are numbered `0` to `len(col_pins) * len(row_pins) - 1` as usual, and keys on the right half are offset by the right half's *own* `len(col_pins) * len(row_pins)`.
For example, with 2 rows, 3 columns on the left and 4 columns on the right, the right half's keys start at `2 * 4 = 8`:

```python
keyboard.coord_mapping = [
0, 1, 2, 8, 9, 10, 11,
3, 4, 5, 12, 13, 14, 15,
]
```

Use the same `coord_mapping` and keymap on both halves. See [Coord mapping](porting_to_kmk.md#coord-mapping) for details, including how to leave out unused matrix positions.

### `split_flip`
If your split keyboard uses the **same PCB for both sides**, but vertically flipped, set this to `True`, and `False` otherwise. `True` means the wiring is the same for both side except that the `col_pins` are reversed.
Expand Down