From f1c33423b07886355c7a06c2bc785dcd22c4e10d Mon Sep 17 00:00:00 2001 From: cole smith <38364556+daysgobye@users.noreply.github.com> Date: Mon, 1 Jun 2020 13:07:49 -0700 Subject: [PATCH] Added new keyboard boardsource/3x4 (#9247) * added bordsource 3x4 macro pad * added bordsource 3x4 macro pad * Update keyboards/boardsource/3x4/3x4.h Co-authored-by: Nick Brassel * Update keyboards/boardsource/3x4/3x4.c Co-authored-by: Nick Brassel * Update keyboards/boardsource/3x4/config.h Co-authored-by: Nick Brassel * Update keyboards/boardsource/3x4/config.h Co-authored-by: Nick Brassel * Update keyboards/boardsource/3x4/config.h Co-authored-by: Nick Brassel * Update keyboards/boardsource/3x4/config.h Co-authored-by: Nick Brassel * added link to readme * Update keyboards/boardsource/3x4/keymaps/default/keymap.c Co-authored-by: Nick Brassel * Apply suggestions from code review Co-authored-by: Ryan Co-authored-by: Nick Brassel Co-authored-by: Ryan --- keyboards/boardsource/3x4/3x4.c | 1 + keyboards/boardsource/3x4/3x4.h | 12 ++ keyboards/boardsource/3x4/config.h | 144 ++++++++++++++++++ keyboards/boardsource/3x4/info.json | 28 ++++ .../boardsource/3x4/keymaps/default/keymap.c | 25 +++ keyboards/boardsource/3x4/readme.md | 14 ++ keyboards/boardsource/3x4/rules.mk | 31 ++++ 7 files changed, 255 insertions(+) create mode 100644 keyboards/boardsource/3x4/3x4.c create mode 100644 keyboards/boardsource/3x4/3x4.h create mode 100644 keyboards/boardsource/3x4/config.h create mode 100644 keyboards/boardsource/3x4/info.json create mode 100644 keyboards/boardsource/3x4/keymaps/default/keymap.c create mode 100644 keyboards/boardsource/3x4/readme.md create mode 100644 keyboards/boardsource/3x4/rules.mk diff --git a/keyboards/boardsource/3x4/3x4.c b/keyboards/boardsource/3x4/3x4.c new file mode 100644 index 00000000000..798d5a65c4b --- /dev/null +++ b/keyboards/boardsource/3x4/3x4.c @@ -0,0 +1 @@ +#include "3x4.h" diff --git a/keyboards/boardsource/3x4/3x4.h b/keyboards/boardsource/3x4/3x4.h new file mode 100644 index 00000000000..a27d32c74f7 --- /dev/null +++ b/keyboards/boardsource/3x4/3x4.h @@ -0,0 +1,12 @@ +#pragma once + +#include "quantum.h" +#define LAYOUT( \ + K00, K01, K02, K03, \ + K10, K11, K12, K13, \ + K20, K21, K22, K23 \ + ) { \ + {K00, K01, K02, K03}, \ + {K10, K11, K12, K13}, \ + {K20, K21, K22, K23} \ + } diff --git a/keyboards/boardsource/3x4/config.h b/keyboards/boardsource/3x4/config.h new file mode 100644 index 00000000000..95c6f9ac273 --- /dev/null +++ b/keyboards/boardsource/3x4/config.h @@ -0,0 +1,144 @@ + + +#pragma once + +#include "config_common.h" + +/* USB Device descriptor parameter */ +#define VENDOR_ID 0xF7E0 +#define PRODUCT_ID 0x0412 +#define DEVICE_VER 0x0000 +#define MANUFACTURER Boardsource +#define PRODUCT 3x4 +#define DESCRIPTION Little macro pad + +/* key matrix size */ +#define MATRIX_ROWS 3 +#define MATRIX_COLS 4 + +#define MATRIX_ROW_PINS { F7, F6, F5,} +#define MATRIX_COL_PINS {B6, B2, B3, B1} + +#define DIODE_DIRECTION COL2ROW + +#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 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 + +/* + * Magic Key Options + * + * Magic keys are hotkey commands that allow control over firmware functions of + * the keyboard. They are best used in combination with the HID Listen program, + * found here: https://www.pjrc.com/teensy/hid_listen.html + * + * The options below allow the magic key functionality to be changed. This is + * useful if your keyboard/keypad is missing keys and you want magic key support. + * + */ + +/* control how magic key switches layers */ +//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true +//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true +//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false + +/* override magic key keymap */ +//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS +//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS +//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM +//#define MAGIC_KEY_HELP1 H +//#define MAGIC_KEY_HELP2 SLASH +//#define MAGIC_KEY_DEBUG D +//#define MAGIC_KEY_DEBUG_MATRIX X +//#define MAGIC_KEY_DEBUG_KBD K +//#define MAGIC_KEY_DEBUG_MOUSE M +//#define MAGIC_KEY_VERSION V +//#define MAGIC_KEY_STATUS S +//#define MAGIC_KEY_CONSOLE C +//#define MAGIC_KEY_LAYER0_ALT1 ESC +//#define MAGIC_KEY_LAYER0_ALT2 GRAVE +//#define MAGIC_KEY_LAYER0 0 +//#define MAGIC_KEY_LAYER1 1 +//#define MAGIC_KEY_LAYER2 2 +//#define MAGIC_KEY_LAYER3 3 +//#define MAGIC_KEY_LAYER4 4 +//#define MAGIC_KEY_LAYER5 5 +//#define MAGIC_KEY_LAYER6 6 +//#define MAGIC_KEY_LAYER7 7 +//#define MAGIC_KEY_LAYER8 8 +//#define MAGIC_KEY_LAYER9 9 +//#define MAGIC_KEY_BOOTLOADER PAUSE +//#define MAGIC_KEY_LOCK CAPS +//#define MAGIC_KEY_EEPROM E +//#define MAGIC_KEY_NKRO N +//#define MAGIC_KEY_SLEEP_LED Z + +/* + * 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 + +/* + * MIDI options + */ + +/* Prevent use of disabled MIDI features in the keymap */ +//#define MIDI_ENABLE_STRICT 1 + +/* enable basic MIDI features: + - MIDI notes can be sent when in Music mode is on +*/ +//#define MIDI_BASIC + +/* enable advanced MIDI features: + - MIDI notes can be added to the keymap + - Octave shift and transpose + - Virtual sustain, portamento, and modulation wheel + - etc. +*/ +//#define MIDI_ADVANCED + +/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */ +//#define MIDI_TONE_KEYCODE_OCTAVES 1 diff --git a/keyboards/boardsource/3x4/info.json b/keyboards/boardsource/3x4/info.json new file mode 100644 index 00000000000..4ef02873e3f --- /dev/null +++ b/keyboards/boardsource/3x4/info.json @@ -0,0 +1,28 @@ +{ + "keyboard_name": "boardsource 4x3", + "url": "https://boardsource.xyz", + "maintainer": "boardsource", + "width": 4, + "height": 3, + "layouts": { + "LAYOUT": { + "layout": [ + { "label": "K01", "x": 0, "y": 0 }, + { "label": "K02", "x": 1, "y": 0 }, + { "label": "K03", "x": 2, "y": 0 }, + + { "label": "K04", "x": 0, "y": 1 }, + { "label": "K05", "x": 1, "y": 1 }, + { "label": "K06", "x": 2, "y": 1 }, + + { "label": "K07", "x": 0, "y": 2 }, + { "label": "K08", "x": 1, "y": 2 }, + { "label": "K09", "x": 2, "y": 2 }, + + { "label": "K10", "x": 0, "y": 3 }, + { "label": "K11", "x": 1, "y": 3 }, + { "label": "K12", "x": 2, "y": 3 } + ] + } + } +} diff --git a/keyboards/boardsource/3x4/keymaps/default/keymap.c b/keyboards/boardsource/3x4/keymaps/default/keymap.c new file mode 100644 index 00000000000..3add4f7fbf1 --- /dev/null +++ b/keyboards/boardsource/3x4/keymaps/default/keymap.c @@ -0,0 +1,25 @@ + +#include QMK_KEYBOARD_H + +#define _MAIN 0 +#define _RAISE 1 +#define _LOWER 2 + +// Readability keycodes +#define LOWER MO(_LOWER) +#define RAISE MO(_RAISE) + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + + [_MAIN] = LAYOUT( + KC_0, KC_1, KC_4, KC_7, + KC_ENT, KC_2, KC_5, KC_8, + RAISE, KC_3, KC_6, KC_9 + ), + [_RAISE] = LAYOUT( + _______, _______, _______, _______, + _______, _______, _______, _______, + _______, _______, _______, RESET + ) + +}; diff --git a/keyboards/boardsource/3x4/readme.md b/keyboards/boardsource/3x4/readme.md new file mode 100644 index 00000000000..67a22ed4c0b --- /dev/null +++ b/keyboards/boardsource/3x4/readme.md @@ -0,0 +1,14 @@ +# 3x4 +![Boardsource 3x4 macro](https://i.imgur.com/EiPF1hh.jpg) + +this macro pad / small 12 key was inspired by the plaid look + +* Keyboard Maintainer: [Boardsource](https://github.com/daysgobye) +* Hardware Supported: 3x4 v1 +* Hardware Availability: [Boardsource store](https://boardsource.xyz/store/5ecc2008eee64242946c98c1) + +Make example for this keyboard (after setting up your build environment): + + make boardsource/3x4: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). diff --git a/keyboards/boardsource/3x4/rules.mk b/keyboards/boardsource/3x4/rules.mk new file mode 100644 index 00000000000..263c586048d --- /dev/null +++ b/keyboards/boardsource/3x4/rules.mk @@ -0,0 +1,31 @@ +# MCU name +MCU = atmega32u4 + +# Bootloader selection +# Teensy halfkay +# Pro Micro caterina +# Atmel DFU atmel-dfu +# LUFA DFU lufa-dfu +# QMK DFU qmk-dfu +# ATmega32A bootloadHID +# ATmega328P USBasp +BOOTLOADER = caterina + +# 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 = yes # 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 = no # USB Nkey Rollover +BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality +MIDI_ENABLE = no # MIDI support +UNICODE_ENABLE = no # Unicode +BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID +AUDIO_ENABLE = no # Audio output on port C6 +FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches