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