Add Keychron Q9 (qmk#19318)

ideas32 · Jan 25, 2023 · 495c846 · 495c846
1 parent 486894d
commit 495c846
Show file tree

Hide file tree

Showing 52 changed files with 2,195 additions and 0 deletions.
diff --git a/keyboards/keychron/q9/ansi/ansi.c b/keyboards/keychron/q9/ansi/ansi.c
@@ -0,0 +1,113 @@
+/* Copyright 2021 @ Keychron (https://www.keychron.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 "ansi.h"
+
+#ifdef RGB_MATRIX_ENABLE
+
+// clang-format off
+
+const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to CKLED manual for these locations
+ *   driver
+ *   |  R location
+ *   |  |       G location
+ *   |  |       |       B location
+ *   |  |       |       | */
+    {0, L_16,   J_16,   K_16},
+    {0, L_15,   J_15,   K_15},
+    {0, L_14,   J_14,   K_14},
+    {0, L_13,   J_13,   K_13},
+    {0, L_12,   J_12,   K_12},
+    {0, L_11,   J_11,   K_11},
+    {0, L_10,   J_10,   K_10},
+    {0, L_9,    J_9,    K_9},
+    {0, L_8,    J_8,    K_8},
+    {0, L_7,    J_7,    K_7},
+    {0, L_6,    J_6,    K_6},
+    {0, L_5,    J_5,    K_5},
+    {0, L_4,    J_4,    K_4},
+    {0, L_3,    J_3,    K_3},
+    {0, L_2,    J_2,    K_2},
+
+    {0, C_16,   A_16,   B_16},
+    {0, C_15,   A_15,   B_15},
+    {0, C_14,   A_14,   B_14},
+    {0, C_13,   A_13,   B_13},
+    {0, C_12,   A_12,   B_12},
+    {0, C_11,   A_11,   B_11},
+    {0, C_10,   A_10,   B_10},
+    {0, C_9,    A_9,    B_9},
+    {0, C_8,    A_8,    B_8},
+    {0, C_7,    A_7,    B_7},
+    {0, C_6,    A_6,    B_6},
+    {0, C_5,    A_5,    B_5},
+    {0, C_3,    A_3,    B_3},
+    {0, C_2,    A_2,    B_2},
+
+    {0, I_16,   G_16,   H_16},
+    {0, I_14,   G_14,   H_14},
+    {0, I_13,   G_13,   H_13},
+    {0, I_12,   G_12,   H_12},
+    {0, I_11,   G_11,   H_11},
+    {0, I_10,   G_10,   H_10},
+    {0, I_9,    G_9,    H_9},
+    {0, I_8,    G_8,    H_8},
+    {0, I_7,    G_7,    H_7},
+    {0, I_6,    G_6,    H_6},
+    {0, I_5,    G_5,    H_5},
+    {0, I_3,    G_3,    H_3},
+    {0, I_2,    G_2,    H_2},
+
+    {0, F_16,   D_16,   E_16},
+    {0, F_15,   D_15,   E_15},
+    {0, F_14,   D_14,   E_14},
+    {0, F_10,   D_10,   E_10},
+    {0, F_6,    D_6,    E_6},
+    {0, F_5,    D_5,    E_5},
+    {0, F_4,    D_4,    E_4},
+    {0, F_3,    D_3,    E_3},
+    {0, F_2,    D_2,    E_2},
+    {0, C_4,    A_4,    B_4}
+};
+
+#define __ NO_LED
+
+led_config_t g_led_config = {
+     {
+        // Key Matrix to LED Index
+        {  0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 14 },
+        { 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 51, 27, 28 },
+        { 29, __, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, __, 40, 41 },
+        { 42, 43, 44, __, __, __, 45, __, __, __, 46, 47, 48, 49, 50 },
+    },
+    {
+        // LED Index to Physical Position
+        {2,0},  {20,0},  {35,0},  {50,0},  {65,0},  {80,0},  {94,0},  {109,0},  {124,0},  {139,0},  {154,0},  {168,0},  {183,0},  {202,0},            {224,0},
+        {4,21}, {24,21}, {39,21}, {54,21}, {68,21}, {83,21}, {98,21}, {113,21}, {128,21}, {142,21}, {157,21}, {172,21},           {196,21},           {224,27},
+        {7,43},          {31,43}, {46,43}, {61,43}, {76,43}, {91,43}, {105,43}, {120,43}, {135,43}, {150,43}, {165,43},           {185,43}, {205,43},
+        {0,64}, {18,64}, {37,64},                            {92,64},                               {146,64}, {161,64}, {176,64}, {190,64}, {205,64}, {220,64},
+    },
+    {
+        // RGB LED Index to Flag
+        1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,    1,
+        8, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,    1,    1,
+        1,    4, 4, 4, 4, 4, 4, 4, 4, 4, 4,    1, 1,
+        1, 1, 1,          4,          1, 1, 1, 1, 1, 1,
+    }
+};
+
+#endif // RGB_MATRIX_ENABLE
diff --git a/keyboards/keychron/q9/ansi/ansi.h b/keyboards/keychron/q9/ansi/ansi.h
@@ -0,0 +1,19 @@
+/* Copyright 2021 @ Keychron (https://www.keychron.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/>.
+ */
+
+#pragma once
+
+#include "quantum.h"
diff --git a/keyboards/keychron/q9/ansi/config.h b/keyboards/keychron/q9/ansi/config.h
@@ -0,0 +1,24 @@
+/* Copyright 2021 @ Keychron (https://www.keychron.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/>.
+ */
+
+#pragma once
+
+/* RGB Matrix Configuration */
+#define DRIVER_1_LED_TOTAL 52
+#define RGB_MATRIX_LED_COUNT DRIVER_1_LED_TOTAL
+
+/* Enable caps-lock LED */
+#define CAPS_LOCK_LED_INDEX 15
diff --git a/keyboards/keychron/q9/ansi/info.json b/keyboards/keychron/q9/ansi/info.json
@@ -0,0 +1,72 @@
+{
+    "keyboard_name": "Keychron Q9",
+    "manufacturer": "Keychron",
+    "url": "https://github.com/Keychron",
+    "maintainer": "lalalademaxiya1",
+    "usb": {
+        "vid": "0x3434",
+        "pid": "0x0190",
+        "device_version": "1.0.0"
+    },
+    "layouts": {
+        "LAYOUT_ansi_52": {
+            "layout": [
+                {"matrix":[0, 0], "x":0, "y":0.25, "w":1.5},
+                {"matrix":[0, 1], "x":1.5, "y":0.25},
+                {"matrix":[0, 2], "x":2.5, "y":0.25},
+                {"matrix":[0, 3], "x":3.5, "y":0.25},
+                {"matrix":[0, 4], "x":4.5, "y":0.25},
+                {"matrix":[0, 5], "x":5.5, "y":0.25},
+                {"matrix":[0, 6], "x":6.5, "y":0.25},
+                {"matrix":[0, 7], "x":7.5, "y":0.25},
+                {"matrix":[0, 8], "x":8.5, "y":0.25},
+                {"matrix":[0, 9], "x":9.5, "y":0.25},
+                {"matrix":[0,10], "x":10.5, "y":0.25},
+                {"matrix":[0,11], "x":11.5, "y":0.25},
+                {"matrix":[0,12], "x":12.5, "y":0.25},
+                {"matrix":[0,13], "x":13.5, "y":0.25, "w":1.5},
+                {"matrix":[0,14], "x":15.25, "y":0},
+
+                {"matrix":[1, 0], "x":0, "y":1.25, "w":1.75},
+                {"matrix":[1, 1], "x":1.75, "y":1.25},
+                {"matrix":[1, 2], "x":2.75, "y":1.25},
+                {"matrix":[1, 3], "x":3.75, "y":1.25},
+                {"matrix":[1, 4], "x":4.75, "y":1.25},
+                {"matrix":[1, 5], "x":5.75, "y":1.25},
+                {"matrix":[1, 6], "x":6.75, "y":1.25},
+                {"matrix":[1, 7], "x":7.75, "y":1.25},
+                {"matrix":[1, 8], "x":8.75, "y":1.25},
+                {"matrix":[1, 9], "x":9.75, "y":1.25},
+                {"matrix":[1,10], "x":10.75, "y":1.25},
+                {"matrix":[1,11], "x":11.75, "y":1.25},
+                {"matrix":[1,13], "x":12.75, "y":1.25, "w":2.25},
+                {"matrix":[1,14], "x":15.25, "y":1.25},
+
+                {"matrix":[2, 0], "x":0, "y":2.25, "w":2.25},
+                {"matrix":[2, 2], "x":2.25, "y":2.25},
+                {"matrix":[2, 3], "x":3.25, "y":2.25},
+                {"matrix":[2, 4], "x":4.25, "y":2.25},
+                {"matrix":[2, 5], "x":5.25, "y":2.25},
+                {"matrix":[2, 6], "x":6.25, "y":2.25},
+                {"matrix":[2, 7], "x":7.25, "y":2.25},
+                {"matrix":[2, 8], "x":8.25, "y":2.25},
+                {"matrix":[2, 9], "x":9.25, "y":2.25},
+                {"matrix":[2,10], "x":10.25, "y":2.25},
+                {"matrix":[2,11], "x":11.25, "y":2.25},
+                {"matrix":[2,13], "x":12.25, "y":2.25, "w":1.75},
+                {"matrix":[2,14], "x":14.25, "y":2.5},
+
+                {"matrix":[3, 0], "x":0, "y":3.25, "w":1.25},
+                {"matrix":[3, 1], "x":1.25, "y":3.25, "w":1.25},
+                {"matrix":[3, 2], "x":2.5, "y":3.25, "w":1.25},
+                {"matrix":[3, 6], "x":3.75, "y":3.25, "w":6.25},
+                {"matrix":[3,10], "x":10, "y":3.25},
+                {"matrix":[3,11], "x":11, "y":3.25},
+                {"matrix":[3,12], "x":12, "y":3.25},
+                {"matrix":[3,13], "x":13.25, "y":3.5},
+                {"matrix":[3,14], "x":14.25, "y":3.5},
+                {"matrix":[1,12], "x":15.25, "y":3.5}
+            ]
+        }
+    }
+}
diff --git a/keyboards/keychron/q9/ansi/keymaps/default/keymap.c b/keyboards/keychron/q9/ansi/keymaps/default/keymap.c
@@ -0,0 +1,62 @@
+/* Copyright 2021 @ Keychron (https://www.keychron.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
+
+// clang-format off
+
+enum layers{
+    MAC_BASE,
+    WIN_BASE,
+    _FN1,
+    _FN2,
+    _FN3
+};
+
+#define KC_TASK LGUI(KC_TAB)
+#define KC_FLXP LGUI(KC_E)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [MAC_BASE] = LAYOUT_ansi_52(
+        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_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_ENT,           KC_HOME,
+        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_LOPT,  KC_LCMD,                             KC_SPC,                             KC_RCMD,  MO(_FN1), MO(_FN3), KC_LEFT, KC_DOWN, KC_RGHT),
+
+    [WIN_BASE] = LAYOUT_ansi_52(
+        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_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_ENT,           KC_HOME,
+        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_LWIN,  KC_LALT,                             KC_SPC,                             KC_RALT,  MO(_FN2), MO(_FN3), KC_LEFT, KC_DOWN, KC_RGHT),
+
+    [_FN1] = LAYOUT_ansi_52(
+        KC_GRV,  KC_BRID,  KC_BRIU,  KC_NO,   KC_NO,   RGB_VAD, RGB_VAI, KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE,  KC_VOLD,  KC_VOLU,  _______,          _______,
+        RGB_TOG, RGB_MOD,  RGB_VAI,  RGB_HUI, RGB_SAI, RGB_SPI, _______, _______, _______, _______, _______,  _______,            _______,          _______,
+        _______,           RGB_RMOD, RGB_VAD, RGB_HUD, RGB_SAD, RGB_SPD, NK_TOGG, _______, _______, _______,  _______,            _______, _______,
+        _______, _______,  _______,                             _______,                            _______,  _______,  _______,  _______, _______, _______),
+
+    [_FN2] = LAYOUT_ansi_52(
+        KC_GRV,  KC_BRID,  KC_BRIU,  KC_TASK, KC_FLXP, RGB_VAD, RGB_VAI, KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE,  KC_VOLD,  KC_VOLU,  _______,          _______,
+        RGB_TOG, RGB_MOD,  RGB_VAI,  RGB_HUI, RGB_SAI, RGB_SPI, _______, _______, _______, _______, _______,  _______,            _______,          _______,
+        _______,           RGB_RMOD, RGB_VAD, RGB_HUD, RGB_SAD, RGB_SPD, NK_TOGG, _______, _______, _______,  _______,            _______, _______,
+        _______, _______,  _______,                             _______,                            _______,  _______,  _______,  _______, _______, _______),
+
+    [_FN3] = LAYOUT_ansi_52(
+        KC_TILD, 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_BSPC,          _______,
+        KC_ESC,  KC_1,     KC_2,     KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,     _______,            _______,          _______,
+        _______,           _______,  _______, _______, _______, _______, _______, _______, _______, _______,  _______,            _______, _______,
+        _______, _______,  _______,                             _______,                            _______,  _______,  _______,  _______, _______, _______)
+};
diff --git a/keyboards/keychron/q9/ansi/keymaps/keychron/keymap.c b/keyboards/keychron/q9/ansi/keymaps/keychron/keymap.c
@@ -0,0 +1,69 @@
+/* Copyright 2021 @ Keychron (https://www.keychron.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
+#include "keychron_common.h"
+
+// clang-format off
+
+enum layers{
+    MAC_BASE,
+    WIN_BASE,
+    _FN1,
+    _FN2,
+    _FN3
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [MAC_BASE] = LAYOUT_ansi_52(
+        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_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_ENT,           KC_HOME,
+        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_LOPTN, KC_LCMMD,                            KC_SPC,                             KC_RCMMD, MO(_FN1), MO(_FN3), KC_LEFT, KC_DOWN, KC_RGHT),
+
+    [WIN_BASE] = LAYOUT_ansi_52(
+        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_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_ENT,           KC_HOME,
+        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_LWIN,  KC_LALT,                             KC_SPC,                             KC_RALT,  MO(_FN2), MO(_FN3), KC_LEFT, KC_DOWN, KC_RGHT),
+
+    [_FN1] = LAYOUT_ansi_52(
+        KC_GRV,  KC_BRID,  KC_BRIU,  KC_MCTL, KC_LPAD, RGB_VAD, RGB_VAI, KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE,  KC_VOLD,  KC_VOLU,  _______,          _______,
+        RGB_TOG, RGB_MOD,  RGB_VAI,  RGB_HUI, RGB_SAI, RGB_SPI, _______, _______, _______, _______, _______,  _______,            _______,          _______,
+        _______,           RGB_RMOD, RGB_VAD, RGB_HUD, RGB_SAD, RGB_SPD, NK_TOGG, _______, _______, _______,  _______,            _______, _______,
+        _______, _______,  _______,                             _______,                            _______,  _______,  _______,  _______, _______, _______),
+
+    [_FN2] = LAYOUT_ansi_52(
+        KC_GRV,  KC_BRID,  KC_BRIU,  KC_TASK, KC_FLXP, RGB_VAD, RGB_VAI, KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE,  KC_VOLD,  KC_VOLU,  _______,          _______,
+        RGB_TOG, RGB_MOD,  RGB_VAI,  RGB_HUI, RGB_SAI, RGB_SPI, _______, _______, _______, _______, _______,  _______,            _______,          _______,
+        _______,           RGB_RMOD, RGB_VAD, RGB_HUD, RGB_SAD, RGB_SPD, NK_TOGG, _______, _______, _______,  _______,            _______, _______,
+        _______, _______,  _______,                             _______,                            _______,  _______,  _______,  _______, _______, _______),
+
+    [_FN3] = LAYOUT_ansi_52(
+        KC_TILD, 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_BSPC,          _______,
+        KC_ESC,  KC_1,     KC_2,     KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,     _______,            _______,          _______,
+        _______,           _______,  _______, _______, _______, _______, _______, _______, _______, _______,  _______,            _______, _______,
+        _______, _______,  _______,                             _______,                            _______,  _______,  _______,  _______, _______, _______)
+};
+
+// clang-format on
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    if (!process_record_keychron(keycode, record)) {
+        return false;
+    }
+    return true;
+}
diff --git a/keyboards/keychron/q9/ansi/keymaps/keychron/rules.mk b/keyboards/keychron/q9/ansi/keymaps/keychron/rules.mk
@@ -0,0 +1,4 @@
+VIA_ENABLE = yes
+
+VPATH += keyboards/keychron/common
+SRC += keychron_common.c