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