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