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