summaryrefslogtreecommitdiff
path: root/keyboards
diff options
context:
space:
mode:
authorcole smith <38364556+daysgobye@users.noreply.github.com>2020-08-18 13:46:09 -0600
committerGitHub <noreply@github.com>2020-08-18 12:46:09 -0700
commitc0df341f5c0db7217838dfb994ccbb6bd2d075fe (patch)
tree6a2a6b4bf3f3644d04b214334729e414c836753b /keyboards
parent186b1b2ba2550d9a7a864a241e8f9503c37f188b (diff)
[Keyboard] Boardsource Microdox (#9971)
* microdox keyboard workidng * updated readme * cleaned up for pr * Apply suggestions from code review * Apply suggestions from code review * added license headers * Update keyboards/boardsource/microdox/keymaps/default/keymap.c * Update keyboards/boardsource/microdox/rules.mk * Update keyboards/boardsource/microdox/rules.mk * Update keyboards/boardsource/microdox/rules.mk
Diffstat (limited to 'keyboards')
-rw-r--r--keyboards/boardsource/microdox/config.h80
-rw-r--r--keyboards/boardsource/microdox/info.json56
-rw-r--r--keyboards/boardsource/microdox/keymaps/cole/keymap.c116
-rw-r--r--keyboards/boardsource/microdox/keymaps/cole/rules.mk1
-rw-r--r--keyboards/boardsource/microdox/keymaps/default/keymap.c50
-rw-r--r--keyboards/boardsource/microdox/microdox.c19
-rw-r--r--keyboards/boardsource/microdox/microdox.h37
-rw-r--r--keyboards/boardsource/microdox/readme.md13
-rw-r--r--keyboards/boardsource/microdox/rules.mk23
9 files changed, 395 insertions, 0 deletions
diff --git a/keyboards/boardsource/microdox/config.h b/keyboards/boardsource/microdox/config.h
new file mode 100644
index 0000000000..65af0f16de
--- /dev/null
+++ b/keyboards/boardsource/microdox/config.h
@@ -0,0 +1,80 @@
+/*
+Copyright 2020 Cole Smith <cole@boadsource.xyz>
+
+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"
+
+#define VENDOR_ID 0xF7E0
+#define PRODUCT_ID 0x0412
+#define DEVICE_VER 0x0000
+#define MANUFACTURER Boardsource
+#define PRODUCT microdox
+
+/* key matrix size */
+// Rows are doubled-up
+#define MATRIX_ROWS 8
+#define MATRIX_COLS 5
+#define MATRIX_ROW_PINS { B2, B6, B4, B5 }
+
+// wiring of each half
+#define MATRIX_COL_PINS { F4, F5, F6, F7, B1 }
+#define USE_SERIAL
+#define SOFT_SERIAL_PIN D2
+/* define if matrix has ghost */
+//#define MATRIX_HAS_GHOST
+
+/* number of backlight levels */
+// #define BACKLIGHT_LEVELS 3
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCE 5
+
+/* COL2ROW, ROW2COL*/
+#define DIODE_DIRECTION COL2ROW
+
+/* 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
+
+/* 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
+#endif
+
+/*
+ * 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
+//#define NO_ACTION_MACRO
+//#define NO_ACTION_FUNCTION \ No newline at end of file
diff --git a/keyboards/boardsource/microdox/info.json b/keyboards/boardsource/microdox/info.json
new file mode 100644
index 0000000000..fad30399d4
--- /dev/null
+++ b/keyboards/boardsource/microdox/info.json
@@ -0,0 +1,56 @@
+{
+ "keyboard_name": "microdox",
+ "url": "https://boardsource.xyz/store/5f2e7e4a2902de7151494f92",
+ "maintainer": "boardsource",
+ "width": 13,
+ "height": 4.7,
+ "layouts": {
+ "LAYOUT_split_3x5_3": {
+ "layout": [
+ { "label": "Q", "x": 0, "y": 0.3 },
+ { "label": "W", "x": 1, "y": 0.1 },
+ { "label": "E", "x": 2, "y": 0 },
+ { "label": "R", "x": 3, "y": 0.1 },
+ { "label": "T", "x": 4, "y": 0.2 },
+
+ { "label": "Y", "x": 8, "y": 0.2 },
+ { "label": "U", "x": 9, "y": 0.1 },
+ { "label": "I", "x": 10, "y": 0 },
+ { "label": "O", "x": 11, "y": 0.1 },
+ { "label": "P", "x": 12, "y": 0.3 },
+
+ { "label": "A", "x": 0, "y": 1.3 },
+ { "label": "S", "x": 1, "y": 1.1 },
+ { "label": "D", "x": 2, "y": 1 },
+ { "label": "F", "x": 3, "y": 1.1 },
+ { "label": "G", "x": 4, "y": 1.2 },
+
+ { "label": "H", "x": 8, "y": 1.2 },
+ { "label": "J", "x": 9, "y": 1.1 },
+ { "label": "K", "x": 10, "y": 1 },
+ { "label": "L", "x": 11, "y": 1.1 },
+ { "label": ";", "x": 12, "y": 1.3 },
+
+ { "label": "Z", "x": 0, "y": 2.3 },
+ { "label": "X", "x": 1, "y": 2.1 },
+ { "label": "C", "x": 2, "y": 2 },
+ { "label": "V", "x": 3, "y": 2.1 },
+ { "label": "B", "x": 4, "y": 2.2 },
+
+ { "label": "N", "x": 8, "y": 2.2 },
+ { "label": "M", "x": 9, "y": 2.1 },
+ { "label": ",", "x": 10, "y": 2 },
+ { "label": ".", "x": 11, "y": 2.1 },
+ { "label": "/", "x": 12, "y": 2.3 },
+
+ { "label": "GUI / KC_HANJ", "x": 3, "y": 3.7 },
+ { "label": "Lower", "x": 4, "y": 3.7 },
+ { "label": "Space", "x": 5, "y": 3.2 },
+
+ { "label": "Enter", "x": 7, "y": 3.2 },
+ { "label": "Raise", "x": 8, "y": 3.7 },
+ { "label": "Alt / KC_HAEN", "x": 9, "y": 3.7 }
+ ]
+ }
+ }
+}
diff --git a/keyboards/boardsource/microdox/keymaps/cole/keymap.c b/keyboards/boardsource/microdox/keymaps/cole/keymap.c
new file mode 100644
index 0000000000..62d7280000
--- /dev/null
+++ b/keyboards/boardsource/microdox/keymaps/cole/keymap.c
@@ -0,0 +1,116 @@
+/*
+Copyright 2020 Cole Smith <cole@boadsource.xyz>
+
+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 "split_util.h"
+
+enum layers {
+ _QWERTY,
+ _RAISE,
+ _LOWER,
+ _ADJUST
+};
+
+#define KC_CTSC RCTL_T(KC_SCLN)
+#define LOWER_SPC LT(_LOWER, KC_SPC)
+#define RASE_BACK LT(_RAISE, KC_BSPC)
+#define SHFT_Z MT(MOD_LSFT, KC_Z)
+#define SHIFT_SLASH MT(MOD_RSFT,KC_SLSH)
+#define RASE_ENT LT(_RAISE, KC_ENT)
+#define CTRL_A MT(MOD_LCTL,KC_A)
+#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,
+ CTRL_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_CTSC,
+ SHFT_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, SHIFT_SLASH,
+ MO(_LOWER),KC_LGUI, RASE_ENT, RASE_BACK, LOWER_SPC, KC_TAB
+ ),
+ [_RAISE] = LAYOUT_split_3x5_3(
+ KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0,
+ KC_ESC, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_QUOT,
+ KC_LSFT, KC_GRV, PREVWINDOW, NEXTWINDOW, XXXXXXX, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,
+ _______, KC_LGUI, KC_ENT, KC_BSPC, KC_SPC, _______
+ ),
+ [_LOWER] = LAYOUT_split_3x5_3(
+ KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN,
+ KC_ESC, XXXXXXX, XXXXXXX, XXXXXXX, RGB_TOG, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_DQT,
+ KC_ESC, KC_TILD, PREVWINDOW, NEXTWINDOW, RGB_MODE_FORWARD, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
+ _______, KC_LGUI, KC_ENT, KC_BSPC, KC_SPC, _______
+ )
+};
+
+#ifdef OLED_DRIVER_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);
+ }
+}
+
+void oled_task_user(void) {
+ if (is_keyboard_master()) {
+ render_status();
+ } else {
+ render_logo();
+ oled_scroll_left();
+ }
+}
+
+#endif
diff --git a/keyboards/boardsource/microdox/keymaps/cole/rules.mk b/keyboards/boardsource/microdox/keymaps/cole/rules.mk
new file mode 100644
index 0000000000..48a51b2250
--- /dev/null
+++ b/keyboards/boardsource/microdox/keymaps/cole/rules.mk
@@ -0,0 +1 @@
+OLED_DRIVER_ENABLE = yes \ No newline at end of file
diff --git a/keyboards/boardsource/microdox/keymaps/default/keymap.c b/keyboards/boardsource/microdox/keymaps/default/keymap.c
new file mode 100644
index 0000000000..06322be0b7
--- /dev/null
+++ b/keyboards/boardsource/microdox/keymaps/default/keymap.c
@@ -0,0 +1,50 @@
+/*
+Copyright 2020 Cole Smith <cole@boadsource.xyz>
+
+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 layers {
+ _QWERTY,
+ _RAISE,
+ _LOWER,
+};
+
+#define RAISE MO(_RAISE)
+#define LOWER MO(_LOWER)
+
+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,
+ KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN,
+ KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH,
+ KC_LCTL, LOWER, KC_SPC, KC_BSPC, RAISE, KC_ENT
+),
+
+[_RAISE] = LAYOUT_split_3x5_3(
+ KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0,
+ KC_TAB, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, XXXXXXX, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC,
+ KC_LCTL, KC_GRV, KC_LGUI, KC_LALT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_BSLS, KC_QUOT,
+ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
+),
+
+[_LOWER] = LAYOUT_split_3x5_3(
+ KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN,
+ KC_ESC, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR,
+ KC_CAPS, KC_TILD, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_PIPE, KC_DQT,
+ XXXXXXX, XXXXXXX, XXXXXXX, KC_ENT, XXXXXXX, KC_DEL
+)
+};
diff --git a/keyboards/boardsource/microdox/microdox.c b/keyboards/boardsource/microdox/microdox.c
new file mode 100644
index 0000000000..eef981297a
--- /dev/null
+++ b/keyboards/boardsource/microdox/microdox.c
@@ -0,0 +1,19 @@
+/*
+Copyright 2020 Cole Smith <cole@boadsource.xyz>
+
+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 "microdox.h"
+
diff --git a/keyboards/boardsource/microdox/microdox.h b/keyboards/boardsource/microdox/microdox.h
new file mode 100644
index 0000000000..950d46d99f
--- /dev/null
+++ b/keyboards/boardsource/microdox/microdox.h
@@ -0,0 +1,37 @@
+/*
+Copyright 2020 Cole Smith <cole@boadsource.xyz>
+
+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_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 \
+ ) \
+ { \
+ { 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 } \
+ }
diff --git a/keyboards/boardsource/microdox/readme.md b/keyboards/boardsource/microdox/readme.md
new file mode 100644
index 0000000000..7b54283674
--- /dev/null
+++ b/keyboards/boardsource/microdox/readme.md
@@ -0,0 +1,13 @@
+# Microdox
+
+![boardsource Microdox](https://i.imgur.com/AliShkvl.jpg)
+
+* Keyboard Maintainer: [Boardsource](https://github.com/daysgobye)
+* Hardware Supported: microdox v1
+* 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
+
+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).
diff --git a/keyboards/boardsource/microdox/rules.mk b/keyboards/boardsource/microdox/rules.mk
new file mode 100644
index 0000000000..b6afb77c78
--- /dev/null
+++ b/keyboards/boardsource/microdox/rules.mk
@@ -0,0 +1,23 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = caterina
+
+# Build Options
+# change yes to no to disable
+#
+BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = no # Mouse keys
+EXTRAKEY_ENABLE = no # 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 = no # USB Nkey Rollover
+BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no # Enable Bluetooth
+AUDIO_ENABLE = no # Audio output
+SPLIT_KEYBOARD = yes