From 605de079583db1f1106ebfd239b948170d929a58 Mon Sep 17 00:00:00 2001 From: Will McGloughlin <3410869+wymcg@users.noreply.github.com> Date: Tue, 14 Dec 2021 21:52:10 -0500 Subject: [PATCH] [Keyboard] Add pluto12 (#15369) Co-authored-by: Drashna Jaelre Co-authored-by: Ryan --- keyboards/psuieee/pluto12/config.h | 138 ++++++++++++++++++ keyboards/psuieee/pluto12/info.json | 23 +++ .../psuieee/pluto12/keymaps/default/keymap.c | 23 +++ .../psuieee/pluto12/keymaps/default/readme.md | 1 + keyboards/psuieee/pluto12/pluto12.c | 4 + keyboards/psuieee/pluto12/pluto12.h | 24 +++ keyboards/psuieee/pluto12/readme.md | 27 ++++ keyboards/psuieee/pluto12/rules.mk | 18 +++ 8 files changed, 258 insertions(+) create mode 100644 keyboards/psuieee/pluto12/config.h create mode 100644 keyboards/psuieee/pluto12/info.json create mode 100644 keyboards/psuieee/pluto12/keymaps/default/keymap.c create mode 100644 keyboards/psuieee/pluto12/keymaps/default/readme.md create mode 100644 keyboards/psuieee/pluto12/pluto12.c create mode 100644 keyboards/psuieee/pluto12/pluto12.h create mode 100644 keyboards/psuieee/pluto12/readme.md create mode 100644 keyboards/psuieee/pluto12/rules.mk diff --git a/keyboards/psuieee/pluto12/config.h b/keyboards/psuieee/pluto12/config.h new file mode 100644 index 0000000000..60d3f0a501 --- /dev/null +++ b/keyboards/psuieee/pluto12/config.h @@ -0,0 +1,138 @@ +// Copyright 2021 Willem McGloughlin (wymcg) +// SPDX-License-Identifier: GPL-2.0-or-later + +#pragma once + +#include "config_common.h" + +/* USB Device descriptor parameter */ +#define VENDOR_ID 0x4747 +#define PRODUCT_ID 0x7012 +#define DEVICE_VER 0x0001 +#define MANUFACTURER psuieee +#define PRODUCT pluto12 + +/* key matrix size */ +#define MATRIX_ROWS 3 +#define MATRIX_COLS 4 + +/* + * 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 { D0, D4, C6 } +#define MATRIX_COL_PINS { D7, E6, B4, B5 } +#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 0 diff --git a/keyboards/psuieee/pluto12/info.json b/keyboards/psuieee/pluto12/info.json new file mode 100644 index 0000000000..a48b687fb1 --- /dev/null +++ b/keyboards/psuieee/pluto12/info.json @@ -0,0 +1,23 @@ +{ + "keyboard_name": "pluto12", + "url": "https://github.com/psuieee/pluto12", + "maintainer": "wymcg", + "layouts": { + "LAYOUT": { + "layout": [ + { "label": "M1", "x": 0, "y": 0 }, + { "label": "M2", "x": 1, "y": 0 }, + { "label": "M3", "x": 2, "y": 0 }, + { "label": "M4", "x": 3, "y": 0 }, + { "label": "M5", "x": 0, "y": 1 }, + { "label": "M6", "x": 1, "y": 1 }, + { "label": "M7", "x": 2, "y": 1 }, + { "label": "M8", "x": 3, "y": 1 }, + { "label": "M9", "x": 0, "y": 2 }, + { "label": "M10", "x": 1, "y": 2 }, + { "label": "M11", "x": 2, "y": 2 }, + { "label": "M12", "x": 3, "y": 2 } + ] + } + } +} diff --git a/keyboards/psuieee/pluto12/keymaps/default/keymap.c b/keyboards/psuieee/pluto12/keymaps/default/keymap.c new file mode 100644 index 0000000000..1c09c4fc83 --- /dev/null +++ b/keyboards/psuieee/pluto12/keymaps/default/keymap.c @@ -0,0 +1,23 @@ +// Copyright 2021 Will McGLoughlin (wymcg) +// SPDX-License-Identifier: GPL-2.0-or-later + +#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] = LAYOUT( + KC_PGUP, KC_MUTE, KC_VOLD, KC_VOLU, + KC_PGDN, KC_MPLY, KC_MPRV, KC_MNXT, + KC_NO, KC_HOME, KC_END, OSL(_FN) + ), + [_FN] = LAYOUT( + KC_F1, KC_F2, KC_F3, KC_F4, + KC_F5, KC_F6, KC_F7, KC_F8, + KC_F9, KC_F10, KC_F11, KC_F12 + ) +}; diff --git a/keyboards/psuieee/pluto12/keymaps/default/readme.md b/keyboards/psuieee/pluto12/keymaps/default/readme.md new file mode 100644 index 0000000000..8416c0fe61 --- /dev/null +++ b/keyboards/psuieee/pluto12/keymaps/default/readme.md @@ -0,0 +1 @@ +# The default keymap for pluto12 diff --git a/keyboards/psuieee/pluto12/pluto12.c b/keyboards/psuieee/pluto12/pluto12.c new file mode 100644 index 0000000000..c08911493c --- /dev/null +++ b/keyboards/psuieee/pluto12/pluto12.c @@ -0,0 +1,4 @@ +// Copyright 2021 Will McGloughlin (@wymcg) +// SPDX-License-Identifier: GPL-2.0-or-later + +#include "pluto12.h" diff --git a/keyboards/psuieee/pluto12/pluto12.h b/keyboards/psuieee/pluto12/pluto12.h new file mode 100644 index 0000000000..7a01de10f7 --- /dev/null +++ b/keyboards/psuieee/pluto12/pluto12.h @@ -0,0 +1,24 @@ +// Copyright 2021 Will McGloughlin (@wymcg) +// SPDX-License-Identifier: GPL-2.0-or-later + +#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( \ + K00, K01, K02, K03, \ + K10, K11, K12, K13, \ + K20, K21, K22, K23 \ +) { \ + {K00, K01, K02, K03}, \ + {K10, K11, K12, K13}, \ + {K20, K21, K22, K23} \ +} diff --git a/keyboards/psuieee/pluto12/readme.md b/keyboards/psuieee/pluto12/readme.md new file mode 100644 index 0000000000..bfdafb3b2d --- /dev/null +++ b/keyboards/psuieee/pluto12/readme.md @@ -0,0 +1,27 @@ +# pluto12 + +![pluto12](https://i.imgur.com/XYtwexoh.jpg) + +The pluto12 is a 4x3 macropad designed for use in the Penn State IEEE Student Chapter's [2021-22 workshop series](https://github.com/psuieee/projects2021). Designed by the 2021-22 Penn State IEEE Projects Committee. + +* Keyboard Maintainer: [Will McGloughlin](https://github.com/wymcg) +* Hardware Supported: Pro Micro and derivatives +* Hardware Availability: [PCB and case files](https://github.com/psuieee/pluto12) + +Make example for this keyboard (after setting up your build environment): + + make psuieee/pluto12:default + +Flashing example for this keyboard: + + make psuieee/pluto12: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). + +## Bootloader + +Enter the bootloader in 3 ways: + +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard +* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead. +* **Keycode in layout**: Press the key mapped to `RESET` if it is available diff --git a/keyboards/psuieee/pluto12/rules.mk b/keyboards/psuieee/pluto12/rules.mk new file mode 100644 index 0000000000..515ca5621f --- /dev/null +++ b/keyboards/psuieee/pluto12/rules.mk @@ -0,0 +1,18 @@ +# MCU name +MCU = atmega32u4 + +# Bootloader selection +BOOTLOADER = caterina + +# Build Options +# change yes to no to disable +# +BOOTMAGIC_ENABLE = yes # Enable Bootmagic Lite +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 +NKRO_ENABLE = no # Enable N-Key Rollover +BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality +RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow +AUDIO_ENABLE = no # Audio output