~ruther/qmk_firmware

42ac7c0541b2a9c2f38f6c2aac6d05163dec4a37 — StefanGrindelwald 4 years ago 8c52670
[Keyboard] Add Momoka ergo (#13127)

Co-authored-by: precondition <57645186+precondition@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
A keyboards/momoka_ergo/config.h => keyboards/momoka_ergo/config.h +131 -0
@@ 0,0 1,131 @@
/*
Copyright 2021 StefanGrindelwald

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    0xFEED
#define PRODUCT_ID   0x0000
#define DEVICE_VER   0x0001
#define MANUFACTURER StefanGrindelwald
#define PRODUCT      Momoka Ergo

/* key matrix size */
#define MATRIX_ROWS 14
#define MATRIX_COLS 6

/*
 * 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 { C6, D7, E6, B4, B5, B6, B7 }
#define MATRIX_COL_PINS { F7, F6, F5, F4, F1, F0 }
#define UNUSED_PINS

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

#define RGB_DI_PIN C7
#define RGBLIGHT_ANIMATIONS
#define RGBLED_NUM 22
#define RGBLED_SPLIT { 11, 11 }
#define RGBLIGHT_HUE_STEP 8
#define RGBLIGHT_SAT_STEP 8
#define RGBLIGHT_VAL_STEP 8

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

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

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

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

/* 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	
#define BOOTMAGIC_KEY_SALT     KC_RSFT||KC_LSFT
#define BOOTMAGIC_KEY_SKIP 	KC_ESC
#define BOOTMAGIC_KEY_EEPROM_CLEAR 	KC_NO
#define OOTMAGIC_KEY_BOOTLOADER 	KC_RCTL||KC_LCTL
#define BOOTMAGIC_KEY_EE_HANDS_LEFT 	KC_T
#define BOOTMAGIC_KEY_EE_HANDS_RIGHT 	KC_Y
#define USE_SERIAL
#define SPLIT_USB_DETECT
#define EE_HANDS

A keyboards/momoka_ergo/info.json => keyboards/momoka_ergo/info.json +82 -0
@@ 0,0 1,82 @@
{
    "keyboard_name": "MOMOKA_ERGO", 
    "url": "", 
    "maintainer": "StefanGrindelwald", 
    "width": 19.5, 
    "height": 9.375, 
    "layouts": {
        "LAYOUT": {
            "layout": [
			{"label":"L02", "x":3.5, "y":0},
			{"label":"R03", "x":15, "y":0},
			{"label":"L03", "x":2.5, "y":0.125},
			{"label":"L01", "x":4.5, "y":0.125},
			{"label":"R04", "x":14, "y":0.125}, 
			{"label":"R02", "x":16, "y":0.125}, 
			{"label":"L00", "x":5.5, "y":0.25}, 
			{"label":"R05", "x":13, "y":0.25}, 
			{"label":"L05", "x":0, "y":0.375, "w":1.5}, 
			{"label":"L04", "x":1.5, "y":0.375}, 
			{"label":"R01", "x":17, "y":0.375}, 
			{"label":"R00", "x":18, "y":0.375, "w":1.5}, 
			{"label":"L12", "x":3.5, "y":1}, 
			{"label":"R13", "x":15, "y":1}, 
			{"label":"L13", "x":2.5, "y":1.125}, 
			{"label":"L11", "x":4.5, "y":1.125}, 
			{"label":"R14", "x":14, "y":1.125}, 
			{"label":"R12", "x":16, "y":1.125}, 
			{"label":"L10", "x":5.5, "y":1.25},
			{"label":"R15", "x":13, "y":1.25}, 
			{"label":"L15", "x":0, "y":1.375, "w":1.5}, 
			{"label":"L14", "x":1.5, "y":1.375}, 
			{"label":"R11", "x":17, "y":1.375}, 
			{"label":"R10", "x":18, "y":1.375, "w":1.5}, 
			{"label":"L22", "x":3.5, "y":2}, 
			{"label":"R23", "x":15, "y":2}, 
			{"label":"L23", "x":2.5, "y":2.125}, 
			{"label":"L21", "x":4.5, "y":2.125}, 
			{"label":"R24", "x":14, "y":2.125}, 
			{"label":"R22", "x":16, "y":2.125}, 
			{"label":"L20", "x":5.5, "y":2.25}, 
			{"label":"R25", "x":13, "y":2.25}, 
			{"label":"L25", "x":0, "y":2.375, "w":1.5},
			{"label":"L24", "x":1.5, "y":2.375},
			{"label":"R21", "x":17, "y":2.375},
			{"label":"R20", "x":18, "y":2.375, "w":1.5},
			{"label":"L32", "x":3.5, "y":3},
			{"label":"R33", "x":15, "y":3},
			{"label":"L33", "x":2.5, "y":3.125},
			{"label":"L31", "x":4.5, "y":3.125},
			{"label":"R34", "x":14, "y":3.125},
			{"label":"R32", "x":16, "y":3.125},
			{"label":"L30", "x":5.5, "y":3.25}, 
			{"label":"R35", "x":13, "y":3.25}, 
			{"label":"L35", "x":0, "y":3.375, "w":1.5}, 
			{"label":"L34", "x":1.5, "y":3.375}, 
			{"label":"R31", "x":17, "y":3.375}, 
			{"label":"R30", "x":18, "y":3.375, "w":1.5}, 
			{"label":"L42", "x":3.5, "y":4}, 
			{"label":"R43", "x":15, "y":4}, 
			{"label":"L43", "x":2.5, "y":4.125}, 
			{"label":"L41", "x":4.5, "y":4.125}, 
			{"label":"R44", "x":14, "y":4.125}, 
			{"label":"R42", "x":16, "y":4.125}, 
			{"label":"L45", "x":0.5, "y":4.375}, 
			{"label":"L44", "x":1.5, "y":4.375},
			{"label":"R41", "x":17, "y":4.375},
			{"label":"R40", "x":18, "y":4.375},
			{"label":"L51", "x":1, "y":4.375},
			{"label":"L40", "x":2, "y":4.375}, 
			{"label":"L52", "x":0, "y":5.375, "h":2}, 
			{"label":"L61", "x":1, "y":5.375, "h":2}, 
			{"label":"L50", "x":2, "y":5.375}, 
			{"label":"L60", "x":2, "y":6.375}, 
			{"label":"R45", "x":-3.0, "y":6.375}, 
			{"label":"R54", "x":-2, "y":6.375}, 
			{"label":"R55", "x":-3.0, "y":7.375}, 
			{"label":"R64", "x":-2, "y":7.375, "h":2}, 
			{"label":"R53", "x":-1.0, "y":7.375, "h":2}, 
			{"label":"R65", "x":-3.0, "y":8.375}]
        }
    }
}

A keyboards/momoka_ergo/keymaps/default/keymap.c => keyboards/momoka_ergo/keymaps/default/keymap.c +55 -0
@@ 0,0 1,55 @@
/* Copyright 2021 StefanGrindelwald
 *
 * 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

// Defines names for use in layer keycodes and the keymap
enum layer_names {
    _BASE,
    _FN1,
    _FN2
};

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    /* Base */
    [_BASE] = LAYOUT(
        KC_ESC,    KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS,
        KC_TAB,    KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSLS,
        KC_CAPS,   KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
        KC_LSFT,   KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,
        MO(_FN1),   KC_GRV,  KC_EQL,  KC_LEFT, KC_RGHT, KC_LALT, KC_RGUI, KC_UP,   KC_DOWN, KC_LBRC, KC_RBRC, MO(_FN1),
                                     KC_BSPC, KC_LCTL, KC_HOME, KC_PGUP, KC_RCTL, KC_SPC,
                                              KC_DEL,  KC_END,  KC_PGDN, KC_ENT
    ),
    [_FN1] = LAYOUT(
        KC_F1,     KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,
        _______,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
        _______,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
        MO(_FN2),  _______, _______, _______, _______, _______, _______, _______, RGB_RMOD,RGB_MOD, RGB_TOG, MO(_FN2),
        _______,   _______, KC_MUTE, KC_VOLD, KC_VOLU, _______, _______, RGB_VAI, RGB_VAD, RGB_SAI, RGB_SAD, _______,
                                     _______, _______, _______, RGB_HUI, _______, _______,
                                              _______, _______, RGB_HUD, _______
    ),
    [_FN2] = LAYOUT(
        KC_F1,     KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,
        _______,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
        _______,   _______, _______, RESET,   _______, _______, _______, _______, RESET,   _______, _______, _______,
        _______,   _______, _______, _______, _______, _______, _______, _______, RGB_RMOD,RGB_MOD, RGB_TOG, _______, 
        _______,   _______, KC_MUTE, KC_VOLD, KC_VOLU, _______, _______, RGB_VAI, RGB_VAD, RGB_SAI, RGB_SAD, _______,
                                     _______, _______, _______, RGB_HUI, _______, _______,
                                              _______, _______, RGB_HUD, _______
    )
    
};

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

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

