~ruther/qmk_firmware

62112117ff0edb25f2ac06770c6d4ae84256ca5c — Duccio 3 years ago 3cbeb11
[Keyboard] Add Eternal keypad (#15413)

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

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 duckyb
#define PRODUCT      eternal_keypad

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

/*
 * 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 { B5, B4, E6, D7, C6 }
#define MATRIX_COL_PINS { B6, B2, B3, B1, F7, F6, F5, 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 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 1

A keyboards/eternal_keypad/eternal_keypad.c => keyboards/eternal_keypad/eternal_keypad.c +17 -0
@@ 0,0 1,17 @@
/* Copyright 2021 duckyb
 *
 * 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 "eternal_keypad.h"

A keyboards/eternal_keypad/eternal_keypad.h => keyboards/eternal_keypad/eternal_keypad.h +41 -0
@@ 0,0 1,41 @@
/* Copyright 2021 duckyb
 *
 * 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( \
	     k01, k02, k03, k04, k05, k06, k07, \
	     k11, k12, k13, k14, k15, k16, k17, \
	k20, k21, k22, k23, k24, k25, k26, k27, \
	k30, k31, k32, k33, k34, k35, k36, k37, \
	k40, k41, k42, k43,      k45,      k47  \
) { \
	{ KC_NO, k01,   k02,   k03,   k04,   k05,   k06,   k07 }, \
	{ KC_NO, k11,   k12,   k13,   k14,   k15,   k16,   k17 }, \
	{ k20,   k21,   k22,   k23,   k24,   k25,   k26,   k27 }, \
	{ k30,   k31,   k32,   k33,   k34,   k35,   k36,   k37 }, \
	{ k40,   k41,   k42,   k43,   KC_NO, k45,   KC_NO, k47 }  \
}

A keyboards/eternal_keypad/info.json => keyboards/eternal_keypad/info.json +47 -0
@@ 0,0 1,47 @@
{
    "keyboard_name": "eternal_keypad",
    "url": "https://github.com/duckyb/eternal-keypad",
    "maintainer": "duckyb",
    "layouts": {
        "LAYOUT": {
            "layout": [
                {"label": "k01", "x": 1.5, "y": 0, "w": 1.25},
                {"label": "k02", "x": 2.75, "y": 0},
                {"label": "k03", "x": 3.75, "y": 0},
                {"label": "k04", "x": 4.75, "y": 0},
                {"label": "k05", "x": 5.75, "y": 0},
                {"label": "k06", "x": 6.75, "y": 0},
                {"label": "k07", "x": 7.75, "y": 0},
                {"label": "k11", "x": 1.5, "y": 1, "w": 1.25},
                {"label": "k12", "x": 2.75, "y": 1},
                {"label": "k13", "x": 3.75, "y": 1},
                {"label": "k14", "x": 4.75, "y": 1},
                {"label": "k15", "x": 5.75, "y": 1},
                {"label": "k16", "x": 6.75, "y": 1},
                {"label": "k17", "x": 7.75, "y": 1},
                {"label": "k20", "x": 0, "y": 2},
                {"label": "k21", "x": 1.5, "y": 2, "w": 1.25},
                {"label": "k22", "x": 2.75, "y": 2},
                {"label": "k23", "x": 3.75, "y": 2},
                {"label": "k24", "x": 4.75, "y": 2},
                {"label": "k25", "x": 5.75, "y": 2},
                {"label": "k26", "x": 6.75, "y": 2},
                {"label": "k27", "x": 7.75, "y": 2},
                {"label": "k30", "x": 0, "y": 3},
                {"label": "k31", "x": 1.5, "y": 3, "w": 1.25},
                {"label": "k32", "x": 2.75, "y": 3},
                {"label": "k33", "x": 3.75, "y": 3},
                {"label": "k34", "x": 4.75, "y": 3},
                {"label": "k35", "x": 5.75, "y": 3},
                {"label": "k36", "x": 6.75, "y": 3},
                {"label": "k37", "x": 7.75, "y": 3},
                {"label": "k40", "x": 0, "y": 4},
                {"label": "k41", "x": 1.5, "y": 4, "w": 1.25},
                {"label": "k42", "x": 2.75, "y": 4, "w": 1.25},
                {"label": "k43", "x": 4, "y": 4},
                {"label": "k45", "x": 5, "y": 4, "w": 2.75},
                {"label": "k47", "x": 7.75, "y": 4}
            ]
        }
    }
}

A keyboards/eternal_keypad/keymaps/default/config.h => keyboards/eternal_keypad/keymaps/default/config.h +19 -0
@@ 0,0 1,19 @@
/* Copyright 2021 duckyb
 *
 * 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

#define ONESHOT_TIMEOUT 2000
#define FORCE_NKRO

A keyboards/eternal_keypad/keymaps/default/keymap.c => keyboards/eternal_keypad/keymaps/default/keymap.c +86 -0
@@ 0,0 1,86 @@
/* Copyright 2021 duckyb
 *
 * 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,
    _ARROW,
    _FN
};

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  /* Base Layer
   * ,-------------------------------------.
   * |     |  Esc  |  1|  2|  3|  4|  5|  6|
	 * |		 |-------+---+---+---+---+---+---|
   * |     |  Tab  |  Q|  W|  E|  R|  T|  7|
	 * |----||-------+---+---+---+---+---+---|
   * | F13|| Enter |  A|  S|  D|  F|  G|  8|
	 * |----||-------+---+---+---+---+---+---|
   * | F14|| Shift |  Z|  X|  C|  V|  B|  9|
   * |----||-------------------------------|
   * | F15|| LCtrl | _FN |Alt|  Space  |  0|
   * `----'`-------------------------------'
   */
    [_BASE] = LAYOUT(
		        KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, 
		        KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_7, 
		KC_F13, KC_ENT, KC_A, KC_S, KC_D, KC_F, KC_G, KC_8, 
		KC_F14, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_9, 
		KC_F15, KC_LCTL, OSL(_FN), KC_LALT, KC_SPC, LT(_ARROW, KC_0)
    ),
  /* Arrows Layer
   * ,-----------------------------------------.
   * |     |       |    |    |     |   |   |   |
	 * |		 |-------+----+----+-----+---+---+---|
   * |     |       |    |  UP|     |   |   |   |
	 * |----||-------+----+----+-----+---+---+---|
   * |    ||       |LEFT|DOWN|RIGHT|   |   |   |
	 * |----||-------+----+----+-----+---+---+---|
   * |    ||       |    |    |     |   |   |   |
   * |----||-----------------------------------|
   * | RST||       |       |     |         |   |
   * `----'`-----------------------------------'
   */
    [_ARROW] = LAYOUT(
		         _______, _______, _______, _______, _______, _______, _______,
		         _______, _______, KC_UP, _______, _______, _______, _______, 
		_______, _______, KC_LEFT, KC_DOWN, KC_RIGHT, _______, _______, _______, 
		_______, _______, _______, _______, _______, _______, _______, _______, 
		RESET,   _______, _______, _______, _______, _______
    ),
  /* Function Layer
   * ,-------------------------------------.
   * |     |       | F1| F2| F3| F4| F5| F6|
	 * |		 |-------+---+---+---+---+---+---|
   * |     |       |  P|  O|  I|  U|  Y| F7|
	 * |----||-------+---+---+---+---+---+---|
   * |    ||  Bspc |  ;|  L|  K|  J|  H| F8|
	 * |----||-------+---+---+---+---+---+---|
   * |    ||       |Gui|  M|  N|F12|F11| F9|
   * |----||-------------------------------|
   * |    ||       |     |   |         |F10|
   * `----'`-------------------------------'
   */
    [_FN] = LAYOUT(
		         _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6,
		         _______, KC_P, KC_O, KC_I, KC_U, KC_Y, KC_F7, 
		_______, KC_BSPC, KC_SCLN, KC_L, KC_K, KC_J, KC_H, KC_F8, 
		_______, _______, KC_LGUI, KC_M, KC_N, KC_F12, KC_F11, KC_F9, 
		_______, _______, _______, _______, _______, KC_F10
    )
};

