Add Royal Kludge RK61 (#25694)

This commit is contained in:
Martin W.
2025-10-06 18:46:41 +02:00
committed by GitHub
parent 5d26dcefa0
commit 02cf2b56fd
7 changed files with 389 additions and 0 deletions

View File

@@ -0,0 +1,11 @@
// Copyright 2025 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#define WS2812_SPI_DRIVER SPID2
#define WS2812_SPI_MOSI_PAL_MODE 0
#define WS2812_SPI_SCK_PAL_MODE 0
#define WS2812_SPI_SCK_PIN B13
#define CAPS_LOCK_LED_INDEX 40

View File

@@ -0,0 +1,9 @@
// Copyright 2025 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#define HAL_USE_SPI TRUE
#include_next <halconf.h>

View File

@@ -0,0 +1,223 @@
{
"manufacturer": "Royal Kludge",
"keyboard_name": "RK61",
"maintainer": "DEREFERENC3D",
"bootloader": "stm32-dfu",
"diode_direction": "COL2ROW",
"dynamic_keymap": {
"layer_count": 16
},
"features": {
"bootmagic": true,
"extrakey": true,
"mousekey": false,
"nkro": true,
"rgb_matrix": true
},
"matrix_pins": {
"cols": ["A10", "A9", "B2", "A15", "B3", "B4", "B5", "B8", "B9", "C13", "C14", "C15", "A0", "A1"],
"rows": ["A6", "A5", "A4", "A3", "A2"]
},
"processor": "STM32F072",
"rgb_matrix": {
"animations": {
"alphas_mods": true,
"band_pinwheel_sat": true,
"band_pinwheel_val": true,
"band_sat": true,
"band_spiral_sat": true,
"band_spiral_val": true,
"band_val": true,
"breathing": true,
"cycle_all": true,
"cycle_left_right": true,
"cycle_out_in": true,
"cycle_out_in_dual": true,
"cycle_pinwheel": true,
"cycle_spiral": true,
"cycle_up_down": true,
"digital_rain": true,
"dual_beacon": true,
"flower_blooming": true,
"gradient_left_right": true,
"gradient_up_down": true,
"hue_breathing": true,
"hue_pendulum": true,
"hue_wave": true,
"jellybean_raindrops": true,
"multisplash": true,
"pixel_flow": true,
"pixel_fractal": true,
"pixel_rain": true,
"rainbow_beacon": true,
"rainbow_moving_chevron": true,
"rainbow_pinwheels": true,
"raindrops": true,
"riverflow": true,
"solid_multisplash": true,
"solid_reactive": true,
"solid_reactive_cross": true,
"solid_reactive_multicross": true,
"solid_reactive_multinexus": true,
"solid_reactive_multiwide": true,
"solid_reactive_nexus": true,
"solid_reactive_simple": true,
"solid_reactive_wide": true,
"solid_splash": true,
"splash": true,
"starlight": true,
"starlight_dual_hue": true,
"starlight_dual_sat": true,
"starlight_smooth": true,
"typing_heatmap": true
},
"default": {
"hue": 170,
"val": 150
},
"driver": "ws2812",
"layout": [
{"matrix": [0, 13], "x": 218, "y": 0, "flags": 1},
{"matrix": [0, 12], "x": 193, "y": 0, "flags": 4},
{"matrix": [0, 11], "x": 177, "y": 0, "flags": 4},
{"matrix": [0, 10], "x": 161, "y": 0, "flags": 4},
{"matrix": [0, 9], "x": 145, "y": 0, "flags": 4},
{"matrix": [0, 8], "x": 129, "y": 0, "flags": 4},
{"matrix": [0, 7], "x": 113, "y": 0, "flags": 4},
{"matrix": [0, 6], "x": 97, "y": 0, "flags": 4},
{"matrix": [0, 5], "x": 81, "y": 0, "flags": 4},
{"matrix": [0, 4], "x": 64, "y": 0, "flags": 4},
{"matrix": [0, 3], "x": 48, "y": 0, "flags": 4},
{"matrix": [0, 2], "x": 32, "y": 0, "flags": 4},
{"matrix": [0, 1], "x": 16, "y": 0, "flags": 4},
{"matrix": [0, 0], "x": 0, "y": 0, "flags": 1},
{"matrix": [1, 0], "x": 4, "y": 16, "flags": 1},
{"matrix": [1, 1], "x": 24, "y": 16, "flags": 4},
{"matrix": [1, 2], "x": 40, "y": 16, "flags": 4},
{"matrix": [1, 3], "x": 56, "y": 16, "flags": 4},
{"matrix": [1, 4], "x": 73, "y": 16, "flags": 4},
{"matrix": [1, 5], "x": 89, "y": 16, "flags": 4},
{"matrix": [1, 6], "x": 105, "y": 16, "flags": 4},
{"matrix": [1, 7], "x": 121, "y": 16, "flags": 4},
{"matrix": [1, 8], "x": 137, "y": 16, "flags": 4},
{"matrix": [1, 9], "x": 153, "y": 16, "flags": 4},
{"matrix": [1, 10], "x": 169, "y": 16, "flags": 4},
{"matrix": [1, 11], "x": 185, "y": 16, "flags": 4},
{"matrix": [1, 12], "x": 202, "y": 16, "flags": 4},
{"matrix": [1, 13], "x": 222, "y": 16, "flags": 1},
{"matrix": [2, 12], "x": 216, "y": 32, "flags": 1},
{"matrix": [2, 11], "x": 189, "y": 32, "flags": 4},
{"matrix": [2, 10], "x": 173, "y": 32, "flags": 4},
{"matrix": [2, 9], "x": 157, "y": 32, "flags": 4},
{"matrix": [2, 8], "x": 141, "y": 32, "flags": 4},
{"matrix": [2, 7], "x": 125, "y": 32, "flags": 4},
{"matrix": [2, 6], "x": 109, "y": 32, "flags": 4},
{"matrix": [2, 5], "x": 93, "y": 32, "flags": 4},
{"matrix": [2, 4], "x": 77, "y": 32, "flags": 4},
{"matrix": [2, 3], "x": 60, "y": 32, "flags": 4},
{"matrix": [2, 2], "x": 44, "y": 32, "flags": 4},
{"matrix": [2, 1], "x": 28, "y": 32, "flags": 4},
{"matrix": [2, 0], "x": 6, "y": 32, "flags": 1},
{"matrix": [3, 0], "x": 10, "y": 48, "flags": 1},
{"matrix": [3, 1], "x": 36, "y": 48, "flags": 4},
{"matrix": [3, 2], "x": 52, "y": 48, "flags": 4},
{"matrix": [3, 3], "x": 69, "y": 48, "flags": 4},
{"matrix": [3, 4], "x": 85, "y": 48, "flags": 4},
{"matrix": [3, 5], "x": 101, "y": 48, "flags": 4},
{"matrix": [3, 6], "x": 117, "y": 48, "flags": 4},
{"matrix": [3, 7], "x": 133, "y": 48, "flags": 4},
{"matrix": [3, 8], "x": 149, "y": 48, "flags": 4},
{"matrix": [3, 9], "x": 165, "y": 48, "flags": 4},
{"matrix": [3, 10], "x": 181, "y": 48, "flags": 4},
{"matrix": [3, 11], "x": 212, "y": 48, "flags": 1},
{"matrix": [4, 12], "x": 224, "y": 64, "flags": 1},
{"matrix": [4, 10], "x": 204, "y": 64, "flags": 1},
{"matrix": [4, 9], "x": 184, "y": 64, "flags": 1},
{"matrix": [4, 8], "x": 164, "y": 64, "flags": 1},
{"matrix": [4, 5], "x": 103, "y": 64, "flags": 1},
{"matrix": [4, 2], "x": 42, "y": 64, "flags": 1},
{"matrix": [4, 1], "x": 22, "y": 64, "flags": 1},
{"matrix": [4, 0], "x": 2, "y": 64, "flags": 1}
],
"max_brightness": 200,
"sleep": true
},
"url": "http://en.rkgaming.com/",
"usb": {
"device_version": "1.0.1",
"pid": "0x6461",
"vid": "0x1480"
},
"ws2812": {
"pin": "B15",
"driver": "spi"
},
"community_layouts": ["60_ansi"],
"layouts": {
"LAYOUT_60_ansi": {
"layout": [
{"label": "ESC", "matrix": [0, 0], "x": 0, "y": 0},
{"label": "!", "matrix": [0, 1], "x": 1, "y": 0},
{"label": "\"", "matrix": [0, 2], "x": 2, "y": 0},
{"label": "\u00a3", "matrix": [0, 3], "x": 3, "y": 0},
{"label": "$", "matrix": [0, 4], "x": 4, "y": 0},
{"label": "%", "matrix": [0, 5], "x": 5, "y": 0},
{"label": "^", "matrix": [0, 6], "x": 6, "y": 0},
{"label": "&", "matrix": [0, 7], "x": 7, "y": 0},
{"label": "*", "matrix": [0, 8], "x": 8, "y": 0},
{"label": "(", "matrix": [0, 9], "x": 9, "y": 0},
{"label": ")", "matrix": [0, 10], "x": 10, "y": 0},
{"label": "_", "matrix": [0, 11], "x": 11, "y": 0},
{"label": "+", "matrix": [0, 12], "x": 12, "y": 0},
{"label": "Backspace", "matrix": [0, 13], "x": 13, "y": 0, "w": 2},
{"label": "Tab", "matrix": [1, 0], "x": 0, "y": 1, "w": 1.5},
{"label": "Q", "matrix": [1, 1], "x": 1.5, "y": 1},
{"label": "W", "matrix": [1, 2], "x": 2.5, "y": 1},
{"label": "E", "matrix": [1, 3], "x": 3.5, "y": 1},
{"label": "R", "matrix": [1, 4], "x": 4.5, "y": 1},
{"label": "T", "matrix": [1, 5], "x": 5.5, "y": 1},
{"label": "Y", "matrix": [1, 6], "x": 6.5, "y": 1},
{"label": "U", "matrix": [1, 7], "x": 7.5, "y": 1},
{"label": "I", "matrix": [1, 8], "x": 8.5, "y": 1},
{"label": "O", "matrix": [1, 9], "x": 9.5, "y": 1},
{"label": "P", "matrix": [1, 10], "x": 10.5, "y": 1},
{"label": "{", "matrix": [1, 11], "x": 11.5, "y": 1},
{"label": "}", "matrix": [1, 12], "x": 12.5, "y": 1},
{"label": "|", "matrix": [1, 13], "x": 13.5, "y": 1, "w": 1.5},
{"label": "Caps Lock", "matrix": [2, 0], "x": 0, "y": 2, "w": 1.75},
{"label": "A", "matrix": [2, 1], "x": 1.75, "y": 2},
{"label": "S", "matrix": [2, 2], "x": 2.75, "y": 2},
{"label": "D", "matrix": [2, 3], "x": 3.75, "y": 2},
{"label": "F", "matrix": [2, 4], "x": 4.75, "y": 2},
{"label": "G", "matrix": [2, 5], "x": 5.75, "y": 2},
{"label": "H", "matrix": [2, 6], "x": 6.75, "y": 2},
{"label": "J", "matrix": [2, 7], "x": 7.75, "y": 2},
{"label": "K", "matrix": [2, 8], "x": 8.75, "y": 2},
{"label": "L", "matrix": [2, 9], "x": 9.75, "y": 2},
{"label": ":", "matrix": [2, 10], "x": 10.75, "y": 2},
{"label": "\"", "matrix": [2, 11], "x": 11.75, "y": 2},
{"label": "Enter", "matrix": [2, 12], "x": 12.75, "y": 2, "w": 2.25},
{"label": "Shift", "matrix": [3, 0], "x": 0, "y": 3, "w": 2.25},
{"label": "Z", "matrix": [3, 1], "x": 2.25, "y": 3},
{"label": "X", "matrix": [3, 2], "x": 3.25, "y": 3},
{"label": "C", "matrix": [3, 3], "x": 4.25, "y": 3},
{"label": "V", "matrix": [3, 4], "x": 5.25, "y": 3},
{"label": "B", "matrix": [3, 5], "x": 6.25, "y": 3},
{"label": "N", "matrix": [3, 6], "x": 7.25, "y": 3},
{"label": "M", "matrix": [3, 7], "x": 8.25, "y": 3},
{"label": "<", "matrix": [3, 8], "x": 9.25, "y": 3},
{"label": ">", "matrix": [3, 9], "x": 10.25, "y": 3},
{"label": "?", "matrix": [3, 10], "x": 11.25, "y": 3},
{"label": "Shift", "matrix": [3, 11], "x": 12.25, "y": 3, "w": 2.75},
{"label": "Ctrl", "matrix": [4, 0], "x": 0, "y": 4, "w": 1.25},
{"label": "Win", "matrix": [4, 1], "x": 1.25, "y": 4, "w": 1.25},
{"label": "Alt", "matrix": [4, 2], "x": 2.5, "y": 4, "w": 1.25},
{"matrix": [4, 5], "x": 3.75, "y": 4, "w": 6.25},
{"label": "AltGr", "matrix": [4, 8], "x": 10, "y": 4, "w": 1.25},
{"label": "Menu", "matrix": [4, 9], "x": 11.25, "y": 4, "w": 1.25},
{"label": "Ctrl", "matrix": [4, 10], "x": 12.5, "y": 4, "w": 1.25},
{"label": "Fn", "matrix": [4, 12], "x": 13.75, "y": 4, "w": 1.25}
]
}
}
}

View File

@@ -0,0 +1,111 @@
// Copyright 2025 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#include QMK_KEYBOARD_H
enum layers {
WIN_BASE,
WIN_T,
WIN_ALT,
ARROW_FN,
LWIN_DIS,
WIN_FN,
WIN_T_FN,
WIN_ALT_FN,
MAC_BASE,
MAC_FN,
};
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[WIN_BASE] = LAYOUT_60_ansi(
KC_ESC, 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_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_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_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_UP, KC_RSFT,
KC_LCTL, KC_LWIN, KC_LALT, KC_SPC, KC_LEFT, KC_DOWN, KC_RIGHT, MO(WIN_FN)
),
[WIN_FN] = LAYOUT_60_ansi(
KC_GRV, 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_PSCR, KC_SCRL, KC_PAUS, _______, _______, RM_VALD, RM_VALU, RM_NEXT,
_______, _______, DF(MAC_BASE), _______, _______, _______, KC_INS, KC_HOME, KC_PGUP, _______, RM_SPDD, RM_SPDU, TG(ARROW_FN),
_______, _______, _______, _______, _______, _______, KC_DEL, KC_END, KC_PGDN, RM_HUEU, _______, _______,
DF(WIN_ALT), TG(LWIN_DIS), _______, _______, _______, _______, _______, _______
),
[WIN_T] = LAYOUT_60_ansi(
KC_GRV, 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,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, MO(WIN_T_FN)
),
[WIN_T_FN] = LAYOUT_60_ansi(
KC_ESC, KC_MYCM, KC_WHOM, KC_MAIL, KC_CALC, KC_MSEL, KC_MSTP, KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE, KC_VOLD, KC_VOLU, KC_BSPC,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, DF(MAC_BASE), _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, TG(ARROW_FN),
DF(WIN_BASE), TG(LWIN_DIS), _______, _______, _______, _______, _______, _______
),
[WIN_ALT] = LAYOUT_60_ansi(
KC_GRV, 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_PSCR, KC_SCRL, KC_PAUS, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, KC_INS, KC_HOME, KC_PGUP, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, KC_DEL, KC_END, KC_PGDN, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, MO(WIN_ALT_FN)
),
[WIN_ALT_FN] = LAYOUT_60_ansi(
KC_ESC, KC_MYCM, KC_WHOM, KC_MAIL, KC_CALC, KC_MSEL, KC_MSTP, KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE, KC_VOLD, KC_VOLU, KC_BSPC,
_______, _______, _______, _______, _______, _______, KC_Y, KC_U, KC_I, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, KC_H, KC_J, KC_K, _______, _______, _______, TG(ARROW_FN),
_______, _______, _______, _______, _______, _______, KC_N, KC_M, KC_COMM, _______, _______, _______,
DF(WIN_T), TG(LWIN_DIS), _______, _______, _______, _______, _______, _______
),
[MAC_BASE] = LAYOUT_60_ansi(
KC_ESC, 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_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_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_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT,
KC_LCTL, KC_LOPT, KC_LCMD, KC_SPC, KC_RCMD, KC_APP, KC_RCTL, MO(MAC_FN)
),
[MAC_FN] = LAYOUT_60_ansi(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, DF(WIN_BASE), _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_SLSH, _______,
_______, _______, _______, _______, _______, KC_F1, KC_RCTL, KC_F2
),
[ARROW_FN] = LAYOUT_60_ansi(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_SLSH, _______,
_______, _______, _______, _______, KC_RALT, KC_APP, KC_RCTL, _______
),
[LWIN_DIS] = LAYOUT_60_ansi(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, KC_NO, _______, _______, _______, _______, _______, _______
),
};
#ifdef CAPS_LOCK_LED_INDEX
bool rgb_matrix_indicators_user(void) {
if (host_keyboard_led_state().caps_lock) {
rgb_matrix_set_color(CAPS_LOCK_LED_INDEX, 255, 255, 255);
} else {
if (!rgb_matrix_get_flags()) {
rgb_matrix_set_color(CAPS_LOCK_LED_INDEX, 0, 0, 0);
}
}
if (layer_state_is(LWIN_DIS)) {
rgb_matrix_set_color(59, 255, 255, 255);
} else {
if (!rgb_matrix_get_flags()) {
rgb_matrix_set_color(59, 0, 0, 0);
}
}
return false;
}
#endif

