diff options
Diffstat (limited to 'doc/keymap.md')
-rw-r--r-- | doc/keymap.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/keymap.md b/doc/keymap.md index d1985e567..6f2a663fc 100644 --- a/doc/keymap.md +++ b/doc/keymap.md | |||
@@ -455,6 +455,35 @@ Turn the backlight on and off without changing level. | |||
455 | 455 | ||
456 | 456 | ||
457 | 457 | ||
458 | ### 2.6 Swap-Hands Action | ||
459 | The swap-hands action allows support for one-handed keyboards without requiring a separate layer. Set `ONEHAND_ENABLE` in the Makefile and define a `hand_swap_config` entry in your keymap. Now whenever the `ACTION_SWAP_HANDS` command key is pressed the keyboard is mirrored. For instance, to type "Hello, World" on QWERTY you would type `^Ge^s^s^w^c W^wr^sd` | ||
460 | |||
461 | ### 2.6.1 Configuration | ||
462 | The configuration table is a simple 2-dimensional array to map from column/row to new column/row. Example `hand_swap_config` for Planck: | ||
463 | |||
464 | ``` | ||
465 | const keypos_t hand_swap_config[MATRIX_ROWS][MATRIX_COLS] = { | ||
466 | {{11, 0}, {10, 0}, {9, 0}, {8, 0}, {7, 0}, {6, 0}, {5, 0}, {4, 0}, {3, 0}, {2, 0}, {1, 0}, {0, 0}}, | ||
467 | {{11, 1}, {10, 1}, {9, 1}, {8, 1}, {7, 1}, {6, 1}, {5, 1}, {4, 1}, {3, 1}, {2, 1}, {1, 1}, {0, 1}}, | ||
468 | {{11, 2}, {10, 2}, {9, 2}, {8, 2}, {7, 2}, {6, 2}, {5, 2}, {4, 2}, {3, 2}, {2, 2}, {1, 2}, {0, 2}}, | ||
469 | {{11, 3}, {10, 3}, {9, 3}, {8, 3}, {7, 3}, {6, 3}, {5, 3}, {4, 3}, {3, 3}, {2, 3}, {1, 3}, {0, 3}}, | ||
470 | }; | ||
471 | ``` | ||
472 | |||
473 | Note that the array indices are reversed same as the matrix and the values are of type `keypos_t` which is `{col, row}` and all values are zero-based. In the example above, `hand_swap_config[2][4]` (third row, fifth column) would return {7, 2} (third row, eighth column). | ||
474 | |||
475 | ### 2.6.2 Advanced Swap Commands | ||
476 | - **`ACTION_SWAP_HANDS()`** Swaps hands when pressed, returns to normal when released (momentary). | ||
477 | - **`ACTION_SWAP_HANDS_TOGGLE()`** Toggles swap on and off with every keypress. | ||
478 | - **`ACTION_SWAP_HANDS_TAP_TOGGLE()`** Toggles with a tap; momentary when held. | ||
479 | - **`ACTION_SWAP_HANDS_TAP_KEY(key)`** Sends `key` with a tap; momentary swap when held. | ||
480 | - **`ACTION_SWAP_HANDS_ON_OFF()`** Alias for `ACTION_SWAP_HANDS()` | ||
481 | - **`ACTION_SWAP_HANDS_OFF_ON()`** Momentarily turns off swap. | ||
482 | - **`ACTION_SWAP_HANDS_ON()`** Turns on swapping and leaves it on. | ||
483 | - **`ACTION_SWAP_HANDS_OFF()`** Turn off swapping and leaves it off. Good for returning to a known state. | ||
484 | |||
485 | |||
486 | |||
458 | ## 3. Layer switching Example | 487 | ## 3. Layer switching Example |
459 | There are some ways to switch layer with 'Layer' actions. | 488 | There are some ways to switch layer with 'Layer' actions. |
460 | 489 | ||