keyboards/planck/keymaps/andylikescandy/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   _NAVIGATION
  32 };
  33
  34 enum planck_keycodes {
  35   QWERTY = SAFE_RANGE,
  36   COLEMAK,
  37   DVORAK,
  38   PLOVER,
  39   BACKLIT,
  40   EXT_PLV
  41 };
  42
  43 #define LOWER MO(_LOWER)
  44 #define RAISE MO(_RAISE)
  45 #define _NAVIGATION 8
  46 #define NAVL MO(_NAVIGATION)
  47 #define NAVSPC LT( 8, KC_SPC)
  48 //#define SHFTENT SHFT_T(KC_ENT)
  49
  50 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  51
  52   /* Qwerty
  53    * ,-----------------------------------------------------------------------------------.
  54    * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  55    * |------+------+------+------+------+-------------+------+------+------+------+------|
  56    * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  57    * |------+------+------+------+------+------|------+------+------+------+------+------|
  58    * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Shift |
  59    * |------+------+------+------+------+------+------+------+------+------+------+------|
  60    * | Ctrl | CS   |  Alt | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  61    * `-----------------------------------------------------------------------------------'
  62    */
  63   [_QWERTY] = {
  64     {KC_TAB,  KC_Q,           KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  65     {KC_ESC,  KC_A,           KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  66     {KC_LSFT, KC_Z,           KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SFT_T(KC_ENT) },
  67     {KC_LCTL, LCTL(KC_LSFT),  KC_LGUI, KC_LALT, LOWER,   NAVSPC,  NAVSPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  68   },
  69
  70   /* Colemak
  71    * ,-----------------------------------------------------------------------------------.
  72    * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  73    * |------+------+------+------+------+-------------+------+------+------+------+------|
  74    * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  75    * |------+------+------+------+------+------|------+------+------+------+------+------|
  76    * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |SftEnt|
  77    * |------+------+------+------+------+------+------+------+------+------+------+------|
  78    * | Ctrl | CS   |  Alt | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  79    * `-----------------------------------------------------------------------------------'
  80    */
  81   [_COLEMAK] = {
  82     {KC_TAB,  KC_Q,           KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
  83     {KC_ESC,  KC_A,           KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
  84     {KC_LSFT, KC_Z,           KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SFT_T(KC_ENT)  },
  85     {KC_LCTL, LCTL(KC_LSFT),  KC_LGUI, KC_LALT, LOWER,   NAVSPC,  NAVSPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  86   },
  87
  88   /* Dvorak REUSED AS COLEMAK
  89   * ,-----------------------------------------------------------------------------------.
  90   * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  91   * |------+------+------+------+------+-------------+------+------+------+------+------|
  92   * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  93   * |------+------+------+------+------+------|------+------+------+------+------+------|
  94   * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Shift |
  95   * |------+------+------+------+------+------+------+------+------+------+------+------|
  96   * | Ctrl | CS   |  Alt | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  97   * `-----------------------------------------------------------------------------------'
  98   */
  99   [_DVORAK] = {
 100     {KC_TAB,  KC_QUOT,          KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
 101     {KC_ESC,  KC_A,             KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_QUOT},
 102     {KC_LSFT, KC_SCLN,          KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    SFT_T(KC_ENT) },
 103     {KC_LCTL, LCTL(KC_LSFT),    KC_LGUI, KC_LALT, LOWER,   NAVSPC,  NAVSPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
 104   },
 105   // /* Dvorak
 106   //  * ,-----------------------------------------------------------------------------------.
 107   //  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
 108   //  * |------+------+------+------+------+-------------+------+------+------+------+------|
 109   //  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
 110   //  * |------+------+------+------+------+------|------+------+------+------+------+------|
 111   //  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
 112   //  * |------+------+------+------+------+------+------+------+------+------+------+------|
 113   //  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
 114   //  * `-----------------------------------------------------------------------------------'
 115   //  */
 116   // [_DVORAK] = {
 117   //   {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
 118   //   {KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
 119   //   {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT },
 120   //   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   NAVSPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
 121   // },
 122 //
 123 // /* Lower
 124 // * ,-----------------------------------------------------------------------------------.
 125 // * |   ~  |  F7  |  F8  |  F9  | F10  | F11  | F12  |   _  |   +  |   {  |   }  | Bksp |
 126 // * |------+------+------+------+------+-------------+------+------+------+------+------|
 127 // * |  Del |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  |   |
 128 // * |------+------+------+------+------+------|------+------+------+------+------+------|
 129 // * |      |Ctl+z |Ctl+x |Ctl+c |Ctl+v |      |      |      |      |      |      |Enter |
 130 // * |------+------+------+------+------+------+------+------+------+------+------+------|
 131 // * |      |      |      |      |      |             |      | HOME | PGDN | PGUP | END  |
 132 // * `-----------------------------------------------------------------------------------'
 133 // */
 134 [_LOWER] = {
 135   { KC_TILD, KC_F7,  KC_F8, KC_F9, KC_F10, KC_F11,  KC_F12, KC_UNDS, KC_PLUS, KC_LCBR,  KC_RCBR,   KC_BSPC },
 136   { KC_DEL , KC_F1,  KC_F2, KC_F3, KC_F4, KC_F5,  KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC,   KC_PIPE },
 137   { _______, LCTL(KC_Z),  LCTL(KC_X), LCTL(KC_C),  LCTL(KC_V), _______, _______, _______, _______, _______, _______,   KC_ENT },
 138   { _______, _______, _______, _______, _______, KC_SPC, KC_SPC, _______, KC_HOME, KC_PGDN, KC_PGUP,    KC_END }
 139 },
 140
 141 /* Raise
 142 * ,-----------------------------------------------------------------------------------.
 143 * |   `  |  !   |  @   |  #   |  $   |  %   |  ^   |   &  |   *  |  (   |   )  | Bksp |
 144 * |------+------+------+------+------+-------------+------+------+------+------+------|
 145 * | Del  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |  \   |
 146 * |------+------+------+------+------+------|------+------+------+------+------+------|
 147 * |      |      |      |      |      |      |      |      |      |      |      |Enter |
 148 * |------+------+------+------+------+------+------+------+------+------+------+------|
 149 * |      |      |      |      |      |             |      | HOME | PGDN | PGUP | END  |
 150 * `-----------------------------------------------------------------------------------'
 151 */
 152 [_RAISE] = {
 153   { KC_GRV,  KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN,    KC_BSPC },
 154   { KC_DEL,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,       KC_BSLS },
 155   { _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,    KC_ENT },
 156   { _______, _______, _______, _______, _______, KC_SPC, KC_SPC, _______, KC_HOME, KC_PGDN, KC_PGUP,    KC_END }
 157 },
 158
 159 /* Plover layer (http://opensteno.org)
 160  * ,-----------------------------------------------------------------------------------.
 161  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 162  * |------+------+------+------+------+-------------+------+------+------+------+------|
 163  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 164  * |------+------+------+------+------+------|------+------+------+------+------+------|
 165  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 166  * |------+------+------+------+------+------+------+------+------+------+------+------|
 167  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 168  * `-----------------------------------------------------------------------------------'
 169  */
 170
 171 [_PLOVER] = {
 172   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 173   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 174   {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 175   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 176 },
 177
 178 /* Adjust (Lower + Raise)
 179  * ,-----------------------------------------------------------------------------------.
 180  * | Reset|      |      |      |      |      |      |      |      |      |      | Bksp |
 181  * |------+------+------+------+------+-------------+------+------+------+------+------|
 182  * |C.A.D.|      |      |      |      |      |      |      |      |      |      |      |
 183  * |------+------+------+------+------+------|------+------+------+------+------+------|
 184  * | CAPS |      |      |      |      |      |      |Insert|PntScn|Scroll|Pause |      |
 185  * |------+------+------+------+------+------+------+------+------+------+------+------|
 186  * |      |      |      |      |      |             |      |Qwerty|Colemk|Dvorak|Plover|
 187  * `-----------------------------------------------------------------------------------'
 188  */
 189 [_ADJUST] = {
 190   {RESET,               XXXXXXX,   XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX },
 191   {LALT(LCTL(KC_DEL)),  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,XXXXXXX, XXXXXXX, XXXXXXX,  XXXXXXX,  XXXXXXX},
 192   {KC_CAPSLOCK,         XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_INS, KC_PSCR, KC_SLCK, KC_PAUS, XXXXXXX},
 193   {_______,             _______, _______, _______, _______, _______, _______, _______, QWERTY,  COLEMAK, DVORAK, XXXXXXX}  //PLOVER}
 194 },
 195 /* Navigation
 196 * ,-----------------------------------------------------------------------------------.
 197 * |      |      |      |      |      |      |      | Home | PgDn | PgUp | End  |ctlBsp|
 198 * |------+------+------+------+------+-------------+------+------+------+------+------|
 199 * |  Del |Ctl+A |      |Shift | Ctrl |      |      | Left | Down |  Up  |Right |  Del |
 200 * |------+------+------+------+------+------|------+------+------+------+------+------|
 201 * | C+S  |Ctl+z |Ctl+x |Ctl+c |Ctl+v |      |      |      |Shift |Shift |Shift |Enter |
 202 * |------+------+------+------+------+------+------+------+------+------+------+------|
 203 * |C+A+S |      |      |      |      |             |      |C+Left|C+Down| C+Up |C+Right|
 204 * `-----------------------------------------------------------------------------------'
 205 */
 206 [_NAVIGATION] = {
 207   {XXXXXXX,             XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,       XXXXXXX, XXXXXXX,       KC_HOME, KC_PGDN, KC_PGUP, KC_END,      LCTL(KC_BSPC) },
 208   {KC_DEL,              LCTL(KC_A), XXXXXXX, KC_LSFT, KC_LCTL,    XXXXXXX, XXXXXXX,       KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT,     KC_DEL},
 209   {LCTL(KC_LSFT),       XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,       XXXXXXX, XXXXXXX,       XXXXXXX, KC_RSFT, KC_RSFT, KC_RSFT,         KC_ENT},
 210   {_______,             _______, _______,  _______, _______,      _______, _______,       LCTL(KC_LEFT), LCTL(KC_DOWN), LCTL(KC_UP), LCTL(KC_RGHT), _______}
 211 }
 212
 213
 214 };
 215
 216 #ifdef AUDIO_ENABLE
 217   float plover_song[][2]     = SONG(PLOVER_SOUND);
 218   float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 219 #endif
 220
 221 uint32_t layer_state_set_user(uint32_t state) {
 222   return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
 223 }
 224
 225 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 226   switch (keycode) {
 227     case QWERTY:
 228       if (record->event.pressed) {
 229         print("mode just switched to qwerty and this is a huge string\n");
 230         set_single_persistent_default_layer(_QWERTY);
 231       }
 232       return false;
 233       break;
 234     case COLEMAK:
 235       if (record->event.pressed) {
 236         set_single_persistent_default_layer(_COLEMAK);
 237       }
 238       return false;
 239       break;
 240     case DVORAK:
 241       if (record->event.pressed) {
 242         set_single_persistent_default_layer(_DVORAK);
 243       }
 244       return false;
 245       break;
 246     case BACKLIT:
 247       if (record->event.pressed) {
 248         register_code(KC_RSFT);
 249         #ifdef BACKLIGHT_ENABLE
 250           backlight_step();
 251         #endif
 252         PORTE &= ~(1<<6);
 253       } else {
 254         unregister_code(KC_RSFT);
 255         PORTE |= (1<<6);
 256       }
 257       return false;
 258       break;
 259     case PLOVER:
 260       if (record->event.pressed) {
 261         #ifdef AUDIO_ENABLE
 262           stop_all_notes();
 263           PLAY_SONG(plover_song);
 264         #endif
 265         layer_off(_RAISE);
 266         layer_off(_LOWER);
 267         layer_off(_ADJUST);
 268         layer_on(_PLOVER);
 269         if (!eeconfig_is_enabled()) {
 270             eeconfig_init();
 271         }
 272         keymap_config.raw = eeconfig_read_keymap();
 273         keymap_config.nkro = 1;
 274         eeconfig_update_keymap(keymap_config.raw);
 275       }
 276       return false;
 277       break;
 278     case EXT_PLV:
 279       if (record->event.pressed) {
 280         #ifdef AUDIO_ENABLE
 281           PLAY_SONG(plover_gb_song);
 282         #endif
 283         layer_off(_PLOVER);
 284       }
 285       return false;
 286       break;
 287   }
 288   return true;
 289 }