keyboards/lets_split/readme.md

   1 Let's Split
   2 ======
   3
   4 This readme and most of the code are from https://github.com/ahtn/tmk_keyboard/
   5
   6 Split keyboard firmware for Arduino Pro Micro or other ATmega32u4
   7 based boards.
   8
   9
  10 ## First Time Setup
  11
  12 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:
  13
  14 ```
  15 $ make rev2
  16 ```
  17
  18 You will see a lot of output and if everything worked correctly you will see the built hex files:
  19
  20 ```
  21 lets_split_rev2_serial.hex
  22 lets_split_rev2_i2c.hex
  23 ```
  24
  25 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:
  26
  27
  28 ```
  29 $ make rev2-YOUR_KEYMAP_NAME
  30 ```
  31
  32 If everything worked correctly you will see a file:
  33
  34 ```
  35 lets_split_rev2_YOUR_KEYMAP_NAME.hex
  36 ```
  37
  38 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.
  39
  40 ### Let's split 1.0
  41 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.
  42
  43 Features
  44 --------
  45
  46 For the full Quantum Mechanical Keyboard feature list, see [the parent readme.md](/readme.md).
  47
  48 Some features supported by the firmware:
  49
  50 * Either half can connect to the computer via USB, or both halves can be used
  51   independently.
  52 * You only need 3 wires to connect the two halves. Two for VCC and GND and one
  53   for serial communication.
  54 * Optional support for I2C connection between the two halves if for some
  55   reason you require a faster connection between the two halves. Note this
  56   requires an extra wire between halves and pull-up resistors on the data lines.
  57
  58 Required Hardware
  59 -----------------
  60
  61 Apart from diodes and key switches for the keyboard matrix in each half, you
  62 will need:
  63
  64 * 2 Arduino Pro Micro's. You can find theses on aliexpress for ≈3.50USD each.
  65 * 2 TRS sockets
  66 * 1 TRS cable.
  67
  68 Alternatively, you can use any sort of cable and socket that has at least 3
  69 wires. If you want to use I2C to communicate between halves, you will need a
  70 cable with at least 4 wires and 2x 4.7kΩ pull-up resistors
  71
  72 Optional Hardware
  73 -----------------
  74
  75 A speaker can be hooked-up to either side to the `5` (`C6`) pin and `GND`, and turned on via `AUDIO_ENABLE`.
  76
  77 Wiring
  78 ------
  79
  80 The 3 wires of the TRS cable need to connect GND, VCC, and digital pin 3 (i.e.
  81 PD0 on the ATmega32u4) between the two Pro Micros.
  82
  83 Then wire your key matrix to any of the remaining 17 IO pins of the pro micro
  84 and modify the `matrix.c` accordingly.
  85
  86 The wiring for serial:
  87
  88 ![serial wiring](imgs/split-keyboard-serial-schematic.png)
  89
  90 The wiring for i2c:
  91
  92 ![i2c wiring](imgs/split-keyboard-i2c-schematic.png)
  93
  94 The pull-up resistors may be placed on either half. It is also possible
  95 to use 4 resistors and have the pull-ups in both halves, but this is
  96 unnecessary in simple use cases.
  97
  98 Notes on Software Configuration
  99 -------------------------------
 100
 101 Configuring the firmware is similar to any other QMK project. One thing
 102 to note is that `MATIX_ROWS` in `config.h` is the total number of rows between
 103 the two halves, i.e. if your split keyboard has 4 rows in each half, then
 104 `MATRIX_ROWS=8`.
 105
 106 Also the current implementation assumes a maximum of 8 columns, but it would
 107 not be very difficult to adapt it to support more if required.
 108
 109 Flashing
 110 -------
 111 From the keymap directory run `make SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing.
 112 Example: `make rev2-serial-avrdude`
 113
 114
 115 Choosing which board to plug the USB cable into (choosing Master)
 116 --------
 117 Because the two boards are identical, the firmware has logic to differentiate the left and right board.
 118
 119 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.
 120
 121 The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side.
 122
 123 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.
 124
 125 ### Setting the left hand as master
 126 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.
 127
 128 ### Setting the right hand as master
 129 If 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
 135 If you define `EE_HANDS` in your `config.h`, you will need to set the
 136 EEPROM for the left and right halves.
 137
 138 The EEPROM is used to store whether the
 139 half is left handed or right handed. This makes it so that the same firmware
 140 file will run on both hands instead of having to flash left and right handed
 141 versions of the firmware to each half. To flash the EEPROM file for the left
 142 half run:
 143 ```
 144 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep
 145 // or the equivalent in dfu-programmer
 146
 147 ```
 148 and similarly for right half
 149 ```
 150 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep
 151 // or the equivalent in dfu-programmer
 152 ```
 153
 154 NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
 155
 156 After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.
 157
 158 Note that you need to program both halves, but you have the option of using
 159 different keymaps for each half. You could program the left half with a QWERTY
 160 layout and the right half with a Colemak layout using bootmagic's default layout option.
 161 Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
 162 right half is connected.
 163
 164
 165 Notes on Using Pro Micro 3.3V
 166 -----------------------------
 167
 168 Do update the `F_CPU` parameter in `rules.mk` to `8000000` which reflects
 169 the frequency on the 3.3V board.
 170
 171 Also, if the slave board is producing weird characters in certain columns,
 172 update the following line in `matrix.c` to the following:
 173
 174 ```
 175 // _delay_us(30);  // without this wait read unstable value.
 176 _delay_us(300);  // without this wait read unstable value.
 177 ```