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 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.
  37
  38 ### DeltaSplit75 V2
  39 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
  40
  41 Features
  42 --------
  43
  44 For the full Quantum Mechanical Keyboard feature list, see [the parent readme.md](/readme.md).
  45
  46 Some features supported by the firmware:
  47
  48 * Either half can connect to the computer via USB, or both halves can be used
  49   independently.
  50 * 75% formfactor
  51 * Support for multiple Bottom Rows
  52 * RGB underglow support
  53 * Split Backspace and ISO support
  54
  55
  56 Flashing
  57 -------
  58 I personally use xLoader to upload my hex files to the keyboard, though any other working software is fine too
  59
  60
  61 Choosing which board to plug the USB cable into (choosing Master)
  62 --------
  63 Because the two boards are identical, the firmware has logic to differentiate the left and right board.
  64
  65 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.
  66
  67 The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side.
  68
  69 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.
  70
  71 ### Setting the left hand as master
  72 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.
  73
  74 ### Setting the right hand as master
  75 If you always plug the usb cable into the right board, add an extra flag to your `config.h`
  76 ```
  77  #define MASTER_RIGHT
  78 ```
  79
  80 ### Setting EE_hands to use either hands as master
  81 If you define `EE_HANDS` in your `config.h`, you will need to set the
  82 EEPROM for the left and right halves.
  83
  84 The EEPROM is used to store whether the
  85 half is left handed or right handed. This makes it so that the same firmware
  86 file will run on both hands instead of having to flash left and right handed
  87 versions of the firmware to each half. To flash the EEPROM file for the left
  88 half run:
  89 ```
  90 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep
  91 // or the equivalent in dfu-programmer
  92
  93 ```
  94 and similarly for right half
  95 ```
  96 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep
  97 // or the equivalent in dfu-programmer
  98 ```
  99
 100 NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
 101
 102 After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.
 103
 104 Note that you need to program both halves, but you have the option of using
 105 different keymaps for each half. You could program the left half with a QWERTY
 106 layout and the right half with a Colemak layout using bootmagic's default layout option.
 107 Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
 108 right half is connected.
 109
 110
 111 Notes on Using Pro Micro 3.3V
 112 -----------------------------
 113
 114 Do update the `F_CPU` parameter in `rules.mk` to `8000000` which reflects
 115 the frequency on the 3.3V board.
 116
 117 Also, if the slave board is producing weird characters in certain columns,
 118 update the following line in `matrix.c` to the following:
 119
 120 ```
 121 // _delay_us(30);  // without this wait read unstable value.
 122 _delay_us(300);  // without this wait read unstable value.
 123 ```