Add support for Novelkey's Classic-TKL (#845)

* basic vial keymap for nk_classic_tkl

* add rgb

* Create README.md

* Update rules.mk

* customizable caps lock color
This commit is contained in:
Damien Erambert 2025-02-08 18:05:29 -08:00 committed by GitHub
parent 0a854393d8
commit 4504107cc9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 326 additions and 0 deletions

View file

@ -0,0 +1,18 @@
# The Classic_TKL Vial default layout
To change the color of the Caps Lock indicator:
1. Uncomment line 11 in `config.h` and change the RGB values:
```c
// Uncomment to customize the color of the caps lock indicator
// #define CAPS_LOCK_COLORS {0, 255, 0}
```
2. rebuild the firmware using
```
make novelkeys/nk_classic_tkl:vial
```
3. reflash the firmware according to [README.md](../../readme.md#flash)

View file

@ -0,0 +1,11 @@
/* SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once
#define VIAL_KEYBOARD_UID {0x14, 0xE0, 0xDA, 0x55, 0xA2, 0xB4, 0xD4, 0xF7}
// Escape + Enter to unlock
#define VIAL_UNLOCK_COMBO_ROWS { 0, 3 }
#define VIAL_UNLOCK_COMBO_COLS { 0, 13 }
// Uncomment to customize the color of the caps lock indicator
// #define CAPS_LOCK_COLORS {0, 255, 0}

View file

@ -0,0 +1,75 @@
/* Copyright 2024 Yiancar-Designs
*
* 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 my_keycodes {
RETRO_RGB = QK_KB_0
};
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = LAYOUT_tkl_ansi_tsangan( /* Base */
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_BSLS, 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_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_UP,
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, MO(1), KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT),
[1] = LAYOUT_tkl_ansi_tsangan( /* FN */
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_VOLU, KC_VOLD, KC_MUTE,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, RGB_TOG, RGB_MOD, RGB_HUD, RGB_HUI, RGB_SAD, RGB_SAI, RGB_VAD, RGB_VAI, RGB_SPD, RGB_SPI, _______, _______,
_______, _______, _______, RETRO_RGB, _______, _______, _______, _______, _______, _______),
};
#ifdef CAPS_LOCK_COLORS
static uint8_t caps_lock_colors[] = CAPS_LOCK_COLORS;
#else
static uint8_t caps_lock_colors[] = {255, 86, 0};
#endif
bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
if (host_keyboard_led_state().caps_lock) {
for (uint8_t i = 50; i <= 55; i++) {
rgb_matrix_set_color(i, caps_lock_colors[0], caps_lock_colors[1], caps_lock_colors[2]);
}
}
return false;
}
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
switch (keycode) {
case RETRO_RGB:
if (record->event.pressed) {
switch (rgb_matrix_get_flags()) {
case LED_FLAG_ALL: {
rgb_matrix_set_flags(LED_FLAG_INDICATOR);
}
break;
default: {
rgb_matrix_set_flags(LED_FLAG_ALL);
}
break;
}
}
return false; // Skip all further processing of this key
default:
return true; // Process all other keycodes normally
}
}

View file

@ -0,0 +1,17 @@
# Wildcard to allow APM32 MCU (taken from source rules.mk)
DFU_SUFFIX_ARGS = -v FFFF -p FFFF
# Enable VIA
VIA_ENABLE = yes
# Enable VIAL
VIAL_ENABLE = yes
LTO_ENABLE = yes
# Enable RGB
VIALRGB_ENABLE = yes
# Enable Bootmagic Lite
BOOTMAGIC_ENABLE = yes
# Mouse keys
MOUSEKEY_ENABLE = yes
# Audio control and System control
EXTRAKEY_ENABLE = yes
# Enable N-Key Rollover
NKRO_ENABLE = yes

View file

@ -0,0 +1,205 @@
{
"name": "NK_ Classic TKL",
"vendorId": "0x8968",
"productId": "0x4E54",
"matrix": {
"rows": 6,
"cols": 17
},
"lighting": "vialrgb",
"customKeycodes": [
{
"name": "NK_ Retro RGB",
"title": "NK_ Retro RGB",
"shortName": "RETRO_RGB"
}
],
"layouts": {
"keymap": [
[
{
"c": "#777777"
},
"0,0",
{
"x": 1,
"c": "#cccccc"
},
"0,1",
"0,2",
"0,3",
"0,4",
{
"x": 0.5,
"c": "#aaaaaa"
},
"0,5",
"0,6",
"0,7",
"0,8",
{
"x": 0.5,
"c": "#cccccc"
},
"0,9",
"0,10",
"0,11",
"0,12",
{
"x": 0.25,
"c": "#aaaaaa"
},
"0,14",
"0,15",
"0,16"
],
[
{
"y": 0.25,
"c": "#cccccc"
},
"1,0",
"1,1",
"1,2",
"1,3",
"1,4",
"1,5",
"1,6",
"1,7",
"1,8",
"1,9",
"1,10",
"1,11",
"1,12",
{
"c": "#aaaaaa",
"w": 2
},
"1,13",
{
"x": 0.25
},
"1,14",
"1,15",
"1,16"
],
[
{
"w": 1.5
},
"2,0",
{
"c": "#cccccc"
},
"2,1",
"2,2",
"2,3",
"2,4",
"2,5",
"2,6",
"2,7",
"2,8",
"2,9",
"2,10",
"2,11",
"2,12",
{
"w": 1.5
},
"3,12",
{
"x": 0.25,
"c": "#aaaaaa"
},
"2,14",
"2,15",
"2,16"
],
[
{
"w": 1.75
},
"3,0",
{
"c": "#cccccc"
},
"3,1",
"3,2",
"3,3",
"3,4",
"3,5",
"3,6",
"3,7",
"3,8",
"3,9",
"3,10",
"3,11",
{
"c": "#aaaaaa",
"w": 2.25
},
"3,13"
],
[
{
"w": 2.25
},
"4,0",
{
"c": "#cccccc"
},
"4,2",
"4,3",
"4,4",
"4,5",
"4,6",
"4,7",
"4,8",
"4,9",
"4,10",
"4,11",
{
"c": "#aaaaaa",
"w": 2.75
},
"4,12",
{
"x": 1.25
},
"4,15"
],
[
{
"w": 1.5
},
"5,0",
"5,1",
{
"w": 1.5
},
"5,2",
{
"c": "#cccccc",
"w": 7
},
"5,6",
{
"c": "#aaaaaa",
"w": 1.5
},
"5,11",
"5,12",
{
"w": 1.5
},
"5,13",
{
"x": 0.25
},
"5,14",
"5,15",
"5,16"
]
]
}
}