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