Adding new keyboard: Tenkey++ (tenkey_plusplus) (#11197)

Co-authored-by: Ryan <fauxpark@gmail.com>

8 files changed, 489 insertions, 0 deletions

diff --git a/keyboards/lizard_trick/tenkey_plusplus/config.h b/keyboards/lizard_trick/tenkey_plusplus/config.h
new file mode 100644
index 0000000000..d962e67dae
--- /dev/null
+++ b/keyboards/lizard_trick/tenkey_plusplus/config.h
@@ -0,0 +1,159 @@
+/*
+Copyright 2020 Jonathon Carstens jonathon@lizardtrick.com
+
+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 0xFEED
+#define PRODUCT_ID 0x0000
+#define DEVICE_VER 0x0001
+#define MANUFACTURER Lizard Trick Electronics
+#define PRODUCT Tenkey++
+
+/* key matrix size */
+#define MATRIX_ROWS 6
+#define MATRIX_COLS 4
+
+/*
+ * 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 { B7, D4, B5, B6, C6, C7, }
+#define MATRIX_COL_PINS { D5, D3, D2, F7 }
+#define UNUSED_PINS
+
+#define ENCODERS_PAD_A \
+    { B4, F0, F4 }
+#define ENCODERS_PAD_B \
+    { D7, E6, F1 }
+
+/* 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 LED_NUM_LOCK_PIN B0
+//#define LED_CAPS_LOCK_PIN B1
+//#define LED_SCROLL_LOCK_PIN B2
+//#define LED_COMPOSE_PIN B3
+//#define LED_KANA_PIN B4
+
+//#define BACKLIGHT_PIN B7
+//#define BACKLIGHT_LEVELS 3
+//#define BACKLIGHT_BREATHING
+
+//#define RGB_DI_PIN E2
+//#ifdef RGB_DI_PIN
+//#    define RGBLED_NUM 16
+//#    define RGBLIGHT_HUE_STEP 8
+//#    define RGBLIGHT_SAT_STEP 8
+//#    define RGBLIGHT_VAL_STEP 8
+//#    define RGBLIGHT_LIMIT_VAL 255 /* 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
+
+/* 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
+
+/* 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 useful 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
+
+/* disable these deprecated features by default */
+#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/lizard_trick/tenkey_plusplus/info.json b/keyboards/lizard_trick/tenkey_plusplus/info.json
new file mode 100644
index 0000000000..b81f83763c
--- /dev/null
+++ b/keyboards/lizard_trick/tenkey_plusplus/info.json
@@ -0,0 +1,38 @@
+{
+    "keyboard_name": "tenkey_plusplus",
+    "url": "https://github.com/jonbobcar/tenkey_plusplus",
+    "maintainer": "Jonathon Carstens",
+    "width": 4,
+    "height": 5,
+    "layouts": {
+        "default": {
+            "LAYOUT": [
+                {"label": "Mute", "x": 0, "y": 0, "w": 1.3},
+                {"label": "MDPL", "x": 1.3, "y": 0, "w": 1.4},
+                {"label": "MDNX", "x": 2.7, "y": 0, "w": 1.3},
+
+                {"label": "Num Lock", "x": 0, "y": 1},
+                {"label": "/", "x": 1, "y": 1},
+                {"label": "*", "x": 2, "y": 1},
+                {"label": "-", "x": 3, "y": 1},
+
+                {"label": "7", "x": 0, "y": 2},
+                {"label": "8", "x": 1, "y": 2},
+                {"label": "9", "x": 2, "y": 2},
+                {"label": "+", "x": 3, "y": 2, "h": 2},
+
+                {"label": "4", "x": 0, "y": 3},
+                {"label": "5", "x": 1, "y": 3},
+                {"label": "6", "x": 2, "y": 3},
+
+                {"label": "1", "x": 0, "y": 4},
+                {"label": "2", "x": 1, "y": 4},
+                {"label": "3", "x": 2, "y": 4},
+                {"label": "Enter", "x": 3, "y": 4, "h" :2},
+
+                {"label": "0", "x": 0, "y": 5, "w": 2},
+                {"label": ".", "x": 2, "y": 5}
+            ]
+        }
+    }
+}
diff --git a/keyboards/lizard_trick/tenkey_plusplus/keymaps/default/keymap.c b/keyboards/lizard_trick/tenkey_plusplus/keymaps/default/keymap.c
new file mode 100644
index 0000000000..f785ed97f1
--- /dev/null
+++ b/keyboards/lizard_trick/tenkey_plusplus/keymaps/default/keymap.c
@@ -0,0 +1,78 @@
+/*
+Copyright 2020 Jonathon Carstens jonathon@lizardtrick.com
+
+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,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /*
+     *
+     *  Left    Middle  Right
+     *  VolDn   PgDn    Alt+Tab    (Rotary Counterclockwise)
+     *  VolUp   PgUp    Tab        (Rotary Clockwise)
+     *  Mute    Play    Next       (Rotary Click)
+     *
+     *
+     *
+     *   ┌───┬───┬───┬───┐
+     *   │TG1│ / │ * │ - │
+     *   ├───┼───┼───┼───┤
+     *   │ 7 │ 8 │ 9 │   │
+     *   ├───┼───┼───┤ + │
+     *   │ 4 │ 5 │ 6 │   │
+     *   ├───┼───┼───┼───┤
+     *   │ 1 │ 2 │ 3 │   │
+     *   ├───┴───┼───┤Ent│
+     *   │   0   │ . │   │
+     *   └───────┴───┴───┘
+     */
+
+    [_BASE] = LAYOUT(
+        KC_MUTE,    KC_MPLY,    KC_MNXT,
+        KC_NLCK,    KC_PSLS,    KC_PAST,    KC_PMNS,
+        KC_P7,      KC_P8,      KC_P9,      KC_PPLS,
+        KC_P4,      KC_P5,      KC_P6,
+        KC_P1,      KC_P2,      KC_P3,      KC_PENT,
+        KC_P0,                  KC_PDOT
+    )
+};
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+    if (index == 0) {           /* Left Encoder */
+        if (clockwise) {
+            tap_code16(KC_VOLU);
+        } else {
+            tap_code16(KC_VOLD);
+        }
+    } else if (index == 1) {    /* Middle Encoder */
+        if (clockwise) {
+            tap_code16(KC_PGDN);
+        } else {
+            tap_code16(KC_PGUP);
+        }
+    } else if (index == 2) {    /* Right Encoder */
+        if (clockwise) {
+            tap_code16(KC_TAB);
+        } else {
+            tap_code16(S(KC_TAB));
+        }
+    }
+}
diff --git a/keyboards/lizard_trick/tenkey_plusplus/keymaps/macro/keymap.c b/keyboards/lizard_trick/tenkey_plusplus/keymaps/macro/keymap.c
new file mode 100644
index 0000000000..900bb0a01c
--- /dev/null
+++ b/keyboards/lizard_trick/tenkey_plusplus/keymaps/macro/keymap.c
@@ -0,0 +1,103 @@
+/*
+Copyright 2020 Jonathon Carstens jonathon@lizardtrick.com
+
+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,
+    _TG1,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /*
+     *
+     *  Left    Middle  Right
+     *  VolDn   PgDn    Alt+Tab    (Rotary Counterclockwise)
+     *  VolUp   PgUp    Tab        (Rotary Clockwise)
+     *  Mute    Play    Next       (Rotary Click)
+     *
+     *
+     *
+     *   ┌───┬───┬───┬───┐
+     *   │TG1│ / │ * │ - │
+     *   ├───┼───┼───┼───┤
+     *   │ 7 │ 8 │ 9 │   │
+     *   ├───┼───┼───┤ + │
+     *   │ 4 │ 5 │ 6 │   │
+     *   ├───┼───┼───┼───┤
+     *   │ 1 │ 2 │ 3 │   │
+     *   ├───┴───┼───┤Ent│
+     *   │   0   │ . │   │
+     *   └───────┴───┴───┘
+     */
+
+    [_BASE] = LAYOUT(
+        KC_MUTE,  KC_MPLY,  KC_MNXT,
+        TG(1),    KC_SLSH,  KC_ASTR,  KC_MINS,
+        KC_7,     KC_8,     KC_9,     KC_PLUS,
+        KC_4,     KC_5,     KC_6,
+        KC_1,     KC_2,     KC_3,     KC_ENT,
+        KC_0,               KC_DOT
+    ),
+
+    /*
+     *
+     * ┌─────────┬─────────┬─────────┬─────────┐
+     * │   TG1   │    /    │    *    │    -    │
+     * ├─────────┼─────────┼─────────┼─────────┤
+     * │  Alt 7  │  Alt 8  │  Alt 9  │         │
+     * ├─────────┼─────────┼─────────┤    +    │
+     * │  Alt 4  │  Alt 5  │  Alt 6  │         │
+     * ├─────────┼─────────┼─────────┼─────────┤
+     * │  Alt 1  │  Alt 2  │  Alt 3  │         │
+     * ├─────────┴─────────┼─────────┤   Ent   │
+     * │      Escape       │   Del   │         │
+     * └───────────────────┴─────────┴─────────┘
+     */
+
+    [_TG1] = LAYOUT(
+        _______,        _______,        _______,
+        _______,     _______,   _______,   _______,
+        A(KC_7),     A(KC_8),   A(KC_9),   _______,
+        A(KC_4),     A(KC_5),   A(KC_6),
+        A(KC_1),     A(KC_2),   A(KC_3),   _______,
+        KC_ESC,                 KC_DEL
+    )
+};
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+    if (index == 0) {           /* Left Encoder */
+        if (clockwise) {
+            tap_code16(KC_VOLU);
+        } else {
+            tap_code16(KC_VOLD);
+        }
+    } else if (index == 1) {    /* Middle Encoder */
+        if (clockwise) {
+            tap_code16(KC_PGDN);
+        } else {
+            tap_code16(KC_PGUP);
+        }
+    } else if (index == 2) {    /* Right Encoder */
+        if (clockwise) {
+            tap_code16(KC_TAB);
+        } else {
+            tap_code16(S(KC_TAB));
+        }
+    }
+}
diff --git a/keyboards/lizard_trick/tenkey_plusplus/readme.md b/keyboards/lizard_trick/tenkey_plusplus/readme.md
new file mode 100644
index 0000000000..9687719ddd
--- /dev/null
+++ b/keyboards/lizard_trick/tenkey_plusplus/readme.md
@@ -0,0 +1,25 @@
+# Tenkey++
+
+![TK++](https://i.imgur.com/DOJUgltl.jpg)
+
+Tenkey++ is a USB-C hotswap numpad with the layout of a standard 10-key. Tenkey++ also has three rotary encoders at the top for additional functionality.
+
+* Keyboard Maintainer: [Jonathon Carstens](https://github.com/jonbobcar) :: [jonathon@lizardtrick.com](mailto:jonathon@lizardtrick.com)
+* Hardware Source Files: [Tenkey++ GitHub Repository](https://github.com/jonbobcar/tenkey_plusplus)
+* Hardware Availability: [Tenkey++ on Tindie](https://www.tindie.com/products/lizardtrick/tenkey/)
+
+Make example for default layout (set up QMK build environment first):
+
+    make lizard_trick/tenkey_plusplus:default
+    
+Flashing example for this keyboard:
+    
+    make lizard_trick/tenkey_plusplus:default:flash
+    
+Default Layout:
+
+![TK++_Default](https://i.imgur.com/6L0eQJq.jpg)
+    
+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 the [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+
+![PCB](https://i.imgur.com/aMii80bl.jpg)
diff --git a/keyboards/lizard_trick/tenkey_plusplus/rules.mk b/keyboards/lizard_trick/tenkey_plusplus/rules.mk
new file mode 100644
index 0000000000..fb12719ce8
--- /dev/null
+++ b/keyboards/lizard_trick/tenkey_plusplus/rules.mk
@@ -0,0 +1,23 @@
+# 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 = 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 = no            # USB Nkey Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output
+ENCODER_ENABLE = yes
diff --git a/keyboards/lizard_trick/tenkey_plusplus/tenkey_plusplus.c b/keyboards/lizard_trick/tenkey_plusplus/tenkey_plusplus.c
new file mode 100644
index 0000000000..96c0b92dff
--- /dev/null
+++ b/keyboards/lizard_trick/tenkey_plusplus/tenkey_plusplus.c
@@ -0,0 +1,18 @@
+/*
+Copyright 2020 Jonathon Carstens jonathon@lizardtrick.com
+
+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 "tenkey_plusplus.h"
diff --git a/keyboards/lizard_trick/tenkey_plusplus/tenkey_plusplus.h b/keyboards/lizard_trick/tenkey_plusplus/tenkey_plusplus.h
new file mode 100644
index 0000000000..72f3880652
--- /dev/null
+++ b/keyboards/lizard_trick/tenkey_plusplus/tenkey_plusplus.h
@@ -0,0 +1,45 @@
+/*
+Copyright 2020 Jonathon Carstens jonathon@lizardtrick.com
+
+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 "quantum.h"
+
+/* This is a shortcut to help you visually see your layout.
+ *
+ * The first section contains all of the arguments representing the physical
+ * layout of the board and position of the keys.
+ *
+ * The second converts the arguments into a two-dimensional array which
+ * represents the switch matrix.
+ */
+
+#define LAYOUT( \
+    K00, K01,      K03, \
+    K10, K11, K12, K13, \
+    K20, K21, K22, K23, \
+    K30, K31, K32,      \
+    K40, K41, K42, K43, \
+         K51, K52       \
+) { \
+    { K00,   K01,   KC_NO, K03    }, \
+    { K10,   K11,   K12,   K13    }, \
+    { K20,   K21,   K22,   K23    }, \
+    { K30,   K31,   K32,   KC_NO  }, \
+    { K40,   K41,   K42,   K43    }, \
+    { KC_NO, K51,   K52,   KC_NO  }  \
+}