From 788b1854b42a916919c3e8efc77b366ba03d2d8c Mon Sep 17 00:00:00 2001 From: icesoup Date: Sun, 7 Mar 2021 02:03:48 +0500 Subject: [PATCH] [Keyboard] add Soup10 support (#11921) Co-authored-by: Joel Challis Co-authored-by: Ryan --- keyboards/soup10/config.h | 153 +++++++++++++++++++++ keyboards/soup10/info.json | 23 ++++ keyboards/soup10/keymaps/default/keymap.c | 36 +++++ keyboards/soup10/keymaps/default/readme.md | 1 + keyboards/soup10/keymaps/via/keymap.c | 44 ++++++ keyboards/soup10/keymaps/via/rules.mk | 1 + keyboards/soup10/readme.md | 19 +++ keyboards/soup10/rules.mk | 23 ++++ keyboards/soup10/soup10.c | 17 +++ keyboards/soup10/soup10.h | 39 ++++++ 10 files changed, 356 insertions(+) create mode 100644 keyboards/soup10/config.h create mode 100644 keyboards/soup10/info.json create mode 100644 keyboards/soup10/keymaps/default/keymap.c create mode 100644 keyboards/soup10/keymaps/default/readme.md create mode 100644 keyboards/soup10/keymaps/via/keymap.c create mode 100644 keyboards/soup10/keymaps/via/rules.mk create mode 100644 keyboards/soup10/readme.md create mode 100644 keyboards/soup10/rules.mk create mode 100644 keyboards/soup10/soup10.c create mode 100644 keyboards/soup10/soup10.h diff --git a/keyboards/soup10/config.h b/keyboards/soup10/config.h new file mode 100644 index 0000000000..83fb2dd895 --- /dev/null +++ b/keyboards/soup10/config.h @@ -0,0 +1,153 @@ +/* +Copyright 2021 icesoup + +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 0x5375 +#define PRODUCT_ID 0x0001 +#define DEVICE_VER 0x0001 +#define MANUFACTURER icesoup +#define PRODUCT soup10 + +/* key matrix size */ +#define MATRIX_ROWS 4 +#define MATRIX_COLS 3 + +/* + * 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) + * + */ +// 0 1 2 3 +#define MATRIX_ROW_PINS { D1, D0, D4, C6 } +#define MATRIX_COL_PINS { D7, E6, B4 } +#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 E2 +//#ifdef RGB_DI_PIN +//# define RGBLED_NUM 16 +//# 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 1 diff --git a/keyboards/soup10/info.json b/keyboards/soup10/info.json new file mode 100644 index 0000000000..d2688fe511 --- /dev/null +++ b/keyboards/soup10/info.json @@ -0,0 +1,23 @@ +{ + "keyboard_name": "Soup10", + "url": "https://github.com/Sadeeed/soup10", + "maintainer": "Sadeeed", + "width": 3, + "height": 4, + "layouts": { + "LAYOUT": { + "layout": [ + {"label":"K01 (D1,E6)", "x":1, "y":0}, + {"label":"K10 (D0,D7)", "x":0, "y":1}, + {"label":"K11 (D0,E6)", "x":1, "y":1}, + {"label":"K12 (D0,B4)", "x":2, "y":1}, + {"label":"K20 (D4,D7)", "x":0, "y":2}, + {"label":"K21 (D4,E6)", "x":1, "y":2}, + {"label":"K22 (D4,B4)", "x":2, "y":2}, + {"label":"K30 (C6,D7)", "x":0, "y":3}, + {"label":"K31 (C6,E6)", "x":1, "y":3}, + {"label":"K32 (C6,B4)", "x":2, "y":3} + ] + } + } +} diff --git a/keyboards/soup10/keymaps/default/keymap.c b/keyboards/soup10/keymaps/default/keymap.c new file mode 100644 index 0000000000..5379a15095 --- /dev/null +++ b/keyboards/soup10/keymaps/default/keymap.c @@ -0,0 +1,36 @@ +/* Copyright 2021 icesoup + * + * 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 + +// Defines names for use in layer keycodes and the keymap +enum layer_names { + _BASE, + _FN +}; +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + /* Base */ + [_BASE] = LAYOUT( + KC_F13, + KC_F14, KC_F15, KC_F16, + KC_F17, KC_F18, KC_F19, + KC_F20, KC_F21, MO(_FN)), + + [_FN] = LAYOUT( + RESET, + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS) +}; diff --git a/keyboards/soup10/keymaps/default/readme.md b/keyboards/soup10/keymaps/default/readme.md new file mode 100644 index 0000000000..5daae6fdb9 --- /dev/null +++ b/keyboards/soup10/keymaps/default/readme.md @@ -0,0 +1 @@ +# The default keymap for soup10 diff --git a/keyboards/soup10/keymaps/via/keymap.c b/keyboards/soup10/keymaps/via/keymap.c new file mode 100644 index 0000000000..30809c0ed2 --- /dev/null +++ b/keyboards/soup10/keymaps/via/keymap.c @@ -0,0 +1,44 @@ +/* Copyright 2021 icesoup + * + * 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] = { + /* Base */ + [0] = LAYOUT( + KC_A, + KC_B, KC_C, KC_D, + KC_E, KC_F, KC_G, + KC_H, KC_I, KC_J), + + [1] = LAYOUT( + KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS), + + [2] = LAYOUT( + KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS), + + [3] = LAYOUT( + KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS) + +}; diff --git a/keyboards/soup10/keymaps/via/rules.mk b/keyboards/soup10/keymaps/via/rules.mk new file mode 100644 index 0000000000..036bd6d1c3 --- /dev/null +++ b/keyboards/soup10/keymaps/via/rules.mk @@ -0,0 +1 @@ +VIA_ENABLE = yes \ No newline at end of file diff --git a/keyboards/soup10/readme.md b/keyboards/soup10/readme.md new file mode 100644 index 0000000000..e9de91cd15 --- /dev/null +++ b/keyboards/soup10/readme.md @@ -0,0 +1,19 @@ +# soup10 + +![soup10](https://i.imgur.com/YIMB3kKl.jpg) + +A 4x3 10 key macropad by Sadeed aka icesoup + +* Keyboard Maintainer: [icesoup](https://github.com/Sadeeed) +* Hardware Supported: Pro Micro +* Hardware Availability: [Repository](https://github.com/Sadeeed/Soup10) + +Make example for this keyboard (after setting up your build environment): + + make soup10:default + +Flashing example for this keyboard: + + make soup10: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/soup10/rules.mk b/keyboards/soup10/rules.mk new file mode 100644 index 0000000000..df0fd4dcba --- /dev/null +++ b/keyboards/soup10/rules.mk @@ -0,0 +1,23 @@ +# MCU name +MCU = atmega32u4 + +# Bootloader selection +BOOTLOADER = caterina + +# Build Options +# change yes to no to disable +# +BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration +MOUSEKEY_ENABLE = no # 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 +BLUETOOTH_ENABLE = no # Enable Bluetooth +AUDIO_ENABLE = no # Audio output +LTO_ENABLE = yes diff --git a/keyboards/soup10/soup10.c b/keyboards/soup10/soup10.c new file mode 100644 index 0000000000..c08681392a --- /dev/null +++ b/keyboards/soup10/soup10.c @@ -0,0 +1,17 @@ +/* Copyright 2021 icesoup + * + * 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 "soup10.h" diff --git a/keyboards/soup10/soup10.h b/keyboards/soup10/soup10.h new file mode 100644 index 0000000000..b4a2c14568 --- /dev/null +++ b/keyboards/soup10/soup10.h @@ -0,0 +1,39 @@ +/* Copyright 2021 icesoup + * + * 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( \ + K01, \ + K10, K11, K12, \ + K20, K21, K22, \ + K30, K31, K32 \ +) { \ + { KC_NO, K01, KC_NO }, \ + { K10, K11, K12 }, \ + { K20, K21, K22 }, \ + { K30, K31, K32 } \ +}