Add a new keyboard "Unicorne" (#12993)

* Add keyboards/yanghu/unicorne initial files.

* add default keymap to yanghu/unicorne

* use slow i2c and enable internal pullup resistor

* add oled to default keymaps

* fix unicorne default keymap

* fix encoder pad direction

* fix marauder

* add led matrix configs.

* add encoder code to default keymap.

* fix encoder direction

* add readme, info.json and update copyright for c files.

* fix build error by clean up include in unicorne.c

* fix images in readme files

* Fix various issues in PR #12993 feedback.

* Added copyright in glcdfont, fix include in that file.
* Removed `_kc` layout and renamed layout with generic style.
* Moved capslock oled update to oled.c inside `oled_task_user()`.

* Update keyboards/yanghu/unicorne/keymaps/default/rules.mk

Always include oled.c

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

* Update keyboards/yanghu/unicorne/keymaps/default/oled.c

Wrap `oled.c` with ifdef.

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

* Update keyboards/yanghu/unicorne/keymaps/default/oled.c

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

* move oled code to unicorne.c, and set weakly.

* Update keyboards/yanghu/unicorne/config.h

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

* Update keyboards/yanghu/unicorne/keymaps/default/keymap.c

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

* Update keyboards/yanghu/unicorne/keymaps/default/keymap.c

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

* Update keyboards/yanghu/unicorne/keymaps/default/keymap.c

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

* Update keyboards/yanghu/unicorne/unicorne.c

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

* Update keyboards/yanghu/unicorne/readme.md

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/yanghu/unicorne/readme.md

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/yanghu/unicorne/readme.md

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/yanghu/unicorne/readme.md

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/yanghu/unicorne/keymaps/default/oled.c

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/yanghu/unicorne/f411/rules.mk

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/yanghu/unicorne/rules.mk

Co-authored-by: Ryan <fauxpark@gmail.com>

* remove oled.h

* remove include of oled.h after the file is deleted.

* Apply suggestions from code review: remove redundant macros and reformat.

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

* Apply suggestions from code review: change OLED driver macro.

Use `OLED_ENABLE` instead of `OLED_DRIVER_ENABLE`.

Co-authored-by: Jonathan Rascher <jon@bcat.name>

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Jonathan Rascher <jon@bcat.name>

6 files changed, 216 insertions, 0 deletions

diff --git a/keyboards/yanghu/unicorne/keymaps/default/config.h b/keyboards/yanghu/unicorne/keymaps/default/config.h
new file mode 100644
index 0000000000..e7ee9814ef
--- /dev/null
+++ b/keyboards/yanghu/unicorne/keymaps/default/config.h
@@ -0,0 +1,22 @@
+/* Copyright 2021 Yang Hu
+ *
+ * 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
+
+#define OLED_FONT_H "keyboards/yanghu/unicorne/glcdfont.c"
+#define ENCODER_RESOLUTION 4
+#define RGBLIGHT_DEFAULT_MODE RGBLIGHT_MODE_BREATHING
+#define RGBLIGHT_DEFAULT_COLOR HSV_BLUE
diff --git a/keyboards/yanghu/unicorne/keymaps/default/keymap.c b/keyboards/yanghu/unicorne/keymaps/default/keymap.c
new file mode 100644
index 0000000000..26fb014260
--- /dev/null
+++ b/keyboards/yanghu/unicorne/keymaps/default/keymap.c
@@ -0,0 +1,92 @@
+/* Copyright 2021 Yang Hu
+ *
+ * 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
+#include "layers.h"
+
+#define LOWER MO(_LOWER)
+#define RAISE MO(_RAISE)
+#define ADJUST MO(_ADJUST)
+
+// clang-format off
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_BASE] = LAYOUT_split_3x6_4(
+    KC_TAB,         KC_Q, KC_W, KC_E, KC_R, KC_T,    KC_Y, KC_U, KC_I,    KC_O,   KC_P,    KC_BSPC,
+    LCTL_T(KC_ESC), KC_A, KC_S, KC_D, KC_F, KC_G,    KC_H, KC_J, KC_K,    KC_L,   KC_SCLN, KC_QUOT,
+    KC_LSFT,        KC_Z, KC_X, KC_C, KC_V, KC_B,    KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, RSFT_T(KC_ENT),
+                 KC_LCTL, KC_LALT, LOWER, KC_ENT,    KC_BSPC, KC_SPC, RAISE, KC_RGUI
+  ),
+
+  [_LOWER] = LAYOUT_split_3x6_4(
+    _______,  KC_EXLM,  KC_AT,    KC_HASH,  KC_DLR,    KC_PERC,            KC_CIRC,  KC_AMPR,  KC_ASTR,  KC_LPRN,  KC_RPRN,  KC_DEL,
+    _______,  KC_UNDS,  KC_PLUS,  KC_LCBR,  KC_RCBR,   KC_PIPE,            KC_LEFT,  KC_DOWN,  KC_UP,    KC_RGHT,  KC_GRV,   KC_TILD,
+    _______,  KC_ESC,   KC_LGUI,  KC_LALT,  KC_CAPS,   KC_DQUO,            KC_HOME,  KC_END,   KC_PGUP,  KC_PGDN,  KC_PSCR,  RSFT_T(KC_SPC),
+             _______,  _______,   _______,   _______,  _______,   _______,   _______,  _______
+  ),
+
+  [_RAISE] = LAYOUT_split_3x6_4(
+    _______,  KC_1,     KC_2,     KC_3,     KC_4,      KC_5,               KC_6,     KC_7,     KC_8,     KC_9,     KC_0,     KC_DEL,
+    _______,  KC_MINS,  KC_EQL,   KC_LBRC,  KC_RBRC,   KC_BSLS,            KC_F1,    KC_F2,    KC_F3,    KC_F4,    KC_F5,    KC_F6,
+    _______,  KC_ESC,   KC_RGUI,  KC_RALT,  KC_CAPS,   KC_QUOT,            KC_F7,    KC_F8,    KC_F9,    KC_F10,   KC_F11,   KC_F12,
+             _______,  _______,   _______,   _______,  _______,   _______,   _______,  _______
+  ),
+
+  [_ADJUST] = LAYOUT_split_3x6_4(
+    RGB_VAI,   RGB_SAI, RGB_HUI,  RGB_MOD,  XXXXXXX,   RGB_TOG,            XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,
+    RGB_VAD,   RGB_SAD, RGB_HUD,  RGB_RMOD, XXXXXXX,   XXXXXXX,            XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,
+    XXXXXXX,   XXXXXXX, XXXXXXX,  XXXXXXX,  XXXXXXX,   XXXXXXX,            RESET,    XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,
+             _______,  _______,   _______,   _______,  _______,   _______,   _______,  _______
+  ),
+};
+// clang-format on
+layer_state_t layer_state_set_user(layer_state_t state) { return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST); }
+
+// Left encoder scrolls the mousewheel. Right encoder adjusts underglow hue.
+bool encoder_update_user(uint8_t index, bool clockwise) {
+    if (index == 0) {
+        if (clockwise) {
+#ifdef MOUSEKEY_ENABLE
+            tap_code(KC_MS_WH_DOWN);
+#else
+            tap_code(KC_PGDN);
+#endif
+        } else {
+#ifdef MOUSEKEY_ENABLE
+            tap_code(KC_MS_WH_UP);
+#else
+            tap_code(KC_PGUP);
+#endif
+        }
+    } else {  // index = 1: right encoder
+        if (clockwise) {
+#ifdef RGB_MATRIX_ENABLE
+            rgb_matrix_step();
+#else
+            rgblight_increase_hue_noeeprom();
+#endif
+        } else {
+#ifdef RGB_MATRIX_ENABLE
+            rgb_matrix_step_reverse();
+#else
+            rgblight_decrease_hue_noeeprom();
+#endif
+        }
+    }
+    return false;
+}
+
+// Set underglow color to blue.
+void keyboard_post_init_user(void) { rgblight_sethsv_noeeprom(RGBLIGHT_DEFAULT_COLOR); }
diff --git a/keyboards/yanghu/unicorne/keymaps/default/layers.h b/keyboards/yanghu/unicorne/keymaps/default/layers.h
new file mode 100644
index 0000000000..0505d4956b
--- /dev/null
+++ b/keyboards/yanghu/unicorne/keymaps/default/layers.h
@@ -0,0 +1,24 @@
+/* Copyright 2021 Yang Hu
+ *
+ * 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
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+    _BASE,
+    _LOWER,
+    _RAISE,
+    _ADJUST,
+};
diff --git a/keyboards/yanghu/unicorne/keymaps/default/oled.c b/keyboards/yanghu/unicorne/keymaps/default/oled.c
new file mode 100644
index 0000000000..417f573ff0
--- /dev/null
+++ b/keyboards/yanghu/unicorne/keymaps/default/oled.c
@@ -0,0 +1,67 @@
+/* Copyright 2021 Yang Hu
+ *
+ * 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/>.
+ */
+#ifdef OLED_ENABLE
+#    include QMK_KEYBOARD_H
+#    include "layers.h"
+
+// Some characters position:
+// alt: 84 85 86/a..../c...
+// shift:87 88 89/a.../c...
+// ctrl: b6 b6/d.../
+// capslock: 9c-9f/b.../d...
+// numlock: 98-9b/b.../d...
+// navigation logo: 92-95/b2.../d2...
+// symbol logo: 8a-8d/aa..../ca....
+// qmk logos; 8e-91/ae..../ce....
+void oled_render_layer(void) {
+    /* static const char PROGMEM cmd_logo[] = { */
+    /*   0x80, 0x81, 0x82, 0x83, 10, */
+    /*   0xa0, 0xa1, 0xa2, 0xa3, 10, */
+    /*   0xc0, 0xc1, 0xc2, 0xc3, 10, */
+    /*   0}; */
+    // clang-format off
+    static const char PROGMEM numlock_logo[] = {
+      0x98, 0x99, 0x9a, 0x9b, 10,
+      0xb8, 0xb9, 0xba, 0xbb, 10,
+      0xd8, 0xd9, 0xda, 0xdb, 10, 0};
+    static const char PROGMEM symbol_logo[] = {
+      0x8a, 0x8b, 0x8c, 0x8d, 10,
+      0xaa, 0xab, 0xac, 0xad, 10,
+      0xca, 0xcb, 0xcc, 0xcd, 10, 0};
+    static const char PROGMEM qmk_logo[] = {
+      0x8e, 0x8f, 0x90, 0x91, 10,
+      0xae, 0xaf, 0xb0, 0xb1, 10,
+      0xce, 0xcf, 0xd0, 0xd1, 10, 0};
+    // clang-format on
+    if (IS_LAYER_ON(_LOWER)) {
+        oled_write_P(symbol_logo, false);
+    } else if (IS_LAYER_ON(_RAISE)) {
+        oled_write_P(numlock_logo, false);
+    } else if (IS_LAYER_ON(_BASE)) {
+        oled_write_P(qmk_logo, false);
+    } else {
+        if (IS_LAYER_ON(_ADJUST)) {
+            oled_write_ln("ADJ", false);
+        } else {
+            oled_write_ln("?????", false);
+        }
+        oled_write_ln(" ", false);
+        oled_write_ln(" ", false);
+        oled_write_ln(" ", false);
+    }
+}
+
+#endif
diff --git a/keyboards/yanghu/unicorne/keymaps/default/readme.md b/keyboards/yanghu/unicorne/keymaps/default/readme.md
new file mode 100644
index 0000000000..b6ce9e4237
--- /dev/null
+++ b/keyboards/yanghu/unicorne/keymaps/default/readme.md
@@ -0,0 +1,10 @@
+![keymap](https://imgur.com/48cFzA5.jpg)
+
+# Default Unicorne Layout
+
+This is the default layout for Unicorne. The "lower" layer consists of symbols
+and navigation, while "raises' has numbers, some other symbols and function
+keys.
+
+Press `lower` and `raise` together activates `adjust` layer, with RGB controls,
+as well as access to reset/bootloader.
diff --git a/keyboards/yanghu/unicorne/keymaps/default/rules.mk b/keyboards/yanghu/unicorne/keymaps/default/rules.mk
new file mode 100644
index 0000000000..dbfa81b6ce
--- /dev/null
+++ b/keyboards/yanghu/unicorne/keymaps/default/rules.mk
@@ -0,0 +1 @@
+SRC += oled.c