Keychron q9 plus

keyboards/keychron/q9_plus/ansi_encoder/ansi_encoder.c

@@ -0,0 +1,85 @@
+/* Copyright 2023 @ 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 "quantum.h"
+
+#ifdef RGB_MATRIX_ENABLE
+const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to CKLED2001 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_13,   D_13,   E_13},
+    {0, F_10,   D_10,   E_10},
+    {0, F_7,    D_7,    E_7},
+    {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},
+};
+#endif

keyboards/keychron/q9_plus/ansi_encoder/config.h

@@ -0,0 +1,26 @@
+/* Copyright 2023 @ 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 RGB_MATRIX_LED_COUNT 53
+
+/* Encoder Configuration */
+#define ENCODER_DEFAULT_POS 0x3
+
+/* Enable caps-lock LED */
+#define CAPS_LOCK_LED_INDEX 14

keyboards/keychron/q9_plus/ansi_encoder/info.json

@@ -0,0 +1,66 @@
+{
+    "usb": {
+        "pid": "0x0194",
+        "device_version": "1.0.0"
+    },
+    "rgb_matrix": {
+        "layout": [
+            {"matrix":[0, 0],  "flags":1, "x":2,   "y":0},
+            {"matrix":[0, 1],  "flags":4, "x":20,  "y":0},
+            {"matrix":[0, 2],  "flags":4, "x":35,  "y":0},
+            {"matrix":[0, 3],  "flags":4, "x":50,  "y":0},
+            {"matrix":[0, 4],  "flags":4, "x":65,  "y":0},
+            {"matrix":[0, 5],  "flags":4, "x":80,  "y":0},
+            {"matrix":[0, 6],  "flags":4, "x":94,  "y":0},
+            {"matrix":[0, 7],  "flags":4, "x":109, "y":0},
+            {"matrix":[0, 8],  "flags":4, "x":124, "y":0},
+            {"matrix":[0, 9],  "flags":4, "x":139, "y":0},
+            {"matrix":[0, 10], "flags":4, "x":154, "y":0},
+            {"matrix":[0, 11], "flags":4, "x":168, "y":0},
+            {"matrix":[0, 12], "flags":1, "x":183, "y":0},
+            {"matrix":[0, 13], "flags":1, "x":202, "y":0},
+
+            {"matrix":[1, 0],  "flags":8, "x":4,   "y":21},
+            {"matrix":[1, 1],  "flags":4, "x":24,  "y":21},
+            {"matrix":[1, 2],  "flags":4, "x":39,  "y":21},
+            {"matrix":[1, 3],  "flags":4, "x":54,  "y":21},
+            {"matrix":[1, 4],  "flags":4, "x":68,  "y":21},
+            {"matrix":[1, 5],  "flags":4, "x":83,  "y":21},
+            {"matrix":[1, 6],  "flags":4, "x":98,  "y":21},
+            {"matrix":[1, 7],  "flags":4, "x":113, "y":21},
+            {"matrix":[1, 8],  "flags":4, "x":128, "y":21},
+            {"matrix":[1, 9],  "flags":4, "x":142, "y":21},
+            {"matrix":[1, 10], "flags":4, "x":157, "y":21},
+            {"matrix":[1, 11], "flags":4, "x":172, "y":21},
+            {"matrix":[1, 13], "flags":1, "x":196, "y":21},
+            {"matrix":[1, 14], "flags":1, "x":224, "y":21},
+
+            {"matrix":[2, 0],  "flags":1, "x":7,   "y":43},
+            {"matrix":[2, 2],  "flags":4, "x":31,  "y":43},
+            {"matrix":[2, 3],  "flags":4, "x":46,  "y":43},
+            {"matrix":[2, 4],  "flags":4, "x":61,  "y":43},
+            {"matrix":[2, 5],  "flags":4, "x":76,  "y":43},
+            {"matrix":[2, 6],  "flags":4, "x":91,  "y":43},
+            {"matrix":[2, 7],  "flags":4, "x":105, "y":43},
+            {"matrix":[2, 8],  "flags":4, "x":120, "y":43},
+            {"matrix":[2, 9],  "flags":4, "x":135, "y":43},
+            {"matrix":[2, 10], "flags":4, "x":150, "y":43},
+            {"matrix":[2, 11], "flags":4, "x":165, "y":43},
+            {"matrix":[2, 13], "flags":1, "x":185, "y":43},
+            {"matrix":[2, 14], "flags":1, "x":205, "y":43},
+
+            {"matrix":[3, 0],  "flags":1, "x":0,   "y":64},
+            {"matrix":[3, 1],  "flags":1, "x":18,  "y":64},
+            {"matrix":[3, 2],  "flags":1, "x":37,  "y":64},
+            {"matrix":[3, 3],  "flags":1, "x":55,  "y":64},
+            {"matrix":[3, 6],  "flags":4, "x":81,  "y":64},
+            {"matrix":[3, 9],  "flags":4, "x":118, "y":64},
+            {"matrix":[3, 10], "flags":1, "x":146, "y":64},
+            {"matrix":[3, 11], "flags":1, "x":161, "y":64},
+            {"matrix":[3, 12], "flags":1, "x":176, "y":64},
+            {"matrix":[3, 13], "flags":1, "x":190, "y":64},
+            {"matrix":[3, 14], "flags":1, "x":205, "y":64},
+            {"matrix":[1, 12], "flags":1, "x":224, "y":64}
+        ]
+    }
+}

