keyboards/planck/keymaps/mjtnumsym/keymap.c

   1 // This is MJT's bastardization of the planck and minivan defaults
   2
   3 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
   4 #include "planck.h"
   5 #include "action_layer.h"
   6 #ifdef AUDIO_ENABLE
   7   #include "audio.h"
   8 #endif
   9 #include "eeconfig.h"
  10
  11 extern keymap_config_t keymap_config;
  12
  13 // Each layer gets a name for readability, which is then used in the keymap matrix below.
  14 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
  15 // Layer names don't all need to be of the same length, obviously, and you can also skip them
  16 // entirely and just use numbers.
  17
  18 enum planck_layers {
  19   _QWERTY,
  20   _FKEYS,
  21   _NUMSYM,
  22   _PLOVER,
  23   _ADJUST
  24 };
  25
  26 enum planck_keycodes {
  27   QWERTY = SAFE_RANGE,
  28   PLOVER,
  29   FKEYS,
  30   NUMSYM,
  31   BACKLIT,
  32   EXT_PLV,
  33   MACSLEEP,
  34   DYNAMIC_MACRO_RANGE,
  35 };
  36
  37 #include "dynamic_macro.h"
  38
  39 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  40
  41 /* Qwerty
  42  * ,-----------------------------------------------------------------------------------.
  43  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  44  * |------+------+------+------+------+-------------+------+------+------+------+------|
  45  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  46  * |------+------+------+------+------+------|------+------+------+------+------+------|
  47  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  48  * |------+------+------+------+------+------+------+------+------+------+------+------|
  49  * | Brite| Ctrl | Alt  | GUI  |FKEYS |    Space    |NUMSYM | Left | Down |  Up  |Right |
  50  * `-----------------------------------------------------------------------------------'
  51  */
  52 [_QWERTY] = {
  53   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  54   {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  55   {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) },
  56   {KC_LCTL, KC_LCTL, KC_LALT, KC_LGUI, FKEYS,   KC_SPC,  KC_SPC,  NUMSYM,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  57 },
  58
  59 /* FKEYS
  60  * ,-----------------------------------------------------------------------------------.
  61  * |   ~  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  |  F10 | Bksp |
  62  * |------+------+------+------+------+-------------+------+------+------+------+------|
  63  * | Del  | F11  | F12  | F13  | F14  | F15  |      |      |Sleep |      | Rec1 | Rec2 |
  64  * |------+------+------+------+------+------|------+------+------+------+------+------|
  65  * |      |      |      |      |      |      |      |      | Mac1 | Mac2 |      | Stop |
  66  * |------+------+------+------+------+------+------+------+------+------+------+------|
  67  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
  68  * `-----------------------------------------------------------------------------------'
  69  */
  70 [_FKEYS] = {
  71   {KC_TILD, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  _______},
  72   {KC_DEL,  KC_F11,  KC_F12,  KC_F13,  KC_F14,  KC_F15,  KC_F6,   _______, _______, MACSLEEP, DYN_REC_START1, DYN_REC_START2},
  73   {_______, _______, _______, _______, _______, _______, _______, _______, DYN_MACRO_PLAY1, DYN_MACRO_PLAY2, _______, DYN_REC_STOP},
  74   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
  75 },
  76
  77 /* NUMSYM
  78  * ,-----------------------------------------------------------------------------------.
  79  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
  80  * |------+------+------+------+------+-------------+------+------+------+------+------|
  81  * |  Del |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  |  '   |
  82  * |------+------+------+------+------+------|------+------+------+------+------+------|
  83  * |      |   _  |   +  |   {  |   }  |   |  |   -  |   =  |   [  |   ]  |   \  |      |
  84  * |------+------+------+------+------+------+------+------+------+------+------+------|
  85  * |      |      |      |      |      |             |      | Home |Pg Dn |Pg Up | End  |
  86  * `-----------------------------------------------------------------------------------'
  87  */
  88 [_NUMSYM] = {
  89   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    _______},
  90   {KC_DEL, KC_EXLM,  KC_AT,  KC_HASH, KC_DLR,  KC_PERC,  KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, _______},
  91   {_______,KC_UNDS,  KC_PLUS,KC_LCBR, KC_RCBR, KC_PIPE,  KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS, _______},
  92   {_______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END}
  93 },
  94
  95 /* Plover layer (http://opensteno.org)
  96  * ,-----------------------------------------------------------------------------------.
  97  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
  98  * |------+------+------+------+------+-------------+------+------+------+------+------|
  99  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 100  * |------+------+------+------+------+------|------+------+------+------+------+------|
 101  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 102  * |------+------+------+------+------+------+------+------+------+------+------+------|
 103  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 104  * `-----------------------------------------------------------------------------------'
 105  */
 106
 107 [_PLOVER] = {
 108   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 109   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 110   {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 111   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 112 },
 113
 114 /* Adjust (FKEYS + NUMSYM)
 115  * ,-----------------------------------------------------------------------------------.
 116  * |      | Reset|      |      |      |      |      |      |      |Pause |PR SC |  Del |
 117  * |------+------+------+------+------+-------------+------+------+------+------+------|
 118  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|      |Sleep |Plover|      |
 119  * |------+------+------+------+------+------|------+------+------+------+------+------|
 120  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 121  * |------+------+------+------+------+------+------+------+------+------+------+------|
 122  * |TogLED|      |      |      |      |             |      |      |      |      |      |
 123  * `-----------------------------------------------------------------------------------'
 124  */
 125 [_ADJUST] = {
 126   {_______ , RESET,   _______, _______, _______, _______, _______, _______, _______, KC_PAUS, KC_PSCR, KC_DEL },
 127   {_______ , _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  _______, MACSLEEP,  PLOVER, _______},
 128   {_______ , MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 129   {BACKLIT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 130 } /*,
 131 [_DYN] = {
 132   {_______ , _______, _______, _______, _______, _______, _______, _______, _______, DYN_REC_START1, DYN_REC_START2, _______ },
 133   {_______ , _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
 134   {_______ , _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
 135   {_______ , _______, _______, _______, _______, _______, _______, _______, _______, DYN_MACRO_PLAY1, DYN_MACRO_PLAY2, _______}
 136 }*/
 137
 138 };
 139
 140 #ifdef AUDIO_ENABLE
 141
 142 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 143 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 144 float tone_dyn_macro_rec[][2]     = SONG(DVORAK_SOUND);
 145 float tone_dyn_macro_play[][2]    = SONG(COLEMAK_SOUND);
 146 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 147 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 148 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 149
 150 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 151 #endif
 152
 153 void persistant_default_layer_set(uint16_t default_layer) {
 154   eeconfig_update_default_layer(default_layer);
 155   default_layer_set(default_layer);
 156 }
 157
 158 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 159   uint16_t macro_kc = (keycode == FKEYS ? DYN_REC_STOP : keycode);
 160   if (!process_record_dynamic_macro(macro_kc, record)) {
 161     return false;
 162   }
 163   switch (keycode) {
 164     case QWERTY:
 165       if (record->event.pressed) {
 166         #ifdef AUDIO_ENABLE
 167           PLAY_SONG(tone_qwerty);
 168         #endif
 169         persistant_default_layer_set(1UL<<_QWERTY);
 170       }
 171       return false;
 172       break;
 173     case FKEYS:
 174       if (record->event.pressed) {
 175         layer_on(_FKEYS);
 176         update_tri_layer(_FKEYS, _NUMSYM, _ADJUST);
 177       } else {
 178         layer_off(_FKEYS);
 179         update_tri_layer(_FKEYS, _NUMSYM, _ADJUST);
 180       }
 181       return false;
 182       break;
 183     case NUMSYM:
 184       if (record->event.pressed) {
 185         layer_on(_NUMSYM);
 186         update_tri_layer(_FKEYS, _NUMSYM, _ADJUST);
 187       } else {
 188         layer_off(_NUMSYM);
 189         update_tri_layer(_FKEYS, _NUMSYM, _ADJUST);
 190       }
 191       return false;
 192       break;
 193     case BACKLIT:
 194       if (record->event.pressed) {
 195         register_code(KC_RSFT);
 196         #ifdef BACKLIGHT_ENABLE
 197           backlight_step();
 198         #endif
 199       } else {
 200         unregister_code(KC_RSFT);
 201       }
 202       return false;
 203       break;
 204     case PLOVER:
 205       if (record->event.pressed) {
 206         #ifdef AUDIO_ENABLE
 207           stop_all_notes();
 208           PLAY_SONG(tone_plover);
 209         #endif
 210         layer_off(_NUMSYM);
 211         layer_off(_FKEYS);
 212         layer_off(_ADJUST);
 213         layer_on(_PLOVER);
 214         if (!eeconfig_is_enabled()) {
 215             eeconfig_init();
 216         }
 217         keymap_config.raw = eeconfig_read_keymap();
 218         keymap_config.nkro = 1;
 219         eeconfig_update_keymap(keymap_config.raw);
 220       }
 221       return false;
 222       break;
 223     case EXT_PLV:
 224       if (record->event.pressed) {
 225         #ifdef AUDIO_ENABLE
 226           PLAY_SONG(tone_plover_gb);
 227         #endif
 228         layer_off(_PLOVER);
 229       }
 230       return false;
 231       break;
 232     case MACSLEEP:
 233       if (record->event.pressed) {
 234           // ACTION_MODS_KEY(MOD_LCTL | MOD_LSFT, KC_POWER);
 235           register_code(KC_RSFT);
 236           register_code(KC_RCTL);
 237           register_code(KC_POWER);
 238           unregister_code(KC_POWER);
 239           unregister_code(KC_RCTL);
 240           unregister_code(KC_RSFT);
 241       }
 242       return false;
 243       break;
 244   }
 245   return true;
 246 }
 247
 248 void matrix_init_user(void) {
 249     #ifdef AUDIO_ENABLE
 250         startup_user();
 251     #endif
 252 }
 253
 254 #ifdef AUDIO_ENABLE
 255
 256 void startup_user()
 257 {
 258     _delay_ms(20); // gets rid of tick
 259     PLAY_SONG(tone_startup);
 260 }
 261
 262 void shutdown_user()
 263 {
 264     PLAY_SONG(tone_goodbye);
 265     _delay_ms(150);
 266     stop_all_notes();
 267 }
 268
 269 void music_on_user(void)
 270 {
 271     music_scale_user();
 272 }
 273
 274 void music_scale_user(void)
 275 {
 276     PLAY_SONG(music_scale);
 277 }
 278
 279 #endif