From 7e58ab88ffb5a7ac556e3ca4184628ef41ba8d20 Mon Sep 17 00:00:00 2001 From: yfuku <30647434+yfuku@users.noreply.github.com> Date: Wed, 8 Dec 2021 04:59:39 +0900 Subject: [PATCH] [Keyboard] Add stickey4 keyboard (#15396) Co-authored-by: Drashna Jaelre Co-authored-by: Ryan --- keyboards/dailycraft/stickey4/config.h | 156 ++++++++++++++++++ .../stickey4/keymaps/default/keymap.c | 43 +++++ .../stickey4/keymaps/default/readme.md | 1 + .../dailycraft/stickey4/keymaps/via/keymap.c | 115 +++++++++++++ .../dailycraft/stickey4/keymaps/via/readme.md | 1 + .../dailycraft/stickey4/keymaps/via/rules.mk | 1 + keyboards/dailycraft/stickey4/readme.md | 26 +++ keyboards/dailycraft/stickey4/rules.mk | 20 +++ keyboards/dailycraft/stickey4/stickey4.c | 17 ++ keyboards/dailycraft/stickey4/stickey4.h | 36 ++++ 10 files changed, 416 insertions(+) create mode 100644 keyboards/dailycraft/stickey4/config.h create mode 100644 keyboards/dailycraft/stickey4/keymaps/default/keymap.c create mode 100644 keyboards/dailycraft/stickey4/keymaps/default/readme.md create mode 100644 keyboards/dailycraft/stickey4/keymaps/via/keymap.c create mode 100644 keyboards/dailycraft/stickey4/keymaps/via/readme.md create mode 100644 keyboards/dailycraft/stickey4/keymaps/via/rules.mk create mode 100644 keyboards/dailycraft/stickey4/readme.md create mode 100644 keyboards/dailycraft/stickey4/rules.mk create mode 100644 keyboards/dailycraft/stickey4/stickey4.c create mode 100644 keyboards/dailycraft/stickey4/stickey4.h diff --git a/keyboards/dailycraft/stickey4/config.h b/keyboards/dailycraft/stickey4/config.h new file mode 100644 index 000000000..85e49bca9 --- /dev/null +++ b/keyboards/dailycraft/stickey4/config.h @@ -0,0 +1,156 @@ +/* +Copyright 2021 yfuku + +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 0x5946 // YF +#define PRODUCT_ID 0x0010 +#define DEVICE_VER 0x0001 +#define MANUFACTURER yfuku +#define PRODUCT stickey4 + +/* key matrix size */ +#define MATRIX_ROWS 1 +#define MATRIX_COLS 8 + +/* + * 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 { \ + { D4, C6, D7, E6, NO_PIN, NO_PIN, NO_PIN, NO_PIN } \ +} +#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 + +#define ENCODERS_PAD_A { D4, D7 } +#define ENCODERS_PAD_B { C6, E6 } diff --git a/keyboards/dailycraft/stickey4/keymaps/default/keymap.c b/keyboards/dailycraft/stickey4/keymaps/default/keymap.c new file mode 100644 index 000000000..70de5dca4 --- /dev/null +++ b/keyboards/dailycraft/stickey4/keymaps/default/keymap.c @@ -0,0 +1,43 @@ +/* Copyright 2021 yfuku + * + * 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, + _FN1, + _FN2, + _FN3 +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [_BASE] = LAYOUT( + KC_A, KC_B, KC_C, KC_D, + KC_NO, KC_NO, KC_NO, KC_NO // for encoders + ), + [_FN1] = LAYOUT( + KC_NO, KC_NO, KC_NO, KC_NO, + KC_NO, KC_NO, KC_NO, KC_NO + ), + [_FN2] = LAYOUT( + KC_NO, KC_NO, KC_NO, KC_NO, + KC_NO, KC_NO, KC_NO, KC_NO + ), + [_FN3] = LAYOUT( + KC_NO, KC_NO, KC_NO, KC_NO, + KC_NO, KC_NO, KC_NO, KC_NO + ) +}; diff --git a/keyboards/dailycraft/stickey4/keymaps/default/readme.md b/keyboards/dailycraft/stickey4/keymaps/default/readme.md new file mode 100644 index 000000000..3b9ed23b9 --- /dev/null +++ b/keyboards/dailycraft/stickey4/keymaps/default/readme.md @@ -0,0 +1 @@ +# The default keymap for stickey4 diff --git a/keyboards/dailycraft/stickey4/keymaps/via/keymap.c b/keyboards/dailycraft/stickey4/keymaps/via/keymap.c new file mode 100644 index 000000000..602d3fb10 --- /dev/null +++ b/keyboards/dailycraft/stickey4/keymaps/via/keymap.c @@ -0,0 +1,115 @@ +/* Copyright 2021 yfuku + * + * 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, + _FN1, + _FN2, + _FN3 +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [_BASE] = LAYOUT( + KC_A, KC_B, KC_C, KC_D, + KC_NO, KC_NO, KC_NO, KC_NO // for encoders + ), + [_FN1] = LAYOUT( + KC_NO, KC_NO, KC_NO, KC_NO, + KC_NO, KC_NO, KC_NO, KC_NO + ), + [_FN2] = LAYOUT( + KC_NO, KC_NO, KC_NO, KC_NO, + KC_NO, KC_NO, KC_NO, KC_NO + ), + [_FN3] = LAYOUT( + KC_NO, KC_NO, KC_NO, KC_NO, + KC_NO, KC_NO, KC_NO, KC_NO + ) +}; + +keyevent_t encoder1_ccw = { + .key = (keypos_t){.row = 0, .col = 4}, + .pressed = false +}; + +keyevent_t encoder1_cw = { + .key = (keypos_t){.row = 0, .col = 5}, + .pressed = false +}; + +keyevent_t encoder2_ccw = { + .key = (keypos_t){.row = 0, .col = 6}, + .pressed = false +}; + +keyevent_t encoder2_cw = { + .key = (keypos_t){.row = 0, .col = 7}, + .pressed = false +}; + +void matrix_scan_user(void) { + if (IS_PRESSED(encoder1_ccw)) { + encoder1_ccw.pressed = false; + encoder1_ccw.time = (timer_read() | 1); + action_exec(encoder1_ccw); + } + + if (IS_PRESSED(encoder1_cw)) { + encoder1_cw.pressed = false; + encoder1_cw.time = (timer_read() | 1); + action_exec(encoder1_cw); + } + + if (IS_PRESSED(encoder2_ccw)) { + encoder2_ccw.pressed = false; + encoder2_ccw.time = (timer_read() | 1); + action_exec(encoder2_ccw); + } + + if (IS_PRESSED(encoder2_cw)) { + encoder2_cw.pressed = false; + encoder2_cw.time = (timer_read() | 1); + action_exec(encoder2_cw); + } +} + +bool encoder_update_user(uint8_t index, bool clockwise) { + if (index == 0) { /* First encoder */ + if (clockwise) { + encoder1_cw.pressed = true; + encoder1_cw.time = (timer_read() | 1); + action_exec(encoder1_cw); + } else { + encoder1_ccw.pressed = true; + encoder1_ccw.time = (timer_read() | 1); + action_exec(encoder1_ccw); + } + } else if (index == 1) { + if (clockwise) { + encoder2_cw.pressed = true; + encoder2_cw.time = (timer_read() | 1); + action_exec(encoder2_cw); + } else { + encoder2_ccw.pressed = true; + encoder2_ccw.time = (timer_read() | 1); + action_exec(encoder2_ccw); + } + } + + return true; +} diff --git a/keyboards/dailycraft/stickey4/keymaps/via/readme.md b/keyboards/dailycraft/stickey4/keymaps/via/readme.md new file mode 100644 index 000000000..202bcb2b9 --- /dev/null +++ b/keyboards/dailycraft/stickey4/keymaps/via/readme.md @@ -0,0 +1 @@ +# The via keymap for stickey4 diff --git a/keyboards/dailycraft/stickey4/keymaps/via/rules.mk b/keyboards/dailycraft/stickey4/keymaps/via/rules.mk new file mode 100644 index 000000000..1e5b99807 --- /dev/null +++ b/keyboards/dailycraft/stickey4/keymaps/via/rules.mk @@ -0,0 +1 @@ +VIA_ENABLE = yes diff --git a/keyboards/dailycraft/stickey4/readme.md b/keyboards/dailycraft/stickey4/readme.md new file mode 100644 index 000000000..e365407f8 --- /dev/null +++ b/keyboards/dailycraft/stickey4/readme.md @@ -0,0 +1,26 @@ +# stickey4 + +![stickey4](https://raw.githubusercontent.com/yfuku/stickey4/main/images/stickey4.jpeg) + +macropad + +* Keyboard Maintainer: [yfuku](https://github.com/yfuku) +* Hardware Supported: stickey4 PCB, Pro Micro +* Hardware Availability: https://shop.dailycraft.jp/ + +Make example for this keyboard (after setting up your build environment): + + make dailycraft/stickey4:default + +Flashing example for this keyboard: + + make dailycraft/stickey4: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 2 ways: + +* **Physical reset button**: Briefly press the button on the PCB +* **Keycode in layout**: Press the key mapped to `RESET` if it is available diff --git a/keyboards/dailycraft/stickey4/rules.mk b/keyboards/dailycraft/stickey4/rules.mk new file mode 100644 index 000000000..284ea23e7 --- /dev/null +++ b/keyboards/dailycraft/stickey4/rules.mk @@ -0,0 +1,20 @@ +# MCU name +MCU = atmega32u4 + +# Bootloader selection +BOOTLOADER = atmel-dfu + +# 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 + +ENCODER_ENABLE = yes diff --git a/keyboards/dailycraft/stickey4/stickey4.c b/keyboards/dailycraft/stickey4/stickey4.c new file mode 100644 index 000000000..dd0ac4f5f --- /dev/null +++ b/keyboards/dailycraft/stickey4/stickey4.c @@ -0,0 +1,17 @@ +/* Copyright 2021 yfuku + * + * 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 "stickey4.h" diff --git a/keyboards/dailycraft/stickey4/stickey4.h b/keyboards/dailycraft/stickey4/stickey4.h new file mode 100644 index 000000000..6a21a8f99 --- /dev/null +++ b/keyboards/dailycraft/stickey4/stickey4.h @@ -0,0 +1,36 @@ +/* Copyright 2021 yfuku + * + * 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, \ + k04, k05, k06, k07 \ +) \ +{ \ + {k00, k01, k02, k03, k04, k05, k06, k07 } \ +}