Skip to content

Commit

Permalink
Add Vial support for MonsGeek M3 (#678)
Browse files Browse the repository at this point in the history
  • Loading branch information
@juanlufont
juanlufont authored Feb 18, 2024
1 parent 4a85152 commit d3d4328
Show file tree
Hide file tree
Showing 5 changed files with 268 additions and 0 deletions.
30 changes: 30 additions & 0 deletions keyboards/monsgeek/m3/keymaps/vial/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Flashing MonsGeek M3

MonsGeek M3 requires `wb32-dfu-uptader` to flash QMK (Vial)

## Debian instructions

These instructions have been tested on Debian Trixie. The binary
`wb32-dfu-updater` will be placed in `/usr/local/bin`

```sh
# you may need some other dependencies
sudo apt install -y cmake
git clone https://github.com/WestberryTech/wb32-dfu-updater
cd wb32-dfu-updater
# script requires sudo privileges to install binaries in /usr/local/
sudo ./boostrap.sh install
# select option 1
```

## Flashing

Once `wb32-dfu-updater` is installed and available on the default `$PATH`,
you can put the keyboard in bootlader moder and run:

```sh
qmk flash -kb monsgeek/m3 -km vial
```

You can put the MonsGeek M3 in bootloader mode by using Via to associate
the special keycode `RESET` to a key of your choice.
10 changes: 10 additions & 0 deletions keyboards/monsgeek/m3/keymaps/vial/config.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/* SPDX-License-Identifier: GPL-2.0-or-later */

#pragma once

#define VIAL_KEYBOARD_UID {0x97, 0xF3, 0x13, 0x41, 0x1B, 0xD7, 0x5E, 0xE7}
#define DYNAMIC_KEYMAP_LAYER_COUNT 6

// ESC + Pause/Break
#define VIAL_UNLOCK_COMBO_ROWS { 0, 0 }
#define VIAL_UNLOCK_COMBO_COLS { 0, 16 }
79 changes: 79 additions & 0 deletions keyboards/monsgeek/m3/keymaps/vial/keymap.c
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
/* Copyright (C) 2023 jonylee@hfd
*
* 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

enum __layers {
WIN_B,
WIN_W,
WIN_FN,
MAC_B,
MAC_W,
MAC_FN
};

// clang-format off
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

[WIN_B] = LAYOUT_tkl_ansi( /* Base */
KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_PSCR, KC_SCRL, KC_PAUS,
KC_GRV, 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_BSPC, KC_INS, KC_HOME, KC_PGUP,
KC_TAB, 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_BSLS, KC_DEL, KC_END, KC_PGDN,
KC_CAPS, 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_UP,
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RGUI, MO(WIN_FN), KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT),

[WIN_W] = LAYOUT_tkl_ansi( /* Base */
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_W,
_______, _______, _______, _______, _______, _______, MO(WIN_FN), _______, KC_A, KC_S, KC_D),


[WIN_FN] = LAYOUT_tkl_ansi( /* FN */
_______, KC_MYCM, KC_MAIL, KC_WSCH, KC_WHOM, KC_MSEL, KC_MPLY, KC_MPRV, KC_MNXT, _______,_______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RGB_SPD, RGB_SPI, _______, _______, _______, _______,
_______, _______,TG(WIN_W),_______, QK_BOOT, _______, _______, _______, _______, DF(MAC_B),_______,_______, _______, RGB_MOD, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, RGB_TOG, _______, _______, RGB_HUI,
_______, _______, _______, KC_CALC, _______, _______, _______, KC_MUTE, KC_VOLD, KC_VOLU, _______, _______, RGB_VAI,
_______, GU_TOGG, _______, _______, _______, _______, _______, _______, RGB_SAD, RGB_VAD, RGB_SAI),

[MAC_B] = LAYOUT_tkl_ansi( /* Base */
KC_ESC, KC_BRID, KC_BRIU, KC_MCTL, KC_LPAD, KC_F5, KC_F6, KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE, KC_VOLD, KC_VOLU, KC_PSCR, KC_SCRL, KC_PAUS,
KC_GRV, 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_BSPC, KC_INS, KC_HOME, KC_PGUP,
KC_TAB, 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_BSLS, KC_DEL, KC_END, KC_PGDN,
KC_CAPS, 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_UP,
KC_LCTL, KC_LALT, KC_LGUI, KC_SPC, KC_RGUI, KC_RALT, MO(MAC_FN), KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT),

