1 #include "ergodox_ez.h"
4 #include "action_layer.h"
5 #include "action_util.h"
7 #define BASE 0 // default layer
8 #define SYMB 1 // symbols layer
9 #define MDIA 2 // media layer
10 #define SPEC 3 // special layer
12 #define LCaps 10 // left caps-shift key
13 #define LSymb 11 // left symbol-shift key
14 #define LMdia 12 // left media-shift key
15 #define LSpec 13 // left special-shift key
16 #define RCaps 14 // right caps-shift key
17 #define RSymb 15 // right symbol-shift key
18 #define RMdia 16 // right media-shift key
19 #define RSpec 17 // right special-shift key
21 #define MUL 20 // mouse up left
22 #define MUR 21 // mouse up right
23 #define MDL 22 // mouse down left
24 #define MDR 23 // mouse down right
27 * The Ordinary Layout for the Ergodox EZ keyboard, v4
29 * Modifications from default by Nicholas Keene ergodoxez@nicholaskeene.com
31 * No rights reserved. This software is in the public domain.
32 * Credit me if you are friendly but if you're a jerk don't bother.
35 * https://github.com/nrrkeene/qmk_firmware/tree/master/keyboard/ergodox_ez/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 ,M(LCaps) ,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 ,M(RCaps)
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 | |RGui/0|RAlt/.|Hypr/=|Meh/+ |RCtrl/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 ,GUI_T(KC_0),ALT_T(KC_DOT),ALL_T(KC_EQL),MEH_T(KC_PLUS),CTL_T(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 * | | | | | | | | | | | | | | | |
172 * |-----------+------+------+------+------+------| | | |------+------+------+------+------+-----------|
173 * | | | | | | |------| |------| | | | | | |
174 * |-----------+------+------+------+------+------| | | |------+------+------+------+------+-----------|
175 * | | | | | | | | | | | | | | | RShift |
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_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS
193 ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS
197 ,KC_TRNS,KC_TRNS ,KC_TRNS
199 ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_BSPC ,KC_TRNS
200 ,KC_TRNS ,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
202 ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_RSFT
203 ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS ,KC_TRNS
207 ,KC_TRNS ,KC_TRNS ,KC_TRNS
211 const uint16_t PROGMEM fn_actions[] = {
212 // the faux shift keys are implemented as macro taps
213 [LCaps] = ACTION_MACRO_TAP(LCaps)
214 ,[LSymb] = ACTION_MACRO_TAP(LSymb)
215 ,[LMdia] = ACTION_MACRO_TAP(LMdia)
216 ,[LSpec] = ACTION_MACRO_TAP(LSpec)
217 ,[RCaps] = ACTION_MACRO_TAP(RCaps)
218 ,[RSymb] = ACTION_MACRO_TAP(RSymb)
219 ,[RMdia] = ACTION_MACRO_TAP(RMdia)
220 ,[RSpec] = ACTION_MACRO_TAP(RSpec)
223 uint16_t caps_shift = 0;
224 uint16_t symb_shift = 0;
225 uint16_t mdia_shift = 0;
227 bool symb_lock = false;
228 bool mdia_lock = false;
230 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
233 // There are two shift keys for each layer so we increment a layer_shift var when one
234 // is pressed and decrement when one is released. If both are pressed at the same time
235 // then the layer is locked (or unlocked). The shift counts are bound between 0 and 2
236 // only because sometimes rapid pressing led to irregular events; this way the states
237 // are self healing during use.
239 case LCaps: // both caps-shift keys trigger Left Shift
240 case RCaps: // so they don't interfere with the magic combo
241 if (record->event.pressed && !record->tap.count) {
242 if(++caps_shift > 2) caps_shift = 2;
243 if(caps_shift == 2) {
244 register_code(KC_CAPS);
245 unregister_code(KC_CAPS);
246 } else if(caps_shift == 1) {
247 register_code(KC_LSFT);
250 if(--caps_shift < 0) caps_shift = 0;
251 if(caps_shift == 0) unregister_code(KC_LSFT);
256 if (record->event.pressed) {
257 if(++symb_shift > 2) symb_shift = 2;
258 if(symb_shift == 2) {
259 symb_lock = !symb_lock;
260 } else if(symb_shift == 1) {
264 if(--symb_shift < 0) symb_shift = 0;
265 if((symb_shift == 0) && (!symb_lock)) layer_off(SYMB);
270 if (record->event.pressed) {
271 if (record->tap.count && (!mdia_shift) && (!mdia_lock)) {
272 register_code(KC_TAB);
274 if(++mdia_shift > 2) mdia_shift = 2;
275 if(mdia_shift == 2) {
276 mdia_lock = !mdia_lock;
277 } else if(mdia_shift == 1) {
282 if(record->tap.count && (!mdia_shift) && (!mdia_lock)) {
283 unregister_code(KC_TAB);
285 if(--mdia_shift < 0) mdia_shift = 0;
286 if((!mdia_shift) && (!mdia_lock)) layer_off(MDIA);
292 if (record->event.pressed) {
293 if (record->tap.count && !record->tap.interrupted) {
294 register_code(KC_GRV);
299 if(record->tap.count && !record->tap.interrupted) {
300 unregister_code(KC_GRV);
308 if (record->event.pressed) {
309 if (record->tap.count && (!symb_shift) && (!symb_lock)) {
310 register_code(KC_QUOT);
312 if(++symb_shift > 2) symb_shift = 2;
313 if(symb_shift == 2) {
314 symb_lock = !symb_lock;
315 } else if(symb_shift == 1) {
320 if(record->tap.count && symb_shift == 0) {
321 unregister_code(KC_QUOT);
323 if(--symb_shift < 0) symb_shift = 0;
324 if((!symb_shift) && (!symb_lock)) layer_off(SYMB);
330 if (record->event.pressed) {
331 if (record->tap.count && (!mdia_shift) && (!mdia_lock)) {
332 register_code(KC_BSLS);
334 if(++mdia_shift > 2) mdia_shift = 2;
335 if(mdia_shift == 2) {
336 mdia_lock = !mdia_lock;
337 } else if(mdia_shift == 1) {
342 if(record->tap.count && (!mdia_shift) && (!mdia_lock)) {
343 unregister_code(KC_BSLS);
345 if(--mdia_shift < 0) mdia_shift = 0;
346 if((!mdia_shift) && (!mdia_lock)) layer_off(MDIA);
352 if (record->event.pressed) {
353 if (record->tap.count && !record->tap.interrupted) {
354 register_code(KC_EQL);
359 if(record->tap.count && !record->tap.interrupted) {
360 unregister_code(KC_EQL);
369 case MUL: // mouse up left
370 if (record->event.pressed) {
371 mousekey_on(KC_MS_UP);
372 mousekey_on(KC_MS_LEFT);
375 mousekey_off(KC_MS_UP);
376 mousekey_off(KC_MS_LEFT);
381 case MUR: // mouse up right
382 if (record->event.pressed) {
383 mousekey_on(KC_MS_UP);
384 mousekey_on(KC_MS_RIGHT);
387 mousekey_off(KC_MS_UP);
388 mousekey_off(KC_MS_RIGHT);
393 case MDL: // mouse down left
394 if (record->event.pressed) {
395 mousekey_on(KC_MS_DOWN);
396 mousekey_on(KC_MS_LEFT);
399 mousekey_off(KC_MS_DOWN);
400 mousekey_off(KC_MS_LEFT);
405 case MDR: // mouse down right
406 if (record->event.pressed) {
407 mousekey_on(KC_MS_DOWN);
408 mousekey_on(KC_MS_RIGHT);
411 mousekey_off(KC_MS_DOWN);
412 mousekey_off(KC_MS_RIGHT);
425 // Runs just one time when the keyboard initializes.
426 void matrix_init_user(void) {
430 // Runs constantly in the background, in a loop.
431 void matrix_scan_user(void) {
432 // shift or caps lock turns on red light
433 if(caps_shift || (keyboard_report->mods & MOD_BIT(KC_RSFT)) || (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK))) {
434 ergodox_right_led_1_on();
436 ergodox_right_led_1_off();
439 // Symbol layer turns on green light
440 if(layer_state & (1UL<<SYMB)) {
441 ergodox_right_led_2_on();
443 ergodox_right_led_2_off();
446 // Media layer turns on blue light
447 if(layer_state & (1UL<<MDIA)) {
448 ergodox_right_led_3_on();
450 ergodox_right_led_3_off();