From d94b5d0b8219dfce42aad5798d3bb1d6cf7fec19 Mon Sep 17 00:00:00 2001 From: Dari <41168529+dari-studios@users.noreply.github.com> Date: Sat, 26 Feb 2022 20:18:51 -0500 Subject: [PATCH] [Handwired] Support for Adafruit lemon keypad (#16395) Co-authored-by: Ryan Co-authored-by: zvecr --- keyboards/handwired/lemonpad/config.h | 140 ++++++++++++++++++ keyboards/handwired/lemonpad/info.json | 18 +++ .../lemonpad/keymaps/default/keymap.c | 31 ++++ .../lemonpad/keymaps/default/readme.md | 1 + .../handwired/lemonpad/keymaps/via/config.h | 19 +++ .../handwired/lemonpad/keymaps/via/keymap.c | 78 ++++++++++ .../handwired/lemonpad/keymaps/via/readme.md | 1 + .../handwired/lemonpad/keymaps/via/rules.mk | 2 + keyboards/handwired/lemonpad/lemonpad.c | 17 +++ keyboards/handwired/lemonpad/lemonpad.h | 38 +++++ keyboards/handwired/lemonpad/readme.md | 27 ++++ keyboards/handwired/lemonpad/rules.mk | 20 +++ 12 files changed, 392 insertions(+) create mode 100644 keyboards/handwired/lemonpad/config.h create mode 100644 keyboards/handwired/lemonpad/info.json create mode 100644 keyboards/handwired/lemonpad/keymaps/default/keymap.c create mode 100644 keyboards/handwired/lemonpad/keymaps/default/readme.md create mode 100644 keyboards/handwired/lemonpad/keymaps/via/config.h create mode 100644 keyboards/handwired/lemonpad/keymaps/via/keymap.c create mode 100644 keyboards/handwired/lemonpad/keymaps/via/readme.md create mode 100644 keyboards/handwired/lemonpad/keymaps/via/rules.mk create mode 100644 keyboards/handwired/lemonpad/lemonpad.c create mode 100644 keyboards/handwired/lemonpad/lemonpad.h create mode 100644 keyboards/handwired/lemonpad/readme.md create mode 100644 keyboards/handwired/lemonpad/rules.mk diff --git a/keyboards/handwired/lemonpad/config.h b/keyboards/handwired/lemonpad/config.h new file mode 100644 index 0000000000..46369cb999 --- /dev/null +++ b/keyboards/handwired/lemonpad/config.h @@ -0,0 +1,140 @@ +/* Copyright 2022 dari-studios (@dari-studios) + * + * 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 0x6473 +#define PRODUCT_ID 0x4C50 +#define DEVICE_VER 0x0001 +#define MANUFACTURER dari-studios +#define PRODUCT lemonpad + +/* key matrix size */ +#define MATRIX_ROWS 2 +#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) + * + */ + +#define DIRECT_PINS { \ + { E6, D7, C6 }, \ + { B4, B5, D4 } \ +} +#define UNUSED_PINS + +//#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/handwired/lemonpad/info.json b/keyboards/handwired/lemonpad/info.json new file mode 100644 index 0000000000..e9d13d147f --- /dev/null +++ b/keyboards/handwired/lemonpad/info.json @@ -0,0 +1,18 @@ +{ + "keyboard_name": "lemonpad", + "url": "", + "maintainer": "dari-studios", + "layouts": { + "LAYOUT": { + "layout": [ + {"label": "k00", "x": 0, "y": 0}, + {"label": "k01", "x": 1, "y": 0}, + {"label": "k02", "x": 2, "y": 0}, + + {"label": "k10", "x": 0, "y": 1}, + {"label": "k11", "x": 1, "y": 1}, + {"label": "k12", "x": 2, "y": 1} + ] + } + } +} diff --git a/keyboards/handwired/lemonpad/keymaps/default/keymap.c b/keyboards/handwired/lemonpad/keymaps/default/keymap.c new file mode 100644 index 0000000000..06ebf2083f --- /dev/null +++ b/keyboards/handwired/lemonpad/keymaps/default/keymap.c @@ -0,0 +1,31 @@ +/* Copyright 2022 dari-studios (@dari-studios) + * + * 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, +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [_BASE] = LAYOUT( + KC_A, KC_B, KC_C, + KC_D, KC_E, KC_F + ), + +}; diff --git a/keyboards/handwired/lemonpad/keymaps/default/readme.md b/keyboards/handwired/lemonpad/keymaps/default/readme.md new file mode 100644 index 0000000000..7d4196c9e3 --- /dev/null +++ b/keyboards/handwired/lemonpad/keymaps/default/readme.md @@ -0,0 +1 @@ +# The default keymap for lemonpad diff --git a/keyboards/handwired/lemonpad/keymaps/via/config.h b/keyboards/handwired/lemonpad/keymaps/via/config.h new file mode 100644 index 0000000000..0baa186e23 --- /dev/null +++ b/keyboards/handwired/lemonpad/keymaps/via/config.h @@ -0,0 +1,19 @@ +/* Copyright 2022 dari-studios (@dari-studios) + * + * 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 + +#define DYNAMIC_KEYMAP_LAYER_COUNT 9 \ No newline at end of file diff --git a/keyboards/handwired/lemonpad/keymaps/via/keymap.c b/keyboards/handwired/lemonpad/keymaps/via/keymap.c new file mode 100644 index 0000000000..71b94011cb --- /dev/null +++ b/keyboards/handwired/lemonpad/keymaps/via/keymap.c @@ -0,0 +1,78 @@ +/* Copyright 2022 dari-studios (@dari-studios) + * + * 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, + _EMPTY1, + _EMPTY2, + _EMPTY3, + _EMPTY4, + _EMPTY5, + _EMPTY6, + _EMPTY7, + _EMPTY8 +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [_BASE] = LAYOUT( + KC_A, KC_B, KC_C, + KC_D, KC_E, KC_F + ), + + [_EMPTY1] = LAYOUT( + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS + ), + + [_EMPTY2] = LAYOUT( + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS + ), + + [_EMPTY3] = LAYOUT( + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS + ), + + [_EMPTY4] = LAYOUT( + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS + ), + + [_EMPTY5] = LAYOUT( + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS + ), + + [_EMPTY6] = LAYOUT( + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS + ), + + [_EMPTY7] = LAYOUT( + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS + ), + + [_EMPTY8] = LAYOUT( + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS + ) +}; diff --git a/keyboards/handwired/lemonpad/keymaps/via/readme.md b/keyboards/handwired/lemonpad/keymaps/via/readme.md new file mode 100644 index 0000000000..907b8f5add --- /dev/null +++ b/keyboards/handwired/lemonpad/keymaps/via/readme.md @@ -0,0 +1 @@ +# Basic VIA config, 9 layers. \ No newline at end of file diff --git a/keyboards/handwired/lemonpad/keymaps/via/rules.mk b/keyboards/handwired/lemonpad/keymaps/via/rules.mk new file mode 100644 index 0000000000..43061db1dd --- /dev/null +++ b/keyboards/handwired/lemonpad/keymaps/via/rules.mk @@ -0,0 +1,2 @@ +VIA_ENABLE = yes +LTO_ENABLE = yes \ No newline at end of file diff --git a/keyboards/handwired/lemonpad/lemonpad.c b/keyboards/handwired/lemonpad/lemonpad.c new file mode 100644 index 0000000000..cb5c1461a5 --- /dev/null +++ b/keyboards/handwired/lemonpad/lemonpad.c @@ -0,0 +1,17 @@ +/* Copyright 2022 dari-studios (@dari-studios) + * + * 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 "lemonpad.h" diff --git a/keyboards/handwired/lemonpad/lemonpad.h b/keyboards/handwired/lemonpad/lemonpad.h new file mode 100644 index 0000000000..8f9b64c19a --- /dev/null +++ b/keyboards/handwired/lemonpad/lemonpad.h @@ -0,0 +1,38 @@ +/* Copyright 2022 dari-studios (@dari-studios) + * + * 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. + */ + +//Top 3 on the usb port side, bottom 3 on the opposite side + +#define LAYOUT( \ + k00, k01, k02, \ + k10, k11, k12 \ +) { \ + { k00, k01, k02 }, \ + { k10, k11, k12 }, \ +} diff --git a/keyboards/handwired/lemonpad/readme.md b/keyboards/handwired/lemonpad/readme.md new file mode 100644 index 0000000000..4c1c2082e9 --- /dev/null +++ b/keyboards/handwired/lemonpad/readme.md @@ -0,0 +1,27 @@ +# lemonpad + +![lemonpad](https://i.imgur.com/hAp2Nich.jpeg) + +This is a QMK and VIA implementation for an atmega32u4 based adaptation of the Adafruit Lemon Keypad. By default it uses a Pro Micro, if you would like to use a different microcontroller please make sure you have the correct bootloader set. + +* Keyboard Maintainer: [dari-studios](https://github.com/dari-studios) +* Hardware Supported: atmega32u4 based boards with the Caterina bootloader +* Hardware Availability: https://learn.adafruit.com/qtpy-lemon-mechanical-keypad-macropad + +Make example for this keyboard (after setting up your build environment): + + make handwired/lemonpad:default + +Flashing example for this keyboard: + + make handwired/lemonpad: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/handwired/lemonpad/rules.mk b/keyboards/handwired/lemonpad/rules.mk new file mode 100644 index 0000000000..6174b9bd66 --- /dev/null +++ b/keyboards/handwired/lemonpad/rules.mk @@ -0,0 +1,20 @@ +# 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 = yes # Console for debug +COMMAND_ENABLE = yes # Commands for debug and configuration +NKRO_ENABLE = yes # Enable N-Key Rollover +BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality +RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow +AUDIO_ENABLE = no # Audio output + +LTO_ENABLE = yes