[Keyboard] Add cest73/tkm keyboard (qmk#13939)

Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: cest <cest@localhost>
VictorIsaacChavezEscamilla · Aug 28, 2021 · d37dbee · d37dbee
1 parent d7ad69b
commit d37dbee
Show file tree

Hide file tree

Showing 7 changed files with 382 additions and 0 deletions.
diff --git a/keyboards/cest73/tkm/config.h b/keyboards/cest73/tkm/config.h
@@ -0,0 +1,55 @@
+ /* Copyright 2021 cest73 
+  * 
+  * 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 "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0xBADD
+#define PRODUCT_ID      0xAA55
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    cest73
+#define PRODUCT         TKM-2021 R1.03
+
+/* key matrix size */
+#define MATRIX_ROWS 11
+#define MATRIX_COLS 10
+
+/* matrix sz handy ruler:  1   2   3   4   5   6   7   8   9  10  11  12 */
+/* key matrix pins */
+/*    row    handy ruler: r0  r1  r2  r3  r4  r5  r6  r7  r8  r9  r10 */
+#define MATRIX_ROW_PINS { B0, B1, B2, B3, B4, B5, B6, B7, C6, C7, D0 }
+/*    column handy ruler: c0  c1  c2  c3  c4  c5  c6  c7  c8  c9 */
+#define MATRIX_COL_PINS { D1, D2, D3, D4, D5, D6, D7, F0, F1, F4 }
+#define UNUSED_PINS { AF }
+
+//NOTE: if D6 pin shows any issues in exploatation the LED on the Teensy is to be removed
+
+#define LED_NUM_LOCK_PIN F6
+#define LED_CAPS_LOCK_PIN F5
+#define LED_SCROLL_LOCK_PIN F7
+#define LED_PIN_ON_STATE 0
+//TODO change the E6 pin to either B5, B6, B7 or C6 to utilize hardware PWM on a future PCB revision
+#define BACKLIGHT_PIN E6
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCE 5
+
+/* force n-key rollover*/
+#define FORCE_NKRO
diff --git a/keyboards/cest73/tkm/info.json b/keyboards/cest73/tkm/info.json
@@ -0,0 +1,122 @@
+{
+    "keyboard_name": "TKM 2021",
+    "url": "https://geekhack.org/index.php?topic=110499",
+    "maintainer": "cest73 (aka fire-h0und)",
+    "width": 21,
+    "height": 6.75,
+    "layouts": {
+        "LAYOUT_all": {
+            "layout": [
+              {"label":"Fn", "x":0, "y":0},
+              {"label":"PrtSc", "x":1, "y":0},
+              {"label":"Scroll Lock", "x":2, "y":0},
+              {"label":"Pause", "x":3, "y":0},
+              {"label":"Esc", "x":4.5, "y":0},
+              {"label":"F1", "x":6, "y":0},
+              {"label":"F2", "x":7, "y":0},
+              {"label":"F3", "x":8, "y":0},
+              {"label":"F4", "x":9, "y":0},
+              {"label":"F5", "x":10.25, "y":0},
+              {"label":"F6", "x":11.25, "y":0},
+              {"label":"F7", "x":12.25, "y":0},
+              {"label":"F8", "x":13.25, "y":0},
+              {"label":"F9", "x":14.5, "y":0},
+              {"label":"F10", "x":15.5, "y":0},
+              {"label":"F11", "x":16.5, "y":0},
+              {"label":"F12", "x":17.5, "y":0},
+              {"label":"Home", "x":19, "y":0},
+              {"label":"PgUp", "x":20, "y":0},
+
+              {"label":"-", "x":0, "y":1.5},
+              {"label":"*", "x":1, "y":1.5},
+              {"label":"/", "x":2, "y":1.5},
+              {"label":"Num Lock", "x":3, "y":1.5},
+              {"label":"~", "x":4.5, "y":1.5},
+              {"label":"!", "x":5.5, "y":1.5},
+              {"label":"\"", "x":6.5, "y":1.5},
+              {"label":"\u00a3", "x":7.5, "y":1.5},
+              {"label":"$", "x":8.5, "y":1.5},
+              {"label":"%", "x":9.5, "y":1.5},
+              {"label":"^", "x":10.5, "y":1.5},
+              {"label":"&", "x":11.5, "y":1.5},
+              {"label":"*", "x":12.5, "y":1.5},
+              {"label":"(", "x":13.5, "y":1.5},
+              {"label":")", "x":14.5, "y":1.5},
+              {"label":"_", "x":15.5, "y":1.5},
+              {"label":"+", "x":16.5, "y":1.5},
+              {"label":"Backspace", "x":17.5, "y":1.5, "w":2},
+              {"label":"Insert", "x":20, "y":1.5},
+
+              {"label":"+", "x":0, "y":2.5, "h":2},
+              {"label":"9", "x":1, "y":2.5},
+              {"label":"8", "x":2, "y":2.5},
+              {"label":"7", "x":3, "y":2.5},
+              {"label":"Tab", "x":4.5, "y":2.5, "w":1.5},
+              {"label":"Q", "x":6, "y":2.5},
+              {"label":"W", "x":7, "y":2.5},
+              {"label":"E", "x":8, "y":2.5},
+              {"label":"R", "x":9, "y":2.5},
+              {"label":"T", "x":10, "y":2.5},
+              {"label":"Y", "x":11, "y":2.5},
+              {"label":"U", "x":12, "y":2.5},
+              {"label":"I", "x":13, "y":2.5},
+              {"label":"O", "x":14, "y":2.5},
+              {"label":"P", "x":15, "y":2.5},
+              {"label":"{", "x":16, "y":2.5},
+              {"label":"}", "x":17, "y":2.5},
+              {"label":"Enter", "x":18.25, "y":2.5, "w":1.25, "h":2},
+              {"label":"Delete", "x":20, "y":2.5},
+
+              {"label":"6", "x":1, "y":3.5},
+              {"label":"5", "x":2, "y":3.5},
+              {"label":"4", "x":3, "y":3.5},
+              {"label":"CAPS", "x":4.5, "y":3.5, "w":1.25},
+              {"label":"A", "x":6.25, "y":3.5},
+              {"label":"S", "x":7.25, "y":3.5},
+              {"label":"D", "x":8.25, "y":3.5},
+              {"label":"F", "x":9.25, "y":3.5},
+              {"label":"G", "x":10.25, "y":3.5},
+              {"label":"H", "x":11.25, "y":3.5},
+              {"label":"J", "x":12.25, "y":3.5},
+              {"label":"K", "x":13.25, "y":3.5},
+              {"label":"L", "x":14.25, "y":3.5},
+              {"label":":", "x":15.25, "y":3.5},
+              {"label":"@", "x":16.25, "y":3.5},
+              {"label":"|", "x":17.25, "y":3.5},
+              {"label":"PgDn", "x":20, "y":3.5},
+
+              {"label":"Enter", "x":0, "y":4.5, "h":2},
+              {"label":"3", "x":1, "y":4.5},
+              {"label":"2", "x":2, "y":4.5},
+              {"label":"1", "x":3, "y":4.5},
+              {"label":"Shift", "x":4.5, "y":4.5, "w":2.25},
+              {"label":"Z", "x":6.75, "y":4.5},
+              {"label":"X", "x":7.75, "y":4.5},
+              {"label":"C", "x":8.75, "y":4.5},
+              {"label":"V", "x":9.75, "y":4.5},
+              {"label":"B", "x":10.75, "y":4.5},
+              {"label":"N", "x":11.75, "y":4.5},
+              {"label":"M", "x":12.75, "y":4.5},
+              {"label":"<", "x":13.75, "y":4.5},
+              {"label":">", "x":14.75, "y":4.5},
+              {"label":"?", "x":15.75, "y":4.5},
+              {"label":"Shift", "x":16.75, "y":4.5, "w":1.75},
+              {"label":"End", "x":20, "y":4.5},
+              {"label":"\u2191", "x":18.75, "y":4.75},
+
+              {"label":".", "x":1, "y":5.5},
+              {"label":"0", "x":2, "y":5.5, "w":2},
+              {"label":"Ctrl", "x":4.5, "y":5.5, "w":1.25},
+              {"label":"Win", "x":5.75, "y":5.5},
+              {"label":"Alt", "x":6.75, "y":5.5, "w":1.25},
+              {"label":"Mod1", "x":8, "y":5.5, "w":1.5},
+              {"label":"Space", "x":8, "y":5.5, "w":6.25},
+              {"label":"AltGr", "x":14.25, "y":5.5},
+              {"label":"Menu", "x":15.25, "y":5.5},
+              {"label":"Ctrl", "x":16.25, "y":5.5, "w":1.25},
+              {"label":"\u2190", "x":17.75, "y":5.75},
+              {"label":"\u2193", "x":18.75, "y":5.75},
+              {"label":"\u2192", "x":19.75, "y":5.75}]
+        }
+    }
+}
diff --git a/keyboards/cest73/tkm/keymaps/default/keymap.c b/keyboards/cest73/tkm/keymaps/default/keymap.c
@@ -0,0 +1,79 @@
+ /* Copyright 2021 cest73 
+  * 
+  * 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
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+		_BASE,
+		_FN
+};
+
+/*
+ * ┌───┬───┬───┬───┐ ┌───┐ ┌───┬───┬───┬───┐┌───┬───┬───┬───┐┌───┬───┬───┬───┐ ┌───┬───┐
+ * │Fn │PSc│Scr│Pse│ │Esc│ │F1 │F2 │F3 │F4 ││F5 │F6 │F7 │F8 ││F9 │F10│F11│F12│ │Hme│PgU│
+ * └───┴───┴───┴───┘ └───┘ └───┴───┴───┴───┘└───┴───┴───┴───┘└───┴───┴───┴───┘ └───┴───┘
+ *
+ * ┌───┬───┬───┬───┐ ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐ ┌───┐
+ * │ - │ * │ / │Num│ │ ` │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │Bsl│Bsp│ │Ins│
+ * ├───┼───┼───┼───┤ ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┤ ├───┤
+ * │ + │ 9 │ 8 │ 7 │ │ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ [ │ ] │  \  │ │Del│
+ * ├───┼───┼───┼───┤ ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬────│ ├───┤
+ * │ = │ 6 │ 5 │ 4 │ │ Caps │ A │ S │ D │ F │ G │ H │ J │ K │ L │ ; │ ' │Etl│ Ent│ │PgD│
+ * ├───┼───┼───┼───┤ ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┘ ├───┤
+ * │Tab│ 3 │ 2 │ 1 │ │Shft│Shl│ Z │ X │ C │ V │ B │ N │ M │ , │ . │ / │ Shift│┌───┐│End│
+ * ├───┼───┼───┼───┤ ├────┼───┼───┴┬──┴───┴───┴───┴───┴───┴─┬─┴─┬─┴─┬─┴──┬───┘│ ↑ │└───┘
+ * │Ent│ . │ , │ 0 │ │Ctrl│GUI│Alt │                        │Alt│Mnu│Ctrl│┌───┼───┼───┐
+ * └───┴───┴───┴───┘ └────┴───┴────┴────────────────────────┴───┴───┴────┘│ ← │ ↓ │ → │
+ *                                                                        └───┴───┴───┘
+ */
+ /*
+ * ┌───┬───┬───┬───┐ ┌───┐ ┌───┬───┬───┬───┐┌───┬───┬───┬───┐┌───┬───┬───┬───┐ ┌───┬───┐
+ * │   │   │   │   │ │Rst│ │   │   │   │   ││   │   │   │   ││   │   │   │   │ │   │   │
+ * └───┴───┴───┴───┘ └───┘ └───┴───┴───┴───┘└───┴───┴───┴───┘└───┴───┴───┴───┘ └───┴───┘
+ *
+ * ┌───┬───┬───┬───┐ ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐ ┌───┐
+ * │   │   │   │   │ │   │   │   │   │   │   │   │   │   │   │   │   │   │   │   │ │   │
+ * ├───┼───┼───┼───┤ ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┤ ├───┤
+ * │   │   │   │   │ │     │   │   │   │   │   │   │   │   │   │   │   │   │     │ │   │
+ * ├───┼───┼───┼───┤ ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬────│ ├───┤
+ * │   │   │   │   │ │      │   │   │   │   │   │ ← │ ↑ │ ↓ │ → │   │   │   │ Ent│ │   │
+ * ├───┼───┼───┼───┤ ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┘ ├───┤
+ * │   │   │   │   │ │Shft│   │   │   │   │   │   │   │   │   │   │   │ Shift│┌───┐│   │
+ * ├───┼───┼───┼───┤ ├────┼───┼───┴┬──┴───┴───┴───┴───┴───┴─┬─┴─┬─┴─┬─┴──┬───┘│ ↑ │└───┘
+ * │   │   │   │   │ │Ctrl│GUI│Alt │                        │Alt│Mnu│Ctrl│┌───┼───┼───┐
+ * └───┴───┴───┴───┘ └────┴───┴────┴────────────────────────┴───┴───┴────┘│ ← │ ↓ │ → │
+ *                                                                        └───┴───┴───┘
+ */
+
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+	[_BASE] = LAYOUT_all(
+	MO(1),   KC_PSCR, KC_SLCK, KC_PAUS, 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_HOME, KC_PGUP,
+	KC_PMNS, KC_PAST, KC_PSLS, KC_NLCK, 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_BSLS, KC_BSPC,     KC_INS,
+	KC_PPLS, KC_P9,   KC_P8,   KC_P7,   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_PEQL, KC_P6,   KC_P5,   KC_P4,   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_PGDN,
+	KC_TAB,  KC_P3,   KC_P2,   KC_P1,   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_END,
+	KC_PENT, KC_PDOT, KC_PCMM, KC_P0,   KC_LCTL, KC_LGUI, KC_LALT,                      KC_SPC,                  KC_RALT, KC_APP, KC_RCTL,     KC_LEFT, KC_DOWN, KC_RGHT
+	),
+	[_FN] = LAYOUT_all(
+	KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,  RESET,        KC_F13,  KC_F14,  KC_F15,  KC_F16,  KC_F17,  KC_F18,  KC_F19,  KC_F20,  KC_F21,  KC_F22,  KC_F23,  KC_F24,       KC_TRNS, KC_TRNS,
+	KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,  KC_TRNS,
+	KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,  KC_TRNS,      KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,     KC_TRNS,  KC_TRNS,
+	KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,  KC_TRNS,        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_LEFT,   KC_UP, KC_DOWN, KC_RGHT, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,    KC_TRNS,
+	KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,  KC_TRNS,
+	KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS,                   KC_TRNS,                   KC_TRNS, KC_TRNS, KC_TRNS,           KC_TRNS, KC_TRNS, KC_TRNS
+	)
+};
diff --git a/keyboards/cest73/tkm/readme.md b/keyboards/cest73/tkm/readme.md
@@ -0,0 +1,22 @@
+# Ten Key Mirrored - 2021
+
+![TKM-2021](https://imgur.com/AlvRk1zh.jpg)
+
+Another take on left side numpad and this time mirrored too for the ever more spacious mouse playground.
+
+* Keyboard Maintainer: cest73 (aka fire-h0und)
+* Hardware Supported: TKM-2021 (multiple layouts and switch options including ALPS, ISO and BAE)
+* Hardware Availability: https://geekhack.org/index.php?topic=110499
+
+
+Make example for this keyboard (after setting up your build environment):
+
+    qmk compile -kb cest73/tkm -km default
+
+As the board uses Teensy 2.0 as a daughter board, to bring the board into flash mode is it sufficient to press the button present on the Teensy.
+
+[TKM-2021 PCB](https://geekhack.org/index.php?action=dlattach;topic=110499.0;attach=268641;image)
+
+Despite many hours gazing over the schematics there was a nasty error on the first batch: namely the 6 and 7 columns got swapped in the design process. Luckily it was trivial to fix in the firmware section (see the comments in the layout file(s)).
+
+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).
diff --git a/keyboards/cest73/tkm/rules.mk b/keyboards/cest73/tkm/rules.mk
@@ -0,0 +1,22 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = halfkay
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = full     # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = no        # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+COMMAND_ENABLE = no         # Commands for debug and configuration
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
+# if this doesn't work, see here: /~https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+NKRO_ENABLE = yes           # USB Nkey Rollover
+BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output
diff --git a/keyboards/cest73/tkm/tkm.c b/keyboards/cest73/tkm/tkm.c
@@ -0,0 +1,16 @@
+ /* Copyright 2021 cest73 
+  * 
+  * 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 "tkm.h"