2020 February 29 Breaking Changes Update (#8064)
[jackhill/qmk/firmware.git] / keyboards / planck / keymaps / unicode / keymap.c
CommitLineData
b732b79b
JH
1/*
2 Copyright
3 2015 Jack Humbert <jack.humb@gmail.com>
4 2016 Francois Marlier <fmarlier@gmail.com>
5
6 This program is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 2 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
18
19 For more info on how this works per OS, see here
20 https://en.wikipedia.org/wiki/Unicode_input#Hexadecimal_code_input
21*/
22
23
26eef35f 24#include QMK_KEYBOARD_H
b732b79b
JH
25
26extern keymap_config_t keymap_config;
27
28// Each layer gets a name for readability, which is then used in the keymap matrix below.
29// The underscores don't mean anything - you can have a layer called STUFF or any other name.
30// Layer names don't all need to be of the same length, obviously, and you can also skip them
31// entirely and just use numbers.
32#define _QWERTY 0
33#define _COLEMAK 1
34#define _DVORAK 2
35#define _LOWER 3
36#define _RAISE 4
37#define _PLOVER 5
38#define _ADJUST 16
39
40// Macro name shortcuts
41#define QWERTY M(_QWERTY)
42#define COLEMAK M(_COLEMAK)
43#define DVORAK M(_DVORAK)
44#define LOWER M(_LOWER)
45#define RAISE M(_RAISE)
46#define M_BL 5
47#define PLOVER M(12)
48#define EXT_PLV M(13)
49#define TOG_OUT M(14)
50
b732b79b
JH
51const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
52
53/* Qwerty
54 * ,-----------------------------------------------------------------------------------.
55 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
56 * |------+------+------+------+------+-------------+------+------+------+------+------|
57 * | Esc | A | S | D | F | G | H | J | K | L | ; | " |
58 * |------+------+------+------+------+------|------+------+------+------+------+------|
59 * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
60 * |------+------+------+------+------+------+------+------+------+------+------+------|
61 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
62 * `-----------------------------------------------------------------------------------'
63 */
26eef35f
JY
64[_QWERTY] = LAYOUT_planck_grid(
65 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
66 KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
67 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT ,
68 M(M_BL), KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
69),
b732b79b
JH
70
71/* Colemak
72 * ,-----------------------------------------------------------------------------------.
73 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
74 * |------+------+------+------+------+-------------+------+------+------+------+------|
75 * | Esc | A | R | S | T | D | H | N | E | I | O | " |
76 * |------+------+------+------+------+------|------+------+------+------+------+------|
77 * | Shift| Z | X | C | V | B | K | M | , | . | / |Enter |
78 * |------+------+------+------+------+------+------+------+------+------+------+------|
79 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
80 * `-----------------------------------------------------------------------------------'
81 */
26eef35f
JY
82[_COLEMAK] = LAYOUT_planck_grid(
83 KC_TAB, UC_q, UC_w, UC_f, UC_p, UC_g, UC_j, UC_l, UC_u, UC_y, UC_SCLN, UC_BSPC,
84 KC_ESC, UC_a, UC_r, UC_s, UC_t, UC_d, UC_h, UC_n, UC_e, UC_i, UC_o, UC_QUOT,
85 KC_LSFT, UC_z, UC_x, UC_c, UC_v, UC_b, UC_k, UC_m, UC_COMM, UC_DOT, UC_SLSH, KC_ENT,
86 KC_TRNS, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
87),
b732b79b
JH
88
89/* Dvorak
90 * ,-----------------------------------------------------------------------------------.
91 * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
92 * |------+------+------+------+------+-------------+------+------+------+------+------|
93 * | Esc | A | O | E | U | I | D | H | T | N | S | / |
94 * |------+------+------+------+------+------|------+------+------+------+------+------|
95 * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
96 * |------+------+------+------+------+------+------+------+------+------+------+------|
97 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
98 * `-----------------------------------------------------------------------------------'
99 */
26eef35f
JY
100[_DVORAK] = LAYOUT_planck_grid(
101 KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC,
102 KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH,
103 KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT ,
104 M(M_BL), KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
105),
b732b79b
JH
106
107/* Lower
108 * ,-----------------------------------------------------------------------------------.
109 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
110 * |------+------+------+------+------+-------------+------+------+------+------+------|
111 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
112 * |------+------+------+------+------+------|------+------+------+------+------+------|
113 * | | F7 | F8 | F9 | F10 | F11 | F12 | | | | |Enter |
114 * |------+------+------+------+------+------+------+------+------+------+------+------|
115 * | | | | | | | | Next | Vol- | Vol+ | Play |
116 * `-----------------------------------------------------------------------------------'
117 */
26eef35f
JY
118[_LOWER] = LAYOUT_planck_grid(
119 KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC,
120 KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
121 _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______, _______, _______, _______,
122 _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
123),
b732b79b
JH
124
125/* Raise
126 * ,-----------------------------------------------------------------------------------.
127 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
128 * |------+------+------+------+------+-------------+------+------+------+------+------|
129 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
130 * |------+------+------+------+------+------|------+------+------+------+------+------|
131 * | | F7 | F8 | F9 | F10 | F11 | F12 | | | | |Enter |
132 * |------+------+------+------+------+------+------+------+------+------+------+------|
133 * | | | | | | | | Next | Vol- | Vol+ | Play |
134 * `-----------------------------------------------------------------------------------'
135 */
26eef35f
JY
136[_RAISE] = LAYOUT_planck_grid(
137 KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC,
138 KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,
139 _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______, _______, _______, _______,
140 _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
141),
b732b79b
JH
142
143/* Plover layer (http://opensteno.org)
144 * ,-----------------------------------------------------------------------------------.
145 * | # | # | # | # | # | # | # | # | # | # | # | # |
146 * |------+------+------+------+------+-------------+------+------+------+------+------|
147 * | | S | T | P | H | * | * | F | P | L | T | D |
148 * |------+------+------+------+------+------|------+------+------+------+------+------|
149 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
150 * |------+------+------+------+------+------+------+------+------+------+------+------|
151 * | Exit | | | A | O | | E | U | | | |
152 * `-----------------------------------------------------------------------------------'
153 */
154
26eef35f
JY
155[_PLOVER] = LAYOUT_planck_grid(
156 KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 ,
157 XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC,
158 TOG_OUT, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
159 EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX
160),
b732b79b
JH
161
162/* Adjust (Lower + Raise)
163 * ,-----------------------------------------------------------------------------------.
164 * | | Reset| | | | | | | | | | Del |
165 * |------+------+------+------+------+-------------+------+------+------+------+------|
166 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
167 * |------+------+------+------+------+------|------+------+------+------+------+------|
168 * | |Voice-|Voice+|Mus on|Musoff| | | | | | | |
169 * |------+------+------+------+------+------+------+------+------+------+------+------|
170 * | | | | | | | | | | | |
171 * `-----------------------------------------------------------------------------------'
172 */
26eef35f
JY
173[_ADJUST] = LAYOUT_planck_grid(
174 _______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL,
175 _______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______,
176 _______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______,
177 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
178)
b732b79b
JH
179
180
b732b79b
JH
181};
182
183#ifdef AUDIO_ENABLE
b732b79b 184
49e72632 185float tone_startup[][2] = SONG(STARTUP_SOUND);
b732b79b
JH
186float tone_qwerty[][2] = SONG(QWERTY_SOUND);
187float tone_dvorak[][2] = SONG(DVORAK_SOUND);
188float tone_colemak[][2] = SONG(COLEMAK_SOUND);
189float tone_plover[][2] = SONG(PLOVER_SOUND);
190float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
49e72632 191float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
b732b79b 192
49e72632 193float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
b732b79b
JH
194#endif
195
196
49e72632 197
8ddbf7f5 198void persistent_default_layer_set(uint16_t default_layer) {
b732b79b
JH
199 eeconfig_update_default_layer(default_layer);
200 default_layer_set(default_layer);
201}
202
203const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
204{
205 switch(id) {
206 case _QWERTY:
207 if (record->event.pressed) {
208 #ifdef AUDIO_ENABLE
fe60cbd9 209 PLAY_SONG(tone_qwerty);
b732b79b 210 #endif
8ddbf7f5 211 persistent_default_layer_set(1UL<<_QWERTY);
b732b79b
JH
212 }
213 break;
214 case _COLEMAK:
215 if (record->event.pressed) {
216 #ifdef AUDIO_ENABLE
fe60cbd9 217 PLAY_SONG(tone_colemak);
b732b79b 218 #endif
8ddbf7f5 219 persistent_default_layer_set(1UL<<_COLEMAK);
b732b79b
JH
220 }
221 break;
222 case _DVORAK:
223 if (record->event.pressed) {
224 #ifdef AUDIO_ENABLE
fe60cbd9 225 PLAY_SONG(tone_dvorak);
b732b79b 226 #endif
8ddbf7f5 227 persistent_default_layer_set(1UL<<_DVORAK);
b732b79b
JH
228 }
229 break;
230 case _LOWER:
231 if (record->event.pressed) {
232 layer_on(_LOWER);
233 update_tri_layer(_LOWER, _RAISE, _ADJUST);
234 } else {
235 layer_off(_LOWER);
236 update_tri_layer(_LOWER, _RAISE, _ADJUST);
237 }
238 break;
239 case _RAISE:
240 if (record->event.pressed) {
241 layer_on(_RAISE);
242 update_tri_layer(_LOWER, _RAISE, _ADJUST);
243 } else {
244 layer_off(_RAISE);
245 update_tri_layer(_LOWER, _RAISE, _ADJUST);
246 }
247 break;
248 case M_BL:
249 if (record->event.pressed) {
250 register_code(KC_RSFT);
251 #ifdef BACKLIGHT_ENABLE
252 backlight_step();
253 #endif
254 } else {
255 unregister_code(KC_RSFT);
256 }
257 break;
258 case 12:
259 if (record->event.pressed) {
260 #ifdef AUDIO_ENABLE
261 stop_all_notes();
fe60cbd9 262 PLAY_SONG(tone_plover);
b732b79b
JH
263 #endif
264 layer_off(_RAISE);
265 layer_off(_LOWER);
266 layer_off(_ADJUST);
267 layer_on(_PLOVER);
268 if (!eeconfig_is_enabled()) {
269 eeconfig_init();
270 }
271 keymap_config.raw = eeconfig_read_keymap();
272 keymap_config.nkro = 1;
273 eeconfig_update_keymap(keymap_config.raw);
274 }
275 break;
276 case 13:
277 if (record->event.pressed) {
278 #ifdef AUDIO_ENABLE
fe60cbd9 279 PLAY_SONG(tone_plover_gb);
b732b79b
JH
280 #endif
281 layer_off(_PLOVER);
282 }
283 break;
284 case 14:
285 if (record->event.pressed) {
286 return MACRO( D(E), D(R), D(F), D(V), D(O), D(L), U(E), U(R), U(F), U(V), U(O), U(L), END );
287 }
288 break;
289 }
290 return MACRO_NONE;
291};
292
293void matrix_init_user(void) {
49e72632
JH
294 #ifdef AUDIO_ENABLE
295 startup_user();
296 #endif
b732b79b
JH
297}
298
299#ifdef AUDIO_ENABLE
49e72632
JH
300
301void startup_user()
b732b79b 302{
49e72632 303 _delay_ms(20); // gets rid of tick
fe60cbd9 304 PLAY_SONG(tone_startup);
49e72632
JH
305}
306
307void shutdown_user()
308{
fe60cbd9 309 PLAY_SONG(tone_goodbye);
49e72632
JH
310 _delay_ms(150);
311 stop_all_notes();
312}
313
314void music_on_user(void)
315{
316 music_scale_user();
b732b79b 317}
b732b79b 318
49e72632
JH
319void music_scale_user(void)
320{
fe60cbd9 321 PLAY_SONG(music_scale);
49e72632
JH
322}
323
324#endif
b732b79b 325