1 // This is the canonical layout file for the Quantum project. If you want to add another keyboard,
2 // this is the style you want to emulate.
4 // To flash planck firmware
5 // ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
6 // Reset keyboard or press hw reset button on base (hole)
8 // cd qmk_firmware/keyboards/planck
9 // sudo make KEYMAP=sdothum dfu
11 // sudo make clean (good practice before flashing)
12 // sudo make KEYMAP=sdothum (to compile check)
14 // Package requirements (for arch linux)
15 // ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
22 // ** E R G O W I D E S P L I T ** Layout
24 // Autocompletion tap dance key pairs (),[],{} are available from the
25 // number/symbol layer, as well as, numerous (un)shift key values
27 // The navigation pad provides a single hand right thumb activated cluster
28 // with left hand modifiers
30 // #define PRIVATE_STRING includes private_string.h, a user defined code
31 // block for the PRIV tap dance e.g. SEND_STRING("secret messape"),
32 // see function private()
36 // The num and sym keys together access the navigation pad layer
38 // ,-----------------------------------------------------------------------------------.
39 // | Ctrl | GUI | Alt | Esc | Space| Tab | Bksp | Ent | Left | Down | Up | Right|
40 // `-----------------------------------------------------------------------------------'
44 // For sculpted keycaps such as Cherry or OEM profile, reverse the Alt, Num,
45 // Shift, Shift, Nav, Sym keycaps for more ergonomic thumb orientation and
50 // This source is shamelessly based on the "default" planck layout
52 // #ifdef/#endif block structures are not indented, as syntax highlighting
53 // in vim is sufficient for identification
55 // c++ commenting style is used throughout
59 // See http://thedarnedestthing.com/planck%20constant
60 // See http://thedarnedestthing.com/planck%20done
66 // sudo CPATH=<keymap.c directory>/common make ...
70 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
72 #include "action_layer.h"
74 #include "keymap_steno.h"
81 extern keymap_config_t keymap_config;
107 enum planck_keycodes {
112 ,SM_CIRC // pseudo GUI_T(S(KC_6)) for shifted key-codes, see process_record_user()
113 ,SM_DLR // pseudo SFT_T(S(KC_4)) for shifted key-codes, see process_record_user()
114 ,SM_G // pseudo MT (MOD_LALT | MOD_LSFT, S(KC_G)) for shifted key-codes, see process_record_user()
115 ,SM_H // pseudo MT (MOD_LCTL | MOD_LSFT, S(KC_H)) for shifted key-codes, see process_record_user()
116 ,SM_PERC // pseudo ALT_T(S(KC_5)) for shifted key-codes, see process_record_user()
117 ,SM_W // pseudo MT (MOD_LGUI | MOD_LSFT, S(KC_W)) for shifted key-codes, see process_record_user()
118 ,SL_LEFT // pseudo LT (_MOUSE, S(KC_LEFT)) for shifted key-codes, see process_record_user()
119 ,SP_DEL // pseudo LT (_MOUSE, KC_DEL) for shifted key-codes, see process_record_user()
120 ,SL_TAB // pseudo LT (_FNCKEY, S(KC_TAB)) for shifted key-codes, see process_record_user()
121 ,SL_SPC // pseudo LT (S(_SYMBOL), KC_SPC) for home row shifted GUIFN
123 ,HOME_A // pseudo SFT_T(KC_A)
124 ,HOME_T // pseudo SFT_T(KC_T)
135 ,LT_C = LT (_NUMBER, KC_C)
136 ,LT_V = LT (_FNCKEY, KC_V)
137 ,LT_N = LT (_EDIT, KC_N)
138 ,LT_M = LT (_SYMBOL, KC_M)
143 #define AT_B ALT_T(KC_B)
144 #define AT_DOWN ALT_T(KC_DOWN)
145 #define CT_RGHT CTL_T(KC_RGHT)
146 #define GT_C GUI_T(KC_C)
147 #define GT_UP GUI_T(KC_UP)
148 #define MT_E MT (MOD_LCTL | MOD_LALT, KC_E)
149 #define ST_A SFT_T(KC_A)
151 #define HOME_H GUI_T(KC_H)
152 #define HOME_I CTL_T(KC_I)
153 #define HOME_E ALT_T(KC_E)
154 #define HOME_R ALT_T(KC_R)
155 #define HOME_S CTL_T(KC_S)
156 #define HOME_W GUI_T(KC_W)
168 #define S_DOWN S (KC_DOWN)
169 #define S_LEFT S (KC_LEFT)
170 #define S_RGHT S (KC_RGHT)
171 #define S_TAB S (KC_TAB)
172 #define S_UP S (KC_UP)
174 #include "tapdance.h"
177 #define ___x___ KC_TRNS
178 #define ___fn__ KC_TRNS
180 #define _______ KC_NO
182 #define COPY LCTL(KC_C)
183 #define CUT LCTL(KC_X)
184 #define EOT LCTL(KC_D)
185 #define NAK LCTL(KC_U)
186 #define PASTE LCTL(KC_V)
187 #define UNDO LCTL(KC_Z)
188 #define TMCOPY LALT(LCTL(KC_C))
189 #define TMPASTE LALT(LCTL(KC_V))
190 #define LT_BSLS LT (_MOUSE, KC_BSLS) // see process_record_user() for extended handling
191 #define LT_BSPC LT (_EDIT, KC_BSPC)
192 #define SP_LEFT LT (_EDIT, KC_LEFT)
193 #define LT_ESC LT (_NUMBER, KC_ESC)
194 #define LT_LEFT LT (_SYMBOL, KC_LEFT) // see process_record_user() for extended handling
195 #define SP_BSPC LT (_SYMBOL, KC_BSPC) // see process_record_user() for extended handling
196 #define LT_TAB LT (_FNCKEY, KC_TAB)
197 #define LT_INS LT (_FNCKEY, KC_INS)
198 #define ADJUST MO (_ADJUST)
199 #define OS_ALT OSM (MOD_LALT)
200 #define OS_CTL OSM (MOD_LCTL)
201 #define OS_GUI OSM (MOD_LGUI)
202 #define OS_SFT OSM (MOD_LSFT)
205 #define CNTR_TL TT (_TTFNCKEY)
206 #define CNTR_TR KC_CAPS
207 #define CNTR_HL TT (_TTCURSOR)
208 #define CNTR_HR TT (_TTMOUSE)
209 #define CNTR_BL TT (_TTNUMBER)
210 #define CNTR_BR TT (_TTREGEX)
212 #define CNTR_TL OSM (MOD_LALT | MOD_LCTL)
213 #define CNTR_TR OSM (MOD_LGUI | MOD_LCTL)
214 #define CNTR_HL OSM (MOD_LALT | MOD_LSFT)
215 #define CNTR_HR OSM (MOD_LGUI | MOD_LSFT)
216 #define CNTR_BL TD (_CAPS)
217 #define CNTR_BR OSM (MOD_LSFT | MOD_LCTL)
220 // LT can only reference layers 0-15
222 #define LT_EQL LT (_ADJUST, KC_EQL)
224 #define LT_0 LT (_ADJUST, KC_0)
227 // ........................................................ Default Alpha Layout
229 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
232 #include "steno_layout.h"
234 // ...................................................... Number / Function Keys
236 #include "number_fkey_layout.h"
238 // ......................................................... Symbol / Navigation
240 #include "symbol_guifn_layout.h"
242 // ............................................................... Toggle Layers
245 #include "toggle_layout.h"
248 // ......................................................... Short Cuts / Adjust
250 #include "chord_layout.h"
254 // ...................................................................... Sounds
258 // ........................................................... User Keycode Trap
260 #include "keycode_functions.h"
265 static uint8_t base_n = 0;
267 bool process_record_user(uint16_t keycode, keyrecord_t *record)
271 if (record->event.pressed) {
272 base_n = base_n | BASE_1;
273 if (base_n == BASE_12) {
278 base_n = base_n & ~BASE_1;
282 if (record->event.pressed) {
283 base_n = base_n | BASE_2;
284 if (base_n == BASE_12) {
289 base_n = base_n & ~BASE_2;
295 tap_mods(record, KC_LALT);
296 symbol_shift(record, 0);
300 tap_mods(record, KC_LGUI);
301 symbol_shift(record, 0);
305 tap_mods(record, KC_LCTL);
306 symbol_shift(record, 0);
309 tap_mods(record, KC_LSFT);
310 symbol_shift(record, KC_A);
313 tap_mods(record, KC_RSFT);
314 symbol_shift(record, KC_T);
318 tap_mods(record, KC_LALT);
321 tap_mods(record, KC_LGUI);
324 tap_mods(record, KC_LCTL);
328 lt(record, NOSHIFT, KC_SPC, KC_LSFT, _SYMBOL);
332 clear_tt(); // exit TT layer
337 if (tt_keycode != 0) {
338 clear_tt(); // exit TT layer
342 tap_layer(record, _NUMBER);
346 tap_layer(record, _SYMBOL);
347 // LT (_SYMBOL, KC_LEFT) left right combination layer
348 thumb_layer(record, RIGHT, 0, 0, _SYMBOL, _LSHIFT);
351 tap_mods(record, KC_LALT);
354 tap_mods(record, KC_LCTL);
357 tap_mods(record, KC_LGUI);
361 mt_shift(record, KC_LGUI, 0, KC_6);
365 mt_shift(record, KC_LSFT, 0, KC_4);
368 // MT(MOD_LALT | MOD_LSFT, S(KC_G))
369 mt_shift(record, KC_LALT, KC_LSFT, KC_G);
372 // MT(MOD_LCTL | MOD_LSFT, S(KC_K))
373 mt_shift(record, KC_LCTL, KC_LSFT, KC_H);
376 // MT(MOD_LGUI | MOD_LSFT, S(KC_W))
377 mt_shift(record, KC_LGUI, KC_LSFT, KC_W);
381 mt_shift(record, KC_LALT, 0, KC_5);
384 tap_layer(record, _MOUSE);
385 // LT (_MOUSE, KC_BSLS) left right combination layer, see #define LT_BSLS
386 thumb_layer(record, LEFT, 0, 0, _MOUSE, _SYMBOL);
389 tap_layer(record, _MOUSE);
390 // LT (_MOUSE, S(KC_LEFT)) left right combination layer
391 thumb_layer(record, RIGHT, SHIFT, KC_LEFT, _MOUSE, _LSHIFT);
394 tap_layer(record, _MOUSE);
395 // LT (_MOUSE, S(KC_LEFT)) left right combination layer
396 thumb_layer(record, RIGHT, NOSHIFT, KC_DEL, _MOUSE, _LSHIFT);
399 // LT (_FNCKEY, S(KC_TAB)) emulation
400 lt_shift(record, KC_TAB, _FNCKEY);
403 tap_layer(record, _RSHIFT);
404 // LT (_RSHIFT, KC_ENT) emulation, see tap dance enter
407 tap_layer(record, _LSHIFT);
408 // LT (_LSHIFT, KC_SPC) left right combination layer, see tap dance TD_SPC
409 thumb_layer(record, LEFT, 0, 0, _LSHIFT, _SYMBOL);
418 if (tt_keycode != keycode && tt_keycode != 0) {
419 clear_tt(); // return to base layer first if different TT layer selected
421 tt_keycode = keycode;
424 // #ifdef STENO_ENABLE
426 // stn_layer(record, STN_A, _NUMBER);
429 // stn_layer(record, STN_O, _FNCKEY);
432 // stn_layer(record, STN_E, _EDIT);
435 // stn_layer(record, STN_U, _SYMBOL);