diff options
| -rw-r--r-- | docs/_summary.md | 1 | ||||
| -rw-r--r-- | docs/feature_swap_hands.md | 31 |
2 files changed, 32 insertions, 0 deletions
diff --git a/docs/_summary.md b/docs/_summary.md index 4b007059f0..4e743ac5ea 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -45,6 +45,7 @@ * [RGB Lighting](feature_rgblight.md) * [Space Cadet](feature_space_cadet.md) * [Stenography](feature_stenography.md) + * [Swap Hands](feature_swap_hands.md) * [Tap Dance](feature_tap_dance.md) * [Terminal](feature_terminal.md) * [Thermal Printer](feature_thermal_printer.md) diff --git a/docs/feature_swap_hands.md b/docs/feature_swap_hands.md new file mode 100644 index 0000000000..42f9e08671 --- /dev/null +++ b/docs/feature_swap_hands.md @@ -0,0 +1,31 @@ +# Swap-Hands Action + +The swap-hands action allows support for one-handed typing 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` + +## Configuration + +The configuration table is a simple 2-dimensional array to map from column/row to new column/row. Example `hand_swap_config` for Planck: + +```C +const keypos_t hand_swap_config[MATRIX_ROWS][MATRIX_COLS] = { + {{11, 0}, {10, 0}, {9, 0}, {8, 0}, {7, 0}, {6, 0}, {5, 0}, {4, 0}, {3, 0}, {2, 0}, {1, 0}, {0, 0}}, + {{11, 1}, {10, 1}, {9, 1}, {8, 1}, {7, 1}, {6, 1}, {5, 1}, {4, 1}, {3, 1}, {2, 1}, {1, 1}, {0, 1}}, + {{11, 2}, {10, 2}, {9, 2}, {8, 2}, {7, 2}, {6, 2}, {5, 2}, {4, 2}, {3, 2}, {2, 2}, {1, 2}, {0, 2}}, + {{11, 3}, {10, 3}, {9, 3}, {8, 3}, {7, 3}, {6, 3}, {5, 3}, {4, 3}, {3, 3}, {2, 3}, {1, 3}, {0, 3}}, +}; +``` + +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). Yes, this is confusing. + +## Advanced Swap Commands + +|Macro | Description | +|------|-------------| +| `ACTION_SWAP_HANDS()` | Swaps hands when pressed, returns to normal when released (momentary). | +| `ACTION_SWAP_HANDS_TOGGLE()` | Toggles swap on and off with every key press. | +| `ACTION_SWAP_HANDS_TAP_TOGGLE()` | Toggles with a tap; momentary when held. | +| `ACTION_SWAP_HANDS_TAP_KEY(key)`| Sends `key` with a tap; momentary swap when held. | +| `ACTION_SWAP_HANDS_ON_OFF()` | Alias for `ACTION_SWAP_HANDS()` | +| `ACTION_SWAP_HANDS_OFF_ON()` | Momentarily turns off swap. | +| `ACTION_SWAP_HANDS_ON()` | Turns on swapping and leaves it on. | +| `ACTION_SWAP_HANDS_OFF()` | Turn off swapping and leaves it off. Good for returning to a known state. |
\ No newline at end of file |