summaryrefslogtreecommitdiffstats
path: root/docs/feature_wpm.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature_wpm.md')
-rw-r--r--docs/feature_wpm.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/feature_wpm.md b/docs/feature_wpm.md
new file mode 100644
index 0000000000..12dd080579
--- /dev/null
+++ b/docs/feature_wpm.md
@@ -0,0 +1,25 @@
+# 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.
+
+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.
+
+## Public Functions
+
+`uint8_t get_current_wpm(void);`
+This function returns the current WPM as an unsigned integer.
+
+
+## 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.