[Keyboard] New Keyboard - Clunker

keyboards/mechwild/clunker/config.h

@@ -0,0 +1,26 @@
+// Copyright 2022 Kyle McCreery (@kylemccreery)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+/*
+ * 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
+
+#define ENCODERS_PAD_A { D2 }
+#define ENCODERS_PAD_B { D3 }
+#define ENCODER_RESOLUTION 4
+
+#define SOLENOID_PIN F4

keyboards/mechwild/clunker/info.json

@@ -0,0 +1,86 @@
+{
+    "manufacturer": "MechWild",
+    "keyboard_name": "Clunker",
+    "maintainer": "kylemccreery",
+    "bootloader": "caterina",
+    "diode_direction": "COL2ROW",
+    "features": {
+        "bootmagic": true,
+        "command": false,
+        "console": false,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true,
+        "encoder": true,
+        "encoder_map": true,
+        "haptic": true
+    },
+    "matrix_pins": {
+        "rows": ["F5", "F6", "B3", "F7", "B2", "B1", "B6"],
+        "cols": ["D1", "D0", "D4", "C6", "D7", "E6", "B4", "B5"]
+    },
+    "processor": "atmega32u4",
+    "url": "https://mechwild.com/product/clunker/",
+    "usb": {
+        "device_version": "1.3.0",
+        "pid": "0x1711",
+        "vid": "0x6D77"
+    },
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+            { "matrix": [0, 0], "x":0, "y":0}, 
+            { "matrix": [0, 1], "x":1, "y":0}, 
+            { "matrix": [0, 2], "x":2, "y":0}, 
+            { "matrix": [0, 3], "x":3, "y":0}, 
+            { "matrix": [0, 4], "x":4, "y":0}, 
+            { "matrix": [0, 5], "x":5, "y":0}, 
+            { "matrix": [0, 6], "x":6, "y":0}, 
+            { "matrix": [0, 7], "x":7, "y":0},
+            { "matrix": [1, 0], "x":0, "y":1, "w":1.5},
+            { "matrix": [1, 1], "x":1.5, "y":1}, 
+            { "matrix": [1, 2], "x":2.5, "y":1},
+            { "matrix": [1, 3], "x":3.5, "y":1}, 
+            { "matrix": [1, 4], "x":4.5, "y":1}, 
+            { "matrix": [1, 5], "x":5.5, "y":1}, 
+            { "matrix": [1, 6], "x":6.5, "y":1}, 
+            { "matrix": [1, 7], "x":7.5, "y":1}, 
+            { "matrix": [5, 7], "x":8.5, "y":1}, 
+            { "matrix": [5, 6], "x":9.5, "y":1}, 
+            { "matrix": [5, 5], "x":10.5, "y":1}, 
+            { "matrix": [5, 4], "x":11.5, "y":1}, 
+            { "matrix": [2, 0], "x":0, "y":2, "w":1.75}, 
+            { "matrix": [2, 1], "x":1.75, "y":2}, 
+            { "matrix": [2, 2], "x":2.75, "y":2}, 
+            { "matrix": [2, 3], "x":3.75, "y":2}, 
+            { "matrix": [2, 4], "x":4.75, "y":2}, 
+            { "matrix": [2, 5], "x":5.75, "y":2}, 
+            { "matrix": [2, 6], "x":6.75, "y":2}, 
+            { "matrix": [2, 7], "x":7.75, "y":2}, 
+            { "matrix": [5, 1], "x":8.75, "y":2}, 
+            { "matrix": [5, 2], "x":9.75, "y":2}, 
+            { "matrix": [5, 3], "x":10.75, "y":2, "w":1.75}, 
+            { "matrix": [3, 0], "x":0, "y":3, "w":1.25}, 
+            { "matrix": [3, 1], "x":1.25, "y":3}, 
+            { "matrix": [3, 2], "x":2.25, "y":3}, 
+            { "matrix": [3, 3], "x":3.25, "y":3}, 
+            { "matrix": [3, 4], "x":4.25, "y":3}, 
+            { "matrix": [3, 5], "x":5.25, "y":3}, 
+            { "matrix": [3, 6], "x":6.25, "y":3}, 
+            { "matrix": [3, 7], "x":7.25, "y":3}, 
+            { "matrix": [6, 7], "x":8.25, "y":3}, 
+            { "matrix": [6, 6], "x":9.25, "y":3}, 
+            { "matrix": [6, 5], "x":10.25, "y":3}, 
+            { "matrix": [6, 4], "x":11.25, "y":3, "w":1.25}, 
+            { "matrix": [4, 0], "x":0, "y":4, "w":1.25}, 
+            { "matrix": [4, 1], "x":1.25, "y":4, "w":1.25}, 
+            { "matrix": [4, 2], "x":2.5, "y":4, "w":1.25}, 
+            { "matrix": [4, 3], "x":3.75, "y":4, "w":2.75},
+            { "matrix": [4, 4], "x":6.5, "y":4, "w":2.25}, 
+            { "matrix": [4, 5], "x":8.75, "y":4, "w":1.25},
+            { "matrix": [4, 6], "x":10, "y":4, "w":1.25}, 
+            { "matrix": [4, 7], "x":11.25, "y":4, "w":1.25}
+            ]
+        }
+    }
+}

keyboards/mechwild/clunker/keymaps/default/keymap.c

