~ruther/qmk_firmware

2a45d99059c84e37da4f16a07b324adbe30ddebc — Matthew Dias 4 years ago 06f8cb1
Add m3n3van rev2 (#12405)

* Add m3n3van rev2

* Add via support
A keyboards/m3n3van/config.h => keyboards/m3n3van/config.h +65 -0
@@ 0,0 1,65 @@
/*
Copyright 2021 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       0x6D64
#define PRODUCT_ID      0x2323
#define DEVICE_VER      0x0002
#define MANUFACTURER    Matthew Dias
#define PRODUCT         m3n3van

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

/* m3n3van PCB default pin-out */
#define MATRIX_ROW_PINS { B5, B6, C6, C7 }
#define MATRIX_COL_PINS { F4, F5, F6, F1, F7, F0, E6, D3, D0, D1, D2, D4, D6 }
#define ENCODERS_PAD_A { B4 }
#define ENCODERS_PAD_B { D7 }
#define UNUSED_PINS { B0, B1, B2, B3, B7, D5 }

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

A keyboards/m3n3van/info.json => keyboards/m3n3van/info.json +57 -0
@@ 0,0 1,57 @@
{
    "keyboard_name": "m3n3van",
    "url": "https://github.com/matthewdias/m3n3van/tree/main/rev2",
    "maintainer": "matthewdias",
    "width": 12.75,
    "height": 4,
    "layouts": {
        "LAYOUT": {
            "layout": [
                { "label": "Esc", "x": 0, "y": 0 },
                { "label": "Q", "x": 1, "y": 0 },
                { "label": "W", "x": 2, "y": 0 },
                { "label": "E", "x": 3, "y": 0 },
                { "label": "R", "x": 4, "y": 0 },
                { "label": "T", "x": 5, "y": 0 },
                { "label": "Y", "x": 6, "y": 0 },
                { "label": "U", "x": 7, "y": 0 },
                { "label": "I", "x": 8, "y": 0 },
                { "label": "O", "x": 9, "y": 0 },
                { "label": "P", "x": 10, "y": 0 },
                { "label": "Backspace", "x": 11, "y": 0, "w": 1.75 },
                { "label": "Tab", "x": 0, "y": 1, "w": 1.25 },
                { "label": "A", "x": 1.25, "y": 1 },
                { "label": "S", "x": 2.25, "y": 1 },
                { "label": "D", "x": 3.25, "y": 1 },
                { "label": "F", "x": 4.25, "y": 1 },
                { "label": "G", "x": 5.25, "y": 1 },
                { "label": "H", "x": 6.25, "y": 1 },
                { "label": "J", "x": 7.25, "y": 1 },
                { "label": "K", "x": 8.25, "y": 1 },
                { "label": "L", "x": 9.25, "y": 1 },
                { "label": ";", "x": 10.25, "y": 1 },
                { "label": "Enter", "x": 11.25, "y": 1, "w": 1.5 },
                { "label": "Shift", "x": 0, "y": 2, "w": 1.75 },
                { "label": "Z", "x": 1.75, "y": 2 },
                { "label": "X", "x": 2.75, "y": 2 },
                { "label": "C", "x": 3.75, "y": 2 },
                { "label": "V", "x": 4.75, "y": 2 },
                { "label": "B", "x": 5.75, "y": 2 },
                { "label": "N", "x": 6.75, "y": 2 },
                { "label": "M", "x": 7.75, "y": 2 },
                { "label": "<", "x": 8.75, "y": 2 },
                { "label": ">", "x": 9.75, "y": 2 },
                { "label": "/", "x": 10.75, "y": 2 },
                { "label": "Shift", "x": 11.75, "y": 2 },
                { "label": "Ctrl", "x": 0, "y": 3 },
                { "label": "Alt", "x": 1, "y": 3, "w": 1.25 },
                { "label": "Meta", "x": 2.25, "y": 3 },
                { "x": 3.25, "y": 3, "w": 3 },
                { "x": 6.25, "y": 3, "w": 3 },
                { "label": "Meta", "x": 9.25, "y": 3, "w": 1.25 },
                { "label": "Alt", "x": 10.5, "y": 3 },
                { "label": "Ctrl", "x": 11.5, "y": 3, "w": 1.25 }
            ]
        }
    }
}

A keyboards/m3n3van/keymaps/default/keymap.json => keyboards/m3n3van/keymaps/default/keymap.json +25 -0
@@ 0,0 1,25 @@
{
  "keyboard": "m3n3van",
  "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_BSPC", 
      "KC_TAB",  "KC_A", "KC_S", "KC_D", "KC_F", "KC_G", "KC_H", "KC_J", "KC_K",    "KC_L",   "KC_SCLN", "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_LCTL", "KC_LGUI", "KC_LALT",    "LT(2, KC_SPC)",    "LT(1, KC_SPC)",     "KC_RALT", "KC_RGUI", "KC_RCTL"
    ],
    [
      "KC_GRV",  "KC_MPRV", "KC_MPLY", "KC_MNXT", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_UP",   "KC_LBRC", "KC_RBRC", "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_QUPT",
      "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_MINS", "KC_EQL",  "KC_SLSH", "KC_TRNS", 
      "KC_TRNS", "KC_TRNS", "KC_TRNS",            "KC_TRNS",                       "KC_TRNS",            "KC_TRNS", "KC_TRNS", "KC_TRNS"
    ],
    [
      "KC_TRNS", "KC_1",    "KC_2",    "KC_3",    "KC_4",    "KC_5",    "KC_6",    "KC_7",    "KC_8",    "KC_9",    "KC_0",    "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_BSLS", "KC_TRNS", 
      "KC_TRNS", "KC_TRNS", "KC_TRNS",            "KC_TRNS",                       "KC_TRNS",            "KC_TRNS", "KC_TRNS", "KC_TRNS"
    ]
  ]
}

