keymap.c (14121B)
1 /* Copyright 2015-2021 Jack Humbert 2 * 3 * This program is free software: you can redistribute it and/or modify 4 * it under the terms of the GNU General Public License as published by 5 * the Free Software Foundation, either version 2 of the License, or 6 * (at your option) any later version. 7 * 8 * This program is distributed in the hope that it will be useful, 9 * but WITHOUT ANY WARRANTY; without even the implied warranty of 10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 * GNU General Public License for more details. 12 * 13 * You should have received a copy of the GNU General Public License 14 * along with this program. If not, see <http://www.gnu.org/licenses/>. 15 */ 16 17 #include QMK_KEYBOARD_H 18 19 #ifdef AUDIO_ENABLE 20 # include "muse.h" 21 #endif 22 23 enum planck_layers { 24 _QWERTY, 25 _COLEMAK, 26 _DVORAK, 27 _LOWER, 28 _RAISE, 29 _PLOVER, 30 _ADJUST 31 }; 32 33 enum planck_keycodes { 34 PLOVER = SAFE_RANGE, 35 BACKLIT, 36 EXT_PLV 37 }; 38 39 #define LOWER MO(_LOWER) 40 #define RAISE MO(_RAISE) 41 42 #define QWERTY PDF(_QWERTY) 43 #define COLEMAK PDF(_COLEMAK) 44 #define DVORAK PDF(_DVORAK) 45 46 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { 47 48 /* Qwerty 49 * ,-----------------------------------------------------------------------------------. 50 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp | 51 * |------+------+------+------+------+------+------+------+------+------+------+------| 52 * | Esc | A | S | D | F | G | H | J | K | L | ; | ' | 53 * |------+------+------+------+------+------+------+------+------+------+------+------| 54 * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter | 55 * |------+------+------+------+------+------+------+------+------+------+------+------| 56 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right | 57 * `-----------------------------------------------------------------------------------' 58 */ 59 [_QWERTY] = LAYOUT_planck_grid( 60 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, 61 KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, 62 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT , 63 BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT 64 ), 65 66 /* Colemak 67 * ,-----------------------------------------------------------------------------------. 68 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp | 69 * |------+------+------+------+------+------+------+------+------+------+------+------| 70 * | Esc | A | R | S | T | D | H | N | E | I | O | ' | 71 * |------+------+------+------+------+------+------+------+------+------+------+------| 72 * | Shift| Z | X | C | V | B | K | M | , | . | / |Enter | 73 * |------+------+------+------+------+------+------+------+------+------+------+------| 74 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right | 75 * `-----------------------------------------------------------------------------------' 76 */ 77 [_COLEMAK] = LAYOUT_planck_grid( 78 KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC, 79 KC_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT, 80 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT , 81 BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT 82 ), 83 84 /* Dvorak 85 * ,-----------------------------------------------------------------------------------. 86 * | Tab | ' | , | . | P | Y | F | G | C | R | L | Bksp | 87 * |------+------+------+------+------+------+------+------+------+------+------+------| 88 * | Esc | A | O | E | U | I | D | H | T | N | S | / | 89 * |------+------+------+------+------+------+------+------+------+------+------+------| 90 * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter | 91 * |------+------+------+------+------+------+------+------+------+------+------+------| 92 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right | 93 * `-----------------------------------------------------------------------------------' 94 */ 95 [_DVORAK] = LAYOUT_planck_grid( 96 KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC, 97 KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH, 98 KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT , 99 BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT 100 ), 101 102 /* Lower 103 * ,-----------------------------------------------------------------------------------. 104 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp | 105 * |------+------+------+------+------+------+------+------+------+------+------+------| 106 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | | 107 * |------+------+------+------+------+------+------+------+------+------+------+------| 108 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | Home | End | | 109 * |------+------+------+------+------+------+------+------+------+------+------+------| 110 * | | | | | | | | Next | Vol- | Vol+ | Play | 111 * `-----------------------------------------------------------------------------------' 112 */ 113 [_LOWER] = LAYOUT_planck_grid( 114 KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC, 115 KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE, 116 _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END, _______, 117 _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY 118 ), 119 120 /* Raise 121 * ,-----------------------------------------------------------------------------------. 122 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp | 123 * |------+------+------+------+------+------+------+------+------+------+------+------| 124 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ | 125 * |------+------+------+------+------+------+------+------+------+------+------+------| 126 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / |Pg Up |Pg Dn | | 127 * |------+------+------+------+------+------+------+------+------+------+------+------| 128 * | | | | | | | | Next | Vol- | Vol+ | Play | 129 * `-----------------------------------------------------------------------------------' 130 */ 131 [_RAISE] = LAYOUT_planck_grid( 132 KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC, 133 KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS, 134 _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______, 135 _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY 136 ), 137 138 /* Plover layer (http://opensteno.org) 139 * ,-----------------------------------------------------------------------------------. 140 * | # | # | # | # | # | # | # | # | # | # | # | # | 141 * |------+------+------+------+------+------+------+------+------+------+------+------| 142 * | | S | T | P | H | * | * | F | P | L | T | D | 143 * |------+------+------+------+------+------+------+------+------+------+------+------| 144 * | | S | K | W | R | * | * | R | B | G | S | Z | 145 * |------+------+------+------+------+------+------+------+------+------+------+------| 146 * | Exit | | | A | O | | E | U | | | | 147 * `-----------------------------------------------------------------------------------' 148 */ 149 [_PLOVER] = LAYOUT_planck_grid( 150 KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 , 151 XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, 152 XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, 153 EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX 154 ), 155 156 /* Adjust (Lower + Raise) 157 * v------------------------RGB CONTROL--------------------v 158 * ,-----------------------------------------------------------------------------------. 159 * | | Reset|Debug | RGB |RGBMOD| HUE+ | HUE- | SAT+ | SAT- |BRGTH+|BRGTH-| Del | 160 * |------+------+------+------+------+------+------+------+------+------+------+------| 161 * | | |MUSmod|Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| | 162 * |------+------+------+------+------+------+------+------+------+------+------+------| 163 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | | 164 * |------+------+------+------+------+------+------+------+------+------+------+------| 165 * | | | | | | | | | | | | 166 * `-----------------------------------------------------------------------------------' 167 */ 168 [_ADJUST] = LAYOUT_planck_grid( 169 _______, QK_BOOT, DB_TOGG, UG_TOGG, UG_NEXT, UG_HUEU, UG_HUED, UG_SATU, UG_SATD, UG_VALU, UG_VALD, KC_DEL , 170 _______, _______, MU_NEXT, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______, 171 _______, AU_PREV, AU_NEXT, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______, 172 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ 173 ) 174 175 }; 176 177 #ifdef AUDIO_ENABLE 178 float plover_song[][2] = SONG(PLOVER_SOUND); 179 float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND); 180 #endif 181 182 layer_state_t layer_state_set_user(layer_state_t state) { 183 return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST); 184 } 185 186 bool process_record_user(uint16_t keycode, keyrecord_t *record) { 187 switch (keycode) { 188 case BACKLIT: 189 if (record->event.pressed) { 190 register_code(KC_RSFT); 191 #ifdef BACKLIGHT_ENABLE 192 backlight_step(); 193 #endif 194 #ifdef KEYBOARD_planck_rev5 195 gpio_write_pin_low(E6); 196 #endif 197 } else { 198 unregister_code(KC_RSFT); 199 #ifdef KEYBOARD_planck_rev5 200 gpio_write_pin_high(E6); 201 #endif 202 } 203 return false; 204 break; 205 case PLOVER: 206 if (record->event.pressed) { 207 #ifdef AUDIO_ENABLE 208 stop_all_notes(); 209 PLAY_SONG(plover_song); 210 #endif 211 layer_off(_RAISE); 212 layer_off(_LOWER); 213 layer_off(_ADJUST); 214 layer_on(_PLOVER); 215 if (!eeconfig_is_enabled()) { 216 eeconfig_init(); 217 } 218 eeconfig_read_keymap(&keymap_config); 219 keymap_config.nkro = 1; 220 eeconfig_update_keymap(&keymap_config); 221 } 222 return false; 223 break; 224 case EXT_PLV: 225 if (record->event.pressed) { 226 #ifdef AUDIO_ENABLE 227 PLAY_SONG(plover_gb_song); 228 #endif 229 layer_off(_PLOVER); 230 } 231 return false; 232 break; 233 } 234 return true; 235 } 236 237 bool muse_mode = false; 238 uint8_t last_muse_note = 0; 239 uint16_t muse_counter = 0; 240 uint8_t muse_offset = 70; 241 uint16_t muse_tempo = 50; 242 243 bool encoder_update_user(uint8_t index, bool clockwise) { 244 if (muse_mode) { 245 if (IS_LAYER_ON(_RAISE)) { 246 if (clockwise) { 247 muse_offset++; 248 } else { 249 muse_offset--; 250 } 251 } else { 252 if (clockwise) { 253 muse_tempo+=1; 254 } else { 255 muse_tempo-=1; 256 } 257 } 258 } else { 259 if (clockwise) { 260 #ifdef MOUSEKEY_ENABLE 261 tap_code(MS_WHLD); 262 #else 263 tap_code(KC_PGDN); 264 #endif 265 } else { 266 #ifdef MOUSEKEY_ENABLE 267 tap_code(MS_WHLU); 268 #else 269 tap_code(KC_PGUP); 270 #endif 271 } 272 } 273 return true; 274 } 275 276 bool dip_switch_update_user(uint8_t index, bool active) { 277 switch (index) { 278 case 0: { 279 #ifdef AUDIO_ENABLE 280 static bool play_sound = false; 281 #endif 282 if (active) { 283 #ifdef AUDIO_ENABLE 284 if (play_sound) { PLAY_SONG(plover_song); } 285 #endif 286 layer_on(_ADJUST); 287 } else { 288 #ifdef AUDIO_ENABLE 289 if (play_sound) { PLAY_SONG(plover_gb_song); } 290 #endif 291 layer_off(_ADJUST); 292 } 293 #ifdef AUDIO_ENABLE 294 play_sound = true; 295 #endif 296 break; 297 } 298 case 1: 299 if (active) { 300 muse_mode = true; 301 } else { 302 muse_mode = false; 303 } 304 } 305 return true; 306 } 307 308 void matrix_scan_user(void) { 309 #ifdef AUDIO_ENABLE 310 if (muse_mode) { 311 if (muse_counter == 0) { 312 uint8_t muse_note = muse_offset + SCALE[muse_clock_pulse()]; 313 if (muse_note != last_muse_note) { 314 stop_note(compute_freq_for_midi_note(last_muse_note)); 315 play_note(compute_freq_for_midi_note(muse_note), 0xF); 316 last_muse_note = muse_note; 317 } 318 } 319 muse_counter = (muse_counter + 1) % muse_tempo; 320 } else { 321 if (muse_counter) { 322 stop_all_notes(); 323 muse_counter = 0; 324 } 325 } 326 #endif 327 } 328 329 bool music_mask_user(uint16_t keycode) { 330 switch (keycode) { 331 case RAISE: 332 case LOWER: 333 return false; 334 default: 335 return true; 336 } 337 }