[Keyboard] Add stront keyboard (#21035)

1 files changed, 305 insertions, 0 deletions

diff --git a/keyboards/stront/keymaps/zzeneg/keymap.c b/keyboards/stront/keymaps/zzeneg/keymap.c
new file mode 100644
index 0000000000..67cc52e142
--- /dev/null
+++ b/keyboards/stront/keymaps/zzeneg/keymap.c
@@ -0,0 +1,305 @@
+// Copyright 2022 zzeneg (@zzeneg)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+#include "zzeneg_display.h"
+#include "raw_hid.h"
+#include "transactions.h"
+
+// Left-hand home row mods
+#define HOME_A LGUI_T(KC_A)
+#define HOME_S LALT_T(KC_S)
+#define HOME_D LCTL_T(KC_D)
+#define HOME_F LSFT_T(KC_F)
+
+// Right-hand home row mods
+#define HOME_J RSFT_T(KC_J)
+#define HOME_K RCTL_T(KC_K)
+#define HOME_L LALT_T(KC_L)
+#define HOME_P RGUI_T(KC_P)
+
+// bottom mods
+#define SYM_SPC LT(_SYMBOL, KC_SPC)
+#define NUM_TAB LT(_NUMBER, KC_TAB)
+#define FUNC_ESC LT(_FUNC, KC_ESC)
+#define FUNC_ENT LT(_FUNC, KC_ENT)
+#define NAV_BSPC LT(_NAV, KC_BSPC)
+#define EU_DEL LT(_EU, KC_DEL)
+
+// game layer mods
+#define LALT_Q LALT_T(KC_Q)
+#define LSFT_MINS LSFT_T(KC_MINS)
+#define LCTL_ESC LCTL_T(KC_ESC)
+#define LGUI_QUOT LGUI_T(KC_QUOT)
+
+enum custom_keycodes {
+    M_EMAIL = SAFE_RANGE,
+    M_CBR,
+    M_PRN,
+    M_BRC,
+    M_ARROW,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /* QWERTY
+     *               .---------------------------.                    .---------------------------.
+     *               |   W  |   E  |   R  |   T  |                    |   Y  |   U  |   I  |   O  |
+     * .------+------+------+------+------+------|                    |------+------+------+------+------+------.
+     * |  Q   |   A  |   S  |   D  |   F  |   G  |                    |   H  |   J  |   K  |   L  |   P  |  ;   |
+     * |------+------+------+------+------+------|                    |------+------+------+------+------+------|
+     * |  -   |   Z  |   X  |   C  |   V  |   B  |--------.  .--------|   N  |   M  |   ,  |   .  |   /  |  '   |
+     * '-----------------------------------------/       /    \       \-----------------------------------------'
+     *                         | Esc  | Tab  |  / Space /      \ Enter \  | Bsps | Del  |
+     *                         |_FUNC | _NUM | /_SYMBOL/        \ _FUNC \ | _NAV | _EU  |
+     *                         `-------------''-------'          '-------''-------------'
+     */
+    // clang-format off
+    [_QWERTY] = LAYOUT(
+                            KC_W,    KC_E,    KC_R,    KC_T,                KC_Y,    KC_U,    KC_I,     KC_O,
+        KC_Q,     HOME_A,   HOME_S,  HOME_D,  HOME_F,  KC_G,                KC_H,    HOME_J,  HOME_K,   HOME_L,  HOME_P,   KC_SCLN,
+        KC_MINS,  KC_Z,     KC_X,    KC_C,    KC_V,    KC_B,                KC_N,    KC_M,    KC_COMM,  KC_DOT,  KC_SLSH,  KC_QUOT,
+                                   FUNC_ESC,  NUM_TAB,  SYM_SPC,     FUNC_ENT,  NAV_BSPC,  EU_DEL
+    ),
+
+    [_GAME] = LAYOUT(
+                            KC_W,    KC_E,    KC_R,    KC_T,               KC_Y,    KC_U,    KC_I,     KC_O,
+        LALT_Q,     KC_A,   KC_S,    KC_D,    KC_F,    KC_G,               KC_H,    KC_J,    KC_K,     KC_L,    KC_P,     KC_SCLN,
+        LSFT_MINS,  KC_Z,   KC_X,    KC_C,    KC_V,    KC_B,               KC_N,    KC_M,    KC_COMM,  KC_DOT,  KC_SLSH,  LGUI_QUOT,
+                                    LCTL_ESC,  NUM_TAB,  SYM_SPC,    FUNC_ENT,  NAV_BSPC,  EU_DEL
+    ),
+
+    [_EU] = LAYOUT(
+                               XXXXXXX,     RALT(KC_E),  XXXXXXX,     M_CBR,               KC_MUTE,     RALT(KC_U),  XXXXXXX,  RALT(KC_O),
+        XXXXXXX,  RALT(KC_A),  RALT(KC_S),  LCTL(KC_C),  KC_LSFT,     M_PRN,               M_EMAIL,     KC_RSFT,     M_ARROW,  RALT(KC_L),  XXXXXXX,  XXXXXXX,
+        XXXXXXX,  RALT(KC_Z),  RALT(KC_X),  RALT(KC_C),  LCTL(KC_V),  M_BRC,               RALT(KC_N),  XXXXXXX,     XXXXXXX,  XXXXXXX,     XXXXXXX,  XXXXXXX,
+                                                 FUNC_ESC,   NUM_TAB,   SYM_SPC,      XXXXXXX,  XXXXXXX,   _______
+    ),
+
+    [_NAV] = LAYOUT(
+                            XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,             XXXXXXX,        XXXXXXX,  KC_PGDN,  KC_PGUP,
+        XXXXXXX,  KC_LGUI,  KC_LALT,  KC_LCTL,  KC_LSFT,  XXXXXXX,             LALT(KC_UP),    KC_LEFT,  KC_DOWN,  KC_UP,    KC_RGHT,  KC_PAUS,
+        XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,             LALT(KC_DOWN),  KC_HOME,  KC_END,   KC_INS,   KC_APP,   XXXXXXX,
+                                       FUNC_ESC,   NUM_TAB,   SYM_SPC,     XXXXXXX,  _______,  EU_DEL
+    ),
+
+    [_NUMBER] = LAYOUT(
+                           KC_7,    KC_8,    KC_9,    KC_PLUS,             XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,
+        KC_GRV,   KC_0,    KC_4,    KC_5,    KC_6,    KC_DOT,              XXXXXXX,  KC_RSFT,  KC_RCTL,  KC_LALT,  KC_RGUI,  XXXXXXX,
+        KC_BSPC,  KC_AT,   KC_1,    KC_2,    KC_3,    KC_ASTR,             XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,
+                                    KC_ENT,  _______,  TG(_GAME),       FUNC_ENT,  NAV_BSPC,  EU_DEL
+    ),
+
+    [_SYMBOL] = LAYOUT(
+                            KC_PERC,  KC_PLUS,  KC_LCBR,  KC_RCBR,            XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,
+        KC_DLR,   KC_AMPR,  KC_EXLM,  KC_EQL,   KC_LPRN,  KC_RPRN,            XXXXXXX,  KC_RSFT,  KC_RCTL,  KC_LALT,  KC_RGUI,  XXXXXXX,
+        KC_BSLS,  KC_PIPE,  KC_HASH,  KC_ASTR,  KC_LBRC,  KC_RBRC,            XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,
+                                         MO(_SYS),  KC_BSPC, _______,     FUNC_ENT,  NAV_BSPC,  EU_DEL
+    ),
+
+    [_FUNC] = LAYOUT(
+                            KC_F7,   KC_F8,   KC_F9,   KC_CAPS,            XXXXXXX,  KC_PSCR,  KC_SCRL,  KC_NUM,
+        KC_LCTL,  KC_F11,   KC_F4,   KC_F5,   KC_F6,   KC_F12,             XXXXXXX,  KC_RSFT,  KC_RCTL,  KC_LALT,  KC_RGUI,  XXXXXXX,
+        KC_CIRC,  KC_F10,   KC_F1,   KC_F2,   KC_F3,   KC_TILD,            XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,
+                                         _______, KC_MNXT, KC_MPLY,     _______, XXXXXXX,  MO(_SYS)
+    ),
+
+    [_SYS] = LAYOUT(
+                            BL_DOWN,  BL_UP,    BL_TOGG,  XXXXXXX,            XXXXXXX,   RGB_TOG,  RGB_MOD,  RGB_RMOD,
+        XXXXXXX,  XXXXXXX,  DT_UP,    DT_DOWN,  DT_PRNT,  XXXXXXX,            XXXXXXX,   RGB_HUI,  RGB_SAI,  RGB_VAI,  RGB_SPI,  RGB_M_P,
+        EH_LEFT,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  EH_RGHT,            EH_RGHT,  RGB_HUD,  RGB_SAD,  RGB_VAD,  RGB_SPD,  EH_LEFT,
+                                            _______, QK_BOOT, _______,     _______, QK_BOOT, _______
+    )
+    // clang-format on
+};
+
+#ifdef ENCODER_MAP_ENABLE
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+    // clang-format off
+    [_QWERTY] = { ENCODER_CCW_CW(KC_LEFT, KC_RGHT), ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
+    [_GAME]   = { ENCODER_CCW_CW(KC_LEFT, KC_RGHT), ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
+    [_EU]     = { ENCODER_CCW_CW(KC_LEFT, KC_RGHT), ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
+    [_NAV]    = { ENCODER_CCW_CW(KC_LEFT, KC_RGHT), ENCODER_CCW_CW(KC_MPRV, KC_MNXT) },
+    [_NUMBER] = { ENCODER_CCW_CW(KC_LEFT, KC_RGHT), ENCODER_CCW_CW(KC_MPRV, KC_MNXT) },
+    [_SYMBOL] = { ENCODER_CCW_CW(KC_LEFT, KC_RGHT), ENCODER_CCW_CW(KC_MPRV, KC_MNXT) },
+    [_FUNC]   = { ENCODER_CCW_CW(KC_LEFT, KC_RGHT), ENCODER_CCW_CW(KC_MPRV, KC_MNXT) },
+    [_SYS]    = { ENCODER_CCW_CW(BL_DOWN, BL_UP),   ENCODER_CCW_CW(KC_MPRV, KC_MNXT) }
+    // clang-format on
+};
+#endif // ENCODER_MAP_ENABLE
+
+/* different tapping term for different fingers */
+uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record) {
+    switch (keycode) {
+        // pinkies
+        case HOME_A:
+        case HOME_P:
+            return 250;
+        // ring
+        case HOME_S:
+        case HOME_L:
+            return 200;
+        // middle
+        case HOME_D:
+        case HOME_K:
+            return 160;
+        // index
+        case HOME_F:
+        case HOME_J:
+            return 140;
+        // thumb and game
+        default:
+            return TAPPING_TERM;
+    }
+}
+
+/* helper function for custom increased tapping term for home row CTRL + other keys */
+uint16_t HOME_CTRL_pressed_time = 0;
+void     custom_home_row_ctrl(keyrecord_t *record, uint16_t time) {
+    if (record->tap.count && get_mods() & MOD_MASK_CTRL) {
+        if (TIMER_DIFF_16(record->event.time, HOME_CTRL_pressed_time) < time) {
+            del_mods(MOD_MASK_CTRL);
+            tap_code(KC_D);
+        }
+    }
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    dprintf("process_record_user %u %s %s %d\n", keycode, record->event.pressed ? "pressed" : "depressed", record->tap.interrupted ? "interrupted" : "not interrupted", record->tap.count);
+
+    if (record->event.pressed) {
+        uint8_t data[32];
+        data[0] = 0;
+
+        switch (keycode) {
+            // send hid commands
+            case KC_VOLU:
+            case KC_VOLD:
+                data[0] = _VOLUME;
+                break;
+
+            // handle macros
+            case M_EMAIL:
+                SEND_STRING("zzeneg@gmail.com");
+                break;
+            case M_CBR:
+                SEND_STRING("{}" SS_TAP(X_LEFT));
+                break;
+            case M_PRN:
+                SEND_STRING("()" SS_TAP(X_LEFT));
+                break;
+            case M_BRC:
+                SEND_STRING("[]" SS_TAP(X_LEFT));
+                break;
+            case M_ARROW:
+                SEND_STRING("=>");
+                break;
+
+            // custom increased tapping term for home row CTRL + other keys
+            case HOME_D:
+                // save time when CTRL from D key is pressed
+                if (!record->tap.count) {
+                    HOME_CTRL_pressed_time = record->event.time;
+                }
+                break;
+            case HOME_S:
+                // if S is pressed and CTRL is active, and < 150 passed since CTRL was pressed, cancel CTRL and send D instead
+                custom_home_row_ctrl(record, 150);
+                break;
+            case HOME_A:
+                // if A is pressed and CTRL is active, and < 180 passed since CTRL was pressed, cancel CTRL and send D instead
+                custom_home_row_ctrl(record, 180);
+                break;
+        }
+
+        if (data[0]) {
+            dprintf("raw_hid_send %u\n", data[0]);
+            raw_hid_send(data, sizeof(data));
+        }
+    }
+
+    return true;
+}
+
+/* Active Layer processing */
+layer_state_t layer_state_set_user(layer_state_t state) {
+    if (is_display_enabled()) {
+        display_process_layer_state(get_highest_layer(state));
+    } else if (is_keyboard_master() && !is_keyboard_left()) {
+        uint8_t layer = get_highest_layer(state);
+        dprintf("RPC_ID_USER_LAYER_SYNC: %u\n", layer);
+        transaction_rpc_send(RPC_ID_USER_LAYER_SYNC, 1, &layer);
+    }
+
+    return state;
+}
+
+/* Caps Word processing */
+void caps_word_set_user(bool active) {
+    if (is_display_enabled()) {
+        display_process_caps_word(active);
+    } else if (is_keyboard_master() && !is_keyboard_left()) {
+        dprintf("RPC_ID_USER_CAPS_WORD_SYNC: %s\n", active ? "active" : "inactive");
+        transaction_rpc_send(RPC_ID_USER_CAPS_WORD_SYNC, 1, &active);
+    }
+}
+
+/* default caps word logic that allows KC_MINS. Underscore can be typed with KC_RSFT + KC_MINS */
+bool caps_word_press_user(uint16_t keycode) {
+    switch (keycode) {
+        // Keycodes that continue Caps Word, with shift applied.
+        case KC_A ... KC_Z:
+            add_weak_mods(MOD_BIT(KC_LSFT)); // Apply shift to next key.
+            return true;
+
+        // Keycodes that continue Caps Word, without shifting.
+        case KC_1 ... KC_0:
+        case KC_BSPC:
+        case KC_DEL:
+        case KC_MINS:
+        case KC_RSFT:
+            return true;
+
+        default:
+            return false; // Deactivate Caps Word.
+    }
+}
+
+/* Raw HID processing*/
+void raw_hid_receive(uint8_t *data, uint8_t length) {
+    dprintf("raw_hid_receive - received %u bytes \n", length);
+
+    if (is_display_enabled()) {
+        display_process_raw_hid_data(data, length);
+    } else if (is_keyboard_master() && !is_keyboard_left()) {
+        dprint("RPC_ID_USER_HID_SYNC \n");
+        transaction_rpc_send(RPC_ID_USER_HID_SYNC, length, data);
+    }
+}
+
+void hid_sync(uint8_t initiator2target_buffer_size, const void *initiator2target_buffer, uint8_t target2initiator_buffer_size, void *target2initiator_buffer) {
+    if (is_display_enabled()) {
+        display_process_raw_hid_data((uint8_t *)initiator2target_buffer, initiator2target_buffer_size);
+    }
+}
+
+void layer_sync(uint8_t initiator2target_buffer_size, const void *initiator2target_buffer, uint8_t target2initiator_buffer_size, void *target2initiator_buffer) {
+    if (is_display_enabled()) {
+        display_process_layer_state(*(uint8_t *)initiator2target_buffer);
+    }
+}
+
+void caps_word_sync(uint8_t initiator2target_buffer_size, const void *initiator2target_buffer, uint8_t target2initiator_buffer_size, void *target2initiator_buffer) {
+    if (is_display_enabled()) {
+        display_process_caps_word(*(bool *)initiator2target_buffer);
+    }
+}
+
+void keyboard_post_init_user() {
+    // sync received hid data
+    transaction_register_rpc(RPC_ID_USER_HID_SYNC, hid_sync);
+    // sync highest layer (a bit more performant than standard SPLIT_LAYER_STATE_ENABLE)
+    transaction_register_rpc(RPC_ID_USER_LAYER_SYNC, layer_sync);
+    // sync caps word state
+    transaction_register_rpc(RPC_ID_USER_CAPS_WORD_SYNC, caps_word_sync);
+}