A keyboards/m3n3van/keymaps/matthewdias/keymap.c => keyboards/m3n3van/keymaps/matthewdias/keymap.c +51 -0
@@ 0,0 1,51 @@
/*
Copyright 2021 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 QMK_KEYBOARD_H

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    [0] = LAYOUT_encoder( \
        KC_ESC,  KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I,    KC_O,    KC_P,    KC_BSPC, KC_MUTE, \
        KC_TAB,  KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K,    KC_L,    KC_SCLN, KC_ENT,           \
        KC_RSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT,  KC_SLSH, KC_LSFT,          \
        KC_LCTL, KC_LALT, KC_LGUI,  LT(2, KC_SPC), LT(1, KC_SPC),   KC_RGUI, KC_RALT, KC_RCTL           \
    ),

    [1] = LAYOUT_encoder( \
        KC_GRV,  KC_MPRV, KC_MPLY, KC_MNXT, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_UP,   KC_LBRC, KC_RBRC, 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_QUOT,          \
        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MINS, KC_EQL,  KC_SLSH, KC_TRNS,          \
        KC_TRNS, KC_TRNS, KC_TRNS,          KC_TRNS,                   KC_TRNS,          KC_TRNS, KC_TRNS, KC_TRNS           \
    ),

    [2] = LAYOUT_encoder( \
        KC_TRNS, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    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_BSLS, KC_TRNS,          \
        KC_TRNS, KC_TRNS, KC_TRNS,            KC_TRNS,                       KC_TRNS,            KC_TRNS, KC_TRNS, KC_TRNS   \
    )
};

void encoder_update_user(uint8_t index, bool clockwise) {
    if (index == 0) {
        if (clockwise) {
            tap_code(KC_VOLU);
        } else {
            tap_code(KC_VOLD);
        }
    }
}

A keyboards/m3n3van/keymaps/via/keymap.c => keyboards/m3n3van/keymaps/via/keymap.c +58 -0
@@ 0,0 1,58 @@
/*
Copyright 2021 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 QMK_KEYBOARD_H

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    [0] = LAYOUT_encoder( \
        KC_ESC,  KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I,    KC_O,    KC_P,    KC_BSPC, KC_MUTE, \
        KC_TAB,  KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K,    KC_L,    KC_SCLN, 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_LCTL, KC_LALT, KC_LGUI,  LT(2, KC_SPC), LT(1, KC_SPC),   KC_RGUI, KC_RALT, KC_RCTL           \
    ),

    [1] = LAYOUT_encoder( \
        KC_GRV,  KC_MPRV, KC_MPLY, KC_MNXT, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_UP,   KC_LBRC, KC_RBRC, 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_QUOT,          \
        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MINS, KC_EQL,  KC_SLSH, KC_TRNS,          \
        KC_TRNS, KC_TRNS, KC_TRNS,          KC_TRNS,                   KC_TRNS,          KC_TRNS, KC_TRNS, KC_TRNS           \
    ),

    [2] = LAYOUT_encoder( \
        KC_TRNS, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    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_BSLS, KC_TRNS,          \
        KC_TRNS, KC_TRNS, KC_TRNS,            KC_TRNS,                       KC_TRNS,            KC_TRNS, KC_TRNS, KC_TRNS   \
    ),

    [3] = LAYOUT_encoder( \
        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_TRNS, KC_TRNS, KC_TRNS, KC_BSLS, KC_TRNS,          \
        KC_TRNS, KC_TRNS, KC_TRNS,            KC_TRNS,                       KC_TRNS,            KC_TRNS, KC_TRNS, KC_TRNS   \
    )
};

void encoder_update_user(uint8_t index, bool clockwise) {
    if (index == 0) {
        if (clockwise) {
            tap_code(KC_VOLU);
        } else {
            tap_code(KC_VOLD);
        }
    }
}

A keyboards/m3n3van/keymaps/via/rules.mk => keyboards/m3n3van/keymaps/via/rules.mk +1 -0
@@ 0,0 1,1 @@
VIA_ENABLE = yes

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

A keyboards/m3n3van/m3n3van.h => keyboards/m3n3van/m3n3van.h +48 -0
@@ 0,0 1,48 @@
/*
Copyright 2021 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 XXX KC_NO

#define LAYOUT( \
    K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A,      K0C, \
    K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A,      K1C, \
    K20,      K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, \
    K30, K31, K32,      K34,           K37,      K39,      K3B, K3C  \
) \
{ \
    { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, XXX, K0C }, \
    { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, XXX, K1C }, \
    { K20, XXX, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C }, \
    { K30, K31, K32, XXX, K34, XXX, XXX, K37, XXX, K39, XXX, K3B, K3C }  \
}

#define LAYOUT_encoder( \
    K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, \
    K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A,      K1C, \
    K20,      K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, \
    K30, K31, K32,      K34,           K37,      K39,      K3B, K3C  \
) \
{ \
    { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C }, \
    { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, XXX, K1C }, \
    { K20, XXX, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C }, \
    { K30, K31, K32, XXX, K34, XXX, XXX, K37, XXX, K39, XXX, K3B, K3C }  \
}

A keyboards/m3n3van/readme.md => keyboards/m3n3van/readme.md +21 -0
@@ 0,0 1,21 @@
# m3n3van

![](https://raw.githubusercontent.com/matthewdias/m3n3van/f642037703cfac5deba284ef7671c0564fdd8d4d/rev2/bottom.svg)

A minivan case compatible PCB with 2x3u split space.

-   Keyboard Maintainer: matthewdias
-   Hardware Supported: m3n3van rev2 PCB
-   Hardware Availability: [GitHub](https://github.com/matthewdias/m3n3van/tree/main/rev2)

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 m3n3van: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 m3n3van: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/m3n3van/rules.mk => keyboards/m3n3van/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 = 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
ENCODER_ENABLE = yes