From 98b237a21bf36aa073073ba74c51851a494214d3 Mon Sep 17 00:00:00 2001 From: MechMerlin <30334081+mechmerlin@users.noreply.github.com> Date: Tue, 6 Aug 2019 10:38:28 -0700 Subject: [PATCH] [Keyboard] New Keyboard: Booster (#6486) * initial commit * port over the kbfirmware json * add numpad_5x4 LAYOUT support * fix up layout macro to allow community layout support * add a sparse readme on how to contact Percent Studio * change .h to a .md file * fix firmware file too large error * Update keyboards/percent/booster/info.json Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/percent/booster/info.json Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/percent/booster/info.json Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/percent/booster/info.json Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/percent/booster/info.json Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/percent/booster/keymaps/default/keymap.c Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/percent/booster/keymaps/default/keymap.c Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/percent/booster/keymaps/default/keymap.c Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/percent/booster/keymaps/default/keymap.c Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/percent/booster/keymaps/default/keymap.c Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/percent/booster/keymaps/default/keymap.c Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> --- keyboards/percent/booster/booster.c | 51 ++++++++++++++++++ keyboards/percent/booster/booster.h | 32 ++++++++++++ keyboards/percent/booster/config.h | 52 +++++++++++++++++++ keyboards/percent/booster/info.json | 31 +++++++++++ .../percent/booster/keymaps/default/keymap.c | 27 ++++++++++ .../percent/booster/keymaps/default/readme.md | 1 + keyboards/percent/booster/readme.md | 13 +++++ keyboards/percent/booster/rules.mk | 39 ++++++++++++++ keyboards/percent/readme.md | 6 +++ 9 files changed, 252 insertions(+) create mode 100644 keyboards/percent/booster/booster.c create mode 100644 keyboards/percent/booster/booster.h create mode 100644 keyboards/percent/booster/config.h create mode 100644 keyboards/percent/booster/info.json create mode 100644 keyboards/percent/booster/keymaps/default/keymap.c create mode 100644 keyboards/percent/booster/keymaps/default/readme.md create mode 100644 keyboards/percent/booster/readme.md create mode 100644 keyboards/percent/booster/rules.mk create mode 100644 keyboards/percent/readme.md diff --git a/keyboards/percent/booster/booster.c b/keyboards/percent/booster/booster.c new file mode 100644 index 000000000..3a298f58f --- /dev/null +++ b/keyboards/percent/booster/booster.c @@ -0,0 +1,51 @@ +/* Copyright 2019 MechMerlin + * + * 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 "booster.h" + +// Optional override functions below. +// You can leave any or all of these undefined. +// These are only required if you want to perform custom actions. + +/* + +void matrix_init_kb(void) { + // put your keyboard start-up code here + // runs once when the firmware starts up + + matrix_init_user(); +} + +void matrix_scan_kb(void) { + // put your looping keyboard code here + // runs every cycle (a lot) + + matrix_scan_user(); +} + +bool process_record_kb(uint16_t keycode, keyrecord_t *record) { + // put your per-action keyboard code here + // runs for every action, just before processing by the firmware + + return process_record_user(keycode, record); +} + +void led_set_kb(uint8_t usb_led) { + // put your keyboard LED indicator (ex: Caps Lock LED) toggling code here + + led_set_user(usb_led); +} + +*/ diff --git a/keyboards/percent/booster/booster.h b/keyboards/percent/booster/booster.h new file mode 100644 index 000000000..be2d2cb12 --- /dev/null +++ b/keyboards/percent/booster/booster.h @@ -0,0 +1,32 @@ +/* Copyright 2019 MechMerlin + * + * 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_numpad_5x4( \ + K00, K01, K02, K03, \ + K10, K11, K12, \ + K20, K21, K22, K23, \ + K30, K31, K32, \ + K40, K42, K33 \ +) { \ + { K00, K01, K02, K03 }, \ + { K10, K11, K12, KC_NO }, \ + { K20, K21, K22, K23 }, \ + { K30, K31, K32, K33 }, \ + { K40, KC_NO, K42, KC_NO }, \ +} diff --git a/keyboards/percent/booster/config.h b/keyboards/percent/booster/config.h new file mode 100644 index 000000000..23ac7ad0c --- /dev/null +++ b/keyboards/percent/booster/config.h @@ -0,0 +1,52 @@ +/* +Copyright 2019 MechMerlin + +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 0xFEED +#define PRODUCT_ID 0x0000 +#define DEVICE_VER 0x0001 +#define MANUFACTURER Percent Studio +#define PRODUCT Booster +#define DESCRIPTION Custom programmable numpad + +/* key matrix size */ +#define MATRIX_ROWS 5 +#define MATRIX_COLS 4 + +#define MATRIX_ROW_PINS { D1, D6, D7, B4, B5 } +#define MATRIX_COL_PINS { C7, D4, D2, D0 } + +#define BACKLIGHT_PIN B7 +#define BACKLIGHT_LEVELS 3 + +#define DIODE_DIRECTION COL2ROW + +#define RGB_DI_PIN E2 +#ifdef RGB_DI_PIN + #define RGBLED_NUM 10 + #define RGBLIGHT_HUE_STEP 8 + #define RGBLIGHT_SAT_STEP 8 + #define RGBLIGHT_VAL_STEP 8 + #define RGBLIGHT_LIMIT_VAL 255 + #define RGBLIGHT_SLEEP + #define RGBLIGHT_ANIMATIONS +#endif + diff --git a/keyboards/percent/booster/info.json b/keyboards/percent/booster/info.json new file mode 100644 index 000000000..c5d230deb --- /dev/null +++ b/keyboards/percent/booster/info.json @@ -0,0 +1,31 @@ +{ + "keyboard_name": "booster", + "url": "", + "maintainer": "qmk", + "width": 4, + "height": 5, + "layouts": { + "LAYOUT": { + "key_count": 17, + "layout": [ + {"label":"K00 (D1,C7)", "x":0, "y":0}, + {"label":"K01 (D1,D4)", "x":1, "y":0}, + {"label":"K02 (D1,D2)", "x":2, "y":0}, + {"label":"K03 (D1,D0)", "x":3, "y":0}, + {"label":"K10 (D6,C7)", "x":0, "y":1}, + {"label":"K11 (D6,D4)", "x":1, "y":1}, + {"label":"K12 (D6,D2)", "x":2, "y":1}, + {"label":"K20 (D7,C7)", "x":0, "y":2}, + {"label":"K21 (D7,D4)", "x":1, "y":2}, + {"label":"K22 (D7,D2)", "x":2, "y":2}, + {"label":"K23 (D7,D0)", "x":3, "y":1, "h":2}, + {"label":"K30 (B4,C7)", "x":0, "y":3}, + {"label":"K31 (B4,D4)", "x":1, "y":3}, + {"label":"K32 (B4,D2)", "x":2, "y":3}, + {"label":"K40 (B5,C7)", "x":0, "y":4, "w":2}, + {"label":"K42 (B5,D2)", "x":2, "y":4}, + {"label":"K33 (B4,D0)", "x":3, "y":3, "h":2} + ] + } + } +} diff --git a/keyboards/percent/booster/keymaps/default/keymap.c b/keyboards/percent/booster/keymaps/default/keymap.c new file mode 100644 index 000000000..919774bca --- /dev/null +++ b/keyboards/percent/booster/keymaps/default/keymap.c @@ -0,0 +1,27 @@ +/* Copyright 2019 MechMerlin + * + * 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_numpad_5x4( + KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS, + KC_P7, KC_P8, KC_P9, + KC_P4, KC_P5, KC_P6, KC_PPLS, + KC_P1, KC_P2, KC_P3, + KC_P0, KC_PDOT, KC_PENT + ), + +}; diff --git a/keyboards/percent/booster/keymaps/default/readme.md b/keyboards/percent/booster/keymaps/default/readme.md new file mode 100644 index 000000000..0293153f0 --- /dev/null +++ b/keyboards/percent/booster/keymaps/default/readme.md @@ -0,0 +1 @@ +# The default keymap for Booster diff --git a/keyboards/percent/booster/readme.md b/keyboards/percent/booster/readme.md new file mode 100644 index 000000000..78b4b5a35 --- /dev/null +++ b/keyboards/percent/booster/readme.md @@ -0,0 +1,13 @@ +# Booster + +Booster is a number pad designed for Canoe. Shared exactly the same angle and approximate design language, + +Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) +Hardware Supported: Booster PCB +Hardware Availability: [Percent Studio Store](https://percent.studio/products/booster-for-canoe-65) + +Make example for this keyboard (after setting up your build environment): + + make percent/booster:default + +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/percent/booster/rules.mk b/keyboards/percent/booster/rules.mk new file mode 100644 index 000000000..30e66537f --- /dev/null +++ b/keyboards/percent/booster/rules.mk @@ -0,0 +1,39 @@ +MCU = atmega32u4 +F_CPU = 16000000 +ARCH = AVR8 +F_USB = $(F_CPU) +OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT + + +# Bootloader selection +# Teensy halfkay +# Pro Micro caterina +# Atmel DFU atmel-dfu +# LUFA DFU lufa-dfu +# QMK DFU qmk-dfu +# atmega32a bootloadHID +BOOTLOADER = atmel-dfu + +# 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 = yes # 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 = yes # Enable keyboard backlight functionality +RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow +MIDI_ENABLE = no # MIDI support +UNICODE_ENABLE = no # Unicode +BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID +AUDIO_ENABLE = no # Audio output on port C6 +FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches +HD44780_ENABLE = no # Enable support for HD44780 based LCDs +EXTRAFLAGS += -flto + +LAYOUTS = numpad_5x4 \ No newline at end of file diff --git a/keyboards/percent/readme.md b/keyboards/percent/readme.md new file mode 100644 index 000000000..8028edf03 --- /dev/null +++ b/keyboards/percent/readme.md @@ -0,0 +1,6 @@ +# Percent Studio + +[Website](https://percent.studio/) +[Facebook](https://www.facebook.com/PercentStudio.CN/) +[Instagram](https://www.instagram.com/percent.studio/) +[Taobao](https://shop140162967.world.taobao.com/?spm=a1z09.1.sellercard.15.15ec3606mPki7O) \ No newline at end of file