Adding Opus keyboard (#10628)

* Adding opus keyboard * Preparing keyboard for PR * Adding images to default keymap readme * Changing VENDOR_ID * Minor changes * Changing PRODUCT_ID * Removing comment * Fixing tap dance issue * #pragma once instead of #ifndef * Resolving PR suggestions * Removing ifndef * Using lower resolution image * Formatting comments * Adjusting copyright year Co-authored-by: Raleigh Wayland <raleigh.wayland@stormapp.com>
3 years ago · f90688e550
--- a/keyboards/opus/config.h
+++ b/keyboards/opus/config.h
@ -0,0 +1,45 @@
 /* Copyright 2020 rtwayland
 *
 * 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       0x434B
 #define PRODUCT_ID      0x4F50
 #define DEVICE_VER      0x0001
 #define MANUFACTURER    rtwayland
 #define PRODUCT         Opus

 /* key matrix size */
 #define MATRIX_ROWS 4
 #define MATRIX_COLS 12

 /* PCB pin-out */
 #define MATRIX_ROW_PINS {B1, B3, B2, B6}
 #define MATRIX_COL_PINS {D1, D0, D4, C6, D7, E6, B4, B5, F4, F5, F6, F7}
 #define UNUSED_PINS

 #define DIODE_DIRECTION COL2ROW

 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not 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
--- a/keyboards/opus/info.json
+++ b/keyboards/opus/info.json
@ -0,0 +1,59 @@
 {
    "keyboard_name": "opus",
    "maintainer": "rtwayland",
    "layouts": {
        "LAYOUT": {
            "layout": [
                { "label": "Tab", "x": 0, "y": 0.4 },
                { "label": "Q", "x": 1, "y": 0.4 },
                { "label": "W", "x": 2, "y": 0.2 },
                { "label": "E", "x": 3, "y": 0 },
                { "label": "R", "x": 4, "y": 0.4 },
                { "label": "T", "x": 5, "y": 0.5 },

                { "label": "Y", "x": 10, "y": 0.5 },
                { "label": "U", "x": 11, "y": 0.4 },
                { "label": "I", "x": 12, "y": 0 },
                { "label": "O", "x": 13, "y": 0.2 },
                { "label": "P", "x": 14, "y": 0.4 },
                { "label": "Back Space", "x": 15, "y": 0.4 },

                { "label": "Ctrl / Esc", "x": 0, "y": 1.4 },
                { "label": "A", "x": 1, "y": 1.4 },
                { "label": "S", "x": 2, "y": 1.2 },
                { "label": "D", "x": 3, "y": 1 },
                { "label": "F", "x": 4, "y": 1.4 },
                { "label": "G", "x": 5, "y": 1.5 },

                { "label": "H", "x": 10, "y": 1.5 },
                { "label": "J", "x": 11, "y": 1.4 },
                { "label": "K", "x": 12, "y": 1 },
                { "label": "L", "x": 13, "y": 1.2 },
                { "label": ";", "x": 14, "y": 1.4 },
                { "label": "'", "x": 15, "y": 1.4 },

                { "label": "GUI", "x": 0, "y": 2.4 },
                { "label": "Z", "x": 1, "y": 2.4 },
                { "label": "X", "x": 2, "y": 2.2 },
                { "label": "C", "x": 3, "y": 2 },
                { "label": "V", "x": 4, "y": 2.4 },
                { "label": "B", "x": 5, "y": 2.5 },

                { "label": "N", "x": 10, "y": 2.5 },
                { "label": "M", "x": 11, "y": 2.4 },
                { "label": ",", "x": 12, "y": 2 },
                { "label": ".", "x": 13, "y": 2.2 },
                { "label": "/", "x": 14, "y": 2.4 },
                { "label": "Enter", "x": 15, "y": 2.4 },

                { "label": "Lower", "x": 4.8, "y": 3.7 },
                { "label": "Shift", "x": 5.8, "y": 3.5 },
                { "label": "Tab", "x": 6.8, "y": 3.6 },

                { "label": "Enter", "x": 8.2, "y": 3.6 },
                { "label": "Space", "x": 9.2, "y": 3.5 },
                { "label": "Raise", "x": 10.2, "y": 3.7 }
            ]
        }
    }
 }
--- a/keyboards/opus/keymaps/default/keymap.c
+++ b/keyboards/opus/keymaps/default/keymap.c
@ -0,0 +1,51 @@
 /* Copyright 2020 rtwayland
 *
 * 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 layer_names {
  _BASE,
  _SYMBOL,
  _NUM,
  _NAV,
 };

 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  [_BASE] = LAYOUT(
      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, LT(2,KC_F), KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
      KC_LALT, LGUI_T(KC_Z), KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, LGUI_T(KC_SLSH), KC_ENT,
      MO(3), KC_LSFT, LALT_T(KC_TAB), LT(3,KC_ENT), LT(1,KC_SPC), KC_BSPC
     ),
  [_SYMBOL] = LAYOUT(
      LCTL(KC_C), KC_TILD, KC_AT, KC_LCBR, KC_RCBR, KC_HASH, KC_ASTR, KC_CIRC, KC_AMPR, KC_PIPE, KC_BSLS, LCTL(KC_GRV),
      KC_LCTL, KC_GRV, KC_MINS, KC_LPRN, KC_RPRN, KC_EXLM, KC_QUES, KC_DLR, KC_LT, KC_GT, KC_SLSH, KC_DQUO,
      KC_LALT, KC_LGUI, KC_UNDS, KC_LBRC, KC_RBRC, KC_PLUS, KC_P0, KC_EQL, KC_PERC, KC_COLN, KC_NO, KC_NO,
      KC_TRNS, KC_LSFT, KC_NO, KC_TRNS, KC_TRNS, KC_NO
     ),
  [_NUM] = LAYOUT(
      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_ASTR, KC_7, KC_8, KC_9, KC_SLSH, KC_EQL,
      KC_LCTL, KC_NO, KC_NO, KC_NO, KC_TRNS, KC_NO, KC_PLUS, KC_4, KC_5, KC_6, KC_MINS, KC_PERC,
      KC_LALT, KC_LGUI, KC_NO, KC_NO, KC_NO, KC_NO,  KC_0, KC_1, KC_2, KC_3, KC_DOT, KC_PENT,
      KC_NO, KC_NO, KC_NO, KC_NO, KC_SPC, KC_BSPC
     ),
  [_NAV] = LAYOUT(
      KC_NO, KC_NO, LALT(KC_RGHT), SGUI(KC_LBRC), SGUI(KC_RBRC), KC_NO, KC_HOME, KC_PGDN, KC_PGUP, KC_NO, KC_NO, KC_NO,
      KC_NO, KC_LCTL, KC_LALT, KC_LSFT, KC_LGUI, KC_NO, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_NO, KC_NO,
      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, LALT(KC_LEFT), KC_END, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
      KC_TRNS, KC_NO, KC_NO, KC_NO, KC_SPC, KC_BSPC
     )
 };
--- a/keyboards/opus/keymaps/default/readme.md
+++ b/keyboards/opus/keymaps/default/readme.md
@ -0,0 +1,17 @@
 # The default keymap for Opus

 ## Base Layer

 ![opus base layer](https://i.imgur.com/zsmlS96.png)

 ## Symbol Layer

 ![opus symbol layer](https://i.imgur.com/Fu10HBx.jpg)

 ## Num Layer

 ![opus num layer](https://i.imgur.com/1hvYqi0.jpg)

 ## Nav Layer

 ![opus nav layer](https://i.imgur.com/JqOdXhG.jpg)
--- a/keyboards/opus/keymaps/thefoxcodes/config.h
+++ b/keyboards/opus/keymaps/thefoxcodes/config.h
@ -0,0 +1,21 @@
 /* Copyright 2020 rtwayland
 *
 * 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

 // place overrides here
 #define USB_MAX_POWER_CONSUMPTION 100
 #define TAPPING_TERM 200
--- a/keyboards/opus/keymaps/thefoxcodes/keymap.c
+++ b/keyboards/opus/keymaps/thefoxcodes/keymap.c
@ -0,0 +1,94 @@
 /* Copyright 2020 rtwayland
 *
 * 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 layer_names {
  _BASE,
  _SYMBOL,
  _NUM,
  _NAV,
  _MEDIA,
  _WORD,
  _FKEYS,
  _NUMPAD,
  _MOUSE
 };

 enum {
  TD_PLAY_DO_NOT_DISTURB
 };

 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  [_BASE] = LAYOUT(
      LT(4, KC_TAB), KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, TD(TD_PLAY_DO_NOT_DISTURB),
      LCTL_T(KC_ESC), KC_A, KC_S, KC_D, LT(2, KC_F), KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, LT(4, KC_QUOT),
      MO(5), LGUI_T(KC_Z), KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, LGUI_T(KC_SLSH), MO(5),
      MO(3), KC_LSFT, LALT_T(KC_TAB), LT(3, KC_ENT), LT(1, KC_SPC), KC_BSPC
     ),
  [_SYMBOL] = LAYOUT(
      LCTL(KC_C), KC_TILD, KC_AT, KC_LCBR, KC_RCBR, KC_HASH, KC_ASTR, KC_CIRC, KC_AMPR, KC_PIPE, KC_BSLS, LCTL(KC_GRV),
      KC_LCTL, KC_GRV, KC_MINS, KC_LPRN, KC_RPRN, KC_EXLM, KC_QUES, KC_DLR, KC_LT, KC_GT, KC_SLSH, KC_DQUO,
      KC_LALT, KC_LGUI, KC_UNDS, KC_LBRC, KC_RBRC, KC_PLUS, KC_P0, KC_EQL, KC_PERC, KC_COLN, KC_NO, KC_NO,
      KC_NO, KC_LSFT, LALT_T(KC_TAB), KC_NO, KC_TRNS, KC_NO
     ),
  [_NUM] = LAYOUT(
      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_ASTR, KC_7, KC_8, KC_9, KC_SLSH, KC_EQL,
      KC_LCTL, KC_NO, MO(7), MO(6), KC_TRNS, KC_NO, KC_PLUS, KC_4, KC_5, KC_6, KC_MINS, KC_PERC,
      KC_LALT, KC_LGUI, KC_NO, KC_NO, KC_NO, KC_NO,  KC_0, KC_1, KC_2, KC_3, KC_DOT, KC_PENT,
      KC_NO, KC_LSFT, LALT_T(KC_TAB), KC_NO, KC_SPC, KC_BSPC
     ),
  [_NAV] = LAYOUT(
      KC_NO, KC_NO, LALT(KC_RGHT), SGUI(KC_LBRC), SGUI(KC_RBRC), KC_NO, KC_HOME, KC_PGDN, KC_PGUP, KC_NO, KC_NO, KC_NO,
      KC_NO, KC_LCTL, KC_LALT, KC_LSFT, KC_LGUI, KC_NO, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_NO, KC_NO,
      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, LALT(KC_LEFT), KC_END, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
      KC_TRNS, KC_NO, KC_NO, KC_NO, KC_SPC, KC_BSPC
     ),
  [_MEDIA] = LAYOUT(
      KC_TRNS, SGUI(KC_5), SGUI(KC_3), SGUI(KC_4), MEH(KC_4), KC_VOLU, LCA(KC_U), LCAG(KC_LEFT), LCAG(KC_RGHT), LCA(KC_I), LCA(KC_EQL), LALT(LGUI(KC_POWER)),
      KC_CAPS, KC_F11, KC_MPRV, KC_MNXT, KC_MPLY, KC_VOLD, LCA(KC_LEFT), LCA(KC_DOWN), LCA(KC_UP), LCA(KC_RIGHT), LCA(KC_MINS), KC_TRNS,
      KC_BRID, KC_BRIU, LGUI(KC_MINS), LGUI(KC_PLUS), LGUI(KC_GRV), KC_MUTE, LCA(KC_J), LCA(KC_ENT), LCA(KC_C), LCA(KC_K), MEH(KC_UP), RESET,
      LCTL(LSFT(KC_TAB)), LCTL(KC_TAB), KC_NO, KC_NO, MEH(KC_RGHT), MEH(KC_LEFT)
     ),
  [_WORD] = LAYOUT(
      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,  KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
      KC_NO, KC_NO, LALT(LSFT(KC_MINS)), KC_NO, LALT(LGUI(KC_F)), KC_NO,  KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
      KC_TRNS, KC_NO, LALT(KC_MINS), KC_NO, SGUI(LALT(KC_V)),  KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
      KC_NO, KC_NO, KC_NO,  KC_NO, KC_NO, KC_DEL
     ),
  [_FKEYS] = LAYOUT(
      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_F12, KC_F7, KC_F8, KC_F9, KC_F17, KC_F20,
      KC_NO, KC_NO, KC_NO, KC_TRNS, KC_NO, KC_NO, KC_F11, KC_F4, KC_F5, KC_F6, KC_F16, KC_F19,
      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_F10, KC_F1, KC_F2, KC_F3, KC_F13, KC_F18,
      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO
     ),
  [_NUMPAD] = LAYOUT(
      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,  KC_PAST, KC_P7, KC_P8, KC_P9, KC_PSLS, KC_PEQL,
      KC_LCTL, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_PPLS, KC_P4, KC_P5, KC_P6, KC_PMNS, KC_PERC,
      KC_LALT, KC_LGUI, KC_NO, KC_NO, KC_NO, KC_NO,  KC_P0, KC_P1, KC_P2, KC_P3, KC_PDOT, KC_PENT,
      KC_NO, KC_TRNS, KC_NO, KC_NO, KC_LPRN, KC_RPRN
     ),
  [_MOUSE] = LAYOUT(
      KC_NO, KC_NO, KC_NO, SGUI(KC_LBRC), SGUI(KC_RBRC), KC_NO,  KC_HOME, KC_WH_U, KC_WH_D, KC_NO, KC_NO, KC_NO,
      KC_NO, KC_NO, KC_ACL2, KC_WWW_BACK, KC_ACL0, KC_WWW_FORWARD, KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, KC_NO, KC_NO,
      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_END, KC_WH_R, KC_WH_L, KC_NO, KC_NO, KC_NO,
      KC_NO, KC_NO, KC_NO, KC_NO, KC_BTN1, KC_BTN2
     ),
 };

 qk_tap_dance_action_t tap_dance_actions[] = {
  [TD_PLAY_DO_NOT_DISTURB] = ACTION_TAP_DANCE_DOUBLE(KC_MPLY, KC_F6)
 };
--- a/keyboards/opus/keymaps/thefoxcodes/readme.md
+++ b/keyboards/opus/keymaps/thefoxcodes/readme.md
@ -0,0 +1 @@
 # thefoxcodes keymap
--- a/keyboards/opus/keymaps/thefoxcodes/rules.mk
+++ b/keyboards/opus/keymaps/thefoxcodes/rules.mk
@ -0,0 +1 @@
 TAP_DANCE_ENABLE = yes
--- a/keyboards/opus/opus.c
+++ b/keyboards/opus/opus.c
@ -0,0 +1,17 @@
 /* Copyright 2020 rtwayland
 *
 * 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 "opus.h"
--- a/keyboards/opus/opus.h
+++ b/keyboards/opus/opus.h
@ -0,0 +1,39 @@
 /* Copyright 2020 rtwayland
 *
 * 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"

 /* This a shortcut to help you visually see your layout.
 *
 * The first section contains all of the arguments representing the physical
 * layout of the board and position of the keys.
 *
 * The second converts the arguments into a two-dimensional array which
 * represents the switch matrix.
 */
 #define LAYOUT( \
  k00, k01, k02, k03, k04, k05,                  k06, k07, k08, k09, k0a, k0b, \
  k10, k11, k12, k13, k14, k15,                  k16, k17, k18, k19, k1a, k1b, \
  k20, k21, k22, k23, k24, k25,                  k26, k27, k28, k29, k2a, k2b, \
                        k33, k34, k35,     k36, k37, k38 \
 ) \
 { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b }, \
  { KC_NO, KC_NO, KC_NO, k33, k34, k35, k36, k37, k38, KC_NO, KC_NO, KC_NO } \
 }
--- a/keyboards/opus/readme.md
+++ b/keyboards/opus/readme.md
@ -0,0 +1,15 @@
 # Opus

 ![opus](https://i.imgur.com/1jXSUbrl.jpg)

 This is a 40%, non-split, ergonomic, hot-swap keyboard.
 The columns are angled to follow the natural angle of the hand.

 * Keyboard Maintainer: [rtwayland](https://github.com/rtwayland)  
 * Hardware Supported: Pro-micro. Elite-C.

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

    make opus: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).
--- a/keyboards/opus/rules.mk
+++ b/keyboards/opus/rules.mk
@ -0,0 +1,23 @@
 # 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 = 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 = no        # Enable keyboard RGB underglow
 BLUETOOTH_ENABLE = no       # Enable Bluetooth
 AUDIO_ENABLE = no           # Audio output