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