From 3cc037d8d86a148a8a61e594ad87766f9d0ddbd5 Mon Sep 17 00:00:00 2001 From: obosob Date: Thu, 24 Jun 2021 03:51:15 +0100 Subject: [PATCH] Add "steal this keyboard" keybaord (#12898) --- keyboards/steal_this_keyboard/config.h | 67 ++++++++++++++ keyboards/steal_this_keyboard/info.json | 54 +++++++++++ .../keymaps/default/config.h | 39 ++++++++ .../keymaps/default/keymap.c | 92 +++++++++++++++++++ keyboards/steal_this_keyboard/readme.md | 11 +++ keyboards/steal_this_keyboard/rules.mk | 24 +++++ .../steal_this_keyboard/steal_this_keyboard.c | 16 ++++ .../steal_this_keyboard/steal_this_keyboard.h | 46 ++++++++++ 8 files changed, 349 insertions(+) create mode 100644 keyboards/steal_this_keyboard/config.h create mode 100644 keyboards/steal_this_keyboard/info.json create mode 100644 keyboards/steal_this_keyboard/keymaps/default/config.h create mode 100644 keyboards/steal_this_keyboard/keymaps/default/keymap.c create mode 100644 keyboards/steal_this_keyboard/readme.md create mode 100644 keyboards/steal_this_keyboard/rules.mk create mode 100644 keyboards/steal_this_keyboard/steal_this_keyboard.c create mode 100644 keyboards/steal_this_keyboard/steal_this_keyboard.h diff --git a/keyboards/steal_this_keyboard/config.h b/keyboards/steal_this_keyboard/config.h new file mode 100644 index 00000000000..ea637d0c2f7 --- /dev/null +++ b/keyboards/steal_this_keyboard/config.h @@ -0,0 +1,67 @@ +/* Copyright 2021 Obosob + +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 0xC2AB +#define PRODUCT_ID 0x50AD +#define DEVICE_VER 0x0001 +#define MANUFACTURER Obosob +#define PRODUCT Steal This Keyboard! + +/* key matrix size */ +#define MATRIX_ROWS 8 +#define MATRIX_COLS 5 + +/* + * 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) + * NO_DIODE = switches are directly connected to AVR pins + * +*/ +#define DIRECT_PINS { \ + { F4, F7, B2, D1, D7 }, \ + { F5, B1, B6, D0, E6 }, \ + { F6, B3, D3, D4, B4 }, \ + { C6, B5, NO_PIN, NO_PIN, NO_PIN } \ +} + +#define DIRECT_PINS_RIGHT { \ + { D7, D1, B2, F7, F4}, \ + { E6, D0, B6, B1, F5 }, \ + { B4, D4, D3, B3, F6 }, \ + { B5, C6, NO_PIN, NO_PIN, NO_PIN } \ +} + +#define UNUSED_PINS + +/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */ +#define DEBOUNCE 5 + +/* Serial settings */ +#define USE_SERIAL +/* serial.c configuration for split keyboard */ +#define SOFT_SERIAL_PIN D2 + +#define EE_HANDS diff --git a/keyboards/steal_this_keyboard/info.json b/keyboards/steal_this_keyboard/info.json new file mode 100644 index 00000000000..4c2be48e92c --- /dev/null +++ b/keyboards/steal_this_keyboard/info.json @@ -0,0 +1,54 @@ +{ + "keyboard_name": "steal this keyboard", + "url": "https://github.com/obosob/steal_this_keyboard", + "maintainer": "@obosob", + "width": 12, + "height": 4.75, + "layouts": { + "LAYOUT": { + "layout": [ + {"x": 0, "y": 0.93}, + {"x": 1, "y": 0.31}, + {"x": 2, "y": 0}, + {"x": 3, "y": 0.28}, + {"x": 4, "y": 0.42}, + + {"x": 7, "y": 0.42}, + {"x": 8, "y": 0.28}, + {"x": 9, "y": 0}, + {"x": 10, "y": 0.31}, + {"x": 11, "y": 0.93}, + + {"x": 0, "y": 1.93}, + {"x": 1, "y": 1.31}, + {"x": 2, "y": 1}, + {"x": 3, "y": 1.28}, + {"x": 4, "y": 1.42}, + + {"x": 7, "y": 1.42}, + {"x": 8, "y": 1.28}, + {"x": 9, "y": 1}, + {"x": 10, "y": 1.31}, + {"x": 11, "y": 1.93}, + + {"x": 0, "y": 2.93}, + {"x": 1, "y": 2.31}, + {"x": 2, "y": 2}, + {"x": 3, "y": 2.28}, + {"x": 4, "y": 2.42}, + + {"x": 7, "y": 2.42}, + {"x": 8, "y": 2.28}, + {"x": 9, "y": 2}, + {"x": 10, "y": 2.31}, + {"x": 11, "y": 2.93}, + + {"x": 3.5, "y": 3.75}, + {"x": 4.5, "y": 4}, + + {"x": 6.5, "y": 4}, + {"x": 7.5, "y": 3.75} + ] + } + } +} diff --git a/keyboards/steal_this_keyboard/keymaps/default/config.h b/keyboards/steal_this_keyboard/keymaps/default/config.h new file mode 100644 index 00000000000..14ec0792b1a --- /dev/null +++ b/keyboards/steal_this_keyboard/keymaps/default/config.h @@ -0,0 +1,39 @@ +/* +Copyright 2021 Obosob + +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 +// Set the mouse settings to a comfortable speed/accuracy trade-off, +// assuming a screen refresh rate of 60 Htz or higher +// The default is 50. This makes the mouse ~3 times faster and more accurate +#define MOUSEKEY_INTERVAL 16 +// The default is 20. Since we made the mouse about 3 times faster with the previous setting, +// give it more time to accelerate to max speed to retain precise control over short distances. +#define MOUSEKEY_TIME_TO_MAX 40 +// The default is 300. Let's try and make this as low as possible while keeping the cursor responsive +#define MOUSEKEY_DELAY 100 +// It makes sense to use the same delay for the mouseweel +#define MOUSEKEY_WHEEL_DELAY 100 +// The default is 100 +#define MOUSEKEY_WHEEL_INTERVAL 50 +// The default is 40 +#define MOUSEKEY_WHEEL_TIME_TO_MAX 100 + +// Pick good defaults for enabling homerow modifiers +#define TAPPING_TERM 200 +#define PERMISSIVE_HOLD +#define IGNORE_MOD_TAP_INTERRUPT +#define TAPPING_FORCE_HOLD diff --git a/keyboards/steal_this_keyboard/keymaps/default/keymap.c b/keyboards/steal_this_keyboard/keymaps/default/keymap.c new file mode 100644 index 00000000000..32834c16b10 --- /dev/null +++ b/keyboards/steal_this_keyboard/keymaps/default/keymap.c @@ -0,0 +1,92 @@ +/* Copyright 2021 Obosob + +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 HM_A LSFT_T(KC_A) +#define HM_S LT(5,KC_S) +#define HM_D LT(1,KC_D) +#define HM_F LT(3,KC_F) + +#define HM_J LT(4,KC_J) +#define HM_K LT(2,KC_K) +#define HM_L LT(6,KC_L) +#define HM_SCLN LSFT_T(KC_SCLN) + +#define MT_X LCTL_T(KC_X) +#define MT_C LALT_T(KC_C) +#define MT_SPC LT(7,KC_SPC) +#define MT_COMM LALT_T(KC_COMM) +#define MT_DOT LCTL_T(KC_DOT) + +#define CTL_ALT LCTL(KC_LALT) +#define CT_AL_S LCA(KC_LSFT) + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [0] = LAYOUT_split_3x5_2( +KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, +HM_A, HM_S, HM_D, HM_F, KC_G, KC_H, HM_J, HM_K, HM_L, HM_SCLN, +KC_Z, MT_X, MT_C, KC_V, KC_B, KC_N, KC_M, MT_COMM, MT_DOT, KC_SLSH, + KC_P0, KC_BSPC, MT_SPC, KC_P1 + ), + [1] = LAYOUT_split_3x5_2( +_______, _______, _______, _______, _______, _______, KC_BTN1, KC_WH_U, KC_BTN2, _______, +_______, KC_BTN2, XXXXXXX, KC_BTN1, _______, _______, KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, +_______, _______, _______, _______, _______, _______, KC_WH_L, KC_WH_D, KC_WH_R, _______, + _______, _______, _______, _______ + ), + [2] = LAYOUT_split_3x5_2( +_______, _______, KC_PGUP, _______, _______, _______, _______, _______, _______, _______, +KC_LEFT, KC_UP, KC_DOWN, KC_RGHT, _______, _______, KC_LGUI, XXXXXXX, CTL_ALT, CT_AL_S, +_______, KC_HOME, KC_PGDN, KC_END, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______ + ), + [3] = LAYOUT_split_3x5_2( +_______, _______, _______, _______, _______, _______, KC_UNDS, KC_PIPE, KC_QUOT, _______, +KC_CIRC, KC_ASTR, KC_AMPR, XXXXXXX, _______, KC_HASH, KC_TILD, KC_SLSH, KC_DQUO, KC_DLR, +_______, _______, _______, _______, _______, _______, KC_MINS, KC_BSLS, KC_GRV, _______, + _______, _______, _______, _______ + ), + [4] = LAYOUT_split_3x5_2( +_______, KC_COLN, KC_LT, KC_GT, KC_SCLN, _______, _______, _______, _______, _______, +KC_LCBR, KC_RCBR, KC_LPRN, KC_RPRN, KC_AT, _______, XXXXXXX, KC_EQL, KC_PLUS, KC_PERC, +_______, KC_EXLM, KC_LBRC, KC_RBRC, _______, _______, _______, _______, _______, _______, + KC_VOLD, _______, _______, KC_VOLU + ), + [5] = LAYOUT_split_3x5_2( +_______, _______, _______, _______, _______, _______, KC_F7, KC_F8, KC_F9, KC_F10, +_______, XXXXXXX, CTL_ALT, _______, _______, _______, KC_F4, KC_F5, KC_F6, KC_F11, +_______, _______, _______, _______, _______, _______, KC_F1, KC_F2, KC_F3, KC_F12, + _______, _______, _______, _______ + ), + [6] = LAYOUT_split_3x5_2( +KC_PSLS, KC_7, KC_8, KC_9, KC_PPLS, _______, _______, _______, _______, _______, +KC_0, KC_1, KC_2, KC_3, KC_PMNS, _______, _______, _______, XXXXXXX, _______, +KC_PAST, KC_4, KC_5, KC_6, KC_PEQL, _______, _______, _______, _______, _______, + _______, _______, _______, _______ + ), +#undef MT_COMM +#define MT_COMM RALT_T(KC_COMM) +#undef MT_DOT +#define MT_DOT RCTL_T(KC_DOT) + [7] = LAYOUT_split_3x5_2( +_______, _______, KC_COLN, KC_ESC, _______, _______, _______, _______, _______, KC_DEL, +_______, KC_PERC, KC_SLSH, KC_ENT, _______, DF(1), KC_LGUI, _______, _______, _______, +_______, _______, _______, KC_EXLM, _______, DF(0), _______, MT_COMM, MT_DOT, RESET, + _______, KC_TAB, XXXXXXX, _______ + ) +}; + diff --git a/keyboards/steal_this_keyboard/readme.md b/keyboards/steal_this_keyboard/readme.md new file mode 100644 index 00000000000..395487f7b30 --- /dev/null +++ b/keyboards/steal_this_keyboard/readme.md @@ -0,0 +1,11 @@ +# steal this keyboard! + +A split 34 keys column staggered keyboard named and decorated after the System of a Down album Steal This Album. All PCB files are available on the [project's github page](https://github.com/obosob/steal_this_keyboard) + +* Keyboard Maintainer: [Obosob](https://github.com/obosob) + +Make examples for this keyboard (after setting up your build environment): + + make steal_this_keyboard: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/steal_this_keyboard/rules.mk b/keyboards/steal_this_keyboard/rules.mk new file mode 100644 index 00000000000..ce4d52156d3 --- /dev/null +++ b/keyboards/steal_this_keyboard/rules.mk @@ -0,0 +1,24 @@ +# MCU name +MCU = atmega32u4 + +# Bootloader selection +BOOTLOADER = caterina + +# 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 = no # USB Nkey Rollover +BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality +RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow +UNICODE_ENABLE = yes # Unicode +BLUETOOTH_ENABLE = no # Enable Bluetooth +AUDIO_ENABLE = no # Audio output +SPLIT_KEYBOARD = yes # Use shared split_common code diff --git a/keyboards/steal_this_keyboard/steal_this_keyboard.c b/keyboards/steal_this_keyboard/steal_this_keyboard.c new file mode 100644 index 00000000000..cd5ef5cddac --- /dev/null +++ b/keyboards/steal_this_keyboard/steal_this_keyboard.c @@ -0,0 +1,16 @@ +/* Copyright 2021 Obosob + * + * 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 "steal_this_keyboard.h" diff --git a/keyboards/steal_this_keyboard/steal_this_keyboard.h b/keyboards/steal_this_keyboard/steal_this_keyboard.h new file mode 100644 index 00000000000..af7204f5409 --- /dev/null +++ b/keyboards/steal_this_keyboard/steal_this_keyboard.h @@ -0,0 +1,46 @@ +/* Copyright 2021 Obosob + * + * 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 "quantum.h" + +/* This 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. + */ + +// readability +#define ___ KC_NO + +#define LAYOUT_split_3x5_2( \ + L01, L02, L03, L04, L05, R01, R02, R03, R04, R05, \ + L06, L07, L08, L09, L10, R06, R07, R08, R09, R10, \ + L11, L12, L13, L14, L15, R11, R12, R13, R14, R15, \ + L16, L17, R16, R17 \ + ) \ + { \ + { L01, L02, L03, L04, L05 }, \ + { L06, L07, L08, L09, L10 }, \ + { L11, L12, L13, L14, L15 }, \ + { L16, L17, ___, ___ , ___}, \ + { R01, R02, R03, R04, R05 }, \ + { R06, R07, R08, R09, R10 }, \ + { R11, R12, R13, R14, R15 }, \ + { R16, R17, ___, ___, ___ } \ + }