~ruther/qmk_firmware

17c87710002c3993ce86f8dc6a96c940dedc1da8 — minibois 3 years ago 57a1d04
[Keyboard] Add mini_ten_key_plus (#15568)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
A keyboards/mini_ten_key_plus/config.h => keyboards/mini_ten_key_plus/config.h +110 -0
@@ 0,0 1,110 @@
/*
Copyright 2021 minibois

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 minibois
#define PRODUCT      mini_ten_key_plus

/* key matrix size */
#define MATRIX_ROWS 5
#define MATRIX_COLS 5

/*
 * 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 { D4, B1, B5, B4, E6 }
#define MATRIX_COL_PINS { F5, F4, B6, D7, C6 }
#define ENCODERS_PAD_A { F7 }
#define ENCODERS_PAD_B { F6 }
#define UNUSED_PINS

/* COL2ROW, ROW2COL */
#define DIODE_DIRECTION COL2ROW

/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
#define DEBOUNCE 5

/* 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

#define ENCODER_RESOLUTION 2

A keyboards/mini_ten_key_plus/info.json => keyboards/mini_ten_key_plus/info.json +25 -0
@@ 0,0 1,25 @@
{
    "keyboard_name": "mini_ten_key_plus",
    "url": "https://github.com/minibois/ten-key-plus",
    "maintainer": "minibois",
    "layouts": {
        "LAYOUT_all": {
            "layout":[
                {"label":"Esc", "x":0, "y":0}      ,{"label":"Calculator", "x":1, "y":0},{"label":"/", "x":2, "y":0},{"label":"*", "x":3, "y":0},{"label":"-", "x":4, "y":0},
                {"label":"Backspace", "x":0, "y":1},{"label":"7", "x":1, "y":1}         ,{"label":"8", "x":2, "y":1},{"label":"9", "x":3, "y":1},{"label":"+", "x":4, "y":1},
                {"label":"(", "x":0, "y":2}        ,{"label":"4", "x":1, "y":2}         ,{"label":"5", "x":2, "y":2},{"label":"6", "x":3, "y":2},{"label":"+", "x":4, "y":2},
                {"label":")", "x":0, "y":3}        ,{"label":"1", "x":1, "y":3}         ,{"label":"2", "x":2, "y":3},{"label":"3", "x":3, "y":3},{"label":"Enter", "x":4, "y":3},
                {"label":"y", "x":0, "y":4}        ,{"label":"00", "x":1, "y":4}        ,{"label":"0", "x":2, "y":4},{"label":".", "x":3, "y":4},{"label":"Enter", "x":4, "y":4},
            ]
        },
        "LAYOUT_standard_numpad": {
            "layout":[
                {"label":"Esc", "x":0, "y":0}      ,{"label":"Calculator", "x":1, "y":0},{"label":"/", "x":2, "y":0},{"label":"*", "x":3, "y":0},{"label":"-", "x":4, "y":0},
                {"label":"Backspace", "x":0, "y":1},{"label":"7", "x":1, "y":1}         ,{"label":"8", "x":2, "y":1},{"label":"9", "x":3, "y":1},
                {"label":"(", "x":0, "y":2}        ,{"label":"4", "x":1, "y":2}         ,{"label":"5", "x":2, "y":2},{"label":"6", "x":3, "y":2},{"label":"+", "x":4, "y":2, "h":2},
                {"label":")", "x":0, "y":3}        ,{"label":"1", "x":1, "y":3}         ,{"label":"2", "x":2, "y":3},{"label":"3", "x":3, "y":3},
                {"label":"y", "x":0, "y":4}        ,{"label":"0", "x":1, "y":4 ,"w":2}  ,{"label":".", "x":3, "y":4},{"label":"Enter", "x":4, "y":3, "h":2},
            ]
        }
    }
}

A keyboards/mini_ten_key_plus/keymaps/default/keymap.c => keyboards/mini_ten_key_plus/keymaps/default/keymap.c +32 -0
@@ 0,0 1,32 @@
// Copyright 2021 minibois (@minibois)
// SPDX-License-Identifier: GPL-2.0-or-later

#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] = {
    /* Keymap _BASE: (Base Layer) Default Layer
     * ,-------------------.
     * |Esc|Cal| / | * | - |
     * |--------------------
     * | BS| 7 | 8 | 9 | + |
     * |--------------------
     * | ( | 4 | 5 | 6 | + |
     * |--------------------
     * | ) | 1 | 2 | 3 |Ent|
     * |--------------------
     * | Y | 00| 0 | . |Ent|
     * `-------------------'
     */
    [_BASE] = LAYOUT_all(
        KC_ESC,  KC_CALC, KC_PSLS, KC_PAST, KC_PMNS,
        KC_BSPC,  KC_P7, KC_P8, KC_P9, KC_PPLS,
        KC_LEFT_PAREN,  KC_P4, KC_P5, KC_P6, KC_PPLS,
        KC_RIGHT_PAREN,  KC_P1, KC_P2, KC_P3, KC_PENT,
        KC_Y,  KC_P0, KC_P0, KC_PDOT, KC_PENT
    )
};

