keyboards/planck/keymaps/grahampheath/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 #include QMK_KEYBOARD_H
  17
  18 extern keymap_config_t keymap_config;
  19
  20 enum planck_layers {
  21   _QWERTY,
  22   _COLEMAK,
  23   _DVORAK,
  24   _LOWER,
  25   _RAISE,
  26   _EMOJI,
  27   _PLOVER,
  28   _ADJUST
  29 };
  30
  31 enum planck_keycodes {
  32   QWERTY = SAFE_RANGE,
  33   COLEMAK,
  34   DVORAK,
  35   PLOVER,
  36   LOWER,
  37   RAISE,
  38   BACKLIT,
  39   EXT_PLV,
  40   TOUNGE,
  41   JOY,
  42   FROWN,
  43   HEART,
  44   THMBUP,
  45   THMBDN,
  46   SHRUG,
  47   WINK,
  48   GRIN,
  49   LLAP,
  50   CRY,
  51   SHIT,
  52   FLIP,
  53   FNGLEFT,
  54   ABOVE,
  55   FNGRIGHT,
  56   CONFUSED
  57 };
  58
  59
  60 #define KC_X0 MT(MOD_LCTL, KC_ESC)  // Hold for Left Ctrl, Tap for ESC
  61 #define KC_X1 MT(MOD_RSFT, KC_ENT)  // Hold for Right Shift, Tap for Enter
  62 #define KC_X2 MT(MOD_RSFT, LGUI(KC_ENT))  // Send Command Enter
  63 #define KC_MOUS TT(_EMOJI)  // Hold for Mouse Layer, or tap 5 times.
  64 #define KC_QS LGUI(KC_SPC)  // Send Command + Space (for QuickSilver).
  65 #define KC_TABR LGUI(KC_RCBR)  // Send Command + } (for tab changing).
  66 #define KC_TABL LGUI(KC_LCBR)  // Send Command + { (for tab changing).
  67 #define HYPR_0 HYPR(KC_TILD)  // Send Hyper + ~.
  68 #define HYPR_1 HYPR(KC_EXLM)  // Send Hyper + !.
  69 #define HYPR_2 HYPR(KC_AT)  // Send Hyper + @.
  70
  71
  72 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  73 /* Qwerty
  74  * ,-----------------------------------------------------------------------------------.
  75  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  76  * |------+------+------+------+------+-------------+------+------+------+------+------|
  77  * | Esc* |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  78  * |------+------+------+------+------+------|------+------+------+------+------+------|
  79  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Shift*|
  80  * |------+------+------+------+------+------+------+------+------+------+------+------|
  81  * | GUI  | Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  82  * `-----------------------------------------------------------------------------------'
  83  * - Right Shift: Tap for Enter, hold for shift.
  84  * - Escape: Tap for Esc, hold for Ctrl.
  85  */
  86 [_QWERTY] = LAYOUT_planck_grid(
  87   KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC,
  88   KC_X0,   KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
  89   KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_X1  ,
  90   KC_MOUS, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
  91 ),
  92
  93 /* Colemak
  94  * ,-----------------------------------------------------------------------------------.
  95  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  96  * |------+------+------+------+------+-------------+------+------+------+------+------|
  97  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  98  * |------+------+------+------+------+------|------+------+------+------+------+------|
  99  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
 100  * |------+------+------+------+------+------+------+------+------+------+------+------|
 101  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
 102  * `-----------------------------------------------------------------------------------'
 103  */
 104 [_COLEMAK] = LAYOUT_planck_grid(
 105   KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC,
 106   KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT,
 107   KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT ,
 108   BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
 109 ),
 110
 111 /* Dvorak
 112  * ,-----------------------------------------------------------------------------------.
 113  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
 114  * |------+------+------+------+------+-------------+------+------+------+------+------|
 115  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
 116  * |------+------+------+------+------+------|------+------+------+------+------+------|
 117  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
 118  * |------+------+------+------+------+------+------+------+------+------+------+------|
 119  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
 120  * `-----------------------------------------------------------------------------------'
 121  */
 122 [_DVORAK] = LAYOUT_planck_grid(
 123   KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC,
 124   KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH,
 125   KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT ,
 126   BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
 127 ),
 128
 129
 130 /* Emoji Layer
 131  *
 132  *                ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
 133  *                │HYPR0│     │ ;-) │     │     │ :-P │     │     │:'-( │FLIP │     │     │
 134  *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
 135  *                │HYPR1│  👆 │SHRUG│     │ :-( │     │ <3  │ :-) │     │LLAP │     │     │
 136  *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
 137  *                │HYPR2│     │     │     | :-\ │     │     │ :-D │ SHIT│     │     │     │
 138  *                ├─────┼─────┼─────┼─────┼─────┼─────┴─────┼─────┼─────┼─────┼─────┼─────┤
 139  *                │     │     │     │     │Brig-│   Sleep   │Brig+│ 👈  │ 👎  |  👍 │ 👉 │
 140  *                └─────┴─────┴─────┴─────┴─────┴───────────┴─────┴─────┴─────┴─────┴─────┘
 141  */
 142 [_EMOJI] = LAYOUT_planck_grid(
 143   HYPR_0,  _______, WINK,    _______, _______,  TOUNGE,  _______, _______, CRY,     FLIP,    _______, _______,
 144   HYPR_1,  ABOVE,   SHRUG,   _______, FROWN,    _______, HEART,   JOY,     _______, LLAP,    _______, _______,
 145   HYPR_2,  _______, _______, _______, CONFUSED, _______, _______, GRIN,    SHIT,    _______, _______, _______,
 146   _______, _______, _______, _______, KC_SLCK,  KC_SLEP, KC_SLEP, KC_PAUS, FNGLEFT, THMBDN,  THMBUP,  FNGRIGHT
 147 ),
 148
 149
 150 /* Lower
 151  * ,-----------------------------------------------------------------------------------.
 152  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 153  * |------+------+------+------+------+-------------+------+------+------+------+------|
 154  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 155  * |------+------+------+------+------+------|------+------+------+------+------+------|
 156  * | Shft |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |      |      |      |
 157  * |------+------+------+------+------+------+------+------+------+------+------+------|
 158  * |      |      |      |      |      |             |      |Tab-L |  👎  |  👍  |Tab-R |
 159  * `-----------------------------------------------------------------------------------'
 160  */
 161 [_LOWER] = LAYOUT_planck_grid(
 162   KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR,    KC_ASTR,    KC_LPRN, KC_RPRN, KC_BSPC,
 163   KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS,    KC_PLUS,    KC_LCBR, KC_RCBR, KC_PIPE,
 164   KC_LSFT, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  S(KC_NUHS), S(KC_NUBS), _______, _______, _______,
 165   _______, _______, _______, _______, _______, KC_QS,   KC_QS,   _______,    KC_TABL,    THMBDN,  THMBUP, KC_TABR
 166 ),
 167
 168 /* Raise
 169  * ,-----------------------------------------------------------------------------------.
 170  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 171  * |------+------+------+------+------+-------------+------+------+------+------+------|
 172  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 173  * |------+------+------+------+------+------|------+------+------+------+------+------|
 174  * | Shft |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |      |  Up  |CTLENT|
 175  * |------+------+------+------+------+------+------+------+------+------+------+------|
 176  * |      |      |      |      |      |             |      |      | Left | Down | Right|
 177  * `-----------------------------------------------------------------------------------'
 178  */
 179 [_RAISE] = LAYOUT_planck_grid(
 180   KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,     KC_9,    KC_0,    KC_BSPC,
 181   KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,   KC_LBRC, KC_RBRC, KC_BSLS,
 182   KC_LSFT, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS,  _______,  KC_UP,   KC_X2,
 183   _______, _______, _______, _______, _______, _______, _______, _______, _______,  KC_LEFT, KC_DOWN, KC_RGHT
 184 ),
 185
 186 /* Plover layer (http://opensteno.org)
 187  * ,-----------------------------------------------------------------------------------.
 188  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 189  * |------+------+------+------+------+-------------+------+------+------+------+------|
 190  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 191  * |------+------+------+------+------+------|------+------+------+------+------+------|
 192  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 193  * |------+------+------+------+------+------+------+------+------+------+------+------|
 194  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 195  * `-----------------------------------------------------------------------------------'
 196  */
 197 [_PLOVER] = LAYOUT_planck_grid(
 198   KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   ,
 199   XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC,
 200   XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
 201   EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX
 202 ),
 203
 204 /* Adjust (Lower + Raise)
 205  * ,-----------------------------------------------------------------------------------.
 206  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 207  * |------+------+------+------+------+-------------+------+------+------+------+------|
 208  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 209  * |------+------+------+------+------+------|------+------+------+------+------+------|
 210  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 211  * |------+------+------+------+------+------+------+------+------+------+------+------|
 212  * |Brite |      |      |      |      |             |      |      |      |      |      |
 213  * `-----------------------------------------------------------------------------------'
 214  */
 215 [_ADJUST] = LAYOUT_planck_grid(
 216   _______, RESET,   DEBUG,   _______, _______, _______, _______, TERM_ON, TERM_OFF,_______, _______, KC_DEL ,
 217   _______, _______, MU_MOD,  AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______,
 218   _______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______,
 219   BACKLIT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
 220 )
 221
 222
 223 };
 224
 225 #ifdef AUDIO_ENABLE
 226   float plover_song[][2]     = SONG(PLOVER_SOUND);
 227   float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 228 #endif
 229
 230 #ifdef BACKLIGHT_ENABLE
 231   bool has_layer_changed = true;
 232
 233   void matrix_scan_user(void) {
 234     uint8_t layer = biton32(layer_state);
 235     static uint8_t old_layer = 0;
 236
 237     if (old_layer != layer) {
 238       has_layer_changed = true;
 239       old_layer = layer;
 240     }
 241
 242     if (has_layer_changed) {
 243       has_layer_changed = false;
 244
 245       switch (layer) {
 246         case _LOWER:
 247           backlight_set(1);
 248         break;
 249         case _QWERTY:
 250           backlight_set(2);
 251         break;
 252         case _RAISE:
 253           backlight_set(3);
 254         break;
 255         case _ADJUST:
 256           backlight_set(4);
 257         break;
 258       }
 259     }
 260   };
 261 #endif
 262
 263 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 264   switch (keycode) {
 265     case QWERTY:
 266       if (record->event.pressed) {
 267         print("mode just switched to qwerty and this is a huge string\n");
 268         set_single_persistent_default_layer(_QWERTY);
 269       }
 270       return false;
 271       break;
 272     case COLEMAK:
 273       if (record->event.pressed) {
 274         set_single_persistent_default_layer(_COLEMAK);
 275       }
 276       return false;
 277       break;
 278     case DVORAK:
 279       if (record->event.pressed) {
 280         set_single_persistent_default_layer(_DVORAK);
 281       }
 282       return false;
 283       break;
 284     case LOWER:
 285       if (record->event.pressed) {
 286         layer_on(_LOWER);
 287         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 288       } else {
 289         layer_off(_LOWER);
 290         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 291       }
 292       return false;
 293       break;
 294     case RAISE:
 295       if (record->event.pressed) {
 296         layer_on(_RAISE);
 297         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 298       } else {
 299         layer_off(_RAISE);
 300         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 301       }
 302       return false;
 303       break;
 304     case BACKLIT:
 305       if (record->event.pressed) {
 306         register_code(KC_RSFT);
 307         #ifdef BACKLIGHT_ENABLE
 308           backlight_step();
 309         #endif
 310       } else {
 311         unregister_code(KC_RSFT);
 312       }
 313       return false;
 314       break;
 315     case PLOVER:
 316       if (record->event.pressed) {
 317         #ifdef AUDIO_ENABLE
 318           stop_all_notes();
 319           PLAY_SONG(plover_song);
 320         #endif
 321         layer_off(_RAISE);
 322         layer_off(_LOWER);
 323         layer_off(_ADJUST);
 324         layer_off(_EMOJI);
 325         layer_on(_PLOVER);
 326         if (!eeconfig_is_enabled()) {
 327             eeconfig_init();
 328         }
 329         keymap_config.raw = eeconfig_read_keymap();
 330         keymap_config.nkro = 1;
 331         eeconfig_update_keymap(keymap_config.raw);
 332       }
 333       return false;
 334       break;
 335     case EXT_PLV:
 336       if (record->event.pressed) {
 337         #ifdef AUDIO_ENABLE
 338           PLAY_SONG(plover_gb_song);
 339         #endif
 340         layer_off(_PLOVER);
 341       }
 342       return false;
 343       break;
 344     case FLIP:
 345       if (record->event.pressed) {
 346         SEND_STRING("&fliptable;");
 347       }
 348       return false;
 349       break;
 350     case CONFUSED:
 351       if (record->event.pressed) {
 352         SEND_STRING(":-\\");
 353       }
 354       return false;
 355       break;
 356     case SHIT:
 357       if (record->event.pressed) {
 358         SEND_STRING("&shit; ");
 359       }
 360       return false;
 361       break;
 362     case CRY:
 363       if (record->event.pressed) {
 364         SEND_STRING(":'-( ");
 365       }
 366       return false;
 367       break;
 368     case LLAP:
 369       if (record->event.pressed) {
 370         SEND_STRING("&llap; ");
 371       }
 372       return false;
 373       break;
 374     case GRIN:
 375       if (record->event.pressed) {
 376         SEND_STRING(":-D ");
 377       }
 378       return false;
 379       break;
 380     case TOUNGE:
 381       if (record->event.pressed) {
 382         SEND_STRING(":-P ");
 383       }
 384       return false;
 385       break;
 386     case JOY:
 387       if (record->event.pressed) {
 388         SEND_STRING(":-) ");
 389       }
 390       return false;
 391       break;
 392     case FROWN:
 393       if (record->event.pressed) {
 394         SEND_STRING(":-( ");
 395       }
 396       return false;
 397       break;
 398     case HEART:
 399       if (record->event.pressed) {
 400         SEND_STRING("<3 ");
 401       }
 402       return false;
 403       break;
 404     case SHRUG:
 405       if (record->event.pressed) {
 406         SEND_STRING("&shrug; ");
 407       }
 408       return false;
 409       break;
 410     case THMBUP:
 411       if (record->event.pressed) {
 412         SEND_STRING("&thumbup; ");
 413       }
 414       return false;
 415       break;
 416     case THMBDN:
 417       if (record->event.pressed) {
 418         SEND_STRING("&thumbdown; ");
 419       }
 420       return false;
 421       break;
 422     case FNGLEFT:
 423       if (record->event.pressed) {
 424         SEND_STRING("&fingerleft; ");
 425       }
 426       return false;
 427       break;
 428     case FNGRIGHT:
 429       if (record->event.pressed) {
 430         SEND_STRING("&fingerright; ");
 431       }
 432       return false;
 433       break;
 434     case WINK:
 435       if (record->event.pressed) {
 436         SEND_STRING(";-) ");
 437       }
 438       return false;
 439       break;
 440     case ABOVE:
 441       if (record->event.pressed) {
 442         SEND_STRING("&above; ");
 443       }
 444       return false;
 445       break;
 446   }
 447   return true;
 448 }