From 0355cd0f72899b554c180b7fe6ca61e140e2f908 Mon Sep 17 00:00:00 2001 From: Danny Date: Sun, 7 Feb 2021 13:56:43 -0500 Subject: [PATCH] [Keyboard] Add The Stick keyboard (#11745) Co-authored-by: Ryan --- keyboards/keebio/stick/config.h | 61 +++++++++++++++++++ keyboards/keebio/stick/info.json | 25 ++++++++ .../keebio/stick/keymaps/default/keymap.c | 42 +++++++++++++ keyboards/keebio/stick/keymaps/via/keymap.c | 54 ++++++++++++++++ keyboards/keebio/stick/keymaps/via/rules.mk | 5 ++ keyboards/keebio/stick/readme.md | 19 ++++++ keyboards/keebio/stick/rules.mk | 25 ++++++++ keyboards/keebio/stick/stick.c | 50 +++++++++++++++ keyboards/keebio/stick/stick.h | 26 ++++++++ 9 files changed, 307 insertions(+) create mode 100644 keyboards/keebio/stick/config.h create mode 100644 keyboards/keebio/stick/info.json create mode 100644 keyboards/keebio/stick/keymaps/default/keymap.c create mode 100644 keyboards/keebio/stick/keymaps/via/keymap.c create mode 100644 keyboards/keebio/stick/keymaps/via/rules.mk create mode 100644 keyboards/keebio/stick/readme.md create mode 100644 keyboards/keebio/stick/rules.mk create mode 100644 keyboards/keebio/stick/stick.c create mode 100644 keyboards/keebio/stick/stick.h diff --git a/keyboards/keebio/stick/config.h b/keyboards/keebio/stick/config.h new file mode 100644 index 00000000000..0a43bb86114 --- /dev/null +++ b/keyboards/keebio/stick/config.h @@ -0,0 +1,61 @@ +/* +Copyright 2021 Danny Nguyen + +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 0xCB10 +#define PRODUCT_ID 0x111C +#define DEVICE_VER 0x0100 +#define MANUFACTURER Keebio +#define PRODUCT The Stick + +/* key matrix size */ +#define MATRIX_ROWS 1 +#define MATRIX_COLS 12 + +/* key matrix pins */ +#define DIRECT_PINS { \ + { F4, B6, B5, B4, E6, D7, F6, F7, B1, B3, B2, F5 } \ +} + +#define ENCODERS_PAD_A { D1, D4 } +#define ENCODERS_PAD_B { D0, C6 } + +/* WS2812 RGB LED */ +#define RGB_DI_PIN D3 +#ifdef RGB_DI_PIN +# define RGBLED_NUM 12 +# 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 +// RGB Matrix +# ifdef RGB_MATRIX_ENABLE +# define DRIVER_LED_TOTAL RGBLED_NUM +# endif +#endif + +/* COL2ROW or ROW2COL */ +#define DIODE_DIRECTION COL2ROW + +#define TAPPING_TERM 200 diff --git a/keyboards/keebio/stick/info.json b/keyboards/keebio/stick/info.json new file mode 100644 index 00000000000..33029e8cbfb --- /dev/null +++ b/keyboards/keebio/stick/info.json @@ -0,0 +1,25 @@ +{ + "keyboard_name": "The Stick", + "url": "https://keeb.io", + "maintainer": "nooges", + "width": 12, + "height": 1, + "layouts": { + "LAYOUT": { + "layout": [ + { "label": "F1", "x": 0, "y": 0 }, + { "label": "F2", "x": 1, "y": 0 }, + { "label": "F3", "x": 2, "y": 0 }, + { "label": "F4", "x": 3, "y": 0 }, + { "label": "F5", "x": 4, "y": 0 }, + { "label": "F6", "x": 5, "y": 0 }, + { "label": "F7", "x": 6, "y": 0 }, + { "label": "F8", "x": 7, "y": 0 }, + { "label": "F9", "x": 8, "y": 0 }, + { "label": "F10", "x": 9, "y": 0 }, + { "label": "F11", "x": 10, "y": 0 }, + { "label": "F12", "x": 11, "y": 0 } + ] + } + } +} diff --git a/keyboards/keebio/stick/keymaps/default/keymap.c b/keyboards/keebio/stick/keymaps/default/keymap.c new file mode 100644 index 00000000000..0521afa880d --- /dev/null +++ b/keyboards/keebio/stick/keymaps/default/keymap.c @@ -0,0 +1,42 @@ +/* +Copyright 2021 Danny Nguyen + +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 + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + + [0] = LAYOUT( + KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12 + ), +}; + +void encoder_update_user(uint8_t index, bool clockwise) { + if (index == 0) { + if (clockwise) { + tap_code(KC_VOLU); + } else { + tap_code(KC_VOLD); + } + } + else if (index == 1) { + if (clockwise) { + tap_code(KC_DOWN); + } else { + tap_code(KC_UP); + } + } +} diff --git a/keyboards/keebio/stick/keymaps/via/keymap.c b/keyboards/keebio/stick/keymaps/via/keymap.c new file mode 100644 index 00000000000..3f712e61936 --- /dev/null +++ b/keyboards/keebio/stick/keymaps/via/keymap.c @@ -0,0 +1,54 @@ +/* +Copyright 2021 Danny Nguyen + +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 + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + + [0] = LAYOUT( + KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12 + ), + + [1] = LAYOUT( + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ + ), + + [2] = LAYOUT( + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ + ), + + [3] = LAYOUT( + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ + ), +}; + +void encoder_update_user(uint8_t index, bool clockwise) { + if (index == 0) { + if (clockwise) { + tap_code(KC_VOLU); + } else { + tap_code(KC_VOLD); + } + } + else if (index == 1) { + if (clockwise) { + tap_code(KC_DOWN); + } else { + tap_code(KC_UP); + } + } +} diff --git a/keyboards/keebio/stick/keymaps/via/rules.mk b/keyboards/keebio/stick/keymaps/via/rules.mk new file mode 100644 index 00000000000..d96967a6085 --- /dev/null +++ b/keyboards/keebio/stick/keymaps/via/rules.mk @@ -0,0 +1,5 @@ +VIA_ENABLE = yes +LTO_ENABLE = yes +MOUSEKEY_ENABLE = yes +CONSOLE_ENABLE = yes +COMMAND_ENABLE = no diff --git a/keyboards/keebio/stick/readme.md b/keyboards/keebio/stick/readme.md new file mode 100644 index 00000000000..ea7f7751f85 --- /dev/null +++ b/keyboards/keebio/stick/readme.md @@ -0,0 +1,19 @@ +# The Stick + +A 12-key macrostick keyboard made and sold by Keebio. [More info at Keebio](https://keeb.io). + +* Keyboard Maintainer: [Bakingpy/nooges](https://github.com/nooges) +* Hardware Supported: Pro Micro, Elite-C, Proton C +* Hardware Availability: [Keebio](https://keeb.io) + +Make example for this keyboard (after setting up your build environment): + + make keebio/stick:default + +Flashing example for this keyboard: + + make keebio/stick: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). + +A build guide for this keyboard can be found here: [Keebio Build Guides](https://docs.keeb.io) diff --git a/keyboards/keebio/stick/rules.mk b/keyboards/keebio/stick/rules.mk new file mode 100644 index 00000000000..36791b6c633 --- /dev/null +++ b/keyboards/keebio/stick/rules.mk @@ -0,0 +1,25 @@ +# MCU name +MCU = atmega32u4 + +# Bootloader selection +BOOTLOADER = caterina + +# Build Options +# change yes to no to disable +# +BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration +MOUSEKEY_ENABLE = yes # Mouse keys +EXTRAKEY_ENABLE = yes # Audio control and System control +CONSOLE_ENABLE = yes # 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 +ENCODER_ENABLE = yes +RGB_MATRIX_ENABLE = yes +RGB_MATRIX_DRIVER = WS2812 diff --git a/keyboards/keebio/stick/stick.c b/keyboards/keebio/stick/stick.c new file mode 100644 index 00000000000..050c4eff812 --- /dev/null +++ b/keyboards/keebio/stick/stick.c @@ -0,0 +1,50 @@ +/* +Copyright 2021 Danny Nguyen + +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 "stick.h" + +#ifdef RGB_MATRIX_ENABLE +led_config_t g_led_config = { { + // Key Matrix to LED Index + { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 } +}, { + // LED Index to Physical Position + { 0, 0 }, { 20, 0 }, { 40, 0 }, { 60, 0 }, + { 80, 0 }, { 100, 0 }, { 120, 0 }, { 140, 0 }, + { 160, 0 }, { 180, 0 }, { 200, 0 }, { 220, 0 }, +}, { + // LED Index to Flag + 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 +} }; +#endif + +void eeconfig_init_kb(void) { +#ifdef RGBLIGHT_ENABLE + rgblight_enable(); // Enable RGB by default + rgblight_sethsv(0, 255, 255); // Set default HSV - red hue, full saturation, full brightness +# ifdef RGBLIGHT_ANIMATIONS + rgblight_mode(RGBLIGHT_MODE_RAINBOW_SWIRL + 2); // set to RGB_RAINBOW_SWIRL by default +# endif +#endif + +#ifdef RGB_MATRIX_ENABLE + rgb_matrix_enable(); // Enable RGB by default +#endif + + eeconfig_update_kb(0); + eeconfig_init_user(); +} diff --git a/keyboards/keebio/stick/stick.h b/keyboards/keebio/stick/stick.h new file mode 100644 index 00000000000..758d7d5b975 --- /dev/null +++ b/keyboards/keebio/stick/stick.h @@ -0,0 +1,26 @@ +/* +Copyright 2021 Danny Nguyen + +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" + +#define LAYOUT( \ + A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12 \ + ) { \ + {A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12} \ + }