keyboards/planck/keymaps/dr0ck/keymap.c

   1 /* Copyright 2015-2017 Jack Humbert
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16
  17 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
  18 #include "planck.h"
  19 #include "action_layer.h"
  20
  21 extern keymap_config_t keymap_config;
  22
  23 enum planck_layers {
  24   _QWERTY,
  25   _COLEMAK,
  26   _DVORAK,
  27   _LOWER,
  28   _RAISE,
  29   _PLOVER,
  30   _ADJUST,
  31   _FUNCTION
  32 };
  33
  34 enum planck_keycodes {
  35   QWERTY = SAFE_RANGE,
  36   COLEMAK,
  37   DVORAK,
  38   PLOVER,
  39   LOWER,
  40   RAISE,
  41   BACKLIT,
  42   EXT_PLV,
  43   FUNCTION
  44 };
  45
  46 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  47
  48 /* Qwerty
  49  * ,-----------------------------------------------------------------------------------.
  50  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  51  * |------+------+------+------+------+-------------+------+------+------+------+------|
  52  * | Func |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  ‘   |
  53  * |------+------+------+------+------+------|------+------+------+------+------+------|
  54  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Shift |
  55  * |------+------+------+------+------+------+------+------+------+------+------+------|
  56  * | Ctrl | Alt  | GUI  | Esc  |Lower |Enter |Space |Raise | Func | Alt  |Prt Sc| Ctrl |
  57  * `-----------------------------------------------------------------------------------'
  58  */
  59 [_QWERTY] = {
  60   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  61   {FUNCTION,KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  62   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT },
  63   {KC_LCTL, KC_LALT, KC_LGUI, KC_ESC, LOWER,   KC_ENT,  KC_SPC,  RAISE,   FUNCTION, KC_RALT,KC_PSCR, KC_RCTL}
  64 },
  65
  66 /* Colemak
  67  * ,-----------------------------------------------------------------------------------.
  68  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  69  * |------+------+------+------+------+-------------+------+------+------+------+------|
  70  * | Func |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  71  * |------+------+------+------+------+------|------+------+------+------+------+------|
  72  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  73  * |------+------+------+------+------+------+------+------+------+------+------+------|
  74  * | Ctrl | GUI  | Esc  | Alt  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  75  * `-----------------------------------------------------------------------------------'
  76  */
  77 [_COLEMAK] = {
  78   {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
  79   {FUNCTION,KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
  80   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  81   {KC_LCTL, KC_LGUI, KC_ESC,  KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  82 },
  83
  84 /* Dvorak
  85  * ,-----------------------------------------------------------------------------------.
  86  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  87  * |------+------+------+------+------+-------------+------+------+------+------+------|
  88  * | Func |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
  89  * |------+------+------+------+------+------|------+------+------+------+------+------|
  90  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
  91  * |------+------+------+------+------+------+------+------+------+------+------+------|
  92  * | Ctrl | GUI  | Esc  | Alt  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  93  * `-----------------------------------------------------------------------------------'
  94  */
  95 [_DVORAK] = {
  96   {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
  97   {FUNCTION,KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
  98   {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT },
  99   {KC_LCTL, KC_LGUI, KC_ESC,  KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
 100 },
 101
 102 /* Lower
 103  * ,-----------------------------------------------------------------------------------.
 104  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Del  |
 105  * |------+------+------+------+------+-------------+------+------+------+------+------|
 106  * |      |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 107  * |------+------+------+------+------+------|------+------+------+------+------+------|
 108  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | | Home | End  |      |
 109  * |------+------+------+------+------+------+------+------+------+------+------+------|
 110  * |      |      |      |      |      |             |      | Home |Pg Up |Pg Dn | End  |
 111  * `-----------------------------------------------------------------------------------'
 112  */
 113 [_LOWER] = {
 114   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR,    KC_ASTR,    KC_LPRN, KC_RPRN, KC_DEL },
 115   {_______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS,    KC_PLUS,    KC_LCBR, KC_RCBR, KC_PIPE},
 116   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END,  _______},
 117   {_______, _______, _______, _______, _______, _______, _______, _______,    KC_HOME,    KC_PGUP, KC_PGDN, KC_END}
 118 },
 119
 120 /* Raise
 121  * ,-----------------------------------------------------------------------------------.
 122  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
 123  * |------+------+------+------+------+-------------+------+------+------+------+------|
 124  * |      |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 125  * |------+------+------+------+------+------|------+------+------+------+------+------|
 126  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |Pg Up |Pg Dn |      |
 127  * |------+------+------+------+------+------+------+------+------+------+------+------|
 128  * |      |      |      |      |      |             |      | Home |Pg Up |Pg Dn | End  |
 129  * `-----------------------------------------------------------------------------------'
 130  */
 131 [_RAISE] = {
 132   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL },
 133   {_______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 134   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______},
 135   {_______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGUP, KC_PGDN, KC_END}
 136 },
 137
 138 /* Plover layer (http://opensteno.org)
 139  * ,-----------------------------------------------------------------------------------.
 140  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 141  * |------+------+------+------+------+-------------+------+------+------+------+------|
 142  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 143  * |------+------+------+------+------+------|------+------+------+------+------+------|
 144  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 145  * |------+------+------+------+------+------+------+------+------+------+------+------|
 146  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 147  * `-----------------------------------------------------------------------------------'
 148  */
 149
 150 [_PLOVER] = {
 151   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 152   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 153   {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 154   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 155 },
 156
 157 /* Adjust (Lower + Raise)
 158  * ,-----------------------------------------------------------------------------------.
 159  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 160  * |------+------+------+------+------+-------------+------+------+------+------+------|
 161  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 162  * |------+------+------+------+------+------|------+------+------+------+------+------|
 163  * | Caps |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 164  * |------+------+------+------+------+------+------+------+------+------+------+------|
 165  * |      |      |      |      |      |             |      |      |      |      |      |
 166  * `-----------------------------------------------------------------------------------'
 167  */
 168 [_ADJUST] = {
 169   {_______, RESET,   DEBUG,   _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL },
 170   {_______, _______, MU_MOD,  AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
 171   {KC_CAPS, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 172   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 173 },
 174
 175 /* Function
 176  * ,-----------------------------------------------------------------------------------.
 177  * | Esc  |      | Prev | Play | Next |  F5  |      |Pg Up |  Up  |Pg Dn |Prt Sc| Del  |
 178  * |------+------+------+------+------+-------------+------+------+------+------+------|
 179  * |      | Mute | Vol- | Vol+ |      |      | Home | Left | Down |Right |      |      |
 180  * |------+------+------+------+------+------|------+------+------+------+------+------|
 181  * | Shift|      |      |      |      |      |  End |      |      |      |      | Shift|
 182  * |------+------+------+------+------+------+------+------+------+------+------+------|
 183  * | Ctrl |      |      |      |      |Enter |Space |      |      |      |      | Ctrl |
 184  * `-----------------------------------------------------------------------------------'
 185  */
 186 [_FUNCTION] = {
 187   {KC_ESC , _______, KC_MPRV, KC_MPLY, KC_MNXT, KC_F5, _______, KC_PGUP, KC_UP,   KC_PGDN, KC_PSCR, KC_DEL},
 188   {_______, KC_MUTE, KC_VOLD, KC_VOLU, _______, _______, KC_HOME, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______},
 189   {KC_LSFT, _______, _______, _______, _______, _______, KC_END , _______, _______, _______, _______, KC_RSFT},
 190   {KC_LCTL, _______, _______, _______, KC_ENT,  KC_SPC, _______, _______, _______, _______, _______, KC_RCTL}
 191 }
 192
 193 };
 194
 195 #ifdef AUDIO_ENABLE
 196   float plover_song[][2]     = SONG(PLOVER_SOUND);
 197   float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 198 #endif
 199
 200 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 201   switch (keycode) {
 202     case QWERTY:
 203       if (record->event.pressed) {
 204         set_single_persistent_default_layer(_QWERTY);
 205       }
 206       return false;
 207       break;
 208     case COLEMAK:
 209       if (record->event.pressed) {
 210         set_single_persistent_default_layer(_COLEMAK);
 211       }
 212       return false;
 213       break;
 214     case DVORAK:
 215       if (record->event.pressed) {
 216         set_single_persistent_default_layer(_DVORAK);
 217       }
 218       return false;
 219       break;
 220     case LOWER:
 221       if (record->event.pressed) {
 222         layer_on(_LOWER);
 223         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 224       } else {
 225         layer_off(_LOWER);
 226         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 227       }
 228       return false;
 229       break;
 230     case RAISE:
 231       if (record->event.pressed) {
 232         layer_on(_RAISE);
 233         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 234       } else {
 235         layer_off(_RAISE);
 236         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 237       }
 238       return false;
 239       break;
 240     case BACKLIT:
 241       if (record->event.pressed) {
 242         register_code(KC_RSFT);
 243         #ifdef BACKLIGHT_ENABLE
 244           backlight_step();
 245         #endif
 246       } else {
 247         unregister_code(KC_RSFT);
 248       }
 249       return false;
 250       break;
 251     case PLOVER:
 252       if (record->event.pressed) {
 253         #ifdef AUDIO_ENABLE
 254           stop_all_notes();
 255           PLAY_SONG(plover_song);
 256         #endif
 257         layer_off(_RAISE);
 258         layer_off(_LOWER);
 259         layer_off(_ADJUST);
 260         layer_on(_PLOVER);
 261         if (!eeconfig_is_enabled()) {
 262             eeconfig_init();
 263         }
 264         keymap_config.raw = eeconfig_read_keymap();
 265         keymap_config.nkro = 1;
 266         eeconfig_update_keymap(keymap_config.raw);
 267       }
 268       return false;
 269       break;
 270     case EXT_PLV:
 271       if (record->event.pressed) {
 272         #ifdef AUDIO_ENABLE
 273           PLAY_SONG(plover_gb_song);
 274         #endif
 275         layer_off(_PLOVER);
 276       }
 277       return false;
 278       break;
 279     case FUNCTION:
 280       if (record->event.pressed) {
 281         layer_on(_FUNCTION);
 282       } else {
 283         layer_off(_FUNCTION);
 284       }
 285       return false;
 286       break;
 287   }
 288   return true;
 289 }