Skip to content

Commit

Permalink
Add Keychron Q10 (qmk#19127)
Browse files Browse the repository at this point in the history 
Co-authored-by: Nick Brassel <nick@tzarc.org>
  • Loading branch information
@KeychronMacro @tzarc
KeychronMacro and tzarc authored Dec 12, 2022
1 parent bf2ed01 commit 1431f31
Show file tree
Hide file tree
Showing 31 changed files with 1,683 additions and 0 deletions.
157 changes: 157 additions & 0 deletions keyboards/keychron/q10/ansi_encoder/ansi_encoder.c
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
/* Copyright 2022 @ 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

// clang-format off

const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
/* Refer to IS31 manual for these locations
* driver
* | R location
* | | G location
* | | | B location
* | | | | */
{0, C_2, A_2, B_2}, // ESC
{0, C_3, A_3, B_3}, // F1
{0, C_4, A_4, B_4}, // F2
{0, C_5, A_5, B_5}, // F3
{0, C_6, A_6, B_6}, // F4
{0, C_7, A_7, B_7}, // F5
{0, C_8, A_8, B_8}, // F6
{0, C_9, A_9, B_9}, // F7
{0, C_10, A_10, B_10}, // F8
{0, C_11, A_11, B_11}, // F9
{0, C_12, A_12, B_12}, // F10
{0, C_13, A_13, B_13}, // F11
{0, C_14, A_14, B_14}, // F12
{0, C_15, A_15, B_15}, // INS
{0, C_16, A_16, B_16}, // DEL

{0, I_1, G_1, H_1}, // M1
{0, I_2, G_2, H_2}, // `~
{0, I_3, G_3, H_3}, // 1!
{0, I_4, G_4, H_4}, // 2@
{0, I_5, G_5, H_5}, // 3#
{0, I_6, G_6, H_6}, // 4$
{0, I_7, G_7, H_7}, // 5%
{0, I_8, G_8, H_8}, // 6^
{0, I_9, G_9, H_9}, // 7&
{0, I_10, G_10, H_10}, // 8*
{0, I_11, G_11, H_11}, // 9(
{0, I_12, G_12, H_12}, // 0)
{0, I_13, G_13, H_13}, // -_
{0, I_14, G_14, H_14}, // =+
{0, I_15, G_15, H_15}, // BackSpace
{0, I_16, G_16, H_16}, // PgUp

{0, F_1, D_1, E_1}, // M2
{0, F_2, D_2, E_2}, // TAB
{0, F_3, D_3, E_3}, // Q
{0, F_4, D_4, E_4}, // W
{0, F_5, D_5, E_5}, // E
{0, F_6, D_6, E_6}, // R
{0, F_7, D_7, E_7}, // T
{0, F_8, D_8, E_8}, // Y
{0, F_9, D_9, E_9}, // U
{0, F_10, D_10, E_10}, // I
{0, F_11, D_11, E_11}, // O
{0, F_12, D_12, E_12}, // P
{0, F_13, D_13, E_13}, // [
{0, F_14, D_14, E_14}, // ]
{0, F_15, D_15, E_15}, // |
{0, F_16, D_16, E_16}, // PgDn

{1, C_16, A_16, B_16}, // M3
{1, C_15, A_15, B_15}, // CapsLock
{1, C_14, A_14, B_14}, // A
{1, C_13, A_13, B_13}, // S
{1, C_12, A_12, B_12}, // D
{1, C_11, A_11, B_11}, // F
{1, C_10, A_10, B_10}, // G
{1, C_8, A_8, B_8}, // H
{1, C_7, A_7, B_7}, // J
{1, C_6, A_6, B_6}, // K
{1, C_5, A_5, B_5}, // L
{1, C_4, A_4, B_4}, // ;
{1, C_3, A_3, B_3}, // '
{1, C_2, A_2, B_2}, // Enter
{1, C_1, A_1, B_1}, // Home

{1, I_16, G_16, H_16}, // M4
{1, I_15, G_15, H_15}, // Shift_L
{1, I_13, G_13, H_13}, // Z
{1, I_12, G_12, H_12}, // X
{1, I_11, G_11, H_11}, // C
{1, I_10, G_10, H_10}, // V
{1, I_9, G_9, H_9}, // B
{1, I_8, G_8, H_8}, // B
{1, I_7, G_7, H_7}, // N
{1, I_6, G_6, H_6}, // M
{1, I_5, G_5, H_5}, // ,
{1, I_4, G_4, H_4}, // .
{1, I_3, G_3, H_3}, // ?
{1, I_2, G_2, H_2}, // Shift_R
{1, I_1, G_1, H_1}, // Up

{1, F_16, D_16, E_16}, // M5
{1, F_15, D_15, E_15}, // Ctrl_L
{1, F_14, D_14, E_14}, // Win_L
{1, F_13, D_13, E_13}, // Alt_L
{1, F_12, D_12, E_12}, // Space
{1, F_9, D_9, E_9}, // Fn
{1, F_8, D_8, E_8}, // Space
{1, F_7, D_7, E_7}, // Alt_R
{1, F_3, D_3, E_3}, // Left
{1, F_2, D_2, E_2}, // Down
{1, F_1, D_1, E_1}, // Right
};

