aboutsummaryrefslogtreecommitdiff
path: root/keyboards/handwired
diff options
context:
space:
mode:
authorMichał Szczepaniak <m.szczepaniak.000@gmail.com>2022-02-05 15:27:41 +0100
committerGitHub <noreply@github.com>2022-02-05 14:27:41 +0000
commitdf371257552d9b8a9e290d8ddd120ea96f3dd9e6 (patch)
tree50872d9a28e03274ba8b2a1d340e0e47c978541f /keyboards/handwired
parent10fda3ec8e4ee0a74bb4e8c0f41e554fb7344e78 (diff)
downloadqmk_firmware-df371257552d9b8a9e290d8ddd120ea96f3dd9e6.tar.gz
qmk_firmware-df371257552d9b8a9e290d8ddd120ea96f3dd9e6.zip
Add macroboard(5x6 OLKB blackpill) keyboard (#16219)
* Add macroboard keyboard * Fix issues requested in pull request * Removed halconf/mcuconf and moved to handwired directory * Added description, enabled bootmagic, disabled console * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/handwired')
-rw-r--r--keyboards/handwired/macroboard/chconf.h39
-rw-r--r--keyboards/handwired/macroboard/config.h141
-rw-r--r--keyboards/handwired/macroboard/info.json41
-rw-r--r--keyboards/handwired/macroboard/keymaps/default/keymap.c27
-rw-r--r--keyboards/handwired/macroboard/keymaps/default/readme.md1
-rw-r--r--keyboards/handwired/macroboard/macroboard.c17
-rw-r--r--keyboards/handwired/macroboard/macroboard.h41
-rw-r--r--keyboards/handwired/macroboard/readme.md27
-rw-r--r--keyboards/handwired/macroboard/rules.mk19
9 files changed, 353 insertions, 0 deletions
diff --git a/keyboards/handwired/macroboard/chconf.h b/keyboards/handwired/macroboard/chconf.h
new file mode 100644
index 000000000..de4ab83ec
--- /dev/null
+++ b/keyboards/handwired/macroboard/chconf.h
@@ -0,0 +1,39 @@
1/* Copyright 2020 QMK
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17/*
18 * This file was auto-generated by:
19 * `qmk chibios-confmigrate -i keyboards/handwired/onekey/blackpill_f401/chconf.h -r platforms/chibios/common/configs/chconf.h`
20 */
21
22#pragma once
23
24#define CH_CFG_ST_FREQUENCY 10000
25
26#define CH_CFG_FACTORY_OBJECTS_REGISTRY TRUE
27
28#define CH_CFG_FACTORY_GENERIC_BUFFERS TRUE
29
30#define CH_CFG_FACTORY_SEMAPHORES TRUE
31
32#define CH_CFG_FACTORY_MAILBOXES TRUE
33
34#define CH_CFG_FACTORY_OBJ_FIFOS TRUE
35
36#define CH_CFG_FACTORY_PIPES TRUE
37
38#include_next <chconf.h>
39
diff --git a/keyboards/handwired/macroboard/config.h b/keyboards/handwired/macroboard/config.h
new file mode 100644
index 000000000..92b633d75
--- /dev/null
+++ b/keyboards/handwired/macroboard/config.h
@@ -0,0 +1,141 @@
1/*
2Copyright 2021 Michał Szczepaniak
3
4This program is free software: you can redistribute it and/or modify
5it under the terms of the GNU General Public License as published by
6the Free Software Foundation, either version 2 of the License, or
7(at your option) any later version.
8
9This program is distributed in the hope that it will be useful,
10but WITHOUT ANY WARRANTY; without even the implied warranty of
11MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12GNU General Public License for more details.
13
14You should have received a copy of the GNU General Public License
15along with this program. If not, see <http://www.gnu.org/licenses/>.
16*/
17
18#pragma once
19
20#include "config_common.h"
21
22/* USB Device descriptor parameter */
23#define VENDOR_ID 0xFEED
24#define PRODUCT_ID 0x6465
25#define DEVICE_VER 0x0001
26#define MANUFACTURER QMK
27
28/* key matrix size */
29#define MATRIX_ROWS 5
30#define MATRIX_COLS 6
31
32/*
33 * Keyboard Matrix Assignments
34 *
35 * Change this to how you wired your keyboard
36 * COLS: AVR pins used for columns, left to right
37 * ROWS: AVR pins used for rows, top to bottom
38 * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
39 * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
40 *
41 */
42#define MATRIX_ROW_PINS { A15, B3, B4, B5, B7 }
43#define MATRIX_COL_PINS { B12, B13, B14, B15, A8, A10 }
44#define UNUSED_PINS
45
46#define DIODE_DIRECTION COL2ROW
47
48/*
49 * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
50 */
51//#define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6
52
53//#define LED_NUM_LOCK_PIN B0
54//#define LED_CAPS_LOCK_PIN B1
55//#define LED_SCROLL_LOCK_PIN B2
56//#define LED_COMPOSE_PIN B3
57//#define LED_KANA_PIN B4
58
59//#define BACKLIGHT_PIN B7
60//#define BACKLIGHT_LEVELS 3
61// #define BACKLIGHT_BREATHING
62
63#define RGB_DI_PIN B9
64#ifdef RGB_DI_PIN
65# define RGBLED_NUM 24
66# define RGBLIGHT_HUE_STEP 8
67# define RGBLIGHT_SAT_STEP 8
68# define RGBLIGHT_VAL_STEP 8
69# define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
70//# define RGBLIGHT_SLEEP /* If defined, the RGB lighting will be switched off when the host goes to sleep */
71# define RGBLIGHT_EFFECT_BREATHING
72# define RGBLIGHT_EFFECT_RAINBOW_MOOD
73# define RGBLIGHT_EFFECT_RAINBOW_SWIRL
74# define RGBLIGHT_EFFECT_SNAKE
75# define RGBLIGHT_EFFECT_KNIGHT
76# define RGBLIGHT_EFFECT_CHRISTMAS
77# define RGBLIGHT_EFFECT_STATIC_GRADIENT
78//# define RGBLIGHT_EFFECT_RGB_TEST
79# define RGBLIGHT_EFFECT_ALTERNATING
80#endif
81
82/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
83#define DEBOUNCE 5
84
85/* define if matrix has ghost (lacks anti-ghosting diodes) */
86//#define MATRIX_HAS_GHOST
87
88/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
89#define LOCKING_SUPPORT_ENABLE
90/* Locking resynchronize hack */
91#define LOCKING_RESYNC_ENABLE
92
93/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
94 * This is useful for the Windows task manager shortcut (ctrl+shift+esc).
95 */
96//#define GRAVE_ESC_CTRL_OVERRIDE
97
98/*
99 * Force NKRO
100 *
101 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
102 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
103 * makefile for this to work.)
104 *
105 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
106 * until the next keyboard reset.
107 *
108 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
109 * fully operational during normal computer usage.
110 *
111 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
112 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
113 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
114 * power-up.
115 *
116 */
117//#define FORCE_NKRO
118
119/*
120 * Feature disable options
121 * These options are also useful to firmware size reduction.
122 */
123
124/* disable debug print */
125//#define NO_DEBUG
126
127/* disable print */
128//#define NO_PRINT
129
130/* disable action features */
131//#define NO_ACTION_LAYER
132//#define NO_ACTION_TAPPING
133//#define NO_ACTION_ONESHOT
134
135/* disable these deprecated features by default */
136#define NO_ACTION_MACRO
137#define NO_ACTION_FUNCTION
138
139/* Bootmagic Lite key configuration */
140//#define BOOTMAGIC_LITE_ROW 0
141//#define BOOTMAGIC_LITE_COLUMN 0
diff --git a/keyboards/handwired/macroboard/info.json b/keyboards/handwired/macroboard/info.json
new file mode 100644
index 000000000..2aa44eb80
--- /dev/null
+++ b/keyboards/handwired/macroboard/info.json
@@ -0,0 +1,41 @@
1{
2 "keyboard_name": "macroboard",
3 "url": "",
4 "maintainer": "Michał Szczepaniak",
5 "layouts": {
6 "LAYOUT_ortho_5x6": {
7 "layout": [
8 {"label": "k00", "x": 0, "y": 0},
9 {"label": "k01", "x": 1, "y": 0},
10 {"label": "k02", "x": 2, "y": 0},
11 {"label": "k03", "x": 3, "y": 0},
12 {"label": "k04", "x": 4, "y": 0},
13 {"label": "k05", "x": 5, "y": 0},
14 {"label": "k10", "x": 0, "y": 1},
15 {"label": "k11", "x": 1, "y": 1},
16 {"label": "k12", "x": 2, "y": 1},
17 {"label": "k13", "x": 3, "y": 1},
18 {"label": "k14", "x": 4, "y": 1},
19 {"label": "k15", "x": 5, "y": 1},
20 {"label": "k20", "x": 0, "y": 2},
21 {"label": "k21", "x": 1, "y": 2},
22 {"label": "k22", "x": 2, "y": 2},
23 {"label": "k23", "x": 3, "y": 2},
24 {"label": "k24", "x": 4, "y": 2},
25 {"label": "k25", "x": 5, "y": 2},
26 {"label": "k30", "x": 0, "y": 3},
27 {"label": "k31", "x": 1, "y": 3},
28 {"label": "k32", "x": 2, "y": 3},
29 {"label": "k33", "x": 3, "y": 3},
30 {"label": "k34", "x": 4, "y": 3},
31 {"label": "k35", "x": 5, "y": 3},
32 {"label": "k40", "x": 0, "y": 4},
33 {"label": "k41", "x": 1, "y": 4},
34 {"label": "k42", "x": 2, "y": 4},
35 {"label": "k43", "x": 3, "y": 4},
36 {"label": "k44", "x": 4, "y": 4},
37 {"label": "k45", "x": 5, "y": 4}
38 ]
39 }
40 }
41}
diff --git a/keyboards/handwired/macroboard/keymaps/default/keymap.c b/keyboards/handwired/macroboard/keymaps/default/keymap.c
new file mode 100644
index 000000000..ec587ee25
--- /dev/null
+++ b/keyboards/handwired/macroboard/keymaps/default/keymap.c
@@ -0,0 +1,27 @@
1/* Copyright 2021 Michał Szczepaniak
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16#include QMK_KEYBOARD_H
17
18const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
19 [0] = LAYOUT_ortho_5x6(
20 KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5,
21 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T,
22 KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G,
23 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B,
24 KC_LCTL, KC_LGUI, RGB_TOG, KC_LALT, RESET, KC_SPC
25 )
26};
27
diff --git a/keyboards/handwired/macroboard/keymaps/default/readme.md b/keyboards/handwired/macroboard/keymaps/default/readme.md
new file mode 100644
index 000000000..39fa5888e
--- /dev/null
+++ b/keyboards/handwired/macroboard/keymaps/default/readme.md
@@ -0,0 +1 @@
# The default keymap for macroboard
diff --git a/keyboards/handwired/macroboard/macroboard.c b/keyboards/handwired/macroboard/macroboard.c
new file mode 100644
index 000000000..f9d41ff16
--- /dev/null
+++ b/keyboards/handwired/macroboard/macroboard.c
@@ -0,0 +1,17 @@
1/* Copyright 2021 Michał Szczepaniak
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17#include "macroboard.h"
diff --git a/keyboards/handwired/macroboard/macroboard.h b/keyboards/handwired/macroboard/macroboard.h
new file mode 100644
index 000000000..9909e63af
--- /dev/null
+++ b/keyboards/handwired/macroboard/macroboard.h
@@ -0,0 +1,41 @@
1/* Copyright 2021 Michał Szczepaniak
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17#pragma once
18
19#include "quantum.h"
20
21/* This is a shortcut to help you visually see your layout.
22 *
23 * The first section contains all of the arguments representing the physical
24 * layout of the board and position of the keys.
25 *
26 * The second converts the arguments into a two-dimensional array which
27 * represents the switch matrix.
28 */
29#define LAYOUT_ortho_5x6( \
30 k00, k01, k02, k03, k04, k05, \
31 k10, k11, k12, k13, k14, k15, \
32 k20, k21, k22, k23, k24, k25, \
33 k30, k31, k32, k33, k34, k35, \
34 k40, k41, k42, k43, k44, k45 \
35) { \
36 { k00, k01, k02, k03, k04, k05 }, \
37 { k10, k11, k12, k13, k14, k15 }, \
38 { k20, k21, k22, k23, k24, k25 }, \
39 { k30, k31, k32, k33, k34, k35 }, \
40 { k40, k41, k42, k43, k44, k45 } \
41}
diff --git a/keyboards/handwired/macroboard/readme.md b/keyboards/handwired/macroboard/readme.md
new file mode 100644
index 000000000..ee2351f99
--- /dev/null
+++ b/keyboards/handwired/macroboard/readme.md
@@ -0,0 +1,27 @@
1# macroboard
2
3![macroboard](https://i.imgur.com/AY5Y1Ez.png)
4
53D printable half preonic (5x6 OLKB) with purpose of being macroboard or if you want to have different switches for gaming while having normal full keyboard for typing.
6
7* Keyboard Maintainer: [Michał Szczepaniak](https://github.com/Michal-Szczepaniak)
8* Hardware Supported: Blackpill
9* Hardware Availability: [OpenSCAD files](https://github.com/Michal-Szczepaniak/macroboard-openscad)
10
11Make example for this keyboard (after setting up your build environment):
12
13 make handwired/macroboard:default
14
15Flashing example for this keyboard:
16
17 make handwired/macroboard:default:flash
18
19See 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).
20
21## Bootloader
22
23Enter the bootloader in 3 ways:
24
25* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
26* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
27* **Keycode in layout**: Press the key mapped to `RESET` if it is available, by default 5th column, 5th row
diff --git a/keyboards/handwired/macroboard/rules.mk b/keyboards/handwired/macroboard/rules.mk
new file mode 100644
index 000000000..2c38ac280
--- /dev/null
+++ b/keyboards/handwired/macroboard/rules.mk
@@ -0,0 +1,19 @@
1# MCU name
2MCU = STM32F401
3
4# Bootloader selection
5BOOTLOADER = stm32-dfu
6
7# Build Options
8# change yes to no to disable
9#
10BOOTMAGIC_ENABLE = yes # Enable Bootmagic Lite
11MOUSEKEY_ENABLE = yes # Mouse keys
12EXTRAKEY_ENABLE = yes # Audio control and System control
13CONSOLE_ENABLE = no # Console for debug
14COMMAND_ENABLE = no # Commands for debug and configuration
15NKRO_ENABLE = yes # Enable N-Key Rollover
16BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
17RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow
18AUDIO_ENABLE = no # Audio output
19KEYBOARD_SHARED_EP = yes