aboutsummaryrefslogtreecommitdiff
path: root/layouts
diff options
context:
space:
mode:
authorMichael Guterl <michael@diminishing.org>2019-10-22 10:41:14 -0700
committerDrashna Jaelre <drashna@live.com>2019-10-22 10:41:14 -0700
commitd99f6e95e15075ecab28090e1361e2581b70a517 (patch)
treeb9fa93cd9d82a94b1e9439e1ad0c77912b988f31 /layouts
parente214f2826e6cbb03f988916eeed10f250b77408c (diff)
downloadqmk_firmware-d99f6e95e15075ecab28090e1361e2581b70a517.tar.gz
qmk_firmware-d99f6e95e15075ecab28090e1361e2581b70a517.zip
[Keymap] Add userspace and personal keymaps (#7093)
* Add Planck keymap and custom keycodes to userspace * Add Preonic keymap and extract common ortho layers and keycodes * Add Leaf60 WKL keymap * Add M60-A keymap * Add Levinson keymap * Fix links in personal readmes * Use flash target * Remove duplicate definition Co-Authored-By: fauxpark <fauxpark@gmail.com> * Remove superfluous line endings * Planck and preonic encoder should have the same behavior * Use higher level API Co-Authored-By: fauxpark <fauxpark@gmail.com> * Use layouts to reduce planck/levinson duplication * Update flash instructions for levinson
Diffstat (limited to 'layouts')
-rw-r--r--layouts/community/ortho_4x12/mguterl/config.h39
-rw-r--r--layouts/community/ortho_4x12/mguterl/keymap.c352
-rw-r--r--layouts/community/ortho_4x12/mguterl/readme.md20
-rw-r--r--layouts/community/ortho_4x12/mguterl/rules.mk1
4 files changed, 412 insertions, 0 deletions
diff --git a/layouts/community/ortho_4x12/mguterl/config.h b/layouts/community/ortho_4x12/mguterl/config.h
new file mode 100644
index 000000000..6fa31cc8a
--- /dev/null
+++ b/layouts/community/ortho_4x12/mguterl/config.h
@@ -0,0 +1,39 @@
1#pragma once
2
3#ifdef AUDIO_ENABLE
4 #define STARTUP_SONG SONG(PLANCK_SOUND)
5 // #define STARTUP_SONG SONG(NO_SOUND)
6
7 #define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
8 SONG(COLEMAK_SOUND), \
9 SONG(DVORAK_SOUND) \
10 }
11#endif
12
13/*
14 * MIDI options
15 */
16
17/* Prevent use of disabled MIDI features in the keymap */
18//#define MIDI_ENABLE_STRICT 1
19
20/* enable basic MIDI features:
21 - MIDI notes can be sent when in Music mode is on
22*/
23
24#define MIDI_BASIC
25
26/* enable advanced MIDI features:
27 - MIDI notes can be added to the keymap
28 - Octave shift and transpose
29 - Virtual sustain, portamento, and modulation wheel
30 - etc.
31*/
32//#define MIDI_ADVANCED
33
34/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
35//#define MIDI_TONE_KEYCODE_OCTAVES 2
36
37// Most tactile encoders have detents every 4 stages
38#define ENCODER_RESOLUTION 4
39
diff --git a/layouts/community/ortho_4x12/mguterl/keymap.c b/layouts/community/ortho_4x12/mguterl/keymap.c
new file mode 100644
index 000000000..2be2d449e
--- /dev/null
+++ b/layouts/community/ortho_4x12/mguterl/keymap.c
@@ -0,0 +1,352 @@
1/* Copyright 2015-2017 Jack Humbert
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17#include QMK_KEYBOARD_H
18#include "muse.h"
19#include "mguterl.h"
20
21extern keymap_config_t keymap_config;
22
23const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
24
25/* Qwerty
26 * ,-----------------------------------------------------------------------------------.
27 * |HypTab| Q | W | E | R | T | Y | U | I | O | P | Bksp |
28 * |------+------+------+------+------+------+------+------+------+------+------+------|
29 * |EscCtl| A | S | D | F | G | H | J | K | L | ; | " |
30 * |------+------+------+------+------+------+------+------+------+------+------+------|
31 * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
32 * |------+------+------+------+------+------+------+------+------+------+------+------|
33 * | GESC | Ctrl | Alt | GUI |Lower |SpcUtl|SpcUtl|Raise | Left | Down | Up |Right |
34 * `-----------------------------------------------------------------------------------'
35 */
36[_QWERTY] = LAYOUT_ortho_4x12(
37 HPR_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
38 ESC_CTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
39 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT,
40 KC_GESC, KC_LCTL, KC_LALT, KC_LGUI, LOWER, SPC_UTL, SPC_UTL, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
41),
42
43/*
44 * Gaming is very similar to Qwerty. Certain features from Qwerty are disable
45 * for better gaming experience.
46 */
47[_GAMING] = LAYOUT_ortho_4x12(
48 KC_TAB, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
49 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
50 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
51 KC_ESC, _______, _______, _______, _______, KC_SPC, KC_SPC, _______, _______, _______, _______, _______
52),
53
54/*
55 * Util is accessed by holding Space. The Util layer contains vimkeys and
56 * shortcuts that I find myself needing often.
57 */
58[_UTIL] = LAYOUT_ortho_4x12( \
59 _______, GUI_1, GUI_2, GUI_3, GUI_4, GUI_5, GUI_6, GUI_7, GUI_8, GUI_9, GUI_0, _______,
60 _______, KC_VOLD, KC_VOLU, KC_MUTE, _______, _______, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, _______, _______,
61 _______, _______, _______, _______, _______, _______, _______, GO_BACK, GO_FWD, _______, _______, _______,
62 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
63),
64/* Colemak
65 * ,-----------------------------------------------------------------------------------.
66 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
67 * |------+------+------+------+------+------+------+------+------+------+------+------|
68 * | Esc | A | R | S | T | D | H | N | E | I | O | " |
69 * |------+------+------+------+------+------+------+------+------+------+------+------|
70 * | Shift| Z | X | C | V | B | K | M | , | . | / |Enter |
71 * |------+------+------+------+------+------+------+------+------+------+------+------|
72 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
73 * `-----------------------------------------------------------------------------------'
74 */
75[_COLEMAK] = LAYOUT_ortho_4x12(
76 KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC,
77 KC_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT,
78 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT ,
79 BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
80),
81
82/* Dvorak
83 * ,-----------------------------------------------------------------------------------.
84 * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
85 * |------+------+------+------+------+------+------+------+------+------+------+------|
86 * | Esc | A | O | E | U | I | D | H | T | N | S | / |
87 * |------+------+------+------+------+------+------+------+------+------+------+------|
88 * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
89 * |------+------+------+------+------+------+------+------+------+------+------+------|
90 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
91 * `-----------------------------------------------------------------------------------'
92 */
93[_DVORAK] = LAYOUT_ortho_4x12(
94 KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC,
95 KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH,
96 KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT ,
97 BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
98),
99
100/* Lower
101 * ,-----------------------------------------------------------------------------------.
102 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
103 * |------+------+------+------+------+------+------+------+------+------+------+------|
104 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
105 * |------+------+------+------+------+------+------+------+------+------+------+------|
106 * | | F7 | F8 | F9 | F10 | F11 | F12 | - | = | [ | ] | |
107 * |------+------+------+------+------+------+------+------+------+------+------+------|
108 * | | | | | | | | Next | Vol- | Vol+ | Play |
109 * `-----------------------------------------------------------------------------------'
110 */
111[_LOWER] = LAYOUT_ortho_4x12(
112 KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC,
113 KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
114 _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,
115 _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
116),
117
118/* Raise
119 * ,-----------------------------------------------------------------------------------.
120 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
121 * |------+------+------+------+------+------+------+------+------+------+------+------|
122 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | | | | | |
123 * |------+------+------+------+------+------+------+------+------+------+------+------|
124 * | | F7 | F8 | F9 | F10 | F11 | F12 | | |Pg Up |Pg Dn | |
125 * |------+------+------+------+------+------+------+------+------+------+------+------|
126 * | | | | | | | | Next | Vol- | Vol+ | Play |
127 * `-----------------------------------------------------------------------------------'
128 */
129[_RAISE] = LAYOUT_ortho_4x12(
130 KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC,
131 KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, _______, _______, _______, _______, _______,
132 _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______, KC_PGUP, KC_PGDN, _______,
133 _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
134),
135
136/* Plover layer (http://opensteno.org)
137 * ,-----------------------------------------------------------------------------------.
138 * | # | # | # | # | # | # | # | # | # | # | # | # |
139 * |------+------+------+------+------+------+------+------+------+------+------+------|
140 * | | S | T | P | H | * | * | F | P | L | T | D |
141 * |------+------+------+------+------+------+------+------+------+------+------+------|
142 * | | S | K | W | R | * | * | R | B | G | S | Z |
143 * |------+------+------+------+------+------+------+------+------+------+------+------|
144 * | Exit | | | A | O | | E | U | | | |
145 * `-----------------------------------------------------------------------------------'
146 */
147[_PLOVER] = LAYOUT_ortho_4x12(
148 KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 ,
149 XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC,
150 XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
151 EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX
152),
153
154/* Adjust (Lower + Raise)
155 * v------------------------RGB CONTROL--------------------v
156 * ,-----------------------------------------------------------------------------------.
157 * |ToGame| Reset|Debug | RGB |RGBMOD| HUE+ | HUE- | SAT+ | SAT- |BRGTH+|BRGTH-| Del |
158 * |------+------+------+------+------+------+------+------+------+------+------+------|
159 * | | |MUSmod|Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
160 * |------+------+------+------+------+------+------+------+------+------+------+------|
161 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|TermOn|TermOf| | | |
162 * |------+------+------+------+------+------+------+------+------+------+------+------|
163 * | | | | | | | | | | | |
164 * `-----------------------------------------------------------------------------------'
165 */
166[_ADJUST] = LAYOUT_ortho_4x12(
167 TG_GAME, RESET, DEBUG, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, KC_DEL ,
168 _______, _______, MU_MOD, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______,
169 _______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, TERM_ON, TERM_OFF, _______, _______, _______,
170 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
171)
172
173};
174
175#ifdef AUDIO_ENABLE
176 float plover_song[][2] = SONG(PLOVER_SOUND);
177 float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
178#endif
179
180layer_state_t layer_state_set_user(layer_state_t state) {
181 return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
182}
183
184bool process_record_user(uint16_t keycode, keyrecord_t *record) {
185 switch (keycode) {
186 case QWERTY:
187 if (record->event.pressed) {
188 print("mode just switched to qwerty and this is a huge string\n");
189 set_single_persistent_default_layer(_QWERTY);
190 }
191 return false;
192 break;
193 case COLEMAK:
194 if (record->event.pressed) {
195 set_single_persistent_default_layer(_COLEMAK);
196 }
197 return false;
198 break;
199 case DVORAK:
200 if (record->event.pressed) {
201 set_single_persistent_default_layer(_DVORAK);
202 }
203 return false;
204 break;
205 case BACKLIT:
206 if (record->event.pressed) {
207 register_code(KC_RSFT);
208 #ifdef BACKLIGHT_ENABLE
209 backlight_step();
210 #endif
211 #ifdef KEYBOARD_planck_rev5
212 writePinLow(E6);
213 #endif
214 } else {
215 unregister_code(KC_RSFT);
216 #ifdef KEYBOARD_planck_rev5
217 writePinHigh(E6);
218 #endif
219 }
220 return false;
221 break;
222 case PLOVER:
223 if (record->event.pressed) {
224 #ifdef AUDIO_ENABLE
225 stop_all_notes();
226 PLAY_SONG(plover_song);
227 #endif
228 layer_off(_RAISE);
229 layer_off(_LOWER);
230 layer_off(_ADJUST);
231 layer_on(_PLOVER);
232 if (!eeconfig_is_enabled()) {
233 eeconfig_init();
234 }
235 keymap_config.raw = eeconfig_read_keymap();
236 keymap_config.nkro = 1;
237 eeconfig_update_keymap(keymap_config.raw);
238 }
239 return false;
240 break;
241 case EXT_PLV:
242 if (record->event.pressed) {
243 #ifdef AUDIO_ENABLE
244 PLAY_SONG(plover_gb_song);
245 #endif
246 layer_off(_PLOVER);
247 }
248 return false;
249 break;
250 }
251 return true;
252}
253
254bool muse_mode = false;
255uint8_t last_muse_note = 0;
256uint16_t muse_counter = 0;
257uint8_t muse_offset = 70;
258uint16_t muse_tempo = 50;
259
260void encoder_update(bool clockwise) {
261 if (muse_mode) {
262 if (IS_LAYER_ON(_RAISE)) {
263 if (clockwise) {
264 muse_offset++;
265 } else {
266 muse_offset--;
267 }
268 } else {
269 if (clockwise) {
270 muse_tempo+=1;
271 } else {
272 muse_tempo-=1;
273 }
274 }
275 } else {
276 if (clockwise) {
277 #ifdef MOUSEKEY_ENABLE
278 tap_code(KC_MS_WH_DOWN);
279 #else
280 tap_code(KC_PGDN);
281 #endif
282 } else {
283 #ifdef MOUSEKEY_ENABLE
284 tap_code(KC_MS_WH_UP);
285 #else
286 tap_code(KC_PGUP);
287 #endif
288 }
289 }
290}
291
292void dip_switch_update_user(uint8_t index, bool active) {
293 switch (index) {
294 case 0: {
295#ifdef AUDIO_ENABLE
296 static bool play_sound = false;
297#endif
298 if (active) {
299#ifdef AUDIO_ENABLE
300 if (play_sound) { PLAY_SONG(plover_song); }
301#endif
302 layer_on(_ADJUST);
303 } else {
304#ifdef AUDIO_ENABLE
305 if (play_sound) { PLAY_SONG(plover_gb_song); }
306#endif
307 layer_off(_ADJUST);
308 }
309#ifdef AUDIO_ENABLE
310 play_sound = true;
311#endif
312 break;
313 }
314 case 1:
315 if (active) {
316 muse_mode = true;
317 } else {
318 muse_mode = false;
319 }
320 }
321}
322
323void matrix_scan_user(void) {
324#ifdef AUDIO_ENABLE
325 if (muse_mode) {
326 if (muse_counter == 0) {
327 uint8_t muse_note = muse_offset + SCALE[muse_clock_pulse()];
328 if (muse_note != last_muse_note) {
329 stop_note(compute_freq_for_midi_note(last_muse_note));
330 play_note(compute_freq_for_midi_note(muse_note), 0xF);
331 last_muse_note = muse_note;
332 }
333 }
334 muse_counter = (muse_counter + 1) % muse_tempo;
335 } else {
336 if (muse_counter) {
337 stop_all_notes();
338 muse_counter = 0;
339 }
340 }
341#endif
342}
343
344bool music_mask_user(uint16_t keycode) {
345 switch (keycode) {
346 case RAISE:
347 case LOWER:
348 return false;
349 default:
350 return true;
351 }
352}
diff --git a/layouts/community/ortho_4x12/mguterl/readme.md b/layouts/community/ortho_4x12/mguterl/readme.md
new file mode 100644
index 000000000..d1328c9aa
--- /dev/null
+++ b/layouts/community/ortho_4x12/mguterl/readme.md
@@ -0,0 +1,20 @@
1# Michael Guterl's Ortho 4x12 Layout
2
3I use this layout for both my Planck and Levinson. I also have a very similar
4[keymap](/keyboards/preonic/keymaps/mguterl) for my Preonic.
5
6Check out my [userspace](/users/mguterl) for the custom keycodes that are used
7in keymap.c.
8
9At a very high level I use 4 layers:
10
11* Qwerty - Letters
12* Util - Vimkeys for navigation and other convenient things
13* Raise - Numbers and F keys
14* Lower - Symbols
15
16```sh
17make planck/rev5:mguterl:flash # For Planck rev5 or earlier and Planck Light
18make planck/rev6:mguterl:flash # For Planck rev6
19make keebio/levinson/rev2:mguterl:dfu # For Levinson rev2
20```
diff --git a/layouts/community/ortho_4x12/mguterl/rules.mk b/layouts/community/ortho_4x12/mguterl/rules.mk
new file mode 100644
index 000000000..dcf16bef3
--- /dev/null
+++ b/layouts/community/ortho_4x12/mguterl/rules.mk
@@ -0,0 +1 @@
SRC += muse.c
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-16 14:14:38 +0000