From bfb2f8e0a8f809374fdec102eb02c3bce46a14ee Mon Sep 17 00:00:00 2001 From: brickbots Date: Sun, 22 Mar 2020 06:06:16 -0700 Subject: Add Word Per Minute calculation feature (#8054) * Add Word Per Minute calculation feature * Fix copyright info * Remove header from quantum.c, setup overloadable keycode inclusion for WPM, update docs * Simplify logic for keycode filtering * Adding link from summary to wpm_feature info * Update docs/feature_wpm.md Typo in function prototype example in docs Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Add WPM transport via i2c Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> --- quantum/wpm.c | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 quantum/wpm.c (limited to 'quantum/wpm.c') diff --git a/quantum/wpm.c b/quantum/wpm.c new file mode 100644 index 0000000000..d4c971f313 --- /dev/null +++ b/quantum/wpm.c @@ -0,0 +1,67 @@ +/* + * Copyright 2020 Richard Sutherland (rich@brickbots.com) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include "wpm.h" + +//WPM Stuff +static uint8_t current_wpm = 0; +static uint8_t latest_wpm = 0; +static uint16_t wpm_timer = 0; + +//This smoothing is 40 keystrokes +static const float wpm_smoothing = 0.0487; + +void set_current_wpm(uint8_t new_wpm) { current_wpm = new_wpm; } + +uint8_t get_current_wpm(void) { return current_wpm; } + +bool wpm_keycode(uint16_t keycode) { return wpm_keycode_kb(keycode); } + +__attribute__((weak)) bool wpm_keycode_kb(uint16_t keycode) { return wpm_keycode_user(keycode); } + +__attribute__((weak)) 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; +} + + +void update_wpm(uint16_t keycode) { + if(wpm_keycode(keycode)) { + if(wpm_timer > 0) { + latest_wpm = 60000 / timer_elapsed(wpm_timer) / 5; + current_wpm = (latest_wpm - current_wpm) * wpm_smoothing + current_wpm; + } + wpm_timer = timer_read(); + } +} + +void decay_wpm(void) { + if (timer_elapsed(wpm_timer) > 1000) { + current_wpm = (0 - current_wpm) * wpm_smoothing + + current_wpm; + wpm_timer = timer_read(); + } +} -- cgit v1.2.3