]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboard/planck/keymap_nathan.c
Create keymap_nathan.c
[qmk_firmware.git] / keyboard / planck / keymap_nathan.c
1 // Author: Nathan Ross Powell <nathanrospowell@gmail.com>
2 // https://github.com/nathanrosspowell/tmk_keyboard/blob/planck-jack/keyboard/planck/keymap_nathan.c
3
4 #include "keymap_common.h"
5
6 #ifndef KEYMAP_GRID
7    /* Planck keymap definition macro for the 'grid' layout
8     * ,-----------------------------------------------------------------------.
9     * |     |     |     |     |     |     |     |     |     |     |     |     |
10     * |-----------------------------------------------------------------------|
11     * |     |     |     |     |     |     |     |     |     |     |     |     |
12     * |-----------------------------------------------------------------------|
13     * |     |     |     |     |     |     |     |     |     |     |     |     |
14     * |-----------------------------------------------------------------------|
15     * |     |     |     |     |     |     |     |     |     |     |     |     |
16     * `-----------------------------------------------------------------------'
17     */
18 #define KEYMAP_GRID( \
19        K00,  K01,  K02,  K03,  K04,  K05,  K06,  K07,  K08,  K09,  K0A,  K0B, \
20        K10,  K11,  K12,  K13,  K14,  K15,  K16,  K17,  K18,  K19,  K1A,  K1B, \
21        K20,  K21,  K22,  K23,  K24,  K25,  K26,  K27,  K28,  K29,  K2A,  K2B, \
22        K30,  K31,  K32,  K33,  K34,  K35,  K36,  K37,  K38,  K39,  K3A,  K3B  \
23 ) { \
24     { KC_##K00, KC_##K01, KC_##K02, KC_##K03, KC_##K04, KC_##K05, KC_##K06, KC_##K07, KC_##K08, KC_##K09, KC_##K0A, KC_##K0B }, \
25     { KC_##K10, KC_##K11, KC_##K12, KC_##K13, KC_##K14, KC_##K15, KC_##K16, KC_##K17, KC_##K18, KC_##K19, KC_##K1A, KC_##K1B }, \
26     { KC_##K20, KC_##K21, KC_##K22, KC_##K23, KC_##K24, KC_##K25, KC_##K26, KC_##K27, KC_##K28, KC_##K29, KC_##K2A, KC_##K2B }, \
27     { KC_##K30, KC_##K31, KC_##K32, KC_##K33, KC_##K34, KC_##K35, KC_##K36, KC_##K37, KC_##K38, KC_##K39, KC_##K3A, KC_##K3B }  \
28 }
29 #endif
30
31 const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
32    /* 0: main layer
33     * ,-----------------------------------------------------------------------.
34     * |Tab  | q   | w   | e   | r   | t   | y   | u   | i   | o   | p   | BS  |
35     * |-----------------------------------------------------------------------|
36     * |Ctrl | a   | s   | d   | f   | g   | h   | j   | k   | l   | ;   | Ret |
37     * |-----------------------------------------------------------------------|
38     * |Shift| z   | x   | c   | v   | b   | n   | m   | [   | (   | {   | <   |
39     * |-----------------------------------------------------------------------|
40     * |Meta | \   | /   | Alt |Lower|Space|Space|Upper|Left |Down | Up  |Right|
41     * `-----------------------------------------------------------------------'
42     */
43   [0] = KEYMAP_GRID(
44        TAB,  Q,    W,    E,    R,    T,    Y,    U,    I,    O,    P,    BSPC,
45        LCTL, A,    S,    D,    F,    G,    H,    J,    K,    L,    SCLN, ENT,
46        RSFT, Z,    X,    C,    V,    B,    N,    M,    LBRC, FN10, FN11, FN12,
47        LGUI, BSLS, SLSH, LALT, FN0,  SPC,  SPC,  FN1,  LEFT, DOWN, UP,   RGHT),
48
49    /* 1: fn left/lower layer
50     * The top row are Visual Studio combos:
51     *   'Run', 'Breakpoint', 'Step over', 'Step into', 'Set cursor to line'
52     * 2nd row are key combos:
53     *   'ctrl-alt-delete', 'ctrl-shift-escape' 
54     * 3rd row are macros keys:
55     *   'P0' - 'P5' execute a script on Windows machines 
56     * ,-----------------------------------------------------------------------.
57     * | ESC | F5   | F9 | F10 | F11 |S+F11|CSF10|NLock|Num7 |Num8 |Num9 | Del |
58     * |-----------------------------------------------------------------------|
59     * |     |C/A/D|C/S/E| Ins |Print|Pause|SLock|Num0 |Num4 |Num5 |Num6 |Num= |
60     * |-----------------------------------------------------------------------|
61     * |     | P0  | P1  | P2  | P3  | P4  | P5  |Num. |Num1 |Num2 |Num3 |Num/ |
62     * |-----------------------------------------------------------------------|
63     * |     |User |     |     |     |     |     |     |Home |PgDn |PgUp | End |
64     * `-----------------------------------------------------------------------'
65     */
66   [1] = KEYMAP_GRID(
67        ESC,  F5,   F9,   F10,  F11,  FN30, FN31, NLCK, P7,   P8,   P9,   DEL,
68        TRNS, FN16, FN17, INS,  PSCR, PAUS, SLCK, P0,   P4,   P5,   P6,   PEQL,
69        TRNS, FN2,  FN3,  FN4,  FN5,  FN6,  FN7,  PDOT, P1,   P2,   P3,   PSLS,
70        TRNS, FN8,  TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, HOME, PGDN, PGUP, END ),
71
72   /* 2: fn right/raise layer
73     * ,-----------------------------------------------------------------------.
74     * | F1  | F2  | F3  | F4  |F5   | F6  | F7  | F8  | F9  | F10 | F11 | F12 |
75     * |-----------------------------------------------------------------------|
76     * |     | !   | @   | #   | $   | %   | ^   | &   | *   | -   | +   | =   |
77     * |-----------------------------------------------------------------------|
78     * |     | _   | '   | "   | `   | ~   | ,   | .   | ]   | )   | }   | >   |
79     * |-----------------------------------------------------------------------|
80     * |     |NextT|PrevT|     |     |     | Esc |     |Mute |Vol- |Vol+ | P/P |
81     * `-----------------------------------------------------------------------'
82     */
83   [2] = KEYMAP_GRID(
84        F1,   F2,   F3,   F4,   F5,   F6,   F7,   F8,   F9,   F10,  F11,  F12,
85        TRNS, FN18, FN19, FN20, FN21, FN22, FN23, FN24, FN25, MINS, FN26, PAST,
86        TRNS, FN27, QUOT, FN28, GRV,  FN29, COMM, DOT,  RBRC, FN13, FN14, FN15,
87        TRNS, MNXT, MPRV, TRNS, TRNS, TRNS, ESC,  TRNS, MUTE, VOLD, VOLU, MPLY ),
88 };
89
90 enum macro_id {
91     M_P0,
92     M_P1,
93     M_P2,
94     M_P3,
95     M_P4,
96     M_P5,
97     M_USERNAME
98 };
99
100 const uint16_t PROGMEM fn_actions[] = {
101   [0] = ACTION_LAYER_MOMENTARY(1), // left/lower layer
102   [1] = ACTION_LAYER_MOMENTARY(2), // right/raise layer
103   // Program macros
104   [2] = ACTION_MACRO(M_P0),
105   [3] = ACTION_MACRO(M_P1),
106   [4] = ACTION_MACRO(M_P2),
107   [5] = ACTION_MACRO(M_P3),
108   [6] = ACTION_MACRO(M_P4),
109   [7] = ACTION_MACRO(M_P5),
110   [8] = ACTION_MACRO(M_USERNAME),
111   // Braces
112   [10] = ACTION_MODS_KEY(MOD_LSFT, KC_9), // (
113   [11] = ACTION_MODS_KEY(MOD_LSFT, KC_LBRC), // {
114   [12] = ACTION_MODS_KEY(MOD_LSFT, KC_COMMA), // <
115   [13] = ACTION_MODS_KEY(MOD_LSFT, KC_0),  // )
116   [14] = ACTION_MODS_KEY(MOD_LSFT, KC_RBRC), // {
117   [15] = ACTION_MODS_KEY(MOD_LSFT, KC_DOT), // >
118   // Combo
119   [16] = ACTION_MODS_KEY(MOD_LALT | MOD_LCTL, KC_DEL), // Ctrl+Alt+Delete
120   [17] = ACTION_MODS_KEY(MOD_LSFT | MOD_LCTL, KC_ESC), // Ctrl+Shft+Escape
121   // Symbols
122   [18] = ACTION_MODS_KEY(MOD_LSFT, KC_1), // !
123   [19] = ACTION_MODS_KEY(MOD_LSFT, KC_2), // @
124   [20] = ACTION_MODS_KEY(MOD_LSFT, KC_3), // #
125   [21] = ACTION_MODS_KEY(MOD_LSFT, KC_4), // $
126   [22] = ACTION_MODS_KEY(MOD_LSFT, KC_5), // %
127   [23] = ACTION_MODS_KEY(MOD_LSFT, KC_6), // ^
128   [24] = ACTION_MODS_KEY(MOD_LSFT, KC_7), // &
129   [25] = ACTION_MODS_KEY(MOD_LSFT, KC_8), // *
130   [26] = ACTION_MODS_KEY(MOD_LSFT, KC_EQL), // + 
131   [27] = ACTION_MODS_KEY(MOD_LSFT, KC_MINUS), // _
132   [28] = ACTION_MODS_KEY(MOD_LSFT, KC_QUOTE), // "
133   [29] = ACTION_MODS_KEY(MOD_LSFT, KC_GRAVE), // ~
134   // Debugging
135   [30] = ACTION_MODS_KEY(MOD_LSFT, KC_F11), // Step into
136   [31] = ACTION_MODS_KEY(MOD_LSFT | MOD_LCTL, KC_F10), // Set cursor to line
137  };
138
139 // Run a script and pass a key number to it. This is Windows specific and the script needs to be on your path.
140 // *open run dialog* keypress.py [PRG_NUM]
141 #define ADD_PYTHON_PROGRAM_ON_WIN( PRG_NUM )  MACRO( D(LGUI), T(R), U(LGUI), W(100), T(K), T(E), T(Y), T(P), T(R), T(E), T(S), T(S), T(DOT), T(P), T(Y), T(SPC), T(PRG_NUM), END )
142 // *return*
143 #define RUN_PYTHON_PROGRAM_ON_WIN MACRO( T(ENT), END )
144
145 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
146 {
147     keyevent_t event = record->event;
148     switch (id) {
149         case M_P0:
150             return event.pressed ?
151                 ADD_PYTHON_PROGRAM_ON_WIN( 0 ) : 
152                 RUN_PYTHON_PROGRAM_ON_WIN;
153         case M_P1:
154             return event.pressed ?
155                 ADD_PYTHON_PROGRAM_ON_WIN( 1 ) : 
156                 RUN_PYTHON_PROGRAM_ON_WIN;
157         case M_P2:
158             return event.pressed ?
159                 ADD_PYTHON_PROGRAM_ON_WIN( 2 ) : 
160                 RUN_PYTHON_PROGRAM_ON_WIN;
161         case M_P3:
162             return event.pressed ?
163                 ADD_PYTHON_PROGRAM_ON_WIN( 3 ) : 
164                 RUN_PYTHON_PROGRAM_ON_WIN;
165         case M_P4:
166             return event.pressed ?
167                 ADD_PYTHON_PROGRAM_ON_WIN( 4 ) : 
168                 RUN_PYTHON_PROGRAM_ON_WIN;
169         case M_P5:
170             return event.pressed ?
171                 ADD_PYTHON_PROGRAM_ON_WIN( 5 ) : 
172                 RUN_PYTHON_PROGRAM_ON_WIN;
173         case M_USERNAME:
174             return event.pressed ?
175                 MACRO( T(N), T(A), T(T), T(H), T(A), T(N), T(R), T(O), T(S), T(S), T(P), T(O), T(W), T(E), T(L), T(L), END ) :
176                 MACRO_NONE;
177
178     }
179     return MACRO_NONE;
180 }