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