[Keymap] Custom user keymap for Think6.5 with LED range control (#7603)

* ISO layout for the soldered Think6.5 PCB

* Think6.5 personal layout readme

* Add personal Think6.5 user map with LED group cycling

* Add default case to process_record_user

* Make the ASCII diagram match the layer properly

* Relocate KC_NUHS to the home row for consistency

* Add LAYOUT_65_iso_badge to info.json

* Wire up the badge LEDs as capslock LEDs

* Remove unused keymap variable

2 files changed, 282 insertions, 0 deletions

diff --git a/keyboards/gray_studio/think65/solder/keymaps/rys/keymap.c b/keyboards/gray_studio/think65/solder/keymaps/rys/keymap.c
new file mode 100644
index 0000000000..658798ed67
--- /dev/null
+++ b/keyboards/gray_studio/think65/solder/keymaps/rys/keymap.c
@@ -0,0 +1,271 @@
+/* Copyright 2019 Rys Sommefeldt
+ *
+ * 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
+
+/*
+ * LED ranges
+ * ┌─────────────┬─────────────┬───────────────────────────────────────────┐
+ * │ 00 01 02 03 │ 04 05 06 07 │ 08 09 10 11 12 13 14 15 16 17 18 19 20 21 │
+ * │   escape    │    badge    │              underglow                    │
+ * └─────────────┴─────────────┴───────────────────────────────────────────┘
+ */
+
+// Define the LED ranges                  start, end
+#define THINK65_LED_RANGE_OFF                 0, 0
+#define THINK65_LED_RANGE_ESC                 0, 4
+#define THINK65_LED_RANGE_BADGE               4, 8
+#define THINK65_LED_RANGE_UNDERGLOW           8, 22
+#define THINK65_LED_RANGE_ALL                 0, 22
+
+// Turn the LEDs off by setting HSV to 0, 0, 0
+#define THINK65_LEDS_OFF                      0, 0, 0
+
+// There are 3 ranges, so we can store all combinations in 2^3 values
+// Define all of them to make it easier to write the cycling code
+#define THINK65_LED_STATE_OFF                 0x0 // 0b00000000
+#define THINK65_LED_STATE_ESC                 0x1 // 0b00000001
+#define THINK65_LED_STATE_BADGE               0x2 // 0b00000010
+#define THINK65_LED_STATE_UNDERGLOW           0x4 // 0b00000100
+#define THINK65_LED_STATE_ESC_AND_BADGE       0x3 // 0b00000011
+#define THINK65_LED_STATE_ESC_AND_UNDERGLOW   0x5 // 0b00000101
+#define THINK65_LED_STATE_BADGE_AND_UNDERGLOW 0x6 // 0b00000110
+#define THINK65_LED_STATE_ON                  0x7 // 0b00000111
+
+// Define each LED range as a bit flag
+#define THINK65_LED_ESC_RANGE_BIT             0
+#define THINK65_LED_BADGE_RANGE_BIT           1
+#define THINK65_LED_UNDERGLOW_RANGE_BIT       2
+
+// Setup some keycodes to control cycling and range toggling
+enum rys_keycodes {
+    CYC_LED = SAFE_RANGE,
+    TOG_ESC,
+    TOG_BDG,
+    TOG_UGL
+};
+
+// setup the user EEPROM space we need
+typedef union {
+    uint8_t raw;
+    struct {
+        uint8_t current_led_state:8;
+    };
+} user_config_t;
+
+user_config_t user_config;
+
+// toggle one of the range flag bits
+void toggle_led_state(unsigned int led_range) {
+    if (led_range >= THINK65_LED_ESC_RANGE_BIT && led_range <= THINK65_LED_UNDERGLOW_RANGE_BIT) {
+        user_config.current_led_state ^= 1 << led_range;
+    }
+}
+
+// set one of the range flag bits
+void set_led_state(unsigned int led_range) {
+    if (led_range >= THINK65_LED_ESC_RANGE_BIT && led_range <= THINK65_LED_UNDERGLOW_RANGE_BIT) {
+        user_config.current_led_state |= 1 << led_range;
+    }
+}
+
+// clear one of the range flag bits
+void clear_led_state(unsigned int led_range) {
+    if (led_range >= THINK65_LED_ESC_RANGE_BIT && led_range <= THINK65_LED_UNDERGLOW_RANGE_BIT) {
+        user_config.current_led_state &= ~(1 << led_range);
+    }
+}
+
+// cycle LED states: Off -> Esc -> Badge -> Underglow -> Esc+Badge -> Esc+Underglow -> Badge+Underglow -> All
+void cycle_led_state(void) {
+    switch(user_config.current_led_state) {
+        case THINK65_LED_STATE_OFF:
+            user_config.current_led_state = THINK65_LED_STATE_ESC;
+            break;
+        case THINK65_LED_STATE_ESC:
+            user_config.current_led_state = THINK65_LED_STATE_BADGE;
+            break;
+        case THINK65_LED_STATE_BADGE:
+            user_config.current_led_state = THINK65_LED_STATE_UNDERGLOW;
+            break;
+        case THINK65_LED_STATE_UNDERGLOW:
+            user_config.current_led_state = THINK65_LED_STATE_ESC_AND_BADGE;
+            break;
+        case THINK65_LED_STATE_ESC_AND_BADGE:
+            user_config.current_led_state = THINK65_LED_STATE_ESC_AND_UNDERGLOW;
+            break;
+        case THINK65_LED_STATE_ESC_AND_UNDERGLOW:
+            user_config.current_led_state = THINK65_LED_STATE_BADGE_AND_UNDERGLOW;
+            break;
+        case THINK65_LED_STATE_BADGE_AND_UNDERGLOW:
+            user_config.current_led_state = THINK65_LED_STATE_ON;
+            break;
+        case THINK65_LED_STATE_ON:
+            user_config.current_led_state = THINK65_LED_STATE_OFF;
+            break;
+        default:
+            break;
+    }
+}
+
+void apply_led_state(void) {
+    uint8_t h = rgblight_get_hue();
+    uint8_t s = rgblight_get_sat();
+    uint8_t v = rgblight_get_val();
+
+    // Set the RGB ranges based on the current state
+    switch(user_config.current_led_state) {
+        case THINK65_LED_STATE_OFF:
+            rgblight_sethsv_range(THINK65_LEDS_OFF, THINK65_LED_RANGE_ALL);
+            break;
+        case THINK65_LED_STATE_ESC:
+            rgblight_sethsv_range(h, s, v,          THINK65_LED_RANGE_ESC);
+            rgblight_sethsv_range(THINK65_LEDS_OFF, THINK65_LED_RANGE_BADGE);
+            rgblight_sethsv_range(THINK65_LEDS_OFF, THINK65_LED_RANGE_UNDERGLOW);
+            break;
+        case THINK65_LED_STATE_BADGE:
+            rgblight_sethsv_range(THINK65_LEDS_OFF, THINK65_LED_RANGE_ESC);
+            rgblight_sethsv_range(h, s, v,          THINK65_LED_RANGE_BADGE);
+            rgblight_sethsv_range(THINK65_LEDS_OFF, THINK65_LED_RANGE_UNDERGLOW);
+            break;
+        case THINK65_LED_STATE_UNDERGLOW:
+            rgblight_sethsv_range(THINK65_LEDS_OFF, THINK65_LED_RANGE_ESC);
+            rgblight_sethsv_range(THINK65_LEDS_OFF, THINK65_LED_RANGE_BADGE);
+            rgblight_sethsv_range(h, s, v,          THINK65_LED_RANGE_UNDERGLOW);
+            break;
+        case THINK65_LED_STATE_ESC_AND_BADGE:
+            rgblight_sethsv_range(h, s, v,          THINK65_LED_RANGE_ESC);
+            rgblight_sethsv_range(h, s, v,          THINK65_LED_RANGE_BADGE);
+            rgblight_sethsv_range(THINK65_LEDS_OFF, THINK65_LED_RANGE_UNDERGLOW);
+            break;
+        case THINK65_LED_STATE_ESC_AND_UNDERGLOW:
+            rgblight_sethsv_range(h, s, v,          THINK65_LED_RANGE_ESC);
+            rgblight_sethsv_range(THINK65_LEDS_OFF, THINK65_LED_RANGE_BADGE);
+            rgblight_sethsv_range(h, s, v,          THINK65_LED_RANGE_UNDERGLOW);
+            break;
+        case THINK65_LED_STATE_BADGE_AND_UNDERGLOW:
+            rgblight_sethsv_range(THINK65_LEDS_OFF, THINK65_LED_RANGE_ESC);
+            rgblight_sethsv_range(h, s, v,          THINK65_LED_RANGE_BADGE);
+            rgblight_sethsv_range(h, s, v,          THINK65_LED_RANGE_UNDERGLOW);
+            break;
+        case THINK65_LED_STATE_ON:
+            rgblight_sethsv_range(h, s, v,          THINK65_LED_RANGE_ALL);
+            break;
+        default:
+            break;
+    }
+}
+
+void keyboard_post_init_user(void) {
+    user_config.raw = eeconfig_read_user();
+
+    if (user_config.current_led_state >= THINK65_LED_STATE_OFF && user_config.current_led_state <= THINK65_LED_STATE_ON) {
+        // If the current state read from user EEPROM is valid, apply it
+        apply_led_state();
+    } else {
+        // Setup a new default state of off
+        user_config.current_led_state = THINK65_LED_STATE_OFF;
+        apply_led_state();
+        eeconfig_update_user(user_config.raw);
+    }
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    switch (keycode) {
+        case CYC_LED:
+            if (record->event.pressed) {
+                cycle_led_state();
+                apply_led_state();
+                eeconfig_update_user(user_config.raw);
+            }
+            break;
+        case TOG_ESC:
+            if (record->event.pressed) {
+                toggle_led_state(THINK65_LED_ESC_RANGE_BIT);
+                apply_led_state();
+                eeconfig_update_user(user_config.raw);
+            }
+            break;
+        case TOG_BDG:
+            if (record->event.pressed) {
+                toggle_led_state(THINK65_LED_BADGE_RANGE_BIT);
+                apply_led_state();
+                eeconfig_update_user(user_config.raw);
+            }
+            break;
+        case TOG_UGL:
+            if (record->event.pressed) {
+                toggle_led_state(THINK65_LED_UNDERGLOW_RANGE_BIT);
+                apply_led_state();
+                eeconfig_update_user(user_config.raw);
+            }
+            break;
+        case KC_CAPS:
+            if (!record->event.pressed) {
+                // connect capslock LED control to the badge LEDs
+                host_keyboard_led_state().caps_lock ? set_led_state(THINK65_LED_BADGE_RANGE_BIT) : clear_led_state(THINK65_LED_BADGE_RANGE_BIT);
+                apply_led_state();
+                eeconfig_update_user(user_config.raw);
+            }
+            break;
+        default:
+            break;
+    }
+    return true;
+}
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT_65_iso_badge(
+    /*
+     * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┬───┐
+     * │Esc│ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │ Backsp│ ` │
+     * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┼───┤
+     * │ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ [ │ ] │     │Del│
+     * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┐ Ent├───┤
+     * │ Caps │ A │ S │ D │ F │ G │ H │ J │ K │ L │ ; │ ' │ # │    │   │
+     * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┤   │
+     * │Shft│ \ │ Z │ X │ C │ V │ B │ N │ M │ , │ . │ / │ Shift│ ↑ │   │
+     * ├────┼───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬─┬───┼───┼───┤
+     * │Ctrl│LAlt│GUI │      Spaaaaaaace       │RAlt│ L1 │ │ ← │ ↓ │ → │
+     * └────┴────┴────┴────────────────────────┴────┴────┘ └───┴───┴───┘
+     */
+        KC_ESC,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSPC, KC_GRV,
+        KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC,          KC_DEL,
+        KC_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, KC_NUHS, KC_ENT,
+        KC_LSFT, KC_NUBS, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT, KC_UP,
+        KC_LCTL, KC_LALT, KC_LGUI,                   KC_SPC,                             KC_RALT, MO(1),            KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+    [1] = LAYOUT_65_iso_badge(
+    /*
+     * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┬───┐
+     * │RST│ F1│ F2│ F3│ F4│ F5│ F6│ F7│ F8│ F9│F10│F11│F12│       │   │
+     * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┼───┤
+     * │ TOG │PLN│MOD│HU+│HU-│SA+│SA-│VA+│VA-│   │   │   │   │     │   │
+     * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┐    ├───┤
+     * │      │   │   │   │   │   │   │   │   │   │   │   │   │    │   │
+     * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┤   │
+     * │    │   │   │   │   │   │   │   │   │   │   │   │      │CYC│   │
+     * ├────┼───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬─┬───┼───┼───┤
+     * │    │    │    │                        │    │    │ │ESC│BDG│UGL│
+     * └────┴────┴────┴────────────────────────┴────┴────┘ └───┴───┴───┘
+     */
+        RESET,   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, _______,
+        RGB_TOG, RGB_M_P, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, _______, _______,          _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, CYC_LED,
+        _______, _______, _______,                   _______,                            _______, _______,          TOG_ESC, TOG_BDG, TOG_UGL
+    ),
+
+};
diff --git a/keyboards/gray_studio/think65/solder/keymaps/rys/readme.md b/keyboards/gray_studio/think65/solder/keymaps/rys/readme.md
new file mode 100644
index 0000000000..ed73e30647
--- /dev/null
+++ b/keyboards/gray_studio/think65/solder/keymaps/rys/readme.md
@@ -0,0 +1,11 @@
+# Personal keymap for the Think 6.5 with compatible soldered PCB
+
+The layout is UK ISO with some small personal tweaks.
+
+The LED cycling code is based on code posted to the Gray Studio Discord by `MudkipMao` on Nov 22nd 2019. Thanks!
+
+## LED cycling
+
+This map saves and restores your current active LED group choice to user EEPROM and restores it on keyboard init, which you can cycle through all combinations of, or toggle individually.
+
+The cycle is `Off -> Esc -> Badge -> Underglow -> Esc+Badge -> Esc+Underglow -> Badge+Underglow -> All`. Look at the keymap for the controls on layer 1.