keyboards/ergodox/readme.md

   1 ErgoDox
   2 ==
   3
   4 The ErgoDox is a split ergonomic keyboard originally developed by Dominic "Dox" Beauchamp.
   5
   6 * The **ErgoDox EZ** is a Teensy-based split mechanical keyboard, sold assembled and with warranty at [ErgoDox-EZ.com](https://ergodox-ez.com).
   7 * The **ErgoDox Infinity** is an ARM-based split mechanical keyboard, sold from time to time in kit form at [MassDrop.com](https://www.massdrop.com/buy/infinity-ergodox)
   8
   9 The ErgoDox EZ code is maintained by Erez Zukerman and is officially supported by the EZ -- the keyboard ships running QMK from the factory.
  10
  11 The ErgoDox Infinity code is maintained by Fredizzimo, as a community contribution.
  12
  13 ## Standard Build Instructions
  14
  15 To build QMK for the ErgoDox, see the official [build guide](/docs/build_guide.md).
  16
  17 ## Additional resources
  18
  19 A graphical configurator for the ErgoDox EZ is available at [configure.ergodox-ez.com](http://configure.ergodox-ez.com). It outputs QMK-compiled binaries, as well as source code for your layout, which you can use as a jumping-off point to further customize in QMK.
  20
  21 # Flashing Firmware
  22
  23 ## ErgoDox EZ
  24
  25 The Ez uses the [Teensy Loader](https://www.pjrc.com/teensy/loader.html).
  26
  27 Linux users need to modify udev rules as described on the [Teensy
  28 Linux page].  Some distributions provide a binary, maybe called
  29 `teensy-loader-cli`.
  30
  31 [Teensy Linux page]: https://www.pjrc.com/teensy/loader_linux.html
  32
  33 To flash the firmware:
  34
  35   - Build the firmware with `make keymapname`, for example `make default`
  36   - This will result in a hex file called `ergodox_ez_keymapname.hex`, e.g.
  37     `ergodox_ez_default.hex`
  38
  39   - Start the teensy loader.
  40
  41   - Load the .hex file into it.
  42
  43   - Press the Reset button by inserting a paperclip gently into the reset hole
  44     in the top right corder.
  45
  46   - Click the button in the Teensy app to download the firmware.
  47
  48 To flash with ´teensy-loader-cli´:
  49
  50   - Build the firmware with `make keymapname`, for example `make default`
  51
  52   - Run ´<path/to/>teensy_loader_cli -mmcu=atmega32u4 -w ergodox_ez_<keymap>.hex´
  53
  54   - Press the Reset button by inserting a paperclip gently into the reset hole
  55     in the top right corder.
  56
  57 ## ErgoDox Infinity
  58
  59 The Infinity is two completely independent keyboards, and needs to be flashed
  60 for the left and right halves seperately.  To flash them:
  61
  62   - Build the firmware with `make infinity-keymapname`
  63
  64   - Plug in the left hand keyboard only.
  65
  66   - Press the program button (back of keyboard, above thumb pad).
  67
  68   - Install the firmware with `sudo make infinity-keymapname-dfu-util`
  69
  70   - Build right hand firmware with `make infinity-keymapname MASTER=right`
  71
  72   - Plug in the right hand keyboard only.
  73
  74   - Press the program button (back of keyboard, above thumb pad).
  75
  76   - Install the firmware with `sudo make infinity-keymapname-dfu-util MASTER=right`
  77
  78 More information on the Infinity firmware is available in the [TMK/chibios for
  79 Input Club Infinity Ergodox](https://github.com/fredizzimo/infinity_ergodox/blob/master/README.md)
  80
  81 ### Infinity Master/Two Halves
  82
  83 The Infinity is two completely independent keyboards, that can connect together.
  84 You have a few options in how you flash the firmware:
  85
  86 - Flash the left half, rebuild the firmware with "MASTER=right" and then flash
  87   the right half.  This allows you to plug in either half directly to the
  88   computer and is what the above instructions do.
  89
  90 - Flash the left half, then flash the same firmware on the right.  This only
  91   works when the left half is plugged directly to the computer and the keymap
  92   is mirrored.  It saves the small extra step of rebuilding with
  93   "MASTER=right".
  94
  95 - The same as the previous one but with "MASTER=right" when you build the
  96   firmware, then flash the same firmware to both halves.  You just have to
  97   directly connect the right half to the computer.
  98
  99 - For minor changes such as changing only the keymap without having updated
 100   any part of the firmware code itself, you can program only the MASTER half.
 101   It is safest to program both halves though.
 102
 103 ## ErgoDone
 104
 105 The ErgoDone uses its own HID bootloader and needs to be flashed using the [TKG Toolkit](https://github.com/kairyu/tkg-toolkit).
 106
 107   - Build the firmware with `make ergodone-keymapname`
 108
 109   - While plugging in the USB cable, hold the two right-most keys on the left half of the ErgoDone to enter FLASH mode.
 110
 111   - Use the utility from [TKG Toolkit](https://github.com/kairyu/tkg-toolkit) to flash the keyboard: `hid_bootloader_cli -mmcu=atmega32u4 ergodox_ergodone_keymapname.hex`