keyboards/planck/keymaps/navi/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  * cd /c/qmk_firmware
  13  * make planck/rev4:navi
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
  19 #include "planck.h"
  20 #include "action_layer.h"
  21 #ifdef AUDIO_ENABLE
  22   #include "audio.h"
  23   #include "song_list.h"
  24 #endif
  25
  26 extern keymap_config_t keymap_config;
  27
  28 enum planck_layers {
  29   _QWERTY,
  30   _COLEMAK,
  31   _PLOVER,
  32   _LOWER,
  33   _RAISE,
  34   _ADJUST,
  35   _FUNCTION
  36 };
  37
  38 enum planck_keycodes {
  39   QWERTY = SAFE_RANGE,
  40   COLEMAK,
  41   PLOVER,
  42   LOWER,
  43   RAISE,
  44   EXT_PLV,
  45   FUNCTION
  46 };
  47
  48 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  49
  50 /* Qwerty
  51  * ,-----------------------------------------------------------------------------------.
  52  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  53  * |------+------+------+------+------+-------------+------+------+------+------+------|
  54  * | CtlE |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  55  * |------+------+------+------+------+------|------+------+------+------+------+------|
  56  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  57  * |------+------+------+------+------+------+------+------+------+------+------+------|
  58  * |  FN  |CtlSE |  GUI |  Alt | Lower|    Space    |Raise | Left | Down |  Up  |Right |
  59  * `-----------------------------------------------------------------------------------'
  60  * CtlSE = Control+shift+esc/
  61  * CtlE = Control when held, esc when tapped
  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   {LCTL_T(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, KC_ENT },
  67   {FUNCTION, C_S_T(KC_ESC), KC_LGUI, KC_LALT, LOWER,   KC_SPC,  KC_SPC,  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  * | CtlE |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  75  * |------+------+------+------+------+------|------+------+------+------+------+------|
  76  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  77  * |------+------+------+------+------+------+------+------+------+------+------+------|
  78  * |  FN  |CtlSE |  GUI |  Alt |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   {LCTL_T(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, KC_ENT },
  85   {FUNCTION, C_S_T(KC_ESC), KC_LGUI, KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  86 },
  87
  88 /* Plover layer (http://opensteno.org)
  89  * ,-----------------------------------------------------------------------------------.
  90  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
  91  * |------+------+------+------+------+-------------+------+------+------+------+------|
  92  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
  93  * |------+------+------+------+------+------|------+------+------+------+------+------|
  94  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
  95  * |------+------+------+------+------+------+------+------+------+------+------+------|
  96  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
  97  * `-----------------------------------------------------------------------------------'
  98  */
  99
 100 [_PLOVER] = {
 101   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 102   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 103   {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 104   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 105 },
 106
 107
 108 /* Lower
 109  * ,-----------------------------------------------------------------------------------.
 110  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
 111  * |------+------+------+------+------+-------------+------+------+------+------+------|
 112  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 113  * |------+------+------+------+------+------|------+------+------+------+------+------|
 114  * | Shift|  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |  ISO |  End | Home |      |
 115  * |------+------+------+------+------+------+------+------+------+------+------+------|
 116  * |      |      |      |      |      |             |      |      |Pg DN | Pg UP|      |
 117  * `-----------------------------------------------------------------------------------'
 118  */
 119 [_LOWER] = {
 120   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL},
 121   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS,    KC_PLUS,    KC_LCBR, KC_RCBR, KC_PIPE},
 122   {KC_LSHIFT, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  S(KC_NUHS), S(KC_NUBS), KC_END, KC_HOME,  _______},
 123   {_______, _______, _______, _______, _______, _______, _______, _______,    _______, KC_PGDN  , KC_PGUP, _______}
 124 },
 125
 126 /* Raise
 127  * ,-----------------------------------------------------------------------------------.
 128  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Del  |
 129  * |------+------+------+------+------+-------------+------+------+------+------+------|
 130  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 131  * |------+------+------+------+------+------|------+------+------+------+------+------|
 132  * |Shift |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / | End  | Home |       |
 133  * |------+------+------+------+------+------+------+------+------+------+------+------|
 134  * |      |      |      |      |      |             |      |      |Pg DN |Pg UP |      |
 135  * `-----------------------------------------------------------------------------------'
 136  */
 137 [_RAISE] = {
 138   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR,    KC_ASTR,    KC_LPRN, KC_RPRN, KC_DEL},
 139   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 140   {KC_LSHIFT, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, KC_END, KC_HOME,  _______},
 141   {_______, _______, _______, _______, _______, _______, _______, _______,    _______, KC_PGDN  , KC_PGUP, _______}
 142 },
 143
 144 /* Adjust (Lower + Raise)
 145  * ,-----------------------------------------------------------------------------------.
 146  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 147  * |------+------+------+------+------+-------------+------+------+------+------+------|
 148  * |      |      |MU_MOD|Aud on|Audoff|      |      |Qwerty|Colemk|Plover|      |      |
 149  * |------+------+------+------+------+------|------+------+------+------+------+------|
 150  * |Caps  |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      | Caps |
 151  * |------+------+------+------+------+------+------+------+------+------+------+------|
 152  * |      |      |      |      |      |             |      |      |      |      |      |
 153  * `-----------------------------------------------------------------------------------'
 154  */
 155 [_ADJUST] = {
 156   {_______, RESET,   DEBUG,    RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, KC_DEL },
 157   {_______, _______, MU_MOD,  AU_ON,   AU_OFF,  _______, _______, QWERTY,  COLEMAK, PLOVER,_______,  _______},
 158   {KC_CAPS, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  TERM_ON, TERM_OFF, _______, _______, KC_CAPS},
 159   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 160 },
 161
 162 /* Function
 163  * ,-----------------------------------------------------------------------------------.
 164  * | Esc  |      | Prev | Play | Next |      |      |      |  7   |  8   |  9   | Bksp |
 165  * |------+------+------+------+------+-------------+------+------+------+------+------|
 166  * |      |      | Vol- | Mute | Vol+ |      |      |   +  |  4   |  5   |  6   |  -   |
 167  * |------+------+------+------+------+------|------+------+------+------+------+------|
 168  * | CALC |      |      |      |      |      |      |   $  |  1   |  2   |  3   | Enter|
 169  * |------+------+------+------+------+------+------+------+------+------+------+------|
 170  * |      |      |Prntsc|      |      |             |   *  |  0   |  .   |Numlck|  /   |
 171  * `-----------------------------------------------------------------------------------'
 172  */
 173
 174 [_FUNCTION] = {
 175   {KC_ESC , _______, KC_MPRV, KC_MPLY, KC_MNXT, _______,_______,_______, KC_KP_7, KC_KP_8, KC_KP_9,KC_BSPC},
 176   {_______, _______, KC_VOLD, KC_MUTE, KC_VOLU, _______, _______, KC_PPLS, KC_KP_4, KC_KP_5, KC_KP_6, KC_PMNS},
 177   {KC_CALC, _______, _______, _______, _______, _______, _______, KC_DLR, KC_KP_1, KC_KP_2, KC_KP_3, KC_ENT},
 178   {_______, _______, KC_PSCR, _______, _______ , _______, _______, KC_PAST, KC_KP_0, KC_KP_DOT,KC_NUMLOCK, KC_PSLS}
 179 }
 180
 181 };
 182
 183 #ifdef AUDIO_ENABLE
 184 float tone_startup[][2]    = SONG(ZELDA_PUZZLE);
 185 float tone_qwerty[][2]     = SONG(ZELDA_TREASURE);
 186 float plover_song[][2]     = SONG(PLOVER_SOUND);
 187 float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
 188 float tone_colemak[][2]    = SONG(VIOLIN_SOUND);
 189 float tone_music_on[][2]   = SONG(ONE_UP_SOUND);
 190 float tone_music_off[][2]  = SONG(ROCK_A_BYE_BABY);
 191 #endif /* AUDIO_ENABLE */
 192
 193 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 194   switch (keycode) {
 195     case QWERTY:
 196       if (record->event.pressed) {
 197                   print("mode just switched to qwerty and this is a huge string\n");
 198                   set_single_persistent_default_layer(_QWERTY);
 199         #ifdef AUDIO_ENABLE
 200           PLAY_SONG(tone_qwerty);
 201         #endif
 202       }
 203       return false;
 204       break;
 205     case COLEMAK:
 206       if (record->event.pressed) {
 207                   set_single_persistent_default_layer(_COLEMAK);
 208         #ifdef AUDIO_ENABLE
 209           PLAY_SONG(tone_colemak);
 210         #endif
 211       }
 212       return false;
 213       break;
 214     case LOWER:
 215       if (record->event.pressed) {
 216         layer_on(_LOWER);
 217         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 218       } else {
 219         layer_off(_LOWER);
 220         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 221       }
 222       return false;
 223       break;
 224     case RAISE:
 225       if (record->event.pressed) {
 226         layer_on(_RAISE);
 227         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 228       } else {
 229         layer_off(_RAISE);
 230         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 231       }
 232       return false;
 233       break;
 234         case FUNCTION:
 235       if (record->event.pressed) {
 236         layer_on(_FUNCTION);
 237       } else {
 238         layer_off(_FUNCTION);
 239       }
 240       return false;
 241       break;
 242         case PLOVER:
 243       if (record->event.pressed) {
 244         #ifdef AUDIO_ENABLE
 245           stop_all_notes();
 246           PLAY_SONG(plover_song);
 247         #endif
 248         layer_off(_RAISE);
 249         layer_off(_LOWER);
 250         layer_off(_ADJUST);
 251         layer_on(_PLOVER);
 252         if (!eeconfig_is_enabled()) {
 253             eeconfig_init();
 254         }
 255         keymap_config.raw = eeconfig_read_keymap();
 256         keymap_config.nkro = 1;
 257         eeconfig_update_keymap(keymap_config.raw);
 258       }
 259       return false;
 260       break;
 261     case EXT_PLV:
 262       if (record->event.pressed) {
 263         #ifdef AUDIO_ENABLE
 264           PLAY_SONG(plover_gb_song);
 265         #endif
 266         layer_off(_PLOVER);
 267       }
 268       return false;
 269       break;
 270   }
 271   return true;
 272 }
 273
 274 void matrix_init_user(void) {
 275     #ifdef AUDIO_ENABLE
 276         startup_user();
 277     #endif
 278 }
 279
 280 #ifdef AUDIO_ENABLE
 281
 282 void startup_user()
 283 {
 284     _delay_ms(20); // gets rid of tick
 285     PLAY_SONG(tone_startup);
 286 }
 287
 288 void music_on_user(void)
 289 {
 290         PLAY_SONG(tone_music_on);
 291 }
 292
 293 void music_off_user(void)
 294 {
 295         PLAY_SONG(tone_music_off);
 296 }
 297 #endif
 298
 299