boardsource/microdox V2 (#16569)

2022-04-19 05:03:51 -06:00 · 2022-04-19 05:03:51 -06:00 · ad31ea3f51
parent 9ead40db0c
commit ad31ea3f51
14 changed files with 278 additions and 215 deletions
--- a/keyboards/boardsource/microdox/config.h
+++ b/keyboards/boardsource/microdox/config.h
@ -29,10 +29,12 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 // Rows are doubled-up
 #define MATRIX_ROWS 8
 #define MATRIX_COLS 5
-#define MATRIX_ROW_PINS { B2, B6, B4, B5 }
+#define MATRIX_ROW_PINS \
+    { B2, B6, B4, B5 }

 // wiring of each half
-#define MATRIX_COL_PINS { F4, F5, F6, F7, B1 }
+#define MATRIX_COL_PINS \
+    { F4, F5, F6, F7, B1 }
 #define USE_SERIAL
 #define SOFT_SERIAL_PIN D2
 /* define if matrix has ghost */
@ -53,12 +55,15 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //#define LOCKING_RESYNC_ENABLE

 /* ws2812 RGB LED */
-#define RGBLIGHT_ANIMATIONS
 #define RGB_DI_PIN D3
-#define RGBLED_SPLIT { 6, 6 }
-#define EE_HANDS
 #ifdef RGBLIGHT_ENABLE
 #    define RGBLED_NUM 12 // Number of LEDs
+#    define RGBLED_SPLIT \
+        { 6, 6 }
+#    define RGBLIGHT_EFFECT_BREATHING
+#    define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+#    define RGBLIGHT_EFFECT_STATIC_GRADIENT
+
 #endif

 /*
--- a/keyboards/boardsource/microdox/keymaps/cole/keymap.c
+++ b/keyboards/boardsource/microdox/keymaps/cole/keymap.c
@ -16,13 +16,11 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

 #include QMK_KEYBOARD_H
-#include "split_util.h"

 enum layers {
    _QWERTY,
    _RAISE,
-    _LOWER,
-    _ADJUST
+    _LOWER
 };

 #define KC_CTSC RCTL_T(KC_SCLN)
@ -35,8 +33,6 @@ enum layers {
 #define PREVWINDOW MT(MOD_LCTL, KC_LEFT)
 #define NEXTWINDOW MT(MOD_LCTL, KC_RGHT)

-
-
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  [_QWERTY] = LAYOUT_split_3x5_3(
        KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,             KC_Y,    KC_U,    KC_I,    KC_O,   KC_P,
@ -57,61 +53,3 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
                            _______,  KC_LGUI,  KC_ENT,         KC_BSPC,  KC_SPC, _______
  )
 };
-
-#ifdef OLED_ENABLE
-oled_rotation_t oled_init_user(oled_rotation_t rotation) {
-  if (is_keyboard_master())
-    return OLED_ROTATION_180;
-  return rotation;
-}
-
-static void render_logo(void) {
-  static const char PROGMEM qmk_logo[] = {
-     0x80,0x81,0x82,0x83,0x84,0x85,0x86,0x87,0x88,0x89,0x8a,0x8b,0x8c,0x8d,0x8e,0x8f,0x90,0x91,0x92,0x93,0x94,
-    0xa0,0xa1,0xa2,0xa3,0xa4,0xa5,0xa6,0xa7,0xa8,0xa9,0xaa,0xab,0xac,0xad,0xae,0xaf,0xb0,0xb1,0xb2,0xb3,0xb4,
-    0xc0,0xc1,0xc2,0xc3,0xc4,0xc5,0xc6,0xc7,0xc8,0xc9,0xca,0xcb,0xcc,0xcd,0xce,0xcf,0xd0,0xd1,0xd2,0xd3,0xd4,
-    0
-  };
-  oled_write_P(qmk_logo, false);
-}
-
-static void render_status(void) {
-   switch (get_highest_layer(layer_state)) {
-    case _QWERTY:
-      oled_write_P(PSTR("B R L A O\n"), false);
-      oled_write_P(PSTR("^\n"), false);
-      oled_write_P(PSTR("Layer: Base\n"), false);
-      break;
-    case _RAISE:
-      oled_write_P(PSTR("B R L A O\n"), false);
-      oled_write_P(PSTR("  ^\n"), false);
-      oled_write_P(PSTR("Layer: Raise\n"), false);
-      break;
-    case _LOWER:
-      oled_write_P(PSTR("B R L A O\n"), false);
-      oled_write_P(PSTR("    ^\n"), false);
-      oled_write_P(PSTR("Layer: Lower\n"), false);
-      break;
-    case _ADJUST:
-      oled_write_P(PSTR("B R L A O\n"), false);
-      oled_write_P(PSTR("      ^\n"), false);
-      oled_write_P(PSTR("Layer: Adjust\n"), false);
-      break;
-    default:
-      oled_write_P(PSTR("B R L A O"), false);
-      oled_write_P(PSTR("        ^\n"), false);
-      oled_write_P(PSTR("Layer: Other\n"), false);
-  }
-}
-
-bool oled_task_user(void) {
-  if (is_keyboard_master()) {
-    render_status();
-  } else {
-    render_logo();
-    oled_scroll_left();
-  }
-    return false;
-}
-
-#endif
--- a/keyboards/boardsource/microdox/keymaps/cole/rules.mk
+++ b/keyboards/boardsource/microdox/keymaps/cole/rules.mk
@ -1,2 +1 @@
 OLED_ENABLE = yes
-OLED_DRIVER = SSD1306
--- a/keyboards/boardsource/microdox/keymaps/via/keymap.c
+++ b/keyboards/boardsource/microdox/keymaps/via/keymap.c
@ -1,20 +1,5 @@
-/*
-Copyright 2020 Jack Sangdahl <@toastedmangoes>
-
-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/>.
-*/
-
+// Copyright 2022 jack (@waffle87)
+// SPDX-License-Identifier: GPL-2.0-or-later
 #include QMK_KEYBOARD_H

 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
@ -45,61 +30,3 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
                      KC_TRNS, XXXXXXX, XXXXXXX,      XXXXXXX, XXXXXXX, XXXXXXX
  )
 };
