mirror of
https://github.com/Keychron/qmk_firmware.git
synced 2024-11-22 00:16:41 +06:00
[Docs] Remove references to bootmagic lite (#24369)
This commit is contained in:
parent
c44f5375ab
commit
f043545144
|
@ -167,7 +167,7 @@
|
||||||
},
|
},
|
||||||
{ "text": "Audio", "link": "/features/audio" },
|
{ "text": "Audio", "link": "/features/audio" },
|
||||||
{ "text": "Bluetooth", "link": "/features/bluetooth" },
|
{ "text": "Bluetooth", "link": "/features/bluetooth" },
|
||||||
{ "text": "Bootmagic Lite", "link": "/features/bootmagic" },
|
{ "text": "Bootmagic", "link": "/features/bootmagic" },
|
||||||
{ "text": "Converters", "link": "/feature_converters" },
|
{ "text": "Converters", "link": "/feature_converters" },
|
||||||
{ "text": "Custom Matrix", "link": "/custom_matrix" },
|
{ "text": "Custom Matrix", "link": "/custom_matrix" },
|
||||||
{ "text": "DIP Switch", "link": "/features/dip_switch" },
|
{ "text": "DIP Switch", "link": "/features/dip_switch" },
|
||||||
|
|
|
@ -413,7 +413,7 @@ Use these to enable or disable building certain features. The more you have enab
|
||||||
* `MAGIC_ENABLE`
|
* `MAGIC_ENABLE`
|
||||||
* MAGIC actions (BOOTMAGIC without the boot)
|
* MAGIC actions (BOOTMAGIC without the boot)
|
||||||
* `BOOTMAGIC_ENABLE`
|
* `BOOTMAGIC_ENABLE`
|
||||||
* Enable Bootmagic Lite
|
* Enable Bootmagic
|
||||||
* `MOUSEKEY_ENABLE`
|
* `MOUSEKEY_ENABLE`
|
||||||
* Mouse keys
|
* Mouse keys
|
||||||
* `EXTRAKEY_ENABLE`
|
* `EXTRAKEY_ENABLE`
|
||||||
|
|
|
@ -8,8 +8,8 @@ We recommend the use of the [Zadig](https://zadig.akeo.ie/) utility. If you have
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Put your keyboard into bootloader mode, either by hitting the `QK_BOOT` keycode (which may be on a different layer), or by pressing the reset switch that's usually located on the underside of the board. If your keyboard has neither, try holding Escape or Space+`B` as you plug it in (see the [Bootmagic Lite](features/bootmagic) docs for more details). Some boards use [Command](features/command) instead of Bootmagic; in this case, you can enter bootloader mode by hitting Left Shift+Right Shift+`B` or Left Shift+Right Shift+Escape at any point while the keyboard is plugged in.
|
Put your keyboard into bootloader mode, either by hitting the `QK_BOOT` keycode (which may be on a different layer), or by pressing the reset switch that's usually located on the underside of the board. If your keyboard has neither, try holding Escape or Space+`B` as you plug it in (see the [Bootmagic](features/bootmagic) docs for more details). Some boards use [Command](features/command) instead of Bootmagic; in this case, you can enter bootloader mode by hitting Left Shift+Right Shift+`B` or Left Shift+Right Shift+Escape at any point while the keyboard is plugged in.
|
||||||
Some keyboards may have specific instructions for entering the bootloader. For example, the [Bootmagic Lite](features/bootmagic) key (default: Escape) might be on a different key, e.g. Left Control; or the magic combination for Command (default: Left Shift+Right Shift) might require you to hold something else, e.g. Left Control+Right Control. Refer to the board's README file if you are unsure.
|
Some keyboards may have specific instructions for entering the bootloader. For example, the [Bootmagic](features/bootmagic) key (default: Escape) might be on a different key, e.g. Left Control; or the magic combination for Command (default: Left Shift+Right Shift) might require you to hold something else, e.g. Left Control+Right Control. Refer to the board's README file if you are unsure.
|
||||||
|
|
||||||
To put a device in bootloader mode with USBaspLoader, tap the `RESET` button while holding down the `BOOT` button.
|
To put a device in bootloader mode with USBaspLoader, tap the `RESET` button while holding down the `BOOT` button.
|
||||||
Alternatively, hold `BOOT` while inserting the USB cable.
|
Alternatively, hold `BOOT` while inserting the USB cable.
|
||||||
|
|
|
@ -34,7 +34,7 @@ On first run, the VIA code in the firmware will copy the keymap from flash memor
|
||||||
|
|
||||||
The simple fix for this is to clear the EEPROM. You can do this in several ways:
|
The simple fix for this is to clear the EEPROM. You can do this in several ways:
|
||||||
|
|
||||||
* Hold the Bootmagic Lite key (usually top left/Escape) while plugging the board in, which will also place the board into bootloader mode; then unplug and replug the board.
|
* Hold the Bootmagic key (usually top left/Escape) while plugging the board in, which will also place the board into bootloader mode; then unplug and replug the board.
|
||||||
* Press the `QK_CLEAR_EEPROM`/`EE_CLR` keycode if it is accessible on your keymap.
|
* Press the `QK_CLEAR_EEPROM`/`EE_CLR` keycode if it is accessible on your keymap.
|
||||||
* Place the board into bootloader mode and hit the "Clear EEPROM" button. This may not be available for all bootloaders, and you may need to reflash the board afterwards.
|
* Place the board into bootloader mode and hit the "Clear EEPROM" button. This may not be available for all bootloaders, and you may need to reflash the board afterwards.
|
||||||
|
|
||||||
|
|
|
@ -109,7 +109,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
And lastly, you want to add the `eeconfig_init_user` function, so that when the EEPROM is reset, you can specify default values, and even custom actions. To force an EEPROM reset, use the `EE_CLR` keycode or [Bootmagic Lite](features/bootmagic) functionallity. For example, if you want to set rgb layer indication by default, and save the default valued.
|
And lastly, you want to add the `eeconfig_init_user` function, so that when the EEPROM is reset, you can specify default values, and even custom actions. To force an EEPROM reset, use the `EE_CLR` keycode or [Bootmagic](features/bootmagic) functionallity. For example, if you want to set rgb layer indication by default, and save the default valued.
|
||||||
|
|
||||||
```c
|
```c
|
||||||
void eeconfig_init_user(void) { // EEPROM is getting reset!
|
void eeconfig_init_user(void) { // EEPROM is getting reset!
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Command
|
# Command
|
||||||
|
|
||||||
Command, formerly known as Magic, is a way to change your keyboard's behavior without having to flash or unplug it to use [Bootmagic Lite](bootmagic). There is a lot of overlap between this functionality and the [Magic Keycodes](../keycodes_magic). Wherever possible we encourage you to use that feature instead of Command.
|
Command, formerly known as Magic, is a way to change your keyboard's behavior without having to flash or unplug it to use [Bootmagic](bootmagic). There is a lot of overlap between this functionality and the [Magic Keycodes](../keycodes_magic). Wherever possible we encourage you to use that feature instead of Command.
|
||||||
|
|
||||||
On some keyboards Command is disabled by default. If this is the case, it must be explicitly enabled in your `rules.mk`:
|
On some keyboards Command is disabled by default. If this is the case, it must be explicitly enabled in your `rules.mk`:
|
||||||
|
|
||||||
|
|
|
@ -53,7 +53,7 @@ QMK maintains [a fork of the LUFA DFU bootloader](https://github.com/qmk/lufa/tr
|
||||||
//#define QMK_LED E6
|
//#define QMK_LED E6
|
||||||
//#define QMK_SPEAKER C6
|
//#define QMK_SPEAKER C6
|
||||||
```
|
```
|
||||||
Currently we do not recommend making `QMK_ESC` the same key as the one designated for [Bootmagic Lite](features/bootmagic), as holding it down will cause the MCU to loop back and forth between entering and exiting the bootloader.
|
Currently we do not recommend making `QMK_ESC` the same key as the one designated for [Bootmagic](features/bootmagic), as holding it down will cause the MCU to loop back and forth between entering and exiting the bootloader.
|
||||||
|
|
||||||
The manufacturer and product strings are automatically pulled from `config.h`, with " Bootloader" appended to the product string.
|
The manufacturer and product strings are automatically pulled from `config.h`, with " Bootloader" appended to the product string.
|
||||||
|
|
||||||
|
@ -209,7 +209,7 @@ To enable the additional features, add the following defines to your `config.h`:
|
||||||
//#define QMK_SPEAKER C6
|
//#define QMK_SPEAKER C6
|
||||||
```
|
```
|
||||||
|
|
||||||
Currently we do not recommend making `QMK_ESC` the same key as the one designated for [Bootmagic Lite](features/bootmagic), as holding it down will cause the MCU to loop back and forth between entering and exiting the bootloader.
|
Currently we do not recommend making `QMK_ESC` the same key as the one designated for [Bootmagic](features/bootmagic), as holding it down will cause the MCU to loop back and forth between entering and exiting the bootloader.
|
||||||
|
|
||||||
The manufacturer and product strings are automatically pulled from `config.h`, with " Bootloader" appended to the product string.
|
The manufacturer and product strings are automatically pulled from `config.h`, with " Bootloader" appended to the product string.
|
||||||
|
|
||||||
|
|
|
@ -99,7 +99,7 @@ To reset to the bootloader use `QK_BOOTLOADER` or `QK_BOOT` keycode or `reset_ke
|
||||||
|
|
||||||
## Wiping the EEPROM (Persistent Storage)
|
## Wiping the EEPROM (Persistent Storage)
|
||||||
|
|
||||||
If you're having issues with Audio, RGB Underglow, backlighting or keys acting weird, then you can reset the EEPROM (persistent setting storage). To force an EEPROM reset, use the [`EE_CLR` keycode](quantum_keycodes) or [Bootmagic Lite](features/bootmagic) functionality. If neither of those are an option, then you can use a custom macro to do so.
|
If you're having issues with Audio, RGB Underglow, backlighting or keys acting weird, then you can reset the EEPROM (persistent setting storage). To force an EEPROM reset, use the [`EE_CLR` keycode](quantum_keycodes) or [Bootmagic](features/bootmagic) functionality. If neither of those are an option, then you can use a custom macro to do so.
|
||||||
|
|
||||||
To wipe the EEPROM, run `eeconfig_init()` from your function or macro to reset most of the settings to default.
|
To wipe the EEPROM, run `eeconfig_init()` from your function or macro to reset most of the settings to default.
|
||||||
|
|
||||||
|
|
|
@ -55,7 +55,7 @@ Everything below here requires a lot of foundational knowledge. Besides being ab
|
||||||
* **Advanced Features**
|
* **Advanced Features**
|
||||||
* [Unicode](features/unicode)
|
* [Unicode](features/unicode)
|
||||||
* [API](api_overview)
|
* [API](api_overview)
|
||||||
* [Bootmagic Lite](features/bootmagic)
|
* [Bootmagic](features/bootmagic)
|
||||||
* **Hardware**
|
* **Hardware**
|
||||||
* [How Keyboards Work](how_keyboards_work)
|
* [How Keyboards Work](how_keyboards_work)
|
||||||
* [How A Keyboard Matrix Works](how_a_matrix_works)
|
* [How A Keyboard Matrix Works](how_a_matrix_works)
|
||||||
|
|
Loading…
Reference in New Issue
Block a user