qmk_firmware/keyboards/planck/keymaps/tk/keymap.c

691 lines
31 KiB
C
Raw Normal View History

/* Copyright 2020 Tushar Khan
*
* 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/>.
*/
#include QMK_KEYBOARD_H
#include "muse.h"
/*
*/
#define LCTL_MASK (get_mods() & MOD_BIT(KC_LCTL))
#define RCTL_MASK (get_mods() & MOD_BIT(KC_RCTL))
#define CTL_MASK (LCTL_MASK || RCTL_MASK)
#define LSFT_MASK (get_mods() & MOD_BIT(KC_LSFT))
#define RSFT_MASK (get_mods() & MOD_BIT(KC_RSFT))
#define SFT_MASK (LSFT_MASK || RSFT_MASK)
#define LALT_MASK (get_mods() & MOD_BIT(KC_LALT))
#define RALT_MASK (get_mods() & MOD_BIT(KC_RALT))
#define ALT_MASK (LALT_MASK || RALT_MASK)
// Layers
enum planck_layers {
_BASE,
_LOWER1,
_RAISE1,
_LOWER2,
_RAISE2,
_HYPER,
_ROTOR,
};
#define BASE TO(_BASE)
#define HYPER MO(_HYPER)
#define R_MODES MO(_ROTOR)
#define LOWER1 OSL(_LOWER1)
#define LOWER2 OSL(_LOWER2)
#define RAISE1 OSL(_RAISE1)
#define RAISE2 OSL(_RAISE2)
// Custom keycodes
#define CTL_TAB MT(MOD_LCTL, KC_TAB)
#define SH_ESC MT(MOD_LSFT, KC_ESC)
#define SH_QUOT MT(MOD_RSFT, KC_QUOT)
enum keycodes {
ROTARY = SAFE_RANGE,
PANIC, // backspace on tap, delete on tap with RSHIFT
// rotary modes
R_VOL, R_MEDIA, R_BRI, R_SC_V, R_SC_H, R_AR_V, R_AR_H,
// command-line macros
DEL_LN, // [delete line]
EMAIL, // [email address]
PHONE, // [phone number]
GT_CMT, // git commit -m ''
SHEBANG, // #!/usr/bin/env
CHMOD, // chmod 744 *sh
PY_VENV, // source *env*/bin/activate
};
// Rotary encoder states
enum encoder_states {
VOLUME, // volume up/down, toggle mute
MEDIA, // media next/previous, play/pause
BRIGHTNESS, // brightness up/down
SCROLL_V, // scroll up/down, middle click
SCROLL_H, // scroll right/left, middle click
ARROW_V, // arrow up/down
ARROW_H, // arrow left/right
};
enum encoder_states rotary_state = VOLUME;
// Songs
#ifdef AUDIO_ENABLE
// feedback songs
float confirm_song[][2] = SONG(MARIO_COIN);
float reject_song[][2] = SONG(MARIO_BUMP);
// dynamic macro songs
float dmacro_recs_song[][2] = SONG(MARIO_CAVE_1);
float dmacro_rece_song[][2] = SONG(MARIO_CAVE_2);
float dmacro_play_song[][2] = SONG(MARIO_PIPE);
// layer toggle songs
float base_song[][2] = SONG(MARIO_BUMP);
float hyper_song[][2] = SONG(MARIO_POWERUP_BLOCK);
float rotary_song[][2] = SONG(MARIO_POWERUP);
float raise1_song[][2] = SONG(MARIO_POWERUP_BLOCK);
float raise2_song[][2] = SONG(MARIO_POWERUP);
float lower1_song[][2] = SONG(MARIO_POWERUP_BLOCK);
float lower2_song[][2] = SONG(MARIO_POWERUP);
// shortcut songs
float caps_on_song[][2] = SONG(MARIO_CAVE_1);
float caps_off_song[][2] = SONG(MARIO_CAVE_2);
float save_song[][2] = SONG(MARIO_COIN);
float cut_song[][2] = SONG(MARIO_STOMP);
float copy_song[][2] = SONG(MARIO_STOMP);
float paste_song[][2] = SONG(MARIO_FIREBALL);
float undo_song[][2] = SONG(MARIO_KICK);
float redo_song[][2] = SONG(MARIO_ONEUP);
#endif
/*
*/
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* Base
|-----------------------------------------------------------------------------------------------|
| Rotary| Q | W | E | R | T | Y | U | I | O | P | Panic |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| Tab | A | S | D | F | G | H | J | K | L | ; | Enter |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| Esc | Z | X | C | V | B | N | M | , | . | / | ' |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| HYPER | Caps | Meta | Super | LOWER1| Space | RAISE1|DM1 Ply|DM2 Ply|DM1 Rec|DM2 Rec|
|-----------------------------------------------------------------------------------------------|
* PANIC: BACKSPACE on tap, DELETE on tap with RSHIFT
* TAB: CTRL on hold
* ESC and ': SHIFT on hold
*/
[_BASE] = LAYOUT_planck_grid(
ROTARY, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, PANIC,
CTL_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_ENT,
SH_ESC, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, SH_QUOT,
HYPER, KC_CAPS, KC_LALT, KC_LGUI, LOWER1, KC_SPACE, KC_SPACE, RAISE1, DM_PLY1, DM_PLY2, DM_REC1, DM_REC2
),
/* Hyper - keyboard adjustments and function keys
|-----------------------------------------------------------------------------------------------|
| ROTARY| F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | Reset |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
|T Audio| F11 | F12 | F13 | F14 | F15 | F16 | F17 | F18 | F19 | F20 |T Music|
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
|T Click| F21 | F22 | F23 | F24 | | | | | | |C Music|
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| xXx | Wake | Sleep |PrntScr| xXx | BASE | xXx | | | | |
|-----------------------------------------------------------------------------------------------|
*/
[_HYPER] = LAYOUT_planck_grid(
R_MODES, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, RESET,
AU_TOG, KC_F11, KC_F12, KC_F13, KC_F14, KC_F15, KC_F16, KC_F17, KC_F18, KC_F19, KC_F20, MU_TOG,
CK_TOGG, KC_F21, KC_F22, KC_F23, KC_F24, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, MU_MOD,
XXXXXXX, KC_WAKE, KC_SLEP, KC_PSCR, XXXXXXX, BASE, BASE, XXXXXXX, _______, _______, _______, _______
),
/* Rotary - change rotary encoder mode
|-----------------------------------------------------------------------------------------------|
| | | | | | | |scrll h|scrll v|scrll v|scrll h| |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | | | | | | |arrow h|arrow v|arrow v|arrow h| |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | | | | vol | bright| | media | | | | |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | | | | xXx | BASE | xXx | | | | |
|-----------------------------------------------------------------------------------------------|
*/
[_ROTOR] = LAYOUT_planck_grid(
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, R_SC_H, R_SC_V, R_SC_V, R_SC_H, XXXXXXX,
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, R_AR_H, R_AR_V, R_AR_V, R_AR_H, XXXXXXX,
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, R_VOL, R_BRI, XXXXXXX, R_MEDIA, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, BASE, BASE, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
),
/* Lower I - numbers and brackets
|-----------------------------------------------------------------------------------------------|
| | 1 | 2 | 3 | $ | * | / | | | | | |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | 4 | 5 | 6 | . | + | = | [ | ] | { | } | |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | 7 | 8 | 9 | 0 | - | _ | ( | ) | < | > | |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | | | | LOWER2| BASE | RAISE1| | | | |
|-----------------------------------------------------------------------------------------------|
* The following symbols are found on other layers: $ * /
* It is recommended to not primarily use this layer for those symbols
* They are merely on this layer for numerical-typing convenience
*/
[_LOWER1] = LAYOUT_planck_grid(
_______, KC_1, KC_2, KC_3, KC_DLR, KC_ASTR, KC_SLSH, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______,
_______, KC_4, KC_5, KC_6, KC_DOT, KC_PLUS, KC_EQL, KC_LBRC, KC_RBRC, KC_LCBR, KC_RCBR, _______,
_______, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_UNDS, KC_LPRN, KC_RPRN, KC_LABK, KC_RABK, _______,
_______, _______, _______, _______, LOWER2, BASE, BASE, RAISE1, _______, _______, _______, _______
),
/* Lower II - macros
|-----------------------------------------------------------------------------------------------|
| | | | email | | | | | | | phone | |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | | g stat| del ln| | | | | | | | |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | CHMOD | | g cmt |py venv| | | | | | | |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | | | | xXx | BASE | RAISE1| | | | |
|-----------------------------------------------------------------------------------------------|
* DO NOT INCLUDE DESTRUCTIVE MACROS
*/
[_LOWER2] = LAYOUT_planck_grid(
_______, XXXXXXX, XXXXXXX, EMAIL, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, PHONE, _______,
_______, XXXXXXX, SHEBANG, DEL_LN, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______,
_______, CHMOD, XXXXXXX, GT_CMT, PY_VENV, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______,
_______, _______, _______, _______, XXXXXXX, BASE, BASE, RAISE1, _______, _______, _______, _______
),
/* Raise I - symbols and movement
|-----------------------------------------------------------------------------------------------|
| | ! | @ | # | | | | S lt | S up | S dn | S rt | |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | $ | % | ^ | | | | Left | Down | Up | Right | |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | & | * | ( | ) | | | ~ | ` | | | \ | |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | | | | LOWER1| BASE | RAISE2| | | | |
|-----------------------------------------------------------------------------------------------|
* It is not recomended to use the ( ) symbols on this layer
* They are merely here for uniformity
*/
[_RAISE1] = LAYOUT_planck_grid(
_______, KC_EXLM, KC_AT, KC_HASH, XXXXXXX, XXXXXXX, XXXXXXX, KC_WH_L, KC_WH_D, KC_WH_U, KC_WH_R, _______,
_______, KC_DLR, KC_PERC, KC_CIRC, XXXXXXX, XXXXXXX, XXXXXXX, KC_LEFT, KC_DOWN, KC_UP, KC_RIGHT, _______,
_______, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, XXXXXXX, XXXXXXX, KC_TILD, KC_GRV, KC_PIPE, KC_BSLS, _______,
_______, _______, _______, _______, LOWER1, BASE, BASE, RAISE2, _______, _______, _______, _______
),
/* Raise II - mouse navigation
|-----------------------------------------------------------------------------------------------|
| | | | | | | | S lt | S up | S dn | S rt | |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | | | | | | | M lt | M dn | M up | M rt | |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | | | | | | | L Ck | R ck | Slow | Fast | |
|-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
| | | | | LOWER1| BASE | xXx | | | | |
|-----------------------------------------------------------------------------------------------|
*/
[_RAISE2] = LAYOUT_planck_grid(
_______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_WH_L, KC_WH_D, KC_WH_U, KC_WH_R, _______,
_______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, _______,
_______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_BTN1, KC_BTN2, KC_ACL1, KC_ACL2, _______,
_______, _______, _______, _______, LOWER1, BASE, BASE, XXXXXXX, _______, _______, _______, _______
),
};
/*
*/
// Keyboard initialization
void keyboard_post_init_user(void) {
clicky_off();
}
// Dynamic macros
static bool prerecord_clicky = false;
void dynamic_macro_record_start_user(void) {
prerecord_clicky = is_clicky_on();
if (!prerecord_clicky) {
clicky_on();
}
#ifdef AUDIO_ENABLE
PLAY_SONG(dmacro_recs_song);
#endif
}
void dynamic_macro_record_end_user(int8_t direction) {
if (!prerecord_clicky) {
clicky_off();
}
#ifdef AUDIO_ENABLE
PLAY_SONG(dmacro_rece_song);
#endif
}
void dynamic_macro_play_user(int8_t direction) {
#ifdef AUDIO_ENABLE
PLAY_SONG(dmacro_play_song);
#endif
}
// Layers
layer_state_t layer_state_set_user(layer_state_t state) {
// play layer activation audio
#ifdef AUDIO_ENABLE
switch (get_highest_layer(state)) {
case _BASE:
// enabling base layer song breaks a lot of other songs including
// - macro recording start song
// - rotary feedback songs
// PLAY_SONG(base_song);
break;
case _HYPER:
PLAY_SONG(hyper_song);
break;
case _ROTOR:
PLAY_SONG(rotary_song);
break;
case _LOWER1:
PLAY_SONG(lower1_song);
break;
case _LOWER2:
PLAY_SONG(lower2_song);
break;
case _RAISE1:
PLAY_SONG(raise1_song);
break;
case _RAISE2:
PLAY_SONG(raise2_song);
break;
default:
break;
}
#endif
return state;
}
// Keycode events
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
static bool panic_del = false; // PANIC in delete-mode
static bool caps_active = false;
switch (keycode) {
/*
*/
case PANIC:
if (record->event.pressed) {
if (RSFT_MASK) {
unregister_code(KC_RSFT);
register_code(KC_DEL);
panic_del = true;
}
else {
register_code(KC_BSPACE);
}
}
else {
if (panic_del) {
register_code(KC_RSFT);
unregister_code(KC_DEL);
panic_del = false;
}
else {
unregister_code(KC_BSPACE);
}
}
return false;
case KC_CAPS:
if (record->event.pressed) {
caps_active = !caps_active;
}
break;
// rotary encoder
case R_VOL:
if (record->event.pressed) {
rotary_state = VOLUME;
}
break;
case R_MEDIA:
if (record->event.pressed) {
rotary_state = MEDIA;
}
break;
case R_BRI:
if (record->event.pressed) {
rotary_state = BRIGHTNESS;
}
break;
case R_SC_V:
if (record->event.pressed) {
rotary_state = SCROLL_V;
}
break;
case R_SC_H:
if (record->event.pressed) {
rotary_state = SCROLL_H;
}
break;
case R_AR_V:
if (record->event.pressed) {
rotary_state = ARROW_V;
}
break;
case R_AR_H:
if (record->event.pressed) {
rotary_state = ARROW_H;
}
break;
case ROTARY:
if (record->event.pressed) {
if (rotary_state == VOLUME) {
tap_code(KC_MUTE); // toggle mute
}
else if (rotary_state == MEDIA) {
tap_code(KC_MPLY); // play/pause media
}
else if (rotary_state == SCROLL_V || rotary_state == SCROLL_H) {
tap_code(KC_BTN3); // middle mouse button
}
}
return false;
/*
*/
case DEL_LN:
if (record->event.pressed) {
tap_code16(LCTL(KC_E)); // go to start of line
tap_code16(LCTL(KC_U)); // clear to beginning of line
}
break;
case EMAIL:
if (record->event.pressed) {
SEND_STRING("email macro not set");
}
break;
case PHONE:
if (record->event.pressed) {
SEND_STRING("phone macro not set");
}
break;
case SHEBANG:
if (record->event.pressed) {
SEND_STRING("#!/usr/bin/env ");
}
break;
case CHMOD:
if (record->event.pressed) {
SEND_STRING("chmod 744 *.sh ");
}
break;
case GT_CMT:
if (record->event.pressed) {
SEND_STRING("git commit -m ''");
tap_code(KC_LEFT);
}
break;
case PY_VENV:
if (record->event.pressed) {
SEND_STRING("source *env*/bin/activate");
}
break;
};
/*
*/
#ifdef AUDIO_ENABLE
if (record->event.pressed) {
switch (keycode) {
case KC_S: // CTRL+S
if (CTL_MASK) {
PLAY_SONG(save_song);
}
break;
case KC_C: // CTRL+C
if (CTL_MASK) {
PLAY_SONG(copy_song);
}
break;
case KC_V: // CTRL+V
if (CTL_MASK) {
PLAY_SONG(paste_song);
}
break;
case KC_X: // CTRL+X
if (CTL_MASK) {
PLAY_SONG(cut_song);
}
break;
case KC_Z: // CTRL+Z
if (CTL_MASK) {
PLAY_SONG(undo_song);
}
break;
case KC_Y: // CTRL+Y
if (CTL_MASK) {
PLAY_SONG(redo_song);
}
break;
case KC_CAPS:
if (caps_active) {
PLAY_SONG(caps_on_song);
}
else {
PLAY_SONG(caps_off_song);
}
break;
// rotary encoder
case R_VOL:
case R_MEDIA:
case R_BRI:
case R_SC_V:
case R_SC_H:
case R_AR_V:
case R_AR_H:
PLAY_SONG(confirm_song);
break;
default:
if (IS_LAYER_ON(_ROTOR)) {
PLAY_SONG(reject_song);
}
};
}
#endif
return true;
}
void post_process_record_user(uint16_t keycode, keyrecord_t *record) {
}
/*
*/
#ifdef ENCODER_ENABLE
void encoder_update_user(uint8_t index, bool clockwise) {
static int scroll_interval = 5;
switch (rotary_state) {
case VOLUME:
if (clockwise) {
tap_code(KC_VOLU);
}
else {
tap_code(KC_VOLD);
}
break;
case MEDIA:
if (clockwise) {
tap_code(KC_MNXT);
}
else {
tap_code(KC_MPRV);
}
break;
case BRIGHTNESS:
if (clockwise) {
tap_code(KC_BRIU);
}
else {
tap_code(KC_BRID);
}
break;
case SCROLL_V:
if (clockwise) {
// tap_code(KC_PGDN);
for (int i=0; i<scroll_interval; i++) {
tap_code(KC_WH_D);
}
}
else {
// tap_code(KC_PGUP);
for (int i=0; i<scroll_interval; i++) {
tap_code(KC_WH_U);
}
}
break;
case SCROLL_H:
if (clockwise) {
for (int i=0; i<scroll_interval; i++) {
tap_code(KC_WH_R);
}
}
else {
for (int i=0; i<scroll_interval; i++) {
tap_code(KC_WH_L);
}
}
break;
case ARROW_V:
if (clockwise) {
tap_code(KC_DOWN);
}
else {
tap_code(KC_UP);
}
break;
case ARROW_H:
if (clockwise) {
tap_code(KC_RIGHT);
}
else {
tap_code(KC_LEFT);
}
break;
}
}
#endif