@@ -0,0 +1,63 @@
+// Copyright 2022 Kyle McCreery (@kylemccreery)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+// Defines names for use in layer keycodes and the keymap
+
+enum layer_names {
+  _BASE,
+  _FN1,
+  _FN2,
+  _FN3
+};
+
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /* Base */
+    /* 
+    k00, k01, k02, k03, k04, k05, k06, k07,                     \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A,      \
+    k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, \
+    k40, k41, k42, k43, k44, k45, k46, k47, k48, k49, k4A, k4B, \
+    k50, k51, k52,      k54,      k56,           k59, k5A, k5B  \
+    */
+    [_BASE] = LAYOUT(
+    KC_ESC,   KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_MUTE,
+    KC_TAB,   KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,     KC_BSPC,
+    MO(_FN1), KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,              KC_ENT,
+    KC_LSFT,  KC_SLSH, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,   KC_RSFT,
+    KC_LCTL,  KC_LGUI, KC_LALT,          KC_SPC,           KC_SPC,                    KC_RALT, MO(_FN2), KC_RCTL
+    ),
+    [_FN1] = LAYOUT(
+    KC_GRV,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   HPT_TOG,
+    _______, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL,
+    _______, _______, _______, _______, _______, _______, _______, KC_LBRC, KC_RBRC, KC_SCLN,          KC_QUOT,
+    _______, _______, _______, _______, _______, _______, _______, _______, KC_MINS, KC_EQL,  KC_UP,   KC_SLSH,
+    _______, _______, _______,          _______,          _______,                   KC_LEFT, KC_DOWN, KC_RIGHT
+    ),
+    [_FN2] = LAYOUT(
+    QK_BOOT, _______, _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+    _______, _______, _______,          _______,          _______,                   _______, _______, _______
+    ),
+	[_FN3] = LAYOUT(
+    _______, _______, _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+    _______, _______, _______,          _______,          _______,                   _______, _______, _______
+    )
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][1][2] = {
+    [0] =  { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)  },
+    [1] =  { ENCODER_CCW_CW(KC_LEFT, KC_RIGHT)  },
+    [2] =  { ENCODER_CCW_CW(KC_HOME, KC_END)  },
+    [3] =  { ENCODER_CCW_CW(KC_BRID, KC_BRIU) }
+};
+#endif

keyboards/mechwild/clunker/keymaps/via/keymap.c

@@ -0,0 +1,63 @@
+// Copyright 2022 Kyle McCreery (@kylemccreery)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+// Defines names for use in layer keycodes and the keymap
+
+enum layer_names {
+  _BASE,
+  _FN1,
+  _FN2,
+  _FN3
+};
+
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /* Base */
+    /* 
+    k00, k01, k02, k03, k04, k05, k06, k07,                     \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A,      \
+    k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, \
+    k40, k41, k42, k43, k44, k45, k46, k47, k48, k49, k4A, k4B, \
+    k50, k51, k52,      k54,      k56,           k59, k5A, k5B  \
+    */
+    [_BASE] = LAYOUT(
+    KC_ESC,   KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_MUTE,
+    KC_TAB,   KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,     KC_BSPC,
+    MO(_FN1), KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,              KC_ENT,
+    KC_LSFT,  KC_SLSH, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,   KC_RSFT,
+    KC_LCTL,  KC_LGUI, KC_LALT,          KC_SPC,           KC_SPC,                    KC_RALT, MO(_FN2), KC_RCTL
+    ),
+    [_FN1] = LAYOUT(
+    KC_GRV,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   HPT_TOG,
+    _______, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL,
+    _______, _______, _______, _______, _______, _______, _______, KC_LBRC, KC_RBRC, KC_SCLN,          KC_QUOT,
+    _______, _______, _______, _______, _______, _______, _______, _______, KC_MINS, KC_EQL,  KC_UP,   KC_SLSH,
+    _______, _______, _______,          _______,          _______,                   KC_LEFT, KC_DOWN, KC_RIGHT
+    ),
+    [_FN2] = LAYOUT(
+    QK_BOOT, _______, _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+    _______, _______, _______,          _______,          _______,                   _______, _______, _______
+    ),
+	[_FN3] = LAYOUT(
+    _______, _______, _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+    _______, _______, _______,          _______,          _______,                   _______, _______, _______
+    )
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][1][2] = {
+    [0] =  { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)  },
+    [1] =  { ENCODER_CCW_CW(KC_LEFT, KC_RIGHT)  },
+    [2] =  { ENCODER_CCW_CW(KC_HOME, KC_END)  },
+    [3] =  { ENCODER_CCW_CW(KC_BRID, KC_BRIU) }
+};
+#endif

keyboards/mechwild/clunker/keymaps/via/rules.mk

@@ -0,0 +1,2 @@
+VIA_ENABLE = yes
+LTO_ENABLE = yes

keyboards/mechwild/clunker/readme.md

@@ -0,0 +1,25 @@
+# Clunker
+
+![clunker](https://i.imgur.com/6X5ijDoh.jpg)
+
+The Clunker is a 40% DIY kit with a knob and solenoid.
+
+* Keyboard Maintainer: [Kyle McCreery](https://github.com/kylemccreery)
+* Hardware Supported: Clunker v1.3
+* Hardware Availability: [Clunker on MechWild](https://mechwild.com/product/clunker/)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make mechwild/clunker:default
+
+Flashing example for this keyboard:
+
+    make mechwild/clunker:default:flash
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the top of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available

keyboards/mechwild/clunker/rules.mk

@@ -0,0 +1 @@
+HAPTIC_DRIVER += SOLENOID