Enhancement of WPM feature (#11727)

1 files changed, 52 insertions, 15 deletions

diff --git a/docs/feature_wpm.md b/docs/feature_wpm.md
index 12dd080579..c8ec3a7f32 100644
--- a/docs/feature_wpm.md
+++ b/docs/feature_wpm.md
@@ -1,25 +1,62 @@
 # Word Per Minute (WPM) Calculcation
 
-The WPM feature uses time between keystrokes to compute a rolling average words
-per minute rate and makes this available for various uses.
+The WPM feature uses time between keystrokes to compute a rolling average words per minute rate and makes this available for various uses.
 
 Enable the WPM system by adding this to your `rules.mk`:
 
     WPM_ENABLE = yes
 
-For split keyboards using soft serial, the computed WPM
-score will be available on the master AND slave half.
+For split keyboards using soft serial, the computed WPM score will be available on the master AND slave half.
 
-## Public Functions
-
-`uint8_t get_current_wpm(void);`
-This function returns the current WPM as an unsigned integer.
+## Configuration
 
+|Define                       |Default       | Description                                                                              |
+|-----------------------------|--------------|------------------------------------------------------------------------------------------|
+|`WPM_SMOOTHING`              |`0.0487`      | Sets the smoothing to about 40 keystrokes                                                |
+|`WPM_ESTIMATED_WORD_SIZE`    |`5`           | This is the value used when estimating average word size (for regression and normal use) |
+|`WPM_ALLOW_COUNT_REGRESSOIN` |_Not defined_ | If defined allows the WPM to be decreased when hitting Delete or Backspace               |
+## Public Functions
 
-## Customized keys for WPM calc
-
-By default, the WPM score only includes letters, numbers, space and some
-punctuation.  If you want to change the set of characters considered as part of
-the WPM calculation, you can implement `wpm_keycode_user(uint16_t keycode)`
-and return true for any characters you would like included in the calculation,
-or false to not count that particular keycode.
+|Function                  |Description                                       |
+|--------------------------|--------------------------------------------------|
+|`get_current_wpm(void)`   | Returns the current WPM as a value between 0-255 |
+|`set_current_wpm(x)`      | Sets the current WPM to `x` (between 0-255)      |
+
+## Callbacks
+
+By default, the WPM score only includes letters, numbers, space and some punctuation.  If you want to change the set of characters considered as part of the WPM calculation, you can implement your own `bool wpm_keycode_user(uint16_t keycode)` and return true for any characters you would like included in the calculation, or false to not count that particular keycode.
+
+For instance, the default is:
+
+```c
+bool wpm_keycode_user(uint16_t keycode) {
+    if ((keycode >= QK_MOD_TAP && keycode <= QK_MOD_TAP_MAX) || (keycode >= QK_LAYER_TAP && keycode <= QK_LAYER_TAP_MAX) || (keycode >= QK_MODS && keycode <= QK_MODS_MAX)) {
+        keycode = keycode & 0xFF;
+    } else if (keycode > 0xFF) {
+        keycode = 0;
+    }
+    if ((keycode >= KC_A && keycode <= KC_0) || (keycode >= KC_TAB && keycode <= KC_SLASH)) {
+        return true;
+    }
+
+    return false;
+}
+```
+
+Additionally, if `WPM_ALLOW_COUNT_REGRESSION` is defined, there is the `uint8_t wpm_regress_count(uint16_t keycode)` function that allows you to decrease the WPM. This is useful if you want to be able to penalize certain keycodes (or even combinations). 
+
+__attribute__((weak)) uint8_t wpm_regress_count(uint16_t keycode) {
+    bool weak_modded = (keycode >= QK_LCTL && keycode < QK_LSFT) || (keycode >= QK_RCTL && keycode < QK_RSFT);
+    
+    if ((keycode >= QK_MOD_TAP && keycode <= QK_MOD_TAP_MAX) || (keycode >= QK_LAYER_TAP && keycode <= QK_LAYER_TAP_MAX) || (keycode >= QK_MODS && keycode <= QK_MODS_MAX)) {
+        keycode = keycode & 0xFF;
+    } else if (keycode > 0xFF) {
+        keycode = 0;
+    }
+    if (((get_mods() | get_oneshot_mods()) & MOD_MASK_CTRL} || weak_modded) && (keycode == KC_DEL || keycode == KC_BSPC)) {
+        return WPM_ESTIMATED_WORD_SIZE;
+    }
+    if (keycode == KC_DEL || keycode == KC_BSPC) {
+        return 1;
+    }
+}