diff options
| author | k.bigwheel <k.bigwheel+eng@gmail.com> | 2021-02-08 01:56:27 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-07 08:56:27 -0800 |
| commit | 784a9cdca4e776150af6b996f8944af89541f2f5 (patch) | |
| tree | 8567b65c6b21b47bb3719569630de1702fe2b6b7 | |
| parent | 3d01794b12a895b1678c51b5aea46a0def5fca3f (diff) | |
| download | qmk_firmware-784a9cdca4e776150af6b996f8944af89541f2f5.tar.gz qmk_firmware-784a9cdca4e776150af6b996f8944af89541f2f5.zip | |
[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>
| -rw-r--r-- | keyboards/earth_rover/config.h | 114 | ||||
| -rw-r--r-- | keyboards/earth_rover/earth_rover.c | 17 | ||||
| -rw-r--r-- | keyboards/earth_rover/earth_rover.h | 41 | ||||
| -rw-r--r-- | keyboards/earth_rover/info.json | 30 | ||||
| -rw-r--r-- | keyboards/earth_rover/keymaps/default/keymap.c | 31 | ||||
| -rw-r--r-- | keyboards/earth_rover/keymaps/default/readme.md | 1 | ||||
| -rw-r--r-- | keyboards/earth_rover/readme.md | 22 | ||||
| -rw-r--r-- | keyboards/earth_rover/rules.mk | 22 |
8 files changed, 278 insertions, 0 deletions
diff --git a/keyboards/earth_rover/config.h b/keyboards/earth_rover/config.h new file mode 100644 index 000000000..6e958f138 --- /dev/null +++ b/keyboards/earth_rover/config.h | |||
| @@ -0,0 +1,114 @@ | |||
| 1 | /* | ||
| 2 | Copyright 2020 k.bigwheel | ||
| 3 | |||
| 4 | This program is free software: you can redistribute it and/or modify | ||
| 5 | it under the terms of the GNU General Public License as published by | ||
| 6 | the Free Software Foundation, either version 2 of the License, or | ||
| 7 | (at your option) any later version. | ||
| 8 | |||
| 9 | This program is distributed in the hope that it will be useful, | ||
| 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 12 | GNU General Public License for more details. | ||
| 13 | |||
| 14 | You should have received a copy of the GNU General Public License | ||
| 15 | along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| 16 | */ | ||
| 17 | |||
| 18 | #pragma once | ||
| 19 | |||
| 20 | #include "config_common.h" | ||
| 21 | |||
| 22 | /* USB Device descriptor parameter */ | ||
| 23 | #define VENDOR_ID 0xFEED | ||
| 24 | #define PRODUCT_ID 0xEE11 | ||
| 25 | #define DEVICE_VER 0x0001 | ||
| 26 | #define MANUFACTURER k.bigwheel | ||
| 27 | #define PRODUCT earth_rover | ||
| 28 | |||
| 29 | /* key matrix size */ | ||
| 30 | #define MATRIX_ROWS 4 | ||
| 31 | #define MATRIX_COLS 4 | ||
| 32 | |||
| 33 | /* | ||
| 34 | * Keyboard Matrix Assignments | ||
| 35 | * | ||
| 36 | * Change this to how you wired your keyboard | ||
| 37 | * COLS: AVR pins used for columns, left to right | ||
| 38 | * ROWS: AVR pins used for rows, top to bottom | ||
| 39 | * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode) | ||
| 40 | * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode) | ||
| 41 | * | ||
| 42 | */ | ||
| 43 | #define MATRIX_ROW_PINS { D4, C6, D7, E6 } | ||
| 44 | #define MATRIX_COL_PINS { F4, F5, F6, F7 } | ||
| 45 | #define UNUSED_PINS | ||
| 46 | |||
| 47 | /* COL2ROW, ROW2COL */ | ||
| 48 | #define DIODE_DIRECTION COL2ROW | ||
| 49 | |||
| 50 | /* | ||
| 51 | * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN. | ||
| 52 | */ | ||
| 53 | #define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6 | ||
| 54 | |||
| 55 | /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */ | ||
| 56 | #define DEBOUNCE 5 | ||
| 57 | |||
| 58 | /* define if matrix has ghost (lacks anti-ghosting diodes) */ | ||
| 59 | //#define MATRIX_HAS_GHOST | ||
| 60 | |||
| 61 | /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */ | ||
| 62 | #define LOCKING_SUPPORT_ENABLE | ||
| 63 | /* Locking resynchronize hack */ | ||
| 64 | #define LOCKING_RESYNC_ENABLE | ||
| 65 | |||
| 66 | /* If defined, GRAVE_ESC will always act as ESC when CTRL is held. | ||
| 67 | * This is useful for the Windows task manager shortcut (ctrl+shift+esc). | ||
| 68 | */ | ||
| 69 | //#define GRAVE_ESC_CTRL_OVERRIDE | ||
| 70 | |||
| 71 | /* | ||
| 72 | * Force NKRO | ||
| 73 | * | ||
| 74 | * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved | ||
| 75 | * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the | ||
| 76 | * makefile for this to work.) | ||
| 77 | * | ||
| 78 | * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N) | ||
| 79 | * until the next keyboard reset. | ||
| 80 | * | ||
| 81 | * NKRO may prevent your keystrokes from being detected in the BIOS, but it is | ||
| 82 | * fully operational during normal computer usage. | ||
| 83 | * | ||
| 84 | * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N) | ||
| 85 | * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by | ||
| 86 | * bootmagic, NKRO mode will always be enabled until it is toggled again during a | ||
| 87 | * power-up. | ||
| 88 | * | ||
| 89 | */ | ||
| 90 | //#define FORCE_NKRO | ||
| 91 | |||
| 92 | /* | ||
| 93 | * Feature disable options | ||
| 94 | * These options are also useful to firmware size reduction. | ||
| 95 | */ | ||
| 96 | |||
| 97 | /* disable debug print */ | ||
| 98 | //#define NO_DEBUG | ||
| 99 | |||
| 100 | /* disable print */ | ||
| 101 | //#define NO_PRINT | ||
| 102 | |||
| 103 | /* disable action features */ | ||
| 104 | //#define NO_ACTION_LAYER | ||
| 105 | //#define NO_ACTION_TAPPING | ||
| 106 | //#define NO_ACTION_ONESHOT | ||
| 107 | |||
| 108 | /* disable these deprecated features by default */ | ||
| 109 | #define NO_ACTION_MACRO | ||
| 110 | #define NO_ACTION_FUNCTION | ||
| 111 | |||
| 112 | /* Bootmagic Lite key configuration */ | ||
| 113 | //#define BOOTMAGIC_LITE_ROW 0 | ||
| 114 | //#define BOOTMAGIC_LITE_COLUMN 0 | ||
diff --git a/keyboards/earth_rover/earth_rover.c b/keyboards/earth_rover/earth_rover.c new file mode 100644 index 000000000..c12eaa8c0 --- /dev/null +++ b/keyboards/earth_rover/earth_rover.c | |||
| @@ -0,0 +1,17 @@ | |||
| 1 | /* Copyright 2020 k.bigwheel | ||
| 2 | * | ||
| 3 | * This program is free software: you can redistribute it and/or modify | ||
| 4 | * it under the terms of the GNU General Public License as published by | ||
| 5 | * the Free Software Foundation, either version 2 of the License, or | ||
| 6 | * (at your option) any later version. | ||
| 7 | * | ||
| 8 | * This program is distributed in the hope that it will be useful, | ||
| 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 11 | * GNU General Public License for more details. | ||
| 12 | * | ||
| 13 | * You should have received a copy of the GNU General Public License | ||
| 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| 15 | */ | ||
| 16 | |||
| 17 | #include "earth_rover.h" | ||
diff --git a/keyboards/earth_rover/earth_rover.h b/keyboards/earth_rover/earth_rover.h new file mode 100644 index 000000000..a0676beeb --- /dev/null +++ b/keyboards/earth_rover/earth_rover.h | |||
| @@ -0,0 +1,41 @@ | |||
| 1 | /* Copyright 2020 k.bigwheel | ||
| 2 | * | ||
| 3 | * This program is free software: you can redistribute it and/or modify | ||
| 4 | * it under the terms of the GNU General Public License as published by | ||
| 5 | * the Free Software Foundation, either version 2 of the License, or | ||
| 6 | * (at your option) any later version. | ||
| 7 | * | ||
| 8 | * This program is distributed in the hope that it will be useful, | ||
| 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 11 | * GNU General Public License for more details. | ||
| 12 | * | ||
| 13 | * You should have received a copy of the GNU General Public License | ||
| 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| 15 | */ | ||
| 16 | |||
| 17 | #pragma once | ||
| 18 | |||
| 19 | #include "quantum.h" | ||
| 20 | |||
| 21 | /* This is a shortcut to help you visually see your layout. | ||
| 22 | * | ||
| 23 | * The first section contains all of the arguments representing the physical | ||
| 24 | * layout of the board and position of the keys. | ||
| 25 | * | ||
| 26 | * The second converts the arguments into a two-dimensional array which | ||
| 27 | * represents the switch matrix. | ||
| 28 | */ | ||
| 29 | // clang-format off | ||
| 30 | #define LAYOUT( \ | ||
| 31 | k00, k01, \ | ||
| 32 | k10, k12, k13, k14, \ | ||
| 33 | k20, k22, k23, k24, \ | ||
| 34 | k30, k32, k33, k34 \ | ||
| 35 | ) { \ | ||
| 36 | { KC_NO, k00, k01, KC_NO }, \ | ||
| 37 | { k10, k12, k13, k14 }, \ | ||
| 38 | { k20, k22, k23, k24 }, \ | ||
| 39 | { k30, k32, k33, k34 }, \ | ||
| 40 | } | ||
| 41 | // clang-format on | ||
diff --git a/keyboards/earth_rover/info.json b/keyboards/earth_rover/info.json new file mode 100644 index 000000000..3cfc28285 --- /dev/null +++ b/keyboards/earth_rover/info.json | |||
| @@ -0,0 +1,30 @@ | |||
| 1 | { | ||
| 2 | "keyboard_name": "earth_rover", | ||
| 3 | "url": "https://github.com/bigwheel/earth_rover", | ||
| 4 | "maintainer": "k.bigwheel", | ||
| 5 | "width": 4, | ||
| 6 | "height": 4, | ||
| 7 | "layouts": { | ||
| 8 | "LAYOUT": { | ||
| 9 | "layout": [ | ||
| 10 | {"label": "k10", "x": 1.25, "y": 0}, | ||
| 11 | {"label": "k20", "x": 2.25, "y": 0}, | ||
| 12 | |||
| 13 | {"label": "k01", "x": 0, "y": 1.25}, | ||
| 14 | {"label": "k11", "x": 1.25, "y": 1.25}, | ||
| 15 | {"label": "k21", "x": 2.25, "y": 1.25}, | ||
| 16 | {"label": "k31", "x": 3.5, "y": 1.25}, | ||
| 17 | |||
| 18 | {"label": "k02", "x": 0, "y": 2.25}, | ||
| 19 | {"label": "k12", "x": 1.25, "y": 2.25}, | ||
| 20 | {"label": "k22", "x": 2.25, "y": 2.25}, | ||
| 21 | {"label": "k32", "x": 3.5, "y": 2.25}, | ||
| 22 | |||
| 23 | {"label": "k03", "x": 0, "y": 3.25}, | ||
| 24 | {"label": "k13", "x": 1.25, "y": 3.25}, | ||
| 25 | {"label": "k23", "x": 2.25, "y": 3.25}, | ||
| 26 | {"label": "k33", "x": 3.5, "y": 3.25} | ||
| 27 | ] | ||
| 28 | } | ||
| 29 | } | ||
| 30 | } | ||
diff --git a/keyboards/earth_rover/keymaps/default/keymap.c b/keyboards/earth_rover/keymaps/default/keymap.c new file mode 100644 index 000000000..be97773d5 --- /dev/null +++ b/keyboards/earth_rover/keymaps/default/keymap.c | |||
| @@ -0,0 +1,31 @@ | |||
| 1 | /* Copyright 2020 k.bigwheel | ||
| 2 | * | ||
| 3 | * This program is free software: you can redistribute it and/or modify | ||
| 4 | * it under the terms of the GNU General Public License as published by | ||
| 5 | * the Free Software Foundation, either version 2 of the License, or | ||
| 6 | * (at your option) any later version. | ||
| 7 | * | ||
| 8 | * This program is distributed in the hope that it will be useful, | ||
| 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 11 | * GNU General Public License for more details. | ||
| 12 | * | ||
| 13 | * You should have received a copy of the GNU General Public License | ||
| 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| 15 | */ | ||
| 16 | #include QMK_KEYBOARD_H | ||
| 17 | |||
| 18 | // Defines names for use in layer keycodes and the keymap | ||
| 19 | enum layer_names { _BASE }; | ||
| 20 | |||
| 21 | // clang-format off | ||
| 22 | const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | ||
| 23 | /* Base */ | ||
| 24 | [_BASE] = LAYOUT( | ||
| 25 | KC_A, KC_B, | ||
| 26 | KC_C, KC_D, KC_E, KC_F, | ||
| 27 | KC_G, KC_H, KC_I, KC_J, | ||
| 28 | KC_K, KC_L, KC_M, KC_N | ||
| 29 | ) | ||
| 30 | }; | ||
| 31 | // clang-format on | ||
diff --git a/keyboards/earth_rover/keymaps/default/readme.md b/keyboards/earth_rover/keymaps/default/readme.md new file mode 100644 index 000000000..aa0b88c38 --- /dev/null +++ b/keyboards/earth_rover/keymaps/default/readme.md | |||
| @@ -0,0 +1 @@ | |||
| # The default keymap for earth_rover | |||
diff --git a/keyboards/earth_rover/readme.md b/keyboards/earth_rover/readme.md new file mode 100644 index 000000000..84b1ad87d --- /dev/null +++ b/keyboards/earth_rover/readme.md | |||
| @@ -0,0 +1,22 @@ | |||
| 1 | # earth_rover | ||
| 2 | |||
| 3 |  | ||
| 4 | |||
| 5 | Mechanical warm, or just cubic macro pad. | ||
| 6 | |||
| 7 | * Keyboard Maintainer: [k.bigwheel](https://github.com/bigwheel) | ||
| 8 | * Build Guide: [bigwheel/earth\_rover](https://github.com/bigwheel/earth_rover) | ||
| 9 | * Hardware Supported: [無限の可能性 \| MxLEDBitPCB](https://swanmatch.github.io/MxLEDBitPCB/), Pro Micro | ||
| 10 | * Hardware Availability: [魔界鍵盤製作所 \- BOOTH](https://swanmatch.booth.pm/), [Pro Micro (コンスルー付き) \| 遊舎工房](https://yushakobo.jp/shop/promicro-spring-pinheader/) | ||
| 11 | |||
| 12 | Make example for this keyboard (after setting up your build environment): | ||
| 13 | |||
| 14 | make earth_rover:default | ||
| 15 | |||
| 16 | Reset Pro Micro by reset button on ProMicroSocket (Red LED must light). | ||
| 17 | |||
| 18 | Flashing example for this keyboard: | ||
| 19 | |||
| 20 | make earth_rover:default:flash | ||
| 21 | |||
| 22 | 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). | ||
diff --git a/keyboards/earth_rover/rules.mk b/keyboards/earth_rover/rules.mk new file mode 100644 index 000000000..fd76a5247 --- /dev/null +++ b/keyboards/earth_rover/rules.mk | |||
| @@ -0,0 +1,22 @@ | |||
| 1 | # MCU name | ||
| 2 | MCU = atmega32u4 | ||
| 3 | |||
| 4 | # Bootloader selection | ||
| 5 | BOOTLOADER = caterina | ||
| 6 | |||
| 7 | # Build Options | ||
| 8 | # change yes to no to disable | ||
| 9 | # | ||
| 10 | BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration | ||
| 11 | MOUSEKEY_ENABLE = yes # Mouse keys | ||
| 12 | EXTRAKEY_ENABLE = yes # Audio control and System control | ||
| 13 | CONSOLE_ENABLE = no # Console for debug | ||
| 14 | COMMAND_ENABLE = no # Commands for debug and configuration | ||
| 15 | # Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE | ||
| 16 | SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend | ||
| 17 | # if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work | ||
| 18 | NKRO_ENABLE = no # USB Nkey Rollover | ||
| 19 | BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality | ||
| 20 | RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow | ||
| 21 | BLUETOOTH_ENABLE = no # Enable Bluetooth | ||
| 22 | AUDIO_ENABLE = no # Audio output | ||
