[Keymap] Add kzar keymap for Kinesis Advantage (#12444)

4 files changed, 438 insertions, 0 deletions

diff --git a/keyboards/kinesis/kint36/keymaps/kzar/config.h b/keyboards/kinesis/kint36/keymaps/kzar/config.h
new file mode 100644
index 0000000000..6b03aa6a70
--- /dev/null
+++ b/keyboards/kinesis/kint36/keymaps/kzar/config.h
@@ -0,0 +1,19 @@
+/* Copyright 2021 Dave Vandyke <kzar@kzar.co.uk>
+ *
+ * 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/>.
+ */
+
+#pragma once
+
+#undef LED_COMPOSE_PIN
diff --git a/keyboards/kinesis/kint36/keymaps/kzar/keymap.c b/keyboards/kinesis/kint36/keymaps/kzar/keymap.c
new file mode 100644
index 0000000000..20b1352683
--- /dev/null
+++ b/keyboards/kinesis/kint36/keymaps/kzar/keymap.c
@@ -0,0 +1,405 @@
+/* Copyright 2021 Dave Vandyke <kzar@kzar.co.uk>,
+ *   Based upon Xyverz's Kinesis keymap Copyright 2017-2020.
+ *
+ * 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
+#include "version.h"
+
+enum layer_names {_QWERTY, _DVORAK, _MAC, _PC, _KEYPAD, _PROGRAM};
+enum my_keycodes {QWERTY = SAFE_RANGE, DVORAK, WIN, MAC, PC, STATUS, PROGRAM};
+
+#define LED_KEYPAD E26
+
+// clang-format off
+
+/*
+        QWERTY layer:
+        ,---------------------------------------------------------------------------.
+        |    ESC   |  F1  |  F2  |  F3  |  F4  |    F5    |   F6   |   F7   |  F8   |
+        `---------------------------------------------------------------------------'
+        ,---------------------------------------------------------------------------.
+        |    F9    |  F10 |  F11 |  F12 | PScr |   SLck   |  Pause | Keypad | Prgrm |
+        `---------------------------------------------------------------------------'
+        ,-------------------------------------------.,-------------------------------------------.
+        |   =    |   1  |   2  |   3  |   4  |   5  ||   6  |   7  |   8  |   9  |   0  |   -    |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        | Tab    |   Q  |   W  |   E  |   R  |   T  ||   Y  |   U  |   I  |   O  |   P  |   \    |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        | CapsLk |   A  |   S  |   D  |   F  |   G  ||   H  |   J  |   K  |   L  |   ;  |   '    |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        | LShift |   Z  |   X  |   C  |   V  |   B  ||   N  |   M  |   ,  |   .  |   /  | RShift |
+        `--------+------+------+------+------+------'`------+------+------+------+------+--------'
+                 |   `  |   \  | Left | Rght |              |  Up  |  Dn  |   [  |   ]  |
+                 `---------------------------'              `---------------------------'
+                                     ,--------------.,--------------.
+                                     | LCtl  | LAlt || LGUI | RCtl  |
+                              ,------|-------|------||------+-------+-------.
+                              |      |       | Home || PgUp | Enter |       |
+                              | BkSp |  Del  |------||------|   /   | Space |
+                              |      |       | End  || PgDn | KeyPd |       |
+                              `---------------------'`----------------------'
+
+        Dvorak layer:
+        ,---------------------------------------------------------------------------.
+        |          |      |      |      |      |          |        |        |       |
+        `---------------------------------------------------------------------------'
+        ,---------------------------------------------------------------------------.
+        |          |      |      |      |      |          |        |        |       |
+        `---------------------------------------------------------------------------'
+        ,-------------------------------------------.,-------------------------------------------.
+        |        |      |      |      |      |      ||      |      |      |      |      |        |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |   '  |   ,  |   .  |   P  |   Y  ||   F  |   G  |   C  |   R  |   L  |   /    |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |   A  |   O  |   E  |   U  |   I  ||   D  |   H  |   T  |   N  |   S  |   \    |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |   ;  |   Q  |   J  |   K  |   X  ||   B  |   M  |   W  |   V  |   Z  |        |
+        `--------+------+------+------+------+------'`------+------+------+------+------+--------'
+                 |      |      |      |      |              |      |      |      |      |
+                 `---------------------------'              `---------------------------'
+                                     ,--------------.,--------------.
+                                     |       |      ||      |       |
+                              ,------|-------|------||------+-------+-------.
+                              |      |       |      ||      |       |       |
+                              |      |       |------||------|       |       |
+                              |      |       |      ||      |       |       |
+                              `---------------------'`----------------------'
+
+        Mac layer:
+        ,-------------------------------------------------------------------------------.
+        |          |      |      |        |        |          |        |        |       |
+        `-------------------------------------------------------------------------------'
+        ,-------------------------------------------------------------------------------.
+        |          |      |      |        |        |   Power  |        |        |       |
+        `-------------------------------------------------------------------------------'
+        ,-------------------------------------------.,-------------------------------------------.
+        |        |      |      |      |      |      ||      |      |      |      |      |        |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |      |      |      |      |      ||      |      |      |      |      |        |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |      |      |      |      |      ||      |      |      |      |      |        |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |      |      |      |      |      ||      |      |      |      |      |        |
+        `--------+------+------+------+------+------'`------+------+------+------+------+--------'
+                 |      |      |      |      |              |      |      |      |      |
+                 `---------------------------'              `---------------------------'
+                                      ,-------------.,-------------.
+                                      | LGUI | LAlt || RCtl | RGUI |
+                               ,------|------|------||------+------+------.
+                               |      |      |      ||      |      |      |
+                               |      |      |------||------|      |      |
+                               |      |      |      ||      |      |      |
+                               `--------------------'`--------------------'
+
+        PC layer:
+        ,-------------------------------------------------------------------------------.
+        |          |      |      |        |        |          |        |        |       |
+        `-------------------------------------------------------------------------------'
+        ,-------------------------------------------------------------------------------.
+        |          |      |      |        |        |          |        |        |       |
+        `-------------------------------------------------------------------------------'
+        ,-------------------------------------------.,-------------------------------------------.
+        |        |      |      |      |      |      ||      |      |      |      |      |        |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |      |      |      |      |      ||      |      |      |      |      |        |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |      |      |      |      |      ||      |      |      |      |      |        |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |      |      |      |      |      ||      |      |      |      |      |        |
+        `--------+------+------+------+------+------'`------+------+------+------+------+--------'
+                 |      |      |      |      |              |      |      |      |      |
+                 `---------------------------'              `---------------------------'
+                                      ,-------------.,-------------.
+                                      |      |      || RAlt |      |
+                               ,------|------|------||------+------+------.
+                               |      |      |      ||      |      |      |
+                               |      |      |------||------|      |      |
+                               |      |      |      ||      |      |      |
+                               `--------------------'`--------------------'
+
+        Keypad layer:
+        ,---------------------------------------------------------------------------.
+        |          |      |      |      |      |          |        |        |       |
+        `---------------------------------------------------------------------------'
+        ,---------------------------------------------------------------------------.
+        |          |      |      |      | Mute | Vol Down | Vol Up | Keypad |       |
+        `---------------------------------------------------------------------------'
+        ,-------------------------------------------.,-------------------------------------------.
+        |        |      |      |      |      |      ||      | NmLk | KP = | KP / | KP * |        |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |      |      |      |      |      ||      | KP 7 | KP 8 | KP 9 | KP - |        |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |      |      |      |      |      ||      | KP 4 | KP 5 | KP 6 | KP + |        |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |      |      |      |      |      ||      | KP 1 | KP 2 | KP 3 |KP Ent|        |
+        `--------+------+------+------+------+------'`------+------+------+------+------+--------'
+                 |      |  INS |      |      |              |      |      | KP . |KP Ent|
+                 `---------------------------'              `---------------------------'
+                                      ,-------------.,-------------.
+                                      |      |      ||      |      |
+                               ,------|------|------||------+------+------.
+                               |      |      |      ||      |      |      |
+                               |      |      |------||------|      | KP 0 |
+                               |      |      |      ||      |      |      |
+                               `--------------------'`--------------------'
+
+        Program layer:
+        ,-------------------------------------------------------------------------------.
+        |  STATUS  |      |      | QWERTY | DVORAK |          |        |        |       |
+        `-------------------------------------------------------------------------------'
+        ,-------------------------------------------------------------------------------.
+        |   RESET  |      |      |        |        |          |        |        |       |
+        `-------------------------------------------------------------------------------'
+        ,-------------------------------------------.,-------------------------------------------.
+        |        |      |      |      |      |      ||      |      |      |      |      |        |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |      |      |      |      |      ||      |      |      |      |      |        |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |      |      |      |      |      ||      |      |      |      |      |        |
+        |--------+------+------+------+------+------||------+------+------+------+------+--------|
+        |        |      |      |      |      |      ||      |      |      |      |      |        |
+        `--------+------+------+------+------+------'`------+------+------+------+------+--------'
+                 |      |      |      |      |              |      |      |      |      |
+                 `---------------------------'              `---------------------------'
+                                      ,-------------.,-------------.
+                                      |      |      ||      |      |
+                               ,------|------|------||------+------+------.
+                               |      |      |      ||      |      |      |
+                               |      |      |------||------|      |      |
+                               |      |      |      ||      |      |      |
+                               `--------------------'`--------------------'
+
+*/
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+[_QWERTY] = LAYOUT (
+           // Left Hand
+           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,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,
+           KC_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,
+           KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,
+                    KC_GRV,  KC_NUBS, KC_LEFT, KC_RGHT,
+           // Left Thumb
+                    KC_LCTL, KC_LALT,
+                             KC_HOME,
+           KC_BSPC, KC_DEL,  KC_END,
+
+           // Right Hand
+           KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_PSCR, KC_SLCK, KC_PAUS, TG(_KEYPAD),  MO(_PROGRAM),
+           KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS,
+           KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSLS,
+           KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
+           KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,
+                    KC_UP,   KC_DOWN, KC_LBRC, KC_RBRC,
+           // Right Thumb
+           KC_LGUI, KC_RCTL,
+           KC_PGUP,
+           KC_PGDN, KC_ENT, KC_SPC
+    ),
+
+[_DVORAK] = LAYOUT (
+           // Left Hand
+           _______, _______, _______, _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, KC_QUOT, KC_COMM,  KC_DOT,    KC_P,    KC_Y,
+           _______,    KC_A,    KC_O,    KC_E,    KC_U,    KC_I,
+           _______, KC_SCLN,    KC_Q,    KC_J,    KC_K,    KC_X,
+                    _______, _______, _______, _______,
+           // Left Thumb
+                    _______, _______,
+                             _______,
+           _______, _______, _______,
+
+           // Right Hand
+           _______, _______, _______, _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           KC_F,       KC_G,    KC_C,    KC_R,    KC_L, KC_SLSH,
+           KC_D,       KC_H,    KC_T,    KC_N,    KC_S, KC_BSLS,
+           KC_B,       KC_M,    KC_W,    KC_V,    KC_Z, _______,
+                    _______, _______, _______, _______,
+           // Right Thumb
+           _______, _______,
+           _______,
+           _______, _______, _______
+    ),
+
+[_MAC] = LAYOUT (
+           // Left Hand
+           _______, _______, _______, _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+                    _______, _______, _______, _______,
+           // Left Thumb
+                    KC_LGUI, KC_LALT,
+                             _______,
+           _______, _______, _______,
+
+           // Right Hand
+           _______, _______, _______, _______, _______, KC_POWER, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+                    _______, _______, _______, _______,
+           // Right Thumb
+           KC_RCTL, KC_RGUI,
+           _______,
+           _______, _______, _______
+    ),
+
+[_PC] = LAYOUT (
+           // Left Hand
+           _______, _______, _______, _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+                    _______, _______, _______, _______,
+           // Left Thumb
+                    _______, _______,
+                             _______,
+           _______, _______, _______,
+
+           // Right Hand
+           _______, _______, _______, _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+                    _______, _______, _______, _______,
+           // Right Thumb
+           KC_RALT, _______,
+           _______,
+           _______, _______, _______
+    ),
+
+[_KEYPAD] = LAYOUT (
+           // Left Hand
+           _______, _______, _______, _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+                    _______, KC_INS,  _______, _______,
+           // Left Thumb
+                    _______, _______,
+                             _______,
+           _______, _______, _______,
+
+           // Right Hand
+           _______,    _______, _______, _______, KC__MUTE, KC__VOLDOWN, KC__VOLUP, _______, _______,
+           _______, 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_PDOT, KC_PENT,
+           // Right Thumb
+           _______, _______,
+           _______,
+           _______, _______, KC_P0
+    ),
+
+[_PROGRAM] = LAYOUT (
+           // Left Hand
+           STATUS,  _______, _______, QWERTY,   DVORAK,  MAC,     PC,     WIN,     _______,
+           _______, _______, _______, _______ , _______, _______,
+           _______, _______, _______, _______ , _______, _______,
+           _______, _______, _______, _______ , _______, _______,
+           _______, _______, _______, _______ , _______, _______,
+                    _______, _______, _______ , _______,
+           // Left Thumb
+                    _______, _______,
+                             _______,
+           _______, _______, _______,
+
+           // Right Hand
+           RESET,   _______, _______, _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+           _______, _______, _______, _______, _______, _______,
+                    _______, _______, _______, _______,
+           // Right Thumb
+           _______, _______,
+           _______,
+           _______, _______, _______
+    )
+
+};
+
+layer_state_t layer_state_set_user(layer_state_t state) {
+    writePin(LED_KEYPAD, !layer_state_cmp(state, _KEYPAD));
+    return state;
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    if (record->event.pressed) {
+        switch (keycode) {
+            case QWERTY:
+                set_single_persistent_default_layer(_QWERTY);
+                return false;
+            case DVORAK:
+                set_single_persistent_default_layer(_DVORAK);
+                return false;
+            case MAC:
+                layer_on(_MAC);
+                layer_off(_PC);
+                return false;
+            case PC:
+                layer_off(_MAC);
+                layer_on(_PC);
+                return false;
+            case WIN:
+                layer_off(_MAC);
+                layer_off(_PC);
+                return false;
+            case STATUS:
+                SEND_STRING("Firmware> QMK " QMK_VERSION ", " QMK_BUILDDATE "\n");
+                SEND_STRING("Keyboard> " QMK_KEYBOARD "\n");
+                SEND_STRING("Keymap> " QMK_KEYMAP "\n");
+
+                if (layer_state_is(_QWERTY))
+                    SEND_STRING("Layout> QWERTY\n");
+                else
+                    SEND_STRING("Layout> DVORAK\n");
+
+                if (layer_state_is(_MAC))
+                    SEND_STRING("Thumb keys mode> MAC\n");
+                else if (layer_state_is(_PC))
+                    SEND_STRING("Thumb keys mode> PC\n");
+                else
+                    SEND_STRING("Thumb keys mode> WIN\n");
+
+                if (keymap_config.nkro)
+                    SEND_STRING("NKRO> Enabled\n");
+                else
+                    SEND_STRING("NKRO> Disabled\n");
+
+                if (debug_enable)
+                    SEND_STRING("Debug> Enabled\n");
+                else
+                    SEND_STRING("Debug> Disabled\n");
+
+                return false;
+        }
+    }
+
+    return true;
+}
diff --git a/keyboards/kinesis/kint36/keymaps/kzar/readme.md b/keyboards/kinesis/kint36/keymaps/kzar/readme.md
new file mode 100644
index 0000000000..b45808892e
--- /dev/null
+++ b/keyboards/kinesis/kint36/keymaps/kzar/readme.md
@@ -0,0 +1,9 @@
+# Dave's Kinesis Advantage keymap
+
+Kinesis Advantage keymap aiming to emulate the stock controller. QWERTY, DVORAK,
+WIN, MAC, PC, program and keypad layers are all supported, along with the
+keypad LED and RESET + STATUS keys.
+
+Tested with a Kinesis Advantage2, kinT (stapelberg) keyboard controller built
+with a Teensy 3.6 microcontroller and a UK system layout. Originally based upon
+the xyvers keymap.
diff --git a/keyboards/kinesis/kint36/keymaps/kzar/rules.mk b/keyboards/kinesis/kint36/keymaps/kzar/rules.mk
new file mode 100644
index 0000000000..7537188840
--- /dev/null
+++ b/keyboards/kinesis/kint36/keymaps/kzar/rules.mk
@@ -0,0 +1,5 @@
+BOOTMAGIC_ENABLE = no
+COMMAND_ENABLE = yes
+MOUSEKEY_ENABLE = no
+NKRO_ENABLE = yes
+RGBLIGHT_ENABLE = no