[Keymap] Add keymap for kinesis advantage (#16862)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>

3 files changed, 398 insertions, 0 deletions

diff --git a/keyboards/kinesis/keymaps/heatxsink/keymap.c b/keyboards/kinesis/keymaps/heatxsink/keymap.c
new file mode 100644
index 0000000000..1f49c4622c
--- /dev/null
+++ b/keyboards/kinesis/keymaps/heatxsink/keymap.c
@@ -0,0 +1,228 @@
+/* Copyright 2022 Nicholas Granado <ngranado@gmail.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 layer_names {
+    _DEFAULT,
+    _QWERTY,
+    _COLEMAK_MOD_DH,
+    _WORKMAN,
+    _KEYPAD,
+    _LAYERS,
+};
+
+#define DEFAULT DF(_DEFAULT)
+#define QWERTY  TO(_QWERTY)
+#define CMMDH   TO(_COLEMAK_MOD_DH)
+#define WM      TO(_WORKMAN)
+#define KEYPAD  TO(_KEYPAD)
+#define LAYERS  OSL(_LAYERS)
+#define HCTLESC CTL_T(KC_ESC)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+    [_DEFAULT] = LAYOUT(
+        // LHAND
+        KC_ESC ,KC_F1  ,KC_F2  ,KC_F3  ,KC_F4  ,KC_F5  ,KC_F6  ,KC_F7  ,KC_F8  ,
+        KC_EQL ,KC_1   ,KC_2   ,KC_3   ,KC_4   ,KC_5   ,
+        KC_TAB ,_______,_______,_______,_______,_______,
+        HCTLESC,_______,_______,_______,_______,_______,
+        KC_LSPO,_______,_______,_______,_______,_______,
+                KC_GRV ,LAYERS ,KC_LEFT,KC_RGHT,
+        // LTHUMB
+                KC_LALT,KC_LCTL,
+                        KC_HOME,
+        KC_BSPC,KC_DEL ,KC_END ,
+        // RHAND
+        KC_F9  ,KC_F10 ,KC_F11 ,KC_F12 ,KC_PSCR,KC_SLCK,KC_PAUS,KEYPAD ,RESET  ,
+        KC_6   ,KC_7   ,KC_8   ,KC_9   ,KC_0   ,KC_MINS,
+        _______,_______,_______,_______,_______,KC_BSLS,
+        _______,_______,_______,_______,_______,KC_QUOT,
+        _______,_______,_______,_______,_______,KC_RSPC,
+                KC_UP  ,KC_DOWN,KC_LBRC,KC_RBRC,
+        // RTHUMB
+        KC_RCTL,KC_LGUI,
+        KC_PGUP,
+        KC_PGDN,KC_ENT ,KC_SPC
+    ),
+
+    [_QWERTY] = LAYOUT(
+        // LHAND
+        _______,_______,_______,_______,_______,_______,_______,_______,_______,
+        _______,_______,_______,_______,_______,_______,
+        _______,KC_Q   ,KC_W   ,KC_E   ,KC_R   ,KC_T   ,
+        _______,KC_A   ,KC_S   ,KC_D   ,KC_F   ,KC_G   ,
+        _______,KC_Z   ,KC_X   ,KC_C   ,KC_V   ,KC_B   ,
+                _______,_______,_______,_______,
+        // LTHUMB
+                _______,_______,
+                        _______,
+        _______,_______,_______,
+        // RHAND
+        _______,_______,_______,_______,_______,_______,_______,_______,_______,
+        _______,_______,_______,_______,_______,_______,
+        KC_Y   ,KC_U   ,KC_I   ,KC_O   ,KC_P   ,_______,
+        KC_H   ,KC_J   ,KC_K   ,KC_L   ,KC_SCLN,_______,
+        KC_N   ,KC_M   ,KC_COMM,KC_DOT ,KC_SLSH,_______,
+                _______,_______,_______,_______,
+        // RTHUMB
+        _______,_______,
+        _______,
+        _______,_______,_______
+    ),
+
+    [_COLEMAK_MOD_DH] = LAYOUT(
+        // LHAND
+        _______,_______,_______,_______,_______,_______,_______,_______,_______,
+        _______,_______,_______,_______,_______,_______,
+        _______,KC_Q   ,KC_W   ,KC_F   ,KC_P   ,KC_B,
+        _______,KC_A   ,KC_R   ,KC_S   ,KC_T   ,KC_G,
+        _______,KC_Z   ,KC_X   ,KC_C   ,KC_D   ,KC_V,
+                _______,_______,_______,_______,
+        // LTHUMB
+                _______,_______,
+                        _______,
+        _______,_______,_______,
+        // RHAND
+        _______,_______,_______,_______,_______,_______,_______,_______,_______,
+        _______,_______,_______,_______,_______,_______,
+        KC_J   ,KC_L   ,KC_U   ,KC_Y   ,KC_SCLN,_______,
+        KC_M   ,KC_N   ,KC_E   ,KC_I   ,KC_O   ,_______,
+        KC_K   ,KC_H   ,KC_COMM,KC_DOT ,KC_SLSH,_______,
+                _______,_______,_______,_______,
+        // RTHUMB
+        _______,_______,
+        _______,
+        _______,_______,_______
+    ),
+
+    [_WORKMAN] = LAYOUT(
+        // LHAND
+        _______,_______,_______,_______,_______,_______,_______,_______,_______,
+        _______,_______,_______,_______,_______,_______,
+        _______,KC_Q   ,KC_D   ,KC_R   ,KC_W   ,KC_B,
+        _______,KC_A   ,KC_S   ,KC_H   ,KC_T   ,KC_G,
+        _______,KC_Z   ,KC_X   ,KC_M   ,KC_C   ,KC_V,
+                _______,_______,_______,_______,
+        // LTHUMB
+                _______,_______,
+                        _______,
+        _______,_______,_______,
+        // RHAND
+        _______,_______,_______,_______,_______,_______,_______,_______,_______,
+        _______,_______,_______,_______,_______,_______,
+        KC_J   ,KC_F   ,KC_U   ,KC_P   ,KC_SCLN,_______,
+        KC_Y   ,KC_N   ,KC_E   ,KC_O   ,KC_I   ,_______,
+        KC_K   ,KC_L   ,KC_COMM,KC_DOT ,KC_SLSH,_______,
+                _______,_______,_______,_______,
+        // RTHUMB
+        _______,_______,
+        _______,
+        _______,_______,_______
+    ),
+
+    [_KEYPAD] = LAYOUT (
+        // LHAND
+        _______,_______,_______,_______,_______,_______,_______,_______,_______,
+        _______,_______,_______,_______,_______,_______,
+        _______,_______,KC_MUTE,KC_VOLD,KC_VOLU,_______,
+        _______,KC_MSTP,KC_MPRV,KC_MPLY,KC_MNXT,KC_MSEL,
+        _______,_______,_______,_______,_______,_______,
+                _______,_______,_______,_______,
+        // LTHUMB
+                _______,_______,
+                        _______,
+        _______,_______,_______,
+
+        // RHAND
+        _______,_______,_______,_______,_______,_______,_______,_______,_______,
+        _______,KC_NLCK,KC_PEQL,KC_PSLS,KC_PAST,_______,
+        _______,KC_P7,  KC_P8,  KC_P9,  KC_PMNS,_______,
+        _______,KC_P4,  KC_P5,  KC_P6,  KC_PPLS,_______,
+        _______,KC_P1,  KC_P2,  KC_P3,  KC_PENT,_______,
+                KC_LPRN,KC_RPRN,KC_PDOT,KC_PENT,
+        // RTHUMB
+        _______,_______,
+        _______,
+        _______,KC_PENT,KC_P0
+    ),
+
+    [_LAYERS] = LAYOUT (
+        // LHAND
+        _______,_______,_______,_______,_______,_______,_______,_______,_______,
+        _______,QWERTY ,CMMDH  ,WM     ,KEYPAD ,_______,
+        _______,_______,_______,_______,_______,_______,
+        _______,_______,_______,_______,_______,_______,
+        _______,_______,_______,_______,_______,_______,
+                _______,_______,_______,_______,
+        // LTHUMB
+                _______,_______,
+                        _______,
+        _______,_______,_______,
+
+        // RHAND
+        _______,_______,_______,_______,_______,_______,_______,_______,_______,
+        _______,_______,_______,_______,_______,_______,
+        _______,_______,_______,_______,_______,_______,
+        _______,_______,_______,_______,_______,_______,
+        _______,_______,_______,_______,_______,_______,
+                _______,_______,_______,_______,
+        // RTHUMB
+        _______,_______,
+        _______,
+        _______,_______,_______
+    ),
+};
+
+layer_state_t layer_state_set_user(layer_state_t state) {
+    writePinHigh(LED_NUM_LOCK_PIN);
+    writePinHigh(LED_SCROLL_LOCK_PIN);
+    writePinHigh(LED_COMPOSE_PIN);
+    writePinHigh(LED_CAPS_LOCK_PIN);
+    switch (get_highest_layer(state)) {
+        case _QWERTY:
+            // Caps Lock Lit
+            writePinLow(LED_CAPS_LOCK_PIN);
+            break;
+        case _COLEMAK_MOD_DH:
+            // Num Lock Lit
+            writePinLow(LED_NUM_LOCK_PIN);
+            break;
+        case _WORKMAN:
+            // Scroll Lock Lit
+            writePinLow(LED_SCROLL_LOCK_PIN);
+            break;
+        case _KEYPAD:
+            // Compose Lit
+            writePinLow(LED_COMPOSE_PIN);
+            break;
+        case _LAYERS:
+            // All LEDs Lit
+            writePinLow(LED_SCROLL_LOCK_PIN);
+            writePinLow(LED_NUM_LOCK_PIN);
+            writePinLow(LED_CAPS_LOCK_PIN);
+            writePinLow(LED_COMPOSE_PIN);
+            break;
+    }
+  return state;
+}
+
+bool led_update_user(led_t led_state) {
+    // disable led_update_kb() so that we do not override layer indicators
+    return false;
+}
+
diff --git a/keyboards/kinesis/keymaps/heatxsink/readme.md b/keyboards/kinesis/keymaps/heatxsink/readme.md
new file mode 100644
index 0000000000..83a2b55854
--- /dev/null
+++ b/keyboards/kinesis/keymaps/heatxsink/readme.md
@@ -0,0 +1,165 @@
+# heatxsink's keymap for kinesis advantage w/ kinx
+
+## my keymap has three objectives ...
+1. Make it easy to add keyboard layouts (layers).
+2. Easy to swap between keyboard layouts (layers).
+3. Use LED indicators on the kinX controller to provide feedback as to what layer is selected.
+
+## layer description
+0. DEFAULT (function key row, number row, left/right gutter keys, and thumb keys)
+1. QWERTY
+2. CMMDH [Colemak Mod-DH](https://colemakmods.github.io/mod-dh/)
+3. WM    [Workman](https://workmanlayout.org/)
+3. Keypad (number pad on the right, media keys on the left)
+
+## layers
+```
+Keymap: DEFAULT
+Description: keys separated by "/" tap for first, hold for second; uses Space Cadet Shifts
+
+ ,-------------------------------------------------------------------------------------------------------------------.
+ | Esc    |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F8  |  F9  |  F10 |  F12 | PSCR | SLCK | PAUS |KEYPAD|  BOOT  |
+ |--------+------+------+------+------+------+---------------------------+------+------+------+------+------+--------|
+ | =+     |  1!  |  2@  |  3#  |  4$  |  5%  |                           |  6^  |  7&  |  8*  |  9(  |  0)  | -_     |
+ |--------+------+------+------+------+------|                           +------+------+------+------+------+--------|
+ | Tab    |      |      |      |      |      |                           |      |      |      |      |      | \|     |
+ |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
+ |ESC/CTRL|      |      |      |      |      |                           |      |      |      |      |      | '"     |
+ |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
+ |SC_Shift|      |      |      |      |      |                           |      |      |      |      |      |SC_Shift|
+ `--------+------+------+------+------+------'                           `------+------+------+------+------+--------'
+          | `~   |LAYERS| Left | Right|                                         | Up   | Down |  [{  |  ]}  |
+          `---------------------------'                                         `---------------------------'
+                                        ,-------------.         ,-------------.
+                                        | ALT  | CTRL |         | CTRL  | GUI |
+                                 ,------|------|------|         |------+------+------.
+                                 |      |      | Home |         | PgUp |      |      |
+                                 | BkSp | Del  |------|         |------|Return| Space|
+                                 |      |      | End  |         | PgDn |      |      |
+                                 `--------------------'         `--------------------'
+
+Keymap: LAYERS 
+Description: OSL that allows for easy switching between layers.
+
+ ,-------------------------------------------------------------------------------------------------------------------.
+ |        |      |      |      |      |      |      |      |      |      |      |      |      |      |      |        |
+ |--------+------+------+------+------+------+---------------------------+------+------+------+------+------+--------|
+ |        |QWERTY|CMMDH |WM    |KEYPAD|      |                           |      |      |      |      |      |        |
+ |--------+------+------+------+------+------|                           +------+------+------+------+------+--------|
+ |        |      |      |      |      |      |                           |      |      |      |      |      |        |
+ |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
+ |        |      |      |      |      |      |                           |      |      |      |      |      |        |
+ |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
+ |        |      |      |      |      |      |                           |      |      |      |      |      |        |
+ `--------+------+------+------+------+------'                           `------+------+------+------+------+--------'
+          |      |      |      |      |                                         |      |      |      |      |
+          `---------------------------'                                         `---------------------------'
+                                        ,-------------.         ,-------------.
+                                        |      |      |         |      |      |
+                                 ,------|------|------|         |------+------+------.
+                                 |      |      |      |         |      |      |      |
+                                 |      |      |------|         |------|      |      |
+                                 |      |      |      |         |      |      |      |
+                                 `--------------------'         `--------------------'
+
+Keymap: QWERTY
+
+ ,-------------------------------------------------------------------------------------------------------------------.
+ |        |      |      |      |      |      |      |      |      |      |      |      |      |      |      |        |
+ |--------+------+------+------+------+------+---------------------------+------+------+------+------+------+--------|
+ |        |      |      |      |      |      |                           |      |      |      |      |      |        |
+ |--------+------+------+------+------+------|                           +------+------+------+------+------+--------|
+ |        |   Q  |   W  |   E  |   R  |   T  |                           |   Y  |   U  |   I  |   O  |   P  |        |
+ |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
+ |        |   A  |   S  |   D  |   F  |   G  |                           |   H  |   J  |   K  |   L  |  ;:  |        |
+ |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
+ |        |   Z  |   X  |   C  |   V  |   B  |                           |   N  |   M  |  ,.  |  .>  |  /?  |        |
+ `--------+------+------+------+------+------'                           `------+------+------+------+------+--------'
+          |      |      |      |      |                                         |      |      |      |      |
+          `---------------------------'                                         `---------------------------'
+                                        ,-------------.         ,-------------.
+                                        |      |      |         |      |      |
+                                 ,------|------|------|         |------+------+------.
+                                 |      |      |      |         |      |      |      |
+                                 |      |      |------|         |------|      |      |
+                                 |      |      |      |         |      |      |      |
+                                 `--------------------'         `--------------------'
+
+Keymap: CMMDH (Colemak Mod-DH)
+
+ ,-------------------------------------------------------------------------------------------------------------------.
+ |        |      |      |      |      |      |      |      |      |      |      |      |      |      |      |        |
+ |--------+------+------+------+------+------+---------------------------+------+------+------+------+------+--------|
+ |        |      |      |      |      |      |                           |      |      |      |      |      |        |
+ |--------+------+------+------+------+------|                           +------+------+------+------+------+--------|
+ |        |   Q  |   W  |   F  |   P  |   B  |                           |   J  |   L  |   U  |   Y  |  ;:  |        |
+ |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
+ |        |   A  |   R  |   S  |   T  |   G  |                           |   M  |   N  |   E  |   I  |  O   |        |
+ |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
+ |        |   Z  |   X  |   C  |   D  |   V  |                           |   K  |   H  |  ,.  |  .>  |  /?  |        |
+ `--------+------+------+------+------+------'                           `------+------+------+------+------+--------'
+          |      |      |      |      |                                         |      |      |      |      |
+          `---------------------------'                                         `---------------------------'
+                                        ,-------------.         ,-------------.
+                                        |      |      |         |      |      |
+                                 ,------|------|------|         |------+------+------.
+                                 |      |      |      |         |      |      |      |
+                                 |      |      |------|         |------|      |      |
+                                 |      |      |      |         |      |      |      |
+                                 `--------------------'         `--------------------'
+
+Keymap: WM (Workman)
+
+ ,-------------------------------------------------------------------------------------------------------------------.
+ |        |      |      |      |      |      |      |      |      |      |      |      |      |      |      |        |
+ |--------+------+------+------+------+------+---------------------------+------+------+------+------+------+--------|
+ |        |      |      |      |      |      |                           |      |      |      |      |      |        |
+ |--------+------+------+------+------+------|                           +------+------+------+------+------+--------|
+ |        |   Q  |   D  |   R  |   W  |   B  |                           |   J  |   F  |   U  |   P  |  ;:  |        |
+ |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
+ |        |   A  |   S  |   H  |   T  |   G  |                           |   Y  |   N  |   E  |   O  |  I   |        |
+ |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
+ |        |   Z  |   X  |   M  |   C  |   V  |                           |   K  |   L  |  ,.  |  .>  |  /?  |        |
+ `--------+------+------+------+------+------'                           `------+------+------+------+------+--------'
+          |      |      |      |      |                                         |      |      |      |      |
+          `---------------------------'                                         `---------------------------'
+                                        ,-------------.         ,-------------.
+                                        |      |      |         |      |      |
+                                 ,------|------|------|         |------+------+------.
+                                 |      |      |      |         |      |      |      |
+                                 |      |      |------|         |------|      |      |
+                                 |      |      |      |         |      |      |      |
+                                 `--------------------'         `--------------------'
+
+Keymap: KEYPAD
+
+ ,-------------------------------------------------------------------------------------------------------------------.
+ |        |      |      |      |      |      |      |      |      |      |      |      |      |      |      |        |
+ |--------+------+------+------+------+------+---------------------------+------+------+------+------+------+--------|
+ |        |      |      |      |      |      |                           |      |NUMLCK|  =   |  /   |PASTE |        |
+ |--------+------+------+------+------+------|                           +------+------+------+------+------+--------|
+ |        |      | MUTE | VOL- | VOL+ |      |                           |      |   7  |   8  |   9  |  -   |        |
+ |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
+ |        | STOP | PREV | PLAY | NEXT |SELECT|                           |      |   4  |   5  |   6  |  +   |        |
+ |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
+ |        |      |      |      |      |      |                           |      |   1  |   2  |   3  | ENTER|        |
+ `--------+------+------+------+------+------'                           `------+------+------+------+------+--------'
+          |      |      |      |      |                                         |   (  |   )  |   .  | ENTER|
+          `---------------------------'                                         `---------------------------'
+                                        ,-------------.         ,-------------.
+                                        |      |      |         |      |      |
+                                 ,------|------|------|         |------+------+------.
+                                 |      |      |      |         |      |      |      |
+                                 |      |      |------|         |------|ENTER |  0   |
+                                 |      |      |      |         |      |      |      |
+                                 `--------------------'         `--------------------'
+```
+## requirements
+* K500 or K600 Kinesis Advantage MPC or Advantage 2.
+* [kinx project / stapelberg controller](https://github.com/kinx-project/kint)
+
+## shoutout(s)
+* `stapelberg` self explanitory
+* `jwon` for his LED indicator code
+* `tuesdayjohn` for how he did layers
+
diff --git a/keyboards/kinesis/keymaps/heatxsink/rules.mk b/keyboards/kinesis/keymaps/heatxsink/rules.mk
new file mode 100644
index 0000000000..f8c1a24cca
--- /dev/null
+++ b/keyboards/kinesis/keymaps/heatxsink/rules.mk
@@ -0,0 +1,5 @@
+BOOTMAGIC_ENABLE = no
+MOUSEKEY_ENABLE = no
+EXTRAKEY_ENABLE = yes
+NKRO_ENABLE = yes
+SLEEP_LED_ENABLE = yes