mirror of
https://github.com/qmk/qmk_firmware
synced 2024-11-15 16:35:15 +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
307 lines
10 KiB
C
307 lines
10 KiB
C
/* Copyright 2021 Gun Pinyo
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include QMK_KEYBOARD_H
|
|
|
|
extern keymap_config_t keymap_config;
|
|
|
|
enum planck_layers {
|
|
LY_0000, LY_0001, LY_0010, LY_0011,
|
|
LY_0100, LY_0101, LY_0110, LY_0111,
|
|
LY_1000, LY_1001, LY_1010, LY_1011,
|
|
LY_1100, LY_1101, LY_1110, LY_1111,
|
|
LY_THAI_A, LY_THAI_B, LY_THAI_C,
|
|
LY_SANDBOX, LY_STICK,
|
|
};
|
|
|
|
enum planck_keycodes {
|
|
MIN_KC = SAFE_RANGE,
|
|
FUNC_A, FUNC_B, FUNC_C, FUNC_D,
|
|
SANDBOX, STICK,
|
|
LTHAI_A, LTHAI_B, LTHAI_C,
|
|
LSW0110, LSW1111, LSW0100,
|
|
USER_NAME, USER_EMAIL,
|
|
MAX_KC,
|
|
DYNAMIC_MACRO_RANGE,
|
|
};
|
|
|
|
#define KC_L2_0 KC_LSFT
|
|
#define KC_L3_0 KC_LCTL
|
|
#define KC_L3_1 KC_LALT
|
|
#define KC_L3_2 KC_LGUI
|
|
|
|
#define KC_R2_1 FUNC_A
|
|
#define KC_R2_2 FUNC_B
|
|
#define KC_R2_3 FUNC_C
|
|
#define KC_R2_4 FUNC_D
|
|
|
|
#define KC_R2_5 KC_RSFT
|
|
#define KC_R3_0 KC_R2_4
|
|
#define KC_R3_1 KC_SPC
|
|
|
|
#define LAYOUT_gunp( k00, k01, k02, k03, k04, k05, \
|
|
k10, k11, k12, k13, k14, k15, \
|
|
k20, k21, k22, k23, k24, k25, \
|
|
k30, k31, k32, k33, k34, k35) \
|
|
LAYOUT_ortho_4x12( \
|
|
k00,k01,k02,k03,k04,k05, LSW0110, KC_LEFT, KC_BSPC, KC_RIGHT,XXXXXXX, XXXXXXX,\
|
|
k10,k11,k12,k13,k14,k15, LSW1111, LTHAI_A, LTHAI_B, LTHAI_C, XXXXXXX, XXXXXXX,\
|
|
k20,k21,k22,k23,k24,k25, LSW0100, KC_R2_1, KC_R2_2, KC_R2_3, KC_R2_4, KC_R2_5,\
|
|
k30,k31,k32,k33,k34,k35, KC_R3_0, KC_R3_1, KC_ENT, KC_RGUI, KC_RALT, KC_RCTL)
|
|
|
|
#define UNUSED_LAYER LAYOUT_gunp(\
|
|
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,\
|
|
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,\
|
|
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,\
|
|
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX),
|
|
|
|
#define F1_F12_LAYER(M) LAYOUT_gunp(\
|
|
S(M(KC_F7 )), S(M(KC_F8 )), M(KC_F7 ), M(KC_F8 ), M(KC_F9 ), S(M(KC_F9 )),\
|
|
S(M(KC_F4 )), S(M(KC_F5 )), M(KC_F4 ), M(KC_F5 ), M(KC_F6 ), S(M(KC_F6 )),\
|
|
S(M(KC_F1 )), S(M(KC_F2 )), M(KC_F1 ), M(KC_F2 ), M(KC_F3 ), S(M(KC_F3 )),\
|
|
S(M(KC_F10)), S(M(KC_F11)), M(KC_F10), M(KC_F11), M(KC_F12), S(M(KC_F12))),
|
|
|
|
#define MC(kc) LCTL(kc)
|
|
#define MA(kc) LALT(kc)
|
|
#define MG(kc) LGUI(kc)
|
|
#define MSC(kc) LSFT(LCTL(kc))
|
|
|
|
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
|
[LY_0000] = LAYOUT_ortho_4x12(
|
|
KC_PGUP, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_K, KC_TAB,
|
|
KC_PGDN, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, STICK,
|
|
KC_L2_0, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_M,
|
|
KC_R2_1, KC_R2_2, KC_R2_3, KC_UP, KC_R2_5,
|
|
KC_L3_0, KC_L3_1, KC_L3_2, KC_ESCAPE, KC_BSPC, KC_ENTER,
|
|
KC_R3_0, KC_R3_1, KC_PSCR, KC_LEFT, KC_DOWN, KC_RIGHT
|
|
),
|
|
[LY_1000] = LAYOUT_gunp(
|
|
XXXXXXX, KC_PERC, KC_QUES, KC_EXLM, KC_GRV, XXXXXXX,
|
|
XXXXXXX, KC_AT, KC_COMM, KC_DOT, KC_QUOT, KC_EQL,
|
|
KC_L2_0, KC_DLR, KC_SCLN, KC_COLN, KC_DQUO, KC_UNDS,
|
|
KC_L3_0, KC_L3_1, KC_L3_2, XXXXXXX, XXXXXXX, XXXXXXX
|
|
),
|
|
[LY_0010] = LAYOUT_gunp(
|
|
XXXXXXX, KC_AMPR, KC_PIPE, KC_TILD, KC_CIRC, XXXXXXX,
|
|
XXXXXXX, KC_LCBR, KC_LBRC, KC_LPRN, KC_LT, KC_SLSH,
|
|
KC_L2_0, KC_RCBR, KC_RBRC, KC_RPRN, KC_GT, KC_BSLS,
|
|
KC_L3_0, KC_L3_1, KC_L3_2, XXXXXXX, XXXXXXX, XXXXXXX
|
|
),
|
|
[LY_1010] = LAYOUT_gunp(
|
|
XXXXXXX, KC_HASH, KC_7, KC_8, KC_9, XXXXXXX,
|
|
XXXXXXX, KC_ASTR, KC_4, KC_5, KC_6, KC_PLUS,
|
|
KC_L2_0, KC_0, KC_1, KC_2, KC_3, KC_MINS,
|
|
KC_L3_0, KC_L3_1, KC_L3_2, XXXXXXX, XXXXXXX, XXXXXXX
|
|
),
|
|
[LY_0100] = LAYOUT_gunp(
|
|
XXXXXXX, MC(KC_G), KC_HOME, KC_UP, KC_END, MC(KC_UP),
|
|
XXXXXXX, KC_PGUP, KC_LEFT, KC_DOWN, KC_RIGHT, MC(KC_DOWN),
|
|
XXXXXXX, KC_PGDN, MC(KC_S), MC(KC_A), MC(KC_Z), MSC(KC_Z),
|
|
XXXXXXX, XXXXXXX, MC(KC_LEFT), MC(KC_F), MC(KC_RIGHT), XXXXXXX
|
|
),
|
|
[LY_1100] = LAYOUT_gunp(
|
|
XXXXXXX, MSC(KC_G), S(KC_HOME), S(KC_UP), S(KC_END), MSC(KC_UP),
|
|
XXXXXXX, S(KC_PGUP), S(KC_LEFT), S(KC_DOWN), S(KC_RIGHT), MSC(KC_DOWN),
|
|
XXXXXXX, S(KC_PGDN), MC(KC_X), MC(KC_C), MC(KC_V), MC(KC_L),
|
|
XXXXXXX, XXXXXXX, MSC(KC_LEFT), MC(KC_R), MSC(KC_RIGHT), XXXXXXX
|
|
),
|
|
[LY_0110] = F1_F12_LAYER()
|
|
[LY_1110] = F1_F12_LAYER(MG)
|
|
|
|
[LY_0001] = LAYOUT_gunp(
|
|
MC(KC_H), MC(KC_0), MSC(KC_PGUP), KC_BRIU, MSC(KC_PGDN), KC_VOLU,
|
|
MSC(KC_T), MC(KC_PLUS), MC(KC_PGUP), KC_BRID, MC(KC_PGDN), KC_VOLD,
|
|
OSM(MOD_LSFT), MC(KC_MINS), MA(KC_LEFT), MC(KC_T), MA(KC_RIGHT), KC_MUTE,
|
|
OSM(MOD_LCTL), OSM(MOD_LALT), OSM(MOD_LGUI), MC(KC_W), KC_DELETE, KC_APP
|
|
),
|
|
[LY_1101] = LAYOUT_gunp(
|
|
SANDBOX, XXXXXXX, AU_TOG, KC_LOCK, RGB_TOG, QK_BOOT,
|
|
KC_WAKE, KC_CAPS, USER_NAME, USER_EMAIL, RGB_MOD, DB_TOGG,
|
|
KC_SLEP, KC_NUM, DM_REC1, DM_PLY1, XXXXXXX, EEP_RST,
|
|
KC_PWR, KC_SCRL, DM_REC2, DM_PLY2, DM_RSTP, KC_INSERT
|
|
),
|
|
[LY_1111] = LAYOUT_gunp(
|
|
KC_ACL1, KC_ACL0, KC_WH_L, KC_MS_U, KC_WH_R, KC_WH_U,
|
|
KC_ACL2, XXXXXXX, KC_MS_L, KC_MS_D, KC_MS_R, KC_WH_D,
|
|
KC_MPRV, KC_BTN5, KC_MRWD, KC_MPLY, KC_MFFD, KC_BTN3,
|
|
KC_MNXT, KC_BTN4, KC_PAUSE, KC_MSTP, KC_BTN1, KC_BTN2
|
|
),
|
|
[LY_0111] = UNUSED_LAYER
|
|
[LY_1011] = UNUSED_LAYER
|
|
|
|
[LY_1001] = UNUSED_LAYER
|
|
[LY_0101] = UNUSED_LAYER
|
|
[LY_0011] = UNUSED_LAYER
|
|
|
|
/* mapping from US QWERTY to TH Kedmanee */
|
|
[LY_THAI_A] = LAYOUT_gunp(
|
|
S(KC_G), KC_PIPE, KC_8, KC_COMM, S(KC_A), KC_QUES,
|
|
S(KC_I), KC_SCLN, KC_QUOT, KC_O, KC_I, KC_RBRC,
|
|
S(KC_P), S(KC_T), KC_M, KC_P, KC_EQL, KC_COLN,
|
|
KC_LT, S(KC_S), S(KC_R), KC_GT, KC_R, KC_A
|
|
),
|
|
[LY_THAI_B] = LAYOUT_gunp(
|
|
S(KC_N), S(KC_H), KC_J, KC_H, S(KC_U), S(KC_J),
|
|
S(KC_F), KC_C, KC_G, KC_K, KC_Y, KC_T,
|
|
KC_DOT, KC_W, KC_B, KC_U, KC_7, KC_N,
|
|
KC_1, S(KC_B), S(KC_Y), KC_E, KC_6, KC_CIRC
|
|
),
|
|
[LY_THAI_C] = LAYOUT_gunp(
|
|
KC_4, KC_BSLS, KC_MINS, S(KC_V), S(KC_E), S(KC_D),
|
|
KC_5, KC_0, KC_D, KC_V, KC_F, KC_9,
|
|
S(KC_L), S(KC_K), KC_L, KC_S, KC_LBRC, KC_X,
|
|
S(KC_O), KC_Q, KC_LCBR, S(KC_C), KC_Z, KC_SLSH
|
|
),
|
|
[LY_SANDBOX] = LAYOUT_ortho_4x12(
|
|
KC_LCBR, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_K, KC_RCBR,
|
|
KC_LBRC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_RBRC,
|
|
KC_LPRN,KC_Z,KC_X,KC_C,KC_V,KC_B,KC_M,KC_COMM,KC_DOT,KC_SCLN,KC_COLN,KC_RPRN,
|
|
KC_LT , KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_GT
|
|
),
|
|
[LY_STICK] = UNUSED_LAYER // as a gateway to other persistant layers
|
|
};
|
|
|
|
#define NUM_LANGS 2
|
|
#define LANG_ENG 0
|
|
#define LANG_THAI 1
|
|
|
|
uint16_t cur_layer = LY_0000;
|
|
uint16_t cur_lang = LANG_ENG;
|
|
bool is_layer_persistant = false;
|
|
|
|
void change_layer(uint16_t new_layer) {
|
|
if(cur_layer != new_layer) {
|
|
layer_off(cur_layer);
|
|
layer_on(new_layer);
|
|
cur_layer = new_layer;
|
|
}
|
|
}
|
|
|
|
void change_lang(uint16_t lang) {
|
|
while(lang != cur_lang) {
|
|
SEND_STRING(SS_LGUI(" "));
|
|
cur_lang = (cur_lang + 1) % NUM_LANGS;
|
|
}
|
|
}
|
|
|
|
void user_panic(void) {
|
|
SEND_STRING("Planck Keyboard: User Panic!");
|
|
}
|
|
|
|
void update_env_thai(void) {
|
|
if(LY_THAI_A <= cur_layer && cur_layer <= LY_THAI_C) {
|
|
change_lang(LANG_THAI);
|
|
} else {
|
|
change_lang(LANG_ENG);
|
|
}
|
|
}
|
|
|
|
uint16_t get_persistant_layer_from_keycode(uint16_t keycode) {
|
|
switch(keycode) {
|
|
case FUNC_A: return LY_1000;
|
|
case FUNC_B: return LY_1010;
|
|
case FUNC_C: return LY_0010;
|
|
case FUNC_D: return LY_0000;
|
|
case LTHAI_A: return LY_THAI_A;
|
|
case LTHAI_B: return LY_THAI_B;
|
|
case LTHAI_C: return LY_THAI_C;
|
|
case LSW0110: return LY_0110;
|
|
case LSW1111: return LY_1111;
|
|
case LSW0100: return LY_0100;
|
|
}
|
|
return 0; // this line is unreachable but be here to make the complier happy
|
|
}
|
|
|
|
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
|
|
|
|
if(!is_layer_persistant && FUNC_A <= keycode && keycode <= FUNC_D) {
|
|
uint16_t mask = 1 << (3 - (keycode - FUNC_A));
|
|
uint16_t cur_layer_code = cur_layer - LY_0000;
|
|
if(!(LY_0000 <= cur_layer && cur_layer <= LY_1111))
|
|
user_panic();
|
|
if(!(cur_layer_code & mask) == record->event.pressed)
|
|
change_layer((mask ^ cur_layer_code) + LY_0000);
|
|
return false;
|
|
}
|
|
|
|
if(!(record->event.pressed))
|
|
return !(MIN_KC <= keycode && keycode <= MAX_KC);
|
|
|
|
switch(keycode) {
|
|
case USER_NAME:
|
|
SEND_STRING("Gun Pinyo");
|
|
return false;
|
|
|
|
case USER_EMAIL:
|
|
SEND_STRING("gunpinyo@gmail.com");
|
|
return false;
|
|
|
|
case SANDBOX:
|
|
case STICK:
|
|
change_layer(keycode == STICK ? LY_STICK : LY_SANDBOX);
|
|
change_lang(LANG_ENG);
|
|
is_layer_persistant = true;
|
|
return false;
|
|
|
|
case FUNC_A: case FUNC_B: case FUNC_C: case FUNC_D:
|
|
case LTHAI_A: case LTHAI_B: case LTHAI_C:
|
|
case LSW0110: case LSW1111: case LSW0100:
|
|
if(is_layer_persistant) {
|
|
change_layer(get_persistant_layer_from_keycode(keycode));
|
|
update_env_thai();
|
|
// `FUNC_D` resets the layer configuration when `is_layer_persistant`
|
|
is_layer_persistant = keycode != FUNC_D;
|
|
if(!is_layer_persistant) {
|
|
clear_keyboard();
|
|
layer_clear();
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
#ifdef RGB_MATRIX_ENABLE
|
|
bool rgb_matrix_indicators_user(void) {
|
|
// `42` is the index of the middle light at the bottom row (in planck light)
|
|
// it is disabled because it does not have a cover, hence irritates my eyes
|
|
rgb_matrix_set_color(42, 0, 0, 0);
|
|
return false;
|
|
}
|
|
#endif
|
|
|
|
#ifdef AUDIO_ENABLE
|
|
float tone_startup[][2] = SONG(STARTUP_SOUND);
|
|
float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
|
|
|
|
float tone_ly_normal[][2] = SONG(QWERTY_SOUND);
|
|
float tone_ly_spacial[][2] = SONG(DVORAK_SOUND);
|
|
|
|
float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
|
|
#endif
|
|
|
|
void startup_user() {
|
|
#ifdef AUDIO_ENABLE
|
|
PLAY_SONG(tone_startup);
|
|
#endif
|
|
}
|
|
|
|
void shutdown_user() {
|
|
#ifdef AUDIO_ENABLE
|
|
PLAY_SONG(tone_goodbye);
|
|
stop_all_notes();
|
|
#endif
|
|
}
|