[MAC_W] = LAYOUT_tkl_ansi( /* Base */
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_W,
_______, _______, _______, _______, _______, _______, MO(MAC_FN), _______, KC_A, KC_S, KC_D),
[MAC_FN] = LAYOUT_tkl_ansi( /* FN */
KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, _______, _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RGB_SPD, RGB_SPI, _______, _______, _______, _______,
_______, _______,TG(MAC_W),_______, QK_BOOT, _______, _______, _______, _______, DF(WIN_B),_______,_______, _______, RGB_MOD, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, RGB_TOG, _______, _______, RGB_HUI,
_______, _______, _______, KC_CALC, _______, _______, _______, KC_MUTE, KC_VOLD, KC_VOLU, _______, _______, RGB_VAI,
_______, _______, _______, _______, _______, _______, _______, _______, RGB_SAD, RGB_VAD, RGB_SAI)
};
// clang-format on
2 changes: 2 additions & 0 deletions keyboards/monsgeek/m3/keymaps/vial/rules.mk
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
VIA_ENABLE = yes
VIAL_ENABLE = yes
147 changes: 147 additions & 0 deletions keyboards/monsgeek/m3/keymaps/vial/vial.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
{
"name": "MonsGeek M3",
"vendorId": "0xFFFE",
"productId": "0x0009",
"lightning": "qmk_backlight",
"matrix": {
"rows": 6,
"cols": 17
},
"layouts": {
"labels": [],
"keymap": [
{
"name": "MonsGeek M3",
"author": "JLFont",
"switchMount": "cherry"
},
[
{ "x": 2.5, "c": "#777777" },
"0,0",
{ "x": 1, "c": "#cccccc" },
"0,1",
"0,2",
"0,3",
"0,4",
{ "x": 0.5, "c": "#aaaaaa" },
"0,5",
"0,6",
"0,7",
"0,8",
{ "x": 0.5, "c": "#cccccc" },
"0,9",
"0,10",
"0,11",
"0,12",
{ "x": 0.25, "c": "#aaaaaa" },
"0,14",
"0,15",
"0,16"
],
[
{ "y": 0.5, "x": 2.5, "c": "#cccccc" },
"1,0",
"1,1",
"1,2",
"1,3",
"1,4",
"1,5",
"1,6",
"1,7",
"1,8",
"1,9",
"1,10",
"1,11",
"1,12",
{ "c": "#aaaaaa", "w": 2 },
"1,13",
{ "x": 0.25 },
"1,14",
"1,15",
"1,16"
],
[
{ "x": 2.5, "w": 1.5 },
"2,0",
{ "c": "#cccccc" },
"2,1",
"2,2",
"2,3",
"2,4",
"2,5",
"2,6",
"2,7",
"2,8",
"2,9",
"2,10",
"2,11",
"2,12",
{ "w": 1.5 },
"2,13",
{ "x": 0.25, "c": "#aaaaaa" },
"2,14",
"2,15",
"2,16"
],
[
{ "x": 2.5, "w": 1.75 },
"3,0",
{ "c": "#cccccc" },
"3,1",
"3,2",
"3,3",
"3,4",
"3,5",
"3,6",
"3,7",
"3,8",
"3,9",
"3,10",
"3,11",
{ "c": "#777777", "w": 2.25 },
"3,13"
],
[
{ "x": 2.5, "c": "#aaaaaa", "w": 2.25 },
"4,0",
{ "c": "#cccccc" },
"4,1",
"4,2",
"4,3",
"4,4",
"4,5",
"4,6",
"4,7",
"4,8",
"4,9",
"4,10",
{ "c": "#aaaaaa", "w": 2.75 },
"4,13",
{ "x": 1.25 },
"4,15"
],
[
{ "x": 2.5, "w": 1.25 },
"5,0",
{ "w": 1.25 },
"5,1",
{ "w": 1.25 },
"5,2",
{ "c": "#cccccc", "w": 6.25 },
"5,5",
{ "c": "#aaaaaa", "w": 1.25 },
"5,9",
{ "w": 1.25 },
"5,10",
{ "w": 1.25 },
"5,11",
{ "w": 1.25 },
"5,13",
{ "x": 0.25 },
"5,14",
"5,15",
"5,16"
]
]
}
}

0 comments on commit d3d4328

Please sign in to comment.