keyboards/planck/keymaps/smt/keymap.c

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