TKC TKL_A/B87: Initial support (qmk#10943)

Co-authored-by: Joel Challis <[email protected]> Co-authored-by: Ryan <[email protected]> Co-authored-by: James Young <[email protected]>
besselfunct · Dec 2, 2020 · 2989f9c · 2989f9c
1 parent bcab02b
commit 2989f9c
Show file tree

Hide file tree

Showing 9 changed files with 434 additions and 0 deletions.
diff --git a/keyboards/tkc/tkl_ab87/config.h b/keyboards/tkc/tkl_ab87/config.h
@@ -0,0 +1,151 @@
+/*
+Copyright 2020 Terry Mathews
+
+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       0x544B //TK
+#define PRODUCT_ID      0x0007
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    TKC
+#define PRODUCT         TKL A/B87
+
+/* key matrix size */
+#define MATRIX_ROWS 6
+#define MATRIX_COLS 16
+
+#define DYNAMIC_KEYMAP_LAYER_COUNT 2 //Reduced layer count due to memory space considerations
+
+/*
+ * Keyboard Matrix Assignments
+ *
+ * Change this to how you wired your keyboard
+ * COLS: AVR pins used for columns, left to right
+ * ROWS: AVR pins used for rows, top to bottom
+ * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
+ *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
+ *
+*/
+#define MATRIX_ROW_PINS { B1, F5, F7, B0, B2, B3 }
+#define MATRIX_COL_PINS { D0, D1, D2, D3, D5, D4, D6, D7, B4, B5, B6, C6, C7, E6, F6, F4 }
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL*/
+#define DIODE_DIRECTION COL2ROW
+
+/*
+ * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
+ */
+//#define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6
+#define BACKLIGHT_PIN B7
+#ifdef BACKLIGHT_PIN
+#define BACKLIGHT_BREATHING
+#define BACKLIGHT_LEVELS 3
+#endif
+#define RGB_DI_PIN E2
+#ifdef RGB_DI_PIN
+  #define RGBLED_NUM 22
+  #define RGBLIGHT_HUE_STEP 8
+  #define RGBLIGHT_SAT_STEP 8
+  #define RGBLIGHT_VAL_STEP 8
+  #define RGBLIGHT_LIMIT_VAL 200 /* The maximum brightness level */
+  #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
+/*== all animations enable ==*/
+  #define RGBLIGHT_ANIMATIONS
+// /*== or choose animations ==*/
+//   #define RGBLIGHT_EFFECT_BREATHING
+//   #define RGBLIGHT_EFFECT_RAINBOW_MOOD
+//   #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+//   #define RGBLIGHT_EFFECT_SNAKE
+//   #define RGBLIGHT_EFFECT_KNIGHT
+//   #define RGBLIGHT_EFFECT_CHRISTMAS
+//   #define RGBLIGHT_EFFECT_STATIC_GRADIENT
+//   #define RGBLIGHT_EFFECT_RGB_TEST
+//   #define RGBLIGHT_EFFECT_ALTERNATING
+// /*== customize breathing effect ==*/
+//   /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
+//   #define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
+//   /*==== use exp() and sin() ====*/
+//   #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
+//   #define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
+#endif
+
+#define LED_SCROLL_LOCK_PIN F0
+#define LED_CAPS_LOCK_PIN F1
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* number of backlight levels */
+
+/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
+#define LOCKING_SUPPORT_ENABLE
+/* Locking resynchronize hack */
+#define LOCKING_RESYNC_ENABLE
+
+/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
+ * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
+ */
+// #define GRAVE_ESC_CTRL_OVERRIDE
+
+/*
+ * Force NKRO
+ *
+ * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
+ * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
+ * makefile for this to work.)
+ *
+ * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
+ * until the next keyboard reset.
+ *
+ * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
+ * fully operational during normal computer usage.
+ *
+ * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
+ * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
+ * bootmagic, NKRO mode will always be enabled until it is toggled again during a
+ * power-up.
+ *
+ */
+//#define FORCE_NKRO
+
+/*
+ * Feature disable options
+ *  These options are also useful to firmware size reduction.
+ */
+
+/* disable debug print */
+//#define NO_DEBUG
+
+/* disable print */
+//#define NO_PRINT
+
+/* disable action features */
+//#define NO_ACTION_LAYER
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
+//#define NO_ACTION_MACRO
+//#define NO_ACTION_FUNCTION
+
+/* Bootmagic Lite key configuration */
+// #define BOOTMAGIC_LITE_ROW 0
+// #define BOOTMAGIC_LITE_COLUMN 0
diff --git a/keyboards/tkc/tkl_ab87/info.json b/keyboards/tkc/tkl_ab87/info.json
@@ -0,0 +1,103 @@
+{
+    "keyboard_name": "TKC TKL A/B87", 
+    "url": "", 
+    "maintainer": "TerryMathews", 
+    "width": 18.25, 
+    "height": 6.5, 
+    "layouts": {
+        "LAYOUT_all": {
+            "layout": [
+				{"label":"Esc", "x":0, "y":0},
+				{"label":"F1", "x":2, "y":0}, 
+				{"label":"F2", "x":3, "y":0}, 
+				{"label":"F3", "x":4, "y":0}, 
+				{"label":"F4", "x":5, "y":0}, 
+				{"label":"F5", "x":6.5, "y":0}, 
+				{"label":"F6", "x":7.5, "y":0}, 
+				{"label":"F7", "x":8.5, "y":0}, 
+				{"label":"F8", "x":9.5, "y":0}, 
+				{"label":"F9", "x":11, "y":0}, 
+				{"label":"F10", "x":12, "y":0}, 
+				{"label":"F11", "x":13, "y":0}, 
+				{"label":"F12", "x":14, "y":0}, 
+				{"label":"PrtSc", "x":15.25, "y":0}, 
+				{"label":"Scroll Lock", "x":16.25, "y":0}, 
+				{"label":"Pause", "x":17.25, "y":0}, 
+				{"label":"~", "x":0, "y":1.5}, 
+				{"label":"!", "x":1, "y":1.5}, 
+				{"label":"@", "x":2, "y":1.5}, 
+				{"label":"#", "x":3, "y":1.5}, 
+				{"label":"$", "x":4, "y":1.5}, 
+				{"label":"%", "x":5, "y":1.5}, 
+				{"label":"^", "x":6, "y":1.5}, 
+				{"label":"&", "x":7, "y":1.5}, 
+				{"label":"*", "x":8, "y":1.5}, 
+				{"label":"(", "x":9, "y":1.5}, 
+				{"label":")", "x":10, "y":1.5}, 
+				{"label":"_", "x":11, "y":1.5}, 
+				{"label":"+", "x":12, "y":1.5}, 
+				{"label":"Del", "x":13, "y":1.5}, 
+				{"label":"Bksp", "x":14, "y":1.5}, 
+				{"label":"Insert", "x":15.25, "y":1.5}, 
+				{"label":"Home", "x":16.25, "y":1.5}, 
+				{"label":"PgUp", "x":17.25, "y":1.5}, 
+				{"label":"Tab", "x":0, "y":2.5, "w":1.5}, 
+				{"label":"Q", "x":1.5, "y":2.5}, 
+				{"label":"W", "x":2.5, "y":2.5}, 
+				{"label":"E", "x":3.5, "y":2.5}, 
+				{"label":"R", "x":4.5, "y":2.5}, 
+				{"label":"T", "x":5.5, "y":2.5}, 
+				{"label":"Y", "x":6.5, "y":2.5}, 
+				{"label":"U", "x":7.5, "y":2.5}, 
+				{"label":"I", "x":8.5, "y":2.5}, 
+				{"label":"O", "x":9.5, "y":2.5}, 
+				{"label":"P", "x":10.5, "y":2.5}, 
+				{"label":"{", "x":11.5, "y":2.5}, 
+				{"label":"}", "x":12.5, "y":2.5}, 
+				{"label":"|", "x":13.5, "y":2.5, "w":1.5}, 
+				{"label":"Delete", "x":15.25, "y":2.5}, 
+				{"label":"End", "x":16.25, "y":2.5}, 
+				{"label":"PgDn", "x":17.25, "y":2.5}, 
+				{"label":"Caps Lock", "x":0, "y":3.5, "w":1.75}, 
+				{"label":"A", "x":1.75, "y":3.5}, 
+				{"label":"S", "x":2.75, "y":3.5}, 
+				{"label":"D", "x":3.75, "y":3.5}, 
+				{"label":"F", "x":4.75, "y":3.5}, 
+				{"label":"G", "x":5.75, "y":3.5}, 
+				{"label":"H", "x":6.75, "y":3.5}, 
+				{"label":"J", "x":7.75, "y":3.5}, 
+				{"label":"K", "x":8.75, "y":3.5}, 
+				{"label":"L", "x":9.75, "y":3.5}, 
+				{"label":":", "x":10.75, "y":3.5}, 
+				{"label":"\"", "x":11.75, "y":3.5}, 
+				{"label":"Nuhs", "x":12.75, "y":3.5}, 
+				{"label":"Enter", "x":13.75, "y":3.5, "w":1.25}, 
+				{"label":"Shift", "x":0, "y":4.5, "w":1.25}, 
+				{"label":"Nubs", "x":1.25, "y":4.5}, 
+				{"label":"Z", "x":2.25, "y":4.5}, 
+				{"label":"X", "x":3.25, "y":4.5}, 
+				{"label":"C", "x":4.25, "y":4.5}, 
+				{"label":"V", "x":5.25, "y":4.5}, 
+				{"label":"B", "x":6.25, "y":4.5}, 
+				{"label":"N", "x":7.25, "y":4.5}, 
+				{"label":"M", "x":8.25, "y":4.5}, 
+				{"label":"<", "x":9.25, "y":4.5}, 
+				{"label":">", "x":10.25, "y":4.5}, 
+				{"label":"?", "x":11.25, "y":4.5}, 
+				{"label":"Shift", "x":12.25, "y":4.5, "w":1.75}, 
+				{"label":"Del", "x":14, "y":4.5}, 
+				{"label":"\u2191", "x":16.25, "y":4.5}, 
+				{"label":"Ctrl", "x":0, "y":5.5, "w":1.25}, 
+				{"label":"Win", "x":1.25, "y":5.5, "w":1.25}, 
+				{"label":"Alt", "x":2.5, "y":5.5, "w":1.25}, 
+				{"x":3.75, "y":5.5, "w":6.25}, 
+				{"label":"Alt", "x":10, "y":5.5, "w":1.25}, 
+				{"label":"Win", "x":11.25, "y":5.5, "w":1.25}, 
+				{"label":"Menu", "x":12.5, "y":5.5, "w":1.25}, 
+				{"label":"Ctrl", "x":13.75, "y":5.5, "w":1.25}, 
+				{"label":"\u2190", "x":15.25, "y":5.5}, 
+				{"label":"\u2193", "x":16.25, "y":5.5}, 
+				{"label":"\u2192", "x":17.25, "y":5.5}]
+        }
+    }
+}
diff --git a/keyboards/tkc/tkl_ab87/keymaps/default/keymap.c b/keyboards/tkc/tkl_ab87/keymaps/default/keymap.c
@@ -0,0 +1,28 @@
+/* Copyright 2020 Terry Mathews
+ *
+ * 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
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [0] = LAYOUT_all( /* 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_SLCK, 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_DEL, 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_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_DEL,                    KC_UP,
+	KC_LCTL, KC_LGUI, KC_LALT,                           KC_SPC,                                       KC_RALT, KC_RGUI, KC_APP,  KC_RCTL,          KC_LEFT, KC_DOWN, KC_RGHT
+  ),
+};
diff --git a/keyboards/tkc/tkl_ab87/keymaps/via/keymap.c b/keyboards/tkc/tkl_ab87/keymaps/via/keymap.c
@@ -0,0 +1,44 @@
+/* Copyright 2020 Terry Mathews
+ *
+ * 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
+
+//Layers
+
+enum {
+  BASE = 0,
+  FUNCTION,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [BASE] = LAYOUT_all( /* 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_SLCK, 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_DEL, 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_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_DEL,                    KC_UP,
+	KC_LCTL, KC_LGUI, KC_LALT,                           KC_SPC,                                       KC_RALT, KC_RGUI, KC_APP,  KC_RCTL,          KC_LEFT, KC_DOWN, KC_RGHT
+  ),
+  [FUNCTION] = LAYOUT_all( /* Function */
+
+	_______,           _______,   _______,   _______,   _______,        _______,   _______,   _______,   _______,       _______,   _______,  _______,  _______,           _______, _______, _______,
+	_______,  _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______, _______,  _______, _______,           _______,  _______, _______,
+	_______,  _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______, _______,          _______,          _______,  _______,  _______,
+	_______, _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______, _______, _______,          _______,
+	_______, _______, _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______, _______,  _______,          _______, _______,                    _______,
+	_______, _______, _______,                           _______,                                       _______, _______, _______,  _______,          _______, _______, _______
+  ),
+};
diff --git a/keyboards/tkc/tkl_ab87/keymaps/via/rules.mk b/keyboards/tkc/tkl_ab87/keymaps/via/rules.mk
@@ -0,0 +1 @@
+VIA_ENABLE = yes
diff --git a/keyboards/tkc/tkl_ab87/readme.md b/keyboards/tkc/tkl_ab87/readme.md
@@ -0,0 +1,27 @@
+# TKC TKL A/B87
+
+![Photo](https://i.imgur.com/BRHfEbHl.jpg)
+
+A fairly typical TKL
+
+* Keyboard Maintainer: [TerryMathews](https://github.com/TerryMathews)
+* Hardware Supported: TKC TKL A/B87 PCB
+* Hardware Availability: TBA
+
+
+Reset board in one of two ways:
+
+	1) Short reset header to right of up arrow key
+![Photo](https://i.imgur.com/S01CTTGl.jpg)
+
+	2) Hold down Esc key while plugging in USB-C
+
+Make example for this keyboard (after setting up your build environment):
+
+    make tkc/tkl_ab87:default
+
+Flashing example for this keyboard:
+
+    make tkc/tkl_ab87: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).
diff --git a/keyboards/tkc/tkl_ab87/rules.mk b/keyboards/tkc/tkl_ab87/rules.mk
@@ -0,0 +1,22 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = lite     # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = yes       # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+COMMAND_ENABLE = yes        # 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 = yes       # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output