feat(q5_max): enable Keychron RGB and fix EEPROM persistence
Enable KEYCHRON_RGB_ENABLE for the Q5 Max, wiring up PER_KEY_RGB and MIXED_RGB effects, and fix a cascade of EEPROM bugs that caused the Launcher-configured RGB mode to revert to the default heatmap on every power cycle and wireless transport change. Keychron RGB enablement: - Add KEYCHRON_RGB_ENABLE = yes to rules.mk - Define default_per_key_led[] and default_region[] for the ANSI Encoder layout in ansi_encoder.c (extern'd by keychron_rgb.c) - Fix missing #include "eeconfig_custom_rgb.h" in mixed_rgb.c and rgb_matrix_kb.inc so EECONFIG_SIZE_CUSTOM_RGB is in scope for the compile guards that gate the custom effects - Add #undef EECONFIG_KB_DATA_SIZE before the Keychron redefinition in eeconfig_kb.h to suppress redefinition of QMK's default-zero value EEPROM persistence fixes (keychron_rgb.c): - Fix retail_demo_enable never being written to EEPROM in eeconfig_reset_custom_rgb(): original code used eeprom_read_block instead of eeprom_update_block, leaving 0xFF on freshly-flashed boards; retail_demo_task() treats any non-zero value as "demo active" and forces the mode to CUSTOM_MIXED_RGB every scan - Clamp retail_demo_enable > 1 to 0 on load to recover boards already affected by the above bug - Move EECONFIG_KEYBOARD version stamp from eeconfig_init_custom_rgb() (load path) to eeconfig_reset_custom_rgb() (reset/write path) so the version is only stamped when valid defaults are actually written - Call eeconfig_update_rgb_matrix() in kc_rgb_save() so the current QMK RGB mode is persisted alongside Keychron data; without this, rgb_matrix_init() (called on every transport change) reloads the compile-time default RGB_MATRIX_TYPING_HEATMAP from EEPROM Transport-change persistence (q5_max.c): - Call eeconfig_init_custom_rgb() in keyboard_post_init_kb() so Keychron RGB arrays are loaded from EEPROM on every boot instead of being zero-initialised - Add wireless_enter_connected_kb() hook: re-applies the EEPROM-saved QMK RGB mode after BT/2.4G reconnect in case the reconnect sequence resets the in-RAM mode before the display settles DIP switch Win-side override (keymap.c): - Replace rgb_matrix_mode() / rgb_matrix_sethsv() calls (which write to EEPROM and permanently overwrite the Launcher mode) with a dip_win_active flag; rgb_matrix_indicators_advanced_user() paints all LEDs white each frame when the flag is set, leaving the active effect and EEPROM untouched VIA keymap address pinning (config.h): - Define VIA_EEPROM_MAGIC_ADDR 544 to anchor VIA keymap storage at a fixed EEPROM offset; without this, growth in EECONFIG_KB_DATA_SIZE silently shifts the keymap block, corrupting stored layouts (observed as layer-0 keys reverting to KC_TRNS / KC_NONE on boot)
This commit is contained in:
@@ -165,4 +165,38 @@ led_config_t g_led_config = {
|
||||
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
|
||||
}
|
||||
};
|
||||
|
||||
#ifdef KEYCHRON_RGB_ENABLE
|
||||
// Default Color of Per Key RGB
|
||||
#define DC_RED {HSV_RED}
|
||||
#define DC_BLU {HSV_BLUE}
|
||||
#define DC_YLW {HSV_YELLOW}
|
||||
|
||||
// 101 LEDs: rows match g_led_config above
|
||||
// Row 0 (0-16): Fn row (Esc, F1-F12, Del, PrtSc, PgUp, PgDn)
|
||||
// Row 1 (17-35): Number row + numpad cluster top
|
||||
// Row 2 (36-54): QWERTY row + numpad cluster mid
|
||||
// Row 3 (55-71): ASDF row + numpad cluster
|
||||
// Row 4 (72-88): ZXCV row + numpad arrows
|
||||
// Row 5 (89-100): Modifier/bottom row + numpad
|
||||
HSV default_per_key_led[RGB_MATRIX_LED_COUNT] = {
|
||||
DC_RED, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW,
|
||||
DC_YLW, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW,
|
||||
DC_YLW, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW,
|
||||
DC_RED, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_YLW, DC_YLW, DC_YLW, DC_YLW,
|
||||
DC_YLW, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW,
|
||||
DC_YLW, DC_YLW, DC_YLW, DC_BLU, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW
|
||||
};
|
||||
|
||||
// Default mixed RGB region (all keys in region 0)
|
||||
uint8_t default_region[RGB_MATRIX_LED_COUNT] = {
|
||||
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
|
||||
};
|
||||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
@@ -45,6 +45,14 @@
|
||||
|
||||
#endif
|
||||
|
||||
// Pin VIA keymap storage to a fixed EEPROM address. By default VIA places its
|
||||
// magic/keymap block immediately after EECONFIG_KB_DATA_SIZE, so any growth in
|
||||
// the Keychron custom-RGB EEPROM region shifts the keymap silently and corrupts
|
||||
// the stored layout (observed as layer 0 keys reverting to KC_TRNS on boot).
|
||||
// 544 is past the current Keychron data region and leaves headroom for further
|
||||
// EEPROM additions without requiring another VIA reset.
|
||||
#define VIA_EEPROM_MAGIC_ADDR 544
|
||||
|
||||
/* Number of layers */
|
||||
#define DYNAMIC_KEYMAP_LAYER_COUNT 6
|
||||
|
||||
|
||||
@@ -211,7 +211,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||
RGB_TOG, RGB_MOD, RGB_VAI, RGB_HUI, RGB_SAI, RGB_SPI, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
|
||||
_______, RGB_RMOD, RGB_VAD, RGB_HUD, RGB_SAD, RGB_SPD, _______, _______, _______, _______, _______, _______, _______, KC_END, _______, _______, _______, _______,
|
||||
_______, _______, _______, _______, _______, BAT_LVL, NK_TOGG, _______, _______, _______, _______, _______, _______, _______, _______, _______,
|
||||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______),
|
||||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, QK_CLEAR_EEPROM, _______, _______),
|
||||
};
|
||||
|
||||
#if defined(ENCODER_MAP_ENABLE)
|
||||
@@ -262,20 +262,16 @@ void keyboard_post_init_user(void) {
|
||||
#ifdef DIP_SWITCH_ENABLE
|
||||
// dip_switch_update_user is claimed by factory_test.c; use the weak
|
||||
// dip_switch_update_keymap hook added in q5_max.c instead.
|
||||
|
||||
// True while the Win-side dip switch is active. The underlying RGB effect
|
||||
// keeps running unchanged; rgb_matrix_indicators_advanced_user() paints over
|
||||
// all LEDs with white each frame so neither mode nor EEPROM state is touched.
|
||||
// Transport changes (which call rgb_matrix_init()) are therefore irrelevant.
|
||||
static bool dip_win_active = false;
|
||||
|
||||
void dip_switch_update_keymap(uint8_t index, bool active) {
|
||||
if (index == 0) {
|
||||
if (active) {
|
||||
// "Win" side → solid white backlight
|
||||
rgb_matrix_mode(RGB_MATRIX_SOLID_COLOR);
|
||||
rgb_matrix_sethsv(HSV_WHITE);
|
||||
} else {
|
||||
// "Mac" side → heatmap effect.
|
||||
// Restore hue+saturation before switching modes: the heatmap reads
|
||||
// rgb_matrix_config.hsv.s directly for its color scale, so leaving
|
||||
// saturation=0 (from HSV_WHITE) produces a white-only heatmap.
|
||||
rgb_matrix_sethsv(0, 255, rgb_matrix_get_val());
|
||||
rgb_matrix_mode(RGB_MATRIX_TYPING_HEATMAP);
|
||||
}
|
||||
dip_win_active = active;
|
||||
}
|
||||
}
|
||||
#endif
|
||||
@@ -434,6 +430,19 @@ void matrix_scan_user(void) {
|
||||
// BASE stays dark; each FN/control layer gets a distinct colour.
|
||||
#if defined(RGB_MATRIX_ENABLE)
|
||||
bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
|
||||
#ifdef DIP_SWITCH_ENABLE
|
||||
// Win-side override: paint all LEDs white so the user gets a clean white
|
||||
// backlight regardless of which RGB effect is active. The effect keeps
|
||||
// ticking internally and resumes the moment the switch returns to Mac side.
|
||||
// Layer and status indicators painted in the rest of this function appear
|
||||
// on top of the white fill, so they continue to work normally.
|
||||
if (dip_win_active) {
|
||||
for (uint8_t i = led_min; i < led_max; i++) {
|
||||
rgb_matrix_set_color(i, 255, 255, 255);
|
||||
}
|
||||
}
|
||||
#endif
|
||||
|
||||
switch (get_highest_layer(layer_state)) {
|
||||
case FN1:
|
||||
RGB_MATRIX_INDICATOR_SET_COLOR(0, 0, 128, 255); // blue
|
||||
|
||||
Reference in New Issue
Block a user