aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2018-12-14 09:01:58 -0800
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2018-12-14 09:01:58 -0800
commit02d44beb4410b806cb8c38e272941d212fee8a74 (patch)
treeb82be304dcea0c838b45abe2e9909a9f30a49dc9 /docs
parent80dfd34fe454f8dde67145fef51eb82ef7ea2e45 (diff)
downloadqmk_firmware-02d44beb4410b806cb8c38e272941d212fee8a74.tar.gz
qmk_firmware-02d44beb4410b806cb8c38e272941d212fee8a74.zip
Fix up tap_code functionality (#4609)
* Add delay in Tap Code to avoid issues I think a few people have reporting issues with it working properly, and it may be a timing issue. The 'register_code' uses this sort of delay in some of the functions, and this is probably why. Adding the 100ms delay should hopefully fix any issues with it. * Make tap_code delay configurable * Update documentation * Bring tap_code16 inline with changes * Fix type for tap_code16 Bad copy-paste job * Just use the value check for the define * Clarify timing in docs Co-Authored-By: drashna <drashna@live.com> * Wordsmithing Co-Authored-By: drashna <drashna@live.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/config_options.md2
-rw-r--r--docs/feature_macros.md2
2 files changed, 4 insertions, 0 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index b811fa877..69fecc8b4 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -160,6 +160,8 @@ If you define these options you will enable the associated feature, which may in
160 * Set this to the number of combos that you're using in the [Combo](feature_combo.md) feature. 160 * Set this to the number of combos that you're using in the [Combo](feature_combo.md) feature.
161* `#define COMBO_TERM 200` 161* `#define COMBO_TERM 200`
162 * how long for the Combo keys to be detected. Defaults to `TAPPING_TERM` if not defined. 162 * how long for the Combo keys to be detected. Defaults to `TAPPING_TERM` if not defined.
163* `#define TAP_CODE_DELAY 100`
164 * Sets the delay between `register_code` and `unregister_code`, if you're having issues with it registering properly (common on VUSB boards). The value is in milliseconds.
163 165
164## RGB Light Configuration 166## RGB Light Configuration
165 167
diff --git a/docs/feature_macros.md b/docs/feature_macros.md
index 29ba29fef..aa13fb97f 100644
--- a/docs/feature_macros.md
+++ b/docs/feature_macros.md
@@ -250,6 +250,8 @@ Parallel to `register_code` function, this sends the `<kc>` keyup event to the c
250 250
251This will send `register_code(<kc>)` and then `unregister_code(<kc>)`. This is useful if you want to send both the press and release events ("tap" the key, rather than hold it). 251This will send `register_code(<kc>)` and then `unregister_code(<kc>)`. This is useful if you want to send both the press and release events ("tap" the key, rather than hold it).
252 252
253If you're having issues with taps (un)registering, you can add a delay between the register and unregister events by setting `#define TAP_CODE_DELAY 100` in your `config.h` file. The value is in milliseconds.
254
253### `clear_keyboard();` 255### `clear_keyboard();`
254 256
255This will clear all mods and keys currently pressed. 257This will clear all mods and keys currently pressed.