Merge remote-tracking branch 'origin/develop' into xap

This commit is contained in:
QMK Bot 2024-06-17 19:24:46 +00:00
commit a09e60a7b3
63 changed files with 63 additions and 144 deletions

View File

@ -4,6 +4,7 @@
"/cli_dev_configuration": "/cli_configuration",
"/dynamic_macros": "/feature_dynamic_macros",
"/feature_common_shortcuts": "/feature_advanced_keycodes",
"/flashing_bootloadhid": "/flashing",
"/getting_started_build_tools": "/newbs_getting_started",
"/getting_started_getting_help": "/support",
"/glossary": "/reference_glossary",

View File

@ -64,13 +64,7 @@
"text": "Development Environments",
"items": [{ "text": "Docker Guide", "link": "/getting_started_docker" }]
},
{
"text": "Flashing",
"items": [
{ "text": "Flashing", "link": "/flashing" },
{ "text": "Flashing ATmega32A (ps2avrgb)", "link": "/flashing_bootloadhid" }
]
},
{ "text": "Flashing", "link": "/flashing" },
{
"text": "IDEs",
"items": [

View File

@ -1,74 +0,0 @@
# BootloadHID Flashing Instructions and Bootloader Information
ps2avr(GB) boards use an ATmega32A microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
General flashing sequence:
1. Enter the bootloader using any of the following methods:
* Tap the `QK_BOOT` keycode (may not work on all devices)
* Hold the salt key while plugging the keyboard in (usually documented within keyboard readme)
2. Wait for the OS to detect the device
3. Flash a .hex file
4. Reset the device into application mode (may be done automatically)
## bootloadHID Flashing Target
::: tip
Using the QMK installation script, detailed [here](newbs_getting_started), the required bootloadHID tools should be automatically installed.
:::
To flash via the command line, use the target `:bootloadhid` by executing the following command:
```
make <keyboard>:<keymap>:bootloadhid
```
## GUI Flashing
### Windows
1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
2. Place your keyboard into reset.
3. Ensure the configured VendorID is `16c0` and ProductID is `05df`
4. Press the `Find Device` button and ensure that your keyboard is found.
5. Press the `Open .hex File` button and locate the `.hex` file you created.
6. Press the `Flash Device` button and wait for the process to complete.
## Command Line Flashing
1. Place your keyboard into reset.
2. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
### Windows Manual Installation
For MSYS2:
1. Download the BootloadHID firmware package from https://www.obdev.at/downloads/vusb/bootloadHID.2012-12-08.tar.gz.
2. Extract contents using a compatible tool, for example 7-Zip.
3. Add to the MSYS path by copying `commandline/bootloadHID.exe` from the extracted archive to your MSYS2 installation, typically `C:\msys64\usr\bin`.
For native Windows flashing, the `bootloadHID.exe` can be used outside of the MSYS2 environment.
### Linux Manual Installation
1. Install libusb development dependency:
```
# This depends on OS - for Debian the following works
sudo apt-get install libusb-dev
```
2. Download the BootloadHID firmware package:
```
wget https://www.obdev.at/downloads/vusb/bootloadHID.2012-12-08.tar.gz -O - | tar -xz -C /tmp
```
3. Build the bootloadHID executable:
```
cd /tmp/bootloadHID.2012-12-08/commandline/
make
sudo cp bootloadHID /usr/local/bin
```
### MacOS Manual Installation
1. Install Homebrew by typing the following:
```
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```
2. Install the following packages:
```
brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
```

View File

@ -15,7 +15,7 @@ Make example for this keyboard (after setting up your build environment):
make amag23:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make amag23:default:flash

View File

@ -8,7 +8,7 @@ Make example for this keyboard (after setting up your build environment):
make ares:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make ares:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make bfake:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make bfake:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make db/db63:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make db/db63:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make donutcables/budget96:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make donutcables/budget96:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make eve/meteor:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make eve/meteor:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make exclusive/e6v2/le_bmc:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make exclusive/e6v2/le_bmc:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make exclusive/e6v2/oe_bmc:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make exclusive/e6v2/oe_bmc:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make exent:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](flashing_bootloadhid.md))
Flashing example for this keyboard:
make exent:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make facew:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make facew:default:flash

View File

