5 #include "action_layer.h"
6 #include "action_util.h"
8 #define BASE 0 // default layer
9 #define SYMB 1 // symbols layer
10 #define MDIA 2 // media layer
11 #define SPEC 3 // special layer
13 #define LSymb 10 // left symbol-shift key
14 #define LMdia 11 // left media-shift key
15 #define LSpec 12 // left special-shift key
16 #define RSymb 13 // right symbol-shift key
17 #define RMdia 14 // right media-shift key
18 #define RSpec 15 // right special-shift key
20 #define MUL 20 // mouse up left
21 #define MUR 21 // mouse up right
22 #define MDL 22 // mouse down left
23 #define MDR 23 // mouse down right
26 * The Ordinary Layout for the Ergodox EZ keyboard, v4.20
28 * Modifications from default by Nicholas Keene ergodoxez@nicholaskeene.com
30 * No rights reserved. This software is in the public domain.
31 * Credit me if you are friendly but if you're a jerk don't bother.
32 * If you use or modify this layout I would love to hear from you.
35 * https://github.com/nrrkeene/qmk_firmware/tree/master/keyboards/ergodox/keymaps/ordinary
38 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
40 /******* Base Layer ****************************************************************************************************
42 * ,------------------------------------------------------. ,------------------------------------------------------.
43 * | Special `~ | 1 | 2 | 3 | 4 | 5 | ESC | | - | 6 | 7 | 8 | 9 | 0 | =+ Special |
44 * |------------+------+------+------+------+-------------| |------+------+------+------+------+------+------------|
45 * | Media Tab | Q | W | E | R | T | [ | | ] | Y | U | I | O | P | \| Media |
46 * |------------+------+------+------+------+------| | | |------+------+------+------+------+------------|
47 * | Symbol | A | S | D | F | G |------| |------| H | J | K | L | ; | '" Symbol |
48 * |------------+------+------+------+------+------|Shift | | Tab |------+------+------+------+------+------------|
49 * | Capitals | Z | X | C | V | B | -Tab | | | N | M | , | . | / | Capitals |
50 * `------------+------+------+------+------+-------------' `-------------+------+------+------+------+------------'
51 * | LCtrl | Meh |Hyper | LAlt | LGui | | RGui | RAlt | Hyper| Meh | RCtrl |
52 * `-----------------------------------' `-----------------------------------'
53 * ,-------------. ,-------------.
54 * | Home | End | | Left | Right|
55 * ,------|------|------| |------+------+------.
56 * | | | PgUp | | Up | | |
57 * |Backsp| Del |------| |------| Enter| Space|
58 * | | | PgDn | | Down | | |
59 * `--------------------' `--------------------'
63 F(LSpec) ,KC_1 ,KC_2 ,KC_3 ,KC_4 ,KC_5 ,KC_ESC
64 ,F(LMdia) ,KC_Q ,KC_W ,KC_E ,KC_R ,KC_T ,KC_LBRC
65 ,M(LSymb) ,KC_A ,KC_S ,KC_D ,KC_F ,KC_G
66 ,KC_LSFT ,KC_Z ,KC_X ,KC_C ,KC_V ,KC_B ,LSFT(KC_TAB)
67 ,KC_LCTL ,KC_MEH ,KC_HYPR,KC_LALT,KC_LGUI
70 ,KC_BSPC,KC_DEL ,KC_PGDN
72 ,KC_MINS ,KC_6 ,KC_7 ,KC_8 ,KC_9 ,KC_0 ,F(RSpec)
73 ,KC_RBRC ,KC_Y ,KC_U ,KC_I ,KC_O ,KC_P ,F(RMdia)
74 ,KC_H ,KC_J ,KC_K ,KC_L ,KC_SCLN ,F(RSymb)
75 ,KC_TAB ,KC_N ,KC_M ,KC_COMM,KC_DOT ,KC_SLSH ,KC_RSFT
76 ,KC_RGUI,KC_RALT,KC_HYPR ,KC_MEH ,KC_RCTL
79 ,KC_DOWN ,KC_ENT ,KC_SPC
82 /******* Symbols Layer *************************************************************************************************
84 * ,-----------------------------------------------------. ,-----------------------------------------------------.
85 * | | F1 | F2 | F3 | F4 | F5 | Esc | | - | F6 | F7 | F8 | F9 | F10 | |
86 * |-----------+------+------+------+------+-------------| |------+------+------+------+------+------+-----------|
87 * | | ! | @ | { | } | & | < | | > | | | 7 | 8 | 9 | / | |
88 * |-----------+------+------+------+------+------| | | |------+------+------+------+------+-----------|
89 * | | # | $ | ( | ) | ` |------| |------| / | 4 | 5 | 6 | * | |
90 * |-----------+------+------+------+------+------| Tab | | Shift|------+------+------+------+------+-----------|
91 * | | % | ^ | [ | ] | ~ | | | -Tab| \ | 1 | 2 | 3 | - | |
92 * `-----------+------+------+------+------+-------------' `-------------+------+------+------+------+-----------'
93 * | LCtrl | Meh |Hyper | LAlt | LGui | | 0 | . | = | + | Ent |
94 * `-----------------------------------' `-----------------------------------'
95 * ,-------------. ,-------------.
96 * | Left | Right| | Home | End |
97 * ,------|------|------| |------+------+------.
98 * | | | Up | | PgUp | | |
99 * |Space |Enter |------| |------|BackSp| Del |
100 * | | | Down | | PgDn | | |
101 * `--------------------' `--------------------'
105 KC_TRNS ,KC_F1 ,KC_F2 ,KC_F3 ,KC_F4 ,KC_F5 ,KC_ESC
106 ,KC_TRNS ,KC_EXLM ,KC_AT ,KC_LCBR ,KC_RCBR ,KC_AMPR ,LSFT(KC_COMM)
107 ,KC_TRNS ,KC_HASH ,KC_DLR ,KC_LPRN ,KC_RPRN ,KC_GRV
108 ,KC_TRNS ,KC_PERC ,KC_CIRC ,KC_LBRC ,KC_RBRC ,KC_TILD ,KC_TAB
109 ,KC_LCTL ,KC_MEH ,KC_HYPR ,KC_LALT ,KC_LGUI
112 ,KC_SPC ,KC_ENT ,KC_DOWN
114 ,KC_MINS ,KC_F6 ,KC_F7 ,KC_F8 ,KC_F9 ,KC_F10 ,KC_TRNS
115 ,LSFT(KC_DOT),KC_PIPE ,KC_7 ,KC_8 ,KC_9 ,KC_SLSH ,KC_TRNS
116 ,KC_SLSH ,KC_4 ,KC_5 ,KC_6 ,KC_ASTR ,KC_TRNS
117 ,LSFT(KC_TAB),KC_BSLS ,KC_1 ,KC_2 ,KC_3 ,KC_MINS ,KC_TRNS
118 ,KC_0 ,KC_DOT ,KC_EQL,KC_PLUS ,KC_ENT
121 ,KC_PGDN ,KC_BSPC ,KC_DEL
124 /******* Media Layer *******************************************************************************************************
126 * ,---------------------------------------------------------------. ,---------------------------------------------------------------.
127 * | | F11 | F12 | F13 | F14 | F15 | Esc | | | F16 | F17 | F18 | F19 | F20 | |
128 * |------+---------+---------+---------+---------+----------------| |------+---------+---------+---------+---------+---------+------|
129 * | |Shut Down|MouseUpLf|Mouse Up |MouseUpRg|Volume Up|Scroll| |Scroll|PrintScrn| Home | Up | PgUp | Mail | |
130 * |------+---------+---------+---------+---------+---------| Up | | Up |---------+---------+---------+---------+---------+------|
131 * | | Sleep |MouseLeft|MouseDown|MouseRght|Volume Dn|------| |------| Num Lock| Left | Down | Right | MyComp | |
132 * |------+---------+---------+---------+---------+---------|Scroll| |Scroll|---------+---------+---------+---------+---------+------|
133 * | | |MouseDnLf|MouseDown|MouseDnRg| Mute | Down | | Down | | End | Down | PgDn | | |
134 * `------+---------+---------+---------+---------+----------------' `----------------+---------+---------+---------+---------+------'
135 * |LCtrl| Meh | MClick | LClick | R Click| |Cmd/Insrt|Optn/Del | Hyper | Meh |RCtrl|
136 * `---------------------------------------------' `---------------------------------------------'
137 * ,-------------. ,-------------.
138 * | Stop |Refrsh| | Prev | Next |
139 * ,------|------|------| |------+------+------.
140 * |Brwser|Brwser|Search| |VolUp | | |
141 * |Back | Fwd |------| |------| Stop | Play-|
142 * | | | Home | |VolDn | | Pause|
143 * `--------------------' `--------------------'
147 KC_TRNS ,KC_F11 ,KC_F12 ,KC_F13 ,KC_F14 ,KC_F15 ,KC_ESC
148 ,KC_TRNS ,KC_POWER ,M(MUL) ,KC_MS_U ,M(MUR) ,KC_VOLU ,KC_WH_U
149 ,KC_TRNS ,KC_SLEP ,KC_MS_L ,KC_MS_D ,KC_MS_R ,KC_VOLD
150 ,KC_TRNS ,KC_NO ,M(MDL) ,KC_MS_D ,M(MDR) ,KC_MUTE ,KC_WH_D
151 ,KC_LCTL ,KC_MEH ,KC_BTN3 ,KC_BTN1 ,KC_BTN2
154 ,KC_WBAK ,KC_NO ,KC_WHOM
156 ,KC_NO ,KC_F16 ,KC_F17 ,KC_F18 ,KC_F19 ,KC_F20 ,KC_TRNS
157 ,KC_WH_U ,KC_PSCR ,KC_HOME ,KC_UP ,KC_PGUP ,KC_MAIL ,KC_TRNS
158 ,KC_NLCK ,KC_LEFT ,KC_DOWN ,KC_RIGHT,KC_MYCM ,KC_TRNS
159 ,KC_WH_D ,KC_NO ,KC_END ,KC_DOWN ,KC_PGDN ,KC_NO ,KC_TRNS
160 ,GUI_T(KC_INS),ALT_T(KC_DEL),KC_HYPR ,KC_MEH ,KC_RCTL
163 ,KC_VOLD ,KC_MSTP ,KC_MPLY
166 /******* Special Layer *****************************************************************************************************
168 * ,-------------------------------------------------------. ,-------------------------------------------------------.
169 * | | Esc | | | | | | | | | | | - | Bspc | |
170 * |-------------+------+------+------+------+-------------| |------+------+------+------+------+------+-------------|
171 * | Media Lock | | | | | | | | | | | | [ | ] | Media Lock |
172 * |-------------+------+------+------+------+------| | | |------+------+------+------+------+-------------|
173 * | Symbol Lock | | | | | |------| |------| | | | | | Symbol Lock |
174 * |-------------+------+------+------+------+------| | | |------+------+------+------+------+-------------|
175 * | Caps Lock | | | | | | | | | | | | | | Caps Lock |
176 * `-------------+------+------+------+------+-------------' `-------------+------+------+------+------+-------------'
177 * | | | | | | | | | | | |
178 * `------------------------------------' `------------------------------------'
179 * ,-------------. ,-------------.
181 * ,------|------|------| |------+------+------.
183 * | | |------| |------| | |
185 * `--------------------' `--------------------'
189 KC_TRNS ,KC_ESC ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS
190 ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS
191 ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS
192 ,KC_CAPS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS
193 ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS
196 ,KC_TRNS,KC_TRNS ,KC_TRNS
198 ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_MINS ,KC_BSPC ,KC_TRNS
199 ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_LBRC ,KC_RBRC ,KC_TRNS
200 ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS
201 ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_CAPS
202 ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS
205 ,KC_TRNS ,KC_TRNS ,KC_TRNS
209 const uint16_t PROGMEM fn_actions[] = {
210 // the faux shift keys are implemented as macro taps
211 [LSymb] = ACTION_MACRO_TAP(LSymb)
212 ,[LMdia] = ACTION_MACRO_TAP(LMdia)
213 ,[LSpec] = ACTION_MACRO_TAP(LSpec)
214 ,[RSymb] = ACTION_MACRO_TAP(RSymb)
215 ,[RMdia] = ACTION_MACRO_TAP(RMdia)
216 ,[RSpec] = ACTION_MACRO_TAP(RSpec)
219 uint16_t symb_shift = 0;
220 uint16_t mdia_shift = 0;
221 uint16_t spec_shift = 0;
223 bool mdia_lock = false;
224 bool symb_lock = false;
226 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
229 // There are two shift keys for each layer so we increment a layer_shift var when one
230 // is pressed and decrement when one is released. If both are pressed at the same time
231 // then the layer is locked (or unlocked). The shift counts are bound between 0 and 2
232 // only because sometimes rapid pressing led to irregular events; this way the states
233 // are self healing during use.
236 if (record->event.pressed) { // when the LSymb button is pressed
237 if(++symb_shift > 2) mdia_shift = 2; // increment the symb shift count, max two
238 if(spec_shift) symb_lock = !symb_lock; // if the Special layer is on, toggle the shift lock
239 layer_on(SYMB); // in any case, turn on the Symbols layer
240 } else { // when the LSymb button is released
241 if(--symb_shift < 0) symb_shift = 0; // decrement the shift count, minimum zero
242 if((!symb_shift) && (!symb_lock)) layer_off(SYMB); // if both shifts are released and the lock is off, turn off the Symbols layer
247 if (record->event.pressed) {
248 if (record->tap.count && (!mdia_shift) && (!mdia_lock) && (!spec_shift)) {
249 register_code(KC_TAB);
251 if(spec_shift) mdia_lock = !mdia_lock;
252 if(++mdia_shift > 2) mdia_shift = 2;
256 if(record->tap.count && (!mdia_shift) && (!mdia_lock) && (!spec_shift)) {
257 unregister_code(KC_TAB);
259 if(--mdia_shift < 0) mdia_shift = 0;
260 if((!mdia_shift) && (!mdia_lock)) layer_off(MDIA);
266 if (record->event.pressed) { // when the LSpec button is pressed
267 if(symb_shift) symb_lock == !symb_lock; // if another layer button is engaged, then
268 else if(mdia_shift) mdia_lock = !mdia_lock; // lock that layer, be it caps or symb or mdia
269 else if (record->tap.count && !record->tap.interrupted && (!spec_shift)) {
270 register_code(KC_GRV); // otherwise, if it's an uninterrupted tap, emit a char
272 if(++spec_shift > 2) spec_shift = 2;
273 layer_on(SPEC); // otherwise, turn on the Special layer
276 if(record->tap.count && !record->tap.interrupted && (!spec_shift)) {
277 unregister_code(KC_GRV);
279 if(--spec_shift < 0) spec_shift = 0;
280 if(!spec_shift) layer_off(SPEC);
286 if (record->event.pressed) {
287 if (record->tap.count && (!symb_shift) && (!symb_lock) && (!spec_shift)) {
288 register_code(KC_QUOT);
290 if(++symb_shift > 2) symb_shift = 2;
291 if(spec_shift) symb_lock = !symb_lock;
295 if(record->tap.count && (!symb_shift) && (!symb_lock) && (!spec_shift)) {
296 unregister_code(KC_QUOT);
298 if(--symb_shift < 0) symb_shift = 0;
299 if((!symb_shift) && (!symb_lock)) layer_off(SYMB);
305 if (record->event.pressed) {
306 if (record->tap.count && (!mdia_shift) && (!mdia_lock) && (!spec_shift)) {
307 register_code(KC_BSLS);
309 if(++mdia_shift > 2) mdia_shift = 2;
310 if(spec_shift) mdia_lock = !mdia_lock;
314 if(record->tap.count && (!mdia_shift) && (!mdia_lock) && (!spec_shift)) {
315 unregister_code(KC_BSLS);
317 if(--mdia_shift < 0) mdia_shift = 0;
318 if((!mdia_shift) && (!mdia_lock)) layer_off(MDIA);
324 if (record->event.pressed) {
325 if(symb_shift) symb_lock = !symb_lock;
326 else if(mdia_shift) mdia_lock = !mdia_lock;
327 else if (record->tap.count && !record->tap.interrupted && (!spec_shift)) {
328 register_code(KC_EQL);
330 if(++spec_shift > 2) spec_shift = 2;
334 if(record->tap.count && !record->tap.interrupted && (!spec_shift)) {
335 unregister_code(KC_EQL);
337 if(--spec_shift < 0) spec_shift = 0;
338 if(!spec_shift) layer_off(SPEC);
345 case MUL: // mouse up left
346 if (record->event.pressed) {
347 mousekey_on(KC_MS_UP);
348 mousekey_on(KC_MS_LEFT);
351 mousekey_off(KC_MS_UP);
352 mousekey_off(KC_MS_LEFT);
357 case MUR: // mouse up right
358 if (record->event.pressed) {
359 mousekey_on(KC_MS_UP);
360 mousekey_on(KC_MS_RIGHT);
363 mousekey_off(KC_MS_UP);
364 mousekey_off(KC_MS_RIGHT);
369 case MDL: // mouse down left
370 if (record->event.pressed) {
371 mousekey_on(KC_MS_DOWN);
372 mousekey_on(KC_MS_LEFT);
375 mousekey_off(KC_MS_DOWN);
376 mousekey_off(KC_MS_LEFT);
381 case MDR: // mouse down right
382 if (record->event.pressed) {
383 mousekey_on(KC_MS_DOWN);
384 mousekey_on(KC_MS_RIGHT);
387 mousekey_off(KC_MS_DOWN);
388 mousekey_off(KC_MS_RIGHT);
401 // Runs just one time when the keyboard initializes.
402 void matrix_init_user(void) {
406 // Runs constantly in the background, in a loop.
407 void matrix_scan_user(void) {
408 // shift or caps lock turns on red light
409 if((keyboard_report->mods & MOD_BIT(KC_LSFT))
410 || (keyboard_report->mods & MOD_BIT(KC_RSFT))
411 || (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK))) {
412 ergodox_right_led_1_on();
414 ergodox_right_led_1_off();
417 // Symbol layer turns on green light
418 if(layer_state & (1UL<<SYMB)) {
419 ergodox_right_led_2_on();
421 ergodox_right_led_2_off();
424 // Media layer turns on blue light
425 if(layer_state & (1UL<<MDIA)) {
426 ergodox_right_led_3_on();
428 ergodox_right_led_3_off();