aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_auto_shift.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2020-11-28 12:02:18 -0800
committerGitHub <noreply@github.com>2020-11-28 12:02:18 -0800
commitc66df1664497546f32662409778731143e45a552 (patch)
treeda73a2d532a27685a31d932b3a44a707d4a3af81 /docs/feature_auto_shift.md
parent15385d4113414d42bd062c60c9de5df797d3157f (diff)
downloadqmk_firmware-c66df1664497546f32662409778731143e45a552.tar.gz
qmk_firmware-c66df1664497546f32662409778731143e45a552.zip
2020 November 28 Breaking Changes Update (#11053)
* Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183) * Add support for soft serial to ATmega32U2 (#10204) * Change MIDI velocity implementation to allow direct control of velocity value (#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (#10417) * Joystick 16-bit support (#10439) * Per-encoder resolutions (#10259) * Share button state from mousekey to pointing_device (#10179) * Add hotfix for chibios keyboards not wake (#10088) * Add advanced/efficient RGB Matrix Indicators (#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (#10206) * Add milc as a dependency and remove the installed milc (#10563) * ChibiOS upgrade: early init conversions (#10214) * ChibiOS upgrade: configuration file migrator (#9952) * Haptic and solenoid cleanup (#9700) * XD75 cleanup (#10524) * OLED display update interval support (#10388) * Add definition based on currently-selected serial driver. (#10716) * New feature: Retro Tapping per key (#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (#8669) * Minor change to behavior allowing display updates to continue between task ticks (#10750) * Some GPIO manipulations in matrix.c change to atomic. (#10491) * qmk cformat (#10767) * [Keyboard] Update the Speedo firmware for v3.0 (#10657) * Maartenwut/Maarten namechange to evyd13/Evy (#10274) * [quantum] combine repeated lines of code (#10837) * Add step sequencer feature (#9703) * aeboards/ext65 refactor (#10820) * Refactor xelus/dawn60 for Rev2 later (#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549) * update chibios os usb for the otg driver (#8893) * Remove HD44780 References, Part 4 (#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (#10512) * Fix cursor position bug in oled_write_raw functions (#10800) * Fixup version.h writing when using SKIP_VERSION=yes (#10972) * Allow for certain code in the codebase assuming length of string. (#10974) * Add AT90USB support for serial.c (#10706) * Auto shift: support repeats and early registration (#9826) * Rename ledmatrix.h to match .c file (#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840) * Merge point for 2020 Nov 28 Breaking Change
Diffstat (limited to 'docs/feature_auto_shift.md')
-rw-r--r--docs/feature_auto_shift.md42
1 files changed, 28 insertions, 14 deletions
diff --git a/docs/feature_auto_shift.md b/docs/feature_auto_shift.md
index b21a7690d..8e04d9dd3 100644
--- a/docs/feature_auto_shift.md
+++ b/docs/feature_auto_shift.md
@@ -15,25 +15,31 @@ problem.
15When you tap a key, it stays depressed for a short period of time before it is 15When you tap a key, it stays depressed for a short period of time before it is
16then released. This depressed time is a different length for everyone. Auto Shift 16then released. This depressed time is a different length for everyone. Auto Shift
17defines a constant `AUTO_SHIFT_TIMEOUT` which is typically set to twice your 17defines a constant `AUTO_SHIFT_TIMEOUT` which is typically set to twice your
18normal pressed state time. When you press a key, a timer starts and then stops 18normal pressed state time. When you press a key, a timer starts, and if you
19when you release the key. If the time depressed is greater than or equal to the 19have not released the key after the `AUTO_SHIFT_TIMEOUT` period, then a shifted
20`AUTO_SHIFT_TIMEOUT`, then a shifted version of the key is emitted. If the time 20version of the key is emitted. If the time is less than the `AUTO_SHIFT_TIMEOUT`
21is less than the `AUTO_SHIFT_TIMEOUT` time, then the normal state is emitted. 21time, or you press another key, then the normal state is emitted.
22
23If `AUTO_SHIFT_REPEAT` is defined, there is keyrepeat support. Holding the key
24down will repeat the shifted key, though this can be disabled with
25`AUTO_SHIFT_NO_AUTO_REPEAT`. If you want to repeat the normal key, then tap it
26once then immediately (within `TAPPING_TERM`) hold it down again (this works
27with the shifted value as well if auto-repeat is disabled).
22 28
23## Are There Limitations to Auto Shift? 29## Are There Limitations to Auto Shift?
24 30
25Yes, unfortunately. 31Yes, unfortunately.
26 32
271. Key repeat will cease to work. For example, before if you wanted 20 'a' 33You will have characters that are shifted when you did not intend on shifting, and
28 characters, you could press and hold the 'a' key for a second or two. This no 34other characters you wanted shifted, but were not. This simply comes down to
29 longer works with Auto Shift because it is timing your depressed time instead 35practice. As we get in a hurry, we think we have hit the key long enough for a
30 of emitting a depressed key state to your operating system. 36shifted version, but we did not. On the other hand, we may think we are tapping
312. You will have characters that are shifted when you did not intend on shifting, and 37the keys, but really we have held it for a little longer than anticipated.
32 other characters you wanted shifted, but were not. This simply comes down to 38
33 practice. As we get in a hurry, we think we have hit the key long enough 39Additionally, with keyrepeat the desired shift state can get mixed up. It will
34 for a shifted version, but we did not. On the other hand, we may think we are 40always 'belong' to the last key pressed. For example, keyrepeating a capital
35 tapping the keys, but really we have held it for a little longer than 41and then tapping something lowercase (whether or not it's an Auto Shift key)
36 anticipated. 42will result in the capital's *key* still being held, but shift not.
37 43
38## How Do I Enable Auto Shift? 44## How Do I Enable Auto Shift?
39 45
@@ -103,6 +109,14 @@ Do not Auto Shift numeric keys, zero through nine.
103 109
104Do not Auto Shift alpha characters, which include A through Z. 110Do not Auto Shift alpha characters, which include A through Z.
105 111
112### AUTO_SHIFT_REPEAT (simple define)
113
114Enables keyrepeat.
115
116### AUTO_SHIFT_NO_AUTO_REPEAT (simple define)
117
118Disables automatically keyrepeating when `AUTO_SHIFT_TIMEOUT` is exceeded.
119
106## Using Auto Shift Setup 120## Using Auto Shift Setup
107 121
108This will enable you to define three keys temporarily to increase, decrease and report your `AUTO_SHIFT_TIMEOUT`. 122This will enable you to define three keys temporarily to increase, decrease and report your `AUTO_SHIFT_TIMEOUT`.