-
-#ifdef OLED_ENABLE
-oled_rotation_t oled_init_user(oled_rotation_t rotation) {
-  if (is_keyboard_master())
-    return OLED_ROTATION_180;
-  return rotation;
-}
-
-static void render_logo(void) {
-  static const char PROGMEM qmk_logo[] = {
-     0x80,0x81,0x82,0x83,0x84,0x85,0x86,0x87,0x88,0x89,0x8a,0x8b,0x8c,0x8d,0x8e,0x8f,0x90,0x91,0x92,0x93,0x94,
-    0xa0,0xa1,0xa2,0xa3,0xa4,0xa5,0xa6,0xa7,0xa8,0xa9,0xaa,0xab,0xac,0xad,0xae,0xaf,0xb0,0xb1,0xb2,0xb3,0xb4,
-    0xc0,0xc1,0xc2,0xc3,0xc4,0xc5,0xc6,0xc7,0xc8,0xc9,0xca,0xcb,0xcc,0xcd,0xce,0xcf,0xd0,0xd1,0xd2,0xd3,0xd4,
-    0
-  };
-  oled_write_P(qmk_logo, false);
-}
-
-static void render_status(void) {
-   switch (get_highest_layer(layer_state)) {
-    case 0:
-      oled_write_P(PSTR("B R L A O\n"), false);
-      oled_write_P(PSTR("^\n"), false);
-      oled_write_P(PSTR("Layer: Base\n"), false);
-      break;
-    case 1:
-      oled_write_P(PSTR("B R L A O\n"), false);
-      oled_write_P(PSTR("  ^\n"), false);
-      oled_write_P(PSTR("Layer: Raise\n"), false);
-      break;
-    case 2:
-      oled_write_P(PSTR("B R L A O\n"), false);
-      oled_write_P(PSTR("    ^\n"), false);
-      oled_write_P(PSTR("Layer: Lower\n"), false);
-      break;
-    case 3:
-      oled_write_P(PSTR("B R L A O\n"), false);
-      oled_write_P(PSTR("      ^\n"), false);
-      oled_write_P(PSTR("Layer: Adjust\n"), false);
-      break;
-    default:
-      oled_write_P(PSTR("B R L A O"), false);
-      oled_write_P(PSTR("        ^\n"), false);
-      oled_write_P(PSTR("Layer: Other\n"), false);
-  }
-}
-
-bool oled_task_user(void) {
-  if (is_keyboard_master()) {
-    render_status();
-  } else {
-    render_logo();
-    oled_scroll_left();
-  }
-    return false;
-}
-
-#endif
--- a/keyboards/boardsource/microdox/keymaps/via/rules.mk
+++ b/keyboards/boardsource/microdox/keymaps/via/rules.mk
@ -1,6 +1,3 @@
 OLED_ENABLE = yes
