From 16d6fd6e8ec8e6423b600459298797c2f14f9647 Mon Sep 17 00:00:00 2001 From: Yan-Fa Li Date: Mon, 6 Aug 2018 08:40:00 -0700 Subject: [PATCH] Keyboard: Add Catch 22 Hotswap Macropad to QMK (#3576) * Initial Commit of catch22 macropad by rockydbull * Add configurator info.json * Use macros * Use pragma once * Use CA22 as product id * Clean up readme * Use the layer define value * Feedback from @drashna --- keyboards/catch22/README.md | 17 ++++++ keyboards/catch22/catch22.c | 18 +++++++ keyboards/catch22/catch22.h | 33 ++++++++++++ keyboards/catch22/config.h | 56 ++++++++++++++++++++ keyboards/catch22/info.json | 10 ++++ keyboards/catch22/keymaps/default/keymap.c | 31 +++++++++++ keyboards/catch22/rules.mk | 60 ++++++++++++++++++++++ 7 files changed, 225 insertions(+) create mode 100644 keyboards/catch22/README.md create mode 100644 keyboards/catch22/catch22.c create mode 100644 keyboards/catch22/catch22.h create mode 100644 keyboards/catch22/config.h create mode 100644 keyboards/catch22/info.json create mode 100644 keyboards/catch22/keymaps/default/keymap.c create mode 100644 keyboards/catch22/rules.mk diff --git a/keyboards/catch22/README.md b/keyboards/catch22/README.md new file mode 100644 index 0000000000..8d4a22398f --- /dev/null +++ b/keyboards/catch22/README.md @@ -0,0 +1,17 @@ +# Catch 22 Budget Hotswap Macropad + +GB by /u/rockydbull run in July 2018, PCB designed with help from /u/Kilgarah. + +Designed to be a budget project board to enjoy hotswapping/switch testing/macro making fun. The board is controlled by a pro micro clone made famous by other projects like the lets split, iris, and nyquist and allows for full QMK implementation. Each Catch22 kit will contain: + + * 2 pcbs (one to solder to and one to be a base)(green color) + * 1 pcb material switch plate( green color) with cut out for pcb mount cherry stabilizers + * 40 throughhole diodes (22 for the pcb and the remaining as extras in case you lose one and to use to make the pro micro removeable without desoldering) + * 22 Kailh hotswap sockets + * 1 smd reset button + * 1 dip socket to mount between the pcb and pro micro if you choose to make it removeable without desoldering + * 5 (12mm) m2 standoffs + * 10 m2 screws + * Genuine Cherry pcb mount 2u stabilizer + * 4 rubber bumpons + * Pro Micro is included in kit diff --git a/keyboards/catch22/catch22.c b/keyboards/catch22/catch22.c new file mode 100644 index 0000000000..11a983936e --- /dev/null +++ b/keyboards/catch22/catch22.c @@ -0,0 +1,18 @@ +/* +Copyright 2018 QMK Community + +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 "catch22.h" diff --git a/keyboards/catch22/catch22.h b/keyboards/catch22/catch22.h new file mode 100644 index 0000000000..6eefb9cd51 --- /dev/null +++ b/keyboards/catch22/catch22.h @@ -0,0 +1,33 @@ +/* +Copyright 2018 QMK Community + +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( \ + K01, K02, K03, K04, \ + K11, K12, K13, K14, \ +K20, K21, K22, K23, K24, \ +K30, K31, K32, K33, K34, \ + K41, K42, K43, K44 \ +) { \ + { KC_NO, K01, K02, K03, K04 }, \ + { KC_NO, K11, K12, K13, K14 }, \ + { K20, K21, K22, K23, K24 }, \ + { K30, K31, K32, K33, K34 }, \ + { KC_NO, K41, K42, K43, K44 }, \ +} diff --git a/keyboards/catch22/config.h b/keyboards/catch22/config.h new file mode 100644 index 0000000000..cb7ca7d84c --- /dev/null +++ b/keyboards/catch22/config.h @@ -0,0 +1,56 @@ +/* +Copyright 2018 QMK Contributors + +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 0xCA22 +#define DEVICE_VER 0x0001 +#define MANUFACTURER rockydbull +#define PRODUCT Catch22 Hotswap Macropad +#define DESCRIPTION Budget 22 Key Hotswap Macropad + +/* key matrix size */ +#define MATRIX_ROWS 5 +#define MATRIX_COLS 5 + +/* key matrix pins */ +#define MATRIX_ROW_PINS { B6, B2, B3, B1, F7 } +#define MATRIX_COL_PINS { B5, B4, E6, D7, C6 } +#define UNUSED_PINS { } + +/* COL2ROW or ROW2COL */ +#define DIODE_DIRECTION COL2ROW + +/* Set 0 if debouncing isn't needed */ +#define DEBOUNCING_DELAY 50 + +/* key combination for command */ +#define IS_COMMAND() ( \ + false \ +) + +/* prevent stuck modifiers */ +#define PREVENT_STUCK_MODIFIERS + +#ifdef RGBLIGHT_ENABLE +#define RGB_DI_PIN F6 +#define RGBLIGHT_ANIMATIONS +#define RGBLED_NUM 6 +#endif diff --git a/keyboards/catch22/info.json b/keyboards/catch22/info.json new file mode 100644 index 0000000000..eb95b8561d --- /dev/null +++ b/keyboards/catch22/info.json @@ -0,0 +1,10 @@ +{ + "keyboard_name": "catch22", + "width": 5, + "height": 5, + "layouts": { + "LAYOUT": { + "layout": [{"label":"A", "x":1, "y":0}, {"label":"B", "x":2, "y":0}, {"label":"C", "x":3, "y":0}, {"label":"D", "x":4, "y":0}, {"label":"E", "x":1, "y":1}, {"label":"F", "x":2, "y":1}, {"label":"G", "x":3, "y":1}, {"label":"H", "x":4, "y":1}, {"label":"I", "x":0, "y":2}, {"label":"J", "x":1, "y":2}, {"label":"K", "x":2, "y":2}, {"label":"L", "x":3, "y":2}, {"label":"M", "x":4, "y":2}, {"label":"1", "x":0, "y":3, "h":2}, {"label":"N", "x":1, "y":3}, {"label":"O", "x":2, "y":3}, {"label":"P", "x":3, "y":3}, {"label":"Q", "x":4, "y":3}, {"label":"R", "x":1, "y":4}, {"label":"S", "x":2, "y":4}, {"label":"T", "x":3, "y":4}, {"label":"U", "x":4, "y":4}] + } + } +} diff --git a/keyboards/catch22/keymaps/default/keymap.c b/keyboards/catch22/keymaps/default/keymap.c new file mode 100644 index 0000000000..f0300d27fe --- /dev/null +++ b/keyboards/catch22/keymaps/default/keymap.c @@ -0,0 +1,31 @@ +#include QMK_KEYBOARD_H + +#define _BASE 0 +#define _FN 1 + +#define _______ KC_TRNS + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { +[_BASE] = LAYOUT( /* Base */ + KC_A, KC_B, KC_C, KC_D, \ + KC_E, KC_F, KC_G, KC_H, \ + MO(_FN), KC_I, KC_J, KC_K, KC_L, \ + KC_1, KC_M, KC_N, KC_O, KC_P, \ + KC_Q, KC_R, KC_S, KC_T \ +), +[_FN] = LAYOUT( + RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUI, \ + _______, _______, _______, _______, \ + _______, _______, _______, _______, _______, \ + KC_2, _______, _______, _______, _______, \ + _______, _______, _______, _______ \ +), +}; + +const uint16_t PROGMEM fn_actions[] = { +}; + +const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) // MACRODOWN only works in this function +{ + return MACRO_NONE; +}; diff --git a/keyboards/catch22/rules.mk b/keyboards/catch22/rules.mk new file mode 100644 index 0000000000..2b76e465cf --- /dev/null +++ b/keyboards/catch22/rules.mk @@ -0,0 +1,60 @@ +# 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) + +# Bootloader +BOOTLOADER = caterina + +# Interrupt driven control endpoint task(+60) +OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT + + +# Boot Section Size in *bytes* +#OPT_DEFS += -DBOOTLOADER_SIZE=4096 + + +# Build Options +# comment out to disable the options. +# +BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000) +MOUSEKEY_ENABLE = no # Mouse keys(+4700) +EXTRAKEY_ENABLE = no # Audio control and System control(+450) +CONSOLE_ENABLE = yes # Console for debug(+400) +COMMAND_ENABLE = yes # Commands for debug and configuration +SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend +NKRO_ENABLE = no # USB Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work +BACKLIGHT_ENABLE = no # Custom backlighting code is used, so this should not be enabled +AUDIO_ENABLE = no # This can be enabled if a speaker is connected to the expansion port. Not compatible with RGBLIGHT below +RGBLIGHT_ENABLE = yes # This can be enabled if a ws2812 strip is connected to the expansion port. +