A keyboards/eternal_keypad/keymaps/default/readme.md => keyboards/eternal_keypad/keymaps/default/readme.md +1 -0
@@ 0,0 1,1 @@
# The default keymap for eternal_keypad

A keyboards/eternal_keypad/keymaps/lefty/config.h => keyboards/eternal_keypad/keymaps/lefty/config.h +19 -0
@@ 0,0 1,19 @@
/* Copyright 2021 duckyb
 *
 * 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

#define ONESHOT_TIMEOUT 2000
#define FORCE_NKRO

A keyboards/eternal_keypad/keymaps/lefty/keymap.c => keyboards/eternal_keypad/keymaps/lefty/keymap.c +86 -0
@@ 0,0 1,86 @@
/* Copyright 2021 duckyb
 *
 * 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,
		_ARROW,
    _FN
};

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  /* Base Layer
   * ,-------------------------------------.
   * |     |  Esc  |  1|  2|  3|  4|  5|  6|
	 * |		 |-------+---+---+---+---+---+---|
   * |     |  Tab  |  Q|  W|  E|  R|  T|  7|
	 * |----||-------+---+---+---+---+---+---|
   * | F13|| Enter |  D|  S|  A|  F|  G|  8|
	 * |----||-------+---+---+---+---+---+---|
   * | F14|| Shift |  Z|  X|  C|  V|  B|  9|
   * |----||-------------------------------|
   * | F15|| LCtrl | _FN |Alt|  Space  |  0|
   * `----'`-------------------------------'
   */
    [_BASE] = LAYOUT(
		        KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, 
		        KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_7, 
		KC_F13, KC_ENT, KC_D, KC_S, KC_A, KC_F, KC_G, KC_8, 
		KC_F14, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_9, 
		KC_F15, KC_LCTL, OSL(_FN), KC_LALT, KC_SPC, LT(_ARROW, KC_0)
    ),
  /* Arrows Layer
   * ,-----------------------------------------.
   * |     |       |    |    |     |   |   |   |
	 * |		 |-------+----+----+-----+---+---+---|
   * |     |       |    |  UP|     |   |   |   |
	 * |----||-------+----+----+-----+---+---+---|
   * |    ||       |RIGHT|DOWN|LEFT|   |   |   |
	 * |----||-------+----+----+-----+---+---+---|
   * |    ||       |    |    |     |   |   |   |
   * |----||-----------------------------------|
   * | RST||       |       |     |         |   |
   * `----'`-----------------------------------'
   */
    [_ARROW] = LAYOUT(
		         _______, _______, _______, _______, _______, _______, _______,
		         _______, _______, KC_UP, _______, _______, _______, _______, 
		_______, _______, KC_RIGHT,KC_DOWN, KC_LEFT, _______, _______, _______, 
		_______, _______, _______, _______, _______, _______, _______, _______, 
		RESET,   _______, _______, _______, _______, _______
    ),
  /* Function Layer
   * ,-------------------------------------.
   * |     |       | F1| F2| F3| F4| F5| F6|
	 * |		 |-------+---+---+---+---+---+---|
   * |     |       |  P|  O|  I|  U|  Y| F7|
	 * |----||-------+---+---+---+---+---+---|
   * |    ||  Bspc |  ;|  L|  K|  J|  H| F8|
	 * |----||-------+---+---+---+---+---+---|
   * |    ||       |Gui|  M|  N|F12|F11| F9|
   * |----||-------------------------------|
   * |    ||       |     |   |         |F10|
   * `----'`-------------------------------'
   */
    [_FN] = LAYOUT(
		         _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6,
		         _______, KC_P, KC_O, KC_I, KC_U, KC_Y, KC_F7, 
		_______, KC_BSPC, KC_SCLN, KC_L, KC_K, KC_J, KC_H, KC_F8, 
		_______, _______, KC_LGUI, KC_M, KC_N, KC_F12, KC_F11, KC_F9, 
		_______, _______, _______, _______, _______, KC_F10
    )
};

