NK Classic TKL ISO (#24434)

* initial_commit

* fix keymap

* Update keyboards/novelkeys/nk_classic_tkl_iso/keyboard.json

Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>

---------

Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
This commit is contained in:
yiancar 2024-10-05 10:16:25 -06:00 committed by GitHub
parent 6a73c8299b
commit e12c1fefdf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 441 additions and 0 deletions

View file

@ -0,0 +1,25 @@
/* 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/>.
*/
#pragma once
/* RGB options */
#define WS2812_PWM_DRIVER PWMD3
#define WS2812_PWM_CHANNEL 3
#define WS2812_PWM_PAL_MODE 1
#define WS2812_DMA_STREAM STM32_DMA1_STREAM3
#define WS2812_DMA_CHANNEL 3

View file

@ -0,0 +1,21 @@
/* 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/>.
*/
#pragma once
#define HAL_USE_PWM TRUE
#include_next <halconf.h>

View file

@ -0,0 +1,270 @@
{
"manufacturer": "Yiancar-Designs",
"keyboard_name": "NK_ Classic TKL ISO",
"maintainer": "Yiancar",
"bootloader": "stm32-dfu",
"diode_direction": "COL2ROW",
"features": {
"bootmagic": true,
"command": false,
"console": false,
"extrakey": true,
"mousekey": true,
"nkro": true,
"rgb_matrix": true
},
"matrix_pins": {
"cols": ["B12", "B13", "B14", "B15", "A8", "A10", "A14", "A15", "B3", "B4", "B5", "B6", "B7", "B8", "B9", "A0", "A1"],
"rows": ["B11", "B10", "B2", "B1", "A9", "A5"]
},
"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,
"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,
"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,
"typing_heatmap": true
},
"driver": "ws2812",
"layout": [
{"matrix": [0, 0], "x": 0, "y": 0, "flags": 1},
{"matrix": [0, 1], "x": 26, "y": 0, "flags": 4},
{"matrix": [0, 2], "x": 38, "y": 0, "flags": 4},
{"matrix": [0, 3], "x": 51, "y": 0, "flags": 4},
{"matrix": [0, 4], "x": 64, "y": 0, "flags": 4},
{"matrix": [0, 5], "x": 83, "y": 0, "flags": 1},
{"matrix": [0, 6], "x": 96, "y": 0, "flags": 1},
{"matrix": [0, 7], "x": 109, "y": 0, "flags": 1},
{"matrix": [0, 8], "x": 122, "y": 0, "flags": 1},
{"matrix": [0, 9], "x": 141, "y": 0, "flags": 4},
{"matrix": [0, 10], "x": 154, "y": 0, "flags": 4},
{"matrix": [0, 11], "x": 166, "y": 0, "flags": 4},
{"matrix": [0, 12], "x": 179, "y": 0, "flags": 4},
{"matrix": [0, 14], "x": 195, "y": 0, "flags": 1},
{"matrix": [0, 15], "x": 208, "y": 0, "flags": 1},
{"matrix": [0, 16], "x": 221, "y": 0, "flags": 1},
{"matrix": [1, 16], "x": 221, "y": 15, "flags": 1},
{"matrix": [1, 15], "x": 208, "y": 15, "flags": 1},
{"matrix": [1, 14], "x": 195, "y": 15, "flags": 1},
{"matrix": [1, 13], "x": 173, "y": 15, "flags": 1},
{"matrix": [1, 12], "x": 154, "y": 15, "flags": 4},
{"matrix": [1, 11], "x": 141, "y": 15, "flags": 4},
{"matrix": [1, 10], "x": 128, "y": 15, "flags": 4},
{"matrix": [1, 9], "x": 115, "y": 15, "flags": 4},
{"matrix": [1, 8], "x": 102, "y": 15, "flags": 4},
{"matrix": [1, 7], "x": 90, "y": 15, "flags": 4},
{"matrix": [1, 6], "x": 77, "y": 15, "flags": 4},
{"matrix": [1, 5], "x": 64, "y": 15, "flags": 4},
{"matrix": [1, 4], "x": 51, "y": 15, "flags": 4},
{"matrix": [1, 3], "x": 38, "y": 15, "flags": 4},
{"matrix": [1, 2], "x": 26, "y": 15, "flags": 4},
{"matrix": [1, 1], "x": 13, "y": 15, "flags": 4},
{"matrix": [1, 0], "x": 0, "y": 15, "flags": 4},
{"matrix": [2, 0], "x": 3, "y": 27, "flags": 1},
{"matrix": [2, 1], "x": 19, "y": 27, "flags": 4},
{"matrix": [2, 2], "x": 32, "y": 27, "flags": 4},
{"matrix": [2, 3], "x": 45, "y": 27, "flags": 4},
{"matrix": [2, 4], "x": 58, "y": 27, "flags": 4},
{"matrix": [2, 5], "x": 70, "y": 27, "flags": 4},
{"matrix": [2, 6], "x": 83, "y": 27, "flags": 4},
{"matrix": [2, 7], "x": 96, "y": 27, "flags": 4},
{"matrix": [2, 8], "x": 109, "y": 27, "flags": 4},
{"matrix": [2, 9], "x": 122, "y": 27, "flags": 4},
{"matrix": [2, 10], "x": 134, "y": 27, "flags": 4},
{"matrix": [2, 11], "x": 147, "y": 27, "flags": 4},
{"matrix": [2, 12], "x": 160, "y": 27, "flags": 4},
{"matrix": [3, 13], "x": 178, "y": 21, "flags": 1},
{"matrix": [2, 14], "x": 195, "y": 27, "flags": 1},
{"matrix": [2, 15], "x": 208, "y": 27, "flags": 1},
{"matrix": [2, 16], "x": 221, "y": 27, "flags": 1},
{"x": 224, "y": 34, "flags": 9},
{"x": 218, "y": 34, "flags": 9},
{"x": 211, "y": 34, "flags": 9},
{"x": 205, "y": 34, "flags": 9},
{"x": 198, "y": 34, "flags": 9},
{"x": 192, "y": 34, "flags": 9},
{"matrix": [3, 12], "x": 163, "y": 40, "flags": 4},
{"matrix": [3, 11], "x": 150, "y": 40, "flags": 4},
{"matrix": [3, 10], "x": 138, "y": 40, "flags": 4},
{"matrix": [3, 9], "x": 125, "y": 40, "flags": 4},
{"matrix": [3, 8], "x": 112, "y": 40, "flags": 4},
{"matrix": [3, 7], "x": 99, "y": 40, "flags": 4},
{"matrix": [3, 6], "x": 86, "y": 40, "flags": 4},
{"matrix": [3, 5], "x": 74, "y": 40, "flags": 4},
{"matrix": [3, 4], "x": 61, "y": 40, "flags": 4},
{"matrix": [3, 3], "x": 48, "y": 40, "flags": 4},
{"matrix": [3, 2], "x": 35, "y": 40, "flags": 4},
{"matrix": [3, 1], "x": 22, "y": 40, "flags": 4},
{"matrix": [3, 0], "x": 5, "y": 40, "flags": 1},
{"matrix": [4, 0], "x": 1, "y": 52, "flags": 1},
{"matrix": [4, 1], "x": 16, "y": 52, "flags": 4},
{"matrix": [4, 2], "x": 29, "y": 52, "flags": 4},
{"matrix": [4, 3], "x": 42, "y": 52, "flags": 4},
{"matrix": [4, 4], "x": 54, "y": 52, "flags": 4},
{"matrix": [4, 5], "x": 67, "y": 52, "flags": 4},
{"matrix": [4, 6], "x": 80, "y": 52, "flags": 4},
{"matrix": [4, 7], "x": 93, "y": 52, "flags": 4},
{"matrix": [4, 8], "x": 106, "y": 52, "flags": 4},
{"matrix": [4, 9], "x": 118, "y": 52, "flags": 4},
{"matrix": [4, 10], "x": 131, "y": 52, "flags": 4},
{"matrix": [4, 11], "x": 144, "y": 52, "flags": 4},
{"matrix": [4, 12], "x": 168, "y": 52, "flags": 1},
{"matrix": [4, 15], "x": 208, "y": 52, "flags": 1},
{"matrix": [5, 16], "x": 221, "y": 64, "flags": 1},
{"matrix": [5, 15], "x": 208, "y": 64, "flags": 1},
{"matrix": [5, 14], "x": 195, "y": 64, "flags": 1},
{"matrix": [5, 13], "x": 176, "y": 64, "flags": 1},
{"matrix": [5, 12], "x": 160, "y": 64, "flags": 1},
{"matrix": [5, 11], "x": 144, "y": 64, "flags": 1},
{"matrix": [5, 6], "x": 90, "y": 64, "flags": 4},
{"matrix": [5, 2], "x": 35, "y": 64, "flags": 1},
{"matrix": [5, 1], "x": 19, "y": 64, "flags": 1},
{"matrix": [5, 0], "x": 3, "y": 64, "flags": 1}
],
"max_brightness": 120,
"sleep": true
},
"url": "www.yiancar-designs.com",
"usb": {
"device_version": "0.0.1",
"pid": "0x4E55",
"vid": "0x8968"
},
"ws2812": {
"driver": "pwm",
"pin": "B0"
},
"community_layouts": ["tkl_iso_tsangan"],
"layouts": {
"LAYOUT_tkl_iso_tsangan": {
"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, 12], "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.5},
{"matrix": [5, 1], "x": 1.5, "y": 5.25},
{"matrix": [5, 2], "x": 2.5, "y": 5.25, "w": 1.5},
{"matrix": [5, 6], "x": 4, "y": 5.25, "w": 7},
{"matrix": [5, 11], "x": 11, "y": 5.25, "w": 1.5},
{"matrix": [5, 12], "x": 12.5, "y": 5.25},
{"matrix": [5, 13], "x": 13.5, "y": 5.25, "w": 1.5},
{"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}
]
}
}
}

