[Keymap] Crkbd/thunderbird2086 (#16973)

* crkbd:thunderbird2086

* readme

* after code review

* coding format

* minor change

* changed file name

* correct image

* updated readme

* using query to get rgb status

* minor update

1 files changed, 298 insertions, 0 deletions

diff --git a/keyboards/crkbd/keymaps/thunderbird2086/oled.c b/keyboards/crkbd/keymaps/thunderbird2086/oled.c
new file mode 100644
index 0000000000..bee9bc26de
--- /dev/null
+++ b/keyboards/crkbd/keymaps/thunderbird2086/oled.c
@@ -0,0 +1,298 @@
+// Copyright 2021 Allen Choi (@thunderbird2086)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+#include "keycodes.h"
+
+
+// 5x3 Logos
+void render_qmk_logo(void) {
+    static const char PROGMEM font_qmk_logo[16] = {
+        0x80, 0x81, 0x82, 0x83, 0x84,
+        0xa0, 0xa1, 0xa2, 0xa3, 0xa4,
+        0xc0, 0xc1, 0xc2, 0xc3, 0xc4,
+        0
+    };
+    oled_write_P(font_qmk_logo, false);
+};
+
+// 5x2 Keyboard, Controller logos
+void render_kb_split(void) {
+    static const char PROGMEM font_kb_split[11] = {
+        0xb5, 0xb6, 0xb7, 0xb8, 0xb9,
+        0xd5, 0xd6, 0xd7, 0xd8, 0xd9,
+        0
+    };
+    oled_write_P(font_kb_split, false);
+};
+
+// 5x1 Layer indicator
+
+void render_layer(void) {
+    static const char PROGMEM font_layer[4][6] = {
+        {0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0},
+        {0xba, 0xbb, 0xbc, 0xbd, 0xbe, 0},
+        {0xda, 0xdb, 0xdc, 0xdd, 0xde, 0},
+        {0x95, 0x96, 0x97, 0x98, 0x99, 0},
+    };
+
+    uint8_t layer = 0;
+    if (layer_state_is(_FUNCTION)) {
+        layer = 1;
+    } else if (layer_state_is(_CODE)) {
+        layer = 2;
+    } else if (layer_state_is(_ADJUST)) {
+        layer = 3;
+    }
+    oled_write_P(font_layer[layer], false);
+};
+
+
+void render_layers(void) {
+    static const char PROGMEM font_layers[4][16] = {
+        {0x20, 0x85, 0x86, 0x87, 0x20,
+         0x20, 0xa5, 0xa6, 0xa7, 0x20,
+         0x20, 0xc5, 0xc6, 0xc7, 0x20,
+         0},
+        {0x20, 0x88, 0x89, 0x8a, 0x20,
+         0x20, 0xa8, 0xa9, 0xaa, 0x20,
+         0x20, 0xc8, 0xc9, 0xca, 0x20,
+         0},
+        {0x20, 0x8b, 0x8c, 0x8d, 0x20,
+         0x20, 0xab, 0xac, 0xad, 0x20,
+         0x20, 0xcb, 0xcc, 0xcd, 0x20,
+         0},
+        {0x20, 0x8e, 0x8f, 0x90, 0x20,
+         0x20, 0xae, 0xaf, 0xb0, 0x20,
+         0x20, 0xce, 0xcf, 0xd0, 0x20,
+         0},
+    };
+
+    uint8_t layer = 0;
+    if (layer_state_is(_FUNCTION)) {
+        layer = 1;
+    } else if (layer_state_is(_CODE)) {
+        layer = 2;
+    } else if (layer_state_is(_ADJUST)) {
+        layer = 3;
+    }
+    oled_write_P(font_layers[layer], false);
+};
+
+#if defined(RGB_MATRIX_ENABLE) || defined(RGBLIGHT_ENABLE)
+
+void render_rgb_status(void) {
+    static const char PROGMEM font_rgb_off[3] = {0xd1, 0xd2, 0};
+    static const char PROGMEM font_rgb_on[3]  = {0xd3, 0xd4, 0};
+    bool rgb_enabled = 
+#    if defined(RGBLIGHT_ENABLE)
+        rgblight_is_enabled();
+#    elif defined(RGB_MATRIX_ENABLE)
+        rgb_matrix_is_enabled();
+#    endif
+
+    oled_write_P(rgb_enabled ? font_rgb_on : font_rgb_off, false);
+};
+#endif
+
+// 2x1 Ctrl, Alt, Shift, GUI, Caps
+
+void render_mod_ctrl(void) {
+    static const char PROGMEM font_ctrl[3] = {0x91, 0x92, 0};
+    oled_write_P(font_ctrl, false);
+};
+
+void render_mod_alt(void) {
+    static const char PROGMEM font_alt[3] = {0xb1, 0xb2, 0};
+    oled_write_P(font_alt, false);
+};
+
+void render_mod_shift(void) {
+    static const char PROGMEM font_shift[3] = {0xb3, 0xb4, 0};
+    oled_write_P(font_shift, false);
+};
+
+void render_mod_gui(void) {
+    static const char PROGMEM font_gui[3] = {0x93, 0x94, 0};
+    oled_write_P(font_gui, false);
+};
+
+void render_caps_lock(void) {
+    static const char PROGMEM font_caps[3] = {0x9f, 0xbf, 0};
+    oled_write_P(font_caps, false);
+};
+
+
+// 5x2 Mod and feature indicator clusters
+
+void render_mod_status(void) {
+#if defined(NO_ACTION_ONESHOT)
+    uint8_t modifiers = get_mods();
+#else
+    uint8_t modifiers = get_mods() | get_oneshot_mods();
+#endif
+
+    (modifiers & MOD_MASK_CTRL) ? render_mod_ctrl() : oled_write_P(PSTR("  "), false);
+    oled_write_P(PSTR(" "), false);
+    (modifiers & MOD_MASK_SHIFT) ? render_mod_shift() : oled_write_P(PSTR("  "), false);
+
+    (modifiers & MOD_MASK_ALT) ? render_mod_alt() : oled_write_P(PSTR("  "), false);
+    oled_write_P(PSTR(" "), false);
+    (modifiers & MOD_MASK_GUI) ? render_mod_gui() : oled_write_P(PSTR("  "), false);
+
+    led_t led_state = host_keyboard_led_state(); 
+    (led_state.caps_lock) ? render_caps_lock() : oled_write_P(PSTR("  "), false);
+}
+
+void render_feature_status(void) {
+#if defined(RGB_MATRIX_ENABLE) || defined(RGBLIGHT_ENABLE)
+    render_rgb_status();
+#endif
+};
+
+// Keylogger
+#define KEYLOGGER_LENGTH 5
+static char     keylog_str[KEYLOGGER_LENGTH + 1] = {"\n"};
+// clang-format off
+static const char PROGMEM code_to_name[0xFF] = {
+//   0    1    2    3    4    5    6    7    8    9    A    B    C    D    E    F
+    ' ', ' ', ' ', ' ', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l',  // 0x
+    'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '1', '2',  // 1x
+    '3', '4', '5', '6', '7', '8', '9', '0',  20,  19,  27,  26,  22, '-', '=', '[',  // 2x
+    ']','\\', '#', ';','\'', '`', ',', '.', '/', 128, ' ', ' ', ' ', ' ', ' ', ' ',  // 3x
+    ' ', ' ', ' ', ' ', ' ', ' ', 'P', 'S', ' ', ' ', ' ', ' ',  16, ' ', ' ', ' ',  // 4x
+    ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',  // 5x
+    ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',  // 6x
+    ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',  // 7x
+    ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',  // 8x
+    ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',  // 9x
+    ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',  // Ax
+    ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',  // Bx
+    ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',  // Cx
+    ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',  // Dx
+    'C', 'S', 'A', 'C', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',  // Ex
+    ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' '        // Fx
+};
+
+
+#if defined(KEY_LOG_ENABLE)
+void add_keylog(uint16_t keycode) {
+    if ((keycode >= QK_MOD_TAP && keycode <= QK_MOD_TAP_MAX)
+        || (keycode >= QK_LAYER_TAP && keycode <= QK_LAYER_TAP_MAX)
+        || (keycode >= QK_MODS && keycode <= QK_MODS_MAX)) {
+        keycode = keycode & 0xFF;
+    } else if (keycode > 0xFF) {
+        keycode = 0;
+    }
+
+    for (uint8_t i = (KEYLOGGER_LENGTH - 1); i > 0; --i) {
+        keylog_str[i] = keylog_str[i - 1];
+    }
+
+    if (keycode < (sizeof(code_to_name) / sizeof(char))) {
+        keylog_str[0] = pgm_read_byte(&code_to_name[keycode]);
+    }
+}
+#endif
+
+static uint16_t key_timer  = 0;
+static bool is_key_processed = true;
+bool process_record_oled(uint16_t keycode, keyrecord_t *record) {
+    if (record->event.pressed) {
+        key_timer = timer_read();
+        is_key_processed = true;
+
+#       if defined(KEY_LOG_ENABLE)
+        add_keylog(keycode);
+#endif
+    }
+
+    return true;
+}
+
+
+void render_keylogger_status(void) {
+    oled_write(keylog_str, false);
+}
+
+
+void render_prompt(void) {
+    bool blink = (timer_read() % 1000) < 500;
+
+    if (layer_state_is(_FUNCTION)) {
+        oled_write_ln_P(blink ? PSTR("> ft_") : PSTR("> ft "), false);
+    } else if (layer_state_is(_CODE)) {
+        oled_write_ln_P(blink ? PSTR("> sy_") : PSTR("> sy "), false);
+    } else if (layer_state_is(_ADJUST)) {
+        oled_write_ln_P(blink ? PSTR("> aj_") : PSTR("> aj "), false);
+    } else {
+        oled_write_ln_P(blink ? PSTR("> _  ") : PSTR(">    "), false);
+    }
+};
+
+
+void render_status_secondary(void) {
+    oled_write_ln("", false);
+    oled_write_ln("", false);
+
+    render_kb_split();
+
+    oled_write_ln("", false);
+    oled_write_ln("", false);
+    oled_write_ln("", false);
+
+    render_layer();
+
+    oled_write_ln("", false);
+    oled_write_ln("", false);
+    oled_write_ln("", false);
+
+#if defined(RGB_MATRIX_ENABLE) || defined(RGBLIGHT_ENABLE)
+    layer_state_is(_ADJUST) ? render_feature_status() : render_mod_status();
+#else
+    render_mod_status();
+#endif
+};
+
+
+void render_status_main(void) {
+    oled_write_ln("", false);
+    oled_write_ln("", false);
+
+    render_qmk_logo();
+
+    oled_write_ln("", false);
+    oled_write_ln("", false);
+
+    render_layers();
+
+    oled_write_ln("", false);
+    oled_write_ln("", false);
+
+    render_prompt();
+
+    oled_write_ln("", false);
+
+    render_keylogger_status();
+}
+
+
+oled_rotation_t oled_init_user(oled_rotation_t rotation) {
+    return OLED_ROTATION_270;
+}
+
+
+bool oled_task_user(void) {
+    if (is_keyboard_master()) {
+        if (is_key_processed && (timer_elapsed(key_timer) < OLED_KEY_TIMEOUT)) {
+            render_status_main();
+        } else if (is_key_processed) {
+            is_key_processed = false;
+            oled_off();
+        }
+    } else {
+        render_status_secondary();
+    }
+
+    return false;
+}