A keyboards/mini_ten_key_plus/keymaps/default/readme.md => keyboards/mini_ten_key_plus/keymaps/default/readme.md +2 -0
@@ 0,0 1,2 @@
# The default 1u keymap for mini_ten_key_plus
![mini_ten_key_plus](https://imgur.com/VuSTwfC.png)
\ No newline at end of file

A keyboards/mini_ten_key_plus/keymaps/standard_numpad/keymap.c => keyboards/mini_ten_key_plus/keymaps/standard_numpad/keymap.c +32 -0
@@ 0,0 1,32 @@
// Copyright 2021 minibois (@minibois)
// SPDX-License-Identifier: GPL-2.0-or-later

#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] = {
    /* Keymap _BASE: (Base Layer) Default Layer
     * ,-------------------.
     * |Esc|Cal| / | * | - |
     * |--------------------
     * | BS| 7 | 8 | 9 | + |
     * |----------------   |
     * | ( | 4 | 5 | 6 |   |
     * |--------------------
     * | ) | 1 | 2 | 3 |Ent|
     * |----------------   |
     * | Y | 0     | . |   |
     * `-------------------'
     */
    [_BASE] = LAYOUT_standard_numpad(
        KC_ESC,  KC_CALC, KC_PSLS, KC_PAST, KC_PMNS,
        KC_BSPC,  KC_P7, KC_P8, KC_P9,
        KC_LEFT_PAREN,  KC_P4, KC_P5, KC_P6, KC_PPLS,
        KC_RIGHT_PAREN,  KC_P1, KC_P2, KC_P3,
        KC_Y,  KC_P0, KC_PDOT, KC_PENT
    )
};

A keyboards/mini_ten_key_plus/keymaps/standard_numpad/readme.md => keyboards/mini_ten_key_plus/keymaps/standard_numpad/readme.md +2 -0
@@ 0,0 1,2 @@
# The standard numpad keymap for mini_ten_key_plus
![mini_ten_key_plus](https://imgur.com/x2BUc9J.png)
\ No newline at end of file

A keyboards/mini_ten_key_plus/mini_ten_key_plus.c => keyboards/mini_ten_key_plus/mini_ten_key_plus.c +15 -0
@@ 0,0 1,15 @@
// Copyright 2021 minibois (@minibois)
// SPDX-License-Identifier: GPL-2.0-or-later

#include "mini_ten_key_plus.h"

/* Rotary Encoder's function (currently volume up/down) */
bool encoder_update_kb(uint8_t index, bool clockwise) {
    if (!encoder_update_user(index, clockwise)) { return false; }
        if (clockwise) {
            tap_code16(KC_RIGHT_PAREN);
        } else {
            tap_code16(KC_LEFT_PAREN);
        }
    return true;
}
\ No newline at end of file

A keyboards/mini_ten_key_plus/mini_ten_key_plus.h => keyboards/mini_ten_key_plus/mini_ten_key_plus.h +78 -0
@@ 0,0 1,78 @@
/* Copyright 2021 minibois
 *
 * 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"

// readability
#define ___ KC_NO

/* Default
 * ,-------------------.
 * |00 |01 |02 |03 |04 |
 * |-------------------|
 * |10 |11 |12 |13 |14 |
 * |-------------------|
 * |20 |21 |22 |23 |24 |
 * |-------------------|
 * |30 |31 |32 |33 |34 |
 * |-------------------|
 * |40 |41 |42 |43 |44 |
 * `-------------------'
*/
#define LAYOUT_all( \
        k00, k01, k02, k03, k04 , \
        k10, k11, k12, k13, k14 , \
        k20, k21, k22, k23, k24 , \
        k30, k31, k32, k33, k34 , \
        k40, k41, k42, k43, k44   \
) \
{ \
    {   k00, k01, k02, k03, k04,   },  \
    {   k10, k11, k12, k13, k14,   },  \
    {   k20, k21, k22, k23, k24,   },  \
    {   k30, k31, k32, k33, k34,   },  \
    {   k40, k41, k42, k43, k44,   }   \
}

/* Standard Numpad
 * ,-------------------.
 * |00 |01 |02 |03 |04 |
 * |-------------------|
 * |10 |11 |12 |13 |   |
 * |---------------|14 |
 * |20 |21 |22 |23 |   |
 * |-------------------|
 * |30 |31 |32 |33 |   |
 * |---------------|34 |
 * |40 |  41   |43 |   |
 * `-------------------'
*/
#define LAYOUT_standard_numpad( \
        k00, k01, k02, k03, k04 , \
        k10, k11, k12, k13,       \
        k20, k21, k22, k23, k24 , \
        k30, k31, k32, k33,       \
        k40,      k42, k43, k44   \
) \
{ \
    {   k00, k01, k02, k03, k04,   },  \
    {   k10, k11, k12, k13, ___,   },  \
    {   k20, k21, k22, k23, k24,   },  \
    {   k30, k31, k32, k33, ___,   },  \
    {   k40, ___, k42, k43, k44,   }   \
}

A keyboards/mini_ten_key_plus/readme.md => keyboards/mini_ten_key_plus/readme.md +24 -0
@@ 0,0 1,24 @@
# mini_ten_key_plus

![mini_ten_key_plus](https://imgur.com/QtFFONgl.jpg)

A 5x5 numpad/macropad, with support for a rotary encoder running on a Pro Micro.

* Keyboard Maintainer: [minibois](https://github.com/minibois)
* Hardware Supported: mini_ten_key_plus PCB, Pro Micro (or equivalent), 3D printed case, 22 - 25 MX (like) switches, PCB mount stabilizers
* Hardware Availability: https://github.com/minibois/ten-key-plus

Make example for this keyboard (after setting up your build environment):

    make mini_ten_key_plus:default

Flashing example for this keyboard:

    make mini_ten_key_plus: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).

## Bootloader

Enter the bootloader:
* **Physical reset button**: Briefly press the button on the back of the PCB

A keyboards/mini_ten_key_plus/rules.mk => keyboards/mini_ten_key_plus/rules.mk +19 -0
@@ 0,0 1,19 @@
# MCU name
MCU = atmega32u4

# Bootloader selection
BOOTLOADER = atmel-dfu

# Build Options
#   change yes to no to disable
#
BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
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
NKRO_ENABLE = no            # Enable N-Key Rollover
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
AUDIO_ENABLE = no           # Audio output
ENCODER_ENABLE = yes