aboutsummaryrefslogtreecommitdiff
path: root/keyboards/lets_splitv2/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/lets_splitv2/readme.md')
-rw-r--r--keyboards/lets_splitv2/readme.md102
1 files changed, 102 insertions, 0 deletions
diff --git a/keyboards/lets_splitv2/readme.md b/keyboards/lets_splitv2/readme.md
new file mode 100644
index 000000000..73fdb0f78
--- /dev/null
+++ b/keyboards/lets_splitv2/readme.md
@@ -0,0 +1,102 @@
1Let's Split
2======
3
4This readme and most of the code are from https://github.com/ahtn/tmk_keyboard/
5
6Split keyboard firmware for Arduino Pro Micro or other ATmega32u4
7based boards.
8
9Features
10--------
11
12Some features supported by the firmware:
13
14* Either half can connect to the computer via USB, or both halves can be used
15 independently.
16* You only need 3 wires to connect the two halves. Two for VCC and GND and one
17 for serial communication.
18* Optional support for I2C connection between the two halves if for some
19 reason you require a faster connection between the two halves. Note this
20 requires an extra wire between halves and pull-up resistors on the data lines.
21
22Required Hardware
23-----------------
24
25Apart from diodes and key switches for the keyboard matrix in each half, you
26will need:
27
28* 2 Arduino Pro Micro's. You can find theses on aliexpress for ≈3.50USD each.
29* 2 TRS sockets
30* 1 TRS cable.
31
32Alternatively, you can use any sort of cable and socket that has at least 3
33wires. If you want to use I2C to communicate between halves, you will need a
34cable with at least 4 wires and 2x 4.7kΩ pull-up resistors
35
36Optional Hardware
37-----------------
38
39A speaker can be hooked-up to either side to the `5` (`C6`) pin and `GND`, and turned on via `AUDIO_ENABLE`.
40
41Wiring
42------
43
44The 3 wires of the TRS cable need to connect GND, VCC, and digital pin 3 (i.e.
45PD0 on the ATmega32u4) between the two Pro Micros.
46
47Then wire your key matrix to any of the remaining 17 IO pins of the pro micro
48and modify the `matrix.c` accordingly.
49
50The wiring for serial:
51
52![serial wiring](imgs/split-keyboard-serial-schematic.png)
53
54The wiring for i2c:
55
56![i2c wiring](imgs/split-keyboard-i2c-schematic.png)
57
58The pull-up resistors may be placed on either half. It is also possible
59to use 4 resistors and have the pull-ups in both halves, but this is
60unnecessary in simple use cases.
61
62Notes on Software Configuration
63-------------------------------
64
65Configuring the firmware is similar to any other TMK project. One thing
66to note is that `MATIX_ROWS` in `config.h` is the total number of rows between
67the two halves, i.e. if your split keyboard has 4 rows in each half, then
68`MATRIX_ROWS=8`.
69
70Also the current implementation assumes a maximum of 8 columns, but it would
71not be very difficult to adapt it to support more if required.
72
73
74Flashing
75--------
76
77If you define `EE_HANDS` in your `config.h`, you will need to set the
78EEPROM for the left and right halves. The EEPROM is used to store whether the
79half is left handed or right handed. This makes it so that the same firmware
80file will run on both hands instead of having to flash left and right handed
81versions of the firmware to each half. To flash the EEPROM file for the left
82half run:
83```
84make eeprom-left
85```
86and similarly for right half
87```
88make eeprom-right
89```
90
91After you have flashed the EEPROM for the first time, you then need to program
92the flash memory:
93```
94make program
95```
96Note that you need to program both halves, but you have the option of using
97different keymaps for each half. You could program the left half with a QWERTY
98layout and the right half with a Colemak layout. Then if you connect the left
99half to a computer by USB the keyboard will use QWERTY and Colemak when the
100right half is connected.
101
102