]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/planck/keymaps/dbroqua/keymap.c
Adds support for Planck Rev 6 (#2666)
[qmk_firmware.git] / keyboards / planck / keymaps / dbroqua / keymap.c
1
2 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
3 #include "planck.h"
4 #include "action_layer.h"
5 #ifdef AUDIO_ENABLE
6   #include "audio.h"
7 #endif
8 #include "eeconfig.h"
9
10 extern keymap_config_t keymap_config;
11
12 // Each layer gets a name for readability, which is then used in the keymap matrix below.
13 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
14 // Layer names don't all need to be of the same length, obviously, and you can also skip them
15 // entirely and just use numbers.
16 #define _QWERTY 0
17 #define _LOWER 1
18 #define _RAISE 2
19 #define _MULTIMEDIA 3
20 #define _ADJUST 4
21
22 enum planck_keycodes {
23   QWERTY = SAFE_RANGE,
24   LOWER,
25   RAISE,
26   BACKLIT
27 };
28
29 // Fillers to make layering more clear
30 #define _______ KC_TRNS
31 #define XXXXXXX KC_NO
32
33 // Func macro definitions.
34 #define SFT_TAB  FUNC(0) // Tap for Enter, hold for Shift
35
36 // Enable these functions using FUNC(n) macro.
37 const uint16_t PROGMEM fn_actions[] = {
38     [0] = ACTION_LAYER_TAP_KEY(_MULTIMEDIA, KC_TAB)
39  };
40
41 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
42
43 /* Qwerty
44  * ,-----------------------------------------------------------------------------------.
45  * | Esc  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
46  * |------+------+------+------+------+------+------+------+------+------+------+------|
47  * | Tab  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
48  * |------+------+------+------+------+------+------+------+------+------+------+------|
49  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
50  * |------+------+------+------+------+------+------+------+------+------+------+------|
51  * | Ctrl | GUI  | AltGr| Alt  | Lower|    Space    | Raise| Left | Down |  Up  |Right |
52  * `-----------------------------------------------------------------------------------'
53  */
54 [_QWERTY] = {
55   {KC_ESC,  KC_Q,       KC_W,       KC_E,       KC_R,   KC_T,   KC_Y,   KC_U,   KC_I,    KC_O,    KC_P,    KC_BSPC},
56   {SFT_TAB, KC_A,       KC_S,       KC_D,       KC_F,   KC_G,   KC_H,   KC_J,   KC_K,    KC_L,    KC_SCLN, KC_QUOT},
57   {KC_LSFT, KC_Z,       KC_X,       KC_C,       KC_V,   KC_B,   KC_N,   KC_M,   KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
58   {KC_LCTL, KC_LGUI,    KC_RALT,    KC_LALT,    LOWER,  KC_SPC, KC_SPC, RAISE,  KC_LEFT, KC_DOWN, KC_UP,   KC_RIGHT}
59 },
60
61 /* Lower
62  * ,-----------------------------------------------------------------------------------.
63  * |      |      |      |      |      |      |      |      |      |      |   (  |   )  |
64  * |------+------+------+------+------+------+------+------+------+------+------+------|
65  * | Brite|      |      |      |      |      |      |      |      |      |   {  |   }  |
66  * |------+------+------+------+------+------+------+------+------+------+------+------|
67  * |      |      |      |      |      |      |      |      |      |      |   [  |   ]  |
68  * |------+------+------+------+------+------+------+------+------+------+------+------|
69  * |      |      |      |      |      |             |      | Home | PgDwn| PgUp | End  |
70  * `-----------------------------------------------------------------------------------'
71  */
72 [_LOWER] = {
73   {_______, _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,    KC_LPRN,  KC_RPRN},
74   {BACKLIT, _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,    KC_LCBR,  KC_RCBR},
75   {_______, _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,    KC_LBRC,  KC_RBRC},
76   {_______, _______,  _______,  _______,  _______,  _______,  _______,  _______,  KC_HOME,  KC_PGDN,    KC_PGUP,  KC_END}
77 },
78
79 /* Raise
80  * ,-----------------------------------------------------------------------------------.
81  * |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |  10  |   -  |   =  |
82  * |------+------+------+------+------+------+------+------+------+------+------+------|
83  * |      |      |      |      |      |      |      |      |      |      |      |  `   |
84  * |------+------+------+------+------+------+------+------+------+------+------+------|
85  * |      |      |      |      |      |      |      |      |      |      |   \  |      |
86  * |------+------+------+------+------+------+------+------+------+------+------+------|
87  * |      |      |      |      |      |             |      |      |      |      |      |
88  * `-----------------------------------------------------------------------------------'
89  */
90 [_RAISE] = {
91   {KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL},
92   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_GRV},
93   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_BSLS, _______},
94   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
95 },
96
97 /* _MULTIMEDIA
98  * ,-----------------------------------------------------------------------------------.
99  * |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  | F10  | F11  | F12  |
100  * |------+------+------+------+------+------+------+------+------+------+------+------|
101  * |      |      |      |      |      |      |      |  Psc |      |      |      |      |
102  * |------+------+------+------+------+------+------+------+------+------+------+------|
103  * |      |      |      |      |      | Mute | Vol+ | Vol- |      |      |      |Insert|
104  * |------+------+------+------+------+------+------+------+------+------+------+------|
105  * |      |      |      |      |      |             |      | Prev | Play | Next |  Del |
106  * `-----------------------------------------------------------------------------------'
107  */
108 [_MULTIMEDIA] = {
109   {KC_F1,   KC_F2,      KC_F3,      KC_F4,      KC_F5,      KC_F6,      KC_F7,      KC_F8,      KC_F9,      KC_F10,     KC_F11,     KC_F12},
110   {_______, _______,    _______,    _______,    _______,    _______,    _______,    KC_PSCR,    _______,    _______,    _______,    _______},
111   {_______, _______,    _______,    _______,    _______,    KC_MUTE,    KC_VOLU,    KC_VOLD,    _______,    _______,    _______,    KC_INS},
112   {_______, _______,    _______,    _______,    _______,    _______,    _______,    _______,    KC_MPRV,    KC_MPLY,    KC_MNXT,    KC_DEL}
113 },
114
115
116 /* Adjust (Lower + Raise)
117  * ,-----------------------------------------------------------------------------------.
118  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
119  * |------+------+------+------+------+------+------+------+------+------+------+------|
120  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|      |      |      |      |
121  * |------+------+------+------+------+------+------+------+------+------+------+------|
122  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
123  * |------+------+------+------+------+------+------+------+------+------+------+------|
124  * |      |      |      |      |      |             |      |      |      |      |      |
125  * `-----------------------------------------------------------------------------------'
126  */
127 [_ADJUST] = {
128   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
129   {_______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  _______, _______, _______, _______},
130   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
131   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
132 }
133
134
135 };
136
137 #ifdef AUDIO_ENABLE
138
139 float tone_startup[][2]    = SONG(STARTUP_SOUND);
140 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
141 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
142 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
143 float tone_plover[][2]     = SONG(PLOVER_SOUND);
144 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
145 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
146
147 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
148 #endif
149
150
151 void persistent_default_layer_set(uint16_t default_layer) {
152   eeconfig_update_default_layer(default_layer);
153   default_layer_set(default_layer);
154 }
155
156 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
157   switch (keycode) {
158     case QWERTY:
159       if (record->event.pressed) {
160         #ifdef AUDIO_ENABLE
161           PLAY_SONG(tone_qwerty);
162         #endif
163         persistent_default_layer_set(1UL<<_QWERTY);
164       }
165       return false;
166       break;
167     case LOWER:
168       if (record->event.pressed) {
169         layer_on(_LOWER);
170         update_tri_layer(_LOWER, _RAISE, _ADJUST);
171       } else {
172         layer_off(_LOWER);
173         update_tri_layer(_LOWER, _RAISE, _ADJUST);
174       }
175       return false;
176       break;
177     case RAISE:
178       if (record->event.pressed) {
179         layer_on(_RAISE);
180         update_tri_layer(_LOWER, _RAISE, _ADJUST);
181       } else {
182         layer_off(_RAISE);
183         update_tri_layer(_LOWER, _RAISE, _ADJUST);
184       }
185       return false;
186       break;
187     case BACKLIT:
188       if (record->event.pressed) {
189         register_code(KC_RSFT);
190         #ifdef BACKLIGHT_ENABLE
191           backlight_step();
192         #endif
193       } else {
194         unregister_code(KC_RSFT);
195       }
196       return false;
197       break;
198   }
199   return true;
200 }
201
202 void matrix_init_user(void) {
203     #ifdef AUDIO_ENABLE
204         startup_user();
205     #endif
206 }
207
208 #ifdef AUDIO_ENABLE
209
210 void startup_user()
211 {
212     _delay_ms(20); // gets rid of tick
213     PLAY_SONG(tone_startup);
214 }
215
216 void shutdown_user()
217 {
218     PLAY_SONG(tone_goodbye);
219     _delay_ms(150);
220     stop_all_notes();
221 }
222
223 void music_on_user(void)
224 {
225     music_scale_user();
226 }
227
228 void music_scale_user(void)
229 {
230     PLAY_SONG(music_scale);
231 }
232
233 #endif