qmk-keychron-q3-colemak-dh/keyboards/ergodox_infinity/readme.md
Joakim Tufvegren cacf495c91
Ergodox Infinity: Add EE_HANDS support. (#9527)
Including a guide to set these EEPROM values (in the readme).
2020-10-11 01:48:52 +01:00

81 lines
3.5 KiB
Markdown

# ErgoDox Infinity
The Infinity is two completely independent keyboards, and needs to be flashed
for the left and right halves seperately. To flash them:
- Make sure you are in the top-level qmk_firmware directory
- Build the firmware with `make ergodox_infinity:keymapname`
- Plug in the left hand keyboard only.
- Press the program button (back of keyboard, above thumb pad).
- Install the firmware with `sudo make ergodox_infinity:keymapname:dfu-util`
- Build right hand firmware with `make ergodox_infinity:keymapname MASTER=right`
- Plug in the right hand keyboard only.
- Press the program button (back of keyboard, above thumb pad).
- Install the firmware with `sudo make ergodox_infinity:keymapname:dfu-util MASTER=right`
More information on the Infinity firmware is available in the [TMK/chibios for
Input Club Infinity Ergodox](https://github.com/fredizzimo/infinity_ergodox/blob/master/README.md)
## Infinity Master/Two Halves
The Infinity is two completely independent keyboards, that can connect together.
You have a few options in how you flash the firmware:
- Add `#define EE_HANDS` to your config.h, initialize the EEPROM values (see below),
and then flash the same firmware to both halves.
- Flash the left half, rebuild the firmware with "MASTER=right" and then flash
the right half. This allows you to plug in either half directly to the
computer and is what the above instructions do.
- Flash the left half, then flash the same firmware on the right. This only
works when the left half is plugged directly to the computer and the keymap
is mirrored. It saves the small extra step of rebuilding with
"MASTER=right".
- The same as the previous one but with "MASTER=right" when you build the
firmware, then flash the same firmware to both halves. You just have to
directly connect the right half to the computer.
- For minor changes such as changing only the keymap without having updated
any part of the firmware code itself, you can program only the MASTER half,
but it is safest to program both halves.
### EE_HANDS initialization
To initialize the EEPROM values for `EE_HANDS` to work properly, these steps should work.
They only need to be done once, unless you reset the EEPROM later.
- Plug in the left keyboard half to the computer, and press its program button.
- Flash the left half with `make ergodox_infinity:default:dfu-util-split-left`
(If you need to use a different method to flash your keyboard, still run this command,
and abort it with Ctrl+C when the flashing attempts starts to print errors,
then flash the built firmware).
- On the left half, press the top vertical 1.5U key (second from the top in the rightmost column) once,
then the 1U key at the bottom in the opposite corner (bottom left corner).
- Plug in the right keyboard half to the computer, and press its program button.
- Flash the right half with `make ergodox_infinity:default:dfu-util-split-right`
- On the right half, press the top vertical 1.5U key (second from the top in the leftmost column) once,
then the 1U key at the bottom in the opposite corner (bottom right corner).
- Add `#define EE_HANDS` to the config.h file of your keymap, and build your firmware using
`make ergodox_infinity:keymapname`.
- After this, you can flash both halves with the same firmware, _without_ having to rebuild with
"MASTER=right" or risking a mirrored keyboard when connected the wrong way.
If you reset your EEPROM later, you'll have to follow these steps again, though.