aboutsummaryrefslogtreecommitdiff
path: root/keyboards/custommk
diff options
context:
space:
mode:
authorDavid Hoelscher <infinityis@users.noreply.github.com>2020-12-07 20:10:45 -0600
committerGitHub <noreply@github.com>2020-12-07 18:10:45 -0800
commit399be2a9b323130ecbfff4141ead67ea26c32034 (patch)
tree799bb5ee45313850fa96ae960d7701ce08f2d99f /keyboards/custommk
parentab2a43edb060b393387d12dfb6c24f99cad9e871 (diff)
downloadqmk_firmware-399be2a9b323130ecbfff4141ead67ea26c32034.tar.gz
qmk_firmware-399be2a9b323130ecbfff4141ead67ea26c32034.zip
[Keyboard] Add customMK Genesis Macro Pad (#11080)
* Adding customMK Genesis keyboard and keymap files * Updated readme.md fixed a typo * Fixed code for QMK PR * Updated syntax in config.h and changed dfu to flash in readme Co-authored-by: Ray <ray@custommk.com>
Diffstat (limited to 'keyboards/custommk')
-rw-r--r--keyboards/custommk/genesis/config.h62
-rw-r--r--keyboards/custommk/genesis/genesis.c36
-rw-r--r--keyboards/custommk/genesis/genesis.h48
-rw-r--r--keyboards/custommk/genesis/info.json16
-rw-r--r--keyboards/custommk/genesis/keymaps/default/keymap.c37
-rw-r--r--keyboards/custommk/genesis/keymaps/default/readme.md6
-rw-r--r--keyboards/custommk/genesis/keymaps/numpad/keymap.c51
-rw-r--r--keyboards/custommk/genesis/keymaps/numpad/readme.md3
-rw-r--r--keyboards/custommk/genesis/keymaps/via/keymap.c51
-rw-r--r--keyboards/custommk/genesis/keymaps/via/readme.md3
-rw-r--r--keyboards/custommk/genesis/keymaps/via/rules.mk2
-rw-r--r--keyboards/custommk/genesis/readme.md22
-rw-r--r--keyboards/custommk/genesis/rules.mk23
13 files changed, 360 insertions, 0 deletions
diff --git a/keyboards/custommk/genesis/config.h b/keyboards/custommk/genesis/config.h
new file mode 100644
index 000000000..a527737f0
--- /dev/null
+++ b/keyboards/custommk/genesis/config.h
@@ -0,0 +1,62 @@
1/* Copyright 2020 customMK
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
20#include "config_common.h"
21
22/* USB Device descriptor parameter */
23#define VENDOR_ID 0xF35B
24#define PRODUCT_ID 0xFAB0
25#define DEVICE_VER 0x0001
26#define MANUFACTURER customMK
27#define PRODUCT Genesis
28
29/* key matrix size */
30#define MATRIX_ROWS 5
31#define MATRIX_COLS 4
32
33/* key matrix pins */
34#define MATRIX_ROW_PINS { F0, C7, C6, B6, B5 }
35#define MATRIX_COL_PINS { F4, F5, D7, B4 }
36#define UNUSED_PINS
37
38/* COL2ROW or ROW2COL */
39#define DIODE_DIRECTION COL2ROW
40
41/* Set 0 if debouncing isn't needed */
42#define DEBOUNCE 5
43
44/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
45#define LOCKING_SUPPORT_ENABLE
46
47/* Locking resynchronize hack */
48#define LOCKING_RESYNC_ENABLE
49
50#define ENCODERS_PAD_A { F6, D2 }
51#define ENCODERS_PAD_B { F7, D1 }
52#define ENCODER_RESOLUTION 4
53#define TAP_CODE_DELAY 10
54
55#define RGB_DI_PIN E6
56#define RGBLIGHT_ANIMATIONS
57#define RGBLED_NUM 13
58#define RGBLIGHT_HUE_STEP 8
59#define RGBLIGHT_SAT_STEP 8
60#define RGBLIGHT_VAL_STEP 8
61#define RGBLIGHT_LIMIT_VAL 128
62
diff --git a/keyboards/custommk/genesis/genesis.c b/keyboards/custommk/genesis/genesis.c
new file mode 100644
index 000000000..47296dd80
--- /dev/null
+++ b/keyboards/custommk/genesis/genesis.c
@@ -0,0 +1,36 @@
1/* Copyright 2020 customMK
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 "genesis.h"
18
19__attribute__((weak)) void encoder_update_user(uint8_t index, bool clockwise) {
20 /* top left encoder */
21 if (index == 0) {
22 if (clockwise) {
23 tap_code(KC_VOLU);
24 } else {
25 tap_code(KC_VOLD);
26 }
27 }
28 /* top right encoder */
29 else if (index == 1) {
30 if (clockwise) {
31 tap_code(KC_VOLU);
32 } else {
33 tap_code(KC_VOLD);
34 }
35 }
36} \ No newline at end of file
diff --git a/keyboards/custommk/genesis/genesis.h b/keyboards/custommk/genesis/genesis.h
new file mode 100644
index 000000000..ad1073652
--- /dev/null
+++ b/keyboards/custommk/genesis/genesis.h
@@ -0,0 +1,48 @@
1/* Copyright 2020 customMK
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#define LAYOUT_numpad_5x4( \
22 K00, K01, K02, K03, \
23 K10, K11, K12, \
24 K20, K21, K22, K23, \
25 K30, K31, K32, \
26 K40, K42, K43 \
27) { \
28 { K00, K01, K02, K03 }, \
29 { K10, K11, K12, KC_NO }, \
30 { K20, K21, K22, K23 }, \
31 { K30, K31, K32, KC_NO }, \
32 { K40, KC_NO, K42, K43 } \
33}
34
35#define LAYOUT_ortho_5x4( \
36 K00, K01, K02, K03, \
37 K10, K11, K12, K13, \
38 K20, K21, K22, K23, \
39 K30, K31, K32, K33, \
40 K40, K41, K42, K43 \
41) { \
42 { K00, K01, K02, K03 }, \
43 { K10, K11, K12, K13 }, \
44 { K20, K21, K22, K23 }, \
45 { K30, K31, K32, K33 }, \
46 { K40, K41, K42, K43 } \
47}
48
diff --git a/keyboards/custommk/genesis/info.json b/keyboards/custommk/genesis/info.json
new file mode 100644
index 000000000..ddba21f99
--- /dev/null
+++ b/keyboards/custommk/genesis/info.json
@@ -0,0 +1,16 @@
1{
2 "keyboard_name": "Genesis",
3 "url": "https://www.customMK.com",
4 "maintainer": "customMK",
5 "width": 4,
6 "height": 5,
7 "layouts": {
8 "LAYOUT_ortho_5x4": {
9 "layout": [{"label":"MO(1)", "x":0, "y":0}, {"label":"/", "x":1, "y":0}, {"label":"*", "x":2, "y":0}, {"label":"Mute", "x":3, "y":0}, {"label":"7", "x":0, "y":1}, {"label":"8", "x":1, "y":1}, {"label":"9", "x":2, "y":1}, {"label":"+", "x":3, "y":1}, {"label":"4", "x":0, "y":2}, {"label":"5", "x":1, "y":2}, {"label":"6", "x":2, "y":2}, {"label":"Pg Up", "x":3, "y":2}, {"label":"1", "x":0, "y":3}, {"label":"2", "x":1, "y":3}, {"label":"3", "x":2, "y":3}, {"label":"Pg Dn", "x":3, "y":3}, {"label":"0", "x":0, "y":4}, {"label":"Spc", "x":1, "y":4}, {"label":".", "x":2, "y":4}, {"label":"Enter", "x":3, "y":4}]
10 },
11 "LAYOUT_numpad_5x4": {
12 "layout": [{"label":"MO(1)", "x":0, "y":0}, {"label":"/", "x":1, "y":0}, {"label":"*", "x":2, "y":0}, {"label":"-", "x":3, "y":0}, {"label":"7", "x":0, "y":1}, {"label":"8", "x":1, "y":1}, {"label":"9", "x":2, "y":1}, {"label":"+", "x":3, "y":1, "h":2}, {"label":"4", "x":0, "y":2}, {"label":"5", "x":1, "y":2}, {"label":"6", "x":2, "y":2}, {"label":"1", "x":0, "y":3}, {"label":"2", "x":1, "y":3}, {"label":"3", "x":2, "y":3}, {"label":"Enter", "x":3, "y":3, "h":2}, {"label":"0", "x":0, "y":4, "w":2}, {"label":".", "x":2, "y":4}]
13 }
14
15 }
16} \ No newline at end of file
diff --git a/keyboards/custommk/genesis/keymaps/default/keymap.c b/keyboards/custommk/genesis/keymaps/default/keymap.c
new file mode 100644
index 000000000..1b061b034
--- /dev/null
+++ b/keyboards/custommk/genesis/keymaps/default/keymap.c
@@ -0,0 +1,37 @@
1/* Copyright 2020 customMK
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 QMK_KEYBOARD_H
18
19const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
20
21 [0] = LAYOUT_ortho_5x4(
22 MO(1), KC_PSLS, KC_PAST, KC_PMNS,
23 KC_P7, KC_P8, KC_P9, KC_BSPC,
24 KC_P4, KC_P5, KC_P6, KC_PPLS,
25 KC_P1, KC_P2, KC_P3, KC_CAPS,
26 KC_P0, KC_SPC, KC_PDOT, KC_ENT),
27
28 [1] = LAYOUT_ortho_5x4(
29 KC_TRNS, KC_VOLU, RGB_TOG, RGB_MOD,
30 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
31 RGB_VAI, RGB_VAD, RGB_SPI, RGB_SPD,
32 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
33 RGB_HUI, KC_TRNS, KC_TRNS, RGB_HUD),
34
35};
36
37
diff --git a/keyboards/custommk/genesis/keymaps/default/readme.md b/keyboards/custommk/genesis/keymaps/default/readme.md
new file mode 100644
index 000000000..202402d83
--- /dev/null
+++ b/keyboards/custommk/genesis/keymaps/default/readme.md
@@ -0,0 +1,6 @@
1# Default Genesis Macro Pad Layout
2
3This is the default layout for the Genesis Macro Pad. It assumes all 1u switches
4and optional rotary encoder in the top-left or top-right corner for media volume
5control. The top left switch activates Layer 1 which enables control of the RGB
6underglow. \ No newline at end of file
diff --git a/keyboards/custommk/genesis/keymaps/numpad/keymap.c b/keyboards/custommk/genesis/keymaps/numpad/keymap.c
new file mode 100644
index 000000000..97970191d
--- /dev/null
+++ b/keyboards/custommk/genesis/keymaps/numpad/keymap.c
@@ -0,0 +1,51 @@
1/* Copyright 2020 customMK
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 QMK_KEYBOARD_H
18
19const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
20
21 [0] = LAYOUT_numpad_5x4(
22 MO(1), KC_PSLS, KC_PAST, KC_PMNS,
23 KC_P7, KC_P8, KC_P9,
24 KC_P4, KC_P5, KC_P6, KC_PPLS,
25 KC_P1, KC_P2, KC_P3,
26 KC_P0, KC_PDOT, KC_ENT),
27
28 [1] = LAYOUT_numpad_5x4(
29 KC_TRNS, KC_TRNS, RGB_TOG, RGB_MOD,
30 KC_TRNS, KC_TRNS, KC_TRNS,
31 RGB_VAI, RGB_VAD, RGB_SPI, RGB_SPD,
32 KC_TRNS, KC_TRNS, KC_TRNS,
33 RGB_HUI, KC_TRNS, RGB_HUD),
34
35 [2] = LAYOUT_numpad_5x4(
36 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
37 KC_TRNS, KC_TRNS, KC_TRNS,
38 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
39 KC_TRNS, KC_TRNS, KC_TRNS,
40 KC_TRNS, KC_TRNS, KC_TRNS),
41
42 [3] = LAYOUT_numpad_5x4(
43 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
44 KC_TRNS, KC_TRNS, KC_TRNS,
45 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
46 KC_TRNS, KC_TRNS, KC_TRNS,
47 KC_TRNS, KC_TRNS, KC_TRNS),
48
49};
50
51
diff --git a/keyboards/custommk/genesis/keymaps/numpad/readme.md b/keyboards/custommk/genesis/keymaps/numpad/readme.md
new file mode 100644
index 000000000..795e4341a
--- /dev/null
+++ b/keyboards/custommk/genesis/keymaps/numpad/readme.md
@@ -0,0 +1,3 @@
1# Numpad Genesis Macro Pad Layout
2
3This is the numpad layout for the Genesis Macro Pad. It assumes the 0, +, and enter keys are all 2u size, with an optional rotary encoder in the top-left or top-right corner for media volume control. The top left switch activates Layer 1 which enables control of the RGB underglow. \ No newline at end of file
diff --git a/keyboards/custommk/genesis/keymaps/via/keymap.c b/keyboards/custommk/genesis/keymaps/via/keymap.c
new file mode 100644
index 000000000..fe3755476
--- /dev/null
+++ b/keyboards/custommk/genesis/keymaps/via/keymap.c
@@ -0,0 +1,51 @@
1/* Copyright 2020 customMK
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 QMK_KEYBOARD_H
18
19const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
20
21 [0] = LAYOUT_ortho_5x4(
22 MO(1), KC_PSLS, KC_PAST, KC_PMNS,
23 KC_P7, KC_P8, KC_P9, KC_PPLS,
24 KC_P4, KC_P5, KC_P6, KC_PGUP,
25 KC_P1, KC_P2, KC_P3, KC_PGDN,
26 KC_P0, KC_SPC, KC_PDOT, KC_PENT),
27
28 [1] = LAYOUT_ortho_5x4(
29 KC_TRNS, RGB_TOG, RGB_MOD, KC_TRNS,
30 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
31 RGB_VAI, RGB_VAD, RGB_SPI, RGB_SPD,
32 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
33 RGB_HUI, RGB_HUD, KC_TRNS, KC_TRNS),
34
35 [2] = LAYOUT_ortho_5x4(
36 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
37 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
38 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
39 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
40 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
41
42 [3] = LAYOUT_ortho_5x4(
43 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
44 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
45 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
46 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
47 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
48
49};
50
51
diff --git a/keyboards/custommk/genesis/keymaps/via/readme.md b/keyboards/custommk/genesis/keymaps/via/readme.md
new file mode 100644
index 000000000..aa70d6225
--- /dev/null
+++ b/keyboards/custommk/genesis/keymaps/via/readme.md
@@ -0,0 +1,3 @@
1# Genesis Macro Pad Layout for VIA
2
3This is the via layout for the Genesis Macro Pad. It is identical to the default 1u layout which assumes all 1u switches and optional rotary encoder in the top-left or top-right corner for media volume control. The top-left switch activates Layer 1 which enables control of the RGB underglow. \ No newline at end of file
diff --git a/keyboards/custommk/genesis/keymaps/via/rules.mk b/keyboards/custommk/genesis/keymaps/via/rules.mk
new file mode 100644
index 000000000..43061db1d
--- /dev/null
+++ b/keyboards/custommk/genesis/keymaps/via/rules.mk
@@ -0,0 +1,2 @@
1VIA_ENABLE = yes
2LTO_ENABLE = yes \ No newline at end of file
diff --git a/keyboards/custommk/genesis/readme.md b/keyboards/custommk/genesis/readme.md
new file mode 100644
index 000000000..58bd27121
--- /dev/null
+++ b/keyboards/custommk/genesis/readme.md
@@ -0,0 +1,22 @@
1# Genesis
2
3![Genesis Macro Pad](https://i.imgur.com/voBjLrM.jpeg)
4![Genesis Macro Pad PCB](https://i.imgur.com/ST2vtkV.jpeg)
5
6Genesis is a 5x4 ortholinear macro pad designed and produced by customMK.
7
8* Keyboard Maintainer: [customMK](https://github.com/customMK)
9* Hardware Supported: Genesis Macro Pad
10* Hardware Availability: [customMK](https://shop.custommk.com/products/genesis_macropad)
11
12Make example for this keyboard (after setting up your build environment):
13
14 make custommk/genesis:default
15
16Flashing example for this keyboard:
17
18 make custommk/genesis:default:flash
19
20Genesis Macro Pad has qmk-dfu bootloader preinstalled. To enter the bootloader, run the flashing command above, and then either plug in the USB connection while holding the top-left key, or alternatively, plug in the USB connection and then press the reset button on the PCB
21
22See 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/custommk/genesis/rules.mk b/keyboards/custommk/genesis/rules.mk
new file mode 100644
index 000000000..1556125ec
--- /dev/null
+++ b/keyboards/custommk/genesis/rules.mk
@@ -0,0 +1,23 @@
1# MCU name
2MCU = atmega32u4
3
4# Bootloader selection
5BOOTLOADER = qmk-dfu
6
7# Build Options
8# change yes to no to disable
9#
10BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration
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
15# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
16SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
17# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
18NKRO_ENABLE = yes # USB Nkey Rollover
19BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
20RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow
21BLUETOOTH_ENABLE = no # Enable Bluetooth
22AUDIO_ENABLE = no # Audio output
23ENCODER_ENABLE = yes \ No newline at end of file