Skip to content

Commit

Permalink
Add keyboard: Xtrfy K4 TKL RGB, ISO only, no RGB support (SonixQMK#332)
Browse files Browse the repository at this point in the history 
* Add keyboard: Xtrfy K4 TKL ISO, no RGB support yet

* Cleaned out RGB LED elements from plain

* Now based on keychron/k8 from sn32_develop

* Omitted emppty config.h, neatified keymap files

* Added maintainer in readmes

* rm ´include config_common.h´ from config.h

* Delete empty config.h

---------

Co-authored-by: dexter93 <d3xter93@gmail.com>
  • Loading branch information
@humanplayer2 @dexter93
humanplayer2 and dexter93 authored Jan 3, 2024
1 parent 297cbf3 commit 6588045
Show file tree
Hide file tree
Showing 8 changed files with 359 additions and 0 deletions.
32 changes: 32 additions & 0 deletions keyboards/xtrfy/k4/plain/info.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"keyboard_name": "Xtrfy K4",
"manufacturer": "Xtrfy",
"url": "https://cherryxtrfy.com/keyboards/k4/",
"processor": "SN32F248BF",
"maintainer": "humanplayer2",
"bootloader": "sn32-dfu",
"debounce": 1,
"diode_direction": "COL2ROW",
"features": {
"rgb_matrix": false,
"bootmagic": true,
"command": false,
"console": false,
"extrakey": true,
"mousekey": false,
"nkro": true,
"dip_switch": false
},
"matrix_pins": {
"cols": [ "A8", "A9", "A10", "A11", "A12", "A13", "A14", "A15", "B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7", "B8"],
"rows": [ "C15", "D11", "D10", "D9", "D8", "D7"]
},
"indicators": {
"caps_lock": "B12"
},
"usb": {
"vid": "0x0C45",
"device_version": "1.0.0",
"wait_for": false
}
}
105 changes: 105 additions & 0 deletions keyboards/xtrfy/k4/plain/iso/info.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
{
"keyboard_name": "Xtrfy K4",
"usb": {
"pid": "0x8006"
},
"layouts": {
"LAYOUT_tkl_iso": {
"layout": [
{"matrix":[0, 0], "x":0, "y":0},
{"matrix":[0, 1], "x":2, "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.5, "y":0},
{"matrix":[0, 6], "x":7.5, "y":0},
{"matrix":[0, 7], "x":8.5, "y":0},
{"matrix":[0, 8], "x":9.5, "y":0},
{"matrix":[0, 9], "x":11, "y":0},
{"matrix":[0,10], "x":12, "y":0},
{"matrix":[0,11], "x":13, "y":0},
{"matrix":[0,12], "x":14, "y":0},
{"matrix":[0,14], "x":15.25, "y":0},
{"matrix":[0,15], "x":16.25, "y":0},
{"matrix":[0,16], "x":17.25, "y":0},

{"matrix":[1, 0], "x":0, "y":1.25},
{"matrix":[1, 1], "x":1, "y":1.25},
{"matrix":[1, 2], "x":2, "y":1.25},
{"matrix":[1, 3], "x":3, "y":1.25},
{"matrix":[1, 4], "x":4, "y":1.25},
{"matrix":[1, 5], "x":5, "y":1.25},
{"matrix":[1, 6], "x":6, "y":1.25},
{"matrix":[1, 7], "x":7, "y":1.25},
{"matrix":[1, 8], "x":8, "y":1.25},
{"matrix":[1, 9], "x":9, "y":1.25},
{"matrix":[1,10], "x":10, "y":1.25},
{"matrix":[1,11], "x":11, "y":1.25},
{"matrix":[1,12], "x":12, "y":1.25},
{"matrix":[1,13], "x":13, "y":1.25, "w":2},
{"matrix":[1,14], "x":15.25, "y":1.25},
{"matrix":[1,15], "x":16.25, "y":1.25},
{"matrix":[1,16], "x":17.25, "y":1.25},

{"matrix":[2, 0], "x":0, "y":2.25, "w":1.5},
{"matrix":[2, 1], "x":1.5, "y":2.25},
{"matrix":[2, 2], "x":2.5, "y":2.25},
{"matrix":[2, 3], "x":3.5, "y":2.25},
{"matrix":[2, 4], "x":4.5, "y":2.25},
{"matrix":[2, 5], "x":5.5, "y":2.25},
{"matrix":[2, 6], "x":6.5, "y":2.25},
{"matrix":[2, 7], "x":7.5, "y":2.25},
{"matrix":[2, 8], "x":8.5, "y":2.25},
{"matrix":[2, 9], "x":9.5, "y":2.25},
{"matrix":[2,10], "x":10.5, "y":2.25},
{"matrix":[2,11], "x":11.5, "y":2.25},
{"matrix":[2,12], "x":12.5, "y":2.25},
{"matrix":[2,14], "x":15.25, "y":2.25},
{"matrix":[2,15], "x":16.25, "y":2.25},
{"matrix":[2,16], "x":17.25, "y":2.25},

{"matrix":[3, 0], "x":0, "y":3.25, "w":1.75},
{"matrix":[3, 1], "x":1.75, "y":3.25},
{"matrix":[3, 2], "x":2.75, "y":3.25},
{"matrix":[3, 3], "x":3.75, "y":3.25},
{"matrix":[3, 4], "x":4.75, "y":3.25},
{"matrix":[3, 5], "x":5.75, "y":3.25},
{"matrix":[3, 6], "x":6.75, "y":3.25},
{"matrix":[3, 7], "x":7.75, "y":3.25},
{"matrix":[3, 8], "x":8.75, "y":3.25},
{"matrix":[3, 9], "x":9.75, "y":3.25},
{"matrix":[3,10], "x":10.75, "y":3.25},
{"matrix":[3,11], "x":11.75, "y":3.25},
{"matrix":[3,12], "x":12.75, "y":3.25},
{"matrix":[3,13], "x":13.75, "y":2.25, "w":1.25, "h":2},

{"matrix":[4, 0], "x":0, "y":4.25, "w":1.25},
{"matrix":[4, 1], "x":1.25, "y":4.25},
{"matrix":[4, 2], "x":2.25, "y":4.25},
{"matrix":[4, 3], "x":3.25, "y":4.25},
{"matrix":[4, 4], "x":4.25, "y":4.25},
{"matrix":[4, 5], "x":5.25, "y":4.25},
{"matrix":[4, 6], "x":6.25, "y":4.25},
{"matrix":[4, 7], "x":7.25, "y":4.25},
{"matrix":[4, 8], "x":8.25, "y":4.25},
{"matrix":[4, 9], "x":9.25, "y":4.25},
{"matrix":[4,10], "x":10.25, "y":4.25},
{"matrix":[4,11], "x":11.25, "y":4.25},
{"matrix":[4,13], "x":12.25, "y":4.25, "w":2.75},
{"matrix":[4,15], "x":16.25, "y":4.25},

{"matrix":[5, 0], "x":0, "y":5.25, "w":1.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, 6], "x":3.75, "y":5.25, "w":6.25},
{"matrix":[5,10], "x":10, "y":5.25, "w":1.25},
{"matrix":[5,11], "x":11.25, "y":5.25, "w":1.25},
{"matrix":[5,12], "x":12.5, "y":5.25, "w":1.25},
{"matrix":[5,13], "x":13.75, "y":5.25, "w":1.25},
{"matrix":[5,14], "x":15.25, "y":5.25},
{"matrix":[5,15], "x":16.25, "y":5.25},
{"matrix":[5,16], "x":17.25, "y":5.25}
]
}
}
}
12 changes: 12 additions & 0 deletions keyboards/xtrfy/k4/plain/iso/readme.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Xtrfy K4 TKL ISO

