From b4867e1600baa615ec9b28421fc23d4b85bad8ec Mon Sep 17 00:00:00 2001 From: Yoichiro Tanaka Date: Wed, 25 Aug 2021 00:44:00 +0900 Subject: [PATCH] [Keyboard] Add yoichiro/lunakey_macro (#13849) Co-authored-by: Drashna Jaelre Co-authored-by: Ryan --- keyboards/yoichiro/lunakey_macro/config.h | 158 ++++++++++++++++++ keyboards/yoichiro/lunakey_macro/info.json | 68 ++++++++ .../lunakey_macro/keymaps/default/keymap.c | 41 +++++ .../lunakey_macro/keymaps/default/readme.md | 1 + .../lunakey_macro/keymaps/via/keymap.c | 56 +++++++ .../lunakey_macro/keymaps/via/readme.md | 1 + .../lunakey_macro/keymaps/via/rules.mk | 4 + .../yoichiro/lunakey_macro/lunakey_macro.c | 17 ++ .../yoichiro/lunakey_macro/lunakey_macro.h | 37 ++++ keyboards/yoichiro/lunakey_macro/readme.md | 21 +++ keyboards/yoichiro/lunakey_macro/rules.mk | 22 +++ 11 files changed, 426 insertions(+) create mode 100644 keyboards/yoichiro/lunakey_macro/config.h create mode 100644 keyboards/yoichiro/lunakey_macro/info.json create mode 100644 keyboards/yoichiro/lunakey_macro/keymaps/default/keymap.c create mode 100644 keyboards/yoichiro/lunakey_macro/keymaps/default/readme.md create mode 100644 keyboards/yoichiro/lunakey_macro/keymaps/via/keymap.c create mode 100644 keyboards/yoichiro/lunakey_macro/keymaps/via/readme.md create mode 100644 keyboards/yoichiro/lunakey_macro/keymaps/via/rules.mk create mode 100644 keyboards/yoichiro/lunakey_macro/lunakey_macro.c create mode 100644 keyboards/yoichiro/lunakey_macro/lunakey_macro.h create mode 100644 keyboards/yoichiro/lunakey_macro/readme.md create mode 100644 keyboards/yoichiro/lunakey_macro/rules.mk diff --git a/keyboards/yoichiro/lunakey_macro/config.h b/keyboards/yoichiro/lunakey_macro/config.h new file mode 100644 index 0000000000..d68f69f515 --- /dev/null +++ b/keyboards/yoichiro/lunakey_macro/config.h @@ -0,0 +1,158 @@ +/* +Copyright 2020 Yoichiro Tanaka + +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 0x5954 // "YT" - Yoichiro Tanaka +#define PRODUCT_ID 0x0002 +#define DEVICE_VER 0x0001 +#define MANUFACTURER yoichiro +#define PRODUCT Lunakey Macro + +/* 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 { E6, B4, B5 } +#define MATRIX_COL_PINS { B6, B2, B3, B1 } +#define UNUSED_PINS + +/* COL2ROW, ROW2COL */ +#define DIODE_DIRECTION COL2ROW + +/* Audio support */ +#define AUDIO_PIN C6 + +#ifdef AUDIO_ENABLE + #define STARTUP_SONG SONG(E__NOTE(_C7), E__NOTE(_C6)) +#endif + +/* Mouse Keys Combined mode */ +//#define MK_COMBINED + +/* Layer Count */ +#define DYNAMIC_KEYMAP_LAYER_COUNT 3 + +/* + * 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 BACKLIGHT_PIN B7 +//#define BACKLIGHT_LEVELS 3 +//#define BACKLIGHT_BREATHING + +#define RGB_DI_PIN D3 +#ifdef RGB_DI_PIN + #define RGBLED_NUM 5 + #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 */ +// #define RGBLIGHT_LAYERS +#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 +#define RGBLIGHT_EFFECT_TWINKLE +/*== 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/yoichiro/lunakey_macro/info.json b/keyboards/yoichiro/lunakey_macro/info.json new file mode 100644 index 0000000000..25e3bd8d30 --- /dev/null +++ b/keyboards/yoichiro/lunakey_macro/info.json @@ -0,0 +1,68 @@ +{ + "keyboard_name": "Lunakey Macro", + "url": "", + "maintainer": "Yoichiro Tanaka", + "width": 4.5, + "height": 4, + "layouts": { + "LAYOUT": { + "layout": [ + { + "label": "0,2", + "x": 2.5, + "y": 0 + }, + { + "label": "0,1", + "x": 1.5, + "y": 0.175 + }, + { + "label": "0,0", + "x": 0.5, + "y": 0.5 + }, + { + "label": "0,3", + "x": 3.5, + "y": 0.5 + }, + { + "label": "1,2", + "x": 2.5, + "y": 1 + }, + { + "label": "1,1", + "x": 1.5, + "y": 1.175 + }, + { + "label": "1,0", + "x": 0.5, + "y": 1.5 + }, + { + "label": "1,3", + "x": 3.5, + "y": 1.5 + }, + { + "label": "2,1", + "x": 1, + "y": 2.75 + }, + { + "label": "2,0", + "x": 0, + "y": 3 + }, + { + "label": "2,2", + "x": 2, + "y": 3 + } + ] + } + } +} diff --git a/keyboards/yoichiro/lunakey_macro/keymaps/default/keymap.c b/keyboards/yoichiro/lunakey_macro/keymaps/default/keymap.c new file mode 100644 index 0000000000..1b2055b749 --- /dev/null +++ b/keyboards/yoichiro/lunakey_macro/keymaps/default/keymap.c @@ -0,0 +1,41 @@ +/* Copyright 2020 Yoichiro Tanaka + * + * 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 { + _NUMBERS, + _CURSOR, + _ADJUST +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [_NUMBERS] = LAYOUT( + KC_1, KC_2, KC_3, KC_4, + KC_5, KC_6, KC_7, KC_8, + KC_9, KC_0, DF(_CURSOR) + ), + [_CURSOR] = LAYOUT( + KC_PGUP, KC_HOME, KC_UP, KC_END, + KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, + KC_ENT, KC_BSPC, DF(_ADJUST) + ), + [_ADJUST] = LAYOUT( + KC_NO, KC_NO, KC_NO, KC_NO, + KC_NO, KC_NO, KC_NO, KC_NO, + RESET, KC_NO, DF(_NUMBERS) + ) +}; diff --git a/keyboards/yoichiro/lunakey_macro/keymaps/default/readme.md b/keyboards/yoichiro/lunakey_macro/keymaps/default/readme.md new file mode 100644 index 0000000000..b079aa9fa6 --- /dev/null +++ b/keyboards/yoichiro/lunakey_macro/keymaps/default/readme.md @@ -0,0 +1 @@ +# The default keymap for Lunakey Macro diff --git a/keyboards/yoichiro/lunakey_macro/keymaps/via/keymap.c b/keyboards/yoichiro/lunakey_macro/keymaps/via/keymap.c new file mode 100644 index 0000000000..a3a203df6d --- /dev/null +++ b/keyboards/yoichiro/lunakey_macro/keymaps/via/keymap.c @@ -0,0 +1,56 @@ +/* Copyright 2020 Yoichiro Tanaka + * + * 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 { + _NUMBERS, + _CURSOR, + _ADJUST +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [_NUMBERS] = LAYOUT( + KC_1, KC_2, KC_3, KC_4, + KC_5, KC_6, KC_7, KC_8, + KC_9, KC_0, DF(_CURSOR) + ), + [_CURSOR] = LAYOUT( + KC_PGUP, KC_HOME, KC_UP, KC_END, + KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, + KC_ENT, KC_BSPC, DF(_ADJUST) + ), + [_ADJUST] = LAYOUT( + RGB_TOG, RGB_MOD, RGB_VAI, RGB_VAD, + AU_TOG, CK_TOGG, MU_TOG, MU_MOD, + RESET, KC_NO, DF(_NUMBERS) + ) +}; + +bool process_record_user(uint16_t keycode, keyrecord_t *record) { + float next_song[][2] = SONG(E__NOTE(_A6)); + float back_song[][2] = SONG(H__NOTE(_D2)); + switch (keycode) { + case DF(_NUMBERS): + case DF(_CURSOR): + PLAY_SONG(next_song); + break; + case DF(_ADJUST): + PLAY_SONG(back_song); + break; + } + return true; +} diff --git a/keyboards/yoichiro/lunakey_macro/keymaps/via/readme.md b/keyboards/yoichiro/lunakey_macro/keymaps/via/readme.md new file mode 100644 index 0000000000..4e74b05bcd --- /dev/null +++ b/keyboards/yoichiro/lunakey_macro/keymaps/via/readme.md @@ -0,0 +1 @@ +# The keymap supporing VIA for Lunakey Macro diff --git a/keyboards/yoichiro/lunakey_macro/keymaps/via/rules.mk b/keyboards/yoichiro/lunakey_macro/keymaps/via/rules.mk new file mode 100644 index 0000000000..19658b7e47 --- /dev/null +++ b/keyboards/yoichiro/lunakey_macro/keymaps/via/rules.mk @@ -0,0 +1,4 @@ +AUDIO_ENABLE = yes +RGBLIGHT_ENABLE = yes +LTO_ENABLE = yes +VIA_ENABLE = yes diff --git a/keyboards/yoichiro/lunakey_macro/lunakey_macro.c b/keyboards/yoichiro/lunakey_macro/lunakey_macro.c new file mode 100644 index 0000000000..5ef38f70c7 --- /dev/null +++ b/keyboards/yoichiro/lunakey_macro/lunakey_macro.c @@ -0,0 +1,17 @@ +/* Copyright 2020 Yoichiro Tanaka + * + * 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 "lunakey_macro.h" diff --git a/keyboards/yoichiro/lunakey_macro/lunakey_macro.h b/keyboards/yoichiro/lunakey_macro/lunakey_macro.h new file mode 100644 index 0000000000..487b7fe208 --- /dev/null +++ b/keyboards/yoichiro/lunakey_macro/lunakey_macro.h @@ -0,0 +1,37 @@ +/* Copyright 2020 Yoichiro Tanaka + * + * 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( \ + k00, k01, k02, k03, \ + k10, k11, k12, k13, \ + k20, k21, k22 \ +) { \ + { k00, k01, k02, k03 }, \ + { k10, k11, k12, k13 }, \ + { k20, k21, k22, KC_NO } \ +} diff --git a/keyboards/yoichiro/lunakey_macro/readme.md b/keyboards/yoichiro/lunakey_macro/readme.md new file mode 100644 index 0000000000..440845d07d --- /dev/null +++ b/keyboards/yoichiro/lunakey_macro/readme.md @@ -0,0 +1,21 @@ +# Lunakey Macro + +![Lunakey Macro](https://i.imgur.com/BirFxgYh.jpeg) + +This is a macro keyboard which has 11 keys. + +* Keyboard Maintainer: [Yoichiro Tanaka](https://github.com/yoichiro) +* Hardware Supported: Lunakey Macro PCB, Pro Micro MCU. +* Hardware Availability: Published yet. + +Make example for this keyboard (after setting up your build environment): + + make lunakey_macro:default + +Flashing example for this keyboard: + + make lunakey_macro:default:flash + +To enter the bootloader mode, you push the black tact switch next to the ProMicro. + +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/yoichiro/lunakey_macro/rules.mk b/keyboards/yoichiro/lunakey_macro/rules.mk new file mode 100644 index 0000000000..60a579e02e --- /dev/null +++ b/keyboards/yoichiro/lunakey_macro/rules.mk @@ -0,0 +1,22 @@ +# MCU name +MCU = atmega32u4 + +# Bootloader selection +BOOTLOADER = atmel-dfu + +# Build Options +# change yes to no to disable +# +BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration +MOUSEKEY_ENABLE = no # Mouse keys +EXTRAKEY_ENABLE = no # 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 = no # Enable keyboard RGB underglow +BLUETOOTH_ENABLE = no # Enable Bluetooth +AUDIO_ENABLE = no # Audio output