summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEvan Travers <evantravers@gmail.com>2020-10-09 01:17:25 -0500
committerGitHub <noreply@github.com>2020-10-08 23:17:25 -0700
commitcd0e32ff9ec5d33d911832c1ea716acb900b564d (patch)
tree63cbbe387210a827094e312a8dcd744910d53c32
parent7229997e7d7e3519c09774020c7f3979541ea761 (diff)
[Keyboard] Keyboardio Atreus (#10570)
* Initial support for the Keyboardio Atreus Many thanks to noroadsleft for reviews & suggestions. * Add QMK Configurator layout support * Update the fn layer of the Keyboardio Atreus to the new layout. Previously this was using the Classic Atreus layout. * Implement noroadleft's changes from #8492 * Follow Erovia's recommendations qmk/qmk_firmware#8492 * Correct braces * Change correct rules.mk * Remove comments * Fix BOOTMAGIC_ENABLE I had edited the wrong file earlier. * Remove comment * Updates rules.mk Thank you noroadsleft. Co-authored-by: Gergely Nagy <algernon@keyboard.io> Co-authored-by: Phil Hagelberg <phil@hagelb.org>
-rw-r--r--keyboards/keyboardio/atreus/atreus.c17
-rw-r--r--keyboards/keyboardio/atreus/atreus.h32
-rw-r--r--keyboards/keyboardio/atreus/config.h81
-rw-r--r--keyboards/keyboardio/atreus/info.json57
-rw-r--r--keyboards/keyboardio/atreus/keymaps/default/keymap.c43
-rw-r--r--keyboards/keyboardio/atreus/readme.md31
-rw-r--r--keyboards/keyboardio/atreus/rules.mk24
7 files changed, 285 insertions, 0 deletions
diff --git a/keyboards/keyboardio/atreus/atreus.c b/keyboards/keyboardio/atreus/atreus.c
new file mode 100644
index 0000000000..0ad7156581
--- /dev/null
+++ b/keyboards/keyboardio/atreus/atreus.c
@@ -0,0 +1,17 @@
+/* Copyright (C) 2019, 2020 Keyboard.io, Inc
+ *
+ * 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 "atreus.h"
diff --git a/keyboards/keyboardio/atreus/atreus.h b/keyboards/keyboardio/atreus/atreus.h
new file mode 100644
index 0000000000..b03276ff60
--- /dev/null
+++ b/keyboards/keyboardio/atreus/atreus.h
@@ -0,0 +1,32 @@
+/* Copyright (C) 2019, 2020 Keyboard.io, Inc
+ *
+ * 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 XXX KC_NO
+
+#define LAYOUT( \
+ k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, \
+ k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, \
+ k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \
+ k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b \
+) \
+{ \
+ { k00, k01, k02, k03, k04, XXX, XXX, k05, k06, k07, k08, k09 }, \
+ { k10, k11, k12, k13, k14, XXX, XXX, k15, k16, k17, k18, k19 }, \
+ { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b }, \
+ { k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b } \
+}
diff --git a/keyboards/keyboardio/atreus/config.h b/keyboards/keyboardio/atreus/config.h
new file mode 100644
index 0000000000..fb3a48e58f
--- /dev/null
+++ b/keyboards/keyboardio/atreus/config.h
@@ -0,0 +1,81 @@
+/* Copyright (C) 2019, 2020 Keyboard.io, Inc
+ *
+ * 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 0x1209
+#define PRODUCT_ID 0x2303
+#define DEVICE_VER 0x0000
+#define MANUFACTURER Keyboardio
+#define PRODUCT Atreus
+
+/* key matrix size */
+#define MATRIX_ROWS 4
+#define MATRIX_COLS 12
+
+/* 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
+
+/* 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
+
+/*
+ * Keyboard Matrix Assignments
+ *
+ * Change this to how you wired your keyboard
+ * COLS: AVR pins used for columns, left to right
+ * ROWS: AVR pins used for rows, top to bottom
+ * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
+ * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
+ *
+ */
+
+#define MATRIX_ROW_PINS { F6, F5, F4, F1 }
+#define MATRIX_COL_PINS { F7, E2, C7, C6, B6, B5, D7, D6, D4, D5, D3, D2 }
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL*/
+#define DIODE_DIRECTION COL2ROW
+
+/*
+ * 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
diff --git a/keyboards/keyboardio/atreus/info.json b/keyboards/keyboardio/atreus/info.json
new file mode 100644
index 0000000000..69386999ad
--- /dev/null
+++ b/keyboards/keyboardio/atreus/info.json
@@ -0,0 +1,57 @@
+{
+ "keyboard_name": "Keyboardio Atreus",
+ "url": "",
+ "maintainer": "keyboardio",
+ "width": 13,
+ "height": 4.7,
+ "layouts": {
+ "LAYOUT": {
+ "layout": [
+ {"label":"Q", "x":0, "y":0.6},
+ {"label":"W", "x":1, "y":0.35},
+ {"label":"E", "x":2, "y":0},
+ {"label":"R", "x":3, "y":0.35},
+ {"label":"T", "x":4, "y":0.7},
+ {"label":"Y", "x":8, "y":0.7},
+ {"label":"U", "x":9, "y":0.35},
+ {"label":"I", "x":10, "y":0},
+ {"label":"O", "x":11, "y":0.35},
+ {"label":"P", "x":12, "y":0.6},
+ {"label":"A", "x":0, "y":1.6},
+ {"label":"S", "x":1, "y":1.35},
+ {"label":"D", "x":2, "y":1},
+ {"label":"F", "x":3, "y":1.35},
+ {"label":"G", "x":4, "y":1.7},
+ {"label":"H", "x":8, "y":1.7},
+ {"label":"J", "x":9, "y":1.35},
+ {"label":"K", "x":10, "y":1},
+ {"label":"L", "x":11, "y":1.35},
+ {"label":";", "x":12, "y":1.6},
+ {"label":"Z", "x":0, "y":2.6},
+ {"label":"X", "x":1, "y":2.35},
+ {"label":"C", "x":2, "y":2},
+ {"label":"V", "x":3, "y":2.35},
+ {"label":"B", "x":4, "y":2.7},
+ {"label":"`", "x":5, "y":2.54},
+ {"label":"\\", "x":7, "y":2.54},
+ {"label":"N", "x":8, "y":2.7},
+ {"label":"M", "x":9, "y":2.35},
+ {"label":",", "x":10, "y":2},
+ {"label":".", "x":11, "y":2.35},
+ {"label":"/", "x":12, "y":2.6},
+ {"label":"Esc", "x":0, "y":3.6},
+ {"label":"Tab", "x":1, "y":3.35},
+ {"label":"Super", "x":2, "y":3},
+ {"label":"Shift", "x":3, "y":3.35},
+ {"label":"Bksp", "x":4, "y":3.7},
+ {"label":"Ctrl", "x":5, "y":3.54},
+ {"label":"Alt", "x":7, "y":3.54},
+ {"label":"Space", "x":8, "y":3.7},
+ {"label":"Fun", "x":9, "y":3.35},
+ {"label":"-", "x":10, "y":3},
+ {"label":"'", "x":11, "y":3.35},
+ {"label":"Enter", "x":12,"y":3.6}
+ ]
+ }
+ }
+}
diff --git a/keyboards/keyboardio/atreus/keymaps/default/keymap.c b/keyboards/keyboardio/atreus/keymaps/default/keymap.c
new file mode 100644
index 0000000000..7168733454
--- /dev/null
+++ b/keyboards/keyboardio/atreus/keymaps/default/keymap.c
@@ -0,0 +1,43 @@
+// Copyright (C) 2019, 2020 Keyboard.io, Inc
+//
+// this is the style you want to emulate.
+// This is the canonical layout file for the Quantum project. If you want to add another keyboard,
+
+#include QMK_KEYBOARD_H
+
+enum layer_names {
+ _QW,
+ _RS,
+ _LW,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ [_QW] = LAYOUT( /* Qwerty */
+ 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_GRV, KC_BSLS, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH ,
+ KC_ESC, KC_TAB, KC_LGUI, KC_LSFT, KC_BSPC, KC_LCTL, KC_LALT, KC_SPC, MO(_RS), KC_MINS, KC_QUOT, KC_ENT ),
+
+ /*
+ * ! @ up { } || pgup 7 8 9 *
+ * # left down right $ || pgdn 4 5 6 +
+ * [ ] ( ) & || ` 1 2 3 \
+ * lower insert super shift bksp ctrl || alt space fn . 0 =
+ */
+ [_RS] = LAYOUT( /* [> RAISE <] */
+ KC_EXLM, KC_AT, KC_UP, KC_DLR, KC_PERC, KC_PGUP, KC_7, KC_8, KC_9, KC_BSPC,
+ KC_LPRN, KC_LEFT, KC_DOWN, KC_RGHT, KC_RPRN, KC_PGDN, KC_4, KC_5, KC_6, KC_BSLS,
+ KC_LBRC, KC_RBRC, KC_HASH, KC_LCBR, KC_RCBR, KC_CIRC, KC_AMPR,KC_ASTR, KC_1, KC_2, KC_3, KC_PLUS,
+ TG(_LW), KC_INS, KC_LGUI, KC_LSFT, KC_BSPC, KC_LCTL, KC_LALT,KC_SPC, KC_TRNS, KC_DOT, KC_0, KC_EQL ),
+ /*
+ * insert home up end pgup || up F7 F8 F9 F10
+ * del left down right pgdn || down F4 F5 F6 F11
+ * volup reset || F1 F2 F3 F12
+ * voldn super shift bksp ctrl || alt space L0 prtsc scroll pause
+ */
+ [_LW] = LAYOUT( /* [> LOWER <] */
+ KC_INS, KC_HOME, KC_UP, KC_END, KC_PGUP, KC_UP, KC_F7, KC_F8, KC_F9, KC_F10 ,
+ KC_DEL, KC_LEFT, KC_DOWN, KC_RGHT, KC_PGDN, KC_DOWN, KC_F4, KC_F5, KC_F6, KC_F11 ,
+ KC_NO, KC_VOLU, KC_NO, KC_NO, RESET, _______, _______, KC_NO, KC_F1, KC_F2, KC_F3, KC_F12 ,
+ KC_NO, KC_VOLD, KC_LGUI, KC_LSFT, KC_BSPC, KC_LCTL, KC_LALT, KC_SPC, TO(_QW), KC_PSCR, KC_SLCK, KC_PAUS )
+};
diff --git a/keyboards/keyboardio/atreus/readme.md b/keyboards/keyboardio/atreus/readme.md
new file mode 100644
index 0000000000..ab7dba14d7
--- /dev/null
+++ b/keyboards/keyboardio/atreus/readme.md
@@ -0,0 +1,31 @@
+# Keyboardio Atreus
+
+![Atreus](https://atreus.technomancy.us/i/atreus2-mug.jpg)
+
+A small mechanical keyboard that is based around the shape of the human hand.
+
+* Keyboard Maintainer: [Keyboardio](https://github.com/keyboardio)
+* Hardware Supported: Keyboardio Atreus
+* Hardware Availability: https://www.kickstarter.com/projects/keyboardio/atreus
+
+These configuration files are specifically for the Keyboardio Atreus, a
+collaboration between [Phil Hagelberg](https://github.com/technomancy) and
+[Keyboardio](https://github.com/keyboardio). The keyboard is currently on
+Kickstarter, and will come fully assembled.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make keyboardio/atreus:default
+
+Flashing example for this keyboard:
+
+ make keyboardio/atreus:default:flash
+
+*Unlike the TMK firmware, these commands should be run from the root of the repository, not the directory containing this readme.*
+
+To flash new firmware, the keyboard needs to be in bootloader mode. To do that,
+one needs to hold the bottom left key (`Esc` by default) and reset the
+keyboard - either via a macro, or by sending a hang-up signal to the keyboard
+device, or by pressing the reset button on the bottom with a pin.
+
+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/keyboardio/atreus/rules.mk b/keyboards/keyboardio/atreus/rules.mk
new file mode 100644
index 0000000000..76ff03a80c
--- /dev/null
+++ b/keyboards/keyboardio/atreus/rules.mk
@@ -0,0 +1,24 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = caterina
+
+# Build Options
+# change yes to no to disable
+#
+BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = yes # Mouse keys
+EXTRAKEY_ENABLE = yes # Audio control and System control
+CONSOLE_ENABLE = yes # Console for debug
+COMMAND_ENABLE = yes # 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 = yes # USB Nkey Rollover
+BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no # Enable Bluetooth
+AUDIO_ENABLE = no # Audio output
+
+UNICODE_ENABLE = yes # Unicode