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