keyboards/planck/keymaps/sgoodwin/keymap.c

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