Skip to content
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.

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

Discuss layout macro #19803

Merged
merged 5 commits into from
Mar 6, 2023
Merged
Changes from 1 commit
Commits
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
Next Next commit
Discuss layout macro
There is no mention or visualization of how to create a layout macro in `info.json` for split keyboards.

@fauxpark helped me tremendously in Discord by creating and providing these visualizations to aid my understanding:
https://cdn.discordapp.com/attachments/440868230475677698/1073409438712610907/image.png
https://cdn.discordapp.com/attachments/440868230475677698/1073409562373259364/image.png

I strongly feel these should be in the docs.

I think it best to include a short discussion in the [split keyboard page](https://docs.qmk.fm/#/feature_split_keyboard), explaining that row pins are automatically doubled when setting `SPLIT_KEYBOARD = yes` and that QMK views the physical layouts according to those pictures.

These are the pages I used to search for answers to the question:
https://docs.qmk.fm/#/feature_split_keyboard
https://docs.qmk.fm/#/porting_your_keyboard_to_qmk?id=layout-macros
https://docs.qmk.fm/#/hardware_keyboard_guidelines?id=ltkeyboard_namehgt
  • Loading branch information
souvlakeeb committed Feb 10, 2023
commit a5580ed2f7fa6b8d30c12bfcf8f5a0c78da15a17
11 changes: 11 additions & 0 deletions docs/feature_split_keyboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,17 @@ If you're using a custom transport (communication method), then you will also ne
SPLIT_TRANSPORT = custom
```

### Layout Macro
When setting `SPLIT_KEYBOARD = yes`, row pins are automatically doubled.
This is because QMK views a split keyboard as follows, with the numbers
representing row, column:
souvlakeeb marked this conversation as resolved.
Show resolved Hide resolved

IMG1

IMG2
souvlakeeb marked this conversation as resolved.
Show resolved Hide resolved

Take care to define your layout in `info.json` accordingly.

### 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.
Expand Down