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