X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=docs%2Ffeature_swap_hands.md;h=09e01d50d3c0b41c5c86d6c2ccc9e2869bfb9597;hb=2a231457bd494079c36cf3e07c9b887016adb491;hp=61c66a2c10bded32eb3a0262c0d53e6b2677e91d;hpb=7230923b051bdb32bea19c3d732fa1fbc4883a68;p=qmk_firmware.git diff --git a/docs/feature_swap_hands.md b/docs/feature_swap_hands.md index 61c66a2c1..09e01d50d 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. | +|`SH_ON` |Turns on swapping and leaves it on. | +|`SH_OFF` |Turn off swapping and leaves it off. Good for returning to a known state.| +|`SH_MON` |Swaps hands when pressed, returns to normal when released (momentary). | +|`SH_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. |