_Xtrfy K4 TKL RGB_, but RGB is not supported here.

Based on Keychron K8 files in `qmk_firmware/keyboards/keychron/k8/`. For ANSI and RGB support, this may a be good place to start.

To compile: `qmk compile -kb xtrfy/k4/plain/iso -km iso`

* * *
For more info and detailed flashing instructions, please visit https://github.com/alex-dinh/keychron-k8

See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
2 changes: 2 additions & 0 deletions keyboards/xtrfy/k4/plain/iso/rules.mk
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
EEPROM_DRIVER = wear_leveling
WEAR_LEVELING_DRIVER = sn32_flash
87 changes: 87 additions & 0 deletions keyboards/xtrfy/k4/plain/keymaps/default/keymap.c
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
/* Copyright 2020 Adam Honse <calcprogrammer1@gmail.com>
* Copyright 2020 Dimitris Mantzouranis <d3xter93@gmail.com>
* Copyright 2022 Harrison Chan (Xelus)
* Copyright 2022 Thomas Bowman Mørch (tbowmo)
* Copyright 2023 Rasmus Kræmmer Rendsvig (rendsvig@gmail.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

// Each layer gets a name for readability, which is then used in the keymap matrix below.
// The underscores don't mean anything - you can have a layer called STUFF or any other name.
// Layer names don't all need to be of the same length, obviously, and you can also skip them
// entirely and just use numbers.
enum layer_names {
WIN_BASE = 0,
WIN_FN = 1,
LOCKED = 2,
};

#define KC_TASK LGUI(KC_TAB) // Task viewer
#define KC_FLXP LGUI(KC_E) // Windows file explorer
#define KC_CRTN LGUI(KC_C) // Cortana | Microsoft Teams

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* Windows layout
+--------------------------------------------------------------------------+----------------+
| ESC | | F1 | F2 | F3 | F4 | | F5 | F6 | F7 | F8 | | F9| F10| F11| F12| | |PSCR|SCLK|PAUS|
+--------------------------------------------------------------------------+------|----|----|
| ~ | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | - | = | BACKSP | |INS |HOME|PGUP|
+--------------------------------------------------------------------------+------|----|----|
| TAB | Q | W | E | R | T | Y | U | I | O | P | [ | ] | | |DEL |END |PGDN|
+-------------------------------------------------------------------- RET | +--------------+
| CAPSLCK | A | S | D | F | G | H | J | K | L | ; | ' | # | | |
+--------------------------------------------------------------------------+ |----| |
| LSHIFT | < | Z | X | C | V | B | N | M | , | . | / | RSHIFT | | UP | |
+--------------------------------------------------------------------------+------|----|----|
|LCTRL| LGUI| LALT | SPACE | RALT| FN | RGUI| RCTRL | |LFT |DWN |RGT |
+--------------------------------------------------------------------------+----------------+
*/
[WIN_BASE] = LAYOUT_tkl_iso(
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_PSCR, KC_SCRL, KC_PAUS,
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_INS, KC_HOME, 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_DEL, KC_END, 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_NUHS, KC_ENT,
KC_LSFT, KC_NUBS, 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, MO(WIN_FN), KC_APP, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
),

