diff options
author | Nick Brassel <[email protected]> | 2022-03-09 19:29:00 +1100 |
---|---|---|
committer | GitHub <[email protected]> | 2022-03-09 19:29:00 +1100 |
commit | 8d5eacb7dd76bfd45444ceb1efa9a9f840173552 (patch) | |
tree | b6b8b641dd61f5de0c5b7ee1bf251f6a84043656 /docs/feature_swap_hands.md | |
parent | 7121a228eb204a0d697c97503ac7a28b762ab598 (diff) | |
download | qmk_firmware-8d5eacb7dd76bfd45444ceb1efa9a9f840173552.tar.gz qmk_firmware-8d5eacb7dd76bfd45444ceb1efa9a9f840173552.zip |
Add support for encoder mapping. (#13286)
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 +``` |