aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/_summary.md1
-rw-r--r--docs/easy_maker.md31
2 files changed, 32 insertions, 0 deletions
diff --git a/docs/_summary.md b/docs/_summary.md
index 1d9540082..48115cef4 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -36,6 +36,7 @@
36 * Guides 36 * Guides
37 * [Customizing Functionality](custom_quantum_functions.md) 37 * [Customizing Functionality](custom_quantum_functions.md)
38 * [Driver Installation with Zadig](driver_installation_zadig.md) 38 * [Driver Installation with Zadig](driver_installation_zadig.md)
39 * [Easy Maker for One Offs](easy_maker.md)
39 * [Keymap Overview](keymap.md) 40 * [Keymap Overview](keymap.md)
40 * Development Environments 41 * Development Environments
41 * [Docker Guide](getting_started_docker.md) 42 * [Docker Guide](getting_started_docker.md)
diff --git a/docs/easy_maker.md b/docs/easy_maker.md
new file mode 100644
index 000000000..dc9727233
--- /dev/null
+++ b/docs/easy_maker.md
@@ -0,0 +1,31 @@
1# Easy Maker - Build One-Off Projects In Configurator
2
3Have 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.
4
5There are different styles of Easy Maker available depending on your needs:
6
7* [Direct Pin](https://config.qmk.fm/#/?filter=ez_maker/direct) - Connect a single switch to a single pin
8* Direct Pin + Backlight (Coming Soon) - Like Direct Pin but dedicates a single pin to [Backlight](feature_backlight.md) control
9* Direct Pin + Numlock (Coming Soon) - Like Direct Pin but dedicates a single pin to the Numlock LED
10* Direct Pin + Capslock (Coming Soon) - Like Direct Pin but dedicates a single pin to the Numlock LED
11* Direct Pin + Encoder (Coming Soon) - Like Direct Pin but uses 2 pins to add a single rotary encoder
12
13## Quickstart
14
15The 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:
16
17* <https://config.qmk.fm/#/?filter=ez_maker/direct>
18
19For more details see the [Direct Pin](#direct-pin) section.
20
21# Direct Pin
22
23As 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.
24
25Here is a schematic showing how we connect a single button to pin A3 on a ProMicro:
26
27![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)
28
29Once 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:
30
31* <https://config.qmk.fm/#/?filter=ez_maker/direct>