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