[keyboard] Add 0x3E (#14088)

* Add 0x3E - default config

* Apply suggestions from code review

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Apply suggestions from code review 2

Firmware size optimization

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Rename files as per project guidelines + remove empty

* Update link in readme.md

Co-authored-by: Drashna Jaelre <drashna@live.com>

8 files changed, 438 insertions, 0 deletions

diff --git a/keyboards/plut0nium/0x3e/0x3e.c b/keyboards/plut0nium/0x3e/0x3e.c
new file mode 100644
index 0000000000..2f3683d8bc
--- /dev/null
+++ b/keyboards/plut0nium/0x3e/0x3e.c
@@ -0,0 +1,18 @@
+/* Copyright 2020 plut0nium
+ *
+ * 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 "0x3e.h"
+
diff --git a/keyboards/plut0nium/0x3e/0x3e.h b/keyboards/plut0nium/0x3e/0x3e.h
new file mode 100644
index 0000000000..e44530b2fa
--- /dev/null
+++ b/keyboards/plut0nium/0x3e/0x3e.h
@@ -0,0 +1,36 @@
+/* Copyright 2020 plut0nium
+ *
+ * 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"
+
+#define LAYOUT( \
+    k40, k41, k42, k43, k44, k45,      k47, k48, k49, k4a, k4b, k4c, \
+    k30, k31, k32, k33, k34, k35,      k37, k38, k39, k3a, k3b, k3c, \
+    k20, k21, k22, k23, k24, k25,      k27, k28, k29, k2a, k2b, k2c, \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, \
+    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c  \
+) \
+{ \
+    { k40, k41, k42, k43, k44, k45, KC_NO, k47, k48, k49, k4a, k4b, k4c }, \
+    { k30, k31, k32, k33, k34, k35, KC_NO, k37, k38, k39, k3a, k3b, k3c }, \
+    { k20, k21, k22, k23, k24, k25, KC_NO, k27, k28, k29, k2a, k2b, k2c }, \
+    { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c }, \
+    { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c }, \
+}
+
+
diff --git a/keyboards/plut0nium/0x3e/config.h b/keyboards/plut0nium/0x3e/config.h
new file mode 100644
index 0000000000..f61d22228f
--- /dev/null
+++ b/keyboards/plut0nium/0x3e/config.h
@@ -0,0 +1,114 @@
+/*
+Copyright 2020 plut0nium
+
+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       0xFEED
+#define PRODUCT_ID      0x3E01
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    plut0nium
+#define PRODUCT         0x3E
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 13
+
+/*
+ * Keyboard Matrix Assignments
+ */
+#define MATRIX_ROW_PINS { B0, B1, B2, B3, B7 }
+#define MATRIX_COL_PINS { F7, F6, F5, F4, F1, F0, D5, D4, D6, D7, B4, B5, B6 }
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL*/
+#define DIODE_DIRECTION COL2ROW
+
+/*
+ * Backlight
+ */
+#define BACKLIGHT_PIN C6
+#define BACKLIGHT_BREATHING
+#define BACKLIGHT_LEVELS 6
+
+/*
+ * RGB Underglow
+ */
+#define RGB_DI_PIN C7
+#ifdef RGB_DI_PIN
+  #define RGBLED_NUM 6
+  #define RGBLIGHT_HUE_STEP 12
+  #define RGBLIGHT_SAT_STEP 8
+  #define RGBLIGHT_VAL_STEP 8
+  #define RGBLIGHT_LIMIT_VAL 150 /* The maximum brightness level */
+  #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
+  #define RGBLIGHT_EFFECT_BREATHING
+  #define RGBLIGHT_EFFECT_RAINBOW_MOOD
+//  #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+//  #define RGBLIGHT_EFFECT_SNAKE
+//  #define RGBLIGHT_EFFECT_KNIGHT
+//  #define RGBLIGHT_EFFECT_CHRISTMAS
+  #define RGBLIGHT_EFFECT_STATIC_GRADIENT
+//  #define RGBLIGHT_EFFECT_RGB_TEST
+//  #define RGBLIGHT_EFFECT_ALTERNATING
+/*== customize breathing effect ==*/
+  /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
+//  #define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
+  /*==== use exp() and sin() ====*/
+//  #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
+//  #define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
+#endif
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+
+/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
+ * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
+ */
+// #define GRAVE_ESC_CTRL_OVERRIDE
+
+/*
+ * Force NKRO
+ */
+//#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
+
+/* Bootmagic Lite key configuration */
+// #define BOOTMAGIC_LITE_ROW 0
+// #define BOOTMAGIC_LITE_COLUMN 0
diff --git a/keyboards/plut0nium/0x3e/info.json b/keyboards/plut0nium/0x3e/info.json
new file mode 100644
index 0000000000..c3eeb2fd65
--- /dev/null
+++ b/keyboards/plut0nium/0x3e/info.json
@@ -0,0 +1,75 @@
+{
+    "keyboard_name": "0x3E",
+    "url": "",
+    "maintainer": "plut0nium",
+    "width": 14,
+    "height": 5,
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"label":"Esc", "x":0, "y":0, "w":1.5},
+                {"label":"1", "x":1.5, "y":0},
+                {"label":"2", "x":2.5, "y":0},
+                {"label":"3", "x":3.5, "y":0},
+                {"label":"4", "x":4.5, "y":0},
+                {"label":"5", "x":5.5, "y":0},
+                {"label":"6", "x":7.5, "y":0},
+                {"label":"7", "x":8.5, "y":0},
+                {"label":"8", "x":9.5, "y":0},
+                {"label":"9", "x":10.5, "y":0},
+                {"label":"0", "x":11.5, "y":0},
+                {"label":"Back Space", "x":12.5, "y":0, "w":1.5},
+                {"label":"Tab", "x":0, "y":1, "w":1.5},
+                {"label":"Q", "x":1.5, "y":1},
+                {"label":"W", "x":2.5, "y":1},
+                {"label":"E", "x":3.5, "y":1},
+                {"label":"R", "x":4.5, "y":1},
+                {"label":"T", "x":5.5, "y":1},
+                {"label":"Y", "x":7.5, "y":1},
+                {"label":"U", "x":8.5, "y":1},
+                {"label":"I", "x":9.5, "y":1},
+                {"label":"O", "x":10.5, "y":1},
+                {"label":"P", "x":11.5, "y":1},
+                {"label":"\\", "x":12.5, "y":1, "w":1.5},
+                {"label":"Fn", "x":0, "y":2, "w":1.5},
+                {"label":"A", "x":1.5, "y":2},
+                {"label":"S", "x":2.5, "y":2},
+                {"label":"D", "x":3.5, "y":2},
+                {"label":"F", "x":4.5, "y":2},
+                {"label":"G", "x":5.5, "y":2},
+                {"label":"H", "x":7.5, "y":2},
+                {"label":"J", "x":8.5, "y":2},
+                {"label":"K", "x":9.5, "y":2},
+                {"label":"L", "x":10.5, "y":2},
+                {"label":";", "x":11.5, "y":2},
+                {"label":"Return", "x":12.5, "y":2, "w":1.5},
+                {"label":"Shift", "x":0, "y":3, "w":1.5},
+                {"label":"Z", "x":1.5, "y":3},
+                {"label":"X", "x":2.5, "y":3},
+                {"label":"C", "x":3.5, "y":3},
+                {"label":"V", "x":4.5, "y":3},
+                {"label":"B", "x":5.5, "y":3},
+                {"label":"PgUp", "x":6.5, "y":3},
+                {"label":"N", "x":7.5, "y":3},
+                {"label":"M", "x":8.5, "y":3},
+                {"label":",", "x":9.5, "y":3},
+                {"label":".", "x":10.5, "y":3},
+                {"label":"/", "x":11.5, "y":3},
+                {"label":"Shift", "x":12.5, "y":3, "w":1.5},
+                {"label":"Ctrl", "x":0, "y":4, "w":1.5},
+                {"label":"Win", "x":1.5, "y":4},
+                {"label":"Menu", "x":2.5, "y":4},
+                {"label":"Alt", "x":3.5, "y":4},
+                {"label":"Space", "x":4.5, "y":4},
+                {"label":"Space", "x":5.5, "y":4},
+                {"label":"PgDn", "x":6.5, "y":4},
+                {"label":"Space", "x":7.5, "y":4},
+                {"label":"Space", "x":8.5, "y":4},
+                {"label":"AltGr", "x":9.5, "y":4},
+                {"label":"[", "x":10.5, "y":4},
+                {"label":"]", "x":11.5, "y":4},
+                {"label":"Ctrl", "x":12.5, "y":4, "w":1.5}
+            ]
+        }
+    }
+}
diff --git a/keyboards/plut0nium/0x3e/keymaps/default/keymap.c b/keyboards/plut0nium/0x3e/keymaps/default/keymap.c
new file mode 100644
index 0000000000..ed2c464e46
--- /dev/null
+++ b/keyboards/plut0nium/0x3e/keymaps/default/keymap.c
@@ -0,0 +1,157 @@
+/* Copyright 2020 plut0nium
+ *
+ * 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 {
+    _QWERTY,
+    _FN
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /* Base */
+    [_QWERTY] = LAYOUT(
+        KC_ESC,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,              KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC, 
+        KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,              KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSLS,  
+        MO(_FN), KC_A,    KC_S,    KC_D,    KC_F,    KC_G,              KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_ENT,  
+        KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_PGUP,  KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT, 
+        KC_LCTL, KC_LGUI, KC_MENU, KC_LALT, KC_SPC,  KC_SPC,  KC_PGDN,  KC_SPC,  KC_SPC,  KC_RALT, KC_LBRC, KC_RBRC, KC_RCTL  
+    ),
+    [_FN] = LAYOUT(
+        KC_GRV,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,             KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_DEL,  
+        RESET,   _______, KC_UP,   _______, _______, _______,           _______, _______, _______, KC_F11,  KC_F12,  _______, 
+        _______, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______,           _______, _______, _______, _______, _______, _______,
+        _______, RGB_HUI, RGB_SAI, RGB_VAI, RGB_MOD, _______, KC_END,   _______, _______, BL_INC,  KC_MPLY, KC_VOLU, KC_MUTE,
+        _______, RGB_HUD, RGB_SAD, RGB_VAD, RGB_TOG, RGB_TOG, KC_HOME,  BL_TOGG, BL_TOGG, BL_DEC,  KC_MPRV, KC_VOLD, KC_MNXT
+    )
+};
+
+#ifdef OLED_DRIVER_ENABLE
+static void render_logo(void) {
+    static const char PROGMEM my_logo[] = {
+        // '0x3E_logo_32x16', 32x16px
+        0xff, 0x0f, 0x07, 0xf3, 0x73, 0xb3, 0x07, 0x0f, 0xff, 0x3f, 0x3f, 0xff, 0xff, 0x3f, 0x3f, 0xff, 
+        0xe7, 0xe3, 0x33, 0x33, 0x03, 0x87, 0xff, 0xff, 0x03, 0x03, 0x33, 0x33, 0x33, 0xf3, 0xff, 0xff, 
+        0x7f, 0x78, 0x70, 0x66, 0x67, 0x67, 0x70, 0x78, 0x7f, 0x67, 0x62, 0x78, 0x78, 0x62, 0x67, 0x7f, 
+        0x73, 0x63, 0x67, 0x67, 0x60, 0x70, 0x7f, 0x7f, 0x60, 0x60, 0x67, 0x67, 0x67, 0x67, 0x7f, 0x7f
+    };  
+    oled_write_raw_P(my_logo, sizeof(my_logo));
+}
+
+#ifdef RGBLIGHT_ENABLE
+
+void render_rgb_status(void) {
+    oled_write_ln_P(PSTR("RGB"), false);
+    if (!rgblight_is_enabled()) {
+        oled_write_P(PSTR("  off\n\n\n"), false);
+    }
+    else {
+        static char string[4] = {0};
+        oled_write_P(PSTR("M:"), false);
+        uint8_t n = rgblight_get_mode();
+        string[3] = '\0';
+        string[2] = '0' + n % 10;
+        string[1] = ( n /= 10) % 10 ? '0' + (n) % 10 : (n / 10) % 10 ? '0' : ' ';
+        string[0] =  n / 10 ? '0' + n / 10 : ' ';
+        oled_write(string, false);
+
+        oled_write_P(PSTR("H:"), false);
+        n = rgblight_get_hue();
+        string[3] = '\0';
+        string[2] = '0' + n % 10;
+        string[1] = ( n /= 10) % 10 ? '0' + (n) % 10 : (n / 10) % 10 ? '0' : ' ';
+        string[0] =  n / 10 ? '0' + n / 10 : ' ';
+        oled_write(string, false);
+
+        oled_write_P(PSTR("S:"), false);
+        n = rgblight_get_sat();
+        string[3] = '\0';
+        string[2] = '0' + n % 10;
+        string[1] = ( n /= 10) % 10 ? '0' + (n) % 10 : (n / 10) % 10 ? '0' : ' ';
+        string[0] =  n / 10 ? '0' + n / 10 : ' ';
+        oled_write(string, false);
+
+        oled_write_P(PSTR("V:"), false);
+        n = rgblight_get_val()/RGBLIGHT_VAL_STEP;
+        string[3] = '\0';
+        string[2] = '0' + n % 10;
+        string[1] = ( n /= 10) % 10 ? '0' + (n) % 10 : (n / 10) % 10 ? '0' : ' ';
+        string[0] =  n / 10 ? '0' + n / 10 : ' ';
+        oled_write(string, false);
+    }
+}
+#endif
+
+
+void render_backlight_status(void) {
+    oled_write_ln_P(PSTR("BKL"), false);
+    if (!is_backlight_enabled()) {
+        oled_write_P(PSTR("  off"), false);
+    }
+    else {
+        char string[4];
+        oled_write_P(PSTR("L:"), false);
+        uint8_t n = get_backlight_level();
+        string[3] = '\0';
+        string[2] = '0' + n % 10;
+        string[1] = ( n /= 10) % 10 ? '0' + (n) % 10 : (n / 10) % 10 ? '0' : ' ';
+        string[0] =  n / 10 ? '0' + n / 10 : ' ';
+        oled_write(string, false);
+    }
+}
+
+oled_rotation_t oled_init_user(oled_rotation_t rotation) {
+    return OLED_ROTATION_270;  // flips the display 180 degrees if offhand
+}
+
+void oled_task_user(void) {
+    render_logo();
+    oled_set_cursor(0,2); // default logo is 16px high (2 lines)
+
+    // Host Keyboard Layer Status
+    oled_write_P(PSTR("Layer"), false);
+
+    switch (get_highest_layer(layer_state)) {
+        case _QWERTY:
+            oled_write_P(PSTR("QWTY\n"), false);
+            break;
+        case _FN:
+            oled_write_P(PSTR("FN\n"), false);
+            break;
+        default:
+            // Or use the write_ln shortcut over adding '\n' to the end of your string
+            oled_write_ln_P(PSTR("Undf"), false);
+    }
+
+    // Host Keyboard LED Status
+    // uint8_t led_usb_state = host_keyboard_leds();
+    // oled_write_P(PSTR("-----"), false);
+    // oled_write_P(PSTR("Stats"), false);
+    // oled_write_P(led_usb_state & (1<<USB_LED_NUM_LOCK) ? PSTR("num:*") : PSTR("num:."), false);
+    // oled_write_P(led_usb_state & (1<<USB_LED_CAPS_LOCK) ? PSTR("cap:*") : PSTR("cap:."), false);
+    // oled_write_P(led_usb_state & (1<<USB_LED_SCROLL_LOCK) ? PSTR("scr:*") : PSTR("scr:."), false);
+
+    oled_write_P(PSTR("-----"), false);
+    render_backlight_status();
+
+    // Host Keyboard RGB status
+#ifdef RGBLIGHT_ENABLE
+    oled_write_P(PSTR("-----"), false);
+    render_rgb_status();
+#endif
+
+}
+#endif
diff --git a/keyboards/plut0nium/0x3e/keymaps/default/readme.md b/keyboards/plut0nium/0x3e/keymaps/default/readme.md
new file mode 100644
index 0000000000..d75f467dfa
--- /dev/null
+++ b/keyboards/plut0nium/0x3e/keymaps/default/readme.md
@@ -0,0 +1 @@
+# The default keymap for 0x3E
diff --git a/keyboards/plut0nium/0x3e/readme.md b/keyboards/plut0nium/0x3e/readme.md
new file mode 100644
index 0000000000..1dd3c2b17b
--- /dev/null
+++ b/keyboards/plut0nium/0x3e/readme.md
@@ -0,0 +1,18 @@
+# 0x3E
+
+An 60%-ish Ortholinear Low-profile (Kailh Choc) Keyboard, with Boardwalk-like layout (1.5u outer mod colums, split spacebar) and OLED display
+
+* Keyboard Maintainer: [plut0nium](https://github.com/plut0nium)
+* Hardware Supported: 0x3E PCB
+* Hardware Availability: [MKUltra](https://mkultra.click)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make plut0nium/0x3e: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).
+
+## How to reset the board into bootloader mode
+
+The PCB has a dedicated Reset pushbutton on the underside, press it once to reset the board into bootloader mode.
+In addition, bootmagic lite is enabled in the default config, holding ESC (upper left key) while plugging the board will start in bootloader.
diff --git a/keyboards/plut0nium/0x3e/rules.mk b/keyboards/plut0nium/0x3e/rules.mk
new file mode 100644
index 0000000000..7a0ec2db21
--- /dev/null
+++ b/keyboards/plut0nium/0x3e/rules.mk
@@ -0,0 +1,19 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+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
+NKRO_ENABLE = no            # USB Nkey Rollover
+BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+OLED_DRIVER_ENABLE = yes
+LTO_ENABLE = yes