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