From 53224e03d62a4d0bd7c9f7e63fd6222ec649a4fa Mon Sep 17 00:00:00 2001 From: Ckat Date: Thu, 21 May 2020 23:37:09 +0000 Subject: [PATCH] [Keyboard] handwired/k8split (#9133) * New Keyboard: k8split * Apply suggestions from code review * move NKRO rule to keymap scope --- keyboards/handwired/k8split/README.md | 21 ++++++++ keyboards/handwired/k8split/config.h | 48 +++++++++++++++++++ keyboards/handwired/k8split/k8split.c | 18 +++++++ keyboards/handwired/k8split/k8split.h | 37 ++++++++++++++ .../k8split/keymaps/default/keymap.c | 33 +++++++++++++ .../handwired/k8split/keymaps/left/config.h | 21 ++++++++ .../handwired/k8split/keymaps/left/keymap.c | 47 ++++++++++++++++++ .../handwired/k8split/keymaps/right/config.h | 21 ++++++++ .../handwired/k8split/keymaps/right/keymap.c | 45 +++++++++++++++++ keyboards/handwired/k8split/rules.mk | 31 ++++++++++++ 10 files changed, 322 insertions(+) create mode 100644 keyboards/handwired/k8split/README.md create mode 100644 keyboards/handwired/k8split/config.h create mode 100644 keyboards/handwired/k8split/k8split.c create mode 100644 keyboards/handwired/k8split/k8split.h create mode 100644 keyboards/handwired/k8split/keymaps/default/keymap.c create mode 100644 keyboards/handwired/k8split/keymaps/left/config.h create mode 100644 keyboards/handwired/k8split/keymaps/left/keymap.c create mode 100644 keyboards/handwired/k8split/keymaps/right/config.h create mode 100644 keyboards/handwired/k8split/keymaps/right/keymap.c create mode 100644 keyboards/handwired/k8split/rules.mk diff --git a/keyboards/handwired/k8split/README.md b/keyboards/handwired/k8split/README.md new file mode 100644 index 0000000000..01c3365abc --- /dev/null +++ b/keyboards/handwired/k8split/README.md @@ -0,0 +1,21 @@ +# k8split +![left](https://raw.githubusercontent.com/Ckath/k8split/master/k8split_left.png) +![right](https://raw.githubusercontent.com/Ckath/k8split/master/k8split_right.png) + +my personal 8x6(x2) split keyboard, aiming to be a mostly normal keyboard layout with plenty of keys. see the hardware repo for more info. + +* Keyboard Maintainer: [Ckath](https://github.com/Ckath) +* Hardware: https://github.com/Ckath/k8split + +Make example for this keyboard (after setting up your build environment): + + make handwired/k8split:default + +Flashing (both halves are separate keyboards and the default layout is just for debugging): + + # left + make handwired/k8split:left:flash + # right + make handwired/k8split:right: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/handwired/k8split/config.h b/keyboards/handwired/k8split/config.h new file mode 100644 index 0000000000..234ab1adb3 --- /dev/null +++ b/keyboards/handwired/k8split/config.h @@ -0,0 +1,48 @@ +/* +Copyright 2020 Ckat + +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 0xC81D +#define PRODUCT_ID 0xC868 +#define DEVICE_VER 0x0001 +#define MANUFACTURER Ckat +#define PRODUCT k8split +#define DESCRIPTION custom split keyboard + +/* key matrix size */ +#define MATRIX_ROWS 6 +#define MATRIX_COLS 8 + +/* + * 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 { D5, D3, D2, D1, D0, B7 } +#define MATRIX_COL_PINS { C7, C6, B6, B5, B4, D7, D6, D4 } + +/* COL2ROW, ROW2COL */ +#define DIODE_DIRECTION COL2ROW diff --git a/keyboards/handwired/k8split/k8split.c b/keyboards/handwired/k8split/k8split.c new file mode 100644 index 0000000000..300a075ae4 --- /dev/null +++ b/keyboards/handwired/k8split/k8split.c @@ -0,0 +1,18 @@ +/* +Copyright 2020 Ckat + +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 "k8split.h" diff --git a/keyboards/handwired/k8split/k8split.h b/keyboards/handwired/k8split/k8split.h new file mode 100644 index 0000000000..247c0d775a --- /dev/null +++ b/keyboards/handwired/k8split/k8split.h @@ -0,0 +1,37 @@ +/* +Copyright 2020 Ckat + +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" + +#define LAYOUT( \ + k00, k06, k12, k18, k24, k30, k36, k42, \ + k01, k07, k13, k19, k25, k31, k37, k43, \ + k02, k08, k14, k20, k26, k32, k38, k44, \ + k03, k09, k15, k21, k27, k33, k39, k45, \ + k04, k10, k16, k22, k28, k34, k40, k46, \ + k05, k11, k17, k23, k29, k35, k41, k47 \ +) \ +{ \ + { k00, k06, k12, k18, k24, k30, k36, k42 }, \ + { k01, k07, k13, k19, k25, k31, k37, k43 }, \ + { k02, k08, k14, k20, k26, k32, k38, k44 }, \ + { k03, k09, k15, k21, k27, k33, k39, k45 }, \ + { k04, k10, k16, k22, k28, k34, k40, k46 }, \ + { k05, k11, k17, k23, k29, k35, k41, k47 } \ +} diff --git a/keyboards/handwired/k8split/keymaps/default/keymap.c b/keyboards/handwired/k8split/keymaps/default/keymap.c new file mode 100644 index 0000000000..84dc7498cc --- /dev/null +++ b/keyboards/handwired/k8split/keymaps/default/keymap.c @@ -0,0 +1,33 @@ +/* +Copyright 2020 Ckat + +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 + +/* DEBUG + default map is strictly for debugging shorts + flash either the left or right keymap accordingly */ + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [0] = LAYOUT( + KC_0, KC_5, KC_0, KC_5, KC_0, KC_5, KC_0, KC_5, + KC_1, KC_4, KC_1, KC_4, KC_1, KC_4, KC_1, KC_4, + KC_2, KC_3, KC_2, KC_3, KC_2, KC_3, KC_2, KC_3, + KC_3, KC_2, KC_3, KC_2, KC_3, KC_2, KC_3, KC_2, + KC_4, KC_1, KC_4, KC_1, KC_4, KC_1, KC_4, KC_1, + KC_5, KC_0, KC_5, KC_0, KC_5, KC_0, KC_5, KC_0 + ) +}; diff --git a/keyboards/handwired/k8split/keymaps/left/config.h b/keyboards/handwired/k8split/keymaps/left/config.h new file mode 100644 index 0000000000..968a6eb413 --- /dev/null +++ b/keyboards/handwired/k8split/keymaps/left/config.h @@ -0,0 +1,21 @@ +/* +Copyright 2020 Ckat + +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 + +/* ensure NKRO is on */ +#define FORCE_NKRO diff --git a/keyboards/handwired/k8split/keymaps/left/keymap.c b/keyboards/handwired/k8split/keymaps/left/keymap.c new file mode 100644 index 0000000000..473a3b9f76 --- /dev/null +++ b/keyboards/handwired/k8split/keymaps/left/keymap.c @@ -0,0 +1,47 @@ +/* +Copyright 2020 Ckat + +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 + +#define KC_AUDIO_MMUTE KC_F20 +#define KC_COMP KC_APP + +/* LEFT + +---------------------------------------+ + | ESC| F1 | F2 | F3 | F4 | F5 | F6 |MUTE| + +---------------------------------------| + | ` | 1 | 2 | 3 | 4 | 5 | 6 |MMIC| + +-----------------------------------------+ + | TAB | q | w | e | r | t | JP | MWU| + +------------------------------------------+ + | CTRL | a | s | d | f | g |COMP| MWD| + +---------------------------------------------| + | SHIFT | z | x | c | v | b | F13| F14| + +-------------------------------------------------+ + | CTRL |CAPS|SUPR| ALT | SPACE | F15| F16| F17| + +-------------------------------------------------+ */ + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [0] = LAYOUT( + KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_AUDIO_MUTE, + KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_AUDIO_MMUTE, + KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_MHEN, KC_MS_WH_UP, + KC_LCTRL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_COMP, KC_MS_WH_DOWN, + KC_LSHIFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_F13, KC_F14, + KC_LCTRL, KC_CAPS, KC_LWIN, KC_LALT, KC_SPC, KC_F15, KC_F16, KC_F17 + ) +}; diff --git a/keyboards/handwired/k8split/keymaps/right/config.h b/keyboards/handwired/k8split/keymaps/right/config.h new file mode 100644 index 0000000000..968a6eb413 --- /dev/null +++ b/keyboards/handwired/k8split/keymaps/right/config.h @@ -0,0 +1,21 @@ +/* +Copyright 2020 Ckat + +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 + +/* ensure NKRO is on */ +#define FORCE_NKRO diff --git a/keyboards/handwired/k8split/keymaps/right/keymap.c b/keyboards/handwired/k8split/keymaps/right/keymap.c new file mode 100644 index 0000000000..3c804f2cae --- /dev/null +++ b/keyboards/handwired/k8split/keymaps/right/keymap.c @@ -0,0 +1,45 @@ +/* +Copyright 2020 Ckat + +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 + +/* RIGHT + +---------------------------------------+ + | F7 | F8 | F9 | F10| F11| F12| INS|PSCR| + +--------------------------------------------| + | DEL| 7 | 8 | 9 | 0 | - | = | BCKSPC | + +--------------------------------------------| + | y | u | i | o | p | [ | ] | \ | + +---------------------------------------------| + |PGUP| h | j | k | l | ; | ' | ENTER | + +-----------------------------------------------| + |HOME|PGDN| n | m | , | . | / | SHIFT | + +-------------------------------------------------+ + | END| SPACE | ALT | <- | ↓ | ↑ | -> | CTRL | + +-------------------------------------------------+ */ + +/* /!\: rows are reversed in this half because I did all pcb design drunk */ +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [0] = LAYOUT( + KC_END, KC_SPC, KC_RALT, KC_LEFT, KC_DOWN, KC_UP, KC_RIGHT, KC_RCTRL, + KC_HOME, KC_PGDN, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSHIFT, + KC_PGUP, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENTER, + KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, + KC_DEL, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, + KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_INS, KC_PSCR + ) +}; diff --git a/keyboards/handwired/k8split/rules.mk b/keyboards/handwired/k8split/rules.mk new file mode 100644 index 0000000000..3c7b0282c5 --- /dev/null +++ b/keyboards/handwired/k8split/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 = atmel-dfu + +# 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 = yes # USB Nkey Rollover +BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality +RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow +MIDI_ENABLE = no # MIDI support +BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID +AUDIO_ENABLE = no # Audio output +FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches