keyboards/planck/keymaps/emilyh/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
  18 enum planck_layers {
  19   _QWERTY,
  20   _COLEMAK,
  21   _DVORAK,
  22   _LOWER,
  23   _RAISE,
  24   _PLOVER,
  25   _ADJUST
  26 };
  27
  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 // Fillers to make layering more clear
  40 #define _______ KC_TRNS
  41 #define XXXXXXX KC_NO
  42
  43 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  44
  45 /* Qwerty
  46  * ,-----------------------------------------------------------------------------------.
  47  * | Esc  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  48  * |------+------+------+------+------+-------------+------+------+------+------+------|
  49  * | Tab  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  50  * |------+------+------+------+------+------|------+------+------+------+------+------|
  51  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |  Up  |Enter |
  52  * |------+------+------+------+------+------+------+------+------+------+------+------|
  53  * | Ctrl | Brite| GUI  | Alt  |Lower |    Space    |Raise |   /  | Left | Down |Right |
  54  * `-----------------------------------------------------------------------------------'
  55  */
  56 [_QWERTY] = {
  57   {KC_ESC,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  58   {KC_TAB,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  59   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_UP,   KC_ENT },
  60   {KC_LCTL, BACKLIT, KC_LGUI, KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_SLSH, KC_LEFT, KC_DOWN, KC_RGHT}
  61 },
  62
  63 /* Colemak
  64  * ,-----------------------------------------------------------------------------------.
  65  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  66  * |------+------+------+------+------+-------------+------+------+------+------+------|
  67  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  68  * |------+------+------+------+------+------|------+------+------+------+------+------|
  69  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  70  * |------+------+------+------+------+------+------+------+------+------+------+------|
  71  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  72  * `-----------------------------------------------------------------------------------'
  73  */
  74 [_COLEMAK] = {
  75   {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
  76   {KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
  77   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  78   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  79 },
  80
  81 /* Dvorak
  82  * ,-----------------------------------------------------------------------------------.
  83  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  84  * |------+------+------+------+------+-------------+------+------+------+------+------|
  85  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
  86  * |------+------+------+------+------+------|------+------+------+------+------+------|
  87  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
  88  * |------+------+------+------+------+------+------+------+------+------+------+------|
  89  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  90  * `-----------------------------------------------------------------------------------'
  91  */
  92 [_DVORAK] = {
  93   {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
  94   {KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
  95   {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT },
  96   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  97 },
  98
  99 /* Lower
 100  * ,-----------------------------------------------------------------------------------.
 101  * |      |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Del  |
 102  * |------+------+------+------+------+-------------+------+------+------+------+------|
 103  * |   ~  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 104  * |------+------+------+------+------+------|------+------+------+------+------+------|
 105  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ | Home | Next | Vol+ | Mute |
 106  * |------+------+------+------+------+------+------+------+------+------+------+------|
 107  * |      |      |      |      |      |             |      |  End | Prev | Vol- | Play |
 108  * `-----------------------------------------------------------------------------------'
 109  */
 110 [_LOWER] = {
 111   {_______, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR,    KC_ASTR,  KC_LPRN, KC_RPRN, KC_DEL},
 112   {KC_TILD, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS,    KC_PLUS,  KC_LCBR, KC_RCBR, KC_PIPE},
 113   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  S(KC_NUHS), KC_HOME,  KC_MNXT, KC_VOLU, KC_MUTE},
 114   {_______, _______, _______, _______, _______, _______, _______, _______,    KC_END,   KC_MPRV, KC_VOLD, KC_MPLY}
 115 },
 116
 117 /* Raise
 118  * ,-----------------------------------------------------------------------------------.
 119  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 120  * |------+------+------+------+------+-------------+------+------+------+------+------|
 121  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 122  * |------+------+------+------+------+------|------+------+------+------+------+------|
 123  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |Plover|Pg Up | Next | Vol+ | Mute |
 124  * |------+------+------+------+------+------+------+------+------+------+------+------|
 125  * |      |      |      |      |      |             |      |Pg Dn | Prev | Vol- | Play |
 126  * `-----------------------------------------------------------------------------------'
 127  */
 128 [_RAISE] = {
 129   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,        KC_8,    KC_9,    KC_0,    KC_BSPC},
 130   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS,     KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 131   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  TO(_PLOVER), KC_PGUP, KC_MNXT, KC_VOLU, KC_MUTE},
 132   {_______, _______, _______, _______, _______, _______, _______, _______,     KC_PGDN, KC_MPRV, KC_VOLD, KC_MPLY}
 133 },
 134
 135 /* Numpad Layer
 136  * ,-----------------------------------------------------------------------------------.
 137  * | ESC  |      |      |  (   |   )  |      |      |   7  |   8  |   9  |   +  | Bksp |
 138  * |------+------+------+------+------+-------------+------+------+------+------+------|
 139  * |  Tab |   +  |   -  |   *  |   /  |      |      |   4  |   5  |   6  |   -  |      |
 140  * |------+------+------+------+------+------|------+------+------+------+------+------|
 141  * |      |      |  Up  |      |      |      |      |   1  |   2  |   3  |  Up  |      |
 142  * |------+------+------+------+------+------+------+------+------+------+------+------|
 143  * |ToQrty| Left | Down |Right |      |    Space    |   0  |   .  | Left | Down |Right |
 144  * `-----------------------------------------------------------------------------------'
 145  */
 146
 147 [_PLOVER] = {
 148   {KC_ESC , XXXXXXX, XXXXXXX, KC_LPRN, KC_RPRN,XXXXXXX, XXXXXXX,   KC_P7,  KC_P8,    KC_P9,   KC_PPLS, KC_BSPC},
 149   {KC_TAB , KC_PPLS, KC_PMNS, KC_PAST, KC_PSLS,XXXXXXX, XXXXXXX,   KC_P4,  KC_P5,    KC_P6,   KC_PMNS, XXXXXXX},
 150   {XXXXXXX, XXXXXXX, KC_UP,   XXXXXXX, XXXXXXX,XXXXXXX, XXXXXXX,   KC_P1,  KC_P2,    KC_P3,   KC_UP,   _______},
 151   {TO(_QWERTY),KC_LEFT,KC_DOWN,KC_RGHT,XXXXXXX, KC_SPC,  KC_SPC,   KC_P0,  KC_PDOT,  KC_LEFT, KC_DOWN, KC_RGHT}
 152 },
 153
 154 /* Adjust (Lower + Raise)
 155  * ,-----------------------------------------------------------------------------------.
 156  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 157  * |------+------+------+------+------+-------------+------+------+------+------+------|
 158  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 159  * |------+------+------+------+------+------|------+------+------+------+------+------|
 160  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 161  * |------+------+------+------+------+------+------+------+------+------+------+------|
 162  * |      |      |      |      |      |             |      |      |      |      |      |
 163  * `-----------------------------------------------------------------------------------'
 164  */
 165 [_ADJUST] = {
 166   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL },
 167   {_______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
 168   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 169   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 170 }
 171
 172
 173 };
 174
 175 #ifdef AUDIO_ENABLE
 176
 177 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 178 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 179 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 180 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 181 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 182 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 183 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 184
 185 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 186 #endif
 187
 188
 189 void persistant_default_layer_set(uint16_t default_layer) {
 190   eeconfig_update_default_layer(default_layer);
 191   default_layer_set(default_layer);
 192 }
 193
 194 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 195   switch (keycode) {
 196     case QWERTY:
 197       if (record->event.pressed) {
 198         #ifdef AUDIO_ENABLE
 199           PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 200         #endif
 201         persistant_default_layer_set(1UL<<_QWERTY);
 202       }
 203       return false;
 204       break;
 205     case COLEMAK:
 206       if (record->event.pressed) {
 207         #ifdef AUDIO_ENABLE
 208           PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 209         #endif
 210         persistant_default_layer_set(1UL<<_COLEMAK);
 211       }
 212       return false;
 213       break;
 214     case DVORAK:
 215       if (record->event.pressed) {
 216         #ifdef AUDIO_ENABLE
 217           PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
 218         #endif
 219         persistant_default_layer_set(1UL<<_DVORAK);
 220       }
 221       return false;
 222       break;
 223     case LOWER:
 224       if (record->event.pressed) {
 225         layer_on(_LOWER);
 226         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 227       } else {
 228         layer_off(_LOWER);
 229         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 230       }
 231       return false;
 232       break;
 233     case RAISE:
 234       if (record->event.pressed) {
 235         layer_on(_RAISE);
 236         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 237       } else {
 238         layer_off(_RAISE);
 239         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 240       }
 241       return false;
 242       break;
 243     case BACKLIT:
 244       if (record->event.pressed) {
 245         register_code(KC_RSFT);
 246         #ifdef BACKLIGHT_ENABLE
 247           backlight_step();
 248         #endif
 249       } else {
 250         unregister_code(KC_RSFT);
 251       }
 252       return false;
 253       break;
 254     case PLOVER:
 255       if (record->event.pressed) {
 256         #ifdef AUDIO_ENABLE
 257           stop_all_notes();
 258           PLAY_NOTE_ARRAY(tone_plover, false, 0);
 259         #endif
 260         layer_off(_RAISE);
 261         layer_off(_LOWER);
 262         layer_off(_ADJUST);
 263         layer_on(_PLOVER);
 264         if (!eeconfig_is_enabled()) {
 265             eeconfig_init();
 266         }
 267         keymap_config.raw = eeconfig_read_keymap();
 268         keymap_config.nkro = 1;
 269         eeconfig_update_keymap(keymap_config.raw);
 270       }
 271       return false;
 272       break;
 273     case EXT_PLV:
 274       if (record->event.pressed) {
 275         #ifdef AUDIO_ENABLE
 276           PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
 277         #endif
 278         layer_off(_PLOVER);
 279       }
 280       return false;
 281       break;
 282   }
 283   return true;
 284 }
 285
 286 void matrix_init_user(void) {
 287     #ifdef AUDIO_ENABLE
 288         startup_user();
 289     #endif
 290 }
 291
 292 #ifdef AUDIO_ENABLE
 293
 294 void startup_user()
 295 {
 296     _delay_ms(20); // gets rid of tick
 297     PLAY_NOTE_ARRAY(tone_startup, false, 0);
 298 }
 299
 300 void shutdown_user()
 301 {
 302     PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
 303     _delay_ms(150);
 304     stop_all_notes();
 305 }
 306
 307 void music_on_user(void)
 308 {
 309     music_scale_user();
 310 }
 311
 312 void music_scale_user(void)
 313 {
 314     PLAY_NOTE_ARRAY(music_scale, false, 0);
 315 }
 316
 317 #endif