summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJonavin <71780717+Jonavin@users.noreply.github.com>2021-07-30 01:38:38 -0400
committerGitHub <noreply@github.com>2021-07-29 22:38:38 -0700
commit03212ced241522351f5e019946dd701c78793a1f (patch)
treef6f796c9db203b1475657488bb91b3f0437a2a38
parent7e1d28006ffeb66cd4d6a987f2aeea04587b87cb (diff)
[Keymap] jonavin gmmk pro keymap add RGB functionality (#13591)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Jonavin <=>
-rw-r--r--keyboards/gmmk/pro/keymaps/jonavin/config.h5
-rw-r--r--keyboards/gmmk/pro/keymaps/jonavin/keymap.c219
-rw-r--r--keyboards/gmmk/pro/keymaps/jonavin/readme.md22
-rw-r--r--keyboards/gmmk/pro/keymaps/jonavin/rgb_matrix_map.h144
4 files changed, 356 insertions, 34 deletions
diff --git a/keyboards/gmmk/pro/keymaps/jonavin/config.h b/keyboards/gmmk/pro/keymaps/jonavin/config.h
index d7219b2571..b77cb05f5f 100644
--- a/keyboards/gmmk/pro/keymaps/jonavin/config.h
+++ b/keyboards/gmmk/pro/keymaps/jonavin/config.h
@@ -26,3 +26,8 @@
//Always send Escape if Control is pressed
#define TAPPING_TERM 180
+
+#ifdef RGB_MATRIX_ENABLE
+ #define RGB_MATRIX_STARTUP_MODE RGB_MATRIX_SOLID_COLOR
+ #define RGB_DISABLE_WHEN_USB_SUSPENDED true
+#endif
diff --git a/keyboards/gmmk/pro/keymaps/jonavin/keymap.c b/keyboards/gmmk/pro/keymaps/jonavin/keymap.c
index 7289c1dd9e..8b37449576 100644
--- a/keyboards/gmmk/pro/keymaps/jonavin/keymap.c
+++ b/keyboards/gmmk/pro/keymaps/jonavin/keymap.c
@@ -16,6 +16,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include QMK_KEYBOARD_H
+#include "rgb_matrix_map.h"
+
+#define ARRAYSIZE(arr) sizeof(arr)/sizeof(arr[0])
enum custom_layers {
_BASE,
@@ -27,6 +30,8 @@ enum custom_layers {
enum custom_keycodes {
KC_00 = SAFE_RANGE,
KC_WINLCK, //Toggles Win key on and off
+ RGB_TOI, // Timeout idle time up
+ RGB_TOD, // Timeout idle time down
};
// Tap Dance Definitions
@@ -43,31 +48,6 @@ qk_tap_dance_action_t tap_dance_actions[] = {
bool _isWinKeyDisabled = false;
-bool process_record_user(uint16_t keycode, keyrecord_t *record) {
- switch (keycode) {
- case KC_00:
- if (record->event.pressed) {
- // when keycode KC_00 is pressed
- SEND_STRING("00");
- } else {
- // when keycode KC_00 is released
- }
- break;
-
- case KC_WINLCK:
- if (record->event.pressed) {
- _isWinKeyDisabled = !_isWinKeyDisabled; //toggle status
- if(_isWinKeyDisabled) {
- process_magic(GUI_OFF, record);
- } else {
- process_magic(GUI_ON, record);
- }
- } else unregister_code16(keycode);
- break;
- }
- return true;
-};
-
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
@@ -93,8 +73,8 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RGB_TOG,
_______, _______, RGB_VAI, _______, _______, _______, _______, KC_PSCR, KC_SLCK, KC_PAUS, _______, _______, _______, RESET, KC_HOME,
KC_CAPS, _______, RGB_VAD, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_END,
- _______, _______, RGB_HUI, _______, _______, _______, KC_NLCK, _______, _______, _______, _______, _______, RGB_MOD, _______,
- _______, KC_WINLCK, _______, _______, _______, _______, _______, RGB_SPD, RGB_RMOD, RGB_SPI
+ _______, _______, RGB_HUI, _______, _______, _______, KC_NLCK, _______, RGB_TOD, RGB_TOI, _______, _______, RGB_MOD, _______,
+ _______, KC_WINLCK, _______, _______, _______, _______, _______, RGB_SPD, RGB_RMOD, RGB_SPI
),
[_MO2] = LAYOUT(
@@ -117,12 +97,93 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
};
+
+// TIMEOUTS
+#define TIMEOUT_THRESHOLD_DEFAULT 5 // default timeout minutes
+#define TIMEOUT_THRESHOLD_MAX 140 // upper limits (2 hours and 10 minutes -- no rgb indicators above this value)
+static uint16_t timeout_timer = 0;
+static uint16_t timeout_counter = 0; //in minute intervals
+static uint16_t timeout_threshold = TIMEOUT_THRESHOLD_DEFAULT;
+
+void timeout_reset_timer(void) {
+ timeout_timer = timer_read();
+ timeout_counter = 0;
+};
+
+void timeout_update_threshold(bool increase) {
+ if (increase && timeout_threshold < TIMEOUT_THRESHOLD_MAX) timeout_threshold++;
+ if (!increase && timeout_threshold > 0) timeout_threshold--;
+};
+
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+ switch (keycode) {
+ case KC_00:
+ if (record->event.pressed) {
+ // when keycode KC_00 is pressed
+ SEND_STRING("00");
+ } else {
+ // when keycode KC_00 is released
+ }
+ break;
+ case KC_WINLCK:
+ if (record->event.pressed) {
+ _isWinKeyDisabled = !_isWinKeyDisabled; //toggle status
+ if(_isWinKeyDisabled) {
+ process_magic(GUI_OFF, record);
+ } else {
+ process_magic(GUI_ON, record);
+ }
+ } else unregister_code16(keycode);
+ break;
+ case RGB_TOI:
+ if(record->event.pressed) {
+ timeout_update_threshold(true);
+ } else unregister_code16(keycode);
+ break;
+ case RGB_TOD:
+ if(record->event.pressed) {
+ timeout_update_threshold(false); //decrease timeout
+ } else unregister_code16(keycode);
+ break;
+ default:
+ if (record->event.pressed) { //reset activity timer
+ #ifdef RGB_MATRIX_ENABLE
+ rgb_matrix_enable();
+ #endif
+ timeout_reset_timer();
+ }
+ break;
+ }
+ return true;
+};
+
+void matrix_scan_user(void) {
+ if (timeout_threshold > 0) {
+ if (timer_elapsed(timeout_timer) >= 60000) { // 1 minute tick
+ timeout_counter++;
+ timeout_timer = timer_read();
+ }
+ #ifdef RGB_MATRIX_ENABLE
+ if (timeout_threshold > 0 && timeout_counter >= timeout_threshold) {
+ rgb_matrix_disable_noeeprom();
+ }
+ #endif
+ } // timeout_threshold = 0 will disable timeout
+};
+
+
#ifdef ENCODER_ENABLE // Encoder Functionality
+ uint8_t selected_layer = 0;
bool encoder_update_user(uint8_t index, bool clockwise) {
-
if ( clockwise ) {
- if (keyboard_report->mods & MOD_BIT(KC_LSFT) ) { // If you are holding L shift, Page up
+ if (keyboard_report->mods & MOD_BIT(KC_LSFT) ) { // If you are holding L shift, encoder changes layers
+ if(selected_layer < 3) {
+ selected_layer ++;
+ layer_move(selected_layer);
+ }
+ } else if (keyboard_report->mods & MOD_BIT(KC_RSFT) ) { // If you are holding R shift, Page up
unregister_mods(MOD_BIT(KC_LSFT));
register_code(KC_PGDN);
register_mods(MOD_BIT(KC_LSFT));
@@ -131,10 +192,22 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
} else if (keyboard_report->mods & MOD_BIT(KC_LALT)) { // if holding Left Alt, change media next track
tap_code(KC_MEDIA_NEXT_TRACK);
} else {
- tap_code(KC_VOLU); // Otherwise it just changes volume
+ switch (selected_layer) {
+ case _FN1:
+ timeout_update_threshold(true);
+ break;
+ default:
+ tap_code(KC_VOLU); // Otherwise it just changes volume
+ break;
+ }
}
} else {
if (keyboard_report->mods & MOD_BIT(KC_LSFT) ) {
+ if (selected_layer > 0) {
+ selected_layer --;
+ layer_move(selected_layer);
+ }
+ } else if (keyboard_report->mods & MOD_BIT(KC_RSFT) ) {
unregister_mods(MOD_BIT(KC_LSFT));
register_code(KC_PGUP);
register_mods(MOD_BIT(KC_LSFT));
@@ -143,9 +216,93 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
} else if (keyboard_report->mods & MOD_BIT(KC_LALT)) { // if holding Left Alt, change media previous track
tap_code(KC_MEDIA_PREV_TRACK);
} else {
- tap_code(KC_VOLD);
+ switch (selected_layer) {
+ case _FN1:
+ timeout_update_threshold(false);
+ break;
+ default:
+ tap_code(KC_VOLD);
+ break;
+ }
}
}
+
return true;
}
#endif
+
+#ifdef RGB_MATRIX_ENABLE
+ // Capslock, Scroll lock and Numlock indicator on Left side lights.
+ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+ if (IS_HOST_LED_ON(USB_LED_SCROLL_LOCK)) {
+ rgb_matrix_set_color(LED_L1, RGB_GREEN);
+ rgb_matrix_set_color(LED_L2, RGB_GREEN);
+ }
+ if (!IS_HOST_LED_ON(USB_LED_NUM_LOCK)) { // on if NUM lock is OFF
+ rgb_matrix_set_color(LED_L3, RGB_MAGENTA);
+ rgb_matrix_set_color(LED_L4, RGB_MAGENTA);
+ }
+ if (IS_HOST_LED_ON(USB_LED_CAPS_LOCK)) {
+ rgb_matrix_set_color(LED_L5, RGB_RED);
+ rgb_matrix_set_color(LED_L6, RGB_RED);
+ rgb_matrix_set_color(LED_L7, RGB_RED);
+ }
+ if (_isWinKeyDisabled) {
+ rgb_matrix_set_color(LED_LWIN, RGB_RED); //light up Win key when disabled
+ }
+ switch(get_highest_layer(layer_state)){ // special handling per layer
+ case _FN1: // on Fn layer select what the encoder does when pressed
+ rgb_matrix_set_color(LED_R2, RGB_RED);
+ rgb_matrix_set_color(LED_R3, RGB_RED);
+ rgb_matrix_set_color(LED_R4, RGB_RED);
+ rgb_matrix_set_color(LED_FN, RGB_RED); //FN key
+
+ // Add RGB Timeout Indicator -- shows 0 to 139 using F row and num row; larger numbers using 16bit code
+ if (timeout_threshold <= 10) rgb_matrix_set_color(LED_LIST_FUNCROW[timeout_threshold], RGB_RED);
+ else if (timeout_threshold < 140) {
+ rgb_matrix_set_color(LED_LIST_FUNCROW[(timeout_threshold / 10)], RGB_RED);
+ rgb_matrix_set_color(LED_LIST_NUMROW[(timeout_threshold % 10)], RGB_RED);
+ } else { // >= 140 minutes, just show these 3 lights
+ rgb_matrix_set_color(LED_LIST_NUMROW[10], RGB_RED);
+ rgb_matrix_set_color(LED_LIST_NUMROW[11], RGB_RED);
+ rgb_matrix_set_color(LED_LIST_NUMROW[12], RGB_RED);
+ }
+ break;
+ case _MO2:
+ for (uint8_t i=0; i<ARRAYSIZE(LED_LIST_NUMPAD); i++) {
+ rgb_matrix_set_color(LED_LIST_NUMPAD[i], RGB_MAGENTA);
+ }
+ rgb_matrix_set_color(LED_R4, RGB_MAGENTA);
+ rgb_matrix_set_color(LED_R5, RGB_MAGENTA);
+ rgb_matrix_set_color(LED_R6, RGB_MAGENTA);
+ break;
+ case _MO3:
+ rgb_matrix_set_color(LED_R6, RGB_GREEN);
+ rgb_matrix_set_color(LED_R7, RGB_GREEN);
+ rgb_matrix_set_color(LED_R8, RGB_GREEN);
+ break;
+ default:
+ break;
+ }
+ }
+
+ void suspend_power_down_user(void) {
+ rgb_matrix_set_suspend_state(true);
+ }
+
+ void suspend_wakeup_init_user(void) {
+ rgb_matrix_set_suspend_state(false);
+ }
+#endif
+
+
+void keyboard_post_init_user(void) {
+
+ if (IS_HOST_LED_ON(USB_LED_NUM_LOCK)) { // turn on Num lock by defautl so that the numpad layer always has predictable results
+ tap_code(KC_NUMLOCK);
+ }
+ timeout_timer = timer_read(); // set inital time for ide timeout
+ #ifdef RGB_MATRIX_ENABLE
+ rgb_matrix_set_color_all(RGB_NAUTILUS); // Default startup colour
+ #endif
+}
diff --git a/keyboards/gmmk/pro/keymaps/jonavin/readme.md b/keyboards/gmmk/pro/keymaps/jonavin/readme.md
index 45bfedb51b..f4f3401abc 100644
--- a/keyboards/gmmk/pro/keymaps/jonavin/readme.md
+++ b/keyboards/gmmk/pro/keymaps/jonavin/readme.md
@@ -1,6 +1,6 @@
# jonavin's GMMK Pro layout
-- Add all the non-RGB related keys from Glorious Core default mapping that's missing in the default qmk mapping
+- Add Fn layer keys from Glorious Core mapping that's missing in the default qmk mapping
- Add PrtScr, Scroll Lock, Break, NumLock to Fn layer
- Implement Win key lock using Fn+Win like in Glorious Core firmware
- Layer 2 mod on Caps Lock with double-tap to switch to this layer, double tap to switch back
@@ -8,17 +8,33 @@
- Layer 2 left spacebar Backspace
- add double tap of Left Shift to toggle Caps Lock
- additional encoder functionality
- - holding L shift, Navigate page up/down
+ - FN Layer - change rgb idle timeout
+ - holding Left shift, change layers
+ - holding right shift, Navigate page up/down
- holding Left Ctrl, navigate prev/next word
- holding Left Alt, change media prev/next track
- default is change volume
+
+- LED/RGB Functionality
+ - RGB idle timeout (default 5 minutes)
+ - Can be changed in FN layer with < and > or encoder
+ - setting to zero disables timeout
+ - indicators in FN layer using RGB in FN and number rows to show the timeout in minutes
+ - LED address location map as enum definition
+ - LED group lists for arrows, numpad, F row, num row, left and right side LEDs
+ - default startuo in single mode with default colour
+ - Capslock, Scroll Lock, and Num Lock (not set) indicator on left side LED
+ - Layer indicator on right side LED
+ - Fn key light up red when Fn layer activate
+ - Win Key light up red when Win Lock mode enabled
+ - Layer 2 activation lights up Numpad area
## All layers diagram
Default layer
![image](https://user-images.githubusercontent.com/71780717/124177658-82324880-da7e-11eb-9421-b69100131062.png)
Fn Layer
-![image](https://user-images.githubusercontent.com/71780717/124176887-8742c800-da7d-11eb-9b19-156bd67cac7d.png)
+![image](https://user-images.githubusercontent.com/71780717/126086069-bc539ffc-3ab6-4ebb-9bef-5005f8add294.png)
Layer 2 (Caps Lock Mod)
![image](https://user-images.githubusercontent.com/71780717/124177683-8b231a00-da7e-11eb-9434-e2475f679a54.png)
diff --git a/keyboards/gmmk/pro/keymaps/jonavin/rgb_matrix_map.h b/keyboards/gmmk/pro/keymaps/jonavin/rgb_matrix_map.h
new file mode 100644
index 0000000000..1ee5388905
--- /dev/null
+++ b/keyboards/gmmk/pro/keymaps/jonavin/rgb_matrix_map.h
@@ -0,0 +1,144 @@
+/* Copyright 2021 Jonavin Eng
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+#ifdef RGB_MATRIX_ENABLE
+
+ // Custom RGB Colours
+ #define RGB_GODSPEED 0x00, 0xE4, 0xFF // colour for matching keycaps
+ #define RGB_NAUTILUS 0x00, 0xA4, 0xA9 // Naurilus Font colours
+
+ // RGB LED locations
+ enum led_location_map {
+ LED_ESC, // 0, ESC, k13
+ LED_GRV, // 1, ~, k16
+ LEB_TAB, // 2, Tab, k11
+ LED_CAPS, // 3, Caps, k21
+ LED_LSFT, // 4, Sh_L, k00
+ LED_LCTL, // 5, Ct_L, k06
+ LED_F1, // 6, F1, k26
+ LED_1, // 7, 1, k17
+ LED_Q, // 8, Q, k10
+ LED_A, // 9, A, k12
+ LED_Z, // 10, Z, k14
+ LED_LWIN, // 11, Win_L, k90
+ LED_F2, // 12, F2, k36
+ LED_2, // 13, 2, k27
+ LED_W, // 14, W, k20
+ LED_S, // 15, S, k22
+ LED_X, // 16, X, k24
+ LED_LALT, // 17, Alt_L, k93
+ LED_F3, // 18, F3, k31
+ LED_3, // 19, 3, k37
+ LED_E, // 20, E, k30
+ LED_D, // 21, D, k32
+ LED_C, // 22, C, k34
+ LED_F4, // 23, F4, k33
+ LED_4, // 24, 4, k47
+ LED_R, // 25, R, k40
+ LED_F, // 26, F, k42
+ LED_V, // 27, V, k44
+ LED_F5, // 28, F5, k07
+ LED_5, // 29, 5, k46
+ LED_T, // 30, T, k41
+ LED_G, // 31, G, k43
+ LED_B, // 32, B, k45
+ LED_SPC, // 33, SPACE, k94
+ LED_F6, // 34, F6, k63
+ LED_6, // 35, 6, k56
+ LED_Y, // 36, Y, k51
+ LED_H, // 37, H, k53
+ LED_N, // 38, N, k55
+ LED_F7, // 39, F7, k71
+ LED_7, // 40, 7, k57
+ LED_U, // 41, U, k50
+ LED_J, // 42, J, k52
+ LED_M, // 43, M, k54
+ LED_F8, // 44, F8, k76
+ LED_8, // 45, 8, k67
+ LED_I, // 46, I, k60
+ LED_K, // 47, K, k62
+ LED_COMM, // 48, ,, k64
+ LED_RALT, // 49, Alt_R, k95
+ LED_F9, // 50, F9, ka6
+ LED_9, // 51, 9, k77
+ LED_O, // 52, O, k70
+ LED_L, // 53, L, k72
+ LED_DOT, // 54, ., k74
+ LED_FN, // 55, FN, k92
+ LED_F10, // 56, F10, ka7
+ LED_0, // 57, 0, k87
+ LED_P, // 58, P, k80
+ LED_SCLN, // 59, ;, k82
+ LED_SLSH, // 60, ?, k85
+ LED_F11, // 61, F11, ka3
+ LED_MINS, // 62, -, k86
+ LED_LBRC, // 63, [, k81
+ LED_QUOT, // 64, ", k83
+ LED_RCTL, // 65, Ct_R, k04
+ LED_F12, // 66, F12, ka5
+ LED_L1, // 67, LED, l01
+ LED_R1, // 68, LED, l11
+ LED_INS, // 69, Prt, k97 -- remapped to INS
+ LED_L2, // 70, LED, l02
+ LED_R2, // 71, LED, l12
+ LED_DEL, // 72, Del, k65
+ LED_L3, // 73, LED, l03
+ LED_R3, // 74, LED, l13
+ LED_PGUP, // 75, PgUp, k15
+ LED_L4, // 76, LED, l04
+ LED_R4, // 77, LED, l14
+ LED_EQL, // 78, =, k66
+ LED_RIGHT, // 79, Right, k05
+ LED_L5, // 80, LED, l05
+ LED_R5, // 81, LED, l15
+ LED_END, // 82, End, k75
+ LED_L6, // 83, LED, l06
+ LED_R6, // 84, LED, l16
+ LED_BSPC, // 85, BSpc, ka1
+ LED_PGDN, // 86, PgDn, k25
+ LED_L7, // 87, LED, l07
+ LED_R7, // 88, LED, l17
+ LED_RBRC, // 89, ], k61
+ LED_RSFT, // 90, Sh_R, k91
+ LED_L8, // 91, LED, l08
+ LED_R8, // 92, LED, l18
+ LED_BSLS, // 93, \, ka2
+ LED_UP, // 94, Up, k35
+ LED_LEFT, // 95, Left, k03
+ LED_ENT, // 96, Enter, ka4
+ LED_DOWN // 97, Down, k73
+ };
+
+ const uint8_t LED_LIST_WASD[] = { LED_W, LED_A, LED_S, LED_D };
+
+ const uint8_t LED_LIST_ARROWS[] = { LED_LEFT, LED_RIGHT, LED_UP, LED_DOWN };
+
+ const uint8_t LED_LIST_FUNCROW[] = { LED_ESC, LED_F1, LED_F2, LED_F3, LED_F4, LED_F5, LED_F6, LED_F7, LED_F8, LED_F9, LED_F10, LED_F11, LED_F12, LED_INS};
+
+ const uint8_t LED_LIST_NUMROW[] = { LED_GRV, LED_1, LED_2, LED_3, LED_4, LED_5, LED_6, LED_7, LED_8, LED_9, LED_0, LED_MINS, LED_EQL, LED_BSPC, LED_DEL};
+
+ const uint8_t LED_LIST_NUMPAD[] = {
+ LED_7, LED_8, LED_9,
+ LED_U, LED_I, LED_O,
+ LED_J, LED_K, LED_L,
+ LED_M, LED_COMM, LED_DOT
+ };
+
+ const uint8_t LED_SIDE_LEFT[] = { LED_L1, LED_L2, LED_L3, LED_L4, LED_L5, LED_L6, LED_L7, LED_L8};
+
+ const uint8_t LED_SIDE_RIGHT[] = { LED_R1, LED_R2, LED_R3, LED_R4, LED_R5, LED_R6, LED_R7, LED_R8};
+
+#endif