keyboards/planck/keymaps/sean/keymap.c

   1 // This is Sean Hunter's keymap file, customized from the canonical layout file for the Quantum project.
   2 // If you want to add another keyboard, that is the style you want to emulate.
   3
   4 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
   5 #include "planck.h"
   6 #include "action_layer.h"
   7 #include "eeconfig.h"
   8 #include "mymappings.h"
   9
  10 extern keymap_config_t keymap_config;
  11
  12 // Each layer gets a name for readability, which is then used in the keymap matrix below.
  13
  14 enum planck_layers {
  15   _DVRK,
  16   _LOWER,
  17   _RAISE,
  18   _SDRK,
  19   _SLWER,
  20   _SRAIS,
  21   _NMPD,
  22   _MVMT,
  23   _ADJUST
  24 };
  25
  26 enum planck_keycodes {
  27   DVRK = SAFE_RANGE,
  28   LOWER,
  29   RAISE,
  30   SDRK,
  31   SLWER,
  32   SRAIS,
  33   BACKLIT,
  34   BACKTOG,
  35   CUT,
  36   COPY,
  37   PASTE
  38 };
  39
  40 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  41
  42 /* Dvorak
  43  * ,-----------------------------------------------------------------------------------.
  44  * |   "  |   ,  |   .  |   P  |   Y  |   /  |   =  |   F  |   G  |   C  |   R  |   L  |
  45  * |------+------+------+------+------+------+------+------+------+------+------+------|
  46  * |   A  |   O  |   E  |   U  |   I  | ESC  | BSPC |   D  |   H  |   T  |   N  |   S  |
  47  * |------+------+------+------+------+------+------+------+------+------+------+------|
  48  * |   ;  |   Q  |   J  |   K  |   X  | TAB  | ENT  |   B  |   M  |   W  |   V  |   Z  |
  49  * |------+------+------+------+------+------+------+------+------+------+------+------|
  50  * | Sft  | Ctl  | Alt  | Gui  |Lower |    Space    |Raise |   <  |   v  |   ^  |   >  |
  51  * `-----------------------------------------------------------------------------------'
  52  */
  53 [_DVRK] = {
  54   {KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_SLSH, KC_EQL,  KC_F,     KC_G,    KC_C,   KC_R,    KC_L},
  55   {KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_ESC,  KC_BSPC, KC_D,     KC_H,    KC_T,   KC_N,    KC_S},
  56   {KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_TAB,  KC_ENT,  KC_B,     KC_M,    KC_W,   KC_V,    KC_Z},
  57   {KC_LSFT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE, KC_LEFT, KC_DOWN,  KC_UP, KC_RIGHT}
  58 },
  59
  60
  61 /* Lower
  62  * ,-----------------------------------------------------------------------------------.
  63  * | F1   |  F2  |  F3  |  F4  |  F5  |  {   |  }   |  F6  |  F7  |  F8  |  F9  | F10  |
  64  * |------+------+------+------+------+-------------+------+------+------+------+------|
  65  * |  1   |   2  |   3  |   4  |   5  |  [   |  ]   |   6  |   7  |   8  |   9  |  0   |
  66  * |------+------+------+------+------+------|------+------+------+------+------+------|
  67  * |   ~  |   |  |   `  |   -  |   _  | INS  | DEL  |   (  |   )  |   +  |   =  |  \   |
  68  * |------+------+------+------+------+------+------+------+------+------+------+------|
  69  * | Sft  | Ctl  | Alt  | Gui  |Lower |             |Raise | Home | PgDn | PgUp | End  |
  70  * `-----------------------------------------------------------------------------------'
  71  */
  72 [_LOWER] = {
  73   {KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_LCBR, KC_RCBR, KC_F6,     KC_F7,    KC_F8,   KC_F9,    KC_F10},
  74   {KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_LBRC, KC_RBRC, KC_6,      KC_7,     KC_8,    KC_9,     KC_0},
  75   {KC_TILD, KC_PIPE, KC_GRV,  KC_MINS, KC_UNDS, KC_INS,  KC_DEL,  KC_LPRN,   KC_RPRN,  KC_PLUS, KC_EQL,   KC_BSLS},
  76   {_______, _______, _______, _______, _______, _______, _______, _______,   KC_HOME,  KC_PGDN, KC_PGUP,  KC_END}
  77 },
  78
  79
  80 /* Raise
  81  * ,-----------------------------------------------------------------------------------.
  82  * | F11  |  F12 |  F13 |  F14 |  F15 |      |      |  F16 |  F17 |  F18 |  F19 | F20  |
  83  * |------+------+------+------+------+-------------+------+------+------+------+------|
  84  * |  !   |   @  |   #  |   $  |   %  |Sleep | Wake |   ^  |   &  |   *  |   (  |  )   |
  85  * |------+------+------+------+------+-------------+------+------+------+------+------|
  86  * | GUI1 | GUI2 | GUI3 | GUI4 | GUI5 |             | GUI6 | GUI7 | GUI8 | GUI9 |GUI10 |
  87  * |------+------+------+------+------+------+------+------+------+------+------+------|
  88  * | Sft  | Ctl  | Alt  | Gui  |Lower |             |Raise | Gui  | Alt  | Ctl  | Sft  |
  89  * `-----------------------------------------------------------------------------------'
  90  */
  91 [_RAISE] = {
  92   { KC_F11,  KC_F12,  KC_F13,  KC_F14,  KC_F15, _______, _______,   KC_F16,  KC_F17,  KC_F18,  KC_F19,  KC_F20},
  93   {KC_EXLM,   KC_AT, KC_HASH,  KC_DLR, KC_PERC, KC_SLEP, KC_WAKE,   KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN},
  94   {  GUI_1,   GUI_2,   GUI_3,   GUI_4,   GUI_5, _______, _______,     GUI_6,   GUI_7,   GUI_8,   GUI_9,  GUI_10},
  95   {KC_LSFT, KC_LCTL, KC_LALT, KC_LGUI,   LOWER,  KC_SPC,  KC_SPC,     RAISE, KC_RGUI, KC_RALT, KC_RCTL, KC_RSFT}
  96 },
  97
  98 /* 'Software Dvorak': Designed to look like dvorak in the mapping but depend on software
  99  * dvorak (ie the OS keymapping changed to dvorak).
 100  * ,-----------------------------------------------------------------------------------.
 101  * |   "  |   ,  |   .  |   P  |   Y  |   /  |   =  |   F  |   G  |   C  |   R  |   L  |
 102  * |------+------+------+------+------+------+------+------+------+------+------+------|
 103  * |   A  |   O  |   E  |   U  |   I  | ESC  | BSPC |   D  |   H  |   T  |   N  |   S  |
 104  * |------+------+------+------+------+------+------+------+------+------+------+------|
 105  * |   ;  |   Q  |   J  |   K  |   X  | TAB  | ENT  |   B  |   M  |   W  |   V  |   Z  |
 106  * |------+------+------+------+------+------+------+------+------+------+------+------|
 107  * | Sft  | Ctl  | Alt  | Gui  |SLower|    Space    |SRaise|   <  |   v  |   ^  |   >  |
 108  * `-----------------------------------------------------------------------------------'
 109  */
 110 [_SDRK] = {
 111   {DV_QUOT, DV_COMM, DV_DOT,  DV_P,    DV_Y,    DV_SLSH, DV_EQL,  DV_F,     DV_G,    DV_C,   DV_R,    DV_L},
 112   {DV_A,    DV_O,    DV_E,    DV_U,    DV_I,    KC_ESC,  KC_BSPC, DV_D,     DV_H,    DV_T,   DV_N,    DV_S},
 113   {DV_SCLN, DV_Q,    DV_J,    DV_K,    DV_X,    KC_TAB,  KC_ENT,  DV_B,     DV_M,    DV_W,   DV_V,    DV_Z},
 114   {KC_LSFT, KC_LCTL, KC_LALT, KC_LGUI, SLWER,   KC_SPC,  KC_SPC, SRAIS, KC_LEFT, KC_DOWN,  KC_UP, KC_RIGHT}
 115 },
 116
 117
 118 /* 'Software dvorak lower mode':  Puts all the braces etc in the right places so it works
 119  * just like the lower mode above except that it depends on the OS keymapping being set
 120  * to dvorak.
 121  * ,-----------------------------------------------------------------------------------.
 122  * | F1   |  F2  |  F3  |  F4  |  F5  |  {   |  }   |  F6  |  F7  |  F8  |  F9  | F10  |
 123  * |------+------+------+------+------+-------------+------+------+------+------+------|
 124  * |  1   |   2  |   3  |   4  |   5  |  [   |  ]   |   6  |   7  |   8  |   9  |  0   |
 125  * |------+------+------+------+------+------|------+------+------+------+------+------|
 126  * |   ~  |   |  |   `  |   -  |   _  | INS  | DEL  |   (  |   )  |   +  |   =  |  \   |
 127  * |------+------+------+------+------+------+------+------+------+------+------+------|
 128  * | Sft  | Ctl  | Alt  | Gui  |SLower|             |SRaise| Home | PgDn | PgUp | End  |
 129  * `-----------------------------------------------------------------------------------'
 130  */
 131 [_SLWER] = {
 132   {KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   DV_LCBR, DV_RCBR, KC_F6,     KC_F7,    KC_F8,   KC_F9,    KC_F10},
 133   {DV_1,    DV_2,    DV_3,    DV_4,    DV_5,    DV_LBRC, DV_RBRC, DV_6,      DV_7,     DV_8,    DV_9,     DV_0},
 134   {DV_TILD, DV_PIPE, DV_GRV,  DV_MINS, DV_UNDS, KC_INS,  KC_DEL,  DV_LPRN,   DV_RPRN,  DV_PLUS, DV_EQL,   DV_BSLS},
 135   {_______, _______, _______, _______, _______, _______, _______, _______,   KC_HOME,  KC_PGDN, KC_PGUP,  KC_END}
 136 },
 137
 138
 139 /* 'Software dvorak raise mode'
 140  * ,-----------------------------------------------------------------------------------.
 141  * | F11  |  F12 |  F13 |  F14 |  F15 |      |      |  F16 |  F17 |  F18 |  F19 | F20  |
 142  * |------+------+------+------+------+-------------+------+------+------+------+------|
 143  * |  !   |   @  |   #  |   $  |   %  |Sleep | Wake |   ^  |   &  |   *  |   (  |  )   |
 144  * |------+------+------+------+------+-------------+------+------+------+------+------|
 145  * | GUI1 | GUI2 | GUI3 | GUI4 | GUI5 |             | GUI6 | GUI7 | GUI8 | GUI9 |GUI10 |
 146  * |------+------+------+------+------+------+------+------+------+------+------+------|
 147  * | Sft  | Ctl  | Alt  | Gui  |Lower |             |Raise | Gui  | Alt  | Ctl  | Sft  |
 148  * `-----------------------------------------------------------------------------------'
 149  */
 150 [_SRAIS] = {
 151   { KC_F11,  KC_F12,  KC_F13,  KC_F14,  KC_F15, _______, _______,   KC_F16,  KC_F17,  KC_F18,  KC_F19,  KC_F20},
 152   {DV_EXLM,   DV_AT, DV_HASH,  DV_DLR, DV_PERC, KC_SLEP, KC_WAKE,   DV_CIRC, DV_AMPR, DV_ASTR, DV_LPRN, DV_RPRN},
 153   {  GUI_1,   GUI_2,   GUI_3,   GUI_4,   GUI_5, _______, _______,     GUI_6,   GUI_7,   GUI_8,   GUI_9,  GUI_10},
 154   {KC_LSFT, KC_LCTL, KC_LALT, KC_LGUI,   SLWER,  KC_SPC,  KC_SPC,     SRAIS, KC_RGUI, KC_RALT, KC_RCTL, KC_RSFT}
 155 },
 156
 157
 158 /* Adjust (Lower + Raise or SLower + SRaise)
 159  * ,-----------------------------------------------------------------------------------.
 160  * |      | Reset|      |      |      |AGnorm|AGswap|      |      |HRevl |HReset|HMenu |
 161  * |------+------+------+------+------+-------------+------+------+------+------+------|
 162  * | PWR  | EJCT | CUT  | COPY |PASTE |PrScr |SysReq| CAPS | <<   |  >>  | Mute | Stop |
 163  * |------+------+------+------+------+------|------+------+------+------+------+------|
 164  * |DVORAK|NUMPAD| MVMT | SDRK |      |      |      |      | Next | Vol- | Vol+ | Play |
 165  * |------+------+------+------+------+------+------+------+------+------+------+------|
 166  * |Brite |BToggl|      |      |             |      |      | Gui  | Alt  | Ctl  | Sft  |
 167  * `-----------------------------------------------------------------------------------'
 168  */
 169 [_ADJUST] = {
 170   {_______,     RESET,   _______, _______, _______, AG_NORM,   AG_SWAP, _______, _______,    HRVL,  HRESET,  HMENU},
 171   { KC_PWR,   KC_EJCT,       CUT,    COPY,   PASTE, KC_PSCR, KC_SYSREQ, KC_CAPS, KC_MRWD, KC_MFFD, KC_MUTE, KC_MSTP},
 172   {   DVRK, TO(_NMPD), TO(_MVMT),    SDRK, _______, _______,   _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY},
 173   {BACKLIT,   BACKTOG,   _______, _______, _______, _______,   _______, _______, KC_RGUI, KC_RALT, KC_RCTL, KC_RSFT}
 174 },
 175
 176
 177 /* Numpad
 178  * ,-----------------------------------------------------------------------------------.
 179  * |      |      |      |      |      |      |      |NumLck|   7  |   8  |   9  |   /  |
 180  * |------+------+------+------+------+------+------+------+------+------+------+------|
 181  * |      |      |      |      |      |      |      |Enter |   4  |   5  |   6  |   *  |
 182  * |------+------+------+------+------+------+------+------+------+------+------+------|
 183  * |DVORAK|NUMPAD| MVMT | SDRK |      |      |      |      |   3  |   2  |   1  |   -  |
 184  * |------+------+------+------+------+-------------+------+------+------+------+------|
 185  * |      |      |      |      |      |             |      |      |   0  |   .  |   +  |
 186  * `-----------------------------------------------------------------------------------'
 187  */
 188 [_NMPD] = {
 189     {XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_NLCK, KC_P7,   KC_P8,   KC_P9,   KC_PSLS},
 190     {XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_PENT, KC_P4,   KC_P5,   KC_P6,   KC_PAST},
 191     {TO(_DVRK),TO(_NMPD),TO(_MVMT),SDRK, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_P1,   KC_P2,   KC_P3,   KC_PMNS},
 192     {_______, _______, _______, _______, _______, _______, _______, _______, _______, KC_P0,   KC_PDOT, KC_PPLS}
 193 },
 194
 195
 196 /* Movement
 197  * ,-----------------------------------------------------------------------------------.
 198  * |MsBut2|MsWhDn|MsWhUp|MsBut1|MsBut3|      |      |      | Home | PgDn | PgUp |  End |
 199  * +------+------+------+------+------+------+------+------+------+------+------+------+
 200  * |Ms Lft|Ms Dn |Ms Up |Ms Rht|      |      |      |      | Left | Down |  Up  | Right|
 201  * |------+------+------+------+------+------+------+------+------+------+------+------|
 202  * |DVORAK|NUMPAD| MVMT | SDRK |      |      |      |      |      |      |      |      |
 203  * |------+------+------+------+------+-------------+------+------+------+------+------|
 204  * | Sft  | Ctl  | Alt  | Gui  |      |             |      | Gui  | Alt  | Ctl  | Sft  |
 205  * `-----------------------------------------------------------------------------------'
 206  */
 207 [_MVMT] = {
 208     {KC_MB2,  KC_MWDN, KC_MWUP, KC_MB1,   KC_MB3, XXXXXXX, XXXXXXX, XXXXXXX, KC_HOME, KC_PGDN, KC_PGUP, KC_END},
 209     {KC_MLFT, KC_MDN,  KC_MUP,  KC_MRGT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT},
 210     {TO(_DVRK),TO(_NMPD),TO(_MVMT),SDRK,XXXXXXX,XXXXXXX,XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX},
 211     {KC_LSFT, KC_LCTL, KC_LALT, KC_LGUI, _______, _______, _______, _______, KC_RGUI, KC_RALT, KC_RCTL, KC_RSFT}
 212 },
 213 };
 214
 215
 216 void persistent_default_layer_set(uint16_t default_layer) {
 217   eeconfig_update_default_layer(default_layer);
 218   default_layer_set(default_layer);
 219 }
 220
 221 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 222   switch (keycode) {
 223     case DVRK:
 224       if (record->event.pressed) {
 225         persistent_default_layer_set(1UL<<_DVRK);
 226         layer_on(_DVRK);
 227       }
 228       return false;
 229       break;
 230     case LOWER:
 231       if (record->event.pressed) {
 232         layer_on(_LOWER);
 233         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 234       } else {
 235         layer_off(_LOWER);
 236         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 237       }
 238       return false;
 239       break;
 240     case RAISE:
 241       if (record->event.pressed) {
 242         layer_on(_RAISE);
 243         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 244       } else {
 245         layer_off(_RAISE);
 246         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 247       }
 248       return false;
 249       break;
 250     case SDRK:
 251       if (record->event.pressed) {
 252         persistent_default_layer_set(1UL<<_SDRK);
 253         layer_on(_SDRK);
 254       }
 255       return false;
 256       break;
 257     case SLWER:
 258       if (record->event.pressed) {
 259         layer_on(_SLWER);
 260         update_tri_layer(_SLWER, _SRAIS, _ADJUST);
 261       } else {
 262         layer_off(_SLWER);
 263         update_tri_layer(_SLWER, _SRAIS, _ADJUST);
 264       }
 265       return false;
 266       break;
 267     case SRAIS:
 268       if (record->event.pressed) {
 269         layer_on(_SRAIS);
 270         update_tri_layer(_SLWER, _SRAIS, _ADJUST);
 271       } else {
 272         layer_off(_SRAIS);
 273         update_tri_layer(_SLWER, _SRAIS, _ADJUST);
 274       }
 275       return false;
 276       break;
 277     case BACKLIT:
 278       if (record->event.pressed) {
 279         register_code(KC_RSFT);
 280         #ifdef BACKLIGHT_ENABLE
 281           backlight_step();
 282         #endif
 283       } else {
 284         unregister_code(KC_RSFT);
 285       }
 286       return false;
 287       break;
 288     case BACKTOG:
 289       if (record->event.pressed) {
 290         #ifdef BACKLIGHT_ENABLE
 291           backlight_toggle();
 292         #endif
 293       }
 294       return false;
 295       break;
 296     case CUT: //cut macro
 297             return MACRODOWN( DOWN(KC_LCTL), TYPE(KC_X), UP(KC_LCTL), END );
 298     case COPY: // copy macro
 299             return MACRODOWN( DOWN(KC_LCTL), TYPE(KC_C), UP(KC_LCTL), END );
 300     case PASTE: // paste macro
 301             return MACRODOWN( DOWN(KC_LCTL), TYPE(KC_V), UP(KC_LCTL), END );
 302   }
 303   return true;
 304 }
 305
 306 void matrix_init_user(void) {
 307 }