aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlbert Y <76888457+filterpaper@users.noreply.github.com>2022-01-13 06:05:45 +0800
committerGitHub <noreply@github.com>2022-01-12 14:05:45 -0800
commitc4b0a06c798432173ce1f7a18602410c03a45415 (patch)
tree8ea9da157b83584778a16dce49b6ed37fa133dd8
parent93e55605d9f2de7f214a003058bcefbb5a5a0e00 (diff)
downloadqmk_firmware-c4b0a06c798432173ce1f7a18602410c03a45415.tar.gz
qmk_firmware-c4b0a06c798432173ce1f7a18602410c03a45415.zip
[Docs] Improve Handedness by EEPROM documentation (#15615)
Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com> Co-authored-by: filterpaper <filterpaper@localhost>
-rw-r--r--docs/feature_split_keyboard.md25
1 files changed, 16 insertions, 9 deletions
diff --git a/docs/feature_split_keyboard.md b/docs/feature_split_keyboard.md
index c8ba18bee..dbc7740f9 100644
--- a/docs/feature_split_keyboard.md
+++ b/docs/feature_split_keyboard.md
@@ -130,14 +130,17 @@ To enable this method, add the following to your `config.h` file:
130#define EE_HANDS 130#define EE_HANDS
131``` 131```
132 132
133However, you'll have to flash the EEPROM files for the correct hand to each controller. You can do this manually, or there are targets for avrdude and dfu to do this, while flashing the firmware: 133Next, you will have to flash the EEPROM files once for the correct hand to the controller on each halve. You can do this manually with the following bootloader targets while flashing the firmware:
134 134
135* `:avrdude-split-left` 135* AVR controllers with the Caterina bootloader (e.g. Pro Micro):
136* `:avrdude-split-right` 136 * `:avrdude-split-left`
137* `:dfu-split-left` 137 * `:avrdude-split-right`
138* `:dfu-split-right` 138* AVR controllers with the stock Amtel DFU or DFU compatible bootloader (e.g. Elite-C):
139* `:dfu-util-split-left` 139 * `:dfu-split-left`
140* `:dfu-util-split-right` 140 * `:dfu-split-right`
141* ARM controllers with a DFU compatible bootloader (e.g. Proton-C):
142 * `:dfu-util-split-left`
143 * `:dfu-util-split-right`
141 144
142Example: 145Example:
143 146
@@ -145,9 +148,13 @@ Example:
145make crkbd:default:avrdude-split-left 148make crkbd:default:avrdude-split-left
146``` 149```
147 150
151?> ARM controllers using `dfu-util` will require an EEPROM reset after setting handedness. This can be done using the `EEP_RST` keycode or [Bootmagic Lite](feature_bootmagic.md). Controllers using emulated EEPROM will always require handedness parameter when flashing the firmware.
152
153?> [QMK Toolbox]() can also be used to flash EEPROM handedness files. Place the controller in bootloader mode and select menu option Tools -> EEPROM -> Set Left/Right Hand
154
148This setting is not changed when re-initializing the EEPROM using the `EEP_RST` key, or using the `eeconfig_init()` function. However, if you reset the EEPROM outside of the firmware's built in options (such as flashing a file that overwrites the `EEPROM`, like how the [QMK Toolbox]()'s "Reset EEPROM" button works), you'll need to re-flash the controller with the `EEPROM` files. 155This setting is not changed when re-initializing the EEPROM using the `EEP_RST` key, or using the `eeconfig_init()` function. However, if you reset the EEPROM outside of the firmware's built in options (such as flashing a file that overwrites the `EEPROM`, like how the [QMK Toolbox]()'s "Reset EEPROM" button works), you'll need to re-flash the controller with the `EEPROM` files.
149 156
150You can find the `EEPROM` files in the QMK firmware repo, [here](https://github.com/qmk/qmk_firmware/tree/master/quantum/split_common). 157You can find the `EEPROM` files in the QMK firmware repo, [here](https://github.com/qmk/qmk_firmware/tree/master/quantum/split_common).
151 158
152#### Handedness by `#define` 159#### Handedness by `#define`
153 160