cm/cmdr-keyboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remover tap and hold support

Browse Source
This commit is contained in:
Christoffer Martinsson 2022-11-20 17:59:57 +01:00
parent 3aaf744800
commit 2b2ca06007
1 changed files with 49 additions and 189 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

230
firmware/src/main.cpp
View File

@ -60,7 +60,6 @@
* * Status indication -
* - LED off = Normal mode
* - LED flashing = Caps Lock activated
* * Tap/Hold functionality (only for layer0)
*/
#include <Arduino.h>
@ -91,19 +90,11 @@ struct Button
{
int keypad_kchar = 0;
uint16_t keycode = NO_KEY;
uint16_t tap_keycode = NO_KEY;
uint16_t fn1_keycode = NO_KEY;
uint16_t fn2_keycode = NO_KEY;
bool hold_direct = true;
int kstate = IDLE;
uint16_t last_keycode = NO_KEY;
bool run_keycode = false;
int tap_state = 0;
bool tap_timeout_enable = false;
bool tap_release_enable = false;
unsigned long tap_timeout_timestamp = 0;
unsigned long tap_release_timestamp = 0;
bool tap_inhibit = false;
};
const byte KP_ROWS = 4;
@ -121,7 +112,7 @@ char kp_keys[KP_ROWS][KP_COLS] = {
Keypad kp_keypad = Keypad(makeKeymap(kp_keys), kp_rowPins, kp_colPins, KP_ROWS, KP_COLS);
/* Valid "Fn0 (hold) key" when using tap mode are: KEY_LEFT_SHIFT, KEY_RIGHT_SHIFT, KEY_LEFT_CTRL, KEY_RIGHT_CTRL, KEY_RIGHT_ALT, KEY_LEFT_GUI, KEY_RIGHT_GUI, KEY_FN1, KEY_FN2
/*
* "Button ID" corresponding with the physical design of the actual keyboard. DO NOT CHANGE BTN ID!
------------------------------------- -------------------------------------
@ -130,61 +121,58 @@ Keypad kp_keypad = Keypad(makeKeymap(kp_keys), kp_rowPins, kp_colPins, KP_ROWS,
| 25 | 26 | 27 | 28 | 29 | 30 | | 31 | 32 | 33 | 34 | 35 | 36 |
------------------| 37 | 38 | 39 | | 40 | 41 | 42 |------------------
------------------- -------------------
* "Fn0 hold key" is normal key in non tap mode. In tap mode this key is the hold key.
* "Fn0 tap key" enables tap mode.
* "Fn0 key" is the layer 0 key to use.
* "Fn1 key" is the layer 1 key to use. Don NOT add KEY_FN1 or KEY_FN2 to this layer.
* "Fn2 key" is the layer 2 key to use. Don NOT add KEY_FN1 or KEY_FN2 to this layer.
"Fn1 key" and "Fn2 key" are N/A when using tap mode and should me defined as NO_KEY.
* "Hold direct" enables sending PRESS command as soon as the hold key is pressed (regardless if you intend to press the tap key).
/* Keymap config ----------------------------------------------------------------------------------------------------------------------------------- */
// clang-format off
Button buttons[NBR_OF_BUTTONS] =
{
/* Btn ID Fn0 (hold) key Fn0 tap key Fn1 key Fn2 key Hold direct */
{1, KEY_TAB, NO_KEY, KEY_ESC, NO_KEY, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{2, KEY_Q, NO_KEY, KEY_F1, KEY_F12, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{3, KEY_W, NO_KEY, KEY_F2, KEY_F13, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{4, KEY_E, NO_KEY, KEY_F3, KEY_F14, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{5, KEY_R, NO_KEY, KEY_F4, KEY_F15, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{6, KEY_T, NO_KEY, KEY_F5, KEY_F16, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{7, KEY_Y, NO_KEY, KEY_F6, '§', false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{8, KEY_U, NO_KEY, KEY_F7, KEY_M1, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{9, KEY_I, NO_KEY, KEY_F8, KEY_M2, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{10, KEY_O, NO_KEY, KEY_F9, KEY_M3, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{11, KEY_P, NO_KEY, KEY_F10, KEY_MWU, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{12, 'å', NO_KEY, KEY_BACKSPACE, KEY_CAPS_LOCK, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{13, KEY_LEFT_CTRL, NO_KEY, KEY_LEFT_CTRL, KEY_LEFT_CTRL, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{14, KEY_A, NO_KEY, KEY_1, KEY_MEDIA_PLAY_PAUSE, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{15, KEY_S, NO_KEY, KEY_2, KEY_MEDIA_NEXT_TRACK, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{16, KEY_D, NO_KEY, KEY_3, KEY_F17, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{17, KEY_F, NO_KEY, KEY_4, KEY_F18, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{18, KEY_G, NO_KEY, KEY_5, KEY_F19, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{19, KEY_H, NO_KEY, KEY_6, KEY_LEFT_ARROW, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{20, KEY_J, NO_KEY, KEY_7, KEY_DOWN_ARROW, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{21, KEY_K, NO_KEY, KEY_8, KEY_UP_ARROW, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{22, KEY_L, NO_KEY, KEY_9, KEY_RIGHT_ARROW, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{23, 'ö', NO_KEY, KEY_0, KEY_DELETE, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{24, 'ä', NO_KEY, KEY_ENTER, NO_KEY, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{25, KEY_LEFT_SHIFT, NO_KEY, KEY_LEFT_SHIFT, KEY_LEFT_SHIFT, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{26, KEY_Z, NO_KEY, KEY_6, KEY_F20, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{27, KEY_X, NO_KEY, KEY_7, KEY_F21, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{28, KEY_C, NO_KEY, KEY_8, KEY_F22, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{29, KEY_V, NO_KEY, KEY_9, KEY_F23, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{30, KEY_B, NO_KEY, KEY_0, KEY_F24, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{31, KEY_N, NO_KEY, '<', KEY_HOME, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{32, KEY_M, NO_KEY, KEY_EQUAL, KEY_PAGE_DOWN, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{33, KEY_COMMA, NO_KEY, KEY_BACKSLASH, KEY_PAGE_UP, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{34, KEY_PERIOD, NO_KEY, KEY_RIGHT_BRACE, KEY_END, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{35, KEY_SLASH, NO_KEY, KEY_MINUS, KEY_INSERT, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{36, KEY_RIGHT_SHIFT, NO_KEY, KEY_RIGHT_SHIFT, KEY_RIGHT_SHIFT, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{37, KEY_LEFT_ALT, NO_KEY, KEY_LEFT_ALT, KEY_LEFT_ALT, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{38, KEY_FN1, NO_KEY, KEY_FN1, KEY_FN1, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{39, KEY_SPACE, NO_KEY, KEY_SPACE, KEY_LEFT_GUI, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{40, KEY_SPACE, NO_KEY, KEY_BACKSPACE, NO_KEY, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{41, KEY_FN1, NO_KEY, KEY_FN1, KEY_FN1, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false},
{42, KEY_LEFT_GUI, NO_KEY, KEY_RIGHT_ALT, NO_KEY, false, IDLE, NO_KEY, false, 0, false, false, 0, 0, false}};
/* Btn ID Fn0 (hold) key Fn1 key Fn2 key */
{1, KEY_TAB, KEY_ESC, KEY_F11, IDLE, NO_KEY, false},
{2, KEY_Q, KEY_F1, KEY_F12, IDLE, NO_KEY, false},
{3, KEY_W, KEY_F2, KEY_F13, IDLE, NO_KEY, false},
{4, KEY_E, KEY_F3, KEY_F14, IDLE, NO_KEY, false},
{5, KEY_R, KEY_F4, KEY_F15, IDLE, NO_KEY, false},
{6, KEY_T, KEY_F5, KEY_F16, IDLE, NO_KEY, false},
{7, KEY_Y, KEY_F6, '§', IDLE, NO_KEY, false},
{8, KEY_U, KEY_F7, KEY_M1, IDLE, NO_KEY, false},
{9, KEY_I, KEY_F8, KEY_M2, IDLE, NO_KEY, false},
{10, KEY_O, KEY_F9, KEY_M3, IDLE, NO_KEY, false},
{11, KEY_P, KEY_F10, KEY_MWU, IDLE, NO_KEY, false},
{12, 'å', KEY_BACKSPACE, KEY_CAPS_LOCK, IDLE, NO_KEY, false},
{13, KEY_LEFT_CTRL, KEY_LEFT_CTRL, KEY_LEFT_CTRL, IDLE, NO_KEY, false},
{14, KEY_A, KEY_1, KEY_MEDIA_PLAY_PAUSE, IDLE, NO_KEY, false},
{15, KEY_S, KEY_2, KEY_MEDIA_NEXT_TRACK, IDLE, NO_KEY, false},
{16, KEY_D, KEY_3, KEY_F17, IDLE, NO_KEY, false},
{17, KEY_F, KEY_4, KEY_F18, IDLE, NO_KEY, false},
{18, KEY_G, KEY_5, KEY_F19, IDLE, NO_KEY, false},
{19, KEY_H, KEY_6, KEY_LEFT_ARROW, IDLE, NO_KEY, false},
{20, KEY_J, KEY_7, KEY_DOWN_ARROW, IDLE, NO_KEY, false},
{21, KEY_K, KEY_8, KEY_UP_ARROW, IDLE, NO_KEY, false},
{22, KEY_L, KEY_9, KEY_RIGHT_ARROW, IDLE, NO_KEY, false},
{23, 'ö', KEY_0, KEY_DELETE, IDLE, NO_KEY, false},
{24, 'ä', KEY_ENTER, NO_KEY, IDLE, NO_KEY, false},
{25, KEY_LEFT_SHIFT, KEY_LEFT_SHIFT, KEY_LEFT_SHIFT, IDLE, NO_KEY, false},
{26, KEY_Z, KEY_6, KEY_F20, IDLE, NO_KEY, false},
{27, KEY_X, KEY_7, KEY_F21, IDLE, NO_KEY, false},
{28, KEY_C, KEY_8, KEY_F22, IDLE, NO_KEY, false},
{29, KEY_V, KEY_9, KEY_F23, IDLE, NO_KEY, false},
{30, KEY_B, KEY_0, KEY_F24, IDLE, NO_KEY, false},
{31, KEY_N, '<', KEY_HOME, IDLE, NO_KEY, false},
{32, KEY_M, KEY_EQUAL, KEY_PAGE_DOWN, IDLE, NO_KEY, false},
{33, KEY_COMMA, KEY_BACKSLASH, KEY_PAGE_UP, IDLE, NO_KEY, false},
{34, KEY_PERIOD, KEY_RIGHT_BRACE, KEY_END, IDLE, NO_KEY, false},
{35, KEY_SLASH, KEY_MINUS, KEY_INSERT, IDLE, NO_KEY, false},
{36, KEY_RIGHT_SHIFT, KEY_RIGHT_SHIFT, KEY_RIGHT_SHIFT, IDLE, NO_KEY, false},
{37, KEY_LEFT_ALT, KEY_LEFT_ALT, KEY_LEFT_ALT, IDLE, NO_KEY, false},
{38, KEY_FN1, KEY_FN1, KEY_FN1, IDLE, NO_KEY, false},
{39, KEY_SPACE, KEY_SPACE, KEY_LEFT_GUI, IDLE, NO_KEY, false},
{40, KEY_SPACE, KEY_BACKSPACE, NO_KEY, IDLE, NO_KEY, false},
{41, KEY_FN1, KEY_FN1, KEY_FN1, IDLE, NO_KEY, false},
{42, KEY_LEFT_GUI, KEY_RIGHT_ALT, NO_KEY, IDLE, NO_KEY, false}};
// clang-format on
/* End of keymap config ----------------------------------------------------------------------------------------------------------------------------- */
@ -404,26 +392,6 @@ void scan_buttons()
{
if (buttons[j].keypad_kchar == kp_keypad.key[i].kchar && kp_keypad.key[i].stateChanged == true)
{
/* Tap state:
0 = idle (not pressed for a while)
1 = pressed
2 = released within timeout, pressing tap key
3 = pressed again within timeout, holding tap key */
if (buttons[j].tap_keycode != NO_KEY && buttons[j].tap_state == 0)
{
buttons[j].tap_timeout_timestamp = current_timestamp + TAP_TIMEOUT;
buttons[j].tap_timeout_enable = true;
buttons[j].tap_release_timestamp = current_timestamp + TAP_TIMEOUT + 10;
buttons[j].tap_release_enable = true;
buttons[j].tap_state = 1;
}
else if (buttons[j].tap_keycode != NO_KEY && buttons[j].tap_state == 2)
{
buttons[j].tap_timeout_enable = false;
buttons[j].tap_release_enable = false;
buttons[j].tap_state = 3;
}
buttons[j].run_keycode = true;
buttons[j].kstate = PRESSED;
break;
@ -436,21 +404,6 @@ void scan_buttons()
{
if (buttons[j].keypad_kchar == kp_keypad.key[i].kchar && kp_keypad.key[i].stateChanged == true)
{
/* Tap state:
0 = idle (not pressed for a while)
1 = pressed
2 = released within timeout, pressing tap key
3 = pressed again within timeout, holding tap key */
if (buttons[j].tap_keycode != NO_KEY && buttons[j].tap_state == 1)
{
buttons[j].tap_release_timestamp = current_timestamp + TAP_TIMEOUT + 10;
buttons[j].tap_release_enable = true;
buttons[j].tap_state = 2;
}
else
{
buttons[j].tap_state = 0;
}
buttons[j].run_keycode = true;
buttons[j].kstate = RELEASED;
break;
@ -459,21 +412,6 @@ void scan_buttons()
}
}
/* Check if any "non tap keys" has been pressed */
for (int i = 0; i < NBR_OF_BUTTONS; i++)
{
if (buttons[i].run_keycode == true && buttons[i].tap_keycode == NO_KEY && buttons[i].kstate == PRESSED)
{
for (int j = 0; j < NBR_OF_BUTTONS; j++)
{
if (buttons[j].tap_keycode != NO_KEY)
{
buttons[j].tap_inhibit = true;
}
}
}
}
/* Execute key commands */
for (int i = 0; i < NBR_OF_BUTTONS; i++)
{
@ -484,29 +422,10 @@ void scan_buttons()
if (buttons[i].kstate == PRESSED)
{
if (fn_mode == 0)
{
/* Check if key is in tap mode */
if (buttons[i].tap_keycode != NO_KEY)
{
/* Key is in tap mode. Perform action dependant on tap state*/
if (buttons[i].tap_state == 1)
{
if (buttons[i].hold_direct == true)
{
/* Press hold key if "hold direct" is enabled (tap state = 1) */
set_key(buttons[i].keycode, PRESSED);
}
/* Reset tap inhibit flag */
buttons[i].tap_inhibit = false;
}
}
else
{
set_key(buttons[i].keycode, PRESSED);
buttons[i].last_keycode = buttons[i].keycode;
}
}
else if (fn_mode == 1)
{
set_key(buttons[i].fn1_keycode, PRESSED);
@ -519,37 +438,10 @@ void scan_buttons()
}
}
else if (buttons[i].kstate == RELEASED)
{
/* Check if key is in tap mode */
if (buttons[i].tap_keycode != NO_KEY)
{
/* Key is in tap mode. Perform action dependant on tap state*/
if (buttons[i].tap_state == 2)
{
/* Press tap key if no other keys are pressed (tap state = 2) */
set_key(buttons[i].tap_keycode, RELEASED); // Fix for not send press and hold for the tap key
set_key(buttons[i].keycode, RELEASED);
set_key(buttons[i].last_keycode, RELEASED);
if (buttons[i].tap_inhibit == false)
{
set_key(buttons[i].tap_keycode, PRESSED);
}
}
else
{
/* Release all keys (tap state = 0,1,3) */
set_key(buttons[i].keycode, RELEASED);
set_key(buttons[i].tap_keycode, RELEASED);
set_key(buttons[i].last_keycode, RELEASED);
buttons[i].tap_state = 0;
}
}
else
{
/* Sending release command for last keycode related to this button */
set_key(buttons[i].last_keycode, RELEASED);
}
}
/* Reset run_keycode flag */
buttons[i].run_keycode = false;
}
@ -588,38 +480,6 @@ void loop()
scan_buttons();
}
/* Fn tap timeout TAP_TIMEOUT */
for (int i = 0; i < NBR_OF_BUTTONS; i++)
{
if (current_timestamp >= buttons[i].tap_timeout_timestamp && buttons[i].tap_timeout_enable)
{
if (buttons[i].tap_state == 1)
{
if (buttons[i].hold_direct == false)
{
set_key(buttons[i].keycode, PRESSED);
}
buttons[i].tap_state = 0;
}
else if (buttons[i].tap_state == 2)
{
buttons[i].tap_state = 0;
}
buttons[i].tap_timeout_enable = false;
}
}
/* Fn tap release TAP_TIMEOUT + 10ms */
for (int i = 0; i < NBR_OF_BUTTONS; i++)
{
if (current_timestamp >= buttons[i].tap_release_timestamp && buttons[i].tap_release_enable)
{
set_key(buttons[i].tap_keycode, RELEASED);
buttons[i].tap_release_enable = false;
buttons[i].tap_state = 0;
}
}
/* Update mouse 20ms */
if (current_timestamp >= mouse_wheel_timestamp && (mouse_wheel != 0 || mouse_x != 0 || mouse_y != 0 || mouse_d == true || mouse_l == true || mouse_r == true || mouse_u == true))
{