adding my custom keypad to qmk repository (#12150)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Nick Brassel <nick@tzarc.org>

keyboards/makrosu/config.h

@@ -0,0 +1,70 @@
+/* Copyright 2021 Valdydesu_ 
+  * 
+  * 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       0xAB69
+#define PRODUCT_ID      0x8585
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    valdydesu_
+#define PRODUCT         makrosu
+
+/* key matrix size */
+#define MATRIX_ROWS 1
+#define MATRIX_COLS 6
+
+/* key matrix pins */
+#define MATRIX_ROW_PINS { B6 }
+#define MATRIX_COL_PINS { B2, B3, B1, F7, F6, F5}
+#define UNUSED_PINS
+
+#define ENCODERS_PAD_A { D1 }
+#define ENCODERS_PAD_B { E6 }
+#define ENCODER_DIRECTION_FLIP
+#define TAP_CODE_DELAY 10 
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+#define BOOTMAGIC_LITE_ROW 0
+#define BOOTMAGIC_LITE_COLUMN 5
+/* number of backlight levels */
+
+#ifdef BACKLIGHT_PIN
+#define BACKLIGHT_LEVELS 0
+#endif
+
+
+/* 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
+
+
+
+// EEPROM usage
+
+
+#ifdef RGB_DI_PIN
+#define RGBLIGHT_ANIMATIONS
+#define RGBLED_NUM 0
+#define RGBLIGHT_HUE_STEP 8
+#define RGBLIGHT_SAT_STEP 8
+#define RGBLIGHT_VAL_STEP 8
+#endif

keyboards/makrosu/info.json

@@ -0,0 +1,21 @@
+{
+    "keyboard_name": "MakrOSU",
+    "url": "",
+    "maintainer": "Valdydesu_",
+    "width": 3,
+    "height": 2,
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+      
+                {"label" : "Esc", "x":0, "y":0},
+                {"label" : "F1", "x":1, "y":0},
+                {"label" : "F2", "x":2, "y":0},
+                
+                {"label" : "Lower", "x":0, "y":1},
+                {"label" : "Z", "x":1.5, "y":1},
+                {"label" : "X", "x":2.5, "y":1}
+            ]
+        }
+    }
+}

keyboards/makrosu/keymaps/default/keymap.c

@@ -0,0 +1,133 @@
+/* Copyright 2021 Valdydesu_ 
+  * 
+  * 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
+
+enum planck_layers {
+  _1,
+  _2,
+  _3,
+  _4
+
+};
+
+
+enum planck_keycodes {
+  L1 = SAFE_RANGE,
+  L2,
+  L3
+  
+};
+
+#define LOWER MO(_4)
+#define IND_1          D4
+#define IND_2          C6
+#define IND_3          D7
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+	[_1] = LAYOUT(
+		KC_ESC, KC_F1, KC_F2,
+        LOWER, KC_Z, KC_X),
+
+	[_2] = LAYOUT(
+		LALT(KC_TAB), LGUI(KC_TAB), LCTL(KC_S),
+        LOWER, LCTL(KC_C), LCTL(KC_V)),
+
+	[_3] = LAYOUT(
+		KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS),
+
+	[_4] = LAYOUT(
+		L1, L2, L3,
+        _______, _______, _______),
+
+};
+
+
+layer_state_t layer_state_set_user(layer_state_t state) {
+    state = update_tri_layer_state(state, _4, X_PAUSE, X_PAUSE);
+    writePin(IND_1, layer_state_cmp(state, 1));
+	writePin(IND_2, layer_state_cmp(state, 2));
+ 	writePin(IND_3, layer_state_cmp(state, 3)); 
+ 	return state;
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case L1:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_1);
+	
+
+      }
+      return false;
+      break;
+    case L2:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_2);
+	
+      }
+      return false;
+      break;
+    case L3:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_3);
+	
+      }
+      return false;
+      break;
+    
+  }
+  return true;
+}
+
+void matrix_init_user(void) {
+    //init the Pro Micro on-board LEDs
+    setPinOutput(IND_1);
+    setPinOutput(IND_2);
+    setPinOutput(IND_3);
+    //set to off
+    writePinHigh(IND_1);
+    writePinHigh(IND_2);
+    writePinHigh(IND_3);
+}
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+    if (layer_state_is(_1)) {
+	if (clockwise) {
+      tap_code(KC_UP);
+    } else {
+      tap_code(KC_DOWN);
+    }
+   }
+
+    else if (layer_state_is(_2)) {
+	if (clockwise) {
+      tap_code(KC_RGHT);
+    } else {
+      tap_code(KC_LEFT);
+    }
+   }
+
+    else if (layer_state_is(_3)) {
+	if (clockwise) {
+      tap_code(KC_VOLU);
+    } else {
+      tap_code(KC_VOLD);
+    }
+   }
+}

keyboards/makrosu/keymaps/via/keymap.c

@@ -0,0 +1,133 @@
+/* Copyright 2021 Valdydesu_ 
+  * 
+  * 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
+
+enum planck_layers {
+  _1,
+  _2,
+  _3,
+  _4
+
+};
+
+
+enum planck_keycodes {
+  L1 = SAFE_RANGE,
+  L2,
+  L3
+  
+};
+
+#define LOWER MO(_4)
+#define IND_1          D4
+#define IND_2          C6
+#define IND_3          D7
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+	[_1] = LAYOUT(
+		KC_ESC, KC_F1, KC_F2,
+        LOWER, KC_Z, KC_X),
+
+	[_2] = LAYOUT(
+		LALT(KC_TAB), LGUI(KC_TAB), LCTL(KC_S),
+        LOWER, LCTL(KC_C), LCTL(KC_V)),
+
+	[_3] = LAYOUT(
+		KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS),
+
+	[_4] = LAYOUT(
+		L1, L2, L3,
+        _______, _______, _______),
+
+};
+
+
+layer_state_t layer_state_set_user(layer_state_t state) {
+    state = update_tri_layer_state(state, _4, X_PAUSE, X_PAUSE);
+    writePin(IND_1, layer_state_cmp(state, 1));
+	writePin(IND_2, layer_state_cmp(state, 2));
+ 	writePin(IND_3, layer_state_cmp(state, 3)); 
+ 	return state;
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case L1:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_1);
+	
+
+      }
+      return false;
+      break;
+    case L2:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_2);
+	
+      }
+      return false;
+      break;
+    case L3:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_3);
+	
+      }
+      return false;
+      break;
+    
+  }
+  return true;
+}
+
+void matrix_init_user(void) {
+    //init the Pro Micro on-board LEDs
+    setPinOutput(IND_1);
+    setPinOutput(IND_2);
+    setPinOutput(IND_3);
+    //set to off
+    writePinHigh(IND_1);
+    writePinHigh(IND_2);
+    writePinHigh(IND_3);
+}
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+    if (layer_state_is(_1)) {
+	if (clockwise) {
+      tap_code(KC_UP);
+    } else {
+      tap_code(KC_DOWN);
+    }
+   }
+
+    else if (layer_state_is(_2)) {
+	if (clockwise) {
+      tap_code(KC_RGHT);
+    } else {
+      tap_code(KC_LEFT);
+    }
+   }
+
+    else if (layer_state_is(_3)) {
+	if (clockwise) {
+      tap_code(KC_VOLU);
+    } else {
+      tap_code(KC_VOLD);
+    }
+   }
+}

keyboards/makrosu/keymaps/via/rules.mk

@@ -0,0 +1 @@
+VIA_ENABLE = yes

keyboards/makrosu/makrosu.c

@@ -0,0 +1,16 @@
+ /* Copyright 2021 Valdydesu_ 
+  * 
+  * 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 "makrosu.h"

keyboards/makrosu/makrosu.h

@@ -0,0 +1,20 @@
+#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( \
+    K02, K03, K04, \
+    K00, K01, K05  \
+) \
+{ \
+    { K00, K01, K02, K03, K04, K05 }, \
+}
+

keyboards/makrosu/readme.md

@@ -0,0 +1,14 @@
+# [Makrosu Keypad](https://www.instagram.com/p/CJ8eoQ7BoGZ/)
+
+A Macropad that has 1 rotary encoder, 2 switches and 3 push buttons. Default function is for playing OSU!
+
+* Keyboard Maintainer: [Valdy](https://github.com/valdiieee)
+* Hardware Supported: Pro Micro, EC11 rotary encoder, MX Style Switches, Push Buttons, 1n4148 diodes
+* Hardware Availability: Private GB
+
+Make example for this keyboard (after setting up your build environment):
+
+    make makrosu: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).
+

keyboards/makrosu/rules.mk

@@ -0,0 +1,23 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = caterina
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = lite     # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = no        # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+COMMAND_ENABLE = no         # 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 = 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