Co-authored-by: Ryan <fauxpark@gmail.com>pull/13544/head
@ -0,0 +1,158 @@ | |||||
/* | |||||
Copyright 2021 ianklug | |||||
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 0x4B4C // "KL" = klug | |||||
#define PRODUCT_ID 0x4742 // "GB" = grooveboard | |||||
#define DEVICE_VER 0x0001 | |||||
#define MANUFACTURER ianklug | |||||
#define PRODUCT grooveboard | |||||
/* key matrix size */ | |||||
#define MATRIX_ROWS 1 | |||||
#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 { D0, D5 } | |||||
//#define MATRIX_COL_PINS { F1, F0, B0 } | |||||
#define DIRECT_PINS { \ | |||||
{ F7, F6, D1, D2 } \ | |||||
} | |||||
#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 0 | |||||
#define USB_POLLING_INTERVAL_MS 1 | |||||
#define QMK_KEYS_PER_SCAN 4 |
@ -0,0 +1,17 @@ | |||||
/* Copyright 2021 ianklug | |||||
* | |||||
* 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 "grooveboard.h" |
@ -0,0 +1,33 @@ | |||||
/* Copyright 2021 ianklug | |||||
* | |||||
* 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, k02, k03 \ | |||||
) { \ | |||||
{ k00, k01, k02, k03 } \ | |||||
} |
@ -0,0 +1,17 @@ | |||||
{ | |||||
"keyboard_name": "grooveboard", | |||||
"url": "https://github.com/ianklug/grooveboard", | |||||
"maintainer": "ianklug", | |||||
"width": 6, | |||||
"height": 1, | |||||
"layouts": { | |||||
"LAYOUT": { | |||||
"layout": [ | |||||
{"label": "k00", "x": 0, "y": 0, "w": 1, "h": 1}, | |||||
{"label": "k01", "x": 1, "y": 0, "w": 1, "h": 1}, | |||||
{"label": "k02", "x": 4, "y": 0, "w": 1, "h": 1}, | |||||
{"label": "k03", "x": 5, "y": 0, "w": 1, "h": 1} | |||||
] | |||||
} | |||||
} | |||||
} |
@ -0,0 +1,28 @@ | |||||
/* Copyright 2021 ianklug | |||||
* | |||||
* 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] = { | |||||
/* Base */ | |||||
[_BASE] = LAYOUT( | |||||
KC_LEFT, KC_DOWN, KC_UP, KC_RGHT | |||||
) | |||||
}; |
@ -0,0 +1 @@ | |||||
# The default keymap for grooveboard |
@ -0,0 +1,37 @@ | |||||
/* Copyright 2021 ianklug | |||||
* | |||||
* 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] = { | |||||
/* Base */ | |||||
[_BASE] = LAYOUT( | |||||
KC_LEFT, KC_DOWN, KC_UP, KC_RGHT | |||||
), | |||||
[1] = LAYOUT( | |||||
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS | |||||
), | |||||
[2] = LAYOUT( | |||||
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS | |||||
), | |||||
[3] = LAYOUT( | |||||
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS | |||||
) | |||||
}; |
@ -0,0 +1 @@ | |||||
# The via keymap for grooveboard |
@ -0,0 +1,2 @@ | |||||
VIA_ENABLE = yes | |||||
LTO_ENABLE = yes |
@ -0,0 +1,21 @@ | |||||
# Grooveboard | |||||
A four-key mechanical keyboard for rhythm games. | |||||
![Grooveboard Choc PCB](https://i.imgur.com/wbMkbHX.jpg) | |||||
* Keyboard Maintainer: [ianklug](https://github.com/ianklug) | |||||
* Hardware Supported: grooveboard, grooveboard mx, grooveboard choc | |||||
* Hardware Availability: https://github.com/ianklug/grooveboard | |||||
Press the button on the back of the keyboard to enter bootloader mode. | |||||
Make example for this keyboard (after setting up your build environment): | |||||
make ianklug/grooveboard:default | |||||
Flashing example for this keyboard: | |||||
make ianklug/grooveboard: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). |
@ -0,0 +1,22 @@ | |||||
# 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 |