]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboard/ergodox_ez/keymaps/erez_experimental/keymap.c
[Erez & Jack] Documents new Leader key functionality
[qmk_firmware.git] / keyboard / ergodox_ez / keymaps / erez_experimental / keymap.c
1 #include <keymap_extras/keymap_colemak.h>
2 #include "ergodox_ez.h"
3 #include "debug.h"
4 #include "action_layer.h"
5
6 #define BASE 0 // default layer
7 #define SYMB 1 // symbols
8 #define MDIA 2 // media keys
9
10 #define LSFTO M(0) // Left shift, open parens when tapped
11 #define RSFTC M(1) // Right shift, close parens when tapped
12 #define LEADER_TIMEOUT 300
13
14 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
15 /* Keymap 0: Basic layer
16  *
17  * ,--------------------------------------------------.           ,--------------------------------------------------.
18  * |   =    |   1  |   2  |   3  |   4  |   5  | LEFT |           | RIGHT|   6  |   7  |   8  |   9  |   0  |   -    |
19  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
20  * | Del    |   Q  |   W  |   E  |   R  |   T  |  L1  |           |  L1  |   Y  |   U  |   I  |   O  |   P  |   \    |
21  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
22  * | BkSp   |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  | Alt/J|   K  |   L  |; / L2| LGui/' |
23  * |--------+------+------+------+------+------| Hyper|           | Meh  |------+------+------+------+------+--------|
24  * |LShift/(|Z/Ctrl|   X  |   C  |   V  |   B  |   [  |           |  ]   |   N  |   M  |   ,  |   .  |//Ctrl|RShift/)|
25  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
26  *   |Grv/L1|  '"  |AltShf| Left | Right|                                       |  Up  | Down |   [  |   ]  | -/L1  |
27  *   `----------------------------------'                                       `----------------------------------'
28  *                                        ,-------------.       ,-------------.
29  *                                        | App  | LGui |       | Alt  |Ctrl/Esc|
30  *                                 ,------|------|------|       |------+--------+------.
31  *                                 |      |      | Home |       | PgUp |        |      |
32  *                                 | Space|Leader|------|       |------| Tab/L1 |Enter |
33  *                                 |      |      | End  |       | PgDn |        |      |
34  *                                 `--------------------'       `----------------------'
35  */
36 // If it accepts an argument (i.e, is a function), it doesn't need KC_.
37 // Otherwise, it needs KC_*
38 [BASE] = KEYMAP(  // layer 0 : default
39         // left hand
40         KC_EQL,         KC_1,         KC_2,   KC_3,   KC_4,     KC_5,   KC_LEFT,
41         KC_DELT,        KC_Q,         KC_W,   KC_E,   KC_R,     KC_T,   TG(SYMB),
42         KC_BSPC,        KC_A,         KC_S,   KC_D,   KC_F,     KC_G,
43         LSFTO,          CTL_T(KC_Z),  KC_X,   KC_C,   KC_V,     KC_B,   ALL_T(KC_LBRC),
44         LT(SYMB,KC_GRV),KC_QUOT,      LALT(KC_LSFT),  KC_LEFT,  KC_RGHT,
45                                               ALT_T(KC_APP),    KC_LGUI,
46                                                                 KC_HOME,
47                                                  KC_SPC,KC_LEAD,KC_END,
48         // right hand
49              KC_RGHT,       KC_6,KC_7,       KC_8,   KC_9,   KC_0,            KC_MINS,
50              TG(SYMB),      KC_Y,KC_U,       KC_I,   KC_O,   KC_P,            KC_BSLS,
51                             KC_H,ALT_T(KC_J),KC_K,   KC_L,   LT(MDIA,KC_SCLN),GUI_T(KC_QUOT),
52              MEH_T(KC_RBRC),KC_N,KC_M,       KC_COMM,KC_DOT, CTL_T(KC_SLSH),  RSFTC,
53                             KC_UP,           KC_DOWN,KC_LBRC,KC_RBRC,         LT(SYMB,KC_MINS),
54              KC_LALT,       CTL_T(KC_ESC),
55              KC_PGUP,
56              KC_PGDN,LT(SYMB, KC_TAB), KC_ENT
57     ),
58 /* Keymap 1: Symbol Layer
59  *
60  * ,--------------------------------------------------.           ,--------------------------------------------------.
61  * |        |  F1  |  F2  |  F3  |  F4  |  F5  |      |           |      |  F6  |  F7  |  F8  |  F9  |  F10 |   F11  |
62  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
63  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |   F12  |
64  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
65  * |        |   1  |   2  |   3  |   4  |   5  |------|           |------|   &  |   _  |   -  |   ;  |   +  |        |
66  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
67  * |        |   6  |   7  |   8  |   9  |   0  |      |           |      |   |  |   @  |   =  |   %  |      |        |
68  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
69  *   |      |      |      |NxtTab|PrvTab|                                       |      |      |      |      |      |
70  *   `----------------------------------'                                       `----------------------------------'
71  *                                        ,-------------.       ,-------------.
72  *                                        |      |      |       |      |      |
73  *                                 ,------|------|------|       |------+------+------.
74  *                                 |      |      |      |       |      |      |      |
75  *                                 |      |      |------|       |------|      |      |
76  *                                 |      |      |      |       |      |      |      |
77  *                                 `--------------------'       `--------------------'
78  */
79 // SYMBOLS
80 [SYMB] = KEYMAP(
81        // left hand
82        KC_TRNS, KC_F1,  KC_F2,  KC_F3,         KC_F4,        KC_F5,   KC_TRNS,
83        KC_TRNS, KC_TRNS,KC_TRNS,KC_TRNS,       KC_TRNS,      KC_TRNS, KC_TRNS,
84        KC_TRNS, KC_1,   KC_2,   KC_3,          KC_4,         KC_5,
85        KC_TRNS, KC_6,   KC_7,   KC_8,          KC_9,         KC_0,    KC_TRNS,
86        KC_TRNS, KC_TRNS,KC_TRNS,LCTL(KC_PGUP), LCTL(KC_PGDN),
87                                                                               KC_TRNS,KC_TRNS,
88                                                                                       KC_TRNS,
89                                                                       KC_TRNS,KC_TRNS,KC_TRNS,
90                // right hand
91        KC_TRNS, KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,
92        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_F12,
93                 KC_AMPR, KC_UNDS, KC_MINS, CM_SCLN, KC_PLUS, KC_TRNS,
94        KC_TRNS, KC_PIPE, KC_AT,   KC_EQL,  KC_PERC,   KC_TRNS, KC_TRNS,
95                          KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
96        KC_TRNS, KC_TRNS,
97        KC_TRNS,
98        KC_TRNS, KC_TRNS, KC_TRNS
99 ),
100 /* Keymap 2: Media and mouse keys
101  *
102  * ,--------------------------------------------------.           ,--------------------------------------------------.
103  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
104  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
105  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
106  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
107  * |        | PgUp | Home | End  | PgDn |      |------|           |------|      |      |      |      |      |  Play  |
108  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
109  * |        |      |      |      |      |      |      |           |      |      |      | Prev | Next |      |        |
110  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
111  *   |      |      |      |      |      |                                       |VolUp |VolDn | Mute |      |      |
112  *   `----------------------------------'                                       `----------------------------------'
113  *                                        ,-------------.       ,-------------.
114  *                                        |      |      |       |      |      |
115  *                                 ,------|------|------|       |------+------+------.
116  *                                 |      |      |      |       |      |      |Brwser|
117  *                                 |      |      |------|       |------|      |Back  |
118  *                                 |      |      |      |       |      |      |      |
119  *                                 `--------------------'       `--------------------'
120  */
121 // MEDIA AND MOUSE
122 [MDIA] = KEYMAP(
123        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
124        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
125        KC_TRNS, KC_PGUP, KC_HOME, KC_END,  KC_PGDN, KC_TRNS,
126        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
127        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
128                                            KC_TRNS, KC_TRNS,
129                                                     KC_TRNS,
130                                   KC_TRNS, KC_TRNS, KC_TRNS,
131     // right hand
132        KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
133        KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
134                  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MPLY,
135        KC_TRNS,  KC_TRNS, KC_TRNS, KC_MPRV, KC_MNXT, KC_TRNS, KC_TRNS,
136                           KC_VOLU, KC_VOLD, KC_MUTE, KC_TRNS, KC_TRNS,
137        KC_TRNS, KC_TRNS,
138        KC_TRNS,
139        KC_TRNS, KC_TRNS, KC_WBAK
140 ),
141 };
142
143 const uint16_t PROGMEM fn_actions[] = {
144     [1] = ACTION_LAYER_TAP_TOGGLE(SYMB),               // FN1 - Momentary Layer 1 (Symbols)
145     [2] = ACTION_MACRO_TAP(0),                         // Eric Tang's Famous Macro!
146     [3] = ACTION_MACRO_TAP(1)                          // Eric Tang's Famous Macro!
147 };
148
149 static uint16_t key_timer;
150
151 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
152 {
153       switch(id) {
154         case 0:
155           if (record->event.pressed) {
156               register_mods(MOD_BIT(KC_LSFT));
157               if (record->tap.count && !record->tap.interrupted) {
158                   register_code(KC_9);
159               }
160               else {
161                   record->tap.count = 0;
162               }
163           }
164           else {
165               if (record->tap.count) {
166                   unregister_code(KC_9);
167               }
168               else {
169               }
170               unregister_mods(MOD_BIT(KC_LSFT));
171           }
172           break;
173
174         case 1:
175           if (record->event.pressed) {
176               register_mods(MOD_BIT(KC_LSFT));
177               if (record->tap.count && !record->tap.interrupted) {
178                   register_code(KC_0);
179               }
180               else {
181                   record->tap.count = 0;
182               }
183           }
184           else {
185               if (record->tap.count) {
186                   unregister_code(KC_0);
187               }
188               else {
189               }
190               unregister_mods(MOD_BIT(KC_LSFT));
191           }
192           break;
193         }
194     return MACRO_NONE;
195 };
196
197 // Runs just one time when the keyboard initializes.
198 void matrix_init_user(void) {
199
200 };
201
202 LEADER_EXTERNS();
203
204 // Runs constantly in the background, in a loop.
205 void matrix_scan_user(void) {
206
207   uint8_t layer = biton32(layer_state);
208
209   ergodox_board_led_off();
210   ergodox_right_led_1_off();
211   ergodox_right_led_2_off();
212   ergodox_right_led_3_off();
213   switch (layer) {
214     // TODO: Make this relevant to the ErgoDox EZ.
215     case 1:
216       ergodox_right_led_1_on();
217       break;
218     case 2:
219       ergodox_right_led_2_on();
220       break;
221     default:
222       // none
223       break;
224   }
225
226   LEADER_DICTIONARY() {
227     leading = false;
228     leader_end();
229
230     SEQ_ONE_KEY(KC_W) {
231       register_code(KC_LALT);
232       register_code(KC_F4);
233       unregister_code(KC_F4);
234       unregister_code(KC_LALT);
235     }
236     SEQ_ONE_KEY(KC_O) {
237       register_code(KC_LCTL);
238       register_code(KC_LSFT);
239       register_code(KC_O);
240       unregister_code(KC_O);
241       unregister_code(KC_LSFT);
242       unregister_code(KC_LCTL);
243     }
244   }
245 };
246
247
248