diff options
Diffstat (limited to 'keyboards/dumbpad/v1x_dualencoder/readme.md')
-rw-r--r-- | keyboards/dumbpad/v1x_dualencoder/readme.md | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/keyboards/dumbpad/v1x_dualencoder/readme.md b/keyboards/dumbpad/v1x_dualencoder/readme.md new file mode 100644 index 000000000..b568351bf --- /dev/null +++ b/keyboards/dumbpad/v1x_dualencoder/readme.md | |||
@@ -0,0 +1,87 @@ | |||
1 | # dumbpad v1.x dual-encoder | ||
2 | |||
3 |  | ||
4 | |||
5 | ## Single- vs Dual-Encoder Support | ||
6 | |||
7 | The combined Cherry MX/encoder sockets allow single- and dual-encoder configurations. | ||
8 | |||
9 | The only rule when using two encoders is that there cannot be two encoders on the left side at once, or two on the right side. | ||
10 | This table shows where the encoders are in the switch grid ("X" for encoder, "s" for switch): | ||
11 | |||
12 | | C0 | C1 | C2 | C3 | C4 | | ||
13 | |:---:|:---:|:---:|:---:|:---:| | ||
14 | | |__X__| s | s |__X__| | ||
15 | | | s | s | s | s | | ||
16 | | | s | s | s | s | | ||
17 | |__X__|__X__| s | s |__X__| | ||
18 | |||
19 | - The three encoders in columns C0 and C1 are connected to each other | ||
20 | - The two encoders in column C4 are connected to each other | ||
21 | |||
22 | So, if doing dual encoders, one must be in column C4 and the other in either C0 or C1. Three or more encoders will not work. | ||
23 | |||
24 | The following sections describe the configurations that the default keymaps in QMK are designed for. | ||
25 | |||
26 | ### Single-Encoder (Default Configuration) | ||
27 | |||
28 | In the default configuration, the encoder is in column 0, the bottom left corner below the Pro Micro. All other sockets are filled with switches. | ||
29 | |||
30 | | C0 | C1 | C2 | C3 | C4 | | ||
31 | |:---:|:---:|:---:|:---:|:---:| | ||
32 | | | s | s | s | s | | ||
33 | | | s | s | s | s | | ||
34 | | | s | s | s | s | | ||
35 | |__X__| s | s | s | s | | ||
36 | |||
37 |  | ||
38 | |||
39 | ### Dual-Encoder Bottom | ||
40 | |||
41 | One dual-encoder configuration has encoders in the bottom two corners of the 4x4 grid, and switches in the rest of the grid. The socket in column 0 is left empty. | ||
42 | |||
43 | | C0 | C1 | C2 | C3 | C4 | | ||
44 | |:---:|:---:|:---:|:---:|:---:| | ||
45 | | | s | s | s | s | | ||
46 | | | s | s | s | s | | ||
47 | | | s | s | s | s | | ||
48 | | |__X__| s | s |__X__| | ||
49 | |||
50 |  | ||
51 | |||
52 | ### Dual-Encoder Top | ||
53 | |||
54 | Another dual-encoder configuration has encoders in the top two corners of the 4x4 grid, and switches in the rest of the grid. The socket in column 0 is left empty. | ||
55 | |||
56 | | C0 | C1 | C2 | C3 | C4 | | ||
57 | |:---:|:---:|:---:|:---:|:---:| | ||
58 | | |__X__| s | s |__X__| | ||
59 | | | s | s | s | s | | ||
60 | | | s | s | s | s | | ||
61 | | | s | s | s | s | | ||
62 | |||
63 |  | ||
64 | |||
65 | ### No-Encoder | ||
66 | |||
67 | You may also choose not to use any rotary encoders if you like! | ||
68 | |||
69 | ### Bill Of Materials | ||
70 | |||
71 | - Cherry-style mechanical switches | ||
72 | - EC11 rotary encoder with pushbutton (7-pin) - one or two depending on your desired configuration | ||
73 | - 1n4148 diodes (thru hole) - one per switch and rotary encoder (if using clickable encoder(s)) | ||
74 | - 1x Arduino Pro Micro or pin-compatible ATmega32u4-based MCU | ||
75 | - (optional) 3x 3mm LEDs | ||
76 | - (optional) 3x 330 ohm resistors (for limiting current in LEDs) | ||
77 | - (optional) 6mm SPST switch for resetting MCU | ||
78 | |||
79 | * Keyboard Maintainer: [imchipwood](https://github.com/imchipwood) | ||
80 | * Hardware repository: [dumbpad on github](https://github.com/imchipwood/dumbpad) | ||
81 | * PCB Revisions Supported: v1.0_dual | ||
82 | |||
83 | Make example for this keyboard (after setting up your build environment): | ||
84 | |||
85 | make dumbpad/v1x_dualencoder:default | ||
86 | |||
87 | 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). | ||