View File

@@ -0,0 +1,9 @@
// Copyright 2025 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include_next <mcuconf.h>
#undef STM32_SPI_USE_SPI2
#define STM32_SPI_USE_SPI2 TRUE

View File

@@ -0,0 +1,25 @@
# Royal Kludge RK61
![Royal Kludge RK61](https://imgur.com/9YoEEkH.jpg)
* Keyboard Maintainer: [DEREFERENC3D](https://github.com/DEREFERENC3D)
* Hardware Supported: Royal Kludge RK61 - wired-only QMK version
* Hardware Availability: [RKGaming.com](https://en.rkgaming.com/product/43/), [Amazon.com](https://www.amazon.com/RK-ROYAL-KLUDGE-Mechanical-Ultra-Compact/dp/B0832LSV8N)
Make example for this keyboard (after setting up your build environment):
make royal_kludge/rk61:default
Flashing example for this keyboard:
make royal_kludge/rk61:default:flash
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).
## Bootloader
Enter the bootloader in 3 ways:
* **Bootmagic reset**: Hold down the Escape key and plug in the keyboard (this one might be disabled on the stock firmware)
* **Physical reset button**: Briefly press the button on the PCB, located under the space bar keycap, to the right of the space bar's switch
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available. On the stock firmware, VIA should allow it to be mapped.

View File

@@ -0,0 +1 @@
DFU_SUFFIX_ARGS = -p FFFF -v FFFF