Skip to content

Commit

Permalink
[Keyboard] KiwiKeebs Macro V2 (QMK/VIA) and update to V1 (qmk#13499)
Browse files Browse the repository at this point in the history
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ash <ash@splitpixel.co.uk>
  • Loading branch information
6 people authored Sep 11, 2021
1 parent 6213989 commit d0b1d9f
Show file tree
Hide file tree
Showing 16 changed files with 366 additions and 11 deletions.
2 changes: 1 addition & 1 deletion keyboards/kiwikeebs/macro/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#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
Expand Down
2 changes: 1 addition & 1 deletion keyboards/kiwikeebs/macro/info.json
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
20 changes: 15 additions & 5 deletions keyboards/kiwikeebs/macro/keymaps/default/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -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(
_______, _______, _______,
_______, _______, _______, _______
)
};
34 changes: 34 additions & 0 deletions keyboards/kiwikeebs/macro/keymaps/via/keymap.c
Original file line number Diff line number Diff line change
@@ -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 <http://www.gnu.org/licenses/>.
*/
#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
)
};
1 change: 1 addition & 0 deletions keyboards/kiwikeebs/macro/keymaps/via/rules.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
VIA_ENABLE = yes
19 changes: 19 additions & 0 deletions keyboards/kiwikeebs/macro/readme.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion keyboards/kiwikeebs/macro/rules.mk
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
108 changes: 108 additions & 0 deletions keyboards/kiwikeebs/macro_v2/config.h
Original file line number Diff line number Diff line change
@@ -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 <http://www.gnu.org/licenses/>.
*/

#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
19 changes: 19 additions & 0 deletions keyboards/kiwikeebs/macro_v2/info.json
Original file line number Diff line number Diff line change
@@ -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 }
]
}
}
}
44 changes: 44 additions & 0 deletions keyboards/kiwikeebs/macro_v2/keymaps/default/keymap.c
Original file line number Diff line number Diff line change
@@ -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 <http://www.gnu.org/licenses/>.
*/
#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(
_______, _______, _______,
_______, _______, _______, _______
)
};
34 changes: 34 additions & 0 deletions keyboards/kiwikeebs/macro_v2/keymaps/via/keymap.c
Original file line number Diff line number Diff line change
@@ -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 <http://www.gnu.org/licenses/>.
*/
#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
)
};
1 change: 1 addition & 0 deletions keyboards/kiwikeebs/macro_v2/keymaps/via/rules.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
VIA_ENABLE = yes
29 changes: 29 additions & 0 deletions keyboards/kiwikeebs/macro_v2/macro_v2.c
Original file line number Diff line number Diff line change
@@ -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 <http://www.gnu.org/licenses/>.
*/

#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;
}
35 changes: 35 additions & 0 deletions keyboards/kiwikeebs/macro_v2/macro_v2.h
Original file line number Diff line number Diff line change
@@ -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 <http://www.gnu.org/licenses/>.
*/

#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 } \
}
Loading

0 comments on commit d0b1d9f

Please sign in to comment.