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