aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_bootmagic.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature_bootmagic.md')
-rw-r--r--docs/feature_bootmagic.md19
1 files changed, 15 insertions, 4 deletions
diff --git a/docs/feature_bootmagic.md b/docs/feature_bootmagic.md
index 54ebd0867..f084052cc 100644
--- a/docs/feature_bootmagic.md
+++ b/docs/feature_bootmagic.md
@@ -123,7 +123,7 @@ If you would like to change the hotkey assignments for Bootmagic, `#define` thes
123 123
124# Bootmagic Lite :id=bootmagic-lite 124# Bootmagic Lite :id=bootmagic-lite
125 125
126In addition to the full blown Bootmagic feature, is the Bootmagic Lite feature that only handles jumping into the bootloader. This is great for boards that don't have a physical reset button but you need a way to jump into the bootloader, and don't want to deal with the headache that Bootmagic can cause. 126In addition to the full blown Bootmagic feature, is the Bootmagic Lite feature that only handles jumping into the bootloader. This is great for boards that don't have a physical reset button but you need a way to jump into the bootloader, and don't want to deal with the headache that Bootmagic can cause.
127 127
128To enable this version of Bootmagic, you need to enable it in your `rules.mk` with: 128To enable this version of Bootmagic, you need to enable it in your `rules.mk` with:
129 129
@@ -131,7 +131,7 @@ To enable this version of Bootmagic, you need to enable it in your `rules.mk` wi
131BOOTMAGIC_ENABLE = lite 131BOOTMAGIC_ENABLE = lite
132``` 132```
133 133
134Additionally, you may want to specify which key to use. This is especially useful for keyboards that have unusual matrices. To do so, you need to specify the row and column of the key that you want to use. Add these entries to your `config.h` file: 134Additionally, you may want to specify which key to use. This is especially useful for keyboards that have unusual matrices. To do so, you need to specify the row and column of the key that you want to use. Add these entries to your `config.h` file:
135 135
136```c 136```c
137#define BOOTMAGIC_LITE_ROW 0 137#define BOOTMAGIC_LITE_ROW 0
@@ -144,9 +144,20 @@ And to trigger the bootloader, you hold this key down when plugging the keyboard
144 144
145!> Using bootmagic lite will **always reset** the EEPROM, so you will lose any settings that have been saved. 145!> Using bootmagic lite will **always reset** the EEPROM, so you will lose any settings that have been saved.
146 146
147## Split Keyboards
148
149When handedness is predetermined via an option like `SPLIT_HAND_PIN`, you might need to configure a different key between halves. This To do so, add these entries to your `config.h` file:
150
151```c
152#define BOOTMAGIC_LITE_ROW_RIGHT 4
153#define BOOTMAGIC_LITE_COLUMN_RIGHT 1
154```
155
156By default, these values are not set.
157
147## Advanced Bootmagic Lite 158## Advanced Bootmagic Lite
148 159
149The `bootmagic_lite` function is defined weakly, so that you can replace this in your code, if you need. A great example of this is the Zeal60 boards that have some additional handling needed. 160The `bootmagic_lite` function is defined weakly, so that you can replace this in your code, if you need. A great example of this is the Zeal60 boards that have some additional handling needed.
150 161
151To replace the function, all you need to do is add something like this to your code: 162To replace the function, all you need to do is add something like this to your code:
152 163
@@ -163,4 +174,4 @@ void bootmagic_lite(void) {
163} 174}
164``` 175```
165 176
166You can additional feature here. For instance, resetting the eeprom or requiring additional keys to be pressed to trigger bootmagic. Keep in mind that `bootmagic_lite` is called before a majority of features are initialized in the firmware. 177You can additional feature here. For instance, resetting the eeprom or requiring additional keys to be pressed to trigger bootmagic. Keep in mind that `bootmagic_lite` is called before a majority of features are initialized in the firmware.