aboutsummaryrefslogtreecommitdiff
path: root/keyboards/handwired
diff options
context:
space:
mode:
authorGabriel Kim <68445851+gabrielkim13@users.noreply.github.com>2022-01-09 14:44:33 -0300
committerGitHub <noreply@github.com>2022-01-09 09:44:33 -0800
commit1df390c34f95fb3c4e07518cf51438986ec7c621 (patch)
tree1d4f044f50518a05483fb3548c3c19c556e5966d /keyboards/handwired
parent7b27957adf3b960958e2592ce10e29fe866ee2fc (diff)
downloadqmk_firmware-1df390c34f95fb3c4e07518cf51438986ec7c621.tar.gz
qmk_firmware-1df390c34f95fb3c4e07518cf51438986ec7c621.zip
[Keyboard] Add Meck TKL handwired (#15533)
* Add meck_tkl * Fix configuration and pin assignment * Rellocate A10 pin, as it is used by the USB DFU bootloader * Add volume and media keys to the function keys layer * Rellocate source files to the handwired keyboards folder and add documentation * Review changes for PR - Improve LAYOUT macro to match the keyboard layout. - Use "kxy" as pin names on the LAYOUT macro. - Remove unused mcuconf.h and halconf.h. - Fix README. * Improve layout macro naming
Diffstat (limited to 'keyboards/handwired')
-rw-r--r--keyboards/handwired/meck_tkl/blackpill_f401/chconf.h39
-rw-r--r--keyboards/handwired/meck_tkl/blackpill_f401/config.h14
-rw-r--r--keyboards/handwired/meck_tkl/blackpill_f401/rules.mk10
-rw-r--r--keyboards/handwired/meck_tkl/config.h47
-rw-r--r--keyboards/handwired/meck_tkl/info.json103
-rw-r--r--keyboards/handwired/meck_tkl/keymaps/default/keymap.c29
-rw-r--r--keyboards/handwired/meck_tkl/keymaps/default/readme.md1
-rw-r--r--keyboards/handwired/meck_tkl/meck_tkl.c4
-rw-r--r--keyboards/handwired/meck_tkl/meck_tkl.h38
-rw-r--r--keyboards/handwired/meck_tkl/readme.md37
-rw-r--r--keyboards/handwired/meck_tkl/rules.mk16
11 files changed, 338 insertions, 0 deletions
diff --git a/keyboards/handwired/meck_tkl/blackpill_f401/chconf.h b/keyboards/handwired/meck_tkl/blackpill_f401/chconf.h
new file mode 100644
index 000000000..ad51f8cbe
--- /dev/null
+++ b/keyboards/handwired/meck_tkl/blackpill_f401/chconf.h
@@ -0,0 +1,39 @@
1/* Copyright 2020 QMK
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17/*
18 * This file was auto-generated by:
19 * `qmk chibios-confmigrate -i keyboards/handwired/meck_tkl/chconf.h -r platforms/chibios/common/configs/chconf.h`
20 */
21
22#pragma once
23
24#define CH_CFG_ST_FREQUENCY 10000
25
26#define CH_CFG_FACTORY_OBJECTS_REGISTRY TRUE
27
28#define CH_CFG_FACTORY_GENERIC_BUFFERS TRUE
29
30#define CH_CFG_FACTORY_SEMAPHORES TRUE
31
32#define CH_CFG_FACTORY_MAILBOXES TRUE
33
34#define CH_CFG_FACTORY_OBJ_FIFOS TRUE
35
36#define CH_CFG_FACTORY_PIPES TRUE
37
38#include_next <chconf.h>
39
diff --git a/keyboards/handwired/meck_tkl/blackpill_f401/config.h b/keyboards/handwired/meck_tkl/blackpill_f401/config.h
new file mode 100644
index 000000000..cca2eac3a
--- /dev/null
+++ b/keyboards/handwired/meck_tkl/blackpill_f401/config.h
@@ -0,0 +1,14 @@
1// Copyright 2021 Gabriel Kim (@gabrielkim13)
2// SPDX-License-Identifier: GPL-2.0-or-later
3
4#pragma once
5
6#define MATRIX_ROW_PINS \
7 { B15, A8, A9, B14, A15, B3 }
8#define MATRIX_COL_PINS \
9 { B4, B5, B6, B7, B8, B9, A1, A2, A3, A4, A5, A6, A7, B0, B1, A0, B10 }
10#define UNUSED_PINS \
11 { A10, A11, A12, B2, B12, C14, C15 }
12
13#define LED_CAPS_LOCK_PIN C13
14#define LED_PIN_ON_STATE 0
diff --git a/keyboards/handwired/meck_tkl/blackpill_f401/rules.mk b/keyboards/handwired/meck_tkl/blackpill_f401/rules.mk
new file mode 100644
index 000000000..e01b22e8f
--- /dev/null
+++ b/keyboards/handwired/meck_tkl/blackpill_f401/rules.mk
@@ -0,0 +1,10 @@
1# MCU name
2MCU = STM32F401
3
4# Bootloader selection
5BOOTLOADER = stm32-dfu
6
7# Build Options
8# change yes to no to disable
9#
10KEYBOARD_SHARED_EP = yes
diff --git a/keyboards/handwired/meck_tkl/config.h b/keyboards/handwired/meck_tkl/config.h
new file mode 100644
index 000000000..5c22e781e
--- /dev/null
+++ b/keyboards/handwired/meck_tkl/config.h
@@ -0,0 +1,47 @@
1// Copyright 2021 Gabriel Kim (@gabrielkim13)
2// SPDX-License-Identifier: GPL-2.0-or-later
3
4#pragma once
5
6#include "config_common.h"
7
8/* USB Device descriptor parameter */
9#define VENDOR_ID 0x474B
10#define PRODUCT_ID 0x0001
11#define DEVICE_VER 0x0001
12#define MANUFACTURER gabrielkim13
13#define PRODUCT Meck TKL
14
15/* key matrix size */
16#define MATRIX_ROWS 6
17#define MATRIX_COLS 17
18
19/*
20 * Keyboard Matrix Assignments
21 *
22 * Change this to how you wired your keyboard
23 * COLS: AVR pins used for columns, left to right
24 * ROWS: AVR pins used for rows, top to bottom
25 * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
26 * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
27 *
28 */
29
30/* COL2ROW, ROW2COL */
31#define DIODE_DIRECTION COL2ROW
32
33/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
34#define DEBOUNCE 5
35
36/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
37#define LOCKING_SUPPORT_ENABLE
38/* Locking resynchronize hack */
39#define LOCKING_RESYNC_ENABLE
40
41/* disable these deprecated features by default */
42#define NO_ACTION_MACRO
43#define NO_ACTION_FUNCTION
44
45/* Bootmagic Lite key configuration */
46//#define BOOTMAGIC_LITE_ROW 0
47//#define BOOTMAGIC_LITE_COLUMN 0
diff --git a/keyboards/handwired/meck_tkl/info.json b/keyboards/handwired/meck_tkl/info.json
new file mode 100644
index 000000000..5976b6758
--- /dev/null
+++ b/keyboards/handwired/meck_tkl/info.json
@@ -0,0 +1,103 @@
1{
2 "keyboard_name": "meck_tkl",
3 "url": "github.com/gabrielkim13",
4 "maintainer": "gabrielkim13",
5 "layouts": {
6 "LAYOUT_tkl_ansi": {
7 "layout": [
8 { "label": "Esc", "x": 0, "y": 0 },
9 { "label": "F1", "x": 2, "y": 0 },
10 { "label": "F2", "x": 3, "y": 0 },
11 { "label": "F3", "x": 4, "y": 0 },
12 { "label": "F4", "x": 5, "y": 0 },
13 { "label": "F5", "x": 6.5, "y": 0 },
14 { "label": "F6", "x": 7.5, "y": 0 },
15 { "label": "F7", "x": 8.5, "y": 0 },
16 { "label": "F8", "x": 9.5, "y": 0 },
17 { "label": "F9", "x": 11, "y": 0 },
18 { "label": "F10", "x": 12, "y": 0 },
19 { "label": "F11", "x": 13, "y": 0 },
20 { "label": "F12", "x": 14, "y": 0 },
21 { "label": "Print Screen", "x": 15.25, "y": 0 },
22 { "label": "Scroll Lock", "x": 16.25, "y": 0 },
23 { "label": "Pause", "x": 17.25, "y": 0 },
24
25 { "label": "`", "x": 0, "y": 1.5 },
26 { "label": "1", "x": 1, "y": 1.5 },
27 { "label": "2", "x": 2, "y": 1.5 },
28 { "label": "3", "x": 3, "y": 1.5 },
29 { "label": "4", "x": 4, "y": 1.5 },
30 { "label": "5", "x": 5, "y": 1.5 },
31 { "label": "6", "x": 6, "y": 1.5 },
32 { "label": "7", "x": 7, "y": 1.5 },
33 { "label": "8", "x": 8, "y": 1.5 },
34 { "label": "9", "x": 9, "y": 1.5 },
35 { "label": "0", "x": 10, "y": 1.5 },
36 { "label": "-", "x": 11, "y": 1.5 },
37 { "label": "=", "x": 12, "y": 1.5 },
38 { "label": "Back Space", "x": 13, "y": 1.5, "w": 2 },
39 { "label": "Insert", "x": 15.25, "y": 1.5 },
40 { "label": "Home", "x": 16.25, "y": 1.5 },
41 { "label": "Page Up", "x": 17.25, "y": 1.5 },
42
43 { "label": "Tab", "x": 0, "y": 2.5, "w": 1.5 },
44 { "label": "Q", "x": 1.5, "y": 2.5 },
45 { "label": "W", "x": 2.5, "y": 2.5 },
46 { "label": "E", "x": 3.5, "y": 2.5 },
47 { "label": "R", "x": 4.5, "y": 2.5 },
48 { "label": "T", "x": 5.5, "y": 2.5 },
49 { "label": "Y", "x": 6.5, "y": 2.5 },
50 { "label": "U", "x": 7.5, "y": 2.5 },
51 { "label": "I", "x": 8.5, "y": 2.5 },
52 { "label": "O", "x": 9.5, "y": 2.5 },
53 { "label": "P", "x": 10.5, "y": 2.5 },
54 { "label": "[", "x": 11.5, "y": 2.5 },
55 { "label": "]", "x": 12.5, "y": 2.5 },
56 { "label": "\\", "x": 13.5, "y": 2.5, "w": 1.5 },
57 { "label": "Delete", "x": 15.25, "y": 2.5 },
58 { "label": "End", "x": 16.25, "y": 2.5 },
59 { "label": "Page Down", "x": 17.25, "y": 2.5 },
60
61 { "label": "Caps Lock", "x": 0, "y": 3.5, "w": 1.75 },
62 { "label": "A", "x": 1.75, "y": 3.5 },
63 { "label": "S", "x": 2.75, "y": 3.5 },
64 { "label": "D", "x": 3.75, "y": 3.5 },
65 { "label": "F", "x": 4.75, "y": 3.5 },
66 { "label": "G", "x": 5.75, "y": 3.5 },
67 { "label": "H", "x": 6.75, "y": 3.5 },
68 { "label": "J", "x": 7.75, "y": 3.5 },
69 { "label": "K", "x": 8.75, "y": 3.5 },
70 { "label": "L", "x": 9.75, "y": 3.5 },
71 { "label": ";", "x": 10.75, "y": 3.5 },
72 { "label": "'", "x": 11.75, "y": 3.5 },
73 { "label": "Enter", "x": 12.75, "y": 3.5, "w": 2.25 },
74
75 { "label": "Left Shift", "x": 0, "y": 4.5, "w": 2.25 },
76 { "label": "Z", "x": 2.25, "y": 4.5 },
77 { "label": "X", "x": 3.25, "y": 4.5 },
78 { "label": "C", "x": 4.25, "y": 4.5 },
79 { "label": "V", "x": 5.25, "y": 4.5 },
80 { "label": "B", "x": 6.25, "y": 4.5 },
81 { "label": "N", "x": 7.25, "y": 4.5 },
82 { "label": "M", "x": 8.25, "y": 4.5 },
83 { "label": ",", "x": 9.25, "y": 4.5 },
84 { "label": ".", "x": 10.25, "y": 4.5 },
85 { "label": "/", "x": 11.25, "y": 4.5 },
86 { "label": "Right Shift", "x": 12.25, "y": 4.5, "w": 2.75 },
87 { "label": "Up", "x": 16.25, "y": 4.5 },
88
89 { "label": "Left Ctrl", "x": 0, "y": 5.5, "w": 1.25 },
90 { "label": "Left OS", "x": 1.25, "y": 5.5, "w": 1.25 },
91 { "label": "Left Alt", "x": 2.5, "y": 5.5, "w": 1.25 },
92 { "label": "Space", "x": 3.75, "y": 5.5, "w": 6.25 },
93 { "label": "Right Alt", "x": 10, "y": 5.5, "w": 1.25 },
94 { "label": "Fn", "x": 11.25, "y": 5.5, "w": 1.25 },
95 { "label": "Menu", "x": 12.5, "y": 5.5, "w": 1.25 },
96 { "label": "Right Ctrl", "x": 13.75, "y": 5.5, "w": 1.25 },
97 { "label": "Left", "x": 15.25, "y": 5.5 },
98 { "label": "Down", "x": 16.25, "y": 5.5 },
99 { "label": "Right", "x": 17.25, "y": 5.5 }
100 ]
101 }
102 }
103}
diff --git a/keyboards/handwired/meck_tkl/keymaps/default/keymap.c b/keyboards/handwired/meck_tkl/keymaps/default/keymap.c
new file mode 100644
index 000000000..1df1318db
--- /dev/null
+++ b/keyboards/handwired/meck_tkl/keymaps/default/keymap.c
@@ -0,0 +1,29 @@
1// Copyright 2021 Gabriel Kim (@gabrielkim13)
2// SPDX-License-Identifier: GPL-2.0-or-later
3
4#include QMK_KEYBOARD_H
5
6// Defines names for use in layer keycodes and the keymap
7enum layer_names {
8 _BASE,
9 _FN
10};
11
12const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
13 [_BASE] = LAYOUT_tkl_ansi(
14 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_SLCK, KC_PAUS,
15 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,
16 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,
17 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,
18 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,
19 KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, MO(1), KC_MENU, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
20 ),
21 [_FN] = LAYOUT_tkl_ansi(
22 _______, KC_MUTE, KC_VOLD, KC_VOLU, _______, KC_MPRV, KC_MPLY, KC_MNXT, _______, _______, _______, _______, _______, _______, _______, KC_SLEP,
23 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
24 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
25 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
26 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
27 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
28 )
29};
diff --git a/keyboards/handwired/meck_tkl/keymaps/default/readme.md b/keyboards/handwired/meck_tkl/keymaps/default/readme.md
new file mode 100644
index 000000000..9e2994008
--- /dev/null
+++ b/keyboards/handwired/meck_tkl/keymaps/default/readme.md
@@ -0,0 +1 @@
# The default keymap for meck_tkl
diff --git a/keyboards/handwired/meck_tkl/meck_tkl.c b/keyboards/handwired/meck_tkl/meck_tkl.c
new file mode 100644
index 000000000..2668b440e
--- /dev/null
+++ b/keyboards/handwired/meck_tkl/meck_tkl.c
@@ -0,0 +1,4 @@
1// Copyright 2021 Gabriel Kim (@gabrielkim13)
2// SPDX-License-Identifier: GPL-2.0-or-later
3
4#include "meck_tkl.h"
diff --git a/keyboards/handwired/meck_tkl/meck_tkl.h b/keyboards/handwired/meck_tkl/meck_tkl.h
new file mode 100644
index 000000000..a7417dbaf
--- /dev/null
+++ b/keyboards/handwired/meck_tkl/meck_tkl.h
@@ -0,0 +1,38 @@
1// Copyright 2021 Gabriel Kim (@gabrielkim13)
2// SPDX-License-Identifier: GPL-2.0-or-later
3
4#pragma once
5
6#include "quantum.h"
7
8/* This is a shortcut to help you visually see your layout.
9 *
10 * The first section contains all of the arguments representing the physical
11 * layout of the board and position of the keys.
12 *
13 * The second converts the arguments into a two-dimensional array which
14 * represents the switch matrix.
15 *
16 *
17 * | Esc | | F1 | F2 | F3 | F4 | | F5 | F6 | F7 | F8 | | F9 | F10 | F11 | F12 | | SLk | Pau | NLk |
18 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | - | = | Back | | Ins | Hom | PUp |
19 * | Tab | Q | W | E | R | T | Y | U | I | O | P | [ | ] | \ | | Del | End | PDn |
20 * | Caps | A | S | D | F | G | H | J | K | L | ; | ' | Enter |
21 * | Shift | Z | X | C | V | B | N | M | , | . | / | Shift | | ^ |
22 * | Ctrl | Win | alt | Space | alt | fn | Menu | Ctrl | | < | v | > |
23 */
24#define LAYOUT_tkl_ansi( \
25 k00 , k01 , k02 , k03 , k04 , k05 , k06 , k07 , k08 , k09 , k0A , k0B , k0C , k0D , k0E , k0F , \
26 k10 , k11 , k12 , k13 , k14 , k15 , k16 , k17 , k18 , k19 , k1A , k1B , k1C , k1D , k1E , k1F , k1G , \
27 k20 , k21 , k22 , k23 , k24 , k25 , k26 , k27 , k28 , k29 , k2A , k2B , k2C , k2D , k2E , k2F , k2G , \
28 k30 , k31 , k32 , k33 , k34 , k35 , k36 , k37 , k38 , k39 , k3A , k3B , k3C , \
29 k40 , k41 , k42 , k43 , k44 , k45 , k46 , k47 , k48 , k49 , k4A , k4B , k4C , \
30 k50 , k51 , k52 , k53 , k54 , k55 , k56 , k57 , k58 , k59 , k5A \
31) { \
32 { k00, KC_NO, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0D, k0E, k0F }, \
33 { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D, k1E, k1F, k1G }, \
34 { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k2D, k2E, k2F, k2G }, \
35 { k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, KC_NO, k3C, KC_NO, KC_NO, KC_NO }, \
36 { k40, KC_NO, k41, k42, k43, k44, k45, k46, k47, k48, k49, k4A, KC_NO, k4B, KC_NO, k4C, KC_NO }, \
37 { k50, k51, k52, KC_NO, KC_NO, KC_NO, k53, KC_NO, KC_NO, KC_NO, k54, k55, k56, k57, k58, k59, k5A } \
38}
diff --git a/keyboards/handwired/meck_tkl/readme.md b/keyboards/handwired/meck_tkl/readme.md
new file mode 100644
index 000000000..ec09047dd
--- /dev/null
+++ b/keyboards/handwired/meck_tkl/readme.md
@@ -0,0 +1,37 @@
1# meck_tkl
2
3![meck_tkl](https://i.imgur.com/eIpQTjQ.jpeg)
4
5A standard tenkeyless keyboard, using STM32 Blackpill.
6
7* Keyboard Maintainer: [Gabriel Kim](https://github.com/gabrielkim13)
8* Hardware Supported: Blackpill F401
9* Hardware Availability: [Thingiverse: Mechanical Keyboard - MECH - TKL](https://www.thingiverse.com/thing:4225961)
10
11Make example for this keyboard (after setting up your build environment):
12
13 make handwired/meck_tkl:default
14
15Flashing example for this keyboard:
16
17 make handwired/meck_tkl:default:flash
18
19See 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).
20
21## Bootloader
22
23Enter the bootloader in 3 ways:
24
25* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
26* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
27* **Keycode in layout**: Press the key mapped to `RESET` if it is available
28
29## Wiring instructions
30
31- On Blackpill boards, **avoid** using the following pins, since they will cause either USB enumeration or the DFU bootloader to not work correctly:
32 - **USB-related pins:** `PA10`, `PA11`, `PA12`
33 - **BOOT1 pin:** `PB2`
34
35Sample wiring:
36
37![wiring](https://i.imgur.com/jIDmsNy.jpg)
diff --git a/keyboards/handwired/meck_tkl/rules.mk b/keyboards/handwired/meck_tkl/rules.mk
new file mode 100644
index 000000000..621328511
--- /dev/null
+++ b/keyboards/handwired/meck_tkl/rules.mk
@@ -0,0 +1,16 @@
1# Build Options
2# change yes to no to disable
3#
4BOOTMAGIC_ENABLE = yes # Enable Bootmagic Lite
5MOUSEKEY_ENABLE = yes # Mouse keys
6EXTRAKEY_ENABLE = yes # Audio control and System control
7CONSOLE_ENABLE = yes # Console for debug
8COMMAND_ENABLE = no # Commands for debug and configuration
9NKRO_ENABLE = yes # Enable N-Key Rollover
10BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
11RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
12AUDIO_ENABLE = no # Audio output
13AUDIO_SUPPORTED = no
14BACKLIGHT_SUPPORTED = no
15
16DEFAULT_FOLDER = handwired/meck_tkl/blackpill_f401
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-02 07:31:08 +0000