A keyboards/momoka_ergo/momoka_ergo.h => keyboards/momoka_ergo/momoka_ergo.h +53 -0
@@ 0,0 1,53 @@
/* Copyright 2021 StefanGrindelwald
 *
 * 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 is 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( \
	L05, L04, L03, L02, L01, L00, R05, R04, R03, R02, R01, R00, \
	L15, L14, L13, L12, L11, L10, R15, R14, R13, R12, R11, R10, \
	L25, L24, L23, L22, L21, L20, R25, R24, R23, R22, R21, R20, \
	L35, L34, L33, L32, L31, L30, R35, R34, R33, R32, R31, R30, \
	L45, L44, L43, L42, L41, L40, R45, R44, R43, R42, R41, R40, \
	L52, L51, L50, R55, R54, R53, \
	L61, L60, R65, R64 \
	) \
	{ \
		{ L00, L01, L02, L03, L04, L05 }, \
		{ L10, L11, L12, L13, L14, L15 }, \
		{ L20, L21, L22, L23, L24, L25 }, \
		{ L30, L31, L32, L33, L34, L35 }, \
		{ L40, L41, L42, L43, L44, L45 },\
		{ L50, L51, L52, KC_NO,KC_NO,KC_NO },\
		{ L60, L61,KC_NO,KC_NO,KC_NO,KC_NO },\
		{ R05, R04, R03, R02, R01, R00 }, \
		{ R15, R14, R13, R12, R11, R10 }, \
		{ R25, R24, R23, R22, R21, R20 }, \
		{ R35, R34, R33, R32, R31, R30 }, \
		{ R45, R44, R43, R42, R41, R40 },\
		{ R55, R54, R53, KC_NO, KC_NO, KC_NO }, \
		{ R65, R64, KC_NO, KC_NO, KC_NO, KC_NO } \
	}

A keyboards/momoka_ergo/readme.md => keyboards/momoka_ergo/readme.md +29 -0
@@ 0,0 1,29 @@
# momoka_ergo

![momoka_ergo](https://github.com/StefanGrindelwald/TestDemo/blob/master/Momoka_ergo.jpg?raw=true)

The MOMOKA Ergo is a split keyboard that is based on the Ergodox standard layout. It has 35 keys and 11 RGB backlights on each part. The two parts of the keyboard is connected by a TRRS cable.

* Keyboard Maintainer: [StefanGrindelwald](https://github.com/StefanGrindelwald)
* Hardware Supported: momoka.co/ergo
* Hardware Availability: momoka.co/ergo

Bootloader:

With the default keymap, you can easily use FN+Shift+D to enter the bootloader in left side and FN+shift+K in right side. Or you can just use the microswitch in the PCB.

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

    make momoka_ergo:default

Flashing example for this keyboard(Note that you need flash the both side keyboard respectively):

For the left side:

    make momoka_ergo:default:dfu-split-left

For the right side:

    make momoka_ergo:default:dfu-split-right
    
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/momoka_ergo/rules.mk => keyboards/momoka_ergo/rules.mk +23 -0
@@ 0,0 1,23 @@
# MCU name
MCU = atmega32u4

# Bootloader selection
BOOTLOADER = atmel-dfu

# Build Options
#   change yes to no to disable
#
BOOTMAGIC_ENABLE = full     # Virtual DIP switch configuration
MOUSEKEY_ENABLE = no        # 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 = yes        # Enable keyboard RGB underglow
BLUETOOTH_ENABLE = no       # Enable Bluetooth
AUDIO_ENABLE = no           # Audio output
SPLIT_KEYBOARD = yes