]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/ergodox/keymaps/twey/keymap.c
update 9key readme
[qmk_firmware.git] / keyboards / ergodox / keymaps / twey / keymap.c
1 #include "ergodox.h"
2 #include "debug.h"
3 #include "action_layer.h"
4 #include "keymap_plover.h"
5
6 #define BASE 0 // default layer
7 #define SYMB 1 // symbols
8 #define STEN 2 // steno
9 #define MDIA 3 // media keys
10
11
12 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
13 /* Keymap 0: Basic layer
14  *
15  * ,---------------------------------------------------.           ,---------------------------------------------------.
16  * |   =    |   1  |   2  |   3  |   4   |   5  | STEN |           | NONE  |   6  |   7  |   8  |   9  |   0  |   \    |
17  * |--------+------+------+------+-------+-------------|           |-------+------+------+------+------+------+--------|
18  * | Del    |   '  |   ,  |   .  |   P   |   Y  |  Esc |           | Caps  |   F  |   G  |   C  |   R  |   L  |   /    |
19  * |--------+------+------+------+-------+------|      |           |       |------+------+------+------+------+--------|
20  * | BkSp   |   A  |   O  |   E  |   U   |   I  |------|           |-------|   D  |   H  |   T  |   N  |   S  |   -    |
21  * |--------+------+------+------+-------+------|  Tab |           | Enter |------+------+------+------+------+--------|
22  * | LShift |   ;  |   Q  |   J  |   K   |   X  |      |           |       |   B  |   M  |   W  |   V  |   Z  | RShift |
23  * `--------+------+------+------+-------+-------------'           `--------------+------+------+------+------+--------'
24  *   |  L1  | NONE |  Grv | Left | Right |                                        |  Up  | Down |   [  |   ]  |  L1  |
25  *   `-----------------------------------'                                        `----------------------------------'
26  *                                        ,--------------.         ,---------------.
27  *                                        |  PgUp | PgDn |         | Home  |  End  |
28  *                                 ,------|-------|------|         |-------+-------+------.
29  *                                 |      |       | NONE |         | AltGr |       |      |
30  *                                 | Alt  | Enter |------|         |-------| Space | Ctrl |
31  *                                 |      |       | Supr |         | ~MDIA |       |      |
32  *                                 `---------------------'         `----------------------'
33  */
34 // If it accepts an argument (i.e, is a function), it doesn't need KC_.
35 // Otherwise, it needs KC_*
36 [BASE] = KEYMAP(  // layer 0 : default
37         // left hand
38         KC_EQL,         KC_1,         KC_2,   KC_3,   KC_4,   KC_5,   M(0),
39         KC_DELT,        KC_QUOT,      KC_COMM,KC_DOT, KC_P,   KC_Y,   KC_ESC,
40         KC_BSPC,        KC_A,         KC_O,   KC_E,   KC_U,   KC_I,
41         KC_LSFT,        KC_SCLN,      KC_Q,   KC_J,   KC_K,   KC_X,   KC_TAB,
42         MO(SYMB),       KC_NO,        KC_GRV, KC_LEFT,KC_RGHT,
43                                                       KC_PGUP,KC_PGDN,
44                                                               KC_NO,
45                                               KC_LALT,KC_ENT ,KC_LGUI,
46         // right hand
47              KC_NO,       KC_6,   KC_7,   KC_8,   KC_9,   KC_0,    KC_BSLS,
48              KC_CAPS,     KC_F,   KC_G,   KC_C,   KC_R,   KC_L,    KC_SLSH,
49                           KC_D,   KC_H,   KC_T,   KC_N,   KC_S,    KC_MINS,
50              KC_ENT,      KC_B,   KC_M,   KC_W,   KC_V,   KC_Z   , KC_RSFT,
51                                   KC_UP,  KC_DOWN,KC_LBRC,KC_RBRC, MO(SYMB),
52              KC_HOME, KC_END,
53              KC_RALT,
54              MO(MDIA),KC_SPC,KC_RCTL
55     ),
56 /* Keymap 1: Symbol Layer
57  *
58  * ,--------------------------------------------------.           ,--------------------------------------------------.
59  * |        |  F1  |  F2  |  F3  |  F4  |  F5  |      |           |      |  F6  |  F7  |  F8  |  F9  |  F10 |   F11  |
60  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
61  * |        |   !  |   @  |   {  |   }  |   |  |      |           |      |   Up |   7  |   8  |   9  |   *  |   F12  |
62  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
63  * |        |   #  |   $  |   (  |   )  |   `  |------|           |------| Down |   4  |   5  |   6  |   +  |        |
64  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
65  * |        |   %  |   ^  |   [  |   ]  |   ~  |      |           |      |   &  |   1  |   2  |   3  |   \  |        |
66  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
67  *   |      |      |      |      |      |                                       |      |    . |   0  |   =  |      |
68  *   `----------------------------------'                                       `----------------------------------'
69  *                                        ,-------------.       ,-------------.
70  *                                        |      |      |       |      |      |
71  *                                 ,------|------|------|       |------+------+------.
72  *                                 |      |      |      |       |      |      |      |
73  *                                 |      |      |------|       |------|      |      |
74  *                                 |      |      |      |       |      |      |      |
75  *                                 `--------------------'       `--------------------'
76  */
77 // SYMBOLS
78 [SYMB] = KEYMAP(
79        // left hand
80        KC_TRNS,KC_F1,  KC_F2,  KC_F3,  KC_F4,  KC_F5,  KC_TRNS,
81        KC_TRNS,KC_EXLM,KC_AT,  KC_LCBR,KC_RCBR,KC_PIPE,KC_TRNS,
82        KC_TRNS,KC_HASH,KC_DLR, KC_LPRN,KC_RPRN,KC_GRV,
83        KC_TRNS,KC_PERC,KC_CIRC,KC_LBRC,KC_RBRC,KC_TILD,KC_TRNS,
84        KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,
85                                        KC_TRNS,KC_TRNS,
86                                                KC_TRNS,
87                                KC_TRNS,KC_TRNS,KC_TRNS,
88        // right hand
89        KC_TRNS, KC_F6,   KC_F7,  KC_F8,   KC_F9,   KC_F10,  KC_F11,
90        KC_TRNS, KC_UP,   KC_7,   KC_8,    KC_9,    KC_ASTR, KC_F12,
91                 KC_DOWN, KC_4,   KC_5,    KC_6,    KC_PLUS, KC_TRNS,
92        KC_TRNS, KC_AMPR, KC_1,   KC_2,    KC_3,    KC_BSLS, KC_TRNS,
93                          KC_TRNS,KC_DOT,  KC_0,    KC_EQL,  KC_TRNS,
94        KC_TRNS, KC_TRNS,
95        KC_TRNS,
96        KC_TRNS, KC_TRNS, KC_TRNS
97 ),
98
99 [STEN] = KEYMAP(  // layout: layer 2: Steno for Plover
100         // left hand
101         KC_NO,  KC_NO,  KC_NO,  KC_NO,   KC_NO,  KC_NO,   KC_TRNS,
102         KC_NO,  PV_NUM, PV_NUM, PV_NUM,  PV_NUM, PV_NUM,  PV_STAR,
103         KC_NO,  PV_LS,  PV_LT,  PV_LP,   PV_LH,  PV_STAR,
104         KC_NO,  PV_LS,  PV_LK,  PV_LW,   PV_LR,  PV_STAR, PV_STAR,
105         KC_TRNS,KC_NO,  KC_NO,  KC_TRNS, KC_TRNS,
106                                           KC_NO, KC_NO,
107                                                  KC_NO,
108                                    PV_A,  PV_O,  KC_NO,
109         // right hand
110           KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
111         PV_STAR,  PV_NUM,  PV_NUM,  PV_NUM,  PV_NUM,  PV_NUM,  PV_NUM,
112                  PV_STAR,   PV_RF,   PV_RP,   PV_RL,   PV_RT,   PV_RD,
113         PV_STAR, PV_STAR,   PV_RR,   PV_RB,   PV_RG,   PV_RS,   PV_RZ,
114                           KC_TRNS, KC_TRNS,   KC_NO,   KC_NO, KC_TRNS,
115         KC_NO,  KC_NO,
116         KC_NO,
117         KC_TRNS,PV_E,    PV_U
118 ),
119
120 /* Keymap 3: Media and mouse keys
121  *
122  * ,--------------------------------------------------.           ,--------------------------------------------------.
123  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
124  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
125  * |        |      |      | MsUp |      |      |      |           |      |      | Back |      | Frwd |      |        |
126  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
127  * |        |      |MsLeft|MsDown|MsRght|      |------|           |------|      | Prev | Play | Next |      |        |
128  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
129  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
130  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
131  *   |      |      |      | Lclk | Rclk |                                       |VolUp |VolDn | Mute |      |      |
132  *   `----------------------------------'                                       `----------------------------------'
133  *                                        ,-------------.       ,-------------.
134  *                                        |      |      |       |      |      |
135  *                                 ,------|------|------|       |------+------+------.
136  *                                 |      |      |      |       |      |      |      |
137  *                                 |      |      |------|       |------|      |      |
138  *                                 |      |      |      |       |      |      |      |
139  *                                 `--------------------'       `--------------------'
140  */
141 // MEDIA AND MOUSE
142 [MDIA] = KEYMAP(
143        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
144        KC_TRNS, KC_TRNS, KC_TRNS, KC_MS_U, KC_TRNS, KC_TRNS, KC_TRNS,
145        KC_TRNS, KC_TRNS, KC_MS_L, KC_MS_D, KC_MS_R, KC_TRNS,
146        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
147        KC_TRNS, KC_TRNS, KC_TRNS, KC_BTN1, KC_BTN2,
148                                            KC_TRNS, KC_TRNS,
149                                                     KC_TRNS,
150                                   KC_TRNS, KC_TRNS, KC_TRNS,
151     // right hand
152        KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
153        KC_TRNS,  KC_TRNS, KC_WBAK, KC_TRNS, KC_WFWD, KC_TRNS, KC_TRNS,
154                  KC_TRNS, KC_MPRV, KC_MPLY, KC_MNXT, KC_TRNS, KC_TRNS,
155        KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
156                           KC_VOLU, KC_VOLD, KC_MUTE, KC_TRNS, KC_TRNS,
157        KC_TRNS, KC_TRNS,
158        KC_TRNS,
159        KC_TRNS, KC_TRNS, KC_WBAK
160 ),
161 };
162
163 const uint16_t PROGMEM fn_actions[] = {
164     [1] = ACTION_LAYER_TAP_TOGGLE(MDIA)                // FN1 - Momentary Layer 3 (Media)
165 };
166
167 void toggle_steno(int pressed)
168 {
169   uint8_t layer = biton32(layer_state);
170   
171   if (pressed) {
172     if (layer != STEN) layer_on(STEN); else layer_off(STEN);
173
174     register_code(PV_LP);
175     register_code(PV_LH);
176     register_code(PV_LR);
177     register_code(PV_O);
178     register_code(PV_RL);
179     register_code(PV_RG);
180   } else {
181     unregister_code(PV_LP);
182     unregister_code(PV_LH);
183     unregister_code(PV_LR);
184     unregister_code(PV_O);
185     unregister_code(PV_RL);
186     unregister_code(PV_RG);
187   }
188 }
189
190 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
191 {
192   // MACRODOWN only works in this function
193       switch(id) {
194         case 0:
195         toggle_steno(record->event.pressed);
196         break;
197       }
198     return MACRO_NONE;
199 };
200
201 // Runs just one time when the keyboard initializes.
202 void matrix_init_user(void) {
203
204 };
205
206 // Runs constantly in the background, in a loop.
207 void matrix_scan_user(void) {
208     __attribute__ ((unused))
209     uint32_t layer0 = layer_state & (1UL << 0),
210              layer1 = layer_state & (1UL << 1),
211              layer2 = layer_state & (1UL << 2),
212              layer3 = layer_state & (1UL << 3);    
213
214     ergodox_board_led_off();
215     ergodox_right_led_1_off();
216     ergodox_right_led_2_off();
217     ergodox_right_led_3_off();
218
219     if (layer1) ergodox_right_led_1_on();
220     if (layer2) ergodox_right_led_2_on();
221     if (layer3) ergodox_right_led_3_on();
222 };