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