[WIN_FN] = LAYOUT_tkl_iso(
QK_BOOT, _______, KC_KB_VOLUME_DOWN, KC_KB_VOLUME_UP, KC_KB_MUTE, KC_MSTP, KC_MPRV, KC_MPLY, KC_MNXT, KC_MAIL, KC_WWW_HOME, DF(LOCKED), KC_CALC, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ , _______, _______,
_______, GUI_TOG, _______, _______, _______, _______, _______, _______, _______, _______, _______
),

[LOCKED] = LAYOUT_tkl_iso(
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, DF(WIN_BASE), KC_NO, KC_NO, KC_NO, KC_NO,
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO , KC_NO, KC_NO,
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, MO(WIN_FN), KC_NO, KC_NO, KC_NO, KC_NO, KC_NO
)
};

void keyboard_post_init_user(void) {
// Customise these values to desired behaviour
//debug_enable=true;
//debug_matrix=true;
//debug_keyboard=true;
//debug_mouse=true;
}
87 changes: 87 additions & 0 deletions keyboards/xtrfy/k4/plain/keymaps/iso/keymap.c
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
/* Copyright 2020 Adam Honse <calcprogrammer1@gmail.com>
* Copyright 2020 Dimitris Mantzouranis <d3xter93@gmail.com>
* Copyright 2022 Harrison Chan (Xelus)
* Copyright 2022 Thomas Bowman Mørch (tbowmo)
* Copyright 2023 Rasmus Kræmmer Rendsvig (rendsvig@gmail.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

// Each layer gets a name for readability, which is then used in the keymap matrix below.
// The underscores don't mean anything - you can have a layer called STUFF or any other name.
// Layer names don't all need to be of the same length, obviously, and you can also skip them
// entirely and just use numbers.
enum layer_names {
WIN_BASE = 0,
WIN_FN = 1,
LOCKED = 2,
};

#define KC_TASK LGUI(KC_TAB) // Task viewer
#define KC_FLXP LGUI(KC_E) // Windows file explorer
#define KC_CRTN LGUI(KC_C) // Cortana | Microsoft Teams

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* Windows layout
+--------------------------------------------------------------------------+----------------+
| ESC | | F1 | F2 | F3 | F4 | | F5 | F6 | F7 | F8 | | F9| F10| F11| F12| | |PSCR|SCLK|PAUS|
+--------------------------------------------------------------------------+------|----|----|
| ~ | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | - | = | BACKSP | |INS |HOME|PGUP|
+--------------------------------------------------------------------------+------|----|----|
| TAB | Q | W | E | R | T | Y | U | I | O | P | [ | ] | | |DEL |END |PGDN|
+-------------------------------------------------------------------- RET | +--------------+
| CAPSLCK | A | S | D | F | G | H | J | K | L | ; | ' | # | | |
+--------------------------------------------------------------------------+ |----| |
| LSHIFT | < | Z | X | C | V | B | N | M | , | . | / | RSHIFT | | UP | |
+--------------------------------------------------------------------------+------|----|----|
|LCTRL| LGUI| LALT | SPACE | RALT| FN | RGUI| RCTRL | |LFT |DWN |RGT |
+--------------------------------------------------------------------------+----------------+
*/
[WIN_BASE] = LAYOUT_tkl_iso(
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_PSCR, KC_SCRL, KC_PAUS,
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_INS, KC_HOME, 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_DEL, KC_END, 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_NUHS, KC_ENT,
KC_LSFT, KC_NUBS, 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, MO(WIN_FN), KC_APP, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
),

