Per Key Leader Timing Option (#4026)

* leader changes to enable per key timing option

* Changes requested to docs for @drashna

* Changes requested by @drashna

diff --git a/docs/config_options.md b/docs/config_options.md
index bea4acb010aad836e4b364002bf1c0bc87c1a45d..fb1655e9a364f9502d95a7dea147a837310b8819 100644 (file)
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -143,6 +143,8 @@ If you define these options you will enable the associated feature, which may in
   * Breaks any Tap Toggle functionality (`TT` or the One Shot Tap Toggle)
 * `#define LEADER_TIMEOUT 300`
   * how long before the leader key times out
+* `#define LEADER_PER_KEY_TIMING`
+  * sets the timer for leader key chords to run on each key press rather than overall
 * `#define ONESHOT_TIMEOUT 300`
   * how long before oneshot times out
 * `#define ONESHOT_TAP_TOGGLE 2`
@@ -194,7 +196,7 @@ Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in yo
 
 * `#define SPLIT_HAND_PIN B7`
   * For using high/low pin to determine handedness, low = right hand, high = left hand. Replace 'B7' with the pin you are using. This is optional and you can still use the EEHANDS method or MASTER_LEFT / MASTER_RIGHT defines like the stock Let's Split uses.
-  
+
 * `#define USE_I2C`
   * For using I2C instead of Serial (defaults to serial)
 
@@ -252,6 +254,8 @@ Use these to enable or disable building certain features. The more you have enab
   * Enable the audio subsystem.
 * `RGBLIGHT_ENABLE`
   * Enable keyboard underlight functionality
+* `LEADER_ENABLE`
+  * Enable leader key chording
 * `MIDI_ENABLE`
   * MIDI controls
 * `UNICODE_ENABLE`

diff --git a/docs/feature_leader_key.md b/docs/feature_leader_key.md
index 92aebd463d67bd3655371cb47d740dbff90c69e2..9b49e0fd96126f088fc7cfc7ed74fde539e30038 100644 (file)
--- a/docs/feature_leader_key.md
+++ b/docs/feature_leader_key.md
@@ -47,3 +47,26 @@ To add support for Leader Key you simply need to add a single line to your keyma
 ```
 LEADER_ENABLE = yes
 ```
+
+## Per Key Timing on Leader keys
+
+Rather than relying on an incredibly high timeout for long leader key strings or those of us without 200wpm typing skills, we can enable per key timing to ensure that each key pressed provides us with more time to finish our stroke. This is incredibly helpful with leader key emulation of tap dance (read: multiple taps of the same key like C, C, C).
+
+In order to enable this, place this in your `config.h`:
+```
+#define LEADER_PER_KEY_TIMING
+```
+
+After this, it's recommended that you lower your `LEADER_TIMEOUT` to something less that 300ms.
+
+```
+#define LEADER_TIMEOUT 250
+```
+
+Now, something like this won't seem impossible to do without a 1000MS leader key timeout:
+
+```
+SEQ_THREE_KEYS(KC_C, KC_C, KC_C) {
+  SEND_STRING("Per key timing is great!!!");
+}
+```

diff --git a/quantum/process_keycode/process_leader.c b/quantum/process_keycode/process_leader.c
index eddbf71f7001d0a14719fd7e43b8fc63fe655465..b32fc1db6a04b89cbc03d4fcbe7a7e79ad5bd83b 100644 (file)
--- a/quantum/process_keycode/process_leader.c
+++ b/quantum/process_keycode/process_leader.c
@@ -38,9 +38,15 @@ uint8_t leader_sequence_size = 0;
 bool process_leader(uint16_t keycode, keyrecord_t *record) {
   // Leader key set-up
   if (record->event.pressed) {
+#ifdef LEADER_PER_KEY_TIMING
+    leader_time = timer_read();
+#endif
     if (!leading && keycode == KC_LEAD) {
       leader_start();
       leading = true;
+#ifndef LEADER_PER_KEY_TIMING
+      leader_time = timer_read();
+#endif
       leader_time = timer_read();
       leader_sequence_size = 0;
       leader_sequence[0] = 0;