~ruther/qmk_firmware

784a9cdca4e776150af6b996f8944af89541f2f5 — k.bigwheel 4 years ago 3d01794
[Keyboard] Add earth_rover keyboard (#11405)

* Just ./util/new_keyboard.sh earth_rover

* Update readme.md

* Create key layout

* Setup config.h

* Add default keymap

* Fix pins

* Update flash command

* Write info.json

* Add reset instruction

* Change bootloader setting

* Format new C files

* Empty commit for kicking CI

* Update keyboards/earth_rover/config.h

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

* Update keyboards/earth_rover/keymaps/default/keymap.c

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

* Update readme.md

* Update keyboards/earth_rover/readme.md

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
A keyboards/earth_rover/config.h => keyboards/earth_rover/config.h +114 -0
@@ 0,0 1,114 @@
/*
Copyright 2020 k.bigwheel

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   0xEE11
#define DEVICE_VER   0x0001
#define MANUFACTURER k.bigwheel
#define PRODUCT      earth_rover

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

/*
 * 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 { D4, C6, D7, E6 }
#define MATRIX_COL_PINS { F4, F5, F6, F7 }
#define UNUSED_PINS

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

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

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

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

A keyboards/earth_rover/earth_rover.h => keyboards/earth_rover/earth_rover.h +41 -0
@@ 0,0 1,41 @@
/* Copyright 2020 k.bigwheel
 *
 * 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.
 */
// clang-format off
#define LAYOUT( \
    k00, k01, \
    k10, k12, k13, k14, \
    k20, k22, k23, k24, \
    k30, k32, k33, k34 \
) { \
    { KC_NO, k00, k01, KC_NO }, \
    { k10,   k12, k13, k14   }, \
    { k20,   k22, k23, k24   }, \
    { k30,   k32, k33, k34   }, \
}
// clang-format on

A keyboards/earth_rover/info.json => keyboards/earth_rover/info.json +30 -0
@@ 0,0 1,30 @@
{
    "keyboard_name": "earth_rover",
    "url": "https://github.com/bigwheel/earth_rover",
    "maintainer": "k.bigwheel",
    "width": 4,
    "height": 4,
    "layouts": {
        "LAYOUT": {
            "layout": [
                {"label": "k10", "x": 1.25, "y": 0},
                {"label": "k20", "x": 2.25, "y": 0},

                {"label": "k01", "x": 0, "y": 1.25},
                {"label": "k11", "x": 1.25, "y": 1.25},
                {"label": "k21", "x": 2.25, "y": 1.25},
                {"label": "k31", "x": 3.5, "y": 1.25},

                {"label": "k02", "x": 0, "y": 2.25},
                {"label": "k12", "x": 1.25, "y": 2.25},
                {"label": "k22", "x": 2.25, "y": 2.25},
                {"label": "k32", "x": 3.5, "y": 2.25},

                {"label": "k03", "x": 0, "y": 3.25},
                {"label": "k13", "x": 1.25, "y": 3.25},
                {"label": "k23", "x": 2.25, "y": 3.25},
                {"label": "k33", "x": 3.5, "y": 3.25}
            ]
        }
    }
}

A keyboards/earth_rover/keymaps/default/keymap.c => keyboards/earth_rover/keymaps/default/keymap.c +31 -0
@@ 0,0 1,31 @@
/* Copyright 2020 k.bigwheel
 *
 * 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 };

// clang-format off
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    /* Base */
    [_BASE] = LAYOUT(
              KC_A, KC_B,
        KC_C, KC_D, KC_E, KC_F,
        KC_G, KC_H, KC_I, KC_J,
        KC_K, KC_L, KC_M, KC_N
    )
};
// clang-format on

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

A keyboards/earth_rover/readme.md => keyboards/earth_rover/readme.md +22 -0
@@ 0,0 1,22 @@
# earth_rover

![earth_rover](https://pbs.twimg.com/media/Eqh29nYUUAA-9NE?format=jpg)

Mechanical warm, or just cubic macro pad.

* Keyboard Maintainer: [k.bigwheel](https://github.com/bigwheel)
* Build Guide: [bigwheel/earth\_rover](https://github.com/bigwheel/earth_rover)
* Hardware Supported: [無限の可能性 \| MxLEDBitPCB](https://swanmatch.github.io/MxLEDBitPCB/), Pro Micro
* Hardware Availability: [魔界鍵盤製作所 \- BOOTH](https://swanmatch.booth.pm/), [Pro Micro (コンスルー付き) \| 遊舎工房](https://yushakobo.jp/shop/promicro-spring-pinheader/)

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

    make earth_rover:default

Reset Pro Micro by reset button on ProMicroSocket (Red LED must light).

Flashing example for this keyboard:

    make earth_rover: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/earth_rover/rules.mk => keyboards/earth_rover/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