From 8ed9eb9c7f75b898c867060be46b404725339cea Mon Sep 17 00:00:00 2001 From: gkeyboard Date: Sat, 2 Jan 2021 06:26:00 +0700 Subject: [Keyboard] Add GKB-M16 Macro Pad (#11262) * Add GKB-M16 Macro Pad Add GKB-M16 (gkb_m16) Macro Pad under gkeyboard * Update keyboards/gkeyboard/gkb_m16/config.h Co-authored-by: Joel Challis * Update keyboards/gkeyboard/gkb_m16/keymaps/via/keymap.c Co-authored-by: Joel Challis * Update keyboards/gkeyboard/gkb_m16/info.json Co-authored-by: Ryan * Update keyboards/gkeyboard/gkb_m16/keymaps/default/keymap.c Co-authored-by: Ryan Co-authored-by: Joel Challis Co-authored-by: Ryan --- keyboards/gkeyboard/gkb_m16/config.h | 151 +++++++++++++++++++++ keyboards/gkeyboard/gkb_m16/gkb_m16.c | 17 +++ keyboards/gkeyboard/gkb_m16/gkb_m16.h | 40 ++++++ keyboards/gkeyboard/gkb_m16/info.json | 29 ++++ .../gkeyboard/gkb_m16/keymaps/default/keymap.c | 73 ++++++++++ .../gkeyboard/gkb_m16/keymaps/default/readme.md | 1 + keyboards/gkeyboard/gkb_m16/keymaps/via/keymap.c | 44 ++++++ keyboards/gkeyboard/gkb_m16/keymaps/via/readme.md | 1 + keyboards/gkeyboard/gkb_m16/keymaps/via/rules.mk | 2 + keyboards/gkeyboard/gkb_m16/readme.md | 19 +++ keyboards/gkeyboard/gkb_m16/rules.mk | 22 +++ 11 files changed, 399 insertions(+) create mode 100644 keyboards/gkeyboard/gkb_m16/config.h create mode 100644 keyboards/gkeyboard/gkb_m16/gkb_m16.c create mode 100644 keyboards/gkeyboard/gkb_m16/gkb_m16.h create mode 100644 keyboards/gkeyboard/gkb_m16/info.json create mode 100644 keyboards/gkeyboard/gkb_m16/keymaps/default/keymap.c create mode 100644 keyboards/gkeyboard/gkb_m16/keymaps/default/readme.md create mode 100644 keyboards/gkeyboard/gkb_m16/keymaps/via/keymap.c create mode 100644 keyboards/gkeyboard/gkb_m16/keymaps/via/readme.md create mode 100644 keyboards/gkeyboard/gkb_m16/keymaps/via/rules.mk create mode 100644 keyboards/gkeyboard/gkb_m16/readme.md create mode 100644 keyboards/gkeyboard/gkb_m16/rules.mk diff --git a/keyboards/gkeyboard/gkb_m16/config.h b/keyboards/gkeyboard/gkb_m16/config.h new file mode 100644 index 0000000000..be1861b90f --- /dev/null +++ b/keyboards/gkeyboard/gkb_m16/config.h @@ -0,0 +1,151 @@ +/* +Copyright 2020 gkeyboard + +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 . +*/ + +#pragma once + +#include "config_common.h" + +/* USB Device descriptor parameter */ +#define VENDOR_ID 0x474B // "GK" +#define PRODUCT_ID 0x4201 +#define DEVICE_VER 0x0001 +#define MANUFACTURER gkeyboard +#define PRODUCT GKB-M16 +/* key matrix size */ +#define MATRIX_ROWS 4 +#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 { D4, D5, D6, D7 } +#define MATRIX_COL_PINS { F4, F5, F6, F7 } +#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 F1 +#ifdef RGB_DI_PIN + #define RGBLED_NUM 4 + #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 diff --git a/keyboards/gkeyboard/gkb_m16/gkb_m16.c b/keyboards/gkeyboard/gkb_m16/gkb_m16.c new file mode 100644 index 0000000000..5a1f7f13e3 --- /dev/null +++ b/keyboards/gkeyboard/gkb_m16/gkb_m16.c @@ -0,0 +1,17 @@ +/* Copyright 2020 gkeyboard + * + * 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 . + */ + +#include "gkb_m16.h" diff --git a/keyboards/gkeyboard/gkb_m16/gkb_m16.h b/keyboards/gkeyboard/gkb_m16/gkb_m16.h new file mode 100644 index 0000000000..8477f4cda3 --- /dev/null +++ b/keyboards/gkeyboard/gkb_m16/gkb_m16.h @@ -0,0 +1,40 @@ +/* Copyright 2020 gkeyboard + * + * 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 . + */ + +#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_ortho_4x4( \ + K01, K02, K03, K04, \ + K11, K12, K13, K14, \ + K21, K22, K23, K24, \ + K31, K32, K33, K34 \ +) \ +{ \ + { K01, K02, K03, K04 }, \ + { K11, K12, K13, K14 }, \ + { K21, K22, K23, K24 }, \ + { K31, K32, K33, K34 } \ +} diff --git a/keyboards/gkeyboard/gkb_m16/info.json b/keyboards/gkeyboard/gkb_m16/info.json new file mode 100644 index 0000000000..a9263a3cd7 --- /dev/null +++ b/keyboards/gkeyboard/gkb_m16/info.json @@ -0,0 +1,29 @@ +{ + "keyboard_name": "gkb_m16", + "url": "", + "maintainer": "gkeyboard", + "width": 4, + "height": 4, + "layouts": { + "LAYOUT_ortho_4x4": { + "layout": [ + {"x":0, "y":0}, + {"x":1, "y":0}, + {"x":2, "y":0}, + {"x":3, "y":0}, + {"x":0, "y":1}, + {"x":1, "y":1}, + {"x":2, "y":1}, + {"x":3, "y":1}, + {"x":0, "y":2}, + {"x":1, "y":2}, + {"x":2, "y":2}, + {"x":3, "y":2}, + {"x":0, "y":3}, + {"x":1, "y":3}, + {"x":2, "y":3}, + {"x":3, "y":3} + ] + } + } + } diff --git a/keyboards/gkeyboard/gkb_m16/keymaps/default/keymap.c b/keyboards/gkeyboard/gkb_m16/keymaps/default/keymap.c new file mode 100644 index 0000000000..4fcde1b55c --- /dev/null +++ b/keyboards/gkeyboard/gkb_m16/keymaps/default/keymap.c @@ -0,0 +1,73 @@ +/* Copyright 2020 gkeyboard + * + * 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 . + */ +#include QMK_KEYBOARD_H + +enum layers { + _BASE = 0, + _FN1, + _FN2, +}; + +// Defines the keycodes used by our macros in process_record_user +enum custom_keycodes { + QMKBEST = SAFE_RANGE, + QMKURL +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + + [_BASE] = LAYOUT_ortho_4x4( + KC_PGUP, KC_HOME, KC_UP, KC_END , + KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, + MO(_FN2), KC_VOLU, KC_MPLY, KC_MPRV, + MO(_FN1), KC_VOLD, KC_MUTE, KC_MNXT + ), + [_FN1] = LAYOUT_ortho_4x4( + KC_ESC, KC_P7, KC_P8, KC_P9, + KC_TAB, KC_P4, KC_P5, KC_P6, + KC_ENT, KC_P1, KC_P2, KC_P3, + _______, KC_P0, KC_P0, KC_DOT + ), + [_FN2] = LAYOUT_ortho_4x4( + RGB_MOD, RGB_HUI, RGB_SAI, RGB_VAI, + RGB_RMOD, RGB_HUD, RGB_SAD, RGB_VAD, + _______, _______, _______, RESET, + RGB_TOG, _______, QMKBEST, QMKURL + ) + +}; + +bool process_record_user(uint16_t keycode, keyrecord_t *record) { + switch (keycode) { + case QMKBEST: + if (record->event.pressed) { + // when keycode QMKBEST is pressed + SEND_STRING("QMK is the best thing ever!"); + } else { + // when keycode QMKBEST is released + } + break; + case QMKURL: + if (record->event.pressed) { + // when keycode QMKURL is pressed + SEND_STRING("https://qmk.fm/\n"); + } else { + // when keycode QMKURL is released + } + break; + } + return true; +} diff --git a/keyboards/gkeyboard/gkb_m16/keymaps/default/readme.md b/keyboards/gkeyboard/gkb_m16/keymaps/default/readme.md new file mode 100644 index 0000000000..7e49601249 --- /dev/null +++ b/keyboards/gkeyboard/gkb_m16/keymaps/default/readme.md @@ -0,0 +1 @@ +# The default keymap for GKB-M16 diff --git a/keyboards/gkeyboard/gkb_m16/keymaps/via/keymap.c b/keyboards/gkeyboard/gkb_m16/keymaps/via/keymap.c new file mode 100644 index 0000000000..7d43c33082 --- /dev/null +++ b/keyboards/gkeyboard/gkb_m16/keymaps/via/keymap.c @@ -0,0 +1,44 @@ +/* Copyright 2020 gkeyboard + * + * 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 . + */ +#include QMK_KEYBOARD_H +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + + [0] = LAYOUT_ortho_4x4( + KC_PGUP, KC_HOME, KC_UP, KC_END , + KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, + KC_DOT, KC_VOLU, KC_MPLY, KC_MPRV, + MO(1), KC_VOLD, KC_MUTE, KC_MNXT + ), + [1] = LAYOUT_ortho_4x4( + RESET, KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS + ), + [2] = LAYOUT_ortho_4x4( + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS + ), + + [3] = LAYOUT_ortho_4x4( + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS + ) +}; diff --git a/keyboards/gkeyboard/gkb_m16/keymaps/via/readme.md b/keyboards/gkeyboard/gkb_m16/keymaps/via/readme.md new file mode 100644 index 0000000000..b04d2f4a31 --- /dev/null +++ b/keyboards/gkeyboard/gkb_m16/keymaps/via/readme.md @@ -0,0 +1 @@ +# Via keymap for GKB-M16 diff --git a/keyboards/gkeyboard/gkb_m16/keymaps/via/rules.mk b/keyboards/gkeyboard/gkb_m16/keymaps/via/rules.mk new file mode 100644 index 0000000000..36b7ba9cbc --- /dev/null +++ b/keyboards/gkeyboard/gkb_m16/keymaps/via/rules.mk @@ -0,0 +1,2 @@ +VIA_ENABLE = yes +LTO_ENABLE = yes diff --git a/keyboards/gkeyboard/gkb_m16/readme.md b/keyboards/gkeyboard/gkb_m16/readme.md new file mode 100644 index 0000000000..40b9457437 --- /dev/null +++ b/keyboards/gkeyboard/gkb_m16/readme.md @@ -0,0 +1,19 @@ +# GKB-M16 + +![GKB-M16](https://i.imgur.com/LP5I5ZQ.png) + +4x4 Custom Macro Pad, with USB Type-C, RGB underglow. + +* Keyboard Maintainer: [gkeyboard](https://github.com/gkeyboard) +* Hardware Supported: GKB-M16 PCB +* Hardware Availability: http://www.mltelectronic.com + +Make example for this keyboard (after setting up your build environment): + + make gkeyboard/gkb_m16:default + +Flashing example for this keyboard: + + make gkeyboard/gkb_m16: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). diff --git a/keyboards/gkeyboard/gkb_m16/rules.mk b/keyboards/gkeyboard/gkb_m16/rules.mk new file mode 100644 index 0000000000..f49426d513 --- /dev/null +++ b/keyboards/gkeyboard/gkb_m16/rules.mk @@ -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 = yes # USB Nkey Rollover +BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality +RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow +BLUETOOTH_ENABLE = no # Enable Bluetooth +AUDIO_ENABLE = no # Audio output -- cgit v1.2.3