From 59d6b0faab108cc49ca5b3b83d9d169d445f50bd Mon Sep 17 00:00:00 2001 From: Jann-Niklas Zimmermann Date: Wed, 18 Mar 2020 00:57:53 +0100 Subject: [PATCH] [Keymap] Corodiak's Kyria (#8444) * Add kyria keymap * Delete wrong readme.md * Move layer keys * Refine keymap * Clean up * Add comment * Improve OS depending macros * Update keymap overview * Add review suggestions --- keyboards/kyria/keymaps/corodiak/config.h | 45 +++ keyboards/kyria/keymaps/corodiak/keymap.c | 321 ++++++++++++++++++++++ keyboards/kyria/keymaps/corodiak/rules.mk | 4 + 3 files changed, 370 insertions(+) create mode 100644 keyboards/kyria/keymaps/corodiak/config.h create mode 100644 keyboards/kyria/keymaps/corodiak/keymap.c create mode 100644 keyboards/kyria/keymaps/corodiak/rules.mk diff --git a/keyboards/kyria/keymaps/corodiak/config.h b/keyboards/kyria/keymaps/corodiak/config.h new file mode 100644 index 000000000..eed94d055 --- /dev/null +++ b/keyboards/kyria/keymaps/corodiak/config.h @@ -0,0 +1,45 @@ +/* Copyright 2019 Thomas Baart + * + * 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 . + */ + +#pragma once + +#ifdef OLED_DRIVER_ENABLE + #define OLED_DISPLAY_128X64 +#endif + +#ifdef RGBLIGHT_ENABLE + #define RGBLIGHT_ANIMATIONS + #define RGBLIGHT_HUE_STEP 8 + #define RGBLIGHT_SAT_STEP 8 + #define RGBLIGHT_VAL_STEP 8 +#endif + +// The Leader key allows to flexibly assign macros to key sequences. +#define LEADER_PER_KEY_TIMING +#define LEADER_TIMEOUT 350 + +#define TAPPING_TERM 200 + +// Turn off on slave +#define WAIT_FOR_USB + +// If you are using an Elite C rev3 on the slave side, uncomment the lines below: +#define SPLIT_USB_DETECT +#define NO_USB_STARTUP_CHECK + +// Allows to use either side as the master. Look at the documentation for info: +// https://docs.qmk.fm/#/config_options?id=setting-handedness +#define EE_HANDS diff --git a/keyboards/kyria/keymaps/corodiak/keymap.c b/keyboards/kyria/keymaps/corodiak/keymap.c new file mode 100644 index 000000000..0f7e05991 --- /dev/null +++ b/keyboards/kyria/keymaps/corodiak/keymap.c @@ -0,0 +1,321 @@ +/* Copyright 2019 Thomas Baart + * + * 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 QMK_KEYBOARD_H + +typedef union { + uint32_t raw; + struct { + bool osIsWindows; + }; +} user_config_t; + +user_config_t user_config; + +enum layers { + _QWERTY = 0, + _COLEMAK, + _NAV, + _SYMBOLS, + _NUM, + _ADJUST +}; + +enum custom_keycodes { + Qwerty = SAFE_RANGE, + Colemak, + Undo, + Cut, + Copy, + Paste, + NxtWord, + PrvWord +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { +/* + * Base Layer: QWERTY + * + * ,-------------------------------------------. ,-------------------------------------------. + * | TAB | Q | W | E | R | T | | Y | U | I | O | P | Bksp | + * |--------+------+------+------+------+------| |------+------+------+------+------+--------| + * | NAV | A | S | D | F | G | | H | J | K | L | ; : | ' " | + * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| + * | LShift | Z | X | C | V | B |Enter | ESC | |ADJUST|Space | N | M | , < | . > | / ? | Del | + * `----------------------+------+------+------+ +------| |------+ +------+------+------+----------------------' + * | LCTL | GUI | RALT | | NUM | | NUM | | SYMB | NAV |LEADER| + * | | | | | | | | | | | | + * `----------------------------------' `----------------------------------' + */ + [_QWERTY] = LAYOUT( + KC_TAB , KC_Q , KC_W , KC_E , KC_R , KC_T , KC_Y, KC_U , KC_I , KC_O , KC_P , KC_BSPC, + MO(_NAV), KC_A , KC_S , KC_D , KC_F , KC_G , KC_H, KC_J , KC_K , KC_L ,KC_SCLN, KC_QUOT, + KC_LSFT , KC_Z , KC_X , KC_C , KC_V , KC_B , XXXXXXX, KC_ESC , MO(_ADJUST), XXXXXXX, KC_N, KC_M ,KC_COMM, KC_DOT ,KC_SLSH, RSFT_T(KC_DEL), + KC_LCTL, KC_LGUI, KC_RALT, KC_ENT ,TT(_NUM),TT(_NUM), KC_SPC, MO(_SYMBOLS), MO(_NAV), KC_LEAD + ), + +/* + * Base Layer: Colemak + * + * ,-------------------------------------------. ,-------------------------------------------. + * | TAB | Q | W | F | P | G | | J | L | U | Y | ; : | Bksp | + * |--------+------+------+------+------+------| |------+------+------+------+------+--------| + * | NAV | A | R | S | T | D | | H | N | E | I | O | ' " | + * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| + * | LShift | Z | X | C | V | B |Enter | ESC | |ADJUST|Space | K | M | , < | . > | / ? | Del | + * `----------------------+------+------+------+ +------| |------+ +------+------+------+----------------------' + * | LCTL | GUI | RALT | | NUM | | NUM | | SYMB | NAV |LEADER| + * | | | | | | | | | | | | + * `----------------------------------' `----------------------------------' + */ + [_COLEMAK] = LAYOUT( + KC_TAB , KC_Q , KC_W , KC_F , KC_P , KC_G , KC_J, KC_L , KC_U , KC_Y ,KC_SCLN, KC_BSPC, + MO(_NAV), KC_A , KC_R , KC_S , KC_T , KC_D , KC_H, KC_N , KC_E , KC_I , KC_O , KC_QUOT, + KC_LSFT , KC_Z , KC_X , KC_C , KC_V , KC_B , XXXXXXX, KC_ESC , MO(_ADJUST), XXXXXXX, KC_K, KC_M ,KC_COMM, KC_DOT ,KC_SLSH, RSFT_T(KC_DEL), + KC_LCTL, KC_LGUI, KC_RALT, KC_ENT ,TT(_NUM),TT(_NUM), KC_SPC, MO(_SYMBOLS), MO(_NAV), KC_LEAD + ), + +/* + * Navigation Layer: Cursor, Text Navigation + * + * ,-------------------------------------------. ,-------------------------------------------. + * | | | |WheelU| | | | |PrvWord| Up |NxtWord| | | + * |--------+------+------+------+------+------| |------+------+------+------+------+--------| + * | | | LCTL |WheelD|LSFT | Bksp | | Bksp | Left | Down |Right | Del | | + * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| + * | | Undo | Cut | Copy |Paste | | | | | | | | Home | | End | | | + * `----------------------+------+------+------+ +------| |------+ +------+------+------+----------------------' + * | | | | |Space | | | | | | | + * | | | | | | | | | | | | + * `----------------------------------' `----------------------------------' + */ + [_NAV] = LAYOUT( + _______, _______, _______, KC_WH_U, _______, _______, _______, PrvWord, KC_UP , NxtWord, _______, _______, + _______, _______, KC_LCTL, KC_WH_D, KC_LSFT, KC_BSPC, KC_BSPC, KC_LEFT, KC_DOWN,KC_RIGHT, KC_DEL , _______, + _______, Undo , Cut , Copy , Paste , _______, XXXXXXX, _______, _______, XXXXXXX, _______, KC_HOME, _______, KC_END , _______, _______, + _______, _______, _______, _______, KC_SPC , _______, _______, _______, _______, _______ + ), + +/* + * Symbol Layer + * + * ,-------------------------------------------. ,-------------------------------------------. + * | ` ~ | ! | @ | # | $ | % | | ^ | { | } | | € | | + * |--------+------+------+------+------+------| |------+------+------+------+------+--------| + * | ~ | | | - _ | = + | & | | * | ( | ) | | | | | + * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| + * | | | | _ | + | | | | | | | | [ { | ] } | | \ | | | + * `----------------------+------+------+------+ +------| |------+ +------+------+------+----------------------' + * | | | | | | | | | | | | + * | | | | | | | | | | | | + * `----------------------------------' `----------------------------------' + */ + [_SYMBOLS] = LAYOUT( + KC_GRV, KC_EXLM, KC_AT , KC_HASH, KC_DLR , KC_PERC, KC_CIRC, KC_LCBR, KC_RCBR, _______,ALGR(KC_5),_______, + KC_TILD, _______, _______, KC_MINS, KC_EQL , KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, _______, KC_PIPE, _______, + _______, _______, _______, KC_UNDS, KC_PLUS, _______, XXXXXXX, _______, _______, XXXXXXX, _______, KC_LBRC, KC_RBRC, _______, KC_BSLS, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ + ), +/* + * Num Layer + * + * ,-------------------------------------------. ,-------------------------------------------. + * | | 1 ! | 2 @ | 3 # | 4 $ | 5 % | | / | 7 & | 8 * | 9 ( | - | | + * |--------+------+------+------+------+------| |------+------+------+------+------+--------| + * | | 6 ^ | 7 & | 8 * | 9 ( | 0 ) | | * | 4 $ | 5 % | 6 ^ | + | Space | + * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| + * | | | | | | | | | | | | 0 ) | 1 ! | 2 @ | 3 # | = | Enter | + * `----------------------+------+------+------+ +------| |------+ +------+------+------+----------------------' + * | | | | | | | | | | , | . | + * | | | | | | | | | | | | + * `----------------------------------' `----------------------------------' + */ + [_NUM] = LAYOUT( + _______, KC_1 , KC_2 , KC_3 , KC_4 , KC_5 , KC_PSLS, KC_7 , KC_8 , KC_9 , KC_PMNS, _______, + _______, KC_6 , KC_7 , KC_8 , KC_9 , KC_0 , KC_PAST, KC_4 , KC_5 , KC_6 , KC_PLUS, KC_SPC , + _______, _______, _______, _______, _______, _______, XXXXXXX, _______, _______, XXXXXXX, KC_0 , KC_1 , KC_2 , KC_3 , KC_PEQL, KC_ENT , + _______, _______, _______, _______, _______, _______, _______, _______, KC_PCMM, KC_DOT + ), + +/* + * Adjust Layer: Media + * + * ,-------------------------------------------. ,-------------------------------------------. + * | | F9 | F10 | F11 | F12 | | | SAI | | Vol+ | | Play | | + * |--------+------+------+------+------+------| |------+------+------+------+------+--------| + * | | F5 | F6 | F7 | F8 | | | HUI | Prev | Vol- | Nxt | | | + * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| + * | | F1 | F2 | F3 | F4 | | | | | | | VAI | Mute | | | | | + * `----------------------+------+------+------+ +------| |------+ +------+------+------+----------------------' + * |Qwerty|Colemak| | | | | RGB | | RGB | | | + * | Dflt | Dflt | | | | |Toggle| | Mode | | | + * `----------------------------------' `----------------------------------' + */ + [_ADJUST] = LAYOUT( + _______, KC_F9 , KC_F10 , KC_F11 , KC_F12 , _______, RGB_SAI, _______, KC_VOLU, _______, KC_MPLY, _______, + _______, KC_F5 , KC_F6 , KC_F7 , KC_F8 , _______, RGB_HUI, KC_MPRV, KC_VOLD, KC_MNXT, _______, _______, + _______, KC_F1 , KC_F2 , KC_F3 , KC_F4 , _______, XXXXXXX, _______, _______, XXXXXXX, RGB_VAI, KC_MUTE, _______, _______, _______, _______, + Qwerty , Colemak, _______, _______, _______, RGB_TOG, _______, RGB_MOD, _______, _______ + ), + +// /* +// * Layer template +// * +// * ,-------------------------------------------. ,-------------------------------------------. +// * | | | | | | | | | | | | | | +// * |--------+------+------+------+------+------| |------+------+------+------+------+--------| +// * | | | | | | | | | | | | | | +// * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------| +// * | | | | | | | | | | | | | | | | | | +// * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------' +// * | | | | | | | | | | | | +// * | | | | | | | | | | | | +// * `----------------------------------' `----------------------------------' +// */ +// [_LAYERINDEX] = LAYOUT( +// _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, +// _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, +// _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, +// _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ +// ), +}; + +void keyboard_post_init_user(void) { + // Call the post init code. + + // Read the user config from EEPROM + user_config.raw = eeconfig_read_user(); + + // Default RGB settings, without saving settings + rgblight_enable_noeeprom(); + rgblight_sethsv_noeeprom(HSV_CYAN); + rgblight_mode_noeeprom(RGBLIGHT_MODE_STATIC_LIGHT); +} + +bool process_record_user(uint16_t keycode, keyrecord_t *record) { + switch(keycode) { + case Qwerty: + if (record->event.pressed) { + set_single_persistent_default_layer(_QWERTY); + } + break; + case Colemak: + if (record->event.pressed) { + set_single_persistent_default_layer(_COLEMAK); + } + break; + case Undo: + if (record->event.pressed) { + if (user_config.osIsWindows == 1) { + tap_code16(C(KC_Z)); + } else if (user_config.osIsWindows == 0) { + tap_code16(G(KC_Z)); + } + } + break; + case Cut: + if (record->event.pressed) { + if (user_config.osIsWindows == 1) { + tap_code16(C(KC_X)); + } else if (user_config.osIsWindows == 0) { + tap_code16(G(KC_X)); + } + } + break; + case Copy: + if (record->event.pressed) { + if (user_config.osIsWindows == 1) { + tap_code16(C(KC_C)); + } else if (user_config.osIsWindows == 0) { + tap_code16(G(KC_C)); + } + } + break; + case Paste: + if (record->event.pressed) { + if (user_config.osIsWindows == 1) { + tap_code16(C(KC_V)); + } else if (user_config.osIsWindows == 0) { + tap_code16(G(KC_V)); + } + } + break; + case PrvWord: + if (record->event.pressed) { + if (user_config.osIsWindows == 1) { + tap_code16(C(KC_LEFT)); + } else if (user_config.osIsWindows == 0) { + tap_code16(A(KC_LEFT)); + } + } + break; + case NxtWord: + if (record->event.pressed) { + if (user_config.osIsWindows == 1) { + tap_code16(C(KC_RGHT)); + } else if (user_config.osIsWindows == 0) { + tap_code16(A(KC_RGHT)); + } + } + break; + } + return true; +}; + +LEADER_EXTERNS(); + +void matrix_scan_user(void) { + LEADER_DICTIONARY() { + leading = false; + leader_end(); + + // Set current OS indicator to macOs + SEQ_ONE_KEY(KC_M) { + user_config.osIsWindows = false; + eeconfig_update_user(user_config.raw); + } + + // Set current OS indicator to Windows + SEQ_ONE_KEY(KC_W) { + user_config.osIsWindows = true; + eeconfig_update_user(user_config.raw); + } + + // Screenshot + SEQ_ONE_KEY(KC_S) { + if (user_config.osIsWindows == 1) { + tap_code16(S(G(KC_S))); + } else if (user_config.osIsWindows == 0) { + tap_code16(S(G(KC_4))); + } + } + + // Video + SEQ_ONE_KEY(KC_V) { + if (user_config.osIsWindows == 0) { + tap_code16(S(G(KC_5))); + } + } + + // Sleep + SEQ_ONE_KEY(KC_P) { + if (user_config.osIsWindows == 1) { + SEND_STRING(SS_LGUI("x") "u" "h"); + } else if (user_config.osIsWindows == 0) { + tap_code16(A(G(KC_PWR))); + } + } + } +} diff --git a/keyboards/kyria/keymaps/corodiak/rules.mk b/keyboards/kyria/keymaps/corodiak/rules.mk new file mode 100644 index 000000000..da64c4ea5 --- /dev/null +++ b/keyboards/kyria/keymaps/corodiak/rules.mk @@ -0,0 +1,4 @@ +# OLED_DRIVER_ENABLE = yes # Enables the use of OLED displays +# ENCODER_ENABLE = yes # Enables the use of one or more encoders +RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow +LEADER_ENABLE = yes # Enables the Leader shortcut funtionality