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 Features
  10 --------
  11
  12 Some 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
  22 Required Hardware
  23 -----------------
  24
  25 Apart from diodes and key switches for the keyboard matrix in each half, you
  26 will 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
  32 Alternatively, you can use any sort of cable and socket that has at least 3
  33 wires. If you want to use I2C to communicate between halves, you will need a
  34 cable with at least 4 wires and 2x 4.7kΩ pull-up resistors
  35
  36 Optional Hardware
  37 -----------------
  38
  39 A speaker can be hooked-up to either side to the `5` (`C6`) pin and `GND`, and turned on via `AUDIO_ENABLE`.
  40
  41 Wiring
  42 ------
  43
  44 The 3 wires of the TRS cable need to connect GND, VCC, and digital pin 3 (i.e.
  45 PD0 on the ATmega32u4) between the two Pro Micros.
  46
  47 Then wire your key matrix to any of the remaining 17 IO pins of the pro micro
  48 and modify the `matrix.c` accordingly.
  49
  50 The wiring for serial:
  51
  52 ![serial wiring](imgs/split-keyboard-serial-schematic.png)
  53
  54 The wiring for i2c:
  55
  56 ![i2c wiring](imgs/split-keyboard-i2c-schematic.png)
  57
  58 The pull-up resistors may be placed on either half. It is also possible
  59 to use 4 resistors and have the pull-ups in both halves, but this is
  60 unnecessary in simple use cases.
  61
  62 Notes on Software Configuration
  63 -------------------------------
  64
  65 Configuring the firmware is similar to any other TMK project. One thing
  66 to note is that `MATIX_ROWS` in `config.h` is the total number of rows between
  67 the two halves, i.e. if your split keyboard has 4 rows in each half, then
  68 `MATRIX_ROWS=8`.
  69
  70 Also the current implementation assumes a maximum of 8 columns, but it would
  71 not be very difficult to adapt it to support more if required.
  72
  73
  74 Flashing
  75 --------
  76
  77 If you define `EE_HANDS` in your `config.h`, you will need to set the
  78 EEPROM for the left and right halves. The EEPROM is used to store whether the
  79 half is left handed or right handed. This makes it so that the same firmware
  80 file will run on both hands instead of having to flash left and right handed
  81 versions of the firmware to each half. To flash the EEPROM file for the left
  82 half run:
  83 ```
  84 make eeprom-left
  85 ```
  86 and similarly for right half
  87 ```
  88 make eeprom-right
  89 ```
  90
  91 After you have flashed the EEPROM for the first time, you then need to program
  92 the flash memory:
  93 ```
  94 make program
  95 ```
  96 Note that you need to program both halves, but you have the option of using
  97 different keymaps for each half. You could program the left half with a QWERTY
  98 layout and the right half with a Colemak layout. Then if you connect the left
  99 half to a computer by USB the keyboard will use QWERTY and Colemak when the
 100 right half is connected.
 101
 102