#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, 27, 28, 29, 30 },
{ 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46 },
{ 47, 48, 49, 50, 51, 52, 53, __, 54, 55, 56, 57, 58, 59, 60, 61 },
{ 62, 63, __, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76 },
{ 77, 78, 79, 80, 81, __, __, 82, 83, 84, __, __, __, 85, 86, 87 },
},
{
// LED Index to Physical Position
{19,0}, {34,0}, {46,0}, {60,1}, {72,3}, {87,6}, {99,8}, {120,8}, {132,6}, {147,3}, {159,1}, {173,0}, {185,0}, {201,1}, {219,1},
{5,14}, {24,14}, {36,14}, {48,13}, {62,15}, {74,17}, {86,20}, {98,22}, {115,22}, {127,20}, {139,17}, {151,15}, {165,13}, {177,14}, {195,14}, {220,13},
{4,24}, {24,24}, {40,24}, {53,24}, {65,27}, {77,29}, {89,31}, {112,33}, {124,31}, {136,29}, {148,27}, {160,24}, {174,24}, {186,24}, {201,24}, {222,25},
{2,34}, {23,34}, {40,34}, {54,35}, {66,37}, {78,39}, {90,42}, {118,43}, {130,40}, {142,38}, {154,36}, {167,35}, {179,35}, {199,35}, {224,36},
{0,45}, {24,45}, {44,45}, {57,46}, {69,48}, {81,51}, {93,53}, {111,54}, {123,52}, {135,50}, {147,48}, {159,46}, {173,45}, {190,45}, {210,47},
{0,55}, {18,55}, {33,55}, {56,57}, {77,61}, {97,64}, {124,63}, {147,59}, {198,58}, {210,58}, {222,58},
},
{
// RGB LED Index to Flag
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1, 1,
1, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1,
1, 8, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1, 1,
1, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1, 1,
1, 1, 1, 1, 4, 1, 4, 1, 1, 1, 1,
}
};

#endif // RGB_MATRIX_ENABLE
19 changes: 19 additions & 0 deletions keyboards/keychron/q10/ansi_encoder/ansi_encoder.h
View file
Original file line number Diff line number Diff line change
@@ -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"
31 changes: 31 additions & 0 deletions keyboards/keychron/q10/ansi_encoder/config.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/* Copyright 2022 @ 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 47
#define DRIVER_2_LED_TOTAL 41
#define RGB_MATRIX_LED_COUNT (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)

/* Encoder Configuration */
#define ENCODERS_PAD_A { A10 }
#define ENCODERS_PAD_B { A8 }
#define ENCODER_RESOLUTION 4
#define ENCODER_DEFAULT_POS 0x3

