keyboards/planck/keymaps/smt/keymap.c

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