keyboards/planck/keymaps/fabian/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 custom_layers {
  24   _QWERTY,
  25   _COLEMAK,
  26   _DVORAK,
  27   _LOWER,
  28   _RAISE,
  29   _PLOVER,
  30   _ADJUST
  31 };
  32
  33 enum custom_keycodes {
  34   QWERTY = SAFE_RANGE,
  35   COLEMAK,
  36   DVORAK,
  37   PLOVER,
  38   LOWER,
  39   RAISE,
  40   BACKLIT,
  41   EXT_PLV
  42 };
  43
  44 #define XXXXXXX KC_NO
  45 #define _______ KC_TRNS
  46
  47 #define CTL_ESC CTL_T(KC_ESC)  // Tap for Escape, hold for Control
  48 #define HPR_TAB ALL_T(KC_TAB)  // Tap for Tab, hold for Hyper (Super+Ctrl+Alt+Shift)
  49 #define MEH_GRV MEH_T(KC_GRV)  // Tap for Backtick, hold for Meh (Ctrl+Alt+Shift)
  50 #define SFT_BSP SFT_T(KC_BSPC) // Tap for Backspace, hold for Shift
  51 #define SFT_ENT SFT_T(KC_ENT)  // Tap for Enter, hold for Shift
  52 #define SFT_SPC SFT_T(KC_SPC)  // Tap for Space, hold for Shift
  53 #define UMLAUT  RALT(KC_U)     // Combine Alt and U
  54
  55 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  56
  57 /* Qwerty
  58  * ,-----------------------------------------------------------------------------------.
  59  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  60  * |------+------+------+------+------+-------------+------+------+------+------+------|
  61  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  62  * |------+------+------+------+------+------|------+------+------+------+------+------|
  63  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  64  * |------+------+------+------+------+------+------+------+------+------+------+------|
  65  * | Ctrl | Meh  | Alt  | GUI  |Lower |Space | Tab  |Raise | GUI  |AltGr | Umlt | Ctrl |
  66  * `-----------------------------------------------------------------------------------'
  67  */
  68 [_QWERTY] = {
  69   {HPR_TAB, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  70   {CTL_ESC, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  71   {SFT_BSP, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SFT_ENT},
  72   {KC_LCTL, MEH_GRV, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  HPR_TAB, RAISE,   KC_RGUI, KC_RALT, UMLAUT,  KC_RCTL}
  73 },
  74
  75 /* Colemak
  76  * ,-----------------------------------------------------------------------------------.
  77  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  78  * |------+------+------+------+------+-------------+------+------+------+------+------|
  79  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  80  * |------+------+------+------+------+------|------+------+------+------+------+------|
  81  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  82  * |------+------+------+------+------+------+------+------+------+------+------+------|
  83  * | Ctrl | Meh  | Alt  | GUI  |Lower |Space | Tab  |Raise | GUI  |AltGr | Umlt | Ctrl |
  84  * `-----------------------------------------------------------------------------------'
  85  */
  86 [_COLEMAK] = {
  87   {HPR_TAB, KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
  88   {CTL_ESC, KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
  89   {SFT_BSP, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SFT_ENT},
  90   {KC_LCTL, MEH_GRV, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  HPR_TAB, RAISE,   KC_RGUI, KC_RALT, UMLAUT,  KC_RCTL}
  91 },
  92
  93 /* Dvorak
  94  * ,-----------------------------------------------------------------------------------.
  95  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  96  * |------+------+------+------+------+-------------+------+------+------+------+------|
  97  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
  98  * |------+------+------+------+------+------|------+------+------+------+------+------|
  99  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
 100  * |------+------+------+------+------+------+------+------+------+------+------+------|
 101  * | Ctrl | Meh  | Alt  | GUI  |Lower |Space | Tab  |Raise | GUI  |AltGr | Umlt | Ctrl |
 102  * `-----------------------------------------------------------------------------------'
 103  */
 104 [_DVORAK] = {
 105   {HPR_TAB, KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
 106   {CTL_ESC, KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
 107   {SFT_BSP, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    SFT_ENT},
 108   {KC_LCTL, MEH_GRV, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  HPR_TAB, RAISE,   KC_RGUI, KC_RALT, UMLAUT,  KC_RCTL}
 109 },
 110
 111 /* Lower
 112  * ,-----------------------------------------------------------------------------------.
 113  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 114  * |------+------+------+------+------+-------------+------+------+------+------+------|
 115  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 116  * |------+------+------+------+------+------|------+------+------+------+------+------|
 117  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 | MS L | MS D |MS U  | MS R |MS Btn|
 118  * |------+------+------+------+------+------+------+------+------+------+------+------|
 119  * |      |      |      |      |      |      |      |      | Next | Vol- | Vol+ | Play |
 120  * `-----------------------------------------------------------------------------------'
 121  */
 122 [_LOWER] = {
 123   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
 124   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 125   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, KC_BTN1},
 126   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 127 },
 128
 129 /* Raise
 130  * ,-----------------------------------------------------------------------------------.
 131  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 132  * |------+------+------+------+------+-------------+------+------+------+------+------|
 133  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  | }   |
 134  * |------+------+------+------+------+------|------+------+------+------+------+------|
 135  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 | Left | Down |  Up  | Rght |MS_BN2|
 136  * |------+------+------+------+------+------+------+------+------+------+------+------|
 137  * |      |      |      |      |      |      |      |      | Next | Vol- | Vol+ | Play |
 138  * `-----------------------------------------------------------------------------------'
 139  */
 140 [_RAISE] = {
 141   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 142   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 143   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, KC_BTN2},
 144   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 145 },
 146
 147 /* Plover layer (http://opensteno.org)
 148  * ,-----------------------------------------------------------------------------------.
 149  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 150  * |------+------+------+------+------+-------------+------+------+------+------+------|
 151  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 152  * |------+------+------+------+------+------|------+------+------+------+------+------|
 153  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 154  * |------+------+------+------+------+------+------+------+------+------+------+------|
 155  * | Exit |      |      |   A  |   O  |      |      |   E  |   U  |      |      |      |
 156  * `-----------------------------------------------------------------------------------'
 157  */
 158
 159 [_PLOVER] = {
 160   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 161   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 162   {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 163   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 164 },
 165
 166 /* Adjust (Lower + Raise)
 167  * ,-----------------------------------------------------------------------------------.
 168  * |      | Reset|      |      |      |      |      |      |      |      | Reset|  Del |
 169  * |------+------+------+------+------+-------------+------+------+------+------+------|
 170  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 171  * |------+------+------+------+------+------|------+------+------+------+------+------|
 172  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 173  * |------+------+------+------+------+------+------+------+------+------+------+------|
 174  * |      |      |      |      |      |      |      |      |      |      |      |      |
 175  * `-----------------------------------------------------------------------------------'
 176  */
 177 [_ADJUST] = {
 178   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, RESET,   KC_DEL },
 179   {_______, _______, MU_MOD,  AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
 180   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 181   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 182 }
 183
 184
 185 };
 186
 187 #ifdef AUDIO_ENABLE
 188   float plover_song[][2]     = SONG(PLOVER_SOUND);
 189   float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 190 #endif
 191
 192 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 193   switch (keycode) {
 194     case QWERTY:
 195       if (record->event.pressed) {
 196         set_single_persistent_default_layer(_QWERTY);
 197       }
 198       return false;
 199       break;
 200     case COLEMAK:
 201       if (record->event.pressed) {
 202         set_single_persistent_default_layer(_COLEMAK);
 203       }
 204       return false;
 205       break;
 206     case DVORAK:
 207       if (record->event.pressed) {
 208         set_single_persistent_default_layer(_DVORAK);
 209       }
 210       return false;
 211       break;
 212     case LOWER:
 213       if (record->event.pressed) {
 214         layer_on(_LOWER);
 215         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 216       } else {
 217         layer_off(_LOWER);
 218         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 219       }
 220       return false;
 221       break;
 222     case RAISE:
 223       if (record->event.pressed) {
 224         layer_on(_RAISE);
 225         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 226       } else {
 227         layer_off(_RAISE);
 228         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 229       }
 230       return false;
 231       break;
 232     case BACKLIT:
 233       if (record->event.pressed) {
 234         register_code(KC_RSFT);
 235         #ifdef BACKLIGHT_ENABLE
 236           backlight_step();
 237         #endif
 238       } else {
 239         unregister_code(KC_RSFT);
 240       }
 241       return false;
 242       break;
 243     case PLOVER:
 244       if (record->event.pressed) {
 245         #ifdef AUDIO_ENABLE
 246           stop_all_notes();
 247           PLAY_SONG(plover_song);
 248         #endif
 249         layer_off(_RAISE);
 250         layer_off(_LOWER);
 251         layer_off(_ADJUST);
 252         layer_on(_PLOVER);
 253         if (!eeconfig_is_enabled()) {
 254             eeconfig_init();
 255         }
 256         keymap_config.raw = eeconfig_read_keymap();
 257         keymap_config.nkro = 1;
 258         eeconfig_update_keymap(keymap_config.raw);
 259       }
 260       return false;
 261       break;
 262     case EXT_PLV:
 263       if (record->event.pressed) {
 264         #ifdef AUDIO_ENABLE
 265           PLAY_SONG(plover_gb_song);
 266         #endif
 267         layer_off(_PLOVER);
 268       }
 269       return false;
 270       break;
 271   }
 272   return true;
 273 }