From d0b1d9f548aa39e1d267e8f62db4e0c65aae9206 Mon Sep 17 00:00:00 2001 From: AKiwi92 <69772382+AKiwi92@users.noreply.github.com> Date: Sat, 11 Sep 2021 05:20:43 +0100 Subject: [PATCH] [Keyboard] KiwiKeebs Macro V2 (QMK/VIA) and update to V1 (#13499) Co-authored-by: Joel Challis Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: Drashna Jaelre Co-authored-by: Ryan Co-authored-by: Ash --- keyboards/kiwikeebs/macro/config.h | 2 +- keyboards/kiwikeebs/macro/info.json | 2 +- .../kiwikeebs/macro/keymaps/default/keymap.c | 20 +++- .../kiwikeebs/macro/keymaps/via/keymap.c | 34 ++++++ .../kiwikeebs/macro/keymaps/via/rules.mk | 1 + keyboards/kiwikeebs/macro/readme.md | 19 +++ keyboards/kiwikeebs/macro/rules.mk | 2 +- keyboards/kiwikeebs/macro_v2/config.h | 108 ++++++++++++++++++ keyboards/kiwikeebs/macro_v2/info.json | 19 +++ .../macro_v2/keymaps/default/keymap.c | 44 +++++++ .../kiwikeebs/macro_v2/keymaps/via/keymap.c | 34 ++++++ .../kiwikeebs/macro_v2/keymaps/via/rules.mk | 1 + keyboards/kiwikeebs/macro_v2/macro_v2.c | 29 +++++ keyboards/kiwikeebs/macro_v2/macro_v2.h | 35 ++++++ keyboards/kiwikeebs/{ => macro_v2}/readme.md | 6 +- keyboards/kiwikeebs/macro_v2/rules.mk | 21 ++++ 16 files changed, 366 insertions(+), 11 deletions(-) create mode 100644 keyboards/kiwikeebs/macro/keymaps/via/keymap.c create mode 100644 keyboards/kiwikeebs/macro/keymaps/via/rules.mk create mode 100644 keyboards/kiwikeebs/macro/readme.md create mode 100644 keyboards/kiwikeebs/macro_v2/config.h create mode 100644 keyboards/kiwikeebs/macro_v2/info.json create mode 100644 keyboards/kiwikeebs/macro_v2/keymaps/default/keymap.c create mode 100644 keyboards/kiwikeebs/macro_v2/keymaps/via/keymap.c create mode 100644 keyboards/kiwikeebs/macro_v2/keymaps/via/rules.mk create mode 100644 keyboards/kiwikeebs/macro_v2/macro_v2.c create mode 100644 keyboards/kiwikeebs/macro_v2/macro_v2.h rename keyboards/kiwikeebs/{ => macro_v2}/readme.md (87%) create mode 100644 keyboards/kiwikeebs/macro_v2/rules.mk diff --git a/keyboards/kiwikeebs/macro/config.h b/keyboards/kiwikeebs/macro/config.h index 5753b52a0b..d9dcc3ba60 100644 --- a/keyboards/kiwikeebs/macro/config.h +++ b/keyboards/kiwikeebs/macro/config.h @@ -20,7 +20,7 @@ along with this program. If not, see . #include "config_common.h" /* USB Device descriptor parameter */ -#define VENDOR_ID 0xFEED +#define VENDOR_ID 0x4B51 #define PRODUCT_ID 0x4712 #define DEVICE_VER 0x0001 #define MANUFACTURER KiwiKeebs diff --git a/keyboards/kiwikeebs/macro/info.json b/keyboards/kiwikeebs/macro/info.json index 00726a02f4..723eb1908a 100644 --- a/keyboards/kiwikeebs/macro/info.json +++ b/keyboards/kiwikeebs/macro/info.json @@ -1,5 +1,5 @@ { - "keyboard_name": "KiwiKeebs MacroBoard v.10", + "keyboard_name": "KiwiKeebs MacroBoard v1.0", "url": "https://www.reddit.com/r/mechmarket/comments/ibijrd/ic_kiwikeebs_6key_macroboard_rotary_encoder_diy/", "maintainer": "KiwiKeebs", "width": 5, diff --git a/keyboards/kiwikeebs/macro/keymaps/default/keymap.c b/keyboards/kiwikeebs/macro/keymaps/default/keymap.c index 7d1acce308..caa6b4aafc 100644 --- a/keyboards/kiwikeebs/macro/keymaps/default/keymap.c +++ b/keyboards/kiwikeebs/macro/keymaps/default/keymap.c @@ -18,17 +18,27 @@ // Defines names for use in layer keycodes and the keymap enum layer_names { _BASE, - _FN + _FN1, + _FN2, + _FN3 }; const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { /* Base */ [_BASE] = LAYOUT( - KC_DEL, KC_HOME, LT(_FN,KC_END), + KC_DEL, KC_HOME, LT(_FN1,KC_END), KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE ), - [_FN] = LAYOUT( - KC_1, KC_UP, _______, - KC_LEFT, KC_DOWN, KC_RGHT, _______ + [_FN1] = LAYOUT( + RESET, KC_UP, _______, + KC_LEFT, KC_DOWN, KC_RGHT, MAGIC_TOGGLE_NKRO + ), + [_FN2] = LAYOUT( + _______, _______, _______, + _______, _______, _______, _______ + ), + [_FN3] = LAYOUT( + _______, _______, _______, + _______, _______, _______, _______ ) }; diff --git a/keyboards/kiwikeebs/macro/keymaps/via/keymap.c b/keyboards/kiwikeebs/macro/keymaps/via/keymap.c new file mode 100644 index 0000000000..56dffdbd93 --- /dev/null +++ b/keyboards/kiwikeebs/macro/keymaps/via/keymap.c @@ -0,0 +1,34 @@ +/* Copyright 2020 KiwiKeebs + * + * 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, + _FN +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + /* Base */ + [_BASE] = LAYOUT( + KC_DEL, KC_HOME, LT(_FN,KC_END), + KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE + ), + [_FN] = LAYOUT( + RESET, KC_UP, _______, + KC_LEFT, KC_DOWN, KC_RGHT, MAGIC_TOGGLE_NKRO + ) +}; diff --git a/keyboards/kiwikeebs/macro/keymaps/via/rules.mk b/keyboards/kiwikeebs/macro/keymaps/via/rules.mk new file mode 100644 index 0000000000..1e5b99807c --- /dev/null +++ b/keyboards/kiwikeebs/macro/keymaps/via/rules.mk @@ -0,0 +1 @@ +VIA_ENABLE = yes diff --git a/keyboards/kiwikeebs/macro/readme.md b/keyboards/kiwikeebs/macro/readme.md new file mode 100644 index 0000000000..ce9d4ea8cc --- /dev/null +++ b/keyboards/kiwikeebs/macro/readme.md @@ -0,0 +1,19 @@ +# KiwiKeebs MacroBoard V1.0 + +![KiwiKeebs](https://kiwikeebs.co.uk/wp-content/themes/storefront-child-theme-master/images/kiwikeebs-logo.svg) + +A 6 Key PCB with Rotary Encoder Knob + Button made from solid CNC aluminium. + +* Keyboard Maintainer: [AKiwi92](https://github.com/akiwi92) +* Hardware Supported: KiwiKeebs MacroBoard V1.0 +* Hardware Availability: [reddit.com](https://www.reddit.com/r/mechmarket/comments/ibijrd/ic_kiwikeebs_6key_macroboard_rotary_encoder_diy/) + +Make example for this keyboard (after setting up your build environment): + + make kiwikeebs/macro:default + +Flashing example for this keyboard: + + make kiwikeebs/macro: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/kiwikeebs/macro/rules.mk b/keyboards/kiwikeebs/macro/rules.mk index a71e4764c1..1cb11af09f 100644 --- a/keyboards/kiwikeebs/macro/rules.mk +++ b/keyboards/kiwikeebs/macro/rules.mk @@ -13,7 +13,7 @@ EXTRAKEY_ENABLE = yes # Audio control and System control CONSOLE_ENABLE = no # Console for debug COMMAND_ENABLE = no # Commands for debug and configuration SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend -NKRO_ENABLE = no # USB Nkey Rollover +NKRO_ENABLE = yes # USB Nkey Rollover BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow BLUETOOTH_ENABLE = no # Enable Bluetooth diff --git a/keyboards/kiwikeebs/macro_v2/config.h b/keyboards/kiwikeebs/macro_v2/config.h new file mode 100644 index 0000000000..ab486fe54d --- /dev/null +++ b/keyboards/kiwikeebs/macro_v2/config.h @@ -0,0 +1,108 @@ +/* +Copyright 2020 KiwiKeebs + +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 0x4B51 +#define PRODUCT_ID 0x4712 +#define DEVICE_VER 0x0001 +#define MANUFACTURER KiwiKeebs +#define PRODUCT MacroBoard v.2.0 + +/* key matrix size */ +#define MATRIX_ROWS 2 +#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, D7 } +#define MATRIX_COL_PINS { F7, B1, B3, B2 } +#define UNUSED_PINS + +/* COL2ROW or ROW2COL */ +#define DIODE_DIRECTION COL2ROW + +#define ENCODERS_PAD_A { D1 } +#define ENCODERS_PAD_B { D0 } + +/* 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 diff --git a/keyboards/kiwikeebs/macro_v2/info.json b/keyboards/kiwikeebs/macro_v2/info.json new file mode 100644 index 0000000000..524e259463 --- /dev/null +++ b/keyboards/kiwikeebs/macro_v2/info.json @@ -0,0 +1,19 @@ +{ + "keyboard_name": "KiwiKeebs MacroBoard v.2.0", + "url": "https://www.reddit.com/r/mechmarket/comments/ibijrd/ic_kiwikeebs_6key_macroboard_rotary_encoder_diy/", + "maintainer": "KiwiKeebs", + "layouts": { + "LAYOUT": { + "layout": [ + { "label": "k00", "x": 0, "y": 0 }, + { "label": "k01", "x": 1, "y": 0 }, + { "label": "k02", "x": 2, "y": 0 }, + + { "label": "k03", "x": 0, "y": 1 }, + { "label": "k04", "x": 1, "y": 1 }, + { "label": "k05", "x": 2, "y": 1 }, + { "label": "k06", "x": 3, "y": 0, "h":2, "w":2 } + ] + } + } +} diff --git a/keyboards/kiwikeebs/macro_v2/keymaps/default/keymap.c b/keyboards/kiwikeebs/macro_v2/keymaps/default/keymap.c new file mode 100644 index 0000000000..dd0def64b6 --- /dev/null +++ b/keyboards/kiwikeebs/macro_v2/keymaps/default/keymap.c @@ -0,0 +1,44 @@ +/* Copyright 2020 KiwiKeebs + * + * 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 */ + [_BASE] = LAYOUT( + KC_DEL, KC_HOME, LT(_FN1,KC_END), + KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE + ), + [_FN1] = LAYOUT( + RESET, KC_UP, _______, + KC_LEFT, KC_DOWN, KC_RGHT, MAGIC_TOGGLE_NKRO + ), + [_FN2] = LAYOUT( + _______, _______, _______, + _______, _______, _______, _______ + ), + [_FN3] = LAYOUT( + _______, _______, _______, + _______, _______, _______, _______ + ) +}; \ No newline at end of file diff --git a/keyboards/kiwikeebs/macro_v2/keymaps/via/keymap.c b/keyboards/kiwikeebs/macro_v2/keymaps/via/keymap.c new file mode 100644 index 0000000000..56dffdbd93 --- /dev/null +++ b/keyboards/kiwikeebs/macro_v2/keymaps/via/keymap.c @@ -0,0 +1,34 @@ +/* Copyright 2020 KiwiKeebs + * + * 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, + _FN +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + /* Base */ + [_BASE] = LAYOUT( + KC_DEL, KC_HOME, LT(_FN,KC_END), + KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE + ), + [_FN] = LAYOUT( + RESET, KC_UP, _______, + KC_LEFT, KC_DOWN, KC_RGHT, MAGIC_TOGGLE_NKRO + ) +}; diff --git a/keyboards/kiwikeebs/macro_v2/keymaps/via/rules.mk b/keyboards/kiwikeebs/macro_v2/keymaps/via/rules.mk new file mode 100644 index 0000000000..1e5b99807c --- /dev/null +++ b/keyboards/kiwikeebs/macro_v2/keymaps/via/rules.mk @@ -0,0 +1 @@ +VIA_ENABLE = yes diff --git a/keyboards/kiwikeebs/macro_v2/macro_v2.c b/keyboards/kiwikeebs/macro_v2/macro_v2.c new file mode 100644 index 0000000000..795da21cc9 --- /dev/null +++ b/keyboards/kiwikeebs/macro_v2/macro_v2.c @@ -0,0 +1,29 @@ +/* Copyright 2020 KiwiKeebs + * + * 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 "macro_v2.h" + +bool encoder_update_kb(uint8_t index, bool clockwise) { + if (!encoder_update_user(index, clockwise)) return false; + if (index == 0) { /* First encoder */ + if (clockwise) { + tap_code(KC_AUDIO_VOL_UP); + } else { + tap_code(KC_AUDIO_VOL_DOWN); + } + } + return true; +} diff --git a/keyboards/kiwikeebs/macro_v2/macro_v2.h b/keyboards/kiwikeebs/macro_v2/macro_v2.h new file mode 100644 index 0000000000..ee7c6bd47d --- /dev/null +++ b/keyboards/kiwikeebs/macro_v2/macro_v2.h @@ -0,0 +1,35 @@ +/* Copyright 2020 KiwiKeebs + * + * 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 \ +) { \ + { k00, k01, k02, KC_NO }, \ + { k03, k04, k05, k06 } \ +} diff --git a/keyboards/kiwikeebs/readme.md b/keyboards/kiwikeebs/macro_v2/readme.md similarity index 87% rename from keyboards/kiwikeebs/readme.md rename to keyboards/kiwikeebs/macro_v2/readme.md index 61a1441bd7..a581f9cbce 100644 --- a/keyboards/kiwikeebs/readme.md +++ b/keyboards/kiwikeebs/macro_v2/readme.md @@ -1,4 +1,4 @@ -# KiwiKeebs MacroBoard V1.0 +# KiwiKeebs MacroBoard V2.0 ![KiwiKeebs](https://i.imgur.com/h5i9jBl.png) @@ -10,10 +10,10 @@ A 6 Key PCB with Rotary Encoder Knob + Button made from solid CNC aluminium. Make example for this keyboard (after setting up your build environment): - make kiwikeebsmacro:default + make kiwikeebs/macro_v2:default Flashing example for this keyboard: - make kiwikeebsmacro:default:flash + make kiwikeebs/macro_v2: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/kiwikeebs/macro_v2/rules.mk b/keyboards/kiwikeebs/macro_v2/rules.mk new file mode 100644 index 0000000000..c1524daac2 --- /dev/null +++ b/keyboards/kiwikeebs/macro_v2/rules.mk @@ -0,0 +1,21 @@ +# 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 = 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 +SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend +NKRO_ENABLE = yes # 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 \ No newline at end of file