View file

@ -0,0 +1,69 @@
/* 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_USER_0
};
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = LAYOUT_tkl_iso_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_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(1), KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT),
[1] = LAYOUT_tkl_iso_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, _______, _______, _______, _______, _______, _______),
};
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, 255, 86, 0);
}
}
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,22 @@
/* 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/>.
*/
#pragma once
#include_next <mcuconf.h>
#undef STM32_PWM_USE_TIM3
#define STM32_PWM_USE_TIM3 TRUE

View file

@ -0,0 +1,32 @@
# NK Classic TKL
This is a TKL ISO PCB. It supports VIA and full per-key RGB.
* Keyboard Maintainer: [Yiancar](https://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar)
* Hardware Supported: A TKL keyboard with STM32F072CB or APM compatible
* Hardware Availability: https://novelkeys.com/
## Instructions
### Build
Make example for this keyboard (after setting up your build environment):
make novelkeys/nk_classic_tkl_iso:default
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).
### Reset
- Unplug
- Hold Escape
- Plug In
- Unplug
- Release Escape
### Flash
- Unplug
- Hold Escape
- Plug In
- Flash using QMK Toolbox or dfu-util (`make novelkeys/nk_classic_tkl_iso:<keymap>:dfu-util`)

View file

@ -0,0 +1,2 @@
# Wildcard to allow APM32 MCU
DFU_SUFFIX_ARGS = -v FFFF -p FFFF