mirror of
https://github.com/Keychron/qmk_firmware.git
synced 2024-11-28 03:26:51 +06:00
4e1c5887c5
* add docs * core changes * update keyboards to new OLED * updated users to new OLED * update layouts to new OLED * fixup docs * drashna's suggestion * fix up docs * new keyboards with oled * core split changes * remaining keyboard files * Fix The Helix keyboards oled options * reflect develop Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: mtei <2170248+mtei@users.noreply.github.com>
314 lines
19 KiB
C
314 lines
19 KiB
C
/* Copyright 2019 Thomas Baart <thomas@splitkb.com>
|
|
*
|
|
* 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
|
|
|
|
enum layers {
|
|
QWERTY,
|
|
LOWER,
|
|
RAISE,
|
|
NAV,
|
|
ADJUST
|
|
};
|
|
|
|
enum custom_keycodes {
|
|
KC_LBR = SAFE_RANGE,
|
|
KC_RBR
|
|
};
|
|
|
|
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
|
/*
|
|
* Base Layer: QWERTY
|
|
*
|
|
* ,-------------------------------------------. ,-------------------------------------------.
|
|
* | TAB | Q | W | E | R | T | | Y | U | I | O | P | RCTL |
|
|
* |--------+------+------+------+------+------| |------+------+------+------+------+--------|
|
|
* | LCTL | A | S | D | F | G | | H | J | K | L | ; : | ' " |
|
|
* |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
|
|
* | LSFT | Z | X | C | V | B | Del | Raise| |Adjust| Esc | N | M | , < | . > | / ? | LSFT |
|
|
* `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
|
|
* | | LALT | | Bspc | Lower| | Enter| Space| [ { | ] } | |
|
|
* | | | | | | | | | | | |
|
|
* `----------------------------------' `----------------------------------'
|
|
*/
|
|
[QWERTY] = LAYOUT(
|
|
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_RCTL,
|
|
KC_LCTL, 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_DEL, MO(RAISE), MO(ADJUST), KC_ESC, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_LSFT,
|
|
XXXXXXX, KC_LALT, XXXXXXX, KC_BSPC, MO(LOWER), KC_ENT, KC_SPC, KC_LBR, KC_RBR, XXXXXXX
|
|
),
|
|
/*
|
|
* Lower Layer: Numbers, functions, symbols
|
|
*
|
|
* ,-------------------------------------------. ,-------------------------------------------.
|
|
* | | 1 ! | 2 @ | 3 # | 4 $ | 5 % | | 6 ^ | 7 & | 8 * | 9 ( | 0 ) | |
|
|
* |--------+------+------+------+------+------| |------+------+------+------+------+--------|
|
|
* | | ! | @ | # | $ | % | | ^ | & | * | ( | ) | |
|
|
* |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
|
|
* | | F1 | F2 | F3 | F4 | F5 | | | | | | F6 | F7 | F8 | F9 | F10 | |
|
|
* `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
|
|
* | | | | | | | | | ( | ) | |
|
|
* | | | | | | | | | | | |
|
|
* `----------------------------------' `----------------------------------'
|
|
*/
|
|
[LOWER] = LAYOUT(
|
|
_______, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, _______,
|
|
_______, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, _______,
|
|
_______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, _______, _______, _______, _______, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, _______,
|
|
_______, _______, _______, _______, _______, _______, _______, KC_LPRN, KC_RPRN, _______
|
|
),
|
|
/*
|
|
* Raise Layer: Functions, Numbers
|
|
*
|
|
* ,-------------------------------------------. ,-------------------------------------------.
|
|
* | | | F7 | F8 | F9 | | | | 7 & | 8 * | 9 ( | - _ | |
|
|
* |--------+------+------+------+------+------| |------+------+------+------+------+--------|
|
|
* | | | F4 | F5 | F6 | | | | 4 * | 5 % | 6 ^ | = + | RCTL |
|
|
* |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
|
|
* | | | F1 | F2 | F3 | | | | | | | | 1 ! | 2 @ | 3 # | \ | | |
|
|
* `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
|
|
* | | | | | | | | | 0 ) | | |
|
|
* | | | | | | | | | | | |
|
|
* `----------------------------------' `----------------------------------'
|
|
*/
|
|
[RAISE] = LAYOUT(
|
|
_______, _______, KC_F7, KC_F8, KC_F9, _______, _______, KC_7, KC_8, KC_9, _______, _______,
|
|
_______, _______, KC_F4, KC_F5, KC_F6, _______, _______, KC_4, KC_5, KC_6, _______, KC_RCTL,
|
|
_______, _______, KC_F1, KC_F2, KC_F3, _______, _______, _______, _______, _______, _______, KC_1, KC_2, KC_3, _______, _______,
|
|
_______, _______, _______, _______, _______, _______, _______, KC_0, _______, _______
|
|
),
|
|
/*
|
|
* Navigation Layer
|
|
*
|
|
* ,-------------------------------------------. ,-------------------------------------------.
|
|
* | | | | | | | | | | Up | | | RGBTOG |
|
|
* |--------+------+------+------+------+------| |------+------+------+------+------+--------|
|
|
* | | | | | | | | | Left | Down | Right| | RGBOFF |
|
|
* |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
|
|
* | | | | | | | | | | | | | | | | | RGBON |
|
|
* `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
|
|
* | | | | | | | | | Reset|Debug | |
|
|
* | | | | | | | | | | | |
|
|
* `----------------------------------' `----------------------------------'
|
|
*/
|
|
[ADJUST] = LAYOUT(
|
|
_______, _______, _______, _______, _______, _______, _______, _______, KC_UP, _______, _______, RGB_TOG,
|
|
_______, _______, _______, _______, _______, _______, _______, KC_LEFT, KC_DOWN, KC_RGHT, _______, RGB_HUI,
|
|
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RGB_HUD,
|
|
_______, _______, _______, _______, _______, _______, _______, RESET, DEBUG, _______
|
|
),
|
|
// /*
|
|
// * Layer template
|
|
// *
|
|
// * ,-------------------------------------------. ,-------------------------------------------.
|
|
// * | | | | | | | | | | | | | |
|
|
// * |--------+------+------+------+------+------| |------+------+------+------+------+--------|
|
|
// * | | | | | | | | | | | | | |
|
|
// * |--------+------+------+------+------+------+-------------. ,-------------+------+------+------+------+------+--------|
|
|
// * | | | | | | | | | | | | | | | | | |
|
|
// * `----------------------+------+------+------+------+------| |------+------+------+------+------+----------------------'
|
|
// * | | | | | | | | | | | |
|
|
// * | | | | | | | | | | | |
|
|
// * `----------------------------------' `----------------------------------'
|
|
// */
|
|
// [_LAYERINDEX] = LAYOUT(
|
|
// _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
|
|
// _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
|
|
// _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
|
|
// _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
|
|
// ),
|
|
};
|
|
|
|
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
|
|
switch (keycode) {
|
|
case KC_LBR: {
|
|
if (record->event.pressed) {
|
|
if ((get_mods() & MOD_MASK_SHIFT) == MOD_MASK_SHIFT) {
|
|
register_code(KC_9);
|
|
} else {
|
|
register_code(KC_LBRC);
|
|
}
|
|
} else { // Release the key
|
|
if ((get_mods() & MOD_MASK_SHIFT) == MOD_MASK_SHIFT) {
|
|
unregister_code(KC_9);
|
|
} else {
|
|
unregister_code(KC_LBRC);
|
|
}
|
|
}
|
|
return false;
|
|
break;
|
|
}
|
|
case KC_RBR: {
|
|
if (record->event.pressed) {
|
|
if ((get_mods() & MOD_MASK_SHIFT) == MOD_MASK_SHIFT) {
|
|
register_code(KC_0);
|
|
} else {
|
|
register_code(KC_RBRC);
|
|
}
|
|
} else { // Release the key
|
|
if ((get_mods() & MOD_MASK_SHIFT) == MOD_MASK_SHIFT) {
|
|
unregister_code(KC_0);
|
|
} else {
|
|
unregister_code(KC_RBRC);
|
|
}
|
|
}
|
|
return false;
|
|
break;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
LEADER_EXTERNS();
|
|
|
|
void matrix_scan_user(void) {
|
|
LEADER_DICTIONARY() {
|
|
leading = false;
|
|
leader_end();
|
|
|
|
SEQ_ONE_KEY(KC_F) { // Shift + Ctrl + F
|
|
tap_code16(S(C(KC_F)));
|
|
}
|
|
}
|
|
}
|
|
|
|
#ifdef OLED_ENABLE
|
|
oled_rotation_t oled_init_user(oled_rotation_t rotation) {
|
|
return OLED_ROTATION_180;
|
|
}
|
|
|
|
static void render_kyria_logo(void) {
|
|
static const char PROGMEM kyria_logo[] = {
|
|
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,128,128,192,224,240,112,120, 56, 60, 28, 30, 14, 14, 14, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 14, 14, 14, 30, 28, 60, 56,120,112,240,224,192,128,128, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
|
0, 0, 0, 0, 0, 0, 0,192,224,240,124, 62, 31, 15, 7, 3, 1,128,192,224,240,120, 56, 60, 28, 30, 14, 14, 7, 7,135,231,127, 31,255,255, 31,127,231,135, 7, 7, 14, 14, 30, 28, 60, 56,120,240,224,192,128, 1, 3, 7, 15, 31, 62,124,240,224,192, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
|
0, 0, 0, 0,240,252,255, 31, 7, 1, 0, 0,192,240,252,254,255,247,243,177,176, 48, 48, 48, 48, 48, 48, 48,120,254,135, 1, 0, 0,255,255, 0, 0, 1,135,254,120, 48, 48, 48, 48, 48, 48, 48,176,177,243,247,255,254,252,240,192, 0, 0, 1, 7, 31,255,252,240, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
|
0, 0, 0,255,255,255, 0, 0, 0, 0, 0,254,255,255, 1, 1, 7, 30,120,225,129,131,131,134,134,140,140,152,152,177,183,254,248,224,255,255,224,248,254,183,177,152,152,140,140,134,134,131,131,129,225,120, 30, 7, 1, 1,255,255,254, 0, 0, 0, 0, 0,255,255,255, 0, 0, 0, 0,255,255, 0, 0,192,192, 48, 48, 0, 0,240,240, 0, 0, 0, 0, 0, 0,240,240, 0, 0,240,240,192,192, 48, 48, 48, 48,192,192, 0, 0, 48, 48,243,243, 0, 0, 0, 0, 0, 0, 48, 48, 48, 48, 48, 48,192,192, 0, 0, 0, 0, 0,
|
|
0, 0, 0,255,255,255, 0, 0, 0, 0, 0,127,255,255,128,128,224,120, 30,135,129,193,193, 97, 97, 49, 49, 25, 25,141,237,127, 31, 7,255,255, 7, 31,127,237,141, 25, 25, 49, 49, 97, 97,193,193,129,135, 30,120,224,128,128,255,255,127, 0, 0, 0, 0, 0,255,255,255, 0, 0, 0, 0, 63, 63, 3, 3, 12, 12, 48, 48, 0, 0, 0, 0, 51, 51, 51, 51, 51, 51, 15, 15, 0, 0, 63, 63, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 48, 48, 63, 63, 48, 48, 0, 0, 12, 12, 51, 51, 51, 51, 51, 51, 63, 63, 0, 0, 0, 0, 0,
|
|
0, 0, 0, 0, 15, 63,255,248,224,128, 0, 0, 3, 15, 63,127,255,239,207,141, 13, 12, 12, 12, 12, 12, 12, 12, 30,127,225,128, 0, 0,255,255, 0, 0,128,225,127, 30, 12, 12, 12, 12, 12, 12, 12, 13,141,207,239,255,127, 63, 15, 3, 0, 0,128,224,248,255, 63, 15, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
|
0, 0, 0, 0, 0, 0, 0, 3, 7, 15, 62,124,248,240,224,192,128, 1, 3, 7, 15, 30, 28, 60, 56,120,112,112,224,224,225,231,254,248,255,255,248,254,231,225,224,224,112,112,120, 56, 60, 28, 30, 15, 7, 3, 1,128,192,224,240,248,124, 62, 15, 7, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
|
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 3, 7, 15, 14, 30, 28, 60, 56,120,112,112,112,224,224,224,224,224,224,224,224,224,224,224,224,224,224,224,224,112,112,112,120, 56, 60, 28, 30, 14, 15, 7, 3, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
|
|
};
|
|
oled_write_raw_P(kyria_logo, sizeof(kyria_logo));
|
|
}
|
|
|
|
static void render_qmk_logo(void) {
|
|
static const char PROGMEM qmk_logo[] = {
|
|
0x80,0x81,0x82,0x83,0x84,0x85,0x86,0x87,0x88,0x89,0x8a,0x8b,0x8c,0x8d,0x8e,0x8f,0x90,0x91,0x92,0x93,0x94,
|
|
0xa0,0xa1,0xa2,0xa3,0xa4,0xa5,0xa6,0xa7,0xa8,0xa9,0xaa,0xab,0xac,0xad,0xae,0xaf,0xb0,0xb1,0xb2,0xb3,0xb4,
|
|
0xc0,0xc1,0xc2,0xc3,0xc4,0xc5,0xc6,0xc7,0xc8,0xc9,0xca,0xcb,0xcc,0xcd,0xce,0xcf,0xd0,0xd1,0xd2,0xd3,0xd4,0};
|
|
|
|
oled_write_P(qmk_logo, false);
|
|
}
|
|
|
|
static void render_status(void) {
|
|
// QMK Logo and version information
|
|
render_qmk_logo();
|
|
oled_write_P(PSTR(" Kyria rev1.0\n\n"), false);
|
|
|
|
// Host Keyboard Layer Status
|
|
oled_write_P(PSTR("Layer: "), false);
|
|
switch (get_highest_layer(layer_state)) {
|
|
case QWERTY:
|
|
oled_write_P(PSTR("Default\n"), false);
|
|
break;
|
|
case LOWER:
|
|
oled_write_P(PSTR("Lower\n"), false);
|
|
break;
|
|
case RAISE:
|
|
oled_write_P(PSTR("Raise\n"), false);
|
|
break;
|
|
case NAV:
|
|
oled_write_P(PSTR("Navigation\n"), false);
|
|
break;
|
|
case ADJUST:
|
|
oled_write_P(PSTR("Adjust\n"), false);
|
|
break;
|
|
default:
|
|
oled_write_P(PSTR("Undefined\n"), false);
|
|
}
|
|
|
|
// Host Keyboard LED Status
|
|
led_t led_state = host_keyboard_led_state();
|
|
oled_write_P(led_state.num_lock ? PSTR("NUMLCK ") : PSTR(" "), false);
|
|
oled_write_P(led_state.caps_lock ? PSTR("CAPLCK ") : PSTR(" "), false);
|
|
oled_write_P(led_state.scroll_lock ? PSTR("SCRLCK ") : PSTR(" "), false);
|
|
}
|
|
|
|
void oled_task_user(void) {
|
|
if (is_keyboard_master()) {
|
|
render_status(); // Renders the current keyboard state (layer, lock, caps, scroll, etc)
|
|
} else {
|
|
render_kyria_logo();
|
|
}
|
|
}
|
|
#endif
|
|
|
|
#ifdef ENCODER_ENABLE
|
|
bool encoder_update_user(uint8_t index, bool clockwise) {
|
|
if (index == 0) {
|
|
switch (get_highest_layer(layer_state)) {
|
|
case QWERTY:
|
|
if (clockwise) { // Ctrl + I
|
|
tap_code16(C(KC_I));
|
|
} else { // Shift + F3
|
|
tap_code16(S(KC_F3));
|
|
}
|
|
break;
|
|
case LOWER:
|
|
// History scrubbing. For Adobe products, hold shift while moving
|
|
// backward to go forward instead.
|
|
if (clockwise) {
|
|
tap_code16(C(KC_Y));
|
|
} else {
|
|
tap_code16(C(KC_Z));
|
|
}
|
|
break;
|
|
case RAISE:
|
|
if (clockwise) { // Subscript: CTRL + =
|
|
tap_code16(C(KC_EQL));
|
|
}
|
|
break;
|
|
default:
|
|
// Nothing
|
|
break;
|
|
}
|
|
} else if (index == 1) {
|
|
switch (get_highest_layer(layer_state)) {
|
|
case QWERTY:
|
|
// Scroll by letter horizontally
|
|
if (clockwise) {
|
|
tap_code16(KC_RGHT);
|
|
} else {
|
|
tap_code16(KC_LEFT);
|
|
}
|
|
case LOWER:
|
|
// Nothing
|
|
break;
|
|
case RAISE:
|
|
// Find previous/Find next
|
|
if (clockwise) {
|
|
tap_code(KC_F3);
|
|
} else {
|
|
tap_code16(S(KC_F3));
|
|
}
|
|
default:
|
|
// Nothing
|
|
break;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
#endif
|