mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-11-23 11:52:59 +00:00
e885c793bc
* Add Function level EEPROM configuration Add kb and user functions for EEPROM, and example of how to use it. * Bug fixes and demo * Additional cleanup * Add EEPROM reset macro to example * Forgot init function in list * Move eeconfig_init_quantum function to quantum.c and actually set default layer * See if removing weak quantum function fixes issue * Fix travis compile error * Remove ifdef blocks from EECONFIG so settings are always set * Fix for ARM EEPROM updates * Fix merge issues * Fix potential STM32 EEPROM issues
272 lines
13 KiB
C
272 lines
13 KiB
C
#include QMK_KEYBOARD_H
|
|
#include "version.h"
|
|
|
|
#define BASE 0 // default layer
|
|
#define SYMB 1 // symbols
|
|
#define MDIA 2 // media keys
|
|
|
|
enum custom_keycodes {
|
|
PLACEHOLDER = SAFE_RANGE, // can always be here
|
|
EPRM,
|
|
VRSN,
|
|
RGB_SLD,
|
|
RGB_LYR
|
|
};
|
|
|
|
typedef union {
|
|
uint32_t raw;
|
|
struct {
|
|
bool rgb_layer_change :1;
|
|
};
|
|
} user_config_t;
|
|
|
|
user_config_t user_config;
|
|
|
|
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
|
/* Keymap 0: Basic layer
|
|
*
|
|
* ,--------------------------------------------------. ,--------------------------------------------------.
|
|
* | = | 1 | 2 | 3 | 4 | 5 | LEFT | | RIGHT| 6 | 7 | 8 | 9 | 0 | - |
|
|
* |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
|
|
* | Del | Q | W | E | R | T | L1 | | L1 | Y | U | I | O | P | \ |
|
|
* |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
|
|
* | BkSp | A | S | D | F | G |------| |------| H | J | K | L |; / L2|' / Cmd |
|
|
* |--------+------+------+------+------+------| Hyper| | Meh |------+------+------+------+------+--------|
|
|
* | LShift |Z/Ctrl| X | C | V | B | | | | N | M | , | . |//Ctrl| RShift |
|
|
* `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
|
|
* |Grv/L1| '" |AltShf| Left | Right| | Up | Down | [ | ] | ~L1 |
|
|
* `----------------------------------' `----------------------------------'
|
|
* ,-------------. ,-------------.
|
|
* | App | LGui | | Alt |Ctrl/Esc|
|
|
* ,------|------|------| |------+--------+------.
|
|
* | | | Home | | PgUp | | |
|
|
* | Space|Backsp|------| |------| Tab |Enter |
|
|
* | |ace | End | | PgDn | | |
|
|
* `--------------------' `----------------------'
|
|
*/
|
|
// If it accepts an argument (i.e, is a function), it doesn't need KC_.
|
|
// Otherwise, it needs KC_*
|
|
[BASE] = LAYOUT_ergodox( // layer 0 : default
|
|
// left hand
|
|
KC_EQL, KC_1, KC_2, KC_3, KC_4, KC_5, KC_LEFT,
|
|
KC_DELT, KC_Q, KC_W, KC_E, KC_R, KC_T, TG(SYMB),
|
|
KC_BSPC, KC_A, KC_S, KC_D, KC_F, KC_G,
|
|
KC_LSFT, CTL_T(KC_Z), KC_X, KC_C, KC_V, KC_B, ALL_T(KC_NO),
|
|
LT(SYMB,KC_GRV),KC_QUOT, LALT(KC_LSFT), KC_LEFT,KC_RGHT,
|
|
ALT_T(KC_APP), KC_LGUI,
|
|
KC_HOME,
|
|
KC_SPC,KC_BSPC,KC_END,
|
|
// right hand
|
|
KC_RGHT, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS,
|
|
TG(SYMB), KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSLS,
|
|
KC_H, KC_J, KC_K, KC_L, LT(MDIA, KC_SCLN),GUI_T(KC_QUOT),
|
|
MEH_T(KC_NO),KC_N, KC_M, KC_COMM,KC_DOT, CTL_T(KC_SLSH), KC_RSFT,
|
|
KC_UP, KC_DOWN,KC_LBRC,KC_RBRC, TT(SYMB),
|
|
KC_LALT, CTL_T(KC_ESC),
|
|
KC_PGUP,
|
|
KC_PGDN,KC_TAB, KC_ENT
|
|
),
|
|
/* Keymap 1: Symbol Layer
|
|
*
|
|
* ,---------------------------------------------------. ,--------------------------------------------------.
|
|
* |Version | F1 | F2 | F3 | F4 | F5 | | | | F6 | F7 | F8 | F9 | F10 | F11 |
|
|
* |---------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
|
|
* | | ! | @ | { | } | | | | | | Up | 7 | 8 | 9 | * | F12 |
|
|
* |---------+------+------+------+------+------| | | |------+------+------+------+------+--------|
|
|
* | | # | $ | ( | ) | ` |------| |------| Down | 4 | 5 | 6 | + | |
|
|
* |---------+------+------+------+------+------| | | |------+------+------+------+------+--------|
|
|
* | | % | ^ | [ | ] | ~ | | | | & | 1 | 2 | 3 | \ | |
|
|
* `---------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
|
|
* | EPRM | | | | | | | . | 0 | = | |
|
|
* `-----------------------------------' `----------------------------------'
|
|
* ,-------------. ,-------------.
|
|
* |Animat| LYR | |Toggle|Solid |
|
|
* ,------|------|------| |------+------+------.
|
|
* |Bright|Bright| | | |Hue- |Hue+ |
|
|
* |ness- |ness+ |------| |------| | |
|
|
* | | | | | | | |
|
|
* `--------------------' `--------------------'
|
|
*/
|
|
// SYMBOLS
|
|
[SYMB] = LAYOUT_ergodox(
|
|
// left hand
|
|
VRSN, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_TRNS,
|
|
RESET, KC_EXLM,KC_AT, KC_LCBR,KC_RCBR,KC_PIPE,KC_TRNS,
|
|
KC_TRNS,KC_HASH,KC_DLR, KC_LPRN,KC_RPRN,KC_GRV,
|
|
EPRM,KC_PERC,KC_CIRC,KC_LBRC,KC_RBRC,KC_TILD,KC_TRNS,
|
|
KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,
|
|
RGB_MOD,RGB_LYR,
|
|
KC_TRNS,
|
|
RGB_VAD,RGB_VAI,KC_TRNS,
|
|
// right hand
|
|
KC_TRNS, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11,
|
|
KC_TRNS, KC_UP, KC_7, KC_8, KC_9, KC_ASTR, KC_F12,
|
|
KC_DOWN, KC_4, KC_5, KC_6, KC_PLUS, KC_TRNS,
|
|
KC_TRNS, KC_AMPR, KC_1, KC_2, KC_3, KC_BSLS, KC_TRNS,
|
|
KC_TRNS,KC_DOT, KC_0, KC_EQL, KC_TRNS,
|
|
RGB_TOG, RGB_SLD,
|
|
KC_TRNS,
|
|
KC_TRNS, RGB_HUD, RGB_HUI
|
|
),
|
|
/* Keymap 2: Media and mouse keys
|
|
*
|
|
* ,--------------------------------------------------. ,--------------------------------------------------.
|
|
* | | | | | | | | | | | | | | | |
|
|
* |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
|
|
* | | | | MsUp | | | | | | | | | | | |
|
|
* |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
|
|
* | | |MsLeft|MsDown|MsRght| |------| |------| | | | | | Play |
|
|
* |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
|
|
* | | | | | | | | | | | | Prev | Next | | |
|
|
* `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
|
|
* | | | | Lclk | Rclk | |VolUp |VolDn | Mute | | |
|
|
* `----------------------------------' `----------------------------------'
|
|
* ,-------------. ,-------------.
|
|
* | | | | | |
|
|
* ,------|------|------| |------+------+------.
|
|
* | | | | | | |Brwser|
|
|
* | | |------| |------| |Back |
|
|
* | | | | | | | |
|
|
* `--------------------' `--------------------'
|
|
*/
|
|
// MEDIA AND MOUSE
|
|
[MDIA] = LAYOUT_ergodox(
|
|
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
|
|
KC_TRNS, KC_TRNS, KC_TRNS, KC_MS_U, KC_TRNS, KC_TRNS, KC_TRNS,
|
|
KC_TRNS, KC_TRNS, KC_MS_L, KC_MS_D, KC_MS_R, KC_TRNS,
|
|
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
|
|
KC_TRNS, KC_TRNS, KC_TRNS, KC_BTN1, KC_BTN2,
|
|
KC_TRNS, KC_TRNS,
|
|
KC_TRNS,
|
|
KC_TRNS, KC_TRNS, KC_TRNS,
|
|
// right hand
|
|
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
|
|
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
|
|
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MPLY,
|
|
KC_TRNS, KC_TRNS, KC_TRNS, KC_MPRV, KC_MNXT, KC_TRNS, KC_TRNS,
|
|
KC_VOLU, KC_VOLD, KC_MUTE, KC_TRNS, KC_TRNS,
|
|
KC_TRNS, KC_TRNS,
|
|
KC_TRNS,
|
|
KC_TRNS, KC_TRNS, KC_WBAK
|
|
),
|
|
};
|
|
|
|
void eeconfig_init_user(void) {
|
|
rgblight_enable();
|
|
rgblight_sethsv_cyan();
|
|
rgblight_mode(1);
|
|
user_config.rgb_layer_change = true;
|
|
eeconfig_update_user(user_config.raw);
|
|
}
|
|
|
|
|
|
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
|
|
switch (keycode) {
|
|
// dynamically generate these.
|
|
case EPRM:
|
|
if (record->event.pressed) {
|
|
eeconfig_init();
|
|
}
|
|
return false;
|
|
break;
|
|
case VRSN:
|
|
if (record->event.pressed) {
|
|
SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
|
|
}
|
|
return false;
|
|
break;
|
|
case RGB_SLD:
|
|
if (record->event.pressed) {
|
|
#ifdef RGBLIGHT_ENABLE
|
|
rgblight_mode(1);
|
|
#endif
|
|
}
|
|
return false;
|
|
break;
|
|
case RGB_LYR: // This allows me to use underglow as layer indication, or as normal
|
|
if (record->event.pressed) {
|
|
user_config.rgb_layer_change ^= 1; // Toggles the status
|
|
eeconfig_update_user(user_config.raw); // Writes the new status to EEPROM
|
|
if (user_config.rgb_layer_change) { // if layer state indication is enabled,
|
|
layer_state_set(layer_state); // then immediately update the layer color
|
|
}
|
|
}
|
|
return false; break;
|
|
case RGB_MODE_FORWARD ... RGB_MODE_GRADIENT: // For any of the RGB codes (see quantum_keycodes.h, L400 for reference)
|
|
if (record->event.pressed) { //This disables layer indication, as it's assumed that if you're changing this ... you want that disabled
|
|
if (user_config.rgb_layer_change) { // only if this is enabled
|
|
user_config.rgb_layer_change = false; // disable it, and
|
|
eeconfig_update_user(user_config.raw); // write the setings to EEPROM
|
|
}
|
|
}
|
|
return true; break;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
void matrix_init_user(void) {
|
|
// Call the keymap level matrix init.
|
|
|
|
// Read the user config from EEPROM
|
|
user_config.raw = eeconfig_read_user();
|
|
|
|
// Set default layer, if enabled
|
|
if (user_config.rgb_layer_change) {
|
|
rgblight_enable_noeeprom();
|
|
rgblight_sethsv_noeeprom_cyan();
|
|
rgblight_mode_noeeprom(1);
|
|
}
|
|
}
|
|
|
|
// Runs constantly in the background, in a loop.
|
|
void matrix_scan_user(void) {
|
|
|
|
};
|
|
|
|
uint32_t layer_state_set_user(uint32_t state) {
|
|
ergodox_board_led_off();
|
|
ergodox_right_led_1_off();
|
|
ergodox_right_led_2_off();
|
|
ergodox_right_led_3_off();
|
|
switch (biton32(state)) {
|
|
case SYMB:
|
|
ergodox_right_led_1_on();
|
|
if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_red(); rgblight_mode_noeeprom(1); }
|
|
break;
|
|
case MDIA:
|
|
ergodox_right_led_2_on();
|
|
if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_green(); rgblight_mode_noeeprom(1); }
|
|
break;
|
|
case 3:
|
|
ergodox_right_led_3_on();
|
|
if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_blue(); rgblight_mode_noeeprom(1); }
|
|
break;
|
|
case 4:
|
|
ergodox_right_led_1_on();
|
|
ergodox_right_led_2_on();
|
|
if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_orange(); rgblight_mode_noeeprom(1); }
|
|
break;
|
|
case 5:
|
|
ergodox_right_led_1_on();
|
|
ergodox_right_led_3_on();
|
|
if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_yellow(); rgblight_mode_noeeprom(1); }
|
|
break;
|
|
case 6:
|
|
ergodox_right_led_2_on();
|
|
ergodox_right_led_3_on();
|
|
if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_pink(); rgblight_mode_noeeprom(1); }
|
|
break;
|
|
case 7:
|
|
ergodox_right_led_1_on();
|
|
ergodox_right_led_2_on();
|
|
ergodox_right_led_3_on();
|
|
if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_white(); rgblight_mode_noeeprom(1); }
|
|
break;
|
|
default: // for any other layers, or the default layer
|
|
if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_cyan(); rgblight_mode_noeeprom(1); }
|
|
break;
|
|
}
|
|
return state;
|
|
}
|
|
|