From e5831d79c044f394243cfdfe604b91837067b7d6 Mon Sep 17 00:00:00 2001 From: x1 Date: Wed, 7 Aug 2019 01:16:55 +0900 Subject: [PATCH] [Keyboard] Add kudox game keyboard (#6460) * Add configurations for Kudox Game Keyboard rev1. * Modified Kudox Game Keyboard readme and keymap. * Remove unnecessary codes. * Set BootLoader caterina. * Remove wrong settings on rules.mk. * Clean up config.h. * Modified MATRIX_ROWS on kudox_game/rev1/config.h. * Modified RGB_LED_NUM on kudox_game/rev1/config.h. --- keyboards/kudox_game/config.h | 27 ++++++ keyboards/kudox_game/info.json | 39 ++++++++ keyboards/kudox_game/keymaps/default/config.h | 18 ++++ keyboards/kudox_game/keymaps/default/keymap.c | 44 +++++++++ .../kudox_game/keymaps/default/readme.md | 1 + keyboards/kudox_game/keymaps/default/rules.mk | 0 keyboards/kudox_game/kudox_game.c | 16 ++++ keyboards/kudox_game/kudox_game.h | 23 +++++ keyboards/kudox_game/readme.md | 26 ++++++ keyboards/kudox_game/rev1/config.h | 91 +++++++++++++++++++ keyboards/kudox_game/rev1/rev1.c | 22 +++++ keyboards/kudox_game/rev1/rev1.h | 20 ++++ keyboards/kudox_game/rev1/rules.mk | 0 keyboards/kudox_game/rules.mk | 70 ++++++++++++++ 14 files changed, 397 insertions(+) create mode 100644 keyboards/kudox_game/config.h create mode 100644 keyboards/kudox_game/info.json create mode 100644 keyboards/kudox_game/keymaps/default/config.h create mode 100644 keyboards/kudox_game/keymaps/default/keymap.c create mode 100644 keyboards/kudox_game/keymaps/default/readme.md create mode 100644 keyboards/kudox_game/keymaps/default/rules.mk create mode 100644 keyboards/kudox_game/kudox_game.c create mode 100644 keyboards/kudox_game/kudox_game.h create mode 100644 keyboards/kudox_game/readme.md create mode 100644 keyboards/kudox_game/rev1/config.h create mode 100644 keyboards/kudox_game/rev1/rev1.c create mode 100644 keyboards/kudox_game/rev1/rev1.h create mode 100644 keyboards/kudox_game/rev1/rules.mk create mode 100644 keyboards/kudox_game/rules.mk diff --git a/keyboards/kudox_game/config.h b/keyboards/kudox_game/config.h new file mode 100644 index 000000000..0b789c176 --- /dev/null +++ b/keyboards/kudox_game/config.h @@ -0,0 +1,27 @@ +/* +Copyright 2019 Kumao Kobo + +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" + +#define USE_SERIAL + +/* Select hand configuration */ +#define MASTER_LEFT +// #define MASTER_RIGHT +// #define EE_HANDS diff --git a/keyboards/kudox_game/info.json b/keyboards/kudox_game/info.json new file mode 100644 index 000000000..42932601a --- /dev/null +++ b/keyboards/kudox_game/info.json @@ -0,0 +1,39 @@ +{ + "keyboard_name": "Kudox Game Keyboard", + "url": "", + "maintainer": "Kumao Kobo", + "width": 7.5, + "height": 6.75, + "layouts": { + "LAYOUT": { + "layout": [ + {"label":"Esc", "x":0, "y":0}, + {"label":"1", "x":1.5, "y":0}, + {"label":"2", "x":2.5, "y":0}, + {"label":"3", "x":3.5, "y":0}, + {"label":"4", "x":4.5, "y":0}, + {"label":"5", "x":5.5, "y":0}, + {"label":"Q", "x":1.75, "y":1}, + {"label":"W", "x":2.75, "y":1}, + {"label":"E", "x":3.75, "y":1}, + {"label":"R", "x":4.75, "y":1}, + {"label":"T", "x":5.75, "y":1}, + {"label":"GUI", "x":0, "y":2}, + {"label":"Alt", "x":1, "y":2}, + {"label":"A", "x":2, "y":2}, + {"label":"S", "x":3, "y":2}, + {"label":"D", "x":4, "y":2}, + {"label":"F", "x":5.25, "y":2}, + {"label":"G", "x":6.25, "y":2}, + {"label":"Shift", "x":0, "y":3, "w":1.5}, + {"label":"Z", "x":1.5, "y":3}, + {"label":"X", "x":3.75, "y":3}, + {"label":"C", "x":4.75, "y":3}, + {"label":"V", "x":5.75, "y":3}, + {"label":"Ctrl", "x":0, "y":4, "w":1.5}, + {"label":"Layer", "x":5.5, "y":4.25, "h":1.5}, + {"x":6.5, "y":4.75, "h":2} + ] + } + } +} diff --git a/keyboards/kudox_game/keymaps/default/config.h b/keyboards/kudox_game/keymaps/default/config.h new file mode 100644 index 000000000..5cbe7609a --- /dev/null +++ b/keyboards/kudox_game/keymaps/default/config.h @@ -0,0 +1,18 @@ +/* +Copyright 2019 Kumao Kobo + +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 diff --git a/keyboards/kudox_game/keymaps/default/keymap.c b/keyboards/kudox_game/keymaps/default/keymap.c new file mode 100644 index 000000000..cf6b1dfc5 --- /dev/null +++ b/keyboards/kudox_game/keymaps/default/keymap.c @@ -0,0 +1,44 @@ +#include QMK_KEYBOARD_H + +// Each layer gets a name for readability, which is then used in the keymap matrix below. +// The underscores don't mean anything - you can have a layer called STUFF or any other name. +// Layer names don't all need to be of the same length, obviously, and you can also skip them +// entirely and just use numbers. +#define _QWERTY 0 +#define _SYMB 1 + +// Shortcut to make keymap more readable +#define SYM_L MO(_SYMB) +#define KC_ALEN LALT_T(KC_ENT) + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + + [_QWERTY] = LAYOUT( + //┌────────┬────────┬────────┬────────┬────────┬────────┐ + KC_ESC ,KC_1 ,KC_2 ,KC_3 ,KC_4 ,KC_5 , + //└────────┼────────┼────────┼────────┼────────┼────────┤ + KC_Q ,KC_W ,KC_E ,KC_R ,KC_T , + //┌────────┼────────┼────────┼────────┼────────┼────────┼────────┐ + KC_LGUI ,KC_ALEN ,KC_A ,KC_S ,KC_D ,KC_F ,KC_G , + //├────────┼────────┼────────┼────────┼────────┼────────┼────────┐ + KC_LSFT ,KC_Z ,KC_X ,KC_C ,KC_V , + //├────────┼────────┘ └────────┴────────┼────────┼────────┐ + KC_LCTL ,SYM_L ,KC_SPC + //└────────┘ └────────┴────────┘ + ), + + [_SYMB] = LAYOUT( + //┌────────┬────────┬────────┬────────┬────────┬────────┐ + _______ ,KC_6 ,KC_7 ,KC_8 ,KC_9 ,KC_0 , + //└────────┼────────┼────────┼────────┼────────┼────────┤ + KC_GRV ,KC_UP ,KC_PIPE ,KC_LCBR ,KC_RCBR , + //┌────────┼────────┼────────┼────────┼────────┼────────┼────────┐ + _______ ,_______ ,KC_LEFT ,KC_DOWN ,KC_RIGHT,KC_LBRC ,KC_RBRC , + //├────────┼────────┼────────┼────────┼────────┼────────┼────────┐ + _______ ,KC_BSPC ,KC_CIRC ,KC_LPRN ,KC_RPRN , + //├────────┼────────┘ └────────┴────────┼────────┼────────┐ + _______ ,_______ ,_______ + //└────────┘ └────────┴────────┘ + ) + +}; diff --git a/keyboards/kudox_game/keymaps/default/readme.md b/keyboards/kudox_game/keymaps/default/readme.md new file mode 100644 index 000000000..0fbdb86a9 --- /dev/null +++ b/keyboards/kudox_game/keymaps/default/readme.md @@ -0,0 +1 @@ +# The default keymap for Kudox Game Keyboard diff --git a/keyboards/kudox_game/keymaps/default/rules.mk b/keyboards/kudox_game/keymaps/default/rules.mk new file mode 100644 index 000000000..e69de29bb diff --git a/keyboards/kudox_game/kudox_game.c b/keyboards/kudox_game/kudox_game.c new file mode 100644 index 000000000..cf053afd0 --- /dev/null +++ b/keyboards/kudox_game/kudox_game.c @@ -0,0 +1,16 @@ +/* Copyright 2019 Kumao Kobo + * + * 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 "kudox_game.h" diff --git a/keyboards/kudox_game/kudox_game.h b/keyboards/kudox_game/kudox_game.h new file mode 100644 index 000000000..1da820fc2 --- /dev/null +++ b/keyboards/kudox_game/kudox_game.h @@ -0,0 +1,23 @@ +/* Copyright 2019 Kumao Kobo + * + * 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 + +#ifdef KEYBOARD_kudox_game_rev1 + #include "rev1.h" +#endif + +#include "quantum.h" diff --git a/keyboards/kudox_game/readme.md b/keyboards/kudox_game/readme.md new file mode 100644 index 000000000..5ad867790 --- /dev/null +++ b/keyboards/kudox_game/readme.md @@ -0,0 +1,26 @@ +# The Kudox Game keyboard + +

+Kudox logo +

+ +

+Kudox Game PCB rev1.0 +

+ +- Keyboard Maintainer: [Kumao Kobo](https://github.com/kumaokobo) +- Hardware Supported: Kudox Game PCB rev1.0 w/ Pro Micro + +Make example for this keyboard (after setting up your build environment): + +```sh +make kudox_game/rev1:default +``` + +Example of flashing this keyboard: + +```sh +make kudox_game/rev1:default:avrdude +``` + +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/kudox_game/rev1/config.h b/keyboards/kudox_game/rev1/config.h new file mode 100644 index 000000000..e7f7ad1b6 --- /dev/null +++ b/keyboards/kudox_game/rev1/config.h @@ -0,0 +1,91 @@ +/* +Copyright 2019 Kumao Kobo + +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 0xFEED +#define PRODUCT_ID 0x9696 +#define DEVICE_VER 0x0100 +#define MANUFACTURER Kumao Kobo +#define PRODUCT The Kudox Game Keyboard +#define DESCRIPTION Custom keyboard for game + +/* key matrix size */ +#define MATRIX_ROWS 5 +#define MATRIX_COLS 7 + +// wiring of each half +#define MATRIX_ROW_PINS { D4, D7, E6, B4, B5 } +#define MATRIX_COL_PINS { F5, F6, F7, B1, B3, B2, B6 } +// #define MATRIX_COL_PINS { B6, B2, B3, B1, F7, F6, F5} //uncomment this line and comment line above if you need to reverse left-to-right key order + +/* COL2ROW or ROW2COL */ +#define DIODE_DIRECTION COL2ROW + +/* define if matrix has ghost */ +//#define MATRIX_HAS_GHOST + +/* number of backlight levels */ +// #define BACKLIGHT_LEVELS 3 + +/* Set 0 if debouncing isn't needed */ +#define DEBOUNCE 5 + +/* serial.c configuration for split keyboard */ +#define SOFT_SERIAL_PIN D0 + +/* 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 + +/* ws2812 RGB LED */ +#define RGB_DI_PIN D3 + +#undef RGBLED_NUM +#define RGBLED_NUM 7 // Number of LEDs +#define RGBLIGHT_ANIMATIONS +#define RGBLIGHT_HUE_STEP 8 +#define RGBLIGHT_SAT_STEP 8 +#define RGBLIGHT_VAL_STEP 8 + +/* + * 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 + +#define MOUSEKEY_INTERVAL 20 +#define MOUSEKEY_DELAY 0 +#define MOUSEKEY_TIME_TO_MAX 60 +#define MOUSEKEY_MAX_SPEED 7 +#define MOUSEKEY_WHEEL_DELAY 0 diff --git a/keyboards/kudox_game/rev1/rev1.c b/keyboards/kudox_game/rev1/rev1.c new file mode 100644 index 000000000..8f1b8b2b6 --- /dev/null +++ b/keyboards/kudox_game/rev1/rev1.c @@ -0,0 +1,22 @@ +#include "kudox_game.h" + + +#ifdef SSD1306OLED +void led_set_kb(uint8_t usb_led) { + // put your keyboard LED indicator (ex: Caps Lock LED) toggling code here + led_set_user(usb_led); +} +#endif + +void matrix_init_kb(void) { + + // // green led on + // DDRD |= (1<<5); + // PORTD &= ~(1<<5); + + // // orange led on + // DDRB |= (1<<0); + // PORTB &= ~(1<<0); + + matrix_init_user(); +}; diff --git a/keyboards/kudox_game/rev1/rev1.h b/keyboards/kudox_game/rev1/rev1.h new file mode 100644 index 000000000..e630a5165 --- /dev/null +++ b/keyboards/kudox_game/rev1/rev1.h @@ -0,0 +1,20 @@ +#pragma once + +#include "../kudox_game.h" + +#include "quantum.h" + +#define LAYOUT( \ + k00, k01, k02, k03, k04, k05, \ + k11, k12, k13, k14, k15, \ + k20, k21, k22, k23, k24, k25, k26, \ + k30, k31, k34, k35, k36, \ + k40, k45, k46 \ +) \ +{ \ + { k00, k01, k02, k03, k04, k05, KC_NO }, \ + { KC_NO, k11, k12, k13, k14, k15, KC_NO }, \ + { k20, k21, k22, k23, k24, k25, k26 }, \ + { k30, k31, KC_NO, KC_NO, k34, k35, k36 }, \ + { k40, KC_NO, KC_NO, KC_NO, KC_NO, k45, k46 } \ +} diff --git a/keyboards/kudox_game/rev1/rules.mk b/keyboards/kudox_game/rev1/rules.mk new file mode 100644 index 000000000..e69de29bb diff --git a/keyboards/kudox_game/rules.mk b/keyboards/kudox_game/rules.mk new file mode 100644 index 000000000..d564eddf9 --- /dev/null +++ b/keyboards/kudox_game/rules.mk @@ -0,0 +1,70 @@ +# MCU name +MCU = atmega32u4 + +# Processor frequency. +# This will define a symbol, F_CPU, in all source code files equal to the +# processor frequency in Hz. You can then use this symbol in your source code to +# calculate timings. Do NOT tack on a 'UL' at the end, this will be done +# automatically to create a 32-bit value in your source code. +# +# This will be an integer division of F_USB below, as it is sourced by +# F_USB after it has run through any CPU prescalers. Note that this value +# does not *change* the processor frequency - it should merely be updated to +# reflect the processor speed set externally so that the code can use accurate +# software delays. +F_CPU = 16000000 + + +# +# LUFA specific +# +# Target architecture (see library "Board Types" documentation). +ARCH = AVR8 + +# Input clock frequency. +# This will define a symbol, F_USB, in all source code files equal to the +# input clock frequency (before any prescaling is performed) in Hz. This value may +# differ from F_CPU if prescaling is used on the latter, and is required as the +# raw input clock is fed directly to the PLL sections of the AVR for high speed +# clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL' +# at the end, this will be done automatically to create a 32-bit value in your +# source code. +# +# If no clock division is performed on the input clock inside the AVR (via the +# CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU. +F_USB = $(F_CPU) + +# Interrupt driven control endpoint task(+60) +OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT + + +# Bootloader selection +# Teensy halfkay +# Pro Micro caterina +# Atmel DFU atmel-dfu +# LUFA DFU lufa-dfu +# QMK DFU qmk-dfu +# atmega32a bootloadHID +BOOTLOADER = caterina + +# Build Options +# change yes to no to disable +# +BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000) +MOUSEKEY_ENABLE = yes # Mouse keys(+4700) +EXTRAKEY_ENABLE = yes # Audio control and System control(+450) +CONSOLE_ENABLE = no # Console for debug(+400) +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 on B7 by default +MIDI_ENABLE = no # MIDI support (+2400 to 4200, depending on config) +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 +RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight. + +DEFAULT_FOLDER = kudox_game/rev1