@ -15,13 +15,11 @@ Make example for this keyboard (after setting up your build environment):
make foxlab/time80:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make foxlab/time80:default:flash
**Reset Key**: There are no reset switches or pads. Follow this
[guide](https://docs.qmk.fm/#/flashing_bootloadhid)
to have it flashed for the first time. Remember to add a `QK_BOOT`
**Reset Key**: There are no reset switches or pads. Remember to add a `QK_BOOT`
key on your keymap for future endeavors.
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make ft/mars65:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make ft/mars65:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make ft/mars80:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make ft/mars80:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make gray_studio/hb85:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make gray_studio/hb85:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make j80:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make j80:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make jaykeeb/skyline:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make jaykeeb/skyline:default:flash

View File

@ -16,7 +16,7 @@ Make example for this keyboard (after setting up your build environment):
make jc65/v32a:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make jc65/v32a:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make kbdfans/kbdpad/mk1:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make kbdfans/kbdpad/mk1:default:flash

View File

@ -17,7 +17,7 @@ Make example for this keyboard (after setting up your build environment):
make keychron/q2/jis:default
make keychron/q2/jis_encoder:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make keychron/q2/ansi:default:flash
make keychron/q2/ansi_encoder:default:flash

View File

@ -16,7 +16,7 @@ Make example for this keyboard (after setting up your build environment):
make keychron/q4/ansi/v2:default
make keychron/q4/iso:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make keychron/q4/ansi/v1:default:flash
make keychron/q4/ansi/v2:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make keychron/q60/ansi:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make keychron/q60/ansi:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make keychron/q65/ansi_encoder:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make keychron/q65/ansi_encoder:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make keychron/v2/ansi:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make keychron/v2/ansi:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make keychron/v4/ansi:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make keychron/v4/ansi:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make keychron/v7/ansi:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make keychron/v7/ansi:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make keychron/v8/ansi:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make keychron/v8/ansi:default:flash

View File

@ -13,7 +13,7 @@ Make example for this keyboard (after setting up your build environment):
make kira/kira80:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make kira/kira80:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make kprepublic/jj40/rev1:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make kprepublic/jj40/rev1:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make kprepublic/jj4x4:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make kprepublic/jj4x4:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make kprepublic/jj50/rev1:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make kprepublic/jj50/rev1:default:flash

View File

@ -9,7 +9,7 @@ Make example for this keyboard (after setting up your build environment):
make leeku/finger65:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make leeku/finger65:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make mechkeys/mechmini/v1:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make mechkeys/mechmini/v1:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make mehkee96:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make mehkee96:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make mt/mt40:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make mt/mt40:default:flash

View File

@ -15,7 +15,7 @@ Make example for this keyboard (after setting up your build environment):
make mt/split75:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make mt/split75:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make oddforge/vea:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make oddforge/vea:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make panc60:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make panc60:default:flash

View File

@ -11,7 +11,7 @@ Make example for this keyboard (after setting up your build environment):
make pearl:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make pearl:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make percent/canoe:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make percent/canoe:default:flash

View File

@ -8,7 +8,7 @@ Make example for this keyboard (after setting up your build environment):
make percent/skog:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make percent/skog:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make percent/skog_lite:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make percent/skog_lite:default:flash

View File

@ -13,7 +13,7 @@ Make example for this keyboard (after setting up your build environment):
make singa:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make singa:default:flash

View File

@ -16,7 +16,7 @@ Make example for this keyboard (after setting up your build environment):
make spiderisland/split78:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make spiderisland/split78:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make tgr/910:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make tgr/910:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make tgr/910ce:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make tgr/910ce:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make tgr/alice:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make tgr/alice:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make tgr/jane:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make tgr/jane:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make tgr/jane/v2ce:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make tgr/jane/v2ce:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make tris:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make tris:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make unikorn:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make unikorn:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make winkeyless/b87:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make winkeyless/b87:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make winkeyless/bface:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make winkeyless/bface:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make winkeyless/bmini:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make winkeyless/bmini:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make winkeyless/bminiex:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make winkeyless/bminiex:default:flash

View File

@ -13,7 +13,7 @@ Make example for this keyboard (after setting up your build environment):
make ymdk/bface:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make ymdk/bface:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make ymdk/np21:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make ymdk/np21:default:flash

View File

@ -8,7 +8,7 @@ Make example for this keyboard (after setting up your build environment):
make ymdk/sp64:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make ymdk/sp64:default:flash

View File

@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment):
make ymdk/ymd75/rev1:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make ymdk/ymd75/rev1:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make ymdk/ymd75/rev2:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make ymdk/ymd75/rev2:default:flash

View File

@ -10,7 +10,7 @@ Make example for this keyboard (after setting up your build environment):
make ymdk/ymd96:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
Flashing example for this keyboard:
make ymdk/ymd96:default:flash