aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/_summary.md1
-rw-r--r--docs/feature_wpm.md25
2 files changed, 26 insertions, 0 deletions
diff --git a/docs/_summary.md b/docs/_summary.md
index d6186bbf9..4a6e6996e 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -80,6 +80,7 @@
80 * [Terminal](feature_terminal.md) 80 * [Terminal](feature_terminal.md)
81 * [Unicode](feature_unicode.md) 81 * [Unicode](feature_unicode.md)
82 * [Userspace](feature_userspace.md) 82 * [Userspace](feature_userspace.md)
83 * [WPM Calculation](feature_wpm.md)
83 84
84 * Hardware Features 85 * Hardware Features
85 * Displays 86 * Displays
diff --git a/docs/feature_wpm.md b/docs/feature_wpm.md
new file mode 100644
index 000000000..12dd08057
--- /dev/null
+++ b/docs/feature_wpm.md
@@ -0,0 +1,25 @@
1# Word Per Minute (WPM) Calculcation
2
3The WPM feature uses time between keystrokes to compute a rolling average words
4per minute rate and makes this available for various uses.
5
6Enable the WPM system by adding this to your `rules.mk`:
7
8 WPM_ENABLE = yes
9
10For split keyboards using soft serial, the computed WPM
11score will be available on the master AND slave half.
12
13## Public Functions
14
15`uint8_t get_current_wpm(void);`
16This function returns the current WPM as an unsigned integer.
17
18
19## Customized keys for WPM calc
20
21By default, the WPM score only includes letters, numbers, space and some
22punctuation. If you want to change the set of characters considered as part of
23the WPM calculation, you can implement `wpm_keycode_user(uint16_t keycode)`
24and return true for any characters you would like included in the calculation,
25or false to not count that particular keycode.