-OLED_DRIVER = SSD1306
 VIA_ENABLE = yes
-EXTRAKEY_ENABLE = yes
-RGBLIGHT_ENABLE = yes
 LTO_ENABLE = yes
--- a/keyboards/boardsource/microdox/microdox.c
+++ b/keyboards/boardsource/microdox/microdox.c
@ -17,3 +17,60 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.

 #include "microdox.h"

+#ifdef OLED_ENABLE
+oled_rotation_t oled_init_kb(oled_rotation_t rotation) {
+  if (is_keyboard_master())
+    return OLED_ROTATION_180;
+  return rotation;
+}
+
+static void render_logo(void) {
+  static const char PROGMEM qmk_logo[] = {
+    0x80,0x81,0x82,0x83,0x84,0x85,0x86,0x87,0x88,0x89,0x8a,0x8b,0x8c,0x8d,0x8e,0x8f,0x90,0x91,0x92,0x93,0x94,
+    0xa0,0xa1,0xa2,0xa3,0xa4,0xa5,0xa6,0xa7,0xa8,0xa9,0xaa,0xab,0xac,0xad,0xae,0xaf,0xb0,0xb1,0xb2,0xb3,0xb4,
+    0xc0,0xc1,0xc2,0xc3,0xc4,0xc5,0xc6,0xc7,0xc8,0xc9,0xca,0xcb,0xcc,0xcd,0xce,0xcf,0xd0,0xd1,0xd2,0xd3,0xd4,
+    0
+  };
+  oled_write_P(qmk_logo, false);
+}
+
+static void render_status(void) {
+   switch (get_highest_layer(layer_state)) {
+    case 0:
+      oled_write_P(PSTR("B R L A O\n"), false);
+      oled_write_P(PSTR("^\n"), false);
+      oled_write_P(PSTR("Layer: Base\n"), false);
+      break;
+    case 1:
+      oled_write_P(PSTR("B R L A O\n"), false);
+      oled_write_P(PSTR("  ^\n"), false);
+      oled_write_P(PSTR("Layer: Raise\n"), false);
+      break;
+    case 2:
+      oled_write_P(PSTR("B R L A O\n"), false);
+      oled_write_P(PSTR("    ^\n"), false);
+      oled_write_P(PSTR("Layer: Lower\n"), false);
+      break;
+    case 3:
+      oled_write_P(PSTR("B R L A O\n"), false);
+      oled_write_P(PSTR("      ^\n"), false);
+      oled_write_P(PSTR("Layer: Adjust\n"), false);
+      break;
+    default:
+      oled_write_P(PSTR("B R L A O"), false);
+      oled_write_P(PSTR("        ^\n"), false);
+      oled_write_P(PSTR("Layer: Other\n"), false);
+  }
+}
+
+bool oled_task_kb(void) {
+  if (!oled_task_user()) { return false; }
+  if (is_keyboard_master()) {
+    render_status();
+  } else {
+    render_logo();
+    oled_scroll_left();
+  }
+  return false;
+}
+#endif
--- a/keyboards/boardsource/microdox/microdox.h
+++ b/keyboards/boardsource/microdox/microdox.h
@ -18,20 +18,21 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #pragma once

 #include "quantum.h"
+#define xxx KC_NO

 #define LAYOUT_split_3x5_3(\
-  k01, k02, k03, k04, k05,    k45, k44, k43, k42, k41, \
-  k11, k12, k13, k14, k15,    k55, k54, k53, k52, k51, \
-  k21, k22, k23, k24, k25,    k65, k64, k63, k62, k61, \
-            k33, k34, k35,    k75, k74, k73            \
+  k00, k01, k02, k03, k04,    k44, k43, k42, k41, k40, \
+  k10, k11, k12, k13, k14,    k54, k53, k52, k51, k50, \
+  k20, k21, k22, k23, k24,    k64, k63, k62, k61, k60, \
+            k32, k33, k34,    k74, k73, k72            \
  ) \
  { \
-    { k01, k02, k03, k04, k05 }, \
-    { k11, k12, k13, k14, k15 }, \
-    { k21, k22, k23, k24, k25 }, \
-    { KC_NO,KC_NO, k33, k34, k35 }, \
-    { k41, k42, k43, k44, k45 }, \
-    { k51, k52, k53, k54, k55 }, \
-    { k61, k62, k63, k64, k65 }, \
-    { KC_NO, KC_NO, k73, k74, k75 } \
+    { k00, k01, k02, k03, k04 }, \
+    { k10, k11, k12, k13, k14 }, \
+    { k20, k21, k22, k23, k24 }, \
+    { xxx, xxx, k32, k33, k34 }, \
+    { k40, k41, k42, k43, k44 }, \
+    { k50, k51, k52, k53, k54 }, \
+    { k60, k61, k62, k63, k64 }, \
+    { xxx, xxx, k72, k73, k74 } \
  }
