aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoe Wasson <jwasson+github@gmail.com>2016-07-28 01:24:06 -0700
committerJoe Wasson <jwasson+github@gmail.com>2016-08-20 17:46:53 -0700
commit8090f6b499fd87ddeb7a191f7bc3dace9d03be23 (patch)
treed0769eecb8f2b236732b8d713d06cb66833535d7 /doc
parentdd378601608849679ead6e2cccb74f7f29c131dc (diff)
downloadfirmware-8090f6b499fd87ddeb7a191f7bc3dace9d03be23.tar.gz
firmware-8090f6b499fd87ddeb7a191f7bc3dace9d03be23.tar.bz2
firmware-8090f6b499fd87ddeb7a191f7bc3dace9d03be23.zip
Improve one-hand support by adding more actions and tap keys.
Diffstat (limited to 'doc')
-rw-r--r--doc/keymap.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/keymap.md b/doc/keymap.md
index 1285ad6cd..6f2a663fc 100644
--- a/doc/keymap.md
+++ b/doc/keymap.md
@@ -456,8 +456,9 @@ Turn the backlight on and off without changing level.
### 2.6 Swap-Hands Action
-The swap-hands action allows support for one-handed keyboards without requiring a separate layer. Set `ONEHAND_ENABLE` in the Makefile and define a `hand_swap_config` entry in your keymap. Now whenever the `ACTION_SWAP_HANDS` command is executed the keyboard is mirrored. For instance, to type "Hello, World" on QWERTY you would type `^Ge^s^s^w^c W^wr^sd`
+The swap-hands action allows support for one-handed keyboards without requiring a separate layer. Set `ONEHAND_ENABLE` in the Makefile and define a `hand_swap_config` entry in your keymap. Now whenever the `ACTION_SWAP_HANDS` command key is pressed the keyboard is mirrored. For instance, to type "Hello, World" on QWERTY you would type `^Ge^s^s^w^c W^wr^sd`
+### 2.6.1 Configuration
The configuration table is a simple 2-dimensional array to map from column/row to new column/row. Example `hand_swap_config` for Planck:
```
@@ -471,6 +472,16 @@ 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).
+### 2.6.2 Advanced Swap Commands
+- **`ACTION_SWAP_HANDS()`** Swaps hands when pressed, returns to normal when released (momentary).
+- **`ACTION_SWAP_HANDS_TOGGLE()`** Toggles swap on and off with every keypress.
+- **`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.
+
## 3. Layer switching Example