keyboards/planck/keymaps/jeebak/keymap.c

   1 // This is the canonical layout file for the Quantum project. If you want to add another keyboard,
   2 // this is the style you want to emulate.
   3
   4 #include "planck.h"
   5 #include "action_layer.h"
   6 #ifdef AUDIO_ENABLE
   7   #include "audio.h"
   8 #endif
   9 #include "eeconfig.h"
  10
  11 extern keymap_config_t keymap_config;
  12
  13 // Each layer gets a name for readability, which is then used in the keymap matrix below.
  14 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
  15 // Layer names don't all need to be of the same length, obviously, and you can also skip them
  16 // entirely and just use numbers.
  17 #define _QWERTY 0
  18 #define _COLEMAK 1
  19 #define _DVORAK 2
  20 #define _LOWER 3
  21 #define _RAISE 4
  22 #define _PLOVER 5
  23 #define _TOUCHCURSOR 6
  24 #define _MOUSE 7
  25 #define _ADJUST 16
  26
  27 // Keycodes
  28 enum planck_keycodes {
  29   QWERTY = SAFE_RANGE,
  30   COLEMAK,
  31   DVORAK,
  32   PLOVER,
  33   LOWER,
  34   RAISE,
  35   BACKLIT,
  36   EXT_PLV
  37 };
  38
  39 enum macro_keycodes {
  40   KC_ALT_TAB,
  41   KC_CMD_TAB,
  42   KC_CTL_TAB,
  43   KC_CMD_SLSH,
  44 };
  45
  46 // Fillers to make layering more clear
  47 #define _______ KC_TRNS
  48 #define XXXXXXX KC_NO
  49
  50 // Custom macros
  51 #define CTL_ESC     CTL_T(KC_ESC)               // Tap for Esc, hold for Ctrl
  52 #define SFT_ENT     SFT_T(KC_ENT)               // Tap for Enter, hold for Shift
  53 // Requires KC_TRNS/_______ for the trigger key in the destination layer
  54 #define LT_TC       LT(_TOUCHCURSOR, KC_SPC)    // L-ayer T-ap T-ouch C-ursor.
  55 #define LT_ML       LT(_MOUSE, KC_A)            // L-ayer T-ap M-ouse C-ursor (on A)
  56 #define ALT_TAB     M(KC_ALT_TAB)               // Macro for Alt-Tab
  57 #define CMD_TAB     M(KC_CMD_TAB)               // Macro for Cmd-Tab
  58 #define CTL_TAB     M(KC_CTL_TAB)               // Macro for Ctl-Tab
  59 #define CMD_SLSH    M(KC_CMD_SLSH)              // Macro for Cmd-Slash (personal shortcut to toggle iTerm2 visibility)
  60
  61 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  62
  63 /* Qwerty
  64  * ,-----------------------------------------------------------------------------------------.
  65  * | Tab      |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  |  Bksp  |
  66  * |----------+------+------+------+------+-------------+------+------+------+------+--------|
  67  * | Ctrl/Esc | ML/A |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |   "    |
  68  * |----------+------+------+------+------+------|------+------+------+------+------+--------|
  69  * | Shift    |   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Sft/Ent |
  70  * |----------+------+------+------+------+------+------+------+------+------+------+--------|
  71  * | PrntScrn | RGUI | Alt  | GUI  |Lower |  TC/Space   |Raise | Next | Vol- | Vol+ |  Play  |
  72  * `-----------------------------------------------------------------------------------------'
  73  */
  74 [_QWERTY] = {
  75   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  76   {CTL_ESC, LT_ML,   KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  77   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SFT_ENT},
  78   {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER,   LT_TC,   LT_TC,   RAISE,   KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
  79 },
  80
  81 /* Colemak
  82  * ,-----------------------------------------------------------------------------------------.
  83  * | Tab      |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  |  Bksp  |
  84  * |----------+------+------+------+------+-------------+------+------+------+------+--------|
  85  * | Ctrl/Esc | ML/A |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |   "    |
  86  * |----------+------+------+------+------+------|------+------+------+------+------+--------|
  87  * | Shift    |   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Sft/Ent |
  88  * |----------+------+------+------+------+------+------+------+------+------+------+--------|
  89  * | PrntScrn | RGUI | Alt  | GUI  |Lower |  TC/Space   |Raise | Next | Vol- | Vol+ |  Play  |
  90  * `-----------------------------------------------------------------------------------------'
  91  */
  92 [_COLEMAK] = {
  93   {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
  94   {CTL_ESC, LT_ML,   KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
  95   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SFT_ENT},
  96   {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER,   LT_TC,   LT_TC,   RAISE,   KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
  97 },
  98
  99 /* Dvorak
 100  * ,-----------------------------------------------------------------------------------------.
 101  * | Tab      |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  |  Bksp  |
 102  * |----------+------+------+------+------+-------------+------+------+------+------+--------|
 103  * | Ctrl/Esc | ML/A |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |   /    |
 104  * |----------+------+------+------+------+------|------+------+------+------+------+--------|
 105  * | Shift    |   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Sft/Ent |
 106  * |----------+------+------+------+------+------+------+------+------+------+------+--------|
 107  * | PrntScrn | RGUI | Alt  | GUI  |Lower |  TC/Space   |Raise | Next | Vol- | Vol+ |  Play  |
 108  * `-----------------------------------------------------------------------------------------'
 109  */
 110 [_DVORAK] = {
 111   {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
 112   {CTL_ESC, LT_ML,   KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
 113   {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    SFT_ENT},
 114   {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER,   LT_TC,   LT_TC,   RAISE,   KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 115 },
 116
 117 /* Lower
 118  * ,-----------------------------------------------------------------------------------.
 119  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 120  * |------+------+------+------+------+-------------+------+------+------+------+------|
 121  * |   [  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 122  * |------+------+------+------+------+------|------+------+------+------+------+------|
 123  * |   ]  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |   -  |   =  |   [  |   ]  |  \   |
 124  * |------+------+------+------+------+------+------+------+------+------+------+------|
 125  * |Brite |      |      |      |      |             |      | Prev | Stop | Slct | Mute |
 126  * `-----------------------------------------------------------------------------------'
 127  */
 128 [_LOWER] = {
 129   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
 130   {KC_LBRC, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 131   {KC_RBRC, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 132   {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
 133 },
 134
 135 /* Raise
 136  * ,-----------------------------------------------------------------------------------.
 137  * |   0  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 138  * |------+------+------+------+------+-------------+------+------+------+------+------|
 139  * |   $  |   4  |   5  |   6  |   .  |   +  |   .  |   4  |   5  |   6  |   *  |  |   |
 140  * |------+------+------+------+------+------|------+------+------+------+------+------|
 141  * |   =  |   7  |   8  |   9  |   0  |   -  |   .  |   1  |   2  |   3  |   /  |  \   |
 142  * |------+------+------+------+------+------+------+------+------+------+------+------|
 143  * |Brite |      |      |      |      |             |      | Prev | Stop | Slct | Mute |
 144  * `-----------------------------------------------------------------------------------'
 145  */
 146 [_RAISE] = {
 147   {KC_0,    KC_1,    KC_2,    KC_3,    KC_4,   KC_5,     KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 148   {KC_DLR,  KC_4,    KC_5,    KC_6,    KC_DOT, KC_PLUS,  KC_DOT,  KC_4,    KC_5,    KC_6,    KC_ASTR, KC_PIPE},
 149   {KC_EQL,  KC_7,    KC_8,    KC_9,    KC_0,   KC_MINS,  KC_DOT,  KC_1,    KC_2,    KC_3,    KC_SLSH, KC_BSLS},
 150   {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
 151 },
 152
 153 /* TouchCursor layer (http://martin-stone.github.io/touchcursor/) plus personal customizations
 154  * ,-----------------------------------------------------------------------------------.
 155  * |AltTab|CmdTab|CtlTab| GUI  |Shift |  ~   |Insert| Home |  Up  | End  | Bksp |      |
 156  * |------+------+------+------+------+-------------+------+------+------+------+------|
 157  * |      | Alt  |Space |      | Find |Again | PgUp | Left | Down |Right |      |      |
 158  * |------+------+------+------+------+------|------+------+------+------+------+------|
 159  * |      | Undo | Cut  | Copy |Paste |  `   | PgDn | Del  |      |      |      |      |
 160  * |------+------+------+------+------+------+------+------+------+------+------+------|
 161  * |      |      |      |      |      |             |      |      |      |      |      |
 162  * `-----------------------------------------------------------------------------------'
 163  *
 164  * The KC_UNDO, KC_CUT, KC_COPY, KC_PASTE, KC_FIND, and KC_AGAIN keycodes don't
 165  * seem to work on Mac. Presumably they'll work under Windows.
 166  */
 167
 168 [_TOUCHCURSOR] = {
 169   {ALT_TAB, CMD_TAB, CTL_TAB, KC_LGUI, KC_LSFT, KC_TILD, KC_INS,  KC_HOME, KC_UP,   KC_END,  KC_BSPC, _______},
 170   {_______, KC_LALT, KC_SPC,  _______, KC_FIND,KC_AGAIN, KC_PGUP, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______},
 171   {_______, KC_UNDO, KC_CUT,  KC_COPY, KC_PASTE,KC_GRV,  KC_PGDN, KC_DEL,  _______, _______, CMD_SLSH,_______},
 172   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 173 },
 174
 175 /* Mouse Layer
 176  * ,-----------------------------------------------------------------------------------.
 177  * |      |      |ACCL0 |ACCL1 |ACCL2 |ACCL2 |      |WHL_L |  Up  |WHL_R | BTN2 |      |
 178  * |------+------+------+------+------+-------------+------+------+------+------+------|
 179  * |      |      |      | BTN3 | BTN1 | BTN4 |WHL_Up| Left | Down |Right |      |      |
 180  * |------+------+------+------+------+------|------+------+------+------+------+------|
 181  * |      |      |      |      | BTN2 | BTN5 |WHL_Dn| BTN1 |      |      |      |      |
 182  * |------+------+------+------+------+------+------+------+------+------+------+------|
 183  * |      |      |      |      |      |             |      |      |      |      |      |
 184  * `-----------------------------------------------------------------------------------'
 185  */
 186
 187 [_MOUSE] = {
 188   {_______, _______, KC_ACL0, KC_ACL1, KC_ACL2, KC_ACL2, _______, KC_WH_L, KC_MS_U, KC_WH_R, KC_BTN2, _______},
 189   {_______, _______, _______, KC_BTN3, KC_BTN1, KC_BTN4, KC_WH_U, KC_MS_L, KC_MS_D, KC_MS_R, _______, _______},
 190   {_______, _______, _______, _______, KC_BTN2, KC_BTN5, KC_WH_D, KC_BTN1, _______, _______, _______, _______},
 191   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 192 },
 193
 194 /* Plover layer (http://opensteno.org)
 195  * ,-----------------------------------------------------------------------------------.
 196  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 197  * |------+------+------+------+------+-------------+------+------+------+------+------|
 198  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 199  * |------+------+------+------+------+------|------+------+------+------+------+------|
 200  * |TogOut|   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 201  * |------+------+------+------+------+------+------+------+------+------+------+------|
 202  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 203  * `-----------------------------------------------------------------------------------'
 204  */
 205
 206 [_PLOVER] = {
 207   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 208   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 209   {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 210   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 211 },
 212
 213 /* Adjust (Lower + Raise)
 214  * ,-----------------------------------------------------------------------------------.
 215  * |      |      |      |      |      |      |      |      |      |      |      |  Del |
 216  * |------+------+------+------+------+-------------+------+------+------+------+------|
 217  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 218  * |------+------+------+------+------+------|------+------+------+------+------+------|
 219  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 220  * |------+------+------+------+------+------+------+------+------+------+------+------|
 221  * |      |      |      |      |      |             |      |      |      |      |Reset |
 222  * `-----------------------------------------------------------------------------------'
 223  */
 224 [_ADJUST] = {
 225   {_______, _______,  _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
 226   {_______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
 227   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 228   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,   RESET}
 229 }
 230
 231
 232 };
 233
 234 #ifdef AUDIO_ENABLE
 235
 236 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 237 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 238 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 239 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 240 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 241 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 242 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 243
 244 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 245 #endif
 246
 247
 248 void persistant_default_layer_set(uint16_t default_layer) {
 249   eeconfig_update_default_layer(default_layer);
 250   default_layer_set(default_layer);
 251 }
 252
 253 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 254   switch (keycode) {
 255     case QWERTY:
 256       if (record->event.pressed) {
 257         #ifdef AUDIO_ENABLE
 258           PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 259         #endif
 260         default_layer_set(1UL<<_QWERTY);
 261       }
 262       return false;
 263       break;
 264     case COLEMAK:
 265       if (record->event.pressed) {
 266         #ifdef AUDIO_ENABLE
 267           PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 268         #endif
 269         default_layer_set(1UL<<_COLEMAK);
 270       }
 271       return false;
 272       break;
 273     case DVORAK:
 274       if (record->event.pressed) {
 275         #ifdef AUDIO_ENABLE
 276           PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
 277         #endif
 278         default_layer_set(1UL<<_DVORAK);
 279       }
 280       return false;
 281       break;
 282     case LOWER:
 283       if (record->event.pressed) {
 284         layer_on(_LOWER);
 285         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 286       } else {
 287         layer_off(_LOWER);
 288         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 289       }
 290       return false;
 291       break;
 292     case RAISE:
 293       if (record->event.pressed) {
 294         layer_on(_RAISE);
 295         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 296       } else {
 297         layer_off(_RAISE);
 298         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 299       }
 300       return false;
 301       break;
 302     case BACKLIT:
 303       if (record->event.pressed) {
 304         register_code(KC_RSFT);
 305         #ifdef BACKLIGHT_ENABLE
 306           backlight_step();
 307         #endif
 308       } else {
 309         unregister_code(KC_RSFT);
 310       }
 311       return false;
 312       break;
 313     case PLOVER:
 314       if (record->event.pressed) {
 315         #ifdef AUDIO_ENABLE
 316           stop_all_notes();
 317           PLAY_NOTE_ARRAY(tone_plover, false, 0);
 318         #endif
 319         layer_off(_RAISE);
 320         layer_off(_LOWER);
 321         layer_off(_ADJUST);
 322         layer_on(_PLOVER);
 323         if (!eeconfig_is_enabled()) {
 324             eeconfig_init();
 325         }
 326         keymap_config.raw = eeconfig_read_keymap();
 327         keymap_config.nkro = 1;
 328         eeconfig_update_keymap(keymap_config.raw);
 329       }
 330       return false;
 331       break;
 332     case EXT_PLV:
 333       if (record->event.pressed) {
 334         #ifdef AUDIO_ENABLE
 335           PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
 336         #endif
 337         layer_off(_PLOVER);
 338       }
 339       return false;
 340       break;
 341   }
 342   return true;
 343 }
 344
 345 /*
 346  * Macro definition
 347  */
 348 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 349 {
 350     switch (id) {
 351       case KC_ALT_TAB:
 352         return (record->event.pressed ? MACRO( D(LALT),  D(TAB), END ) : MACRO( U(TAB), END ));
 353       case KC_CMD_TAB:
 354         return (record->event.pressed ? MACRO( D(LGUI),  D(TAB), END ) : MACRO( U(TAB), END ));
 355       case KC_CTL_TAB:
 356         return (record->event.pressed ? MACRO( D(LCTRL), D(TAB), END ) : MACRO( U(TAB), END ));
 357       case KC_CMD_SLSH:
 358         return (record->event.pressed ? MACRO( D(LGUI),  D(SLSH),END ) : MACRO( U(SLSH),END ));
 359     }
 360
 361     return MACRO_NONE;
 362 }
 363
 364 void matrix_init_user(void) {
 365     #ifdef AUDIO_ENABLE
 366         startup_user();
 367     #endif
 368 }
 369
 370 #ifdef AUDIO_ENABLE
 371
 372 void startup_user()
 373 {
 374     _delay_ms(20); // gets rid of tick
 375     PLAY_NOTE_ARRAY(tone_startup, false, 0);
 376 }
 377
 378 void shutdown_user()
 379 {
 380     PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
 381     _delay_ms(150);
 382     stop_all_notes();
 383 }
 384
 385 void music_on_user(void)
 386 {
 387     music_scale_user();
 388 }
 389
 390 void music_scale_user(void)
 391 {
 392     PLAY_NOTE_ARRAY(music_scale, false, 0);
 393 }
 394
 395 #endif