diff --git a/keyboards/reviung5/config.h b/keyboards/reviung5/config.h new file mode 100644 index 0000000000..493cc6af99 --- /dev/null +++ b/keyboards/reviung5/config.h @@ -0,0 +1,142 @@ +/* +Copyright 2021 gtips + +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 0x5C06 +#define PRODUCT_ID 0x4F0D +#define DEVICE_VER 0x0001 +#define MANUFACTURER gtips +#define PRODUCT reviung5 + +/* key matrix size */ +#define MATRIX_ROWS 1 +#define MATRIX_COLS 5 + +/* + * 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 { F4 } +#define MATRIX_COL_PINS { D4, C6, D7, E6, B4 } +#define UNUSED_PINS + +/* COL2ROW, ROW2COL */ +#define DIODE_DIRECTION COL2ROW + +/* Encoder */ +#define ENCODERS_PAD_A { D0 } +#define ENCODERS_PAD_B { D1 } + + +#define RGB_DI_PIN D3 +#ifdef RGB_DI_PIN +#　define RGBLED_NUM 4 +#　define RGBLIGHT_HUE_STEP 16 +#　define RGBLIGHT_SAT_STEP 16 +# define RGBLIGHT_VAL_STEP 16 +# 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/reviung5/info.json b/keyboards/reviung5/info.json new file mode 100644 index 0000000000..a8dcc48678 --- /dev/null +++ b/keyboards/reviung5/info.json @@ -0,0 +1,18 @@ +{ + "keyboard_name": "reviung5", + "url": "", + "maintainer": "gtips", + "width": 5, + "height": 1, + "layouts": { + "LAYOUT_reviung5": { + "layout": [ + {"label": "k00", "x": 0, "y": 0}, + {"label": "k01", "x": 1, "y": 0.25}, + {"label": "k02", "x": 2, "y": 0.25}, + {"label": "k03", "x": 3, "y": 0.25}, + {"label": "k04", "x": 4, "y": 0} + ] + } + } +} diff --git a/keyboards/reviung5/keymaps/default/keymap.c b/keyboards/reviung5/keymaps/default/keymap.c new file mode 100644 index 0000000000..39f6669a52 --- /dev/null +++ b/keyboards/reviung5/keymaps/default/keymap.c @@ -0,0 +1,34 @@ +/* Copyright 2021 gtips + * + * 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, + _LOWER, +}; + +#define LO_VD LT(_LOWER, KC_VOLD) + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + /* Base */ + [_BASE] = LAYOUT_reviung5( + LO_VD, KC_MPRV, KC_MPLY, KC_MNXT, KC_VOLU + ), + [_LOWER] = LAYOUT_reviung5( + _______, RGB_HUI, RGB_MOD, RGB_TOG, KC_MUTE + ) +}; diff --git a/keyboards/reviung5/keymaps/default/readme.md b/keyboards/reviung5/keymaps/default/readme.md new file mode 100644 index 0000000000..babdce579f --- /dev/null +++ b/keyboards/reviung5/keymaps/default/readme.md @@ -0,0 +1 @@ +# The default keymap for reviung5 diff --git a/keyboards/reviung5/keymaps/default_lre/keymap.c b/keyboards/reviung5/keymaps/default_lre/keymap.c new file mode 100644 index 0000000000..2e732e72fe --- /dev/null +++ b/keyboards/reviung5/keymaps/default_lre/keymap.c @@ -0,0 +1,55 @@ +/* Copyright 2021 gtips + * + * 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, + _LOWER, +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + /* Base */ + [_BASE] = LAYOUT_reviung5( + TG(_LOWER), KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE + ), + [_LOWER] = LAYOUT_reviung5( + _______, LCTL(KC_X), LCTL(KC_C), LCTL(KC_V), RGB_TOG + ) +}; + +bool encoder_update_user(uint8_t index, bool clockwise) { + if (index == 0) { + if (IS_LAYER_ON(_LOWER)) { + tap_code16((clockwise == true) ? KC_WH_D : KC_WH_U); + } else { + tap_code((clockwise == true) ? KC_VOLD : KC_VOLU); + } + } + return true; +} + +layer_state_t layer_state_set_user(layer_state_t state) { + switch (get_highest_layer(state)) { + case _LOWER: + rgblight_setrgb (RGB_GOLD); + break; + default: // for any other layers, or the default layer + rgblight_setrgb (RGB_TEAL); + break; + } + return state; +} diff --git a/keyboards/reviung5/keymaps/default_lre/readme.md b/keyboards/reviung5/keymaps/default_lre/readme.md new file mode 100644 index 0000000000..0e3edee7b1 --- /dev/null +++ b/keyboards/reviung5/keymaps/default_lre/readme.md @@ -0,0 +1,3 @@ +# The default keymap for reviung5 + +## Use the Left Rotary Encoder diff --git a/keyboards/reviung5/keymaps/default_rre/keymap.c b/keyboards/reviung5/keymaps/default_rre/keymap.c new file mode 100644 index 0000000000..9ee41cb7e9 --- /dev/null +++ b/keyboards/reviung5/keymaps/default_rre/keymap.c @@ -0,0 +1,55 @@ +/* Copyright 2021 gtips + * + * 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, + _LOWER, +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + /* Base */ + [_BASE] = LAYOUT_reviung5( + KC_MUTE, KC_MPRV, KC_MPLY, KC_MNXT, TG(_LOWER) + ), + [_LOWER] = LAYOUT_reviung5( + RGB_TOG, LCTL(KC_X), LCTL(KC_C), LCTL(KC_V), _______ + ) +}; + +bool encoder_update_user(uint8_t index, bool clockwise) { + if (index == 0) { + if (IS_LAYER_ON(_LOWER)) { + tap_code16((clockwise == true) ? KC_WH_D : KC_WH_U); + } else { + tap_code((clockwise == true) ? KC_VOLD : KC_VOLU); + } + } + return true; +} + +layer_state_t layer_state_set_user(layer_state_t state) { + switch (get_highest_layer(state)) { + case _LOWER: + rgblight_setrgb (RGB_RED); + break; + default: // for any other layers, or the default layer + rgblight_setrgb (RGB_TEAL); + break; + } + return state; +} diff --git a/keyboards/reviung5/keymaps/default_rre/readme.md b/keyboards/reviung5/keymaps/default_rre/readme.md new file mode 100644 index 0000000000..d16e25ce50 --- /dev/null +++ b/keyboards/reviung5/keymaps/default_rre/readme.md @@ -0,0 +1,4 @@ +# The default keymap for reviung5 + +## Use the Right Rotary Encoder + diff --git a/keyboards/reviung5/readme.md b/keyboards/reviung5/readme.md new file mode 100644 index 0000000000..990645649c --- /dev/null +++ b/keyboards/reviung5/readme.md @@ -0,0 +1,19 @@ +# reviung5 + +![reviung5](https://github.com/gtips/reviung/blob/master/reviung5/image/reviung5-1.jpg) + +The REVIUNG5 is 5-key (or 4-key + Rotary Encoder) macropad. + +* Keyboard Maintainer: [gtips](https://github.com/gtips) +* Hardware Supported: REVIUNG5 PCB. +* Hardware Availability: [PCB & Case Data](https://github.com/gtips/reviung/tree/master/reviung5) + +Make example for this keyboard (after setting up your build environment): + + make reviung5:default + +Flashing example for this keyboard: + + make reviung5: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/reviung5/reviung5.c b/keyboards/reviung5/reviung5.c new file mode 100644 index 0000000000..a8f98f0627 --- /dev/null +++ b/keyboards/reviung5/reviung5.c @@ -0,0 +1,17 @@ +/* Copyright 2021 gtips + * + * 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 "reviung5.h" diff --git a/keyboards/reviung5/reviung5.h b/keyboards/reviung5/reviung5.h new file mode 100644 index 0000000000..f5d952ba94 --- /dev/null +++ b/keyboards/reviung5/reviung5.h @@ -0,0 +1,33 @@ +/* Copyright 2021 gtips + * + * 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_reviung5( \ + K00, K01, K02, K03, K04 \ +) { \ + { K00, K01, K02, K03, K04 } \ +} diff --git a/keyboards/reviung5/rules.mk b/keyboards/reviung5/rules.mk new file mode 100644 index 0000000000..f543038025 --- /dev/null +++ b/keyboards/reviung5/rules.mk @@ -0,0 +1,23 @@ +# MCU name +MCU = atmega32u4 + +# Bootloader selection +BOOTLOADER = caterina + +# Build Options +# change yes to no to disable +# +BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration +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 +# 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 = no # USB Nkey Rollover +BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality +RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow +BLUETOOTH_ENABLE = no # Enable Bluetooth +AUDIO_ENABLE = no # Audio output +ENCODER_ENABLE = yes \ No newline at end of file