From 2d843088a26ee639287d16fbd9ca4c35e18f7b8b Mon Sep 17 00:00:00 2001 From: Ryan Date: Tue, 31 Jan 2023 05:37:19 +1100 Subject: Normalise Swap Hands keycodes (#19720) --- docs/feature_swap_hands.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'docs/feature_swap_hands.md') diff --git a/docs/feature_swap_hands.md b/docs/feature_swap_hands.md index 6768020f12..35131884e1 100644 --- a/docs/feature_swap_hands.md +++ b/docs/feature_swap_hands.md @@ -19,18 +19,18 @@ Note that the array indices are reversed same as the matrix and the values are o ## Swap Keycodes -|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` |Momentary swap when held, toggles with repeated taps (see below). | -|`SH_OS` |One shot swap hands: toggles while pressed or until next key press. | - -`SH_TT` swap-hands tap-toggle key is similar to [layer tap-toggle](feature_layers.md?id=switching-and-toggling-layers). Tapping repeatedly (5 taps by default) will toggle swap-hands on or off, like `SH_TG`. Tap-toggle count can be changed by defining a value for `TAPPING_TOGGLE`. +|Key |Aliases |Description | +|-----------------------------|---------|----------------------------------------------------| +|`SH_T(kc)` | |Momentary swap when held, `kc` when tapped | +|`QK_SWAP_HANDS_ON` |`SH_ON` |Turn on hand swap | +|`QK_SWAP_HANDS_OFF` |`SH_OFF` |Turn off hand swap | +|`QK_SWAP_HANDS_MOMENTARY_ON` |`SH_MON` |Turn on hand swap while held | +|`QK_SWAP_HANDS_MOMENTARY_OFF`|`SH_MOFF`|Turn off hand swap while held | +|`QK_SWAP_HANDS_TOGGLE` |`SH_TOGG`|Toggle hand swap | +|`QK_SWAP_HANDS_TAP_TOGGLE` |`SH_TT` |Momentary swap when held, toggle when tapped | +|`QK_SWAP_HANDS_ONE_SHOT` |`SH_OS` |Turn on hand swap while held or until next key press| + +`SH_TT` swap-hands tap-toggle key is similar to [layer tap-toggle](feature_layers.md?id=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`. ## Encoder Mapping -- cgit v1.2.3 From 9908ed7ecd1bc0c45f0322b959811bd8fd641961 Mon Sep 17 00:00:00 2001 From: Albert Y <76888457+filterpaper@users.noreply.github.com> Date: Wed, 15 Feb 2023 04:44:18 +0800 Subject: Add swap hands status function (#19831) Co-authored-by: Drashna Jaelre --- docs/feature_swap_hands.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/feature_swap_hands.md') diff --git a/docs/feature_swap_hands.md b/docs/feature_swap_hands.md index 35131884e1..4d0d554093 100644 --- a/docs/feature_swap_hands.md +++ b/docs/feature_swap_hands.md @@ -44,3 +44,9 @@ As an example, if a split keyboard has a single encoder per side, you can swap t const uint8_t PROGMEM encoder_hand_swap_config[NUM_ENCODERS] = { 1, 0 }; #endif ``` + +### Functions :id=functions + +| Function | Description | +|----------------------|---------------------------------------------| +| `is_swap_hands_on()` | Returns true if Swap-Hands is currently on. | -- cgit v1.2.3