[Keyboard] Add minim keyboard (#10970)

* Create minim firmware

* Cleanup and add configurator support

* PR Checklist Items

* Delete keymap.c

* Apply suggestions from code review

Co-authored-by: Joel Challis <git@zvecr.com>

Co-authored-by: Joel Challis <git@zvecr.com>
This commit is contained in:
Matthew Dias 2020-11-25 10:57:58 -06:00 committed by GitHub
parent 0a9476bc2a
commit 24a741649d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 240 additions and 0 deletions

63
keyboards/minim/config.h Normal file
View file

@ -0,0 +1,63 @@
/*
Copyright 2020 Matthew Dias <matthewdias@me.com>
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 0xAAAA
#define DEVICE_VER 0x0001
#define MANUFACTURER Matthew Dias
#define PRODUCT minim
/* key matrix size */
#define MATRIX_ROWS 4
#define MATRIX_COLS 14
/* minim PCB default pin-out */
#define MATRIX_ROW_PINS { D6, D7, B4, B5 }
#define MATRIX_COL_PINS { F4, F5, F6, F1, F7, F0, B0, D1, B1, D2, B2, D3, D5, B3 }
#define UNUSED_PINS
/* COL2ROW or ROW2COL */
#define DIODE_DIRECTION COL2ROW
/* Set 0 if debouncing isn't needed */
#define DEBOUNCE 5
/*
* 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

59
keyboards/minim/info.json Normal file
View file

@ -0,0 +1,59 @@
{
"keyboard_name": "minim",
"url": "https://github.com/matthewdias/minim",
"maintainer": "matthewdias",
"width": 14.5,
"height": 4,
"layouts": {
"LAYOUT": {
"layout": [
{ "label": "Tab", "x": 0, "y": 0, "w": 1.25 },
{ "label": "Q", "x": 1.25, "y": 0 },
{ "label": "W", "x": 2.25, "y": 0 },
{ "label": "E", "x": 3.25, "y": 0 },
{ "label": "R", "x": 4.25, "y": 0 },
{ "label": "T", "x": 5.25, "y": 0 },
{ "label": "Y", "x": 6.25, "y": 0 },
{ "label": "U", "x": 7.25, "y": 0 },
{ "label": "I", "x": 8.25, "y": 0 },
{ "label": "O", "x": 9.25, "y": 0 },
{ "label": "P", "x": 10.25, "y": 0 },
{ "label": "{", "x": 11.25, "y": 0 },
{ "label": "}", "x": 12.25, "y": 0 },
{ "label": "Back", "x": 13.25, "y": 0, "w": 1.25 },
{ "label": "Ctrl", "x": 0, "y": 1, "w": 1.75 },
{ "label": "A", "x": 1.75, "y": 1 },
{ "label": "S", "x": 2.75, "y": 1 },
{ "label": "D", "x": 3.75, "y": 1 },
{ "label": "F", "x": 4.75, "y": 1 },
{ "label": "G", "x": 5.75, "y": 1 },
{ "label": "H", "x": 6.75, "y": 1 },
{ "label": "J", "x": 7.75, "y": 1 },
{ "label": "K", "x": 8.75, "y": 1 },
{ "label": "L", "x": 9.75, "y": 1 },
{ "label": ":", "x": 10.75, "y": 1 },
{ "label": "\"", "x": 11.75, "y": 1 },
{ "label": "Enter", "x": 12.75, "y": 1, "w": 1.75 },
{ "label": "Shift", "x": 0, "y": 2, "w": 2.25 },
{ "label": "Z", "x": 2.25, "y": 2 },
{ "label": "X", "x": 3.25, "y": 2 },
{ "label": "C", "x": 4.25, "y": 2 },
{ "label": "V", "x": 5.25, "y": 2 },
{ "label": "B", "x": 6.25, "y": 2 },
{ "label": "N", "x": 7.25, "y": 2 },
{ "label": "M", "x": 8.25, "y": 2 },
{ "label": "<", "x": 9.25, "y": 2 },
{ "label": ">", "x": 10.25, "y": 2 },
{ "label": "?", "x": 11.25, "y": 2 },
{ "label": "Shift", "x": 12.25, "y": 2, "w": 2.25 },
{ "label": "Opt", "x": 1.5, "y": 3 },
{ "label": "Cmd", "x": 2.5, "y": 3, "w": 1.25 },
{ "label": "", "x": 3.75, "y": 3, "w": 2 },
{ "label": "", "x": 5.75, "y": 3, "w": 3 },
{ "label": "", "x": 8.75, "y": 3, "w": 2 },
{ "label": "Cmd", "x": 10.75, "y": 3, "w": 1.25 },
{ "label": "Opt", "x": 12, "y": 3 }
]
}
}
}

View file

@ -0,0 +1,24 @@
{
"keyboard": "minim",
"keymap": "default",
"layout": "LAYOUT",
"layers": [
[
"KC_ESC", "KC_Q", "KC_W", "KC_E", "KC_R", "KC_T", "KC_Y", "KC_U", "KC_I", "KC_O", "KC_P", "KC_LBRC", "KC_RBRC", "KC_BSPC",
"LCTL_T(KC_TAB)", "KC_A", "KC_S", "KC_D", "KC_F", "KC_G", "KC_H", "KC_J", "KC_K", "KC_L", "KC_SCLN", "KC_QUOT", "KC_ENT",
"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_LALT", "KC_LGUI", "MO(2)", "KC_SPC", "MO(1)", "KC_RGUI", "KC_RALT"
],
[
"KC_GRV", "KC_MPRV", "KC_MPLY", "KC_MNXT", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_UP", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS",
"KC_TRNS", "KC_VOLD", "KC_VOLU", "KC_MUTE", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_LEFT", "KC_DOWN", "KC_RGHT", "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", "KC_RALT"
],
[
"KC_TRNS", "KC_1", "KC_2", "KC_3", "KC_4", "KC_5", "KC_6", "KC_7", "KC_8", "KC_9", "KC_0", "KC_MINS", "KC_EQL", "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", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS",
"KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_RALT"]
]
}

18
keyboards/minim/minim.c Normal file
View file

@ -0,0 +1,18 @@
/*
Copyright 2020 Matthew Dias <matthewdias@me.com>
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 "minim.h"

33
keyboards/minim/minim.h Normal file
View file

@ -0,0 +1,33 @@
/*
Copyright 2020 Matthew Dias <matthewdias@me.com>
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"
#define LAYOUT( \
K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, \
K10, K11, K12, K13, K14, K15, K16, K18, K19, K1A, K1B, K1C, K1D, \
K20, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2D, \
K31, K32, K34, K37, K39, K3B, K3C \
) \
{ \
{ K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D }, \
{ K10, K11, K12, K13, K14, K15, K16, KC_NO, K18, K19, K1A, K1B, K1C, K1D }, \
{ K20, KC_NO, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, KC_NO, K2D }, \
{ KC_NO, K31, K32, KC_NO, K34, KC_NO, KC_NO, K37, KC_NO, K39, KC_NO, K3B, K3C, KC_NO } \
}

21
keyboards/minim/readme.md Normal file
View file

@ -0,0 +1,21 @@
# minim
![](https://raw.githubusercontent.com/matthewdias/minim/main/layout.png)
A symmetrical 50% keyboard.
* Keyboard Maintainer: matthewdias
* Hardware Supported: minim PCB
* Hardware Availability: [GitHub](https://github.com/matthewdias/minim)
To reset the keyboard into bootloader mode, press the reset switch on the underside.
Make example for this keyboard (after setting up your build environment):
make minim:default
Flashing example for this keyboard ([using the command line](https://docs.qmk.fm/#/newbs_flashing?id=flash-your-keyboard-from-the-command-line)):
make minim: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).

22
keyboards/minim/rules.mk Normal file
View file

@ -0,0 +1,22 @@
# MCU name
MCU = atmega32u4
# Bootloader selection
BOOTLOADER = atmel-dfu
# 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 = yes # 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