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 #define MACRO_BREATH_TOGGLE    21
  41 #define MACRO_BREATH_SPEED_INC 23
  42 #define MACRO_BREATH_SPEED_DEC 24
  43 #define MACRO_BREATH_DEFAULT   25
  44 #define M_BRTOG M(MACRO_BREATH_TOGGLE)
  45 #define M_BRINC M(MACRO_BREATH_SPEED_INC)
  46 #define M_BRDEC M(MACRO_BREATH_SPEED_DEC)
  47 #define M_BRDFT M(MACRO_BREATH_DEFAULT)
  48 // Tap Dance Declarations
  49 enum {
  50   ESC_CAP = 0,
  51   LFT_HOM,
  52   DWN_PDN,
  53   UPP_PUP,
  54   RGT_END
  55 };
  56
  57 // Dylan's additions
  58 #define C_A_DEL LALT(LCTL(KC_DEL))
  59 #define C_A_INS LALT(LCTL(KC_INS))
  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  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  68  * |------+------+------+------+------+------|------+------+------+------+------+------|
  69  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  70  * |------+------+------+------+------+------+------+------+------+------+------+------|
  71  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  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   {TD(ESC_CAP), KC_A,    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_T(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 /* Colemak
  82  * ,-----------------------------------------------------------------------------------.
  83  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  84  * |------+------+------+------+------+-------------+------+------+------+------+------|
  85  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  86  * |------+------+------+------+------+------|------+------+------+------+------+------|
  87  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  88  * |------+------+------+------+------+------+------+------+------+------+------+------|
  89  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  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   {KC_ESC,  KC_A,    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, 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 /* Dvorak
 100  * ,-----------------------------------------------------------------------------------.
 101  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
 102  * |------+------+------+------+------+-------------+------+------+------+------+------|
 103  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
 104  * |------+------+------+------+------+------|------+------+------+------+------+------|
 105  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
 106  * |------+------+------+------+------+------+------+------+------+------+------+------|
 107  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
 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   {KC_ESC,  KC_A,    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,    KC_ENT },
 114   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
 115 },
 116
 117 /* Lower
 118  * ,-----------------------------------------------------------------------------------.
 119  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 120  * |------+------+------+------+------+-------------+------+------+------+------+------|
 121  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 122  * |------+------+------+------+------+------|------+------+------+------+------+------|
 123  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | | END  | HOME |Enter |
 124  * |------+------+------+------+------+------+------+------+------+------+------+------|
 125  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 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_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 131   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,S(KC_NUHS),S(KC_NUBS),KC_END, KC_HOME, _______},
 132   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 133 },
 134
 135 /* Raise
 136  * ,-----------------------------------------------------------------------------------.
 137  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 138  * |------+------+------+------+------+-------------+------+------+------+------+------|
 139  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 140  * |------+------+------+------+------+------|------+------+------+------+------+------|
 141  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |PG DN |PG UP |Enter |
 142  * |------+------+------+------+------+------+------+------+------+------+------+------|
 143  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 144  * `-----------------------------------------------------------------------------------'
 145  */
 146 [_RAISE] = {
 147   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 148   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 149   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, KC_PGDN, KC_PGUP, _______},
 150   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 151 },
 152
 153 /* Plover layer (http://opensteno.org)
 154  * ,-----------------------------------------------------------------------------------.
 155  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 156  * |------+------+------+------+------+-------------+------+------+------+------+------|
 157  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 158  * |------+------+------+------+------+------|------+------+------+------+------+------|
 159  * |TogOut|   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 160  * |------+------+------+------+------+------+------+------+------+------+------+------|
 161  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 162  * `-----------------------------------------------------------------------------------'
 163  */
 164
 165 [_PLOVER] = {
 166   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 167   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 168   {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 169   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 170 },
 171
 172 /* Adjust (Lower + Raise)
 173  * ,-----------------------------------------------------------------------------------.
 174  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 175  * |------+------+------+------+------+-------------+------+------+------+------+------|
 176  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 177  * |------+------+------+------+------+------|------+------+------+------+------+------|
 178  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 179  * |------+------+------+------+------+------+------+------+------+------+------+------|
 180  * |      |      |      |      |      |             |      |      |      |      |      |
 181  * `-----------------------------------------------------------------------------------'
 182  */
 183 [_ADJUST] = {
 184   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, M_BRDFT, KC_DEL },
 185   {_______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  _______, _______, M_BRINC, _______},
 186   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, M_BRDEC, C_A_INS},
 187   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, M_BRTOG, C_A_DEL}
 188 }
 189
 190
 191 };
 192
 193
 194 qk_tap_dance_action_t tap_dance_actions[] = {
 195   [ESC_CAP] = ACTION_TAP_DANCE_DOUBLE(KC_ESC, KC_CAPS),
 196   [LFT_HOM] = ACTION_TAP_DANCE_DOUBLE(KC_LEFT, KC_HOME),
 197   [DWN_PDN] = ACTION_TAP_DANCE_DOUBLE(KC_DOWN, KC_PGDN),
 198   [UPP_PUP] = ACTION_TAP_DANCE_DOUBLE(KC_UP, KC_PGUP),
 199   [RGT_END] = ACTION_TAP_DANCE_DOUBLE(KC_RGHT, KC_END)
 200 };
 201
 202 #ifdef AUDIO_ENABLE
 203
 204 float tone_startup[][2]    = SONG(SONIC_RING); //plug in
 205 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 206 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 207 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 208 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 209 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 210 float music_scale[][2]     = SONG(ZELDA_PUZZLE); //music mode
 211
 212 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 213 #endif
 214
 215
 216 void persistant_default_layer_set(uint16_t default_layer) {
 217   eeconfig_update_default_layer(default_layer);
 218   default_layer_set(default_layer);
 219 }
 220
 221 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
 222   switch(id) {
 223     case MACRO_BREATH_TOGGLE:
 224       if (record->event.pressed) {
 225         breathing_toggle();
 226       }
 227       break;
 228     case MACRO_BREATH_SPEED_INC:
 229       if (record->event.pressed) {
 230         breathing_speed_inc(1);
 231       }
 232       break;
 233     case MACRO_BREATH_SPEED_DEC:
 234       if (record->event.pressed) {
 235         breathing_speed_dec(1);
 236       }
 237       break;
 238     case MACRO_BREATH_DEFAULT:
 239       if (record->event.pressed) {
 240         breathing_defaults();
 241       }
 242       break;
 243   }
 244   return MACRO_NONE;
 245 }
 246
 247 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 248   switch (keycode) {
 249     case QWERTY:
 250       if (record->event.pressed) {
 251         #ifdef AUDIO_ENABLE
 252           PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 253         #endif
 254         persistant_default_layer_set(1UL<<_QWERTY);
 255       }
 256       return false;
 257       break;
 258     case COLEMAK:
 259       if (record->event.pressed) {
 260         #ifdef AUDIO_ENABLE
 261           PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 262         #endif
 263         persistant_default_layer_set(1UL<<_COLEMAK);
 264       }
 265       return false;
 266       break;
 267     case DVORAK:
 268       if (record->event.pressed) {
 269         #ifdef AUDIO_ENABLE
 270           PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
 271         #endif
 272         persistant_default_layer_set(1UL<<_DVORAK);
 273       }
 274       return false;
 275       break;
 276     case LOWER:
 277       if (record->event.pressed) {
 278         layer_on(_LOWER);
 279         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 280       } else {
 281         layer_off(_LOWER);
 282         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 283       }
 284       return false;
 285       break;
 286     case RAISE:
 287       if (record->event.pressed) {
 288         layer_on(_RAISE);
 289         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 290       } else {
 291         layer_off(_RAISE);
 292         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 293       }
 294       return false;
 295       break;
 296     case BACKLIT:
 297       if (record->event.pressed) {
 298         register_code(KC_RSFT);
 299         #ifdef BACKLIGHT_ENABLE
 300           backlight_step();
 301         #endif
 302       } else {
 303         unregister_code(KC_RSFT);
 304       }
 305       return false;
 306       break;
 307     case PLOVER:
 308       if (record->event.pressed) {
 309         #ifdef AUDIO_ENABLE
 310           stop_all_notes();
 311           PLAY_NOTE_ARRAY(tone_plover, false, 0);
 312         #endif
 313         layer_off(_RAISE);
 314         layer_off(_LOWER);
 315         layer_off(_ADJUST);
 316         layer_on(_PLOVER);
 317         if (!eeconfig_is_enabled()) {
 318             eeconfig_init();
 319         }
 320         keymap_config.raw = eeconfig_read_keymap();
 321         keymap_config.nkro = 1;
 322         eeconfig_update_keymap(keymap_config.raw);
 323       }
 324       return false;
 325       break;
 326     case EXT_PLV:
 327       if (record->event.pressed) {
 328         #ifdef AUDIO_ENABLE
 329           PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
 330         #endif
 331         layer_off(_PLOVER);
 332       }
 333       return false;
 334       break;
 335   }
 336   return true;
 337 }
 338
 339 void matrix_init_user(void) {
 340     #ifdef AUDIO_ENABLE
 341         startup_user();
 342     #endif
 343 }
 344
 345 #ifdef AUDIO_ENABLE
 346
 347 void startup_user()
 348 {
 349     _delay_ms(20); // gets rid of tick
 350     PLAY_NOTE_ARRAY(tone_startup, false, 0);
 351 }
 352
 353 void shutdown_user()
 354 {
 355     PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
 356     _delay_ms(150);
 357     stop_all_notes();
 358 }
 359
 360 void music_on_user(void)
 361 {
 362     music_scale_user();
 363 }
 364
 365 void music_scale_user(void)
 366 {
 367     PLAY_NOTE_ARRAY(music_scale, false, 0);
 368 }
 369
 370 #endif