--- a/keyboards/boardsource/microdox/readme.md
+++ b/keyboards/boardsource/microdox/readme.md
@ -3,11 +3,13 @@
 ![boardsource Microdox](https://i.imgur.com/AliShkvl.jpg)

 * Keyboard Maintainer: [Boardsource](https://github.com/daysgobye) 
-* Hardware Supported: microdox v1
+* Hardware Supported: Pro Micro and compatible alternatives
 * Hardware Availability: this keyboard is available from the [Boardsource store](https://boardsource.xyz/store/5f2e7e4a2902de7151494f92)

 Make example for this keyboard (after setting up your build environment):

-    make boardsource/microdox:default
+    make boardsource/microdox/v2:default
+
+Remove `v2` from above command if you purchased your PCBs prior to April 2022

 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).
--- a/keyboards/boardsource/microdox/rules.mk
+++ b/keyboards/boardsource/microdox/rules.mk
@ -7,12 +7,12 @@ BOOTLOADER = caterina
 # Build Options
 #   change yes to no to disable
 #
-BOOTMAGIC_ENABLE = no       # Enable Bootmagic Lite
+BOOTMAGIC_ENABLE = yes       # Enable Bootmagic Lite
 MOUSEKEY_ENABLE = no        # Mouse keys
-EXTRAKEY_ENABLE = no        # Audio control and System control
+EXTRAKEY_ENABLE = yes        # Audio control and System control
 CONSOLE_ENABLE = no         # Console for debug
 COMMAND_ENABLE = no         # Commands for debug and configuration
-NKRO_ENABLE = no            # Enable N-Key Rollover
+NKRO_ENABLE = yes            # Enable N-Key Rollover
 BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
 RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
 AUDIO_ENABLE = no           # Audio output
--- a/keyboards/boardsource/microdox/v2/config.h
+++ b/keyboards/boardsource/microdox/v2/config.h
@ -0,0 +1,45 @@
+// Copyright 2022 jack (@waffle87)
+// SPDX-License-Identifier: GPL-2.0-or-later
+#pragma once
+#undef MATRIX_ROW_PINS
+#undef MATRIX_COL_PINS
+#define MATRIX_ROW_PINS \
+    { F4, D2, C6, B1 }
+#define MATRIX_COL_PINS \
+    { D4, D7, B3, F7, F6 }
+#define MATRIX_ROW_PINS_RIGHT \
+    { F5, F7, F6, E6 }
+#define MATRIX_COL_PINS_RIGHT \
+    { F4, B1, D7, C6, B3 }
+#undef SOFT_SERIAL_PIN
+#define SOFT_SERIAL_PIN D3
+#undef RGB_DI_PIN
+#define RGB_DI_PIN B5
+#ifdef RGBLIGHT_ENABLE
+#    undef RGBLED_NUM
+#    undef RGBLED_SPLIT
+#    define RGBLED_NUM 8
+#    define RGBLED_SPLIT { 4, 4 } // underglow only
+#    define RGBLIGHT_SLEEP
+#    define RGBLIGHT_EFFECT_BREATHING
+#    define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+#    define RGBLIGHT_EFFECT_STATIC_GRADIENT
+#endif
+#ifdef RGB_MATRIX_ENABLE
+#    define DRIVER_LED_TOTAL 44
+#    define RGB_MATRIX_SPLIT { 22, 22 }
+#    define RGB_DISABLE_WHEN_USB_SUSPENDED
+#    define RGB_MATRIX_MAXIMUM_BRIGHTNESS 150
+#    define ENABLE_RGB_MATRIX_ALPHAS_MODS
+#    define ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT
+#    define ENABLE_RGB_MATRIX_BREATHING
+#    define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
+#    define ENABLE_RGB_MATRIX_CYCLE_SPIRAL
+#    define ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
+#endif
+#ifdef ENCODER_ENABLE
+#    define ENCODERS_PAD_A { E6 }
+#    define ENCODERS_PAD_B { B2 }
+#    define ENCODERS_PAD_A_RIGHT { B6 }
+#    define ENCODERS_PAD_B_RIGHT { B2 }
+#endif
--- a/keyboards/boardsource/microdox/v2/rules.mk
+++ b/keyboards/boardsource/microdox/v2/rules.mk
@ -0,0 +1,8 @@
+RGB_MATRIX_ENABLE = yes
+RGB_MATRIX_DRIVER = WS2812
+RGB_MATRIX_SUPPORTED = yes
+RGBLIGHT_ENABLE = no
+OLED_ENABLE = yes
+OLED_DRIVER = SSD1306
+ENCODER_ENABLE = yes
+LTO_ENABLE = yes
--- a/keyboards/boardsource/microdox/v2/v2.c
+++ b/keyboards/boardsource/microdox/v2/v2.c
@ -0,0 +1,62 @@
+// Copyright 2022 jack (@waffle87)
+// SPDX-License-Identifier: GPL-2.0-or-later
+#include "v2.h"
+
+#ifdef RGB_MATRIX_ENABLE
+led_config_t g_led_config = { 
+  {
+    { 13, 14, 15, 16, 17 },
+    { 12, 11, 10, 9,  8  },
+    { 3,  4,  5,  6,  7  },
+    { NO_LED, NO_LED, 2, 1, 0 },
+    //18-21 left underglow
+    { 35, 36, 37, 38, 39 },
+    { 34, 33, 32, 31, 30 },
+    { 25, 26, 27, 28, 29 },
+    { NO_LED, NO_LED, 24, 23, 22 }
+    //40-44 right underglow
+  }, {
+    {99,64}, {74,64}, {49,64}, //0-2
+    {0,42},  {24,42}, {49,42}, {74,42}, {99,42}, //3-7
+    {99,21}, {74,21}, {49,21}, {24,21}, {0,21}, //8-12
+    {0,0},   {24,0},  {49,0},  {74,0},  {99,0}, //13-17
+    {12,11}, {86,11}, {86,53}, {0,64}, //18-21
+    {124,64}, {149,64}, {174,64}, //22-24
+    {224,42}, {199,42}, {174,42}, {149,42}, {124,42}, //25-29
+    {124,21}, {149,21}, {174,21}, {199,21}, {224,21}, //30-34
+    {224,0},  {199,0},  {174,0},  {149,0},  {124,0}, //35-39
+    {211,11}, {136,11}, {136,53}, {224,64} //40-44
+  }, {
+    1, 1, 1,
+    4, 4, 4, 4, 4,
+    4, 4, 4, 4, 4,
+    4, 4, 4, 4, 4,
+    2, 2, 2, 2,
+    1, 1, 1,
+    4, 4, 4, 4, 4,
+    4, 4, 4, 4, 4,
+    4, 4, 4, 4, 4,
+    2, 2, 2, 2
+  }
+};
+#endif
+
+#ifdef ENCODER_ENABLE
+bool encoder_update_kb(uint8_t index, bool clockwise) {
+  if (!encoder_update_user(index, clockwise)) { return false; }
+  if (index == 0) {
+    if (clockwise) {
+      tap_code_delay(KC_VOLU, 10);
+    } else {
+      tap_code_delay(KC_VOLD, 10);  
+    }
+  } else {
+    if (clockwise) {
+      tap_code(KC_MNXT);
+    } else {
+      tap_code(KC_MPRV);
+    }
+  }
+  return false;
+}
+#endif
--- a/keyboards/boardsource/microdox/v2/v2.h
+++ b/keyboards/boardsource/microdox/v2/v2.h
@ -0,0 +1,22 @@
+// Copyright 2022 jack (@waffle87)
+// SPDX-License-Identifier: GPL-2.0-or-later
+#pragma once
+#include "quantum.h"
+#define xxx KC_NO
+
+#define LAYOUT_split_3x5_3(\
+  k00, k01, k02, k03, k04,    k44, k43, k42, k41, k40, \
+  k10, k11, k12, k13, k14,    k54, k53, k52, k51, k50, \
+  k20, k21, k22, k23, k24,    k64, k63, k62, k61, k60, \
+            k32, k33, k34,    k74, k73, k72            \
+  ) \
+  { \
+    { k00, k01, k02, k03, k04 }, \
+    { k10, k11, k12, k13, k14 }, \
+    { k20, k21, k22, k23, k24 }, \
+    { xxx, xxx, k32, k33, k34 }, \
+    { k40, k41, k42, k43, k44 }, \
+    { k50, k51, k52, k53, k54 }, \
+    { k60, k61, k62, k63, k64 }, \
+    { xxx, xxx, k72, k73, k74 } \
+  }