]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/rgbkb/sol/keymaps/default/keymap.c
Sol Rev 2 Keyboard (#6389)
[qmk_firmware.git] / keyboards / rgbkb / sol / keymaps / default / keymap.c
1 #include QMK_KEYBOARD_H
2
3 #ifdef PROTOCOL_LUFA
4 #include "lufa.h"
5 #include "split_util.h"
6 #endif
7
8 // Each layer gets a name for readability, which is then used in the keymap matrix below.
9 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
10 // Layer names don't all need to be of the same length, obviously, and you can also skip them
11 // entirely and just use numbers.
12 enum layer_number {
13     _QWERTY = 0,
14     _COLEMAK,
15     _FN,
16     _ADJ
17 };
18
19 // Keycode defines for layers
20 #define QWERTY   DF(_QWERTY)
21 #define COLEMAK  DF(_COLEMAK)
22 #define FN       MO(_FN)
23 #define ADJ      MO(_ADJ)
24
25 enum custom_keycodes {
26   RGBRST = SAFE_RANGE,
27   RGB_MENU
28 };
29
30 #define FN_ESC   LT(_FN, KC_ESC)
31 #define FN_CAPS  LT(_FN, KC_CAPS)
32
33 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
34   /* Qwerty
35    * ,------------------------------------------------.  ,------------------------------------------------.
36    * | GESC |   1  |   2  |   3  |   4  |   5  |   -  |  |   =  |   6  |   7  |   8  |   9  |   0  | BkSp |
37    * |------+------+------+------+------+------|------|  |------|------+------+------+------+------+------|
38    * | Tab  |   Q  |   W  |   E  |   R  |   T  |   [  |  |   ]  |   Y  |   U  |   I  |   O  |   P  |   \  |
39    * |------+------+------+------+------+------|------|  |------|------+------+------+------+------+------|
40    * |FN(CAPS)| A  |   S  |   D  |   F  |   G  |   (  |  |   )  |   H  |   J  |   K  |   L  |   ;  |   '  |
41    * |------+------+------+------+------+------+------|  |------+------+------+------+------+------+------|
42    * |Shift |   Z  |   X  |   C  |   V  |   B  |   {  |  |   }  |   N  |   M  |   ,  |   .  |   /  |Enter |
43    * |------+------+------+------+------+------+------|  |------+------+------+------+------+------+------|
44    * | Ctrl |  Win |  Alt |  RGB | ADJ  | Space| DEL  | | Enter| Space|  FN  | Left | Down | Up   |Right |
45    * |------+------+------+------+------+------+------|  |------+------+------+------+------+------+------'
46    *                                    | Space| DEL  |  | Enter| Space|
47    *                                    `-------------'  `-------------'
48    */
49   [_QWERTY] = LAYOUT( \
50     KC_GESC,    KC_1,    KC_2,    KC_3,    KC_4,    KC_5, KC_MINS,  KC_EQL,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0, KC_BSPC, \
51      KC_TAB,    KC_Q,    KC_W,    KC_E,    KC_R,    KC_T, KC_LBRC, KC_RBRC,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P, KC_BSLS, \
52     FN_CAPS,    KC_A,    KC_S,    KC_D,    KC_F,    KC_G, KC_LPRN, KC_RPRN,    KC_H,    KC_J,    KC_K,    KC_L, KC_SCLN, KC_QUOT, \
53     KC_LSFT,    KC_Z,    KC_X,    KC_C,    KC_V,    KC_B, KC_LCBR, KC_RCBR,    KC_N,    KC_M, KC_COMM,  KC_DOT, KC_SLSH,  KC_ENT, \
54     KC_LCTL, KC_LGUI, KC_LALT, RGB_TOG,     ADJ,  KC_SPC,  KC_DEL,  KC_ENT,  KC_SPC,      FN, KC_LEFT, KC_DOWN,   KC_UP,KC_RIGHT, \
55                                                   KC_SPC,  KC_DEL,  KC_ENT,  KC_SPC \
56   ),
57
58   /* Colemak
59    * ,------------------------------------------------.  ,------------------------------------------------.
60    * | GESC |   1  |   2  |   3  |   4  |   5  |   -  |  |   =  |   6  |   7  |   8  |   9  |   0  | BkSp |
61    * |------+------+------+------+------+------|------|  |------|------+------+------+------+------+------|
62    * | Tab  |   Q  |   W  |   F  |   P  |   B  |   [  |  |   ]  |   J  |   L  |   U  |   Y  |   ;  |   \  |
63    * |------+------+------+------+------+------|------|  |------|------+------+------+------+------+------|
64    * |FN(CAPS)| A  |   R  |   S  |   T  |   G  |   (  |  |   )  |   K  |   N  |   E  |   I  |   O  |   '  |
65    * |------+------+------+------+------+------+------|  |------+------+------+------+------+------+------|
66    * |Shift |   Z  |   X  |   C  |   D  |   V  |   {  |  |   }  |   M  |   H  |   ,  |   .  |   /  |Enter |
67    * |------+------+------+------+------+------+------|  |------+------+------+------+------+------+------|
68    * | Ctrl |  Win |  Alt |  RGB | ADJ  | Space| DEL  |  | Enter| Space|  FN  | Left | Down | Up   |Right |
69    * |------+------+------+------+------+------+------|  |------+------+------+------+------+------+------'
70    *                                    | Space| DEL  |  | Enter| Space|
71    *                                    `-------------'  `-------------'
72    */
73   [_COLEMAK] = LAYOUT( \
74     KC_GESC,    KC_1,    KC_2,    KC_3,    KC_4,    KC_5, KC_MINS,  KC_EQL,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0, KC_BSPC, \
75      KC_TAB,    KC_Q,    KC_W,    KC_F,    KC_P,    KC_G, KC_LBRC, KC_RBRC,    KC_J,    KC_L,    KC_U,    KC_Y, KC_SCLN, KC_BSLS, \
76     FN_CAPS,    KC_A,    KC_R,    KC_S,    KC_T,    KC_D, KC_LPRN, KC_RPRN,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O, KC_QUOT, \
77     KC_LSFT,    KC_Z,    KC_X,    KC_C,    KC_V,    KC_B, KC_LCBR, KC_RCBR,    KC_K,    KC_M, KC_COMM, KC_DOT,  KC_SLSH,  KC_ENT, \
78     KC_LCTL, KC_LGUI, KC_LALT, RGB_TOG,     ADJ,  KC_SPC,  KC_DEL,  KC_ENT,  KC_SPC,      FN, KC_LEFT, KC_DOWN,   KC_UP,KC_RIGHT, \
79                                                   KC_SPC,  KC_DEL,  KC_ENT,  KC_SPC \
80   ),
81
82   /* FN
83    * ,------------------------------------------------.  ,------------------------------------------------.
84    * |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |      |  |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
85    * |------+------+------+------+------+------|------|  |------|------+------+------+------+------+------|
86    * |      | PGDN |  UP  | PGUP |      |      |      |  |      |      | PGDN |  UP  | PGUP | PRINT| HOME |
87    * |------+------+------+------+------+------|------|  |------|------+------+------+------+------+------|
88    * |      | LEFT | DOWN | RIGHT|      |      |      |  |      |      | LEFT | DOWN | RIGHT|INSERT| END  |
89    * |------+------+------+------+------+------+------|  |------+------+------+------+------+------+------|
90    * |      |      |      |      |      |      |      |  |      |      |      |      |      |      |      |
91    * |------+------+------+------+------+------+------|  |------+------+------+------+------+------+------|
92    * |      |      |      |RGBMOD|      |      |      |  |      |      | PLAY | NEXT | MUTE | VOL- | VOL+ |
93    * `------+------+------+------+------+------+------|  |------+------+------+------+------+------+------'
94    *                                    |      |      |  |      |      |
95    *                                    `-------------'  `-------------'
96    */
97   [_FN] = LAYOUT( \
98       KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6, _______, KC_PSCR,   KC_F7,   KC_F8,   KC_F9,  KC_F10,  KC_F11,  KC_F12, \
99     _______, KC_PGDN,   KC_UP, KC_PGUP, _______, _______, _______, KC_SLCK, _______, KC_PGDN,   KC_UP, KC_PGUP, KC_PSCR, KC_HOME, \
100     _______, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______, _______, KC_NLCK, _______, KC_LEFT, KC_DOWN, KC_RGHT,  KC_INS,  KC_END, \
101     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
102     _______, _______, _______, RGB_MOD, _______, _______, _______, _______, _______, KC_MPLY, KC_MNXT, KC_MUTE, KC_VOLD, KC_VOLU, \
103                                                  _______, _______, _______, _______ \
104   ),
105
106   /* ADJ
107    * ,------------------------------------------------.  ,------------------------------------------------.
108    * |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |      |  |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
109    * |------+------+------+------+------+------|------|  |------|------+------+------+------+------+------|
110    * |      | SAD  | VAI  | SAI  | RESET|      |      |  |      |      |      |      |      |      |      |
111    * |------+------+------+------+------+------|------|  |------|------+------+------+------+------+------|
112    * |      | HUD  | VAD  | HUI  |RGBRST|      |      |  |      |      |QWERTY|COLEMK|      |      |      |
113    * |------+------+------+------+------+------+------|  |------+------+------+------+------+------+------|
114    * |      |      |      |      |      |      |      |  |      |      |      |RGBTOG|  HUI |  SAI | VAI  |
115    * |------+------+------+------+------+------+------|  |------+------+------+------+------+------+------|
116    * |      |      |      |RGBMOD(|      |      |      |  |      |      |     |RGBRMOD| HUD |  SAD | VAD  |
117    * `------+------+------+------+------+------+------|  |------+------+------+------+------+------+------'
118    *                                    |      |      |  |      |      |
119    *                                    `-------------'  `-------------'
120    */
121
122   [_ADJ] =  LAYOUT( \
123       KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6, _______, _______,   KC_F7,   KC_F8,   KC_F9,  KC_F10,  KC_F11,  KC_F12, \
124     _______, RGB_SAD, RGB_VAI, RGB_SAI,   RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
125     _______, RGB_HUD, RGB_VAD, RGB_HUI,  RGBRST, _______, _______, _______, _______,  QWERTY, COLEMAK, _______, _______, _______, \
126     _______, RGB_SPD, _______, RGB_SPI, _______, _______, _______, _______, _______, RGB_SPI, RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI, \
127     _______, _______, _______, RGB_MOD, _______, _______, _______, _______, _______, RGB_SPD, RGB_RMOD,RGB_HUD, RGB_SAD, RGB_VAD, \
128                                                  _______, _______, _______, _______ \
129   )
130 };
131
132 // For RGBRST Keycode
133 #if defined(RGB_MATRIX_ENABLE)
134 void rgb_matrix_increase_flags(void)
135 {
136     switch (rgb_matrix_get_flags()) {
137         case LED_FLAG_ALL: {
138             rgb_matrix_set_flags(LED_FLAG_KEYLIGHT | LED_FLAG_MODIFIER);
139             rgb_matrix_set_color_all(0, 0, 0);
140             }
141             break;
142         case LED_FLAG_KEYLIGHT | LED_FLAG_MODIFIER: {
143             rgb_matrix_set_flags(LED_FLAG_UNDERGLOW);
144             rgb_matrix_set_color_all(0, 0, 0);
145             }
146             break;
147         case LED_FLAG_UNDERGLOW: {
148             rgb_matrix_set_flags(LED_FLAG_NONE);
149             rgb_matrix_disable_noeeprom();
150             }
151             break;
152         default: {
153             rgb_matrix_set_flags(LED_FLAG_ALL);
154             rgb_matrix_enable_noeeprom();
155             }
156             break;
157     }
158 }
159
160 void rgb_matrix_decrease_flags(void)
161 {
162     switch (rgb_matrix_get_flags()) {
163         case LED_FLAG_ALL: {
164             rgb_matrix_set_flags(LED_FLAG_NONE);
165             rgb_matrix_disable_noeeprom();
166             }
167             break;
168         case LED_FLAG_KEYLIGHT | LED_FLAG_MODIFIER: {
169             rgb_matrix_set_flags(LED_FLAG_ALL);
170             rgb_matrix_set_color_all(0, 0, 0);
171             }
172             break;
173         case LED_FLAG_UNDERGLOW: {
174             rgb_matrix_set_flags(LED_FLAG_KEYLIGHT | LED_FLAG_MODIFIER);
175             rgb_matrix_set_color_all(0, 0, 0);
176             }
177             break;
178         default: {
179             rgb_matrix_set_flags(LED_FLAG_UNDERGLOW);
180             rgb_matrix_enable_noeeprom();
181             }
182             break;
183     }
184 }
185 #endif
186
187 #ifdef RGB_OLED_MENU
188 uint8_t rgb_encoder_state = 4;
189
190 typedef void (*rgb_matrix_f)(void);
191
192 const rgb_matrix_f rgb_matrix_functions[6][2] = {
193     { rgb_matrix_increase_hue, rgb_matrix_decrease_hue },
194     { rgb_matrix_increase_sat, rgb_matrix_decrease_sat },
195     { rgb_matrix_increase_val, rgb_matrix_decrease_val },
196     { rgb_matrix_increase_speed, rgb_matrix_decrease_speed },
197     { rgb_matrix_step, rgb_matrix_step_reverse },
198     { rgb_matrix_increase_flags, rgb_matrix_decrease_flags }
199 };
200 #endif
201
202 #ifdef ENCODER_ENABLE
203
204 static pin_t encoders_pad_a[] = ENCODERS_PAD_A;
205 #define NUMBER_OF_ENCODERS (sizeof(encoders_pad_a)/sizeof(pin_t))
206
207 const uint16_t PROGMEM encoders[][NUMBER_OF_ENCODERS * 2][2]  = {
208     [_QWERTY] = ENCODER_LAYOUT( \
209         KC_VOLU, KC_VOLD,
210         KC_VOLU, KC_VOLD
211     ),
212     [_COLEMAK] = ENCODER_LAYOUT( \
213         _______, _______,
214         _______, _______
215     ),
216     [_FN] = ENCODER_LAYOUT( \
217         _______, _______,
218         _______, _______
219     ),
220     [_ADJ] = ENCODER_LAYOUT( \
221         _______, _______,
222         _______, _______
223     )
224 };
225
226 void encoder_update_user(uint8_t index, bool clockwise) {
227   if (!is_keyboard_master())
228     return;
229
230 #ifdef RGB_OLED_MENU
231   if (index == RGB_OLED_MENU) {
232     (*rgb_matrix_functions[rgb_encoder_state][clockwise])();
233   } else
234 #endif
235   {
236     uint8_t layer = biton32(layer_state);
237     uint16_t keycode = encoders[layer][index][clockwise];
238     while (keycode == KC_TRANSPARENT && layer > 0)
239     {
240       layer--;
241       if ((layer_state & (1 << layer)) != 0)
242           keycode = encoders[layer][index][clockwise];
243     }
244     if (keycode != KC_TRANSPARENT)
245       tap_code16(keycode);
246   }
247 }
248 #endif
249
250 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
251   static uint16_t reset_timer;
252   switch (keycode) {
253     case RGBRST:
254 #if defined(RGBLIGHT_ENABLE)
255         if (record->event.pressed) {
256           eeconfig_update_rgblight_default();
257           rgblight_enable();
258         }
259 #elif defined(RGB_MATRIX_ENABLE)
260         if (record->event.pressed) {
261           eeconfig_update_rgb_matrix_default();
262         }
263 #endif
264       return false;
265     case RESET:
266       if (record->event.pressed) {
267           reset_timer = timer_read();
268       } else {
269           if (timer_elapsed(reset_timer) >= 500) {
270               reset_keyboard();
271           }
272       }
273       return false;
274 #if defined(RGB_MATRIX_ENABLE) && defined(KEYBOARD_rgbkb_sol_rev2)
275     case RGB_TOG:
276       if (record->event.pressed) {
277         rgb_matrix_increase_flags();
278       }
279       return false;
280 #endif
281     case RGB_MENU:
282 #ifdef RGB_OLED_MENU
283       if (record->event.pressed) {
284         if (get_mods() & MOD_MASK_SHIFT) {
285           rgb_encoder_state = (rgb_encoder_state - 1);
286           if (rgb_encoder_state > 5) {
287             rgb_encoder_state = 5;
288           }
289         } else {
290           rgb_encoder_state = (rgb_encoder_state + 1) % 6;
291         }
292       }
293 #endif
294       return false;
295   }
296   return true;
297 }
298
299 // OLED Driver Logic
300 #ifdef OLED_DRIVER_ENABLE
301 oled_rotation_t oled_init_user(oled_rotation_t rotation) {
302   if (is_keyboard_master())
303     return OLED_ROTATION_90;
304   return rotation;
305 }
306
307 static void render_logo(void) {
308   static const char PROGMEM sol_logo[] = {
309     0x80,0x81,0x82,0x83,0x84,0x85,0x86,0x87,0x88,0x89,0x8a,0x8b,0x8c,0x8d,0x8e,0x8f,0x90,0x91,0x92,0x93,0x94,
310     0xa0,0xa1,0xa2,0xa3,0xa4,0xa5,0xa6,0xa7,0xa8,0xa9,0xaa,0xab,0xac,0xad,0xae,0xaf,0xb0,0xb1,0xb2,0xb3,0xb4,
311     0xc0,0xc1,0xc2,0xc3,0xc4,0xc5,0xc6,0xc7,0xc8,0xc9,0xca,0xcb,0xcc,0xcd,0xce,0xcf,0xd0,0xd1,0xd2,0xd3,0xd4,0
312   };
313   oled_write_P(sol_logo, false);
314 }
315
316 static void render_status(void) {
317   // Render to mode icon
318   static const char PROGMEM sol_icon[] = {
319     0x9b,0x9c,0x9d,0x9e,0x9f,
320     0xbb,0xbc,0xbd,0xbe,0xbf,
321     0xdb,0xdc,0xdd,0xde,0xdf,0
322   };
323   oled_write_P(sol_icon, false);
324
325   // Define layers here
326   oled_write_P(PSTR("Layer"), false);
327   switch (biton32(layer_state)) {
328     case _QWERTY:
329       oled_write_P(PSTR("BASE "), false);
330       break;
331     case _COLEMAK:
332       oled_write_P(PSTR("CLMK "), false);
333       break;
334     case _FN:
335       oled_write_P(PSTR("FN   "), false);
336       break;
337     case _ADJ:
338       oled_write_P(PSTR("ADJ  "), false);
339       break;
340     default:
341       oled_write_P(PSTR("UNDEF"), false);
342   }
343
344   // Host Keyboard LED Status
345     uint8_t led_state = host_keyboard_leds();
346     oled_write_P(PSTR("-----"), false);
347     oled_write_P(IS_LED_ON(led_state, USB_LED_NUM_LOCK) ? PSTR("NUMLK") : PSTR("     "), false);
348     oled_write_P(IS_LED_ON(led_state, USB_LED_CAPS_LOCK) ? PSTR("CAPLK") : PSTR("     "), false);
349     oled_write_P(IS_LED_ON(led_state, USB_LED_SCROLL_LOCK) ? PSTR("SCRLK") : PSTR("     "), false);
350
351 #ifdef RGB_OLED_MENU
352     static char buffer[31] = { 0 };
353     snprintf(buffer, sizeof(buffer), "h%3d s%3d v%3d s%3d m%3d e%3d ", rgb_matrix_config.hsv.h, rgb_matrix_config.hsv.s, rgb_matrix_config.hsv.v, rgb_matrix_config.speed, rgb_matrix_config.mode, rgb_matrix_get_flags());
354     buffer[4 + rgb_encoder_state * 5] = '<';
355
356     oled_write_P(PSTR("-----"), false);
357     oled_write(buffer, false);
358 #endif
359 }
360
361 void oled_task_user(void) {
362   if (is_keyboard_master()) {
363     render_status();
364   } else {
365     render_logo();
366     oled_scroll_left();
367   }
368 }
369
370 #endif