A keyboards/eternal_keypad/readme.md => keyboards/eternal_keypad/readme.md +27 -0
@@ 0,0 1,27 @@
# eternal_keypad

![eternal_keypad](https://i.imgur.com/BAzc343.png)

A 36 key gaming keypad that can be assembled and configured for both left and right handed mouse users.

* Keyboard Maintainer: [duckyb](https://github.com/duckyb)
* Hardware Supported: ETERNAL Keypad
* Hardware Availability: Open Source, files available on [gitHub](https://github.com/duckyb/eternal-keypad)

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

    make eternal_keypad:default

Flashing example for this keyboard:

    make eternal_keypad: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 in 3 ways:

* **Bootmagic reset**: Hold down the key at (0,1) in the matrix (the top left key or Escape) and plug in the keyboard
* **Keycode in layout**: Press the key mapped to `RESET` if it is available (activated by holding the lower right key and tapping the lower left key)
* **Physical reset button**: Briefly sort the pads labeled "RST" and "GND" on the micro-controller

A keyboards/eternal_keypad/rules.mk => keyboards/eternal_keypad/rules.mk +18 -0
@@ 0,0 1,18 @@
# 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 = 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
NKRO_ENABLE = yes           # USB Nkey Rollover
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
AUDIO_ENABLE = no           # Audio output