You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

25 lines
875 B

  1. # Word Per Minute (WPM) Calculcation
  2. The WPM feature uses time between keystrokes to compute a rolling average words
  3. per minute rate and makes this available for various uses.
  4. Enable the WPM system by adding this to your `rules.mk`:
  5. WPM_ENABLE = yes
  6. For split keyboards using soft serial, the computed WPM
  7. score will be available on the master AND slave half.
  8. ## Public Functions
  9. `uint8_t get_current_wpm(void);`
  10. This function returns the current WPM as an unsigned integer.
  11. ## Customized keys for WPM calc
  12. By default, the WPM score only includes letters, numbers, space and some
  13. punctuation. If you want to change the set of characters considered as part of
  14. the WPM calculation, you can implement `wpm_keycode_user(uint16_t keycode)`
  15. and return true for any characters you would like included in the calculation,
  16. or false to not count that particular keycode.