swap_hands.md (3661B)
1 # Swap-Hands Action 2 3 The swap-hands action allows support for one-handed typing without requiring a separate layer. Set `SWAP_HANDS_ENABLE = yes` in your keymap's `rules.mk` (creating it if needed), 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` 4 5 ## Configuration 6 7 The configuration table is a simple 2-dimensional array to map from column/row to new column/row. Example `hand_swap_config` for Planck: 8 9 ```c 10 const keypos_t PROGMEM hand_swap_config[MATRIX_ROWS][MATRIX_COLS] = { 11 {{11, 0}, {10, 0}, {9, 0}, {8, 0}, {7, 0}, {6, 0}, {5, 0}, {4, 0}, {3, 0}, {2, 0}, {1, 0}, {0, 0}}, 12 {{11, 1}, {10, 1}, {9, 1}, {8, 1}, {7, 1}, {6, 1}, {5, 1}, {4, 1}, {3, 1}, {2, 1}, {1, 1}, {0, 1}}, 13 {{11, 2}, {10, 2}, {9, 2}, {8, 2}, {7, 2}, {6, 2}, {5, 2}, {4, 2}, {3, 2}, {2, 2}, {1, 2}, {0, 2}}, 14 {{11, 3}, {10, 3}, {9, 3}, {8, 3}, {7, 3}, {6, 3}, {5, 3}, {4, 3}, {3, 3}, {2, 3}, {1, 3}, {0, 3}}, 15 }; 16 ``` 17 18 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. 19 20 ## Swap Keycodes 21 22 |Key |Aliases |Description | 23 |-----------------------------|---------|----------------------------------------------------| 24 |`SH_T(kc)` | |Momentary swap when held, `kc` when tapped | 25 |`QK_SWAP_HANDS_ON` |`SH_ON` |Turn on hand swap | 26 |`QK_SWAP_HANDS_OFF` |`SH_OFF` |Turn off hand swap | 27 |`QK_SWAP_HANDS_MOMENTARY_ON` |`SH_MON` |Turn on hand swap while held | 28 |`QK_SWAP_HANDS_MOMENTARY_OFF`|`SH_MOFF`|Turn off hand swap while held | 29 |`QK_SWAP_HANDS_TOGGLE` |`SH_TOGG`|Toggle hand swap | 30 |`QK_SWAP_HANDS_TAP_TOGGLE` |`SH_TT` |Momentary swap when held, toggle when tapped | 31 |`QK_SWAP_HANDS_ONE_SHOT` |`SH_OS` |Turn on hand swap while held or until next key press| 32 33 `SH_TT` swap-hands tap-toggle key is similar to [layer tap-toggle](../feature_layers#switching-and-toggling-layers). Tapping repeatedly (5 taps by default) will toggle swap-hands on or off, like `SH_TOGG`. Tap-toggle count can be changed by defining a value for `TAPPING_TOGGLE`. 34 35 ## Encoder Mapping 36 37 When using an encoder mapping, it's also able to handle swapping encoders between sides, too. 38 39 Encoder indexes are defined as left-to-right, and the extent of the array needs to match the number of encoders on the keyboard. 40 41 As an example, if a split keyboard has a single encoder per side, you can swap the order by using the following code in your keymap: 42 ```c 43 #if defined(SWAP_HANDS_ENABLE) && defined(ENCODER_MAP_ENABLE) 44 const uint8_t PROGMEM encoder_hand_swap_config[NUM_ENCODERS] = { 1, 0 }; 45 #endif 46 ``` 47 48 ### Functions {#functions} 49 50 User callback functions to manipulate Swap-Hands: 51 52 | Function | Description | 53 |-----------------------|---------------------------------------------| 54 | `swap_hands_on()` | Turns Swap-Hands on. | 55 | `swap_hands_off()` | Turns Swap-Hands off. | 56 | `swap_hands_toggle()` | Toggles Swap-Hands. | 57 | `is_swap_hands_on()` | Returns true if Swap-Hands is currently on. |