keyboards/deltasplit75/readme.md

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