~ruther/qmk_firmware

8a2d3a8861588646c8563dfde080e49358faa245 — tszaboo 4 years ago 5381943
[Keyboard] Add support for ortho4exent  (#11699)

Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
A keyboards/tszaboo/ortho4exent/config.h => keyboards/tszaboo/ortho4exent/config.h +136 -0
@@ 0,0 1,136 @@
/*
Copyright 2021 tszaboo

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       0x5453 // "TS"
#define PRODUCT_ID      0x7934 // "O4"
#define DEVICE_VER      0x0001
#define MANUFACTURER    tszaboo
#define PRODUCT         ortho4exent

/* key matrix size */
#define MATRIX_ROWS 5
#define MATRIX_COLS 15

/*
 * 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 { B0, B1, D4, D7, B4 }
/*                         0   1   2   3   4   5   6   7   8   9  10  11  12  13  14*/
#define MATRIX_COL_PINS { F0, F1, F4, F5, F6, F7, C7, D6, D5, D3, D2, D1, B7, B3, B2 }
#define UNUSED_PINS
#define LED_CAPS_LOCK_PIN E6

/* COL2ROW, ROW2COL*/
#define DIODE_DIRECTION COL2ROW

/*
 * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
 */
// #define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6

// #define BACKLIGHT_PIN B7
// #define BACKLIGHT_BREATHING
// #define BACKLIGHT_LEVELS 3

 #define RGB_DI_PIN B6
 #ifdef RGB_DI_PIN
   #define RGBLED_NUM 16
   #define RGBLIGHT_HUE_STEP 8
   #define RGBLIGHT_SAT_STEP 8
   #define RGBLIGHT_VAL_STEP 8
   #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
   #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
 /*== all animations enable ==*/
   #define RGBLIGHT_ANIMATIONS
 /*== or choose animations ==*/
//   #define RGBLIGHT_EFFECT_BREATHING
//   #define RGBLIGHT_EFFECT_RAINBOW_MOOD
//   #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
//   #define RGBLIGHT_EFFECT_SNAKE
//   #define RGBLIGHT_EFFECT_KNIGHT
//   #define RGBLIGHT_EFFECT_CHRISTMAS
//   #define RGBLIGHT_EFFECT_STATIC_GRADIENT
//   #define RGBLIGHT_EFFECT_RGB_TEST
//   #define RGBLIGHT_EFFECT_ALTERNATING
 #endif

/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
#define DEBOUNCE 5

/* define if matrix has ghost (lacks anti-ghosting diodes) */
//#define MATRIX_HAS_GHOST

/* number of backlight levels */

/* 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

/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
 * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
 */
// #define GRAVE_ESC_CTRL_OVERRIDE

/*
 * Force NKRO
 *
 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
 * makefile for this to work.)
 *
 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
 * until the next keyboard reset.
 *
 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
 * fully operational during normal computer usage.
 *
 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
 * power-up.
 *
 */
//#define FORCE_NKRO

/* disable print */
//#define NO_PRINT

/* disable action features */
//#define NO_ACTION_LAYER
//#define NO_ACTION_TAPPING
//#define NO_ACTION_ONESHOT

/* disable these deprecated features by default */
#define NO_ACTION_MACRO
#define NO_ACTION_FUNCTION

/* Bootmagic Lite key configuration */
//#define BOOTMAGIC_LITE_ROW 0
//#define BOOTMAGIC_LITE_COLUMN 0

A keyboards/tszaboo/ortho4exent/info.json => keyboards/tszaboo/ortho4exent/info.json +86 -0
@@ 0,0 1,86 @@
{
    "keyboard_name": "Ortho4exent",
    "url": "https://github.com/tszaboo/Ortho4Exent",
    "maintainer": "tszaboo",
    "width": 16,
    "height": 5,
    "layouts": {
      "LAYOUT": {
        "layout": [
			{"label":"k00","x":0,"y":0,"w":1.5},
			{"label":"k01","x":1.5,"y":0},
			{"label":"k02","x":2.5,"y":0},
			{"label":"k03","x":3.5,"y":0},
			{"label":"k04","x":4.5,"y":0},
			{"label":"k05","x":5.5,"y":0},
			{"label":"k06","x":6.5,"y":0},
			{"label":"k07","x":7.5,"y":0},
			{"label":"k08","x":8.5,"y":0},
			{"label":"k09","x":9.5,"y":0},
			{"label":"k0A","x":10.5,"y":0},
			{"label":"k0B","x":11.5,"y":0},
			{"label":"k0C","x":12.5,"y":0},
			{"label":"k0D","x":13.5,"y":0},
			{"label":"k0E","x":14.5,"y":0,"w":1.5},
			{"label":"k10","x":0,"y":1,"w":1.5},
			{"label":"k11","x":1.5,"y":1},
			{"label":"k12","x":2.5,"y":1},
			{"label":"k13","x":3.5,"y":1},
			{"label":"k14","x":4.5,"y":1},
			{"label":"k15","x":5.5,"y":1},
			{"label":"k16","x":6.5,"y":1},
			{"label":"k17","x":7.5,"y":1},
			{"label":"k18","x":8.5,"y":1},
			{"label":"k19","x":9.5,"y":1},
			{"label":"k1A","x":10.5,"y":1},
			{"label":"k1B","x":11.5,"y":1},
			{"label":"k1C","x":12.5,"y":1},
			{"label":"k1D","x":13.5,"y":1},
			{"label":"k1E","x":14.5,"y":1,"w":1.5},
			{"label":"k20","x":0,"y":2},
			{"label":"k21","x":1.5,"y":2},
			{"label":"k22","x":2.5,"y":2},
			{"label":"k23","x":3.5,"y":2},
			{"label":"k24","x":4.5,"y":2},
			{"label":"k25","x":5.5,"y":2},
			{"label":"k26","x":6.5,"y":2},
			{"label":"k27","x":7.5,"y":2},
			{"label":"k28","x":8.5,"y":2},
			{"label":"k29","x":9.5,"y":2},
			{"label":"k2A","x":10.5,"y":2},
			{"label":"k2B","x":11.5,"y":2},
			{"label":"k2C","x":12.5,"y":2},
			{"label":"k2D","x":13.5,"y":2},
			{"label":"k2E","x":14.5,"y":2},
			{"label":"k30","x":0,"y":3,"w":1.5},
			{"label":"k31","x":1.5,"y":3},
			{"label":"k32","x":2.5,"y":3},
			{"label":"k33","x":3.5,"y":3},
			{"label":"k34","x":4.5,"y":3},
			{"label":"k35","x":5.5,"y":3},
			{"label":"k36","x":6.5,"y":3},
			{"label":"k37","x":7.5,"y":3},
			{"label":"k38","x":8.5,"y":3},
			{"label":"k39","x":9.5,"y":3},
			{"label":"k3A","x":10.5,"y":3},
			{"label":"k3B","x":11.5,"y":3},
			{"label":"k3C","x":12.5,"y":3},
			{"label":"k3D","x":13.5,"y":3},
			{"label":"k3E","x":14.5,"y":3,"w":1.5},
			{"label":"k40","x":0,"y":4,"w":1.5},
			{"label":"k41","x":1.5,"y":4,"w":1.5},
			{"label":"k42","x":3,"y":4,"w":1.5},
			{"label":"k43","x":4.5,"y":4,"w":2},
			{"label":"k44","x":6.5,"y":4},
			{"label":"k45","x":7.5,"y":4},
			{"label":"k46","x":8.5,"y":4},
			{"label":"k47","x":9.5,"y":4,"w":2},
			{"label":"k48","x":11.5,"y":4,"w":1.5},
			{"label":"k49","x":13,"y":4,"w":1.5},
			{"label":"k4A","x":14.5,"y":4,"w":1.5}

        ]
      }
    }
  }
  

A keyboards/tszaboo/ortho4exent/keymaps/default/keymap.c => keyboards/tszaboo/ortho4exent/keymaps/default/keymap.c +33 -0
@@ 0,0 1,33 @@
/* Copyright 2021 tszaboo
 *
 * 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
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    [0] = LAYOUT(
		//`        1         2       3       4        5          -      ESC       =         6        7        8       9        0         BSP
        KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_MINS, KC_ESC,  KC_EQL,  KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC,
        KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_LBRC, KC_HOME, KC_RBRC, KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_DEL,
        KC_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_QUOT, KC_END,  KC_BSLS, KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_ENT,  
        KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_PGUP, KC_UP,   KC_PGDN, KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_LSFT,
        KC_LCTL, KC_LGUI, KC_LALT, KC_SPC,  KC_LEFT, KC_DOWN, KC_RGHT, KC_SPC,  KC_RALT, KC_RCTL, MO(1)
    ),
    [1] = LAYOUT(
        KC_TRNS, KC_F1  , KC_F2  , KC_F3  , KC_F4  , KC_F5  , KC_TRNS, KC_TRNS, KC_TRNS, KC_F6  , KC_F7  , KC_F8  , KC_F9  , KC_F10 , KC_TRNS,
        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, RESET,   KC_TRNS,
        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
        KC_TRNS, RGB_TOG, RGB_MOD, RGB_M_P, RGB_M_G, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS
    )
};

A keyboards/tszaboo/ortho4exent/keymaps/default/readme.md => keyboards/tszaboo/ortho4exent/keymaps/default/readme.md +1 -0
@@ 0,0 1,1 @@
# The default keymap for Ortho4exent

A keyboards/tszaboo/ortho4exent/ortho4exent.c => keyboards/tszaboo/ortho4exent/ortho4exent.c +16 -0
@@ 0,0 1,16 @@
/* Copyright 2021 tszaboo
 *
 * 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 "ortho4exent.h"

A keyboards/tszaboo/ortho4exent/ortho4exent.h => keyboards/tszaboo/ortho4exent/ortho4exent.h +41 -0
@@ 0,0 1,41 @@
/* Copyright 2021 tszaboo
 *
 * 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, k0C, k0D, k0E,\
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D, k1E,\
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k2D, k2E,\
    k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, k3C, k3D, k3E,\
    k40, k41, k42, k43, k44, k45, k46, k47, k48, k49, k4A                     \
) \
{ \
    { k00, k01,   k02, k03, k04,   k05, k06, k07, k08,   k09,   k0A, k0B,   k0C, k0D, k0E }, \
    { k10, k11,   k12, k13, k14,   k15, k16, k17, k18,   k19,   k1A, k1B,   k1C, k1D, k1E }, \
    { k20, k21,   k22, k23, k24,   k25, k26, k27, k28,   k29,   k2A, k2B,   k2C, k2D, k2E }, \
    { k30, k31,   k32, k33, k34,   k35, k36, k37, k38,   k39,   k3A, k3B,   k3C, k3D, k3E }, \
    { k40, k41, KC_NO, k42, k43, KC_NO, k44, k45, k46,   k47, KC_NO, k48, KC_NO, k49, k4A }, \
}

A keyboards/tszaboo/ortho4exent/readme.md => keyboards/tszaboo/ortho4exent/readme.md +15 -0
@@ 0,0 1,15 @@
# tszaboo

Ortholinear PCB that is a drop-in replacement for Exent keyboard.
Layout is inspired by excellent Boardwalk PCB, but extended with an extra column to accommodate the 65% Exent form factor.

* Keyboard Maintainer: [tszaboo](https://github.com/tszaboo/)
* Keyboard Product owner: [Riba]
* Hardware Supported: Ortho4exent
* Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=110120.0)

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

    make tszaboo/ortho4exent: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/tszaboo/ortho4exent/rules.mk => keyboards/tszaboo/ortho4exent/rules.mk +23 -0
@@ 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 = no        # 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 = yes       # Enable keyboard RGB underglow
BLUETOOTH_ENABLE = no       # Enable Bluetooth
AUDIO_ENABLE = no           # Audio output
LTO_ENABLE = yes