4 This readme and most of the code are from https://github.com/ahtn/tmk_keyboard/
6 Split keyboard firmware for Arduino Pro Micro or other ATmega32u4
9 **Hardware files for the Let's Split are now stored at http://qmk.fm/lets_split/**
13 A build guide for putting together the Let's Split v2 can be found here: [An Overly Verbose Guide to Building a Let's Split Keyboard](https://github.com/nicinabox/lets-split-guide)
15 There is additional information there about flashing and adding RGB underglow.
19 Download or clone the whole firmware and navigate to the keyboards/lets_split directory. Once your dev env is setup, you'll be able to generate the default .hex using:
25 You will see a lot of output and if everything worked correctly you will see the built hex files:
28 lets_split_rev2_serial.hex
29 lets_split_rev2_i2c.hex
32 If you would like to use one of the alternative keymaps, or create your own, copy one of the existing [keymaps](keymaps/) and run make like so:
36 $ make rev2-YOUR_KEYMAP_NAME
39 If everything worked correctly you will see a file:
42 lets_split_rev2_YOUR_KEYMAP_NAME.hex
45 For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/readme.md##customizing-your-keymap) in the main readme.md.
48 If you have a first generation Let's Split you will need to use the revision 1 code. To do so, use `rev1` in all your commands instead.
53 For the full Quantum Mechanical Keyboard feature list, see [the parent readme.md](/readme.md).
55 Some features supported by the firmware:
57 * Either half can connect to the computer via USB, or both halves can be used
59 * You only need 3 wires to connect the two halves. Two for VCC and GND and one
60 for serial communication.
61 * Optional support for I2C connection between the two halves if for some
62 reason you require a faster connection between the two halves. Note this
63 requires an extra wire between halves and pull-up resistors on the data lines.
68 Apart from diodes and key switches for the keyboard matrix in each half, you
71 * 2 Arduino Pro Micro's. You can find theses on aliexpress for ≈3.50USD each.
72 * 2 TRRS sockets and 1 TRRS cable, or 2 TRS sockets and 1 TRS cable
74 Alternatively, you can use any sort of cable and socket that has at least 3
75 wires. If you want to use I2C to communicate between halves, you will need a
76 cable with at least 4 wires and 2x 4.7kΩ pull-up resistors
81 A speaker can be hooked-up to either side to the `5` (`C6`) pin and `GND`, and turned on via `AUDIO_ENABLE`.
86 The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and digital pin 3 (i.e.
87 PD0 on the ATmega32u4) between the two Pro Micros.
89 Then wire your key matrix to any of the remaining 17 IO pins of the pro micro
90 and modify the `matrix.c` accordingly.
92 The wiring for serial:
94 ![serial wiring](https://i.imgur.com/C3D1GAQ.png)
98 ![i2c wiring](https://i.imgur.com/Hbzhc6E.png)
100 The pull-up resistors may be placed on either half. It is also possible
101 to use 4 resistors and have the pull-ups in both halves, but this is
102 unnecessary in simple use cases.
104 Notes on Software Configuration
105 -------------------------------
107 Configuring the firmware is similar to any other QMK project. One thing
108 to note is that `MATIX_ROWS` in `config.h` is the total number of rows between
109 the two halves, i.e. if your split keyboard has 4 rows in each half, then
112 Also the current implementation assumes a maximum of 8 columns, but it would
113 not be very difficult to adapt it to support more if required.
117 From the keymap directory run `make SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing.
118 Example: `make rev2-serial-avrdude`
121 Choosing which board to plug the USB cable into (choosing Master)
123 Because the two boards are identical, the firmware has logic to differentiate the left and right board.
125 It uses two strategies to figure things out: look at the EEPROM (memory on the chip) or looks if the current board has the usb cable.
127 The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side.
129 The USB cable approach is easier to setup and if you just want the usb cable on the left board, you do not need to do anything extra.
131 ### Setting the left hand as master
132 If you always plug the usb cable into the left board, nothing extra is needed as this is the default. Comment out `EE_HANDS` and comment out `I2C_MASTER_RIGHT` or `MASTER_RIGHT` if for some reason it was set.
134 ### Setting the right hand as master
135 If you always plug the usb cable into the right board, add an extra flag to your `config.h`
140 ### Setting EE_hands to use either hands as master
141 If you define `EE_HANDS` in your `config.h`, you will need to set the
142 EEPROM for the left and right halves.
144 The EEPROM is used to store whether the
145 half is left handed or right handed. This makes it so that the same firmware
146 file will run on both hands instead of having to flash left and right handed
147 versions of the firmware to each half. To flash the EEPROM file for the left
150 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep
151 // or the equivalent in dfu-programmer
154 and similarly for right half
156 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep
157 // or the equivalent in dfu-programmer
160 NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
162 After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.
164 Note that you need to program both halves, but you have the option of using
165 different keymaps for each half. You could program the left half with a QWERTY
166 layout and the right half with a Colemak layout using bootmagic's default layout option.
167 Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
168 right half is connected.
171 Notes on Using Pro Micro 3.3V
172 -----------------------------
174 Do update the `F_CPU` parameter in `rules.mk` to `8000000` which reflects
175 the frequency on the 3.3V board.
177 Also, if the slave board is producing weird characters in certain columns,
178 update the following line in `matrix.c` to the following:
181 // _delay_us(30); // without this wait read unstable value.
182 _delay_us(300); // without this wait read unstable value.