diff options
| author | Nick Brassel <nick@tzarc.org> | 2022-05-29 07:57:11 +1000 |
|---|---|---|
| committer | Nick Brassel <nick@tzarc.org> | 2022-05-29 07:57:11 +1000 |
| commit | b835171008eaeaa992a1b8e390af8bce6f5f0b8f (patch) | |
| tree | de22c239cc47556f8be7538f95f48ad75b86d110 /docs/feature_swap_hands.md | |
| parent | f5d091a9d58c8349437e9d52de87294258cbd256 (diff) | |
| parent | 0c8f78020d01ee5c45481d7d93b9b0d9f7b95103 (diff) | |
Merge branch 'develop' -- breaking changes 2022-05-28.
Diffstat (limited to 'docs/feature_swap_hands.md')
| -rw-r--r-- | docs/feature_swap_hands.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/feature_swap_hands.md b/docs/feature_swap_hands.md index 654108ae70..6768020f12 100644 --- a/docs/feature_swap_hands.md +++ b/docs/feature_swap_hands.md @@ -31,3 +31,16 @@ Note that the array indices are reversed same as the matrix and the values are o |`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`. + +## Encoder Mapping + +When using an encoder mapping, it's also able to handle swapping encoders between sides, too. + +Encoder indexes are defined as left-to-right, and the extent of the array needs to match the number of encoders on the keyboard. + +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: +```c +#if defined(SWAP_HANDS_ENABLE) && defined(ENCODER_MAP_ENABLE) +const uint8_t PROGMEM encoder_hand_swap_config[NUM_ENCODERS] = { 1, 0 }; +#endif +``` |