/* Enable caps-lock LED */
#define CAPS_LOCK_LED_INDEX 48
111 changes: 111 additions & 0 deletions keyboards/keychron/q10/ansi_encoder/info.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
{
"keyboard_name": "Keychron Q10",
"manufacturer": "Keychron",
"url": "https://github.com/Keychron",
"maintainer": "lalalademaxiya1",
"usb": {
"vid": "0x3434",
"pid": "0x01A1",
"device_version": "1.0.0"
},
"layouts": {
"LAYOUT_ansi_89": {
"layout": [
{"matrix":[0, 0], "x":0.25, "y":0},
{"matrix":[0, 1], "x":1.75, "y":0},
{"matrix":[0, 2], "x":3, "y":0},
{"matrix":[0, 3], "x":4, "y":0},
{"matrix":[0, 4], "x":5, "y":0},
{"matrix":[0, 5], "x":6, "y":0},
{"matrix":[0, 6], "x":7.25, "y":0},
{"matrix":[0, 7], "x":8.25, "y":0},
{"matrix":[0, 8], "x":11, "y":0},
{"matrix":[0, 9], "x":12, "y":0},
{"matrix":[0,10], "x":13.25, "y":0},
{"matrix":[0,11], "x":14.25, "y":0},
{"matrix":[0,12], "x":15.25, "y":0},
{"matrix":[0,13], "x":16.25, "y":0},
{"matrix":[0,14], "x":17.5, "y":0},
{"matrix":[0,15], "x":18.75, "y":0},

{"matrix":[1, 0], "x":0.75, "y":1.25},
{"matrix":[1, 1], "x":2.25, "y":1.25},
{"matrix":[1, 2], "x":3.25, "y":1.25},
{"matrix":[1, 3], "x":4.25, "y":1.25},
{"matrix":[1, 4], "x":5.25, "y":1.25},
{"matrix":[1, 5], "x":6.25, "y":1.25},
{"matrix":[1, 6], "x":7.25, "y":1.25},
{"matrix":[1, 7], "x":8.25, "y":1.25},
{"matrix":[1, 8], "x":10.5, "y":1.25},
{"matrix":[1, 9], "x":11.5, "y":1.25},
{"matrix":[1,10], "x":12.5, "y":1.25},
{"matrix":[1,11], "x":13.5, "y":1.25},
{"matrix":[1,12], "x":14.5, "y":1.25},
{"matrix":[1,13], "x":15.5, "y":1.25},
{"matrix":[1,14], "x":16.5, "y":1.25, "w":2},
{"matrix":[1,15], "x":19, "y":1.25},

{"matrix":[2, 0], "x":0.5, "y":2.25},
{"matrix":[2, 1], "x":1.75, "y":2.25, "w":1.5},
{"matrix":[2, 2], "x":3.25, "y":2.25},
{"matrix":[2, 3], "x":4.5, "y":2.25},
{"matrix":[2, 4], "x":5.5, "y":2.25},
{"matrix":[2, 5], "x":6.5, "y":2.25},
{"matrix":[2, 6], "x":7.5, "y":2.25},
{"matrix":[2, 7], "x":10, "y":2.25},
{"matrix":[2, 8], "x":11, "y":2.25},
{"matrix":[2, 9], "x":12, "y":2.25},
{"matrix":[2,10], "x":13, "y":2.25},
{"matrix":[2,11], "x":14, "y":2.25},
{"matrix":[2,12], "x":15.25, "y":2.25},
{"matrix":[2,13], "x":16.25, "y":2.25},
{"matrix":[2,14], "x":17.25, "y":2.25, "w":1.5},
{"matrix":[2,15], "x":19.25, "y":2.25},

{"matrix":[3, 0], "x":0.25, "y":3.25},
{"matrix":[3, 1], "x":1.5, "y":3.25, "w":1.75},
{"matrix":[3, 2], "x":3.25, "y":3.25},
{"matrix":[3, 3], "x":4.5, "y":3.25},
{"matrix":[3, 4], "x":5.5, "y":3.25},
{"matrix":[3, 5], "x":6.5, "y":3.25},
{"matrix":[3, 6], "x":7.5, "y":3.25},
{"matrix":[3, 8], "x":10.25, "y":3.25},
{"matrix":[3, 9], "x":11.25, "y":3.25},
{"matrix":[3,10], "x":12.25, "y":3.25},
{"matrix":[3,11], "x":13.25, "y":3.25},
{"matrix":[3,12], "x":14.75, "y":3.25},
{"matrix":[3,13], "x":15.75, "y":3.25},
{"matrix":[3,14], "x":16.75, "y":3.25, "w":2.25},
{"matrix":[3,15], "x":19.5, "y":3.25},

{"matrix":[4, 0], "x":0, "y":4.25},
{"matrix":[4, 1], "x":1.5, "y":4.25, "w":2.25},
{"matrix":[4, 3], "x":3.5, "y":4.25},
{"matrix":[4, 4], "x":4.75, "y":4.25},
{"matrix":[4, 5], "x":5.75, "y":4.25},
{"matrix":[4, 6], "x":6.75, "y":4.25},
{"matrix":[4, 7], "x":7.75, "y":4.25},
{"matrix":[4, 8], "x":9.5, "y":4.25},
{"matrix":[4, 9], "x":10.5, "y":4.25},
{"matrix":[4,10], "x":11.5, "y":4.25},
{"matrix":[4,11], "x":12.5, "y":4.25},
{"matrix":[4,12], "x":13.5, "y":4.25},
{"matrix":[4,13], "x":15.25, "y":4.25},
{"matrix":[4,14], "x":16.25, "y":4.25, "w":1.75},
{"matrix":[4,15], "x":18.25, "y":4.5},

{"matrix":[5, 0], "x":0, "y":5.25},
{"matrix":[5, 1], "x":1.25, "y":5.25, "w":1.25},
{"matrix":[5, 2], "x":2.5, "y":5.25, "w":1.25},
{"matrix":[5, 3], "x":4.75, "y":5.25, "w":1.25},
{"matrix":[5, 4], "x":6, "y":5.25, "w":2.25},
{"matrix":[5, 7], "x":8.25, "y":5.25},
{"matrix":[5, 8], "x":9.5, "y":5.25, "w":2.75},
{"matrix":[5, 9], "x":12.25, "y":5.25},
{"matrix":[5,13], "x":17.25, "y":5.5},
{"matrix":[5,14], "x":18.25, "y":5.5},
{"matrix":[5,15], "x":19.25, "y":5.5}
]
}
}
}
72 changes: 72 additions & 0 deletions keyboards/keychron/q10/ansi_encoder/keymaps/default/keymap.c
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
/* Copyright 2022 @ 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,
MAC_FN,
WIN_BASE,
WIN_FN
};

#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_89(
KC_MUTE, KC_ESC, KC_BRID, KC_BRIU, KC_NO, KC_NO, RGB_VAD, RGB_VAI, KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE, KC_VOLD, KC_VOLU, KC_INS, KC_DEL,
_______, 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_PGUP,
_______, 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_PGDN,
_______, 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_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP,
_______, KC_LCTL, KC_LOPT, KC_LCMD, KC_SPC, MO(MAC_FN), KC_SPC, KC_RCMD, KC_LEFT, KC_DOWN, KC_RGHT),

[MAC_FN] = LAYOUT_ansi_89(
RGB_TOG, _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, 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_BASE] = LAYOUT_ansi_89(
KC_MUTE, 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_INS, KC_DEL,
_______, 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_PGUP,
_______, 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_PGDN,
_______, 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_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP,
_______, KC_LCTL, KC_LWIN, KC_LALT, KC_SPC, MO(WIN_FN), KC_SPC, KC_RALT, KC_LEFT, KC_DOWN, KC_RGHT),

[WIN_FN] = LAYOUT_ansi_89(
RGB_TOG, _______, 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, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______),
};

#if defined(ENCODER_ENABLE) && defined(ENCODER_MAP_ENABLE)
const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][2] = {
[MAC_BASE] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
[MAC_FN] = { ENCODER_CCW_CW(RGB_VAD, RGB_VAI) },
[WIN_BASE] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
[WIN_FN] = { ENCODER_CCW_CW(RGB_VAD, RGB_VAI) }
};
#endif // ENCODER_MAP_ENABLE
1 change: 1 addition & 0 deletions keyboards/keychron/q10/ansi_encoder/keymaps/default/rules.mk
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ENCODER_MAP_ENABLE = yes
Loading

0 comments on commit 1431f31

Please sign in to comment.