[WIN_FN] = LAYOUT_tkl_iso(
QK_BOOT, _______, KC_KB_VOLUME_DOWN, KC_KB_VOLUME_UP, KC_KB_MUTE, KC_MSTP, KC_MPRV, KC_MPLY, KC_MNXT, KC_MAIL, KC_WWW_HOME, DF(LOCKED), KC_CALC, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ , _______, _______,
_______, GUI_TOG, _______, _______, _______, _______, _______, _______, _______, _______, _______
),

[LOCKED] = LAYOUT_tkl_iso(
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, DF(WIN_BASE), KC_NO, KC_NO, KC_NO, KC_NO,
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO , KC_NO, KC_NO,
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, MO(WIN_FN), KC_NO, KC_NO, KC_NO, KC_NO, KC_NO
)
};

void keyboard_post_init_user(void) {
// Customise these values to desired behaviour
//debug_enable=true;
//debug_matrix=true;
//debug_keyboard=true;
//debug_mouse=true;
}
17 changes: 17 additions & 0 deletions keyboards/xtrfy/k4/plain/readme.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Xtrfy K4 TKL ISO

_Xtrfy K4 TKL RGB_, but RGB is not supported here.

* Keyboard Maintainer: [humanplayer2](https://github.com/humanplayer2)

Based on Keychron K8 files in `qmk_firmware/keyboards/keychron/k8/`. For ANSI and RGB support, this may a be good place to start.

To compile: `qmk compile -kb xtrfy/k4/plain/iso -km iso`

TODO:
- add ANSI support
- add RGB support
- fix CapsLock LED

* * *
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
Loading

0 comments on commit 6588045

Please sign in to comment.