~ruther/qmk_firmware

fe5bcae8b31af85135592b780c8d799a8ef4bd24 — EMajesty 4 years ago cba4c1d
[Keyboard] New keyboard - eiri (#10529)

* eiri default keymap compiles

* pic, info.json

* Added picture for default layout, changed PRODUCT_ID

* Changes to default keymap

* Cleaned unused template remnants from files

* Update keyboards/emajesty/eiri/readme.md

Co-authored-by: Drashna Jaelre <drashna@live.com>

Co-authored-by: EMajesty <deceit66@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
A keyboards/emajesty/eiri/config.h => keyboards/emajesty/eiri/config.h +96 -0
@@ 0,0 1,96 @@
/*
Copyright 2020 EMajesty

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   0x9372
#define DEVICE_VER   0x0001
#define MANUFACTURER EMajesty
#define PRODUCT      eiri

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

/*
 * 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 { B4, B5, B2, B6 }
#define MATRIX_COL_PINS { D1, D0, D4, C6, D7, E6, B3, B1, F7, F6, F5, F4 }
#define UNUSED_PINS

/* COL2ROW, ROW2COL */
#define DIODE_DIRECTION COL2ROW

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

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

A keyboards/emajesty/eiri/eiri.c => keyboards/emajesty/eiri/eiri.c +17 -0
@@ 0,0 1,17 @@
/* Copyright 2020 EMajesty
 *
 * 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 "eiri.h"

A keyboards/emajesty/eiri/eiri.h => keyboards/emajesty/eiri/eiri.h +40 -0
@@ 0,0 1,40 @@
/* Copyright 2020 EMajesty
 *
 * 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( \
    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,               K30, K31, K32, K33, K34, K35, \
              K36, K37, K38, K39, K40,     K41, K42, K43, K44, K45 \
) { \
    { 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, K30, K31, K32, K33, K34, K35   }, \
    { KC_NO, K36, K37, K38, K39, K40, K41, K42, K43, K44, K45, KC_NO } \
}


A keyboards/emajesty/eiri/info.json => keyboards/emajesty/eiri/info.json +12 -0
@@ 0,0 1,12 @@
{
    "keyboard_name": "eiri",
    "url": "https://github.com/EMajesty/eiri",
    "maintainer": "EMajesty",
    "width": 15,
    "height": 4.5,
    "layouts": {
        "LAYOUT": {
            "layout": [{"x":3, "y":0}, {"x":11, "y":0}, {"x":2, "y":0.25}, {"x":4, "y":0.25}, {"x":10, "y":0.25}, {"x":12, "y":0.25}, {"x":1, "y":0.5}, {"x":5, "y":0.5}, {"x":9, "y":0.5}, {"x":13, "y":0.5}, {"x":0, "y":0.75}, {"x":14, "y":0.75}, {"x":3, "y":1}, {"x":11, "y":1}, {"x":2, "y":1.25}, {"x":4, "y":1.25}, {"x":10, "y":1.25}, {"x":12, "y":1.25}, {"x":1, "y":1.5}, {"x":5, "y":1.5}, {"x":9, "y":1.5}, {"x":13, "y":1.5}, {"x":0, "y":1.75}, {"x":14, "y":1.75}, {"x":3, "y":2}, {"x":11, "y":2}, {"x":2, "y":2.25}, {"x":4, "y":2.25}, {"x":10, "y":2.25}, {"x":12, "y":2.25}, {"x":1, "y":2.5}, {"x":5, "y":2.5}, {"x":9, "y":2.5}, {"x":13, "y":2.5}, {"x":0, "y":2.75}, {"x":14, "y":2.75}, {"x":3, "y":3}, {"x":11, "y":3}, {"x":2, "y":3.25}, {"x":4, "y":3.25}, {"x":10, "y":3.25}, {"x":12, "y":3.25}, {"x":5, "y":3.5}, {"x":6, "y":3.5}, {"x":8, "y":3.5}, {"x":9, "y":3.5}]
        }
    }
}

A keyboards/emajesty/eiri/keymaps/default/keymap.c => keyboards/emajesty/eiri/keymaps/default/keymap.c +34 -0
@@ 0,0 1,34 @@
/* Copyright 2020 EMajesty
 *
 * 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(
        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_LCTL, 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,
                          KC_LGUI, KC_LALT, KC_SPC,  KC_DEL,  MO(1),        MO(2),   KC_ENT, KC_BSPC, KC_RALT, KC_RGUI),
    [1] = LAYOUT(
        KC_ESC,  _______, KC_UP,   _______, KC_HOME, KC_PGUP,                        _______, _______, _______, KC_LPRN, KC_RPRN, KC_GRV,
        _______, KC_LEFT, KC_DOWN, KC_RGHT, KC_END,  KC_PGDN,                        _______, KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, _______,
        _______, KC_MPRV, KC_MPLY, KC_MNXT, _______, _______,                        _______, _______, _______, KC_LCBR, KC_RCBR, _______,
                          _______, _______, _______, _______, _______,      _______, _______, _______, _______, _______),
    [2] = LAYOUT(
        RESET,   KC_1,    KC_2,    KC_3,    KC_4,    KC_5,                           KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    _______,
        _______, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC,                        KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, _______,
        KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,                          KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,
                          _______, _______, _______, _______, _______,      _______, _______, _______, _______, _______)
};

A keyboards/emajesty/eiri/keymaps/default/readme.md => keyboards/emajesty/eiri/keymaps/default/readme.md +3 -0
@@ 0,0 1,3 @@
![default keymap](https://imgur.com/F3L3z8w.png)

# The default keymap for eiri

A keyboards/emajesty/eiri/readme.md => keyboards/emajesty/eiri/readme.md +19 -0
@@ 0,0 1,19 @@
# eiri

![eiri](https://imgur.com/ZiLTj3Pl.png)

An Atreus-inspired 40% keyboard with 6 columns

* Keyboard Maintainer: [EMajesty](https://github.com/EMajesty)
* Hardware Supported: eiri pcb
* Hardware Availability: [Project is open source](https://github.com/EMajesty/eiri)

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

    make emajesty/eiri:default

Flashing example for this keyboard:

    make emajesty/eiri:default:flash

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/emajesty/eiri/rules.mk => keyboards/emajesty/eiri/rules.mk +22 -0
@@ 0,0 1,22 @@
# 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