aboutsummaryrefslogtreecommitdiff
path: root/keyboards/lets_split/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/lets_split/readme.md')
-rw-r--r--keyboards/lets_split/readme.md86
1 files changed, 72 insertions, 14 deletions
diff --git a/keyboards/lets_split/readme.md b/keyboards/lets_split/readme.md
index a63ce5907..ecce3f415 100644
--- a/keyboards/lets_split/readme.md
+++ b/keyboards/lets_split/readme.md
@@ -6,9 +6,45 @@ This readme and most of the code are from https://github.com/ahtn/tmk_keyboard/
6Split keyboard firmware for Arduino Pro Micro or other ATmega32u4 6Split keyboard firmware for Arduino Pro Micro or other ATmega32u4
7based boards. 7based boards.
8 8
9
10## First Time Setup
11
12Download 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:
13
14```
15$ make rev2
16```
17
18You will see a lot of output and if everything worked correctly you will see the built hex files:
19
20```
21lets_split_rev2_serial.hex
22lets_split_rev2_i2c.hex
23```
24
25If 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:
26
27
28```
29$ make rev2-YOUR_KEYMAP_NAME
30```
31
32If everything worked correctly you will see a file:
33
34```
35lets_split_rev2_YOUR_KEYMAP_NAME.hex
36```
37
38For 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.
39
40### Let's split 1.0
41If 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.
42
9Features 43Features
10-------- 44--------
11 45
46For the full Quantum Mechanical Keyboard feature list, see [the parent readme.md](/readme.md).
47
12Some features supported by the firmware: 48Some features supported by the firmware:
13 49
14* Either half can connect to the computer via USB, or both halves can be used 50* Either half can connect to the computer via USB, or both halves can be used
@@ -62,7 +98,7 @@ unnecessary in simple use cases.
62Notes on Software Configuration 98Notes on Software Configuration
63------------------------------- 99-------------------------------
64 100
65Configuring the firmware is similar to any other TMK project. One thing 101Configuring the firmware is similar to any other QMK project. One thing
66to note is that `MATIX_ROWS` in `config.h` is the total number of rows between 102to 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 103the two halves, i.e. if your split keyboard has 4 rows in each half, then
68`MATRIX_ROWS=8`. 104`MATRIX_ROWS=8`.
@@ -70,37 +106,59 @@ the two halves, i.e. if your split keyboard has 4 rows in each half, then
70Also the current implementation assumes a maximum of 8 columns, but it would 106Also the current implementation assumes a maximum of 8 columns, but it would
71not be very difficult to adapt it to support more if required. 107not be very difficult to adapt it to support more if required.
72 108
73
74Flashing 109Flashing
110-------
111From the keymap directory run `make SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing.
112Example: `make rev2-serial-avrdude`
113
114
115Choosing which board to plug the USB cable into (choosing Master)
75-------- 116--------
117Because the two boards are identical, the firmware has logic to differentiate the left and right board.
76 118
77From the keymap directory run `make SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing. 119It 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.
78 120
79Example: `make rev2-serial-avrdude` 121The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side.
122
123The 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.
80 124
125### Setting the left hand as master
126If 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.
127
128### Setting the right hand as master
129If you always plug the usb cable into the right board, add an extra flag to your `config.h`
130```
131 #define MASTER_RIGHT
132```
133
134### Setting EE_hands to use either hands as master
81If you define `EE_HANDS` in your `config.h`, you will need to set the 135If you define `EE_HANDS` in your `config.h`, you will need to set the
82EEPROM for the left and right halves. The EEPROM is used to store whether the 136EEPROM for the left and right halves.
137
138The EEPROM is used to store whether the
83half is left handed or right handed. This makes it so that the same firmware 139half is left handed or right handed. This makes it so that the same firmware
84file will run on both hands instead of having to flash left and right handed 140file will run on both hands instead of having to flash left and right handed
85versions of the firmware to each half. To flash the EEPROM file for the left 141versions of the firmware to each half. To flash the EEPROM file for the left
86half run: 142half run:
87``` 143```
88make eeprom-left 144avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep
145// or the equivalent in dfu-programmer
146
89``` 147```
90and similarly for right half 148and similarly for right half
91``` 149```
92make eeprom-right 150avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep
151// or the equivalent in dfu-programmer
93``` 152```
94 153
95After you have flashed the EEPROM for the first time, you then need to program 154NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
96the flash memory: 155
97``` 156After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.
98make program 157
99```
100Note that you need to program both halves, but you have the option of using 158Note that you need to program both halves, but you have the option of using
101different keymaps for each half. You could program the left half with a QWERTY 159different keymaps for each half. You could program the left half with a QWERTY
102layout and the right half with a Colemak layout. Then if you connect the left 160layout and the right half with a Colemak layout using bootmagic's default layout option.
103half to a computer by USB the keyboard will use QWERTY and Colemak when the 161Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
104right half is connected. 162right half is connected.
105 163
106 164