From fd48f687b133d5000f647b38923810c2d1b16453 Mon Sep 17 00:00:00 2001 From: That-Canadian Date: Sun, 14 Jul 2019 18:26:45 -0700 Subject: [PATCH] [Keyboard] Added IVY macropad (#6211) * Added initial files for the Adron 3-key macro pad * Refactor of "adron_pad" to "ivy", cleaned up the readme and removed un-needed keymap as well. * Made suggested changes to commit for PR * Removed unneeded define block from SUBPROJECT_rev1 as it is redundant (Thanks drashna ;) ) --- keyboards/ivy/config.h | 67 ++++++++++++++++++++++++++ keyboards/ivy/ivy.c | 1 + keyboards/ivy/ivy.h | 7 +++ keyboards/ivy/keymaps/default/keymap.c | 46 ++++++++++++++++++ keyboards/ivy/keymaps/default/rules.mk | 22 +++++++++ keyboards/ivy/readme.md | 15 ++++++ keyboards/ivy/rev1/config.h | 27 +++++++++++ keyboards/ivy/rev1/rev1.c | 5 ++ keyboards/ivy/rev1/rev1.h | 14 ++++++ keyboards/ivy/rev1/rules.mk | 3 ++ keyboards/ivy/rules.mk | 67 ++++++++++++++++++++++++++ 11 files changed, 274 insertions(+) create mode 100644 keyboards/ivy/config.h create mode 100644 keyboards/ivy/ivy.c create mode 100644 keyboards/ivy/ivy.h create mode 100644 keyboards/ivy/keymaps/default/keymap.c create mode 100644 keyboards/ivy/keymaps/default/rules.mk create mode 100644 keyboards/ivy/readme.md create mode 100644 keyboards/ivy/rev1/config.h create mode 100644 keyboards/ivy/rev1/rev1.c create mode 100644 keyboards/ivy/rev1/rev1.h create mode 100644 keyboards/ivy/rev1/rules.mk create mode 100644 keyboards/ivy/rules.mk diff --git a/keyboards/ivy/config.h b/keyboards/ivy/config.h new file mode 100644 index 0000000000..1e6f5bc96e --- /dev/null +++ b/keyboards/ivy/config.h @@ -0,0 +1,67 @@ +/* +Copyright 2012 Jun Wako + +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 0x1337 +#define PRODUCT_ID 0x6012 +#define MANUFACTURER Maple Computing +#define PRODUCT Ivy +#define DESCRIPTION A 3 key macro pad + +/* key matrix size */ +#define MATRIX_ROWS 3 +#define MATRIX_COLS 3 + +/* COL2ROW or ROW2COL */ +#define DIODE_DIRECTION COL2ROW + +/* define if matrix has ghost */ +//#define MATRIX_HAS_GHOST + +/* Set 0 if debouncing isn't needed */ +#define DEBOUNCE 5 + +/* 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 + +#define BACKLIGHT_PIN D2 + +/* number of backlight levels */ +#define BACKLIGHT_LEVELS 3 + +/* + * 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 +//#define NO_ACTION_MACRO +//#define NO_ACTION_FUNCTION diff --git a/keyboards/ivy/ivy.c b/keyboards/ivy/ivy.c new file mode 100644 index 0000000000..007ef67253 --- /dev/null +++ b/keyboards/ivy/ivy.c @@ -0,0 +1 @@ +#include "ivy.h" diff --git a/keyboards/ivy/ivy.h b/keyboards/ivy/ivy.h new file mode 100644 index 0000000000..2cba5f4956 --- /dev/null +++ b/keyboards/ivy/ivy.h @@ -0,0 +1,7 @@ +#pragma once + +#ifdef KEYBOARD_ivy_rev1 + #include "rev1.h" +#endif + +#include "quantum.h" diff --git a/keyboards/ivy/keymaps/default/keymap.c b/keyboards/ivy/keymaps/default/keymap.c new file mode 100644 index 0000000000..9a95ba820e --- /dev/null +++ b/keyboards/ivy/keymaps/default/keymap.c @@ -0,0 +1,46 @@ +#include QMK_KEYBOARD_H + +extern keymap_config_t keymap_config; + +// Each layer gets a name for readability, which is then used in the keymap matrix below. +// The underscores don't mean anything - you can have a layer called STUFF or any other name. +// Layer names don't all need to be of the same length, obviously, and you can also skip them +// entirely and just use numbers. + +enum pad_layers { + _L1, + _FUNC +}; + +// Defines for task manager and such +#define CALTDEL LCTL(LALT(KC_DEL)) +#define TSKMGR LCTL(LSFT(KC_ESC)) + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + +/* Layer 1 + * ,------. + * | 1 | + * |------| + * | 2 | + * |------| + * | FN | + * `------' + */ +[_L1] = LAYOUT( \ + KC_1, \ + KC_2, \ + MO(_FUNC) \ +), + +[_FUNC] = LAYOUT( \ + CALTDEL, \ + TSKMGR, \ + _______ \ +) + +}; + +void matrix_init_user(void) { + +} diff --git a/keyboards/ivy/keymaps/default/rules.mk b/keyboards/ivy/keymaps/default/rules.mk new file mode 100644 index 0000000000..cd169fbfd2 --- /dev/null +++ b/keyboards/ivy/keymaps/default/rules.mk @@ -0,0 +1,22 @@ + + +# Build Options +# change to "no" to disable the options, or define them in the Makefile in +# the appropriate keymap folder that will get included automatically +# +BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000) +MOUSEKEY_ENABLE = no # Mouse keys(+4700) +EXTRAKEY_ENABLE = yes # Audio control and System control(+450) +CONSOLE_ENABLE = no # Console for debug(+400) +COMMAND_ENABLE = no # Commands for debug and configuration +NKRO_ENABLE = yes # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work +BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality +MIDI_ENABLE = no # MIDI controls +AUDIO_ENABLE = no # Audio output on port C6 +UNICODE_ENABLE = no # Unicode +BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID +RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight. + +# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE +SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend + diff --git a/keyboards/ivy/readme.md b/keyboards/ivy/readme.md new file mode 100644 index 0000000000..f70630b52b --- /dev/null +++ b/keyboards/ivy/readme.md @@ -0,0 +1,15 @@ +IVY +=== + +![Ivy](https://i.imgur.com/fnVQet6.jpg) + +Make example for this keyboard (after setting up your build environment): + + make ivy/rev1:default + +Install examples: + + make ivy/rev1:default:dfu + +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/ivy/rev1/config.h b/keyboards/ivy/rev1/config.h new file mode 100644 index 0000000000..9b88b89e5e --- /dev/null +++ b/keyboards/ivy/rev1/config.h @@ -0,0 +1,27 @@ +/* +Copyright 2012 Jun Wako + +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 DEVICE_VER 0x0001 + +/* Let's Macro V2 pin-out */ +#define MATRIX_ROW_PINS { F1, B2, D3 } +#define MATRIX_COL_PINS { F5, B3, D5 } +#define UNUSED_PINS + +#define DIODE_DIRECTION COL2ROW diff --git a/keyboards/ivy/rev1/rev1.c b/keyboards/ivy/rev1/rev1.c new file mode 100644 index 0000000000..c099e32c49 --- /dev/null +++ b/keyboards/ivy/rev1/rev1.c @@ -0,0 +1,5 @@ +#include "ivy.h" + +void matrix_init_kb(void) { + matrix_init_user(); +}; diff --git a/keyboards/ivy/rev1/rev1.h b/keyboards/ivy/rev1/rev1.h new file mode 100644 index 0000000000..ac338368ed --- /dev/null +++ b/keyboards/ivy/rev1/rev1.h @@ -0,0 +1,14 @@ +#pragma once + +#include "ivy.h" + +#define LAYOUT( \ + K00, \ + K01, \ + K02 \ + ) \ + { \ + { K00, KC_NO, KC_NO }, \ + { KC_NO, K01, KC_NO }, \ + { KC_NO, KC_NO, K02 }, \ + } diff --git a/keyboards/ivy/rev1/rules.mk b/keyboards/ivy/rev1/rules.mk new file mode 100644 index 0000000000..f4043e2b79 --- /dev/null +++ b/keyboards/ivy/rev1/rules.mk @@ -0,0 +1,3 @@ +BACKLIGHT_ENABLE = yes +RGBLIGHT_ENABLE = no +AUDIO_ENABLE = no \ No newline at end of file diff --git a/keyboards/ivy/rules.mk b/keyboards/ivy/rules.mk new file mode 100644 index 0000000000..1ef5b4aad4 --- /dev/null +++ b/keyboards/ivy/rules.mk @@ -0,0 +1,67 @@ +# MCU name +#MCU = at90usb1287 +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 +# This definition is optional, and if your keyboard supports multiple bootloaders of +# different sizes, comment this out, and the correct address will be loaded +# automatically (+60). See bootloader.mk for all options. +BOOTLOADER = caterina + +# Interrupt driven control endpoint task(+60) +OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT + +# Build Options +# change to "no" to disable the options, or define them in the Makefile in +# the appropriate keymap folder that will get included automatically +# +BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000) +MOUSEKEY_ENABLE = no # Mouse keys(+4700) +EXTRAKEY_ENABLE = yes # Audio control and System control(+450) +CONSOLE_ENABLE = no # Console for debug(+400) +COMMAND_ENABLE = yes # Commands for debug and configuration +NKRO_ENABLE = no # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work +BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality +MIDI_ENABLE = no # MIDI controls +AUDIO_ENABLE = no # Audio output on port C6 +UNICODE_ENABLE = no # Unicode +BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID +RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight. +API_SYSEX_ENABLE = no + +# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE +SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend + +DEFAULT_FOLDER = ivy/rev1 \ No newline at end of file