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