Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Keyboard] ez_maker/directpins for easy one-offs in qmk_configurator #13321

Merged
merged 8 commits into from
Aug 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
* Guides
* [Customizing Functionality](custom_quantum_functions.md)
* [Driver Installation with Zadig](driver_installation_zadig.md)
* [Easy Maker for One Offs](easy_maker.md)
* [Keymap Overview](keymap.md)
* Development Environments
* [Docker Guide](getting_started_docker.md)
Expand Down
31 changes: 31 additions & 0 deletions docs/easy_maker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Easy Maker - Build One-Off Projects In Configurator

Have you ever needed an easy way to program a controller, such as a Proton C or Teensy 2.0, for a one-off project you're building? QMK has you covered with the Easy Maker. Now you can create a firmware in minutes using QMK Configurator.

There are different styles of Easy Maker available depending on your needs:

* [Direct Pin](https://config.qmk.fm/#/?filter=ez_maker/direct) - Connect a single switch to a single pin
* Direct Pin + Backlight (Coming Soon) - Like Direct Pin but dedicates a single pin to [Backlight](feature_backlight.md) control
* Direct Pin + Numlock (Coming Soon) - Like Direct Pin but dedicates a single pin to the Numlock LED
* Direct Pin + Capslock (Coming Soon) - Like Direct Pin but dedicates a single pin to the Numlock LED
* Direct Pin + Encoder (Coming Soon) - Like Direct Pin but uses 2 pins to add a single rotary encoder

## Quickstart

The easiest way to get started is with the Direct Pin boards. This will assign a single key to each pin and you can short that pin to ground to activate it. Select your MCU from the Keyboard dropdown here:

* <https://config.qmk.fm/#/?filter=ez_maker/direct>

For more details see the [Direct Pin](#direct-pin) section.

# Direct Pin

As its name implies Direct Pin works by connecting one switch per pin. The other side of the switch should be connected to ground (VSS or GND.) You don't need any other components, your MCU has internal pull-up resistors so that the switch sensing can work.

Here is a schematic showing how we connect a single button to pin A3 on a ProMicro:

![Schematic diagram showing a ProMicro with a wire coming out of A3, connecting to the left side of a switch. Another wire comes out of the right side of the switch to connect to the Ground Plane.](https://i.imgur.com/JcDhZll.png)

Once you have wired your switches you can assign keycodes to each pin and build a firmware by selecting the MCU you are using from the Keyboard dropdown. Use this link to show only Easy Maker Direct Pin:

* <https://config.qmk.fm/#/?filter=ez_maker/direct>
20 changes: 20 additions & 0 deletions keyboards/ez_maker/directpins/promicro/config.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/*
Copyright 2021 Zach White

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"
49 changes: 49 additions & 0 deletions keyboards/ez_maker/directpins/promicro/info.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
{
"manufacturer": "Zach White",
"keyboard_name": "DirectPins ProMicro",
"maintainer": "skullydazed",
"bootloader": "atmel-dfu",
"debounce": 5,
"diode_direction": "COL2ROW",
"features": {
"bootmagic_lite": true,
"extrakey": true,
"mousekey": true
},
"matrix_pins": {
"direct": [
["D3", null],
["D2", null],
["D1", "F4"],
["D0", "F5"],
["D4", "F6"],
["C6", "F7"],
["D7", "B1"],
["E6", "B3"],
["B4", "B2"],
["B5", "B6"]
]
},
"processor": "atmega32u4",
"usb": {
"device_ver": "0x0001",
"pid": "0x2320",
"vid": "0xFEED"
},
"layouts": {
"LAYOUT_all": {
"layout": [
{"label":"D3", "matrix": [0, 0], "x":0, "y":0},
{"label":"D2", "matrix": [1, 0], "x":0, "y":1},
{"label":"D1", "matrix": [2, 0], "x":0, "y":4}, {"label":"F4", "matrix": [2, 1], "x":2, "y":4},
{"label":"D0", "matrix": [3, 0], "x":0, "y":5}, {"label":"F5", "matrix": [3, 1], "x":2, "y":5},
{"label":"D4", "matrix": [4, 0], "x":0, "y":6}, {"label":"F6", "matrix": [4, 1], "x":2, "y":6},
{"label":"C6", "matrix": [5, 0], "x":0, "y":7}, {"label":"F7", "matrix": [5, 1], "x":2, "y":7},
{"label":"D7", "matrix": [6, 0], "x":0, "y":8}, {"label":"B1", "matrix": [6, 1], "x":2, "y":8},
{"label":"E6", "matrix": [7, 0], "x":0, "y":9}, {"label":"B3", "matrix": [7, 1], "x":2, "y":9},
{"label":"B4", "matrix": [8, 0], "x":0, "y":10}, {"label":"B2", "matrix": [8, 1], "x":2, "y":10},
{"label":"B5", "matrix": [9, 0], "x":0, "y":11}, {"label":"B6", "matrix": [9, 1], "x":2, "y":11}
]
}
}
}
19 changes: 19 additions & 0 deletions keyboards/ez_maker/directpins/promicro/keymaps/default/keymap.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"keyboard": "ez_maker/directpins/promicro",
"keymap": "default",
"layout": "LAYOUT_all",
"layers": [
[
"KC_0",
"KC_1",
"KC_2", "KC_3",
"KC_4", "KC_5",
"KC_6", "KC_7",
"KC_8", "KC_9",
"KC_A", "KC_B",
"KC_C", "KC_D",
"KC_E", "KC_F",
"KC_G", "KC_H"
]
]
}
17 changes: 17 additions & 0 deletions keyboards/ez_maker/directpins/promicro/promicro.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/* Copyright 2021 Zach White
*
* 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 "promicro.h"
19 changes: 19 additions & 0 deletions keyboards/ez_maker/directpins/promicro/promicro.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
/* Copyright 2021 Zach White
*
* 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"
19 changes: 19 additions & 0 deletions keyboards/ez_maker/directpins/promicro/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# DirectPins

![Promicro Pinout Guide](https://i.imgur.com/LZ194Hf.jpg)

Easily assign keys to pins for your custom project using QMK Configurator.

* Keyboard Maintainer: [Zach White](https://github.com/skullydazed)
* Hardware Supported: Promicro
* Hardware Availability: Sparkfun, chinese clones

Make example for this keyboard (after setting up your build environment):

qmk compile -kb ez_maker/directpins/promicro -km default

Flashing example for this keyboard:

qmk flash -kb ez_maker/directpins/promicro -km default

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).
Empty file.
60 changes: 60 additions & 0 deletions keyboards/ez_maker/directpins/proton_c/info.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
{
"manufacturer": "Zach White",
"keyboard_name": "DirectPins Proton C",
"maintainer": "skullydazed",
"debounce": 5,
"processor": "STM32F303",
"board": "QMK_PROTON_C",
"features": {
"bootmagic_lite": true,
"extrakey": true,
"mousekey": true
},
"matrix_pins": {
"direct": [
["A9", null],
["A10", null],
["B7", "A2"],
["B6", "A1"],
["B5", "A0"],
["B4", "B8"],
["B3", "B13"],
["B2", "B14"],
["B1", "B15"],
["B0", "B9"],
["A4", "B10"],
["A5", "B11"],
["A6", "B12"],
["A7", "A14"],
["A8", "A13"],
["A15", null]
]
},
"usb": {
"device_ver": "0x0001",
"pid": "0x2321",
"vid": "0xFEED"
},
"layouts": {
"LAYOUT_all": {
"layout": [
{ "label": "A9", "matrix": [0, 0], "x": 0, "y": 0 },
{ "label": "A10", "matrix": [1, 0], "x": 0, "y": 1 },
{ "label": "B7", "matrix": [2, 0], "x": 0, "y": 4 }, { "label": "A2", "matrix": [2, 1], "x": 2, "y": 4 },
{ "label": "B6", "matrix": [3, 0], "x": 0, "y": 5 }, { "label": "A1", "matrix": [3, 1], "x": 2, "y": 5 },
{ "label": "B5", "matrix": [4, 0], "x": 0, "y": 6 }, { "label": "A0", "matrix": [4, 1], "x": 2, "y": 6 },
{ "label": "B4", "matrix": [5, 0], "x": 0, "y": 7 }, { "label": "B8", "matrix": [5, 1], "x": 2, "y": 7 },
{ "label": "B3", "matrix": [6, 0], "x": 0, "y": 8 }, { "label": "B13", "matrix": [6, 1], "x": 2, "y": 8 },
{ "label": "B2", "matrix": [7, 0], "x": 0, "y": 9 }, { "label": "B14", "matrix": [7, 1], "x": 2, "y": 9 },
{ "label": "B1", "matrix": [8, 0], "x": 0, "y": 10 }, { "label": "B15", "matrix": [8, 1], "x": 2, "y": 10 },
{ "label": "B0", "matrix": [9, 0], "x": 0, "y": 11 }, { "label": "B9", "matrix": [9, 1], "x": 2, "y": 11 },
{ "label": "A4", "matrix": [10, 0], "x": 0, "y": 13 }, { "label": "B10", "matrix": [10, 1], "x": 2, "y": 13 },
{ "label": "A5", "matrix": [11, 0], "x": 0, "y": 14 }, { "label": "B11", "matrix": [11, 1], "x": 2, "y": 14 },
{ "label": "A6", "matrix": [12, 0], "x": 0, "y": 15 }, { "label": "B12", "matrix": [12, 1], "x": 2, "y": 15 },
{ "label": "A7", "matrix": [13, 0], "x": 0, "y": 16 }, { "label": "A14", "matrix": [13, 1], "x": 2, "y": 16 },
{ "label": "A8", "matrix": [14, 0], "x": 0, "y": 17 }, { "label": "A13", "matrix": [14, 1], "x": 2, "y": 17 },
{ "label": "A15", "matrix": [15, 0], "x": 0, "y": 18 }
]
}
}
}
25 changes: 25 additions & 0 deletions keyboards/ez_maker/directpins/proton_c/keymaps/default/keymap.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"keyboard": "ez_maker/directpins/proton_c",
"keymap": "default",
"layout": "LAYOUT_all",
"layers": [
[
"KC_0",
"KC_1",
"KC_2", "KC_3",
"KC_4", "KC_5",
"KC_6", "KC_7",
"KC_8", "KC_9",
"KC_A", "KC_B",
"KC_C", "KC_D",
"KC_E", "KC_F",
"KC_G", "KC_H",
"KC_I", "KC_J",
"KC_K", "KC_L",
"KC_M", "KC_N",
"KC_O", "KC_P",
"KC_Q", "KC_R",
"KC_S"
]
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# The default keymap for directpins
17 changes: 17 additions & 0 deletions keyboards/ez_maker/directpins/proton_c/proton_c.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/* Copyright 2021 Zach White
*
* 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 "proton_c.h"
19 changes: 19 additions & 0 deletions keyboards/ez_maker/directpins/proton_c/proton_c.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
/* Copyright 2021 Zach White
*
* 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"
19 changes: 19 additions & 0 deletions keyboards/ez_maker/directpins/proton_c/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# DirectPins

![Proton-C Pinout Guide](https://i.imgur.com/NqsqmdF.png)

Easily assign keys to pins for your custom project using QMK Configurator.

* Keyboard Maintainer: [Zach White](https://github.com/skullydazed)
* Hardware Supported: Proton C
* Hardware Availability: https://qmk.fm/proton-c

Make example for this keyboard (after setting up your build environment):

qmk compile -kb ez_maker/directpins/proton_c -km default

Flashing example for this keyboard:

qmk flash -kb ez_maker/directpins/proton_c -km default

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).
Empty file.
5 changes: 5 additions & 0 deletions keyboards/ez_maker/directpins/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# DirectPins

Easily assign keys to pins for your custom project using QMK Configurator.

This directory exists so that people creating one-offs can easily hook up their pins to switches and flash QMK to it.
20 changes: 20 additions & 0 deletions keyboards/ez_maker/directpins/teensy_2/config.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/*
Copyright 2021 Zach White

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"
Loading