]> git.donarmstrong.com Git - tmk_firmware.git/blob - keyboard/ergodox/keymap_cub.h
961cdffe276ae08f87b5c64d5cf1a807430821ce
[tmk_firmware.git] / keyboard / ergodox / keymap_cub.h
1 static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
2     /*
3      * Keymap: Default Layer in QWERTY
4      *
5      * ,--------------------------------------------------.           ,--------------------------------------------------.
6      * |   ~    |   1  |   2  |   3  |   4  |   5  |   \  |           |   -  |   6  |   7  |   8  |   9  |   0  |   =    |
7      * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
8      * | Tab    |   Q  |   W  |   E  |   R  |   T  | ~L5  |           | ~L6  |   Y  |   U  |   I  |   O  |   P  |   [    |
9      * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
10      * | Tab/Shf|   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |   ;  |   '    |
11      * |--------+------+------+------+------+------|  L0  |           | ~L7  |------+------+------+------+------+--------|
12      * | LCtrl  |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |   /  |   ]    |
13      * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
14      *   | ~L5  | ~L2  | Caps | LAlt | LGui |                                       |  Lft |  Up  |  Dn  | Rght | ~L6  |
15      *   `----------------------------------'                                       `----------------------------------'
16      *                                        ,-------------.       ,-------------.
17      *                                        | +L2  | Home |       | PgUp | Del  |
18      *                                 ,------|------|------|       |------+------+------.
19      *                                 |      |      |  End |       | PgDn |      |      |
20      *                                 | BkSp |  ESC |------|       |------| Enter| Space|
21      *                                 |      |      |  Spc |       | Ins  |      |      |
22      *                                 `--------------------'       `--------------------'
23      *
24      *
25      *
26      ****************************************************************************************************
27      *
28      * Under XOrg, I use my own mapping from QWERTY to "Workman for Programmers"
29      * See XOrg files in ./addons/ subdirectory.
30      *
31      * I have to do so, because of two things:
32      * 1) my native language is Russian, and XOrg keymap for it is based on QWERTY layout
33      * 2) I want to have non-standart shifted keys, like $ (as normal) and @ (as shifted), or _ and -
34      *
35      * And even if (2) could be solved using FN* keys (but there is limit in firmware for only 32 such
36      * keys), then (1) can't be solved at firmware level at all.
37      *
38      * So, I have to stick with QWERTY as my main layout + my own XOrg keyboard layout for English.
39      * But sometimes I have to input something when XOrg is not active - for example, in Linux console,
40      * or in firmware console (while debugging firmware), or when keyboard is connected to not my computer.
41      *
42      * For such cases I have Layer1 :)
43      * // hint: switch to Layer1 is only at Layer6
44      *
45      ****************************************************************************************************
46      *
47      *
48      *
49      * Keymap: Default Layer in Workman
50      *
51      * ,--------------------------------------------------.           ,--------------------------------------------------.
52      * |  ~     |   ;  |   !  |   #  |   {  |   }  |   '  |           |   ^  |   [  |   ]  |   *  |   (  |   )  |   =    |
53      * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
54      * | Tab    |   Q  |   D  |   R  |   W  |   B  |  NO  |           | ~L7  |   J  |   F  |   U  |   P  |   $  |   :    |
55      * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
56      * | Tab/Shf|   A  |   S  |   H  |   T  |   G  |------|           |------|   Y  |   N  |   E  |   O  |   I  |   -    |
57      * |--------+------+------+------+------+------| Home |           | End  |------+------+------+------+------+--------|
58      * | LCtrl  |   Z  |   X  |   M  |   C  |   V  |      |           |      |   K  |   L  |   ,  |   .  |   /  |   |    |
59      * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
60      *   | ~L5  | ~L2  | Caps | LAlt | LGui |                                       |  Lft |  Up  |  Dn  | Rght | ~L6  |
61      *   `----------------------------------'                                       `----------------------------------'
62      *                                        ,-------------.       ,-------------.
63      *                                        |  L0  |  +L2 |       | PgUp | Del  |
64      *                                 ,------|------|------|       |------+------+------.
65      *                                 |      |      |  NO  |       | PgDn |      |      |
66      *                                 | BkSp |  ESC |------|       |------| Enter| Space|
67      *                                 |      |      |  Spc |       | Ins  |      |      |
68      *                                 `--------------------'       `--------------------'
69      *
70      * Keymap: Default Layer in Workman / with Shift
71      *
72      * ,--------------------------------------------------.           ,--------------------------------------------------.
73      * |  `     |   1  |   2  |   3  |   4  |   5  |   "  |           |   \  |   6  |   7  |   8  |   9  |   0  |   +    |
74      * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
75      * | Tab    |   Q  |   D  |   R  |   W  |   B  |  NO  |           | ~L7  |   J  |   F  |   U  |   P  |   @  |   %    |
76      * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
77      * | Tab/Shf|   A  |   S  |   H  |   T  |   G  |------|           |------|   Y  |   N  |   E  |   O  |   I  |   _    |
78      * |--------+------+------+------+------+------| Home |           | End  |------+------+------+------+------+--------|
79      * | LCtrl  |   Z  |   X  |   M  |   C  |   V  |      |           |      |   K  |   L  |   ,  |   .  |   /  |   &    |
80      * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
81      *   | ~L5  | ~L2  | Caps | LAlt | LGui |                                       |  Lft |  Up  |  Dn  | Rght | ~L6  |
82      *   `----------------------------------'                                       `----------------------------------'
83      *                                        ,-------------.       ,-------------.
84      *                                        |  L0  |  +L2 |       | PgUp | Del  |
85      *                                 ,------|------|------|       |------+------+------.
86      *                                 |      |      |  NO  |       | PgDn |      |      |
87      *                                 | BkSp |  ESC |------|       |------| Enter| Space|
88      *                                 |      |      |  Spc |       | Ins  |      |      |
89      *                                 `--------------------'       `--------------------'
90      *
91      */
92
93     KEYMAP(  // Layer0: default, leftled:none
94         // left hand
95         GRV, 1,   2,   3,   4,   5,   BSLS,
96         TAB, Q,   W,   E,   R,   T,   FN23,
97         FN11,FN28,FN29,FN30,FN31,G,
98         FN12,FN24,FN25,FN26,FN27,B,   HOME,
99         FN21,FN20,CAPS,FN13,FN14,
100                                       FN17,FN19,
101                                            NO,
102                                  FN5, FN6, FN7,
103         // right hand
104              MINS,6,   7,   8,   9,   0,   EQL,
105              FN23,Y,   U,   I,   O,   P,   LBRC,
106                   H,   J,   K,   L,   SCLN,FN15,
107              END, N,   M,   COMM,DOT, SLSH,FN16,
108                        LEFT,UP,  DOWN,RGHT,FN22,
109         PGUP,DEL,
110         PGDN,
111         FN8, FN9, FN10
112     ),
113
114     KEYMAP(  // Layer1: Workman layout, leftled:all
115         // left hand
116         TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
117         TRNS,Q,   D,   R,   W,   B,   TRNS,
118         TRNS,A,   S,   H,   T,   G,
119         TRNS,Z,   X,   M,   C,   V,   TRNS,
120         TRNS,TRNS,TRNS,TRNS,TRNS,
121                                       TRNS,TRNS,
122                                            TRNS,
123                                  TRNS,TRNS,TRNS,
124         // right hand
125              TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
126              TRNS,J,   F,   U,   P,   4,   TRNS,
127                   Y,   N,   E,   O,   I,   TRNS,
128              TRNS,K,   L,   TRNS,TRNS,TRNS,TRNS,
129                        TRNS,TRNS,TRNS,TRNS,TRNS,
130         TRNS,TRNS,
131         TRNS,
132         TRNS,TRNS,TRNS
133     ),
134
135     KEYMAP(  // Layer2: numpad, leftled:mid/blue
136         // left hand
137         TRNS,NO,  NO,  NO,  NO,  PAUS,PSCR,
138         TRNS,NO,  NO,  NO,  NO,  NO,  TRNS,
139         TRNS,NO,  NO,  NO,  TRNS,NO,
140         TRNS,NO,  NO,  NO,  TRNS,NO,  TRNS,
141         TRNS,TRNS,TRNS,TRNS,TRNS,
142                                       TRNS,TRNS,
143                                            TRNS,
144                                  TRNS,TRNS,TRNS,
145         // right hand
146              SLCK,NLCK,PSLS,PAST,PAST,PMNS,BSPC,
147              TRNS,NO,  P7,  P8,  P9,  PMNS,PGUP,
148                   TRNS,P4,  P5,  P6,  PPLS,PGDN,
149              TRNS,NO,  P1,  P2,  P3,  PPLS,PENT,
150                        P0,  PDOT,SLSH,PENT,PENT,
151         TRNS,TRNS,
152         TRNS,
153         TRNS,TRNS,TRNS
154     ),
155
156     KEYMAP(  // Layer3: F-keys + PgUp/PgDn on right hand, leftled:bot/green
157         // left hand
158         TRNS,NO,  NO,  NO,  NO,  NO,  NO,
159         TRNS,NO,  NO,  NO,  NO,  NO,  TRNS,
160         TRNS,NO,  TRNS,NO,  NO,  NO,
161         TRNS,NO,  TRNS,NO,  NO,  NO,  TRNS,
162         TRNS,TRNS,TRNS,LALT,LGUI,
163                                       TRNS,TRNS,
164                                            TRNS,
165                                  LCTL,LSFT,TRNS,
166         // right hand
167              NO,  NO,  NO,  NO,  NO,  NO,  TRNS,
168              TRNS,NO,  F1,  F2,  F3,  F4,  PGUP,
169                   NO,  F5,  F6,  F7,  F8,  PGDN,
170              TRNS,NO,  F9,  F10, F11, F12, APP,
171                        RGUI,RALT,TRNS,TRNS,TRNS,
172         TRNS,TRNS,
173         TRNS,
174         TRNS,RSFT,RCTL
175     ),
176
177     KEYMAP(  // Layer4: unconvenient keys on right hand, leftled:top/white
178         // left hand
179         TRNS,NO,  NO,  NO,  NO,  NO,  NO,
180         TRNS,NO,  NO,  NO,  NO,  NO,  TRNS,
181         TRNS,TRNS,NO,  NO,  NO,  NO,
182         TRNS,TRNS,NO,  NO,  NO,  NO,  TRNS,
183         TRNS,TRNS,TRNS,LALT,LGUI,
184                                       TRNS,TRNS,
185                                            TRNS,
186                                  TRNS,TRNS,TRNS,
187
188         /* in Workman right hand will be:
189                         +
190               ^ { } ( ) =
191               ' ! $ " ; \
192               # [ < > ] \
193         */
194
195         // right hand
196              NO,  NO,  NO,  NO,  NO,  NO,  PPLS,
197              TRNS,MINS,4,   5,   9,   0,   EQL,
198                   BSLS,2,   P,   FN1, 1,   FN2,
199              TRNS,3,   6,   FN3, FN4, 7,   FN2,
200                        TRNS,TRNS,TRNS,TRNS,TRNS,
201         TRNS,TRNS,
202         TRNS,
203         TRNS,TRNS,TRNS
204     ),
205
206     KEYMAP(  // Layer5: F-keys instead of numbers, leftled:top/white
207         // left hand
208         TRNS,F1,  F2,  F3,  F4,  F5,  F6,
209         TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
210         TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
211         TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
212         TRNS,TRNS,TRNS,TRNS,TRNS,
213                                       TRNS,TRNS,
214                                            TRNS,
215                                  TRNS,TRNS,TRNS,
216         // right hand
217              F7,  F8,  F9,  F10, F11, F12, TRNS,
218              TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
219                   TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
220              TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
221                        TRNS,TRNS,TRNS,TRNS,TRNS,
222         TRNS,TRNS,
223         TRNS,
224         TRNS,TRNS,TRNS
225     ),
226
227     KEYMAP(  // Layer6: F-keys, cursor, Workman-layer switch, Teensy, leftled:top/white+onboard
228         // left hand
229         TRNS,F1,  F2,  F3,  F4,  F5,  F6,
230         FN0, NO,  PGUP,UP,  PGDN,PGUP,TRNS,
231         TRNS,NO,  LEFT,DOWN,RGHT,PGDN,
232         TRNS,INS, DEL, END, HOME,NO,  TRNS,
233         FN18,TRNS,TRNS,TRNS,TRNS,
234                                       TRNS,TRNS,
235                                            TRNS,
236                                  TRNS,TRNS,TRNS,
237         // right hand
238              F7,  F8,  F9,  F10, F11, F12, MINS,
239              TRNS,PGUP,PGUP,UP,  PGDN,NO,  FN0,
240                   PGDN,LEFT,DOWN,RGHT,NO,  TRNS,
241              TRNS,NO,  HOME,END, DEL, INS, TRNS,
242                        TRNS,TRNS,TRNS,TRNS,TRNS,
243         TRNS,TRNS,
244         TRNS,
245         TRNS,TRNS,TRNS
246     ),
247
248     //
249     // rarely used
250     //
251
252     KEYMAP(  // Layer7: F-keys only, leftled:top/white
253         // left hand
254         TRNS,NO,  NO,  NO,  NO,  NO,  NO,
255         TRNS,F13, F14, F15, F16, NO,  TRNS,
256         TRNS,F17, F18, F19, F20, NO,
257         TRNS,F21, F22, F23, F24, NO,  TRNS,
258         TRNS,TRNS,TRNS,TRNS,TRNS,
259                                       TRNS,TRNS,
260                                            TRNS,
261                                  TRNS,TRNS,TRNS,
262         // right hand
263              NO,  NO,  NO,  NO,  NO,  NO,  TRNS,
264              TRNS,NO,  F1,  F2,  F3,  F4,  TRNS,
265                   NO,  F5,  F6,  F7,  F8,  TRNS,
266              TRNS,NO,  F9,  F10, F11, F12, TRNS,
267                        TRNS,TRNS,TRNS,TRNS,TRNS,
268         TRNS,TRNS,
269         TRNS,
270         TRNS,TRNS,TRNS
271     ),
272
273     KEYMAP(  // Layer8: mouse and navigation, leftled:mid/blue+bot/green
274         // left hand
275         TRNS,NO,  NO,  NO,  NO,  NO,  NO,
276         TRNS,NO,  NO,  NO,  NO,  NO,  TRNS,
277         TRNS,NO,  NO,  TRNS,NO,  NO,
278         TRNS,NO,  NO,  TRNS,NO,  NO,  TRNS,
279         TRNS,TRNS,TRNS,TRNS,TRNS,
280                                       TRNS,TRNS,
281                                            TRNS,
282                                  TRNS,TRNS,TRNS,
283
284         // right hand
285              TRNS,NO,  NO,  NO,  NO,  NO,  NO,
286              TRNS,BTN2,WH_L,WH_U,WH_D,WH_R,PGUP,
287                   BTN1,MS_L,MS_U,MS_D,MS_R,PGDN,
288              TRNS,BTN3,HOME,END, DEL, INS, NO,
289                        TRNS,TRNS,TRNS,TRNS,TRNS,
290         TRNS,TRNS,
291         TRNS,
292         TRNS,TRNS,TRNS
293     ),
294
295 /*
296     // templates to copy from
297
298     KEYMAP(  // LayerN: transparent on edges + hard-defined thumb keys, all others are empty
299         // left hand
300         TRNS,NO,  NO,  NO,  NO,  NO,  NO,
301         TRNS,NO,  NO,  NO,  NO,  NO,  TRNS,
302         TRNS,NO,  NO,  NO,  NO,  NO,
303         TRNS,NO,  NO,  NO,  NO,  NO,  TRNS,
304         TRNS,TRNS,TRNS,LALT,LGUI,
305                                       TRNS,TRNS,
306                                            TRNS,
307                                  LCTL,LSFT,TRNS,
308         // right hand
309              NO,  NO,  NO,  NO,  NO,  NO,  TRNS,
310              TRNS,NO,  NO,  NO,  NO,  NO,  TRNS,
311                   NO,  NO,  NO,  NO,  NO,  TRNS,
312              TRNS,NO,  NO,  NO,  NO,  NO,  TRNS,
313                        RGUI,RALT,TRNS,TRNS,TRNS,
314         TRNS,TRNS,
315         TRNS,
316         TRNS,RSFT,RCTL
317     ),
318     KEYMAP(  // LayerN: fully transparent
319         // left hand
320         TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
321         TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
322         TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
323         TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
324         TRNS,TRNS,TRNS,TRNS,TRNS,
325                                       TRNS,TRNS,
326                                            TRNS,
327                                  TRNS,TRNS,TRNS,
328         // right hand
329              TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
330              TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
331                   TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
332              TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
333                        TRNS,TRNS,TRNS,TRNS,TRNS,
334         TRNS,TRNS,
335         TRNS,
336         TRNS,TRNS,TRNS
337     ),
338 */
339
340 };
341
342 /* id for user defined functions */
343 enum function_id {
344     TEENSY_KEY,
345 };
346
347 /*
348  * Fn action definition
349  */
350 static const uint16_t PROGMEM fn_actions[] = {
351     [0] =   ACTION_FUNCTION(TEENSY_KEY),                    // FN0  - Teensy key
352
353     [1] =   ACTION_MODS_KEY(MOD_LSFT, KC_BSLS),             // FN1  = Shifted BackSlash // " in Workman
354     [2] =   ACTION_MODS_KEY(MOD_LSFT, KC_MINS),             // FN2  = Shifted Minus     // \ in Workman
355     [3] =   ACTION_MODS_KEY(MOD_LSFT, KC_COMM),             // FN3  = Shifted comma     // < in Workman
356     [4] =   ACTION_MODS_KEY(MOD_LSFT, KC_DOT),              // FN4  = Shifted dot       // > in Workman
357
358     [5] =   ACTION_MODS_TAP_KEY(MOD_LCTL, KC_BSPC),         // FN5  = LShift with tap BackSpace
359     [6] =   ACTION_MODS_TAP_KEY(MOD_LSFT, KC_DEL),          // FN6  = LCtrl  with tap Delete
360     [7] =   ACTION_MODS_TAP_KEY(MOD_LALT, KC_ESC),          // FN7  = LAlt   with tap Escape
361     [8] =   ACTION_MODS_TAP_KEY(MOD_RALT, KC_INS),          // FN8  = RAlt   with tap Ins
362     [9] =   ACTION_MODS_TAP_KEY(MOD_RSFT, KC_ENT),          // FN9  = RShift with tap Enter
363     [10] =  ACTION_MODS_TAP_KEY(MOD_RCTL, KC_SPC),          // FN10 = RCtrl  with tap Space
364
365     [11] =  ACTION_MODS_TAP_KEY(MOD_LSFT, KC_TAB),          // FN11 = LShift with tap Tab
366     [12] =  ACTION_MODS_TAP_KEY(MOD_LCTL, KC_GRV),          // FN12 = LCtrl  with tap Tilda
367     [13] =  ACTION_MODS_TAP_KEY(MOD_LALT, KC_SPC),          // FN13 = LAlt   with tap Space
368     [14] =  ACTION_MODS_TAP_KEY(MOD_LGUI, KC_ESC),          // FN14 = LGui   with tap Escape
369     [15] =  ACTION_MODS_TAP_KEY(MOD_RSFT, KC_QUOT),         // FN15 = RShift with tap quotes
370     [16] =  ACTION_MODS_TAP_KEY(MOD_RCTL, KC_RBRC),         // FN16 = RCtrl  with tap ]
371
372     [17] =  ACTION_LAYER_SET(0, ON_BOTH),                   // FN17 - set Layer0
373     [18] =  ACTION_LAYER_SET(1, ON_BOTH),                   // FN18 - set Layer1, to use Workman layout at firmware level
374     [19] =  ACTION_LAYER_SET(2, ON_BOTH),                   // FN19 - set Layer2, to use with Numpad keys
375
376     [20] =  ACTION_LAYER_MOMENTARY(2),                      // FN20 - momentary Layer2, to use with Numpad keys
377     [21] =  ACTION_LAYER_TAP_KEY(5, KC_ENT),                // FN21 - momentary Layer5 on Enter, to use with F* keys on top row
378     [22] =  ACTION_LAYER_TAP_KEY(6, KC_ENT),                // FN22 - momentary Layer6 on Enter, to use with F* keys on top row, cursor, Teensy, Workman-layer switch
379     [23] =  ACTION_LAYER_TAP_KEY(7, KC_BSLS),               // FN23 - momentary Layer7 on ' , to use with F* keys (F1-F24)
380
381     [24] =  ACTION_LAYER_TAP_KEY(4, KC_Z),                  // FN24 = momentary Layer4 on Z key, to use with unconvenient keys
382     [25] =  ACTION_LAYER_TAP_KEY(3, KC_X),                  // FN25 = momentary Layer3 on X key, to use with F* keys
383     [26] =  ACTION_LAYER_TAP_KEY(8, KC_C),                  // FN26 = momentary Layer8 on C key, to use with mouse and navigation keys
384     [27] =  ACTION_LAYER_TAP_KEY(2, KC_V),                  // FN27 = momentary Layer2 on V key, to use with Numpad keys
385
386     // i'd like to remove this - will try to get used to live without this and convert them to usual keys
387     [28] =  ACTION_LAYER_TAP_KEY(4, KC_A),                  // FN28 = momentary Layer4 on A key, to use with unconvenient keys
388     [29] =  ACTION_LAYER_TAP_KEY(3, KC_S),                  // FN29 = momentary Layer3 on S key, to use with F* keys
389     [30] =  ACTION_LAYER_TAP_KEY(8, KC_D),                  // FN30 = momentary Layer8 on D key, to use with mouse and navigation keys
390     [31] =  ACTION_LAYER_TAP_KEY(2, KC_F),                  // FN31 = momentary Layer2 on F key, to use with Numpad keys
391 };
392
393 void action_function(keyrecord_t *event, uint8_t id, uint8_t opt)
394 {
395     // print("action_function called\n");
396     // print("id  = "); phex(id); print("\n");
397     // print("opt = "); phex(opt); print("\n");
398
399     if (id == TEENSY_KEY) {
400         clear_keyboard();
401         print("\n\nJump to bootloader... ");
402         _delay_ms(50);
403         bootloader_jump(); // should not return
404         print("not supported.\n");
405     }
406 }
407