~ruther/qmk_firmware

f00e56eb0b4e8ab220d52a30f89f3a9213d431fa — Logan Butler 4 years ago 8392729
[Keyboard] Add Southpad Keyboard (#13964)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
A keyboards/matchstickworks/southpad/config.h => keyboards/matchstickworks/southpad/config.h +100 -0
@@ 0,0 1,100 @@
/*
Copyright 2021 Logan Butler

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      0x6060
#define DEVICE_VER      0x0001
#define MANUFACTURER    MatchstickWorks
#define PRODUCT         SouthPad

/* 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 { B3, B5, B6, B7, C7, C6 }
#define MATRIX_COL_PINS { B0, B1, B2, B4 }
#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

/* define if matrix has ghost (lacks anti-ghosting diodes) */
//#define MATRIX_HAS_GHOST


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

A keyboards/matchstickworks/southpad/info.json => keyboards/matchstickworks/southpad/info.json +34 -0
@@ 0,0 1,34 @@
{
    "keyboard_name": "SouthPad",
    "url": "",
    "maintainer": "MatchstickWorks",
    "width": 4,
    "height": 6,
    "layouts": {
        "LAYOUT": {
            "layout": [
                {"label":"K00 (B3,B0)", "x":0, "y":0},
                {"label":"K01 (B3,B1)", "x":1, "y":0},
                {"label":"K02 (B3,B2)", "x":2, "y":0},
                {"label":"K03 (B3,B4)", "x":3, "y":0},
                {"label":"K10 (B5,B0)", "x":0, "y":1},
                {"label":"K11 (B5,B1)", "x":1, "y":1},
                {"label":"K12 (B5,B2)", "x":2, "y":1},
                {"label":"K13 (B5,B4)", "x":3, "y":1},
                {"label":"K30 (B7,B0)", "x":0, "y":2, "h":2},
                {"label":"K21 (B6,B1)", "x":1, "y":2},
                {"label":"K22 (B6,B2)", "x":2, "y":2},
                {"label":"K23 (B6,B4)", "x":3, "y":2},
                {"label":"K31 (B7,B1)", "x":1, "y":3},
                {"label":"K32 (B7,B2)", "x":2, "y":3},
                {"label":"K33 (B7,B4)", "x":3, "y":3},
                {"label":"K50 (C6,B0)", "x":0, "y":4, "h":2},
                {"label":"K41 (C7,B1)", "x":1, "y":4},
                {"label":"K42 (C7,B2)", "x":2, "y":4},
                {"label":"K43 (C7,B4)", "x":3, "y":4},
                {"label":"K51 (C6,B1)", "x":1, "y":5},
                {"label":"K53 (C6,B4)", "x":2, "y":5, "w":2}
            ]
        }
    }
}
\ No newline at end of file

A keyboards/matchstickworks/southpad/keymaps/default/keymap.c => keyboards/matchstickworks/southpad/keymaps/default/keymap.c +27 -0
@@ 0,0 1,27 @@
/* Copyright 2021 Logan Butler
 *
 * 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_numpad_6x4_southpaw( /* Base */
				KC_BSPC, KC_EQL, KC_LPRN, KC_RPRN, 
				KC_PMNS, KC_PAST, KC_PSLS, KC_NLCK, 
					KC_P9, KC_P8, KC_P7, 
				KC_PPLS, KC_P6, KC_P5, KC_P4, 
					KC_P3, KC_P2, KC_P1, 
				KC_PENT, KC_PDOT, KC_P0
  ),
};

A keyboards/matchstickworks/southpad/readme.md => keyboards/matchstickworks/southpad/readme.md +23 -0
@@ 0,0 1,23 @@
# SouthPad

![Southpad](https://i.imgur.com/Wl71thnh.jpg)

This is a left-handed (or mirrored) numberpad with USB-C connections.

Default layout is such:

![SouthPad Layout](https://i.imgur.com/jc7T2jl.jpg)

* Keyboard Maintainer: [Logan Butler](https://github.com/MatchstickWorks)
* Hardware Supported: SouthPad PCB
* Hardware Availability: Either via [my Etsy Store](https://www.etsy.com/shop/MatchstickWorksShop) or by messaging directly

Getting the board into bootloader mode:

In order to flash the firmware to this board, simply press the Reset button on the back of the PCB. You should head a USB disconnect and reconnect sound shortly following.

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

    make matchstickworks/southpad:default

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).

A keyboards/matchstickworks/southpad/rules.mk => keyboards/matchstickworks/southpad/rules.mk +22 -0
@@ 0,0 1,22 @@
# MCU name
MCU = atmega32u2

# Bootloader selection
BOOTLOADER = bootloadHID

# Build Options
#   change yes to no to disable
#
BOOTMAGIC_ENABLE = no       # 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

A keyboards/matchstickworks/southpad/southpad.c => keyboards/matchstickworks/southpad/southpad.c +16 -0
@@ 0,0 1,16 @@
/* Copyright 2021 Logan Butler
 *
 * 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 "southpad.h"

A keyboards/matchstickworks/southpad/southpad.h => keyboards/matchstickworks/southpad/southpad.h +44 -0
@@ 0,0 1,44 @@
/* Copyright 2021 Logan Butler
 *
 * 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 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_numpad_6x4_southpaw( \
				k00, k01, k02, k03, \
				k10, k11, k12, k13, \
					k21, k22, k23, \
				k20, k31, k32, k33, \
					k41, k42, k43, \
				k40, k51,   k53  \
) \
{ \
	{ k00,   k01, k02,   k03 },     \
	{ k10,   k11, k12,   k13 },     \
	{ k20,   k21, k22,   k23 },     \
	{ KC_NO, k31, k32,   k33 },     \
	{ k40,   k41, k42,   k43 },     \
	{ KC_NO, k51, KC_NO, k53 }      \
}