[Keymap] teimor keymap for Keychron Q1 (#16396)

* teimor keymap * quickfix and cleanup * update readme * quickfix and cleanup before pr * clang * clean layout * add reset * pr fix * fix pr * Rename README.md to readme.md
3 years ago · 28f9def219
parent 05f6838f37
commit 28f9def219
14 changed files with 579 additions and 0 deletions
--- a/keyboards/keychron/q1/rev_0100/keymaps/teimor/config.h
+++ b/keyboards/keychron/q1/rev_0100/keymaps/teimor/config.h
@ -0,0 +1,32 @@
+/* Copyright 2022 @ Teimor Epstein
+ *
+ * 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 TAPPING_TERM
+#define TAPPING_TERM 200
+
+/* RGB Matrix Configuration */
+#ifdef RGB_MATRIX_ENABLE
+#    define RGB_DISABLE_WHEN_USB_SUSPENDED
+#    define MAC_LAYER_DEFAULT_COLOR RGB_CYAN
+#    define WIN_LAYER_DEFAULT_COLOR RGB_GREEN
+#    define CAPS_LOCK_INDICATOR_COLOR RGB_RED
+#    define CAPS_LOCK_INDICATOR_LIGHT_60
+#    define FN_LAYER_TRANSPARENT_KEYS_OFF
+#    define RGB_MATRIX_STARTUP_MODE RGB_MATRIX_SOLID_COLOR        // Sets the default mode, if none has been set
+#    define RGB_MATRIX_STARTUP_VAL RGB_MATRIX_MAXIMUM_BRIGHTNESS  // Sets the default brightness value, if none has been set
+#endif
--- a/keyboards/keychron/q1/rev_0100/keymaps/teimor/keymap.c
+++ b/keyboards/keychron/q1/rev_0100/keymaps/teimor/keymap.c
@ -0,0 +1,95 @@
+/* Copyright 2022 @ Teimor Epstein
+ *
+ * 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 "keymap_user.h"
+#ifdef RGB_MATRIX_ENABLE
+#    include "rgb_matrix_user.h"
+#endif
+
+// clang-format off
+
+enum custom_keycodes {
+    KC_MISSION_CONTROL = USER00,
+    KC_LAUNCHPAD,
+};
+
+#define KC_MCTL KC_MISSION_CONTROL
+#define KC_LPAD KC_LAUNCHPAD
+#define TG_NKRO MAGIC_TOGGLE_NKRO
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [MAC_BASE] = LAYOUT_ansi_82(
+        KC_ESC,             KC_F1,    KC_F2,    KC_F3,    KC_F4,    KC_F5,    KC_F6,    KC_F7,    KC_F8,    KC_F9,    KC_F10,   KC_F11,   KC_F12,  KC_DEL,   KC_HOME,
+        KC_GRV,   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_END,
+        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_BSLS,           KC_PGUP,
+        KC_LGMAC, KC_A,     KC_S,     KC_D,     KC_F,     KC_G,     KC_H,     KC_J,     KC_K,     KC_L,     KC_SCLN,  KC_QUOT,            KC_ENT,            KC_PGDN,
+        KC_LSFT,            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_RGUI,  KC_MACFN, KC_RCTL,  KC_LEFT,  KC_DOWN, KC_RGHT),
+ 
+    [MAC_FN] = LAYOUT_ansi_82(
+        _______,            KC_BRID,  KC_BRIU,  KC_MCTL,  KC_LPAD,  RGB_VAD,  RGB_VAI,  KC_MPRV,  KC_MPLY,  KC_MNXT,  KC_MUTE,  KC_VOLD,  KC_VOLU,  KC_MACPS, KC_INS,
+        _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,            _______,
+        RGB_TOG,  RGB_MOD,  RGB_VAI,  RGB_HUI,  RGB_SAI,  RGB_SPI,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  RESET,              _______,
+        KC_CAPS,  RGB_RMOD, RGB_VAD,  RGB_HUD,  RGB_SAD,  RGB_SPD,  _______,  _______,  _______,  KC_LMAC,  _______,  _______,            _______,            _______,
+        _______,            _______,  _______,  _______,  _______,  _______,  TG_NKRO,  _______,  _______,  _______,  _______,            _______,  _______,
+        _______,  _______,  _______,                                _______,                                _______,  _______,  _______,  _______,  _______,  _______),
+
+    [WIN_BASE] = LAYOUT_ansi_82(
+        KC_ESC,             KC_F1,    KC_F2,    KC_F3,    KC_F4,    KC_F5,    KC_F6,    KC_F7,    KC_F8,    KC_F9,    KC_F10,   KC_F11,   KC_F12,   KC_DEL,   KC_HOME,
+        KC_GRV,   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_END,
+        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_BSLS,            KC_PGUP,
+        KC_LGWIN, KC_A,     KC_S,     KC_D,     KC_F,     KC_G,     KC_H,     KC_J,     KC_K,     KC_L,     KC_SCLN,  KC_QUOT,            KC_ENT,             KC_PGDN,
+        KC_LSFT,            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_LGUI,  KC_LALT,                                KC_SPC,                                 KC_RALT,  KC_WINFN, KC_RCTL,  KC_LEFT,  KC_DOWN,  KC_RGHT),
+
+    [WIN_FN] = LAYOUT_ansi_82(
+        _______,            KC_BRID,  KC_BRIU,  KC_TASK,  KC_FLXP,  RGB_VAD,  RGB_VAI,  KC_MPRV,  KC_MPLY,  KC_MNXT,  KC_MUTE,  KC_VOLD,  KC_VOLU,  KC_PSCR,  KC_INS,
+        _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,            _______,
+        RGB_TOG,  RGB_MOD,  RGB_VAI,  RGB_HUI,  RGB_SAI,  RGB_SPI,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  RESET,              _______,
+        KC_CAPS,  RGB_RMOD, RGB_VAD,  RGB_HUD,  RGB_SAD,  RGB_SPD,  _______,  _______,  _______,  _______,  _______,  _______,            _______,            _______,
+        _______,            _______,  _______,  _______,  _______,  _______,  TG_NKRO,  _______,  _______,  _______,  _______,            _______,  _______,
+        _______,  _______,  _______,                                _______,                                _______,  _______,  _______,  _______,  _______,  _______)
+};
+
+// clang-format on
+
+void matrix_init_user(void) {
+#ifdef RGB_MATRIX_ENABLE
+    rgb_matrix_init_user();
+#endif
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    switch (keycode) {
+        case KC_MISSION_CONTROL:
+            if (record->event.pressed) {
+                host_consumer_send(0x29F);
+            } else {
+                host_consumer_send(0);
+            }
+            return false;  // Skip all further processing of this key
+        case KC_LAUNCHPAD:
+            if (record->event.pressed) {
+                host_consumer_send(0x2A0);
+            } else {
+                host_consumer_send(0);
+            }
+            return false;  // Skip all further processing of this key
+        default:
+            return true;  // Process all other keycodes normally
+    }
+}
--- a/keyboards/keychron/q1/rev_0100/keymaps/teimor/keymap_user.h
+++ b/keyboards/keychron/q1/rev_0100/keymaps/teimor/keymap_user.h
@ -0,0 +1,48 @@
+/* Copyright 2022 @ Teimor Epstein
+ *
+ * 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
+
+// clang-format off
+
+enum layers {
+    MAC_BASE,
+    MAC_FN,
+    WIN_BASE,
+    WIN_FN
+};
+
+// clang-format on
+
+// Tap dance enums
+enum {
+    MAC_CAPS_LANGUAGE_CHANGE,
+    WIN_CAPS_LANGUAGE_CHANGE,
+};
+
+#ifdef TAP_DANCE_ENABLE
+#   define KC_LGMAC TD(MAC_CAPS_LANGUAGE_CHANGE)
+#   define KC_LGWIN TD(WIN_CAPS_LANGUAGE_CHANGE)
+#else
+#   define KC_LGMAC KC_CAPS
+#   define KC_LGWIN KC_CAPS
+#endif
+#define KC_MACFN MO(MAC_FN)
+#define KC_WINFN MO(WIN_FN)
+#define KC_LMAC C(G(KC_Q))
+#define KC_MACPS G(S(KC_5))
+#define KC_TASK G(KC_TAB)
+#define KC_FLXP G(KC_E)
--- a/keyboards/keychron/q1/rev_0100/keymaps/teimor/readme.md
+++ b/keyboards/keychron/q1/rev_0100/keymaps/teimor/readme.md
@ -0,0 +1,13 @@
+# teimor's Keychron Q1 keymap
+
+- Via Enabled.
+- Tap dance enabled.
+- On macOS, F3 opens Mission Control and F4 opens Launchpad without needing to configure shortcuts in System Preferences.
+- RGB lighting turns off when the computer sleeps.
+- The RGB lighting for keys that are not assigned turns off when the Fn layer is active
+- 60% layout turns red to indicate when Caps Lock is on.
+- Windows and macOS: A single tap will quickly change the language, and holding will trigger Caps Lock. (Using Tap Dance)
+- RGB Matrix based on layout - macOS base layout will turn on cyan color, Windows base layout will turn on green color.
+- `fn + N` will toggle NKRO, useful when using the keyboard on freebsd.
+- `fn + L` on macOS will lock the system.
+- `fn + del` will trigger screenshot on macOS and Windows.
--- a/keyboards/keychron/q1/rev_0100/keymaps/teimor/rgb_matrix_user.c
+++ b/keyboards/keychron/q1/rev_0100/keymaps/teimor/rgb_matrix_user.c
@ -0,0 +1,91 @@
+/* Copyright 2022 @ Teimor Epstein
+ *
+ * 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 "rgb_matrix_user.h"
+#include "keymap_user.h"
+
+keypos_t led_index_key_position[DRIVER_LED_TOTAL];
+
+void rgb_matrix_init_user(void) {
+    for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
+        for (uint8_t col = 0; col < MATRIX_COLS; col++) {
+            uint8_t led_index = g_led_config.matrix_co[row][col];
+            if (led_index != NO_LED) {
+                led_index_key_position[led_index] = (keypos_t){.row = row, .col = col};
+            }
+        }
+    }
+}
+
+void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+    uint8_t current_layer = get_highest_layer(layer_state | default_layer_state);
+    switch (current_layer) {
+        case MAC_BASE:
+        case WIN_BASE:
+#if defined CAPS_LOCK_INDICATOR_COLOR && defined MAC_LAYER_DEFAULT_COLOR && defined WIN_LAYER_DEFAULT_COLOR
+            if (host_keyboard_led_state().caps_lock) {
+                rgb_matrix_set_color_by_keycode(led_min, led_max, current_layer, is_caps_lock_indicator, CAPS_LOCK_INDICATOR_COLOR);
+            } else if (current_layer == MAC_BASE)
+                rgb_matrix_set_color_all(MAC_LAYER_DEFAULT_COLOR);
+            else if (current_layer == WIN_BASE)
+                rgb_matrix_set_color_all(WIN_LAYER_DEFAULT_COLOR);
+#endif
+            break;
+        case MAC_FN:
+        case WIN_FN:
+#if defined MAC_LAYER_DEFAULT_COLOR && defined WIN_LAYER_DEFAULT_COLOR
+            if (current_layer == MAC_FN) {
+                rgb_matrix_set_color_by_keycode(led_min, led_max, current_layer, is_not_transparent, MAC_LAYER_DEFAULT_COLOR);
+            } else if (current_layer == WIN_FN) {
+                rgb_matrix_set_color_by_keycode(led_min, led_max, current_layer, is_not_transparent, WIN_LAYER_DEFAULT_COLOR);
+            }
+#endif
+#ifdef FN_LAYER_TRANSPARENT_KEYS_OFF
+            rgb_matrix_set_color_by_keycode(led_min, led_max, current_layer, is_transparent, RGB_OFF);
+#endif
+            break;
+    }
+}
+
+void rgb_matrix_set_color_by_keycode(uint8_t led_min, uint8_t led_max, uint8_t layer, bool (*is_keycode)(uint16_t), uint8_t red, uint8_t green, uint8_t blue) {
+    for (uint8_t i = led_min; i < led_max; i++) {
+        uint16_t keycode = keymap_key_to_keycode(layer, led_index_key_position[i]);
+        if ((*is_keycode)(keycode)) {
+            rgb_matrix_set_color(i, red, green, blue);
+        }
+#if defined MAC_LAYER_DEFAULT_COLOR && defined WIN_LAYER_DEFAULT_COLOR
+        else {
+            if (layer == MAC_BASE)
+                rgb_matrix_set_color(i, MAC_LAYER_DEFAULT_COLOR);
+            else if (layer == WIN_BASE)
+                rgb_matrix_set_color(i, WIN_LAYER_DEFAULT_COLOR);
+        }
+#endif
+    }
+}
+
+bool is_caps_lock_indicator(uint16_t keycode) {
+    bool indicator = keycode == KC_CAPS || keycode == KC_LGMAC || keycode == KC_LGWIN;
+#ifdef CAPS_LOCK_INDICATOR_LIGHT_60
+    return (KC_A <= keycode && keycode <= KC_CAPS) || (KC_LEFT_CTRL <= keycode && keycode <= KC_RIGHT_GUI) || keycode == KC_MACFN || keycode == KC_WINFN || indicator;
+#else
+    return indicator;
+#endif
+}
+
+bool is_transparent(uint16_t keycode) { return keycode == KC_TRNS; }
+bool is_not_transparent(uint16_t keycode) { return keycode != KC_TRNS; }
--- a/keyboards/keychron/q1/rev_0100/keymaps/teimor/rgb_matrix_user.h
+++ b/keyboards/keychron/q1/rev_0100/keymaps/teimor/rgb_matrix_user.h
@ -0,0 +1,25 @@
+/* Copyright 2022 @ Teimor Epstein
+ *
+ * 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
+
+void rgb_matrix_init_user(void);
+
+void rgb_matrix_set_color_by_keycode(uint8_t led_min, uint8_t led_max, uint8_t layer, bool (*is_keycode)(uint16_t), uint8_t red, uint8_t green, uint8_t blue);
+
+bool is_caps_lock_indicator(uint16_t keycode);
+bool is_transparent(uint16_t keycode);
+bool is_not_transparent(uint16_t keycode);
--- a/keyboards/keychron/q1/rev_0100/keymaps/teimor/rules.mk
+++ b/keyboards/keychron/q1/rev_0100/keymaps/teimor/rules.mk
@ -0,0 +1,14 @@
+VIA_ENABLE = yes
+MOUSEKEY_ENABLE = no
+TAP_DANCE_ENABLE = yes
+
+ifeq ($(strip $(RGB_MATRIX_ENABLE)), yes)
+    SRC += rgb_matrix_user.c
+endif
+
+ifeq ($(strip $(TAP_DANCE_ENABLE)), yes)
+    SRC += tap_dance_user.c
+    SRC += tap_dance_setup.c
+    SRC += tap_dance_mac_caps.c
+    SRC += tap_dance_win_caps.c
+endif
--- a/keyboards/keychron/q1/rev_0100/keymaps/teimor/tap_dance_mac_caps.c
+++ b/keyboards/keychron/q1/rev_0100/keymaps/teimor/tap_dance_mac_caps.c
@ -0,0 +1,50 @@
+/* Copyright 2021 @ Teimor Epstein
+ *
+ * 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/>.
+ */
+
+/* macOS CapsLock language change */
+#include "tap_dance_mac_caps.h"
+
+static td_tap_t mac_caps_language_tap_state = {.is_press_action = true, .state = TD_NONE};
+
+void mac_caps_language_finished(qk_tap_dance_state_t *state, void *user_data) {
+    mac_caps_language_tap_state.state = current_dance(state);
+    switch (mac_caps_language_tap_state.state) {
+        case TD_SINGLE_TAP:
+            register_code(KC_LCTL);
+            register_code(KC_SPACE);
+            break;
+        case TD_SINGLE_HOLD:
+            register_code(KC_CAPS_LOCK);
+            break;
+        default:
+            break;
+    }
+}
+
+void mac_caps_language_reset(qk_tap_dance_state_t *state, void *user_data) {
+    switch (mac_caps_language_tap_state.state) {
+        case TD_SINGLE_TAP:
+            unregister_code(KC_SPACE);
+            unregister_code(KC_LCTL);
+            break;
+        case TD_SINGLE_HOLD:
+            unregister_code(KC_CAPS_LOCK);
+            break;
+        default:
+            break;
+    }
+    mac_caps_language_tap_state.state = TD_NONE;
+}
--- a/keyboards/keychron/q1/rev_0100/keymaps/teimor/tap_dance_mac_caps.h
+++ b/keyboards/keychron/q1/rev_0100/keymaps/teimor/tap_dance_mac_caps.h
@ -0,0 +1,23 @@
+/* Copyright 2021 @ Teimor Epstein
+ *
+ * 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/>.
+ */
+
+/* macOS CapsLock language change */
+#pragma once
+
+#include "tap_dance_setup.h"
+
+void mac_caps_language_finished(qk_tap_dance_state_t *state, void *user_data);
+void mac_caps_language_reset(qk_tap_dance_state_t *state, void *user_data);
--- a/keyboards/keychron/q1/rev_0100/keymaps/teimor/tap_dance_setup.c
+++ b/keyboards/keychron/q1/rev_0100/keymaps/teimor/tap_dance_setup.c
@ -0,0 +1,49 @@
+/* Copyright 2022 @ Teimor Epstein
+ *
+ * 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 "tap_dance_setup.h"
+
+td_state_t current_dance(qk_tap_dance_state_t *state) {
+    if (state->count == 1) {
+        if (state->interrupted || !state->pressed) return TD_SINGLE_TAP;
+        /* Key has not been interrupted, but the key is still held. Means you w ant to send a 'HOLD'. */
+        else
+            return TD_SINGLE_HOLD;
+    } else if (state->count == 2) {
+        /* TD_DOUBLE_SINGLE_TAP is to distinguish between typing "pepper", and actually wanting a double tap
+           action when hitting 'pp'. Suggested use case for this return value is when you want to send two
+           keystrokes of the key, and not the 'double tap' action/macro. */
+        if (state->interrupted)
+            return TD_DOUBLE_SINGLE_TAP;
+        else if (state->pressed)
+            return TD_DOUBLE_HOLD;
+        else
+            return TD_DOUBLE_TAP;
+    }
+
+    /* Assumes no one is trying to type the same letter three times (at least not quickly).
+      If your tap dance key is 'KC_W', and you want to type "www." quickly - then you will need to add
+      an exception here to return a 'TD_TRIPLE_SINGLE_TAP', and define that enum just like 'TD_DOUBLE_SINGLE_TAP' */
+    if (state->count == 3) {
+        if (state->interrupted)
+            return TD_TRIPLE_SINGLE_TAP;
+        else if (state->pressed)
+            return TD_TRIPLE_HOLD;
+        else
+            return TD_TRIPLE_TAP;
+
+    } else
+        return TD_UNKNOWN;
+}
--- a/keyboards/keychron/q1/rev_0100/keymaps/teimor/tap_dance_setup.h
+++ b/keyboards/keychron/q1/rev_0100/keymaps/teimor/tap_dance_setup.h
@ -0,0 +1,38 @@
+/* Copyright 2022 @ Teimor Epstein
+ *
+ * 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
+
+#include QMK_KEYBOARD_H
+
+typedef enum {
+    TD_NONE,
+    TD_UNKNOWN,
+    TD_SINGLE_TAP,
+    TD_SINGLE_HOLD,
+    TD_DOUBLE_TAP,
+    TD_DOUBLE_HOLD,
+    TD_DOUBLE_SINGLE_TAP,  // Send two single taps
+    TD_TRIPLE_TAP,
+    TD_TRIPLE_HOLD,
+    TD_TRIPLE_SINGLE_TAP  // Send three single tap
+} td_state_t;
+
+typedef struct {
+    bool       is_press_action;
+    td_state_t state;
+} td_tap_t;
+
+td_state_t current_dance(qk_tap_dance_state_t *state);
--- a/keyboards/keychron/q1/rev_0100/keymaps/teimor/tap_dance_user.c
+++ b/keyboards/keychron/q1/rev_0100/keymaps/teimor/tap_dance_user.c
@ -0,0 +1,28 @@
+/* Copyright 2022 @ Teimor Epstein
+ *
+ * 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 "keymap_user.h"
+#include "tap_dance_mac_caps.h"
+#include "tap_dance_win_caps.h"
+
+// clang-format off
+
+qk_tap_dance_action_t tap_dance_actions[] = {
+    [MAC_CAPS_LANGUAGE_CHANGE] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, mac_caps_language_finished, mac_caps_language_reset),
+    [WIN_CAPS_LANGUAGE_CHANGE] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, win_caps_language_finished, win_caps_language_reset)
+};
+
+// clang-format on
--- a/keyboards/keychron/q1/rev_0100/keymaps/teimor/tap_dance_win_caps.c
+++ b/keyboards/keychron/q1/rev_0100/keymaps/teimor/tap_dance_win_caps.c
@ -0,0 +1,50 @@
+/* Copyright 2022 @ Teimor Epstein
+ *
+ * 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/>.
+ */
+
+/* Windows CapsLock language change */
+#include "tap_dance_win_caps.h"
+
+static td_tap_t win_caps_language_tap_state = {.is_press_action = true, .state = TD_NONE};
+
+void win_caps_language_finished(qk_tap_dance_state_t *state, void *user_data) {
+    win_caps_language_tap_state.state = current_dance(state);
+    switch (win_caps_language_tap_state.state) {
+        case TD_SINGLE_TAP:
+            register_code(KC_LGUI);
+            register_code(KC_SPACE);
+            break;
+        case TD_SINGLE_HOLD:
+            register_code(KC_CAPS_LOCK);
+            break;
+        default:
+            break;
+    }
+}
+
+void win_caps_language_reset(qk_tap_dance_state_t *state, void *user_data) {
+    switch (win_caps_language_tap_state.state) {
+        case TD_SINGLE_TAP:
+            unregister_code(KC_SPACE);
+            unregister_code(KC_LGUI);
+            break;
+        case TD_SINGLE_HOLD:
+            unregister_code(KC_CAPS_LOCK);
+            break;
+        default:
+            break;
+    }
+    win_caps_language_tap_state.state = TD_NONE;
+}
--- a/keyboards/keychron/q1/rev_0100/keymaps/teimor/tap_dance_win_caps.h
+++ b/keyboards/keychron/q1/rev_0100/keymaps/teimor/tap_dance_win_caps.h
@ -0,0 +1,23 @@
+/* Copyright 2022 @ Teimor Epstein
+ *
+ * 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/>.
+ */
+
+/* Windows CapsLock language change */
+#pragma once
+
+#include "tap_dance_setup.h"
+
+void win_caps_language_finished(qk_tap_dance_state_t *state, void *user_data);
+void win_caps_language_reset(qk_tap_dance_state_t *state, void *user_data);