diff options
| author |  Joe Wasson <jwasson+github@gmail.com> | 2018-03-11 16:53:35 -0700 |
|---|---|---|
| committer |  Jack Humbert <jack.humb@gmail.com> | 2018-03-16 16:33:43 -0400 |
| commit | 23ac2a02ef870dce91318a4d98e3c8ec5749bced (patch) | |
| tree | 302f61696ce319d635c17e919ec6d8acf264d2ab /docs/feature_swap_hands.md | |
| parent | 7230923b051bdb32bea19c3d732fa1fbc4883a68 (diff) | |
| download | qmk_firmware-23ac2a02ef870dce91318a4d98e3c8ec5749bced.tar.gz | |
Add keycodes for swap-hands feature.
Diffstat (limited to 'docs/feature_swap_hands.md')
| -rw-r--r-- | docs/feature_swap_hands.md | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/docs/feature_swap_hands.md b/docs/feature_swap_hands.md index 61c66a2c1..92e8e3b10 100644 --- a/docs/feature_swap_hands.md +++ b/docs/feature_swap_hands.md @@ -17,15 +17,14 @@ const keypos_t hand_swap_config[MATRIX_ROWS][MATRIX_COLS] = { 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 +## Swap Keycodes -|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 +|Key |Description | +|-----------|-------------------------------------------------------------------------| +|`SH_T(key)`|Sends `key` with a tap; momentary swap when held. | +|`SW_ON` |Turns on swapping and leaves it on. | +|`SW_OFF` |Turn off swapping and leaves it off. Good for returning to a known state.| +|`SW_MON` |Swaps hands when pressed, returns to normal when released (momentary). | +|`SW_MOFF` |Momentarily turns off swap. | +|`SH_TG` |Toggles swap on and off with every key press. | +|`SH_TT` |Toggles with a tap; momentary when held. | |