keyboards/keychron/q9_plus/ansi_encoder/keymaps/default/keymap.c

@@ -0,0 +1,71 @@
+/* Copyright 2023 @ 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
+
+enum layers{
+    MAC_BASE,
+    WIN_BASE,
+    MAC_FN1,
+    WIN_FN1,
+    FN2,
+};
+
+#define KC_TASK LGUI(KC_TAB)
+#define KC_FLXP LGUI(KC_E)
+
+// clang-format off
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [MAC_BASE] = LAYOUT_54_ansi(
+        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_MUTE,
+        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,  MO(MAC_FN1),      KC_SPC,                    KC_SPC,           KC_RCMD,  MO(MAC_FN1), MO(FN2),  KC_LEFT, KC_DOWN, KC_RGHT),
+
+    [WIN_BASE] = LAYOUT_54_ansi(
+        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_MUTE,
+        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,  MO(WIN_FN1),      KC_SPC,                    KC_SPC,           KC_RALT,  MO(WIN_FN1), MO(FN2),  KC_LEFT, KC_DOWN, KC_RGHT),
+
+    [MAC_FN1] = LAYOUT_54_ansi(
+        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_TOG, RGB_MOD,  RGB_VAI,  RGB_HUI, RGB_SAI, RGB_SPI, _______, _______, _______, _______, _______,  _______,               _______,          _______,
+        _______,           RGB_RMOD, RGB_VAD, RGB_HUD, RGB_SAD, RGB_SPD, NK_TOGG, _______, _______, _______,  _______,               _______, _______,
+        _______, _______,  _______,  _______,          _______,                   _______,          _______,  _______,     _______,  _______, _______, _______),
+
+    [WIN_FN1] = LAYOUT_54_ansi(
+        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_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_54_ansi(
+        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,     _______,               _______,          _______,
+        _______,           _______,  _______, _______, _______, _______, _______, _______, _______, _______,  _______,               _______, _______,
+        _______, _______,  _______,  _______,          _______,                   _______,          _______,  _______,     _______,  _______, _______, _______)
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+    [MAC_BASE] = {ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},
+    [WIN_BASE] = {ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},
+    [MAC_FN1]  = {ENCODER_CCW_CW(RGB_VAD, RGB_VAI)},
+    [WIN_FN1]  = {ENCODER_CCW_CW(RGB_VAD, RGB_VAI)},
+    [FN2]      = {ENCODER_CCW_CW(_______, _______)}
+};
+#endif

keyboards/keychron/q9_plus/ansi_encoder/keymaps/default/rules.mk

@@ -0,0 +1,2 @@
+VIA_ENABLE = yes
+ENCODER_MAP_ENABLE = yes

keyboards/keychron/q9_plus/ansi_encoder/keymaps/keychron/keymap.c

@@ -0,0 +1,80 @@
+/* Copyright 2023 @ 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"
+
+enum layers{
+    MAC_BASE,
+    WIN_BASE,
+    MAC_FN1,
+    WIN_FN1,
+    FN2,
+};
+
+// clang-format off
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [MAC_BASE] = LAYOUT_54_ansi(
+        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_MUTE,
+        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, MO(MAC_FN1),      KC_SPC,                    KC_SPC,           KC_RCMMD, MO(MAC_FN1), MO(FN2),  KC_LEFT, KC_DOWN, KC_RGHT),
+
+    [WIN_BASE] = LAYOUT_54_ansi(
+        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_MUTE,
+        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,  MO(WIN_FN1),      KC_SPC,                    KC_SPC,           KC_RALT,  MO(WIN_FN1), MO(FN2),  KC_LEFT, KC_DOWN, KC_RGHT),
+
+    [MAC_FN1] = LAYOUT_54_ansi(
+        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_TOG, RGB_MOD,  RGB_VAI,  RGB_HUI, RGB_SAI, RGB_SPI, _______, _______, _______, _______, _______,  _______,               _______,          _______,
+        _______,           RGB_RMOD, RGB_VAD, RGB_HUD, RGB_SAD, RGB_SPD, NK_TOGG, _______, _______, _______,  _______,               _______, _______,
+        _______, _______,  _______,  _______,          _______,                   _______,          _______,  _______,     _______,  _______, _______, _______),
+
+    [WIN_FN1] = LAYOUT_54_ansi(
+        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_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_54_ansi(
+        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,     _______,               _______,          _______,
+        _______,           _______,  _______, _______, _______, _______, _______, _______, _______, _______,  _______,               _______, _______,
+        _______, _______,  _______,  _______,          _______,                   _______,          _______,  _______,     _______,  _______, _______, _______)
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+    [MAC_BASE] = {ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},
+    [WIN_BASE] = {ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},
+    [MAC_FN1]  = {ENCODER_CCW_CW(RGB_VAD, RGB_VAI)},
+    [WIN_FN1]  = {ENCODER_CCW_CW(RGB_VAD, RGB_VAI)},
+    [FN2]      = {ENCODER_CCW_CW(_______, _______)}
+};
+#endif
+
+void housekeeping_task_user(void) {
+    housekeeping_task_keychron();
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    if (!process_record_keychron(keycode, record)) {
+        return false;
+    }
+    return true;
+}

keyboards/keychron/q9_plus/ansi_encoder/keymaps/keychron/rules.mk

@@ -0,0 +1,5 @@
+VIA_ENABLE = yes
+ENCODER_MAP_ENABLE = yes
+
+VPATH += keyboards/keychron/common
+SRC += keychron_common.c