keyboards/DeltaSplit75/readme.md

   1 DeltaSplit75
   2 ======
   3
   4 This readme and most of the code are from https://github.com/ahtn/tmk_keyboard/ and https://github.com/qmk/qmk_firmware/tree/master/keyboards/lets_split
   5
   6 Credit to ahtn and wootpatoot for work on the split keyboard firmware
   7
   8 Split keyboard firmware for Arduino Pro Micro or other ATmega32u4
   9 based boards.
  10
  11
  12 ## First Time Setup
  13
  14 Download or clone the whole firmware and navigate to the keyboards/DeltaSplit75 directory. Once your dev env is setup, you'll be able to generate the default .hex using:
  15
  16 ```
  17 $ make V2
  18
  19 or
  20
  21 $ make ProtoSplit (if you have one of the prototype PCBs)
  22 ```
  23
  24 You will see a lot of output and if everything worked correctly you will see the built hex files:
  25
  26 ```
  27 DeltaSplit75_ProtoSplit_Default
  28
  29 or
  30
  31 DeltaSplit75_V2_Default.hex
  32
  33 ```
  34
  35
  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 ### DeltaSplit75 V2
  41 The PCBs available in groupbuy are all v2, if you've bought one of my prototype PCBs (it says DeltaSplit65 on the silkscreen instead of 75), use the code $make ProtoSplit 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 * 75% formfactor
  53 * Support for multiple Bottom Rows
  54 * RGB underglow support
  55 * Split Backspace and ISO support
  56
  57
  58   Flashing
  59 -------
  60 I personally use xLoader to upload my hex files to the keyboard, though any other working software is fine too
  61
  62
  63 Choosing which board to plug the USB cable into (choosing Master)
  64 --------
  65 Because the two boards are identical, the firmware has logic to differentiate the left and right board.
  66
  67 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.
  68
  69 The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side.
  70
  71 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.
  72
  73 ### Setting the left hand as master
  74 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.
  75
  76 ### Setting the right hand as master
  77 If you always plug the usb cable into the right board, add an extra flag to your `config.h`
  78 ```
  79  #define MASTER_RIGHT
  80 ```
  81
  82 ### Setting EE_hands to use either hands as master
  83 If you define `EE_HANDS` in your `config.h`, you will need to set the
  84 EEPROM for the left and right halves.
  85
  86 The EEPROM is used to store whether the
  87 half is left handed or right handed. This makes it so that the same firmware
  88 file will run on both hands instead of having to flash left and right handed
  89 versions of the firmware to each half. To flash the EEPROM file for the left
  90 half run:
  91 ```
  92 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep
  93 // or the equivalent in dfu-programmer
  94
  95 ```
  96 and similarly for right half
  97 ```
  98 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep
  99 // or the equivalent in dfu-programmer
 100 ```
 101
 102 NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
 103
 104 After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.
 105
 106 Note that you need to program both halves, but you have the option of using
 107 different keymaps for each half. You could program the left half with a QWERTY
 108 layout and the right half with a Colemak layout using bootmagic's default layout option.
 109 Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
 110 right half is connected.
 111
 112
 113 Notes on Using Pro Micro 3.3V
 114 -----------------------------
 115
 116 Do update the `F_CPU` parameter in `rules.mk` to `8000000` which reflects
 117 the frequency on the 3.3V board.
 118
 119 Also, if the slave board is producing weird characters in certain columns,
 120 update the following line in `matrix.c` to the following:
 121
 122 ```
 123 // _delay_us(30);  // without this wait read unstable value.
 124 _delay_us(300);  // without this wait read unstable value.
 125 ```