mirror of
https://github.com/qmk/qmk_firmware
synced 2024-11-13 23:44:54 +00:00
18dc851e37
* `DEBUG` -> `DB_TOGG`, default-ish keymaps * `DEBUG` -> `DB_TOGG`, user keymaps * `DEBUG` -> `DB_TOGG`, community layouts * `DEBUG` -> `DB_TOGG`, userspace * `DEBUG` -> `DB_TOGG`, docs & core
450 lines
18 KiB
C
450 lines
18 KiB
C
#include QMK_KEYBOARD_H
|
|
#include "muse.h"
|
|
|
|
|
|
enum planck_layers {
|
|
_QWERTY,
|
|
_COLEMAK,
|
|
_DVORAK,
|
|
_LOWER,
|
|
_RAISE,
|
|
_PLOVER,
|
|
_ADJUST,
|
|
|
|
_FN1,
|
|
_DPAD,
|
|
_DPADNUM
|
|
};
|
|
|
|
enum planck_keycodes {
|
|
QWERTY = SAFE_RANGE,
|
|
COLEMAK,
|
|
DVORAK,
|
|
PLOVER,
|
|
BACKLIT,
|
|
EXT_PLV,
|
|
|
|
DP_ON,
|
|
DP_OFF
|
|
};
|
|
|
|
#define LOWER MO(_LOWER)
|
|
#define RAISE MO(_RAISE)
|
|
#define SPACEFN LT(_FN1, KC_SPC)
|
|
|
|
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
|
|
|
/* Qwerty
|
|
* ,-----------------------------------------------------------------------------------.
|
|
* | ESC | Q | W | E | R | T | Y | U | I | O | P | Bksp |
|
|
* |------+------+------+------+------+-------------+------+------+------+------+------|
|
|
* | Tab | A | S | D | F | G | H | J | K | L | ; | " |
|
|
* |------+------+------+------+------+------|------+------+------+------+------+------|
|
|
* | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
|
|
* |------+------+------+------+------+------+------+------+------+------+------+------|
|
|
* | App | Ctrl | GUI | Alt |Lower | SpaceFn |Raise | Left | Down | Up |Right |
|
|
* `-----------------------------------------------------------------------------------'
|
|
*/
|
|
[_QWERTY] = LAYOUT_ortho_4x12(
|
|
KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
|
|
KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
|
|
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, RSFT_T(KC_ENT),
|
|
KC_APP, KC_LCTL, KC_LGUI, KC_LALT, LOWER, SPACEFN, SPACEFN, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RIGHT
|
|
),
|
|
|
|
/* Colemak
|
|
* ,-----------------------------------------------------------------------------------.
|
|
* | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
|
|
* |------+------+------+------+------+-------------+------+------+------+------+------|
|
|
* | Esc | A | R | S | T | D | H | N | E | I | O | " |
|
|
* |------+------+------+------+------+------|------+------+------+------+------+------|
|
|
* | Shift| Z | X | C | V | B | K | M | , | . | / |Enter |
|
|
* |------+------+------+------+------+------+------+------+------+------+------+------|
|
|
* | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
|
|
* `-----------------------------------------------------------------------------------'
|
|
*/
|
|
[_COLEMAK] = LAYOUT_ortho_4x12(
|
|
KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC,
|
|
KC_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT,
|
|
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT ,
|
|
BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
|
|
),
|
|
|
|
/* Dvorak
|
|
* ,-----------------------------------------------------------------------------------.
|
|
* | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
|
|
* |------+------+------+------+------+-------------+------+------+------+------+------|
|
|
* | Esc | A | O | E | U | I | D | H | T | N | S | / |
|
|
* |------+------+------+------+------+------|------+------+------+------+------+------|
|
|
* | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
|
|
* |------+------+------+------+------+------+------+------+------+------+------+------|
|
|
* | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
|
|
* `-----------------------------------------------------------------------------------'
|
|
*/
|
|
[_DVORAK] = LAYOUT_ortho_4x12(
|
|
KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC,
|
|
KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH,
|
|
KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT ,
|
|
BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
|
|
),
|
|
|
|
/* Lower
|
|
* ,-----------------------------------------------------------------------------------.
|
|
* | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | |
|
|
* |------+------+------+------+------+-------------+------+------+------+------+------|
|
|
* | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
|
|
* |------+------+------+------+------+------|------+------+------+------+------+------|
|
|
* | | F7 | F8 | F9 | F10 | F11 | F12 | | | | | |
|
|
* |------+------+------+------+------+------+------+------+------+------+------+------|
|
|
* | | | | | | | | Next | Vol- | Vol+ | Play |
|
|
* `-----------------------------------------------------------------------------------'
|
|
*/
|
|
[_LOWER] = LAYOUT_ortho_4x12(
|
|
KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, _______,
|
|
KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
|
|
_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______, _______, _______, _______,
|
|
_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
|
|
),
|
|
|
|
/* Raise
|
|
* ,-----------------------------------------------------------------------------------.
|
|
* | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | |
|
|
* |------+------+------+------+------+-------------+------+------+------+------+------|
|
|
* | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
|
|
* |------+------+------+------+------+------|------+------+------+------+------+------|
|
|
* | | F7 | F8 | F9 | F10 | F11 | F12 | | | | | |
|
|
* |------+------+------+------+------+------+------+------+------+------+------+------|
|
|
* | | | | | | | | Next | Vol- | Vol+ | Play |
|
|
* `-----------------------------------------------------------------------------------'
|
|
*/
|
|
[_RAISE] = LAYOUT_ortho_4x12(
|
|
KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, _______,
|
|
KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,
|
|
_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______, _______, _______, _______,
|
|
_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
|
|
),
|
|
|
|
/* Plover layer (http://opensteno.org)
|
|
* ,-----------------------------------------------------------------------------------.
|
|
* | # | # | # | # | # | # | # | # | # | # | # | # |
|
|
* |------+------+------+------+------+-------------+------+------+------+------+------|
|
|
* | | S | T | P | H | * | * | F | P | L | T | D |
|
|
* |------+------+------+------+------+------|------+------+------+------+------+------|
|
|
* | | S | K | W | R | * | * | R | B | G | S | Z |
|
|
* |------+------+------+------+------+------+------+------+------+------+------+------|
|
|
* | Exit | | | A | O | | E | U | | | |
|
|
* `-----------------------------------------------------------------------------------'
|
|
*/
|
|
|
|
[_PLOVER] = LAYOUT_ortho_4x12(
|
|
KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 ,
|
|
XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC,
|
|
XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
|
|
EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX
|
|
),
|
|
|
|
/* Adjust (Lower + Raise)
|
|
* ,-----------------------------------------------------------------------------------.
|
|
* | | Reset| | | | | | | | | | Del |
|
|
* |------+------+------+------+------+-------------+------+------+------+------+------|
|
|
* | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
|
|
* |------+------+------+------+------+------|------+------+------+------+------+------|
|
|
* | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
|
|
* |------+------+------+------+------+------+------+------+------+------+------+------|
|
|
* | | | | | | | | | | | |
|
|
* `-----------------------------------------------------------------------------------'
|
|
*/
|
|
[_ADJUST] = LAYOUT_ortho_4x12(
|
|
_______, QK_BOOT, DB_TOGG, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, KC_DEL ,
|
|
_______, _______, MU_MOD, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______,
|
|
_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______,
|
|
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
|
|
),
|
|
|
|
// Two personal additional layers below
|
|
|
|
/* Personal custom Fn layer
|
|
* ,-----------------------------------------------------------------------------------.
|
|
* | | Vol+ | PgUp | Up | PdDn | Ins | | | Up | | PScr | |
|
|
* |------+------+------+------+------+-------------+------+------+------+------+------|
|
|
* | | Vol- | Left | Down | Right| Home | | Left | Down |Right | | Del |
|
|
* |------+------+------+------+------+------|------+------+------+------+------+------|
|
|
* | | Prev | Play | Next | Brite| End | | | Vol- | Vol+ | Mute | |
|
|
* |------+------+------+------+------+------+------+------+------+------+------+------|
|
|
* | Caps | | | | | Space | | DP_ON| | | |
|
|
* `-----------------------------------------------------------------------------------'
|
|
*/
|
|
[_FN1] = LAYOUT_ortho_4x12(
|
|
_______, KC_VOLU, KC_PGUP, KC_UP, KC_PGDN, KC_INS, _______, _______, KC_UP, _______, KC_PSCR, _______,
|
|
_______, KC_VOLD, KC_LEFT, KC_DOWN, KC_RGHT, KC_HOME, _______, KC_LEFT, KC_DOWN, KC_RGHT, _______, KC_DEL ,
|
|
_______, KC_MPRV, KC_MPLY, KC_MNXT, BACKLIT, KC_END, _______, _______, KC_VOLD, KC_VOLU, KC_MUTE, _______,
|
|
KC_CAPS, _______, _______, _______, _______, _______, _______, _______, DP_ON, _______, _______, _______
|
|
),
|
|
|
|
/* DPAD layer, to activate arrow cluster at the bottom right corner
|
|
|
|
* ,-----------------------------------------------------------------------------------.
|
|
* | ESC | Q | W | E | R | T | Y | U | I | O | P | Bksp |
|
|
* |------+------+------+------+------+-------------+------+------+------+------+------|
|
|
* | Tab | A | S | D | F | G | H | J | K | L | ; | " |
|
|
* |------+------+------+------+------+------|------+------+------+------+------+------|
|
|
* | Shift| Z | X | C | V | B | N | M | , | . | Up |Enter |
|
|
* |------+------+------+------+------+------+------+------+------+------+------+------|
|
|
* | Ctrl | GUI | Alt | |DNUM | Space | |DP_OFF| Left | Down |Right |
|
|
* `-----------------------------------------------------------------------------------'
|
|
*/
|
|
|
|
[_DPAD] = LAYOUT_ortho_4x12(
|
|
KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
|
|
KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
|
|
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_UP, KC_ENT ,
|
|
KC_LCTL, KC_LGUI, KC_LALT, XXXXXXX, MO(_DPADNUM),
|
|
KC_SPC, KC_SPC, LOWER, DP_OFF, KC_LEFT, KC_DOWN, KC_RGHT
|
|
),
|
|
|
|
// Extended layer for weapon switching
|
|
|
|
[_DPADNUM] = LAYOUT_ortho_4x12(
|
|
XXXXXXX, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, XXXXXXX,
|
|
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6,
|
|
_______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,
|
|
_______, _______, _______, XXXXXXX, MO(_DPADNUM),
|
|
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
|
|
)
|
|
|
|
|
|
};
|
|
|
|
#ifdef AUDIO_ENABLE
|
|
float plover_song[][2] = SONG(PLOVER_SOUND);
|
|
float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
|
|
|
|
// Borrowing audio from unused audio
|
|
// Caps Lock on and off sound too similar
|
|
|
|
float caps_song_on[][2] = SONG(NUM_LOCK_ON_SOUND);
|
|
float caps_song_off[][2] = SONG(SCROLL_LOCK_ON_SOUND);
|
|
|
|
float dpad_song_on[][2] = SONG(ODE_TO_JOY);
|
|
float dpad_song_off[][2] = SONG(UNICODE_WINDOWS);
|
|
#endif
|
|
|
|
// Disable LED on Rev6
|
|
#ifdef KEYBOARD_planck_rev6
|
|
layer_state_t layer_state_set_user(layer_state_t state) {
|
|
return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
|
|
}
|
|
|
|
#else
|
|
|
|
layer_state_t layer_state_set_user(layer_state_t state) {
|
|
// LED control, lighting up when Fn layer is activated
|
|
state = update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
|
|
# ifdef BACKLIGHT_ENABLE
|
|
switch (get_highest_layer(state)) {
|
|
case _QWERTY:
|
|
backlight_set(0);
|
|
break;
|
|
case _FN1:
|
|
backlight_set(3);
|
|
break;
|
|
case _DPAD:
|
|
backlight_set(3);
|
|
break;
|
|
}
|
|
# endif
|
|
return state;
|
|
}
|
|
|
|
#endif
|
|
|
|
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
|
|
switch (keycode) {
|
|
case QWERTY:
|
|
if (record->event.pressed) {
|
|
print("mode just switched to qwerty and this is a huge string\n");
|
|
set_single_persistent_default_layer(_QWERTY);
|
|
}
|
|
return false;
|
|
break;
|
|
case COLEMAK:
|
|
if (record->event.pressed) {
|
|
set_single_persistent_default_layer(_COLEMAK);
|
|
}
|
|
return false;
|
|
break;
|
|
case DVORAK:
|
|
if (record->event.pressed) {
|
|
set_single_persistent_default_layer(_DVORAK);
|
|
}
|
|
return false;
|
|
break;
|
|
case BACKLIT:
|
|
if (record->event.pressed) {
|
|
register_code(KC_RSFT);
|
|
#ifdef BACKLIGHT_ENABLE
|
|
backlight_step();
|
|
#endif
|
|
#ifdef KEYBOARD_planck_rev5
|
|
writePinLow(E6);
|
|
#endif
|
|
} else {
|
|
unregister_code(KC_RSFT);
|
|
#ifdef KEYBOARD_planck_rev5
|
|
writePinHigh(E6);
|
|
#endif
|
|
}
|
|
return false;
|
|
break;
|
|
case PLOVER:
|
|
if (record->event.pressed) {
|
|
#ifdef AUDIO_ENABLE
|
|
stop_all_notes();
|
|
PLAY_SONG(plover_song);
|
|
#endif
|
|
layer_off(_RAISE);
|
|
layer_off(_LOWER);
|
|
layer_off(_ADJUST);
|
|
layer_on(_PLOVER);
|
|
if (!eeconfig_is_enabled()) {
|
|
eeconfig_init();
|
|
}
|
|
keymap_config.raw = eeconfig_read_keymap();
|
|
keymap_config.nkro = 1;
|
|
eeconfig_update_keymap(keymap_config.raw);
|
|
}
|
|
return false;
|
|
break;
|
|
case EXT_PLV:
|
|
if (record->event.pressed) {
|
|
#ifdef AUDIO_ENABLE
|
|
PLAY_SONG(plover_gb_song);
|
|
#endif
|
|
layer_off(_PLOVER);
|
|
}
|
|
return false;
|
|
break;
|
|
|
|
|
|
// Play audio upon switching Caps Lock and custom layers
|
|
|
|
case KC_CAPS:
|
|
if (record->event.pressed) {
|
|
#ifdef AUDIO_ENABLE
|
|
if (host_keyboard_led_state().caps_lock) {
|
|
PLAY_SONG(caps_song_off);
|
|
} else {
|
|
PLAY_SONG(caps_song_on);
|
|
}
|
|
#endif
|
|
}
|
|
return true;
|
|
|
|
case DP_ON:
|
|
if (record->event.pressed) {
|
|
|
|
} else {
|
|
#ifdef AUDIO_ENABLE
|
|
PLAY_SONG(dpad_song_on);
|
|
#endif
|
|
|
|
layer_off(_FN1);
|
|
layer_on(_DPAD);
|
|
}
|
|
|
|
case DP_OFF:
|
|
if (record->event.pressed) {
|
|
#ifdef AUDIO_ENABLE
|
|
PLAY_SONG(dpad_song_off);
|
|
#endif
|
|
|
|
layer_off(_DPAD);
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
bool muse_mode = false;
|
|
uint8_t last_muse_note = 0;
|
|
uint16_t muse_counter = 0;
|
|
uint8_t muse_offset = 70;
|
|
uint16_t muse_tempo = 50;
|
|
|
|
bool encoder_update_user(uint8_t index, bool clockwise) {
|
|
if (muse_mode) {
|
|
if (IS_LAYER_ON(_RAISE)) {
|
|
if (clockwise) {
|
|
muse_offset++;
|
|
} else {
|
|
muse_offset--;
|
|
}
|
|
} else {
|
|
if (clockwise) {
|
|
muse_tempo+=1;
|
|
} else {
|
|
muse_tempo-=1;
|
|
}
|
|
}
|
|
} else {
|
|
if (clockwise) {
|
|
tap_code(KC_PGDN);
|
|
} else {
|
|
tap_code(KC_PGUP);
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
bool dip_switch_update_user(uint8_t index, bool active) {
|
|
switch (index) {
|
|
case 0:
|
|
if (active) {
|
|
#ifdef AUDIO_ENABLE
|
|
PLAY_SONG(plover_song);
|
|
#endif
|
|
layer_on(_ADJUST);
|
|
} else {
|
|
#ifdef AUDIO_ENABLE
|
|
PLAY_SONG(plover_gb_song);
|
|
#endif
|
|
layer_off(_ADJUST);
|
|
}
|
|
break;
|
|
case 1:
|
|
if (active) {
|
|
muse_mode = true;
|
|
} else {
|
|
muse_mode = false;
|
|
#ifdef AUDIO_ENABLE
|
|
stop_all_notes();
|
|
#endif
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
void matrix_scan_user(void) {
|
|
#ifdef AUDIO_ENABLE
|
|
if (muse_mode) {
|
|
if (muse_counter == 0) {
|
|
uint8_t muse_note = muse_offset + SCALE[muse_clock_pulse()];
|
|
if (muse_note != last_muse_note) {
|
|
stop_note(compute_freq_for_midi_note(last_muse_note));
|
|
play_note(compute_freq_for_midi_note(muse_note), 0xF);
|
|
last_muse_note = muse_note;
|
|
}
|
|
}
|
|
muse_counter = (muse_counter + 1) % muse_tempo;
|
|
}
|
|
#endif
|
|
}
|
|
|
|
bool music_mask_user(uint16_t keycode) {
|
|
switch (keycode) {
|
|
case RAISE:
|
|
case LOWER:
|
|
return false;
|
|
default:
|
|
return true;
|
|
}
|
|
}
|