]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/planck/keymaps/lae3/keymap.c
Adds support for Planck Rev 6 (#2666)
[qmk_firmware.git] / keyboards / planck / keymaps / lae3 / keymap.c
1 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
2 #include "planck.h"
3 #include "action_layer.h"
4 #ifdef AUDIO_ENABLE
5 #include "audio.h"
6 #endif
7 #include "eeconfig.h"
8
9 extern keymap_config_t keymap_config;
10
11 // Each layer gets a name for readability, which is then used in the keymap matrix below.
12 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
13 // Layer names don't all need to be of the same length, obviously, and you can also skip them
14 // entirely and just use numbers.
15 enum planck_layers {
16     _QWERTY,
17     _ARROW,
18     _NUMPAD,
19     _MOVEMENT,
20     _LOWER,
21     _RAISE,
22     _ADJUST
23 };
24
25 #define _MV _MOVEMENT
26
27 enum planck_keycodes {
28     QWERTY = SAFE_RANGE,
29     ARROW,
30     NUMPAD,
31     LOWER,
32     RAISE,
33 };
34
35 // Fillers to make layering more clear
36 #define _______ KC_TRNS
37 #define XXXXXXX KC_NO
38
39 #define KC_MUP KC_MS_UP
40 #define KC_MDN KC_MS_DOWN
41 #define KC_MLFT KC_MS_LEFT
42 #define KC_MRGT KC_MS_RIGHT
43 #define KC_MB1 KC_MS_BTN1
44 #define KC_MB2 KC_MS_BTN2
45 #define KC_MB3 KC_MS_BTN3
46 #define KC_MB4 KC_MS_BTN4
47 #define KC_MB5 KC_MS_BTN5
48 #define KC_MWUP KC_MS_WH_UP
49 #define KC_MWDN KC_MS_WH_DOWN
50
51 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
52
53     /* Qwerty
54      * ,-----------------------------------------------------------------------------------.
55      * | Esc  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
56      * |------+------+------+------+------+------+------+------+------+------+------+------|
57      * | Tab  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |Enter |
58      * |------+------+------+------+------+------+------+------+------+------+------+------|
59      * |Shift |   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Shift |
60      * |------+------+------+------+------+-------------+------+------+------+------+------|
61      * | Ctrl | GUI  | Alt  | Move |Lower |    Space    |Raise | Move | Alt  | GUI  | Ctrl |
62      * `-----------------------------------------------------------------------------------'
63      */
64     [_QWERTY] = {
65         {KC_ESC,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
66         {KC_TAB,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_ENT },
67         {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT},
68         {KC_LCTL, KC_LGUI, KC_LALT, MO(_MV), LOWER,   KC_SPC,  KC_SPC,  RAISE,   MO(_MV), KC_RALT, KC_RGUI, KC_RCTL}
69     },
70
71     /* Arrow
72      * ,-----------------------------------------------------------------------------------.
73      * |      |      |      |      |      |      |      |      |      |      |      |      |
74      * |------+------+------+------+------+------+------+------+------+------+------+------|
75      * |      |      |      |      |      |      |      |      |      |      |      |      |
76      * |------+------+------+------+------+------+------+------+------+------+------+------|
77      * |      |      |      |      |      |      |      |      |      |      |  Up  |      |
78      * |------+------+------+------+------+-------------+------+------+------+------+------|
79      * |      |      |      |      |      |             |      |      | Left | Down | Right|
80      * `-----------------------------------------------------------------------------------'
81      */
82     [_ARROW] = {
83         {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
84         {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
85         {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_UP,   _______},
86         {_______, _______, _______, _______, _______, _______, _______, _______, _______, KC_LEFT, KC_DOWN, KC_RGHT}
87     },
88
89     /* Numpad
90      * ,-----------------------------------------------------------------------------------.
91      * |      |      |      |      |      |      |NumLck|   7  |   8  |   9  |   /  |      |
92      * |------+------+------+------+------+------+------+------+------+------+------+------|
93      * |      |      |      |      |      |      |Enter |   4  |   5  |   6  |   *  |      |
94      * |------+------+------+------+------+------+------+------+------+------+------+------|
95      * |      |      |      |      |      |      |      |   3  |   2  |   1  |   -  |      |
96      * |------+------+------+------+------+-------------+------+------+------+------+------|
97      * |      |      |      |      |      |             |      |   0  |   .  |   +  |      |
98      * `-----------------------------------------------------------------------------------'
99      */
100     [_NUMPAD] = {
101         {_______, _______, _______, _______, _______, _______, KC_NLCK, KC_P7,   KC_P8,   KC_P9,   KC_PSLS, _______},
102         {_______, _______, _______, _______, _______, _______, KC_PENT, KC_P4,   KC_P5,   KC_P6,   KC_PAST, _______},
103         {_______, _______, _______, _______, _______, _______, _______, KC_P1,   KC_P2,   KC_P3,   KC_PMNS, _______},
104         {_______, _______, _______, _______, _______, _______, _______, _______, KC_P0,   KC_PDOT, KC_PPLS, _______}
105     },
106
107     /* Movement
108      * ,-----------------------------------------------------------------------------------.
109      * |      |MsBut2|Ms Up |MsBut1|MsWhUp|      | Home | PgDn | PgUp |  End |      |      |
110      * |------+------+------+------+------+------+------+------+------+------+------+------|
111      * |      |Ms Lft|Ms Dn |Ms Rgt|MsWhDn|      | Left | Down |  Up  | Right|      |      |
112      * |------+------+------+------+------+------+------+------+------+------+------+------|
113      * |      |      |      |      |      |      |      |      |      |      |      |      |
114      * |------+------+------+------+------+-------------+------+------+------+------+------|
115      * |      |      |      |      |      |             |      |      |      |      |      |
116      * `-----------------------------------------------------------------------------------'
117      */
118     [_MOVEMENT] = {
119         {_______, KC_MB2,  KC_MUP,  KC_MB1,  KC_MWUP, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END,  _______, _______},
120         {_______, KC_MLFT, KC_MDN,  KC_MRGT, KC_MWDN, _______, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, _______, _______},
121         {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
122         {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
123     },
124
125     /* Lower
126      * ,-----------------------------------------------------------------------------------.
127      * |   `  |   1  |   2  |   3  |   4  |   5  |   -  |   =  |  Del | End  | PgDn |      |
128      * |------+------+------+------+------+------+------+------+------+------+------+------|
129      * | Caps |   6  |   7  |   8  |   9  |   0  |   [  |   ]  |   \  |   '  |      |      |
130      * |------+------+------+------+------+------+------+------+------+------+------+------|
131      * |      |  F1  |  F2  |  F3  |  F4  |      |      |  F5  |  F6  |  F7  |  F8  |      |
132      * |------+------+------+------+------+-------------+------+------+------+------+------|
133      * |      |      |      |      |      |             |      |      |      |      |      |
134      * `-----------------------------------------------------------------------------------'
135      */
136     [_LOWER] = {
137         {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_MINS, KC_EQL,  KC_DEL,  KC_END,  KC_PGDN, _______},
138         {KC_CAPS, KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_LBRC, KC_RBRC, KC_BSLS, KC_QUOT, XXXXXXX, _______},
139         {_______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   XXXXXXX, XXXXXXX, KC_F5,   KC_F6,   KC_F7,   KC_F8,   _______},
140         {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
141     },
142
143     /* Raise
144      * ,-----------------------------------------------------------------------------------.
145      * |   ~  |   !  |   @  |   #  |   $  |   %  |   _  |   +  |  Ins | Home | PgUp |      |
146      * |------+------+------+------+------+------+------+------+------+------+------+------|
147      * | Caps |   ^  |   &  |   *  |   (  |   )  |   {  |   }  |   |  |   "  |      |      |
148      * |------+------+------+------+------+------+------+------+------+------+------+------|
149      * |      |  F9  |  F10 |  F11 |  F12 |      |      |      |      |      |      |      |
150      * |------+------+------+------+------+-------------+------+------+------+------+------|
151      * |      |      |      |      |      |             |      |      |      |      |      |
152      * `-----------------------------------------------------------------------------------'
153      */
154     [_RAISE] = {
155         {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_UNDS, KC_PLUS, KC_INS,  KC_HOME, KC_PGUP, _______},
156         {KC_CAPS, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_LCBR, KC_RCBR, KC_PIPE, KC_DQUO, XXXXXXX, _______},
157         {_______, KC_F9,   KC_F10,  KC_F11,  KC_F12,  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______},
158         {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
159     },
160
161     /* Adjust (Lower + Raise)
162      * ,-----------------------------------------------------------------------------------.
163      * |Reset |      |      |      |      |      |      |      |      |      |      |      |
164      * |------+------+------+------+------+------+------+------+------+------+------+------|
165      * |      |Bcklgt| Mute |Vol Dn|Vol Up|      |      |Qwerty|Arrow |Numpad|      |      |
166      * |------+------+------+------+------+------+------+------+------+------+------+------|
167      * |      |      |      |      |      |      |      |      |      |      |      |      |
168      * |------+------+------+------+------+-------------+------+------+------+------+------|
169      * |      |      |      |      |      |             |      |      |      |      |      |
170      * `-----------------------------------------------------------------------------------'
171      */
172     [_ADJUST] = {
173         {RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
174         {_______, BL_STEP, KC_MUTE, KC_VOLD, KC_VOLU, _______, _______, QWERTY,  ARROW,   NUMPAD,  _______, _______},
175         {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
176         {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
177     }
178
179 };
180
181 #ifdef AUDIO_ENABLE
182
183 float tone_startup[][2]    = SONG(STARTUP_SOUND);
184 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
185
186 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
187
188 #endif
189
190 bool process_record_user(uint16_t keycode, keyrecord_t *record)
191 {
192     switch (keycode) {
193         case LOWER:
194             if (record->event.pressed) {
195                 layer_on(_LOWER);
196             } else {
197                 layer_off(_LOWER);
198             }
199             update_tri_layer(_LOWER, _RAISE, _ADJUST);
200             return false;
201         case RAISE:
202             if (record->event.pressed) {
203                 layer_on(_RAISE);
204             } else {
205                 layer_off(_RAISE);
206             }
207             update_tri_layer(_LOWER, _RAISE, _ADJUST);
208             return false;
209         case QWERTY:
210             if (record->event.pressed) {
211                 layer_off(_ARROW);
212                 layer_off(_NUMPAD);
213             }
214             return false;
215         case ARROW:
216             if (record->event.pressed) {
217                 layer_off(_NUMPAD);
218                 layer_on(_ARROW);
219             }
220             return false;
221         case NUMPAD:
222             if (record->event.pressed) {
223                 layer_off(_ARROW);
224                 layer_on(_NUMPAD);
225             }
226             return false;
227     }
228     return true;
229 }
230
231 void matrix_init_user(void)
232 {
233 #ifdef AUDIO_ENABLE
234     startup_user();
235 #endif
236 }
237
238 #ifdef AUDIO_ENABLE
239
240 void startup_user()
241 {
242     _delay_ms(100); // gets rid of tick
243     PLAY_SONG(tone_startup);
244 }
245
246 void shutdown_user()
247 {
248     PLAY_SONG(tone_goodbye);
249     _delay_ms(150);
250     stop_all_notes();
251 }
252
253 void music_on_user(void)
254 {
255     music_scale_user();
256 }
257
258 void music_scale_user(void)
259 {
260     PLAY_SONG(music_scale);
261 }
262
263 #endif