Skip to content

Commit c0e9a99

Browse files
daysgobyedaysgobye
committed
new docs on uf2 flashing
1 parent 9e576de commit c0e9a99

File tree

3 files changed

+157
-71
lines changed

3 files changed

+157
-71
lines changed

‎guides/flashing_a_uf2.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: How To Flash A Keyboard with .UF2
3+
description: How To Flash A Keyboard with a uf2 bootloader.
4+
author: Boardsource
5+
product_link: https://boardsource.xyz/store/628b95b494dfa308a6581622
6+
subcategory: easy
7+
draft: false
8+
tags:
9+
- qmk
10+
- via
11+
- uf2
12+
- bootloader
13+
- flashing
14+
banner: https://images.boardsource.xyz/boot_loader.jpg
15+
thumbnail: https://images.boardsource.xyz/uf2,boot_loader.jpg
16+
---
17+
18+
19+
# How To Flash A Keyboard with.UF2
20+
21+
This guide will show you how to flash a keyboard with a.uf2 bootloader.
22+
23+
## Step 1: Get the.uf2 file
24+
25+
First, you will need to get the.uf2 file for your keyboard. You can get a .UF2 file by following our [guide for QMK Configurator](https://www.boardsource.xyz/docs/guides-qmk_configurator) or from [VIA](https://www.caniusevia.com/docs/download_firmware) or by following our [ZMK GUI guide](https://www.boardsource.xyz/docs/guides-zmkGui)
26+
27+
## Step 2: Get into Boot loader
28+
29+
So you have the.uf2 file, now you need to get into the bootloader. This can be done a lot of ways I will list them here from easy to hard.
30+
31+
* Hold down special key while you plug in the keyboard.
32+
* This is the easiest way to get into you bootloader.
33+
But it only works if you keyboard is already flashed with QMK.
34+
The key you would need to hold down is the key is the first key on the first column.
35+
99% of the time that's the escape key.
36+
on a split keyboard it would be escape (for the left side) and `y` or `6` (for the right side)
37+
* Double tap your reset switch.
38+
* Like the method above this only works if your keyboard is already flashed with QMK.
39+
This is a little bit more annoying then holding down a key because you may need to open your keyboards case to gain access to your reset switch.
40+
* Hold down boot switch while you plug in your keyboard.
41+
* if your keyboard is using a RP2040 (Blok, Lulu, Unicorne) you will have a boot switch and a reset switch. Please refer to your keyboard or controller on how to locate it.
42+
* Hold down boot switch while you tap your reset switch.
43+
* here you need to have access to both BOOT and RESET Switches and you simply hold down the boot switch while you tap the reset switch. (some keyboard use a slide switch for boot to make this easier)
44+
45+
### Now you know all the ways you can get access to your boot loader how do you know one of them worked?
46+
47+
As soon as you get into bootloader a new drive will show up on your computer. This drives name will be "RPI-RP2" or "Nicenano"
48+
![boot loader drive](https://images.boardsource.xyz/boot_loader.jpg)
49+
50+
51+
## Step 3: Flash the.uf2 file
52+
53+
Once you have gotten your board into bootloader and you can access the "flash drive" all you need to do is simply copy over you .UF2 file example shown in gif below.
54+
55+
![how to flash uf2](https://images.boardsource.xyz/how_to_uf2_flash.gif)
56+
57+
58+
After the file is done transferring your keyboard will restart and you should no longer be in bootloader mode.
59+
At this point your done and nothing else is needed.
60+
Use your keyboard and enjoy.
61+
62+
## Extra
63+
For questions, ask in [Boardsource Discord
64+
server](https://discord.gg/5qpqbgaTYz)

‎guides/flashing_with_qmk_toolbox.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: How To Flash A Keyboard with qmk
3+
description: How To Flash A Keyboard using qmk tool box.
4+
author: Boardsource
5+
product_link: https://boardsource.xyz/store/628b95b494dfa308a6581622
6+
subcategory: easy
7+
draft: false
8+
tags:
9+
- qmk
10+
- flashing
11+
banner: https://boardsource.imgix.net/3f11ba0e-4a8f-4dd6-894d-4e275a073c4c.jpg
12+
thumbnail: https://boardsource.imgix.net/f2a7c864-074e-406f-9c23-1d26813114e4.jpg?auto=format&ixlib=react-9.2.0&q=80&w=200&dpr=1
13+
---
14+
15+
# A quick note before we go further
16+
17+
If your keyboard is sold as pre-soldered by default, or you have a Blok
18+
controller, you will probably not be able to use this guide and should follow [this one.](https://www.boardsource.xyz/docs/guides-flashing_a_uf2)
19+
20+
# Step 3: Flash Your Keyboard
21+
With the completed Keymap produced by QMK Configurator ready to go, we can move
22+
on to the next step and use the QMK Toolbox. If you don’t have that installed
23+
yet, head over to [QMK Firmware - QMK Toolbox](https://qmk.fm/toolbox/) and
24+
download the software.
25+
26+
QMK Toolbox allows us to flash the Keymap onto our keyboard, and it is very easy
27+
to do so using the Toolbox.
28+
29+
## Open QMK Toolbox
30+
31+
Open QMK Toolbox, you should see something similar to this:
32+
33+
![qmk
34+
toolbox](https://boardsource.imgix.net/ec89f4c8-ea52-4536-95f9-18eb386f051a.jpg)
35+
36+
## Connect Device to QMK Toolbox:
37+
38+
In order to flash the keyboard, we have to make QMK Toolbox recognize the device
39+
as something it can flash. In order to do, we must have QMK Toolbox open and
40+
then press the reset button on our keyboard while it is plugged in. If you’re
41+
using an Elite-C you can use the on-board reset button, if your keyboard kit has
42+
a reset switch included that you installed, simply press that reset switch. If
43+
you need help figuring out how to reset your keyboard, just ask us in Discord.
44+
45+
If you successfully reset your keyboard while it is plugged in with QMK Toolbox
46+
open, you should see this message in the photo below, written in yellow. If you
47+
see that message, you’re good to move on to the next step and you’re almost
48+
done!
49+
50+
![qmk toolbox reset success yellow
51+
message](https://boardsource.imgix.net/44a1b3f9-086c-45aa-946c-0bd966a99282.jpg)
52+
53+
## Flash Keyboard
54+
55+
With your keyboard successfully reset and QMK recognizing it as a device it can
56+
flash, you’re ready to flash your Keymap! Using the file browser in QMK Toolbox
57+
navigate to the location you saved your Keymap (.hex file) earlier that QMK
58+
Configurator gave you. After you have the correct Keymap selected, you may click
59+
“Flash” in QMK Toolbox. If successful, it will read “DFU Device Disconnected,”
60+
because QMK Toolbox automatically disconnects your device after a successful
61+
flash, and a few lines above that you should see the work ‘success.’ If you are
62+
flashing a split keyboard, simply plug in your other half, reset it, and flash
63+
the same Keymap to that half. If you are flashing a non-split board, you’re
64+
done!
65+
66+
![qmk toolbox successful flash
67+
message](https://boardsource.imgix.net/29e30042-a448-40c2-bab8-796e23dadceb.jpg)
68+
69+
## All Done
70+
71+
There you go, now you've successfully flashed a keyboard using QMK Configurator
72+
to build your map, and QMK Toolbox to flash the keymap onto your keyboard. If
73+
your keyboard is built properly, this should be a very smooth process. Now that
74+
you know the easy steps to follow to flash you keyboard, you can spend some time
75+
making the perfect keymap for yourself.

guides/flashing.md renamed to guides/qmk_configurator.md

Lines changed: 18 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: How To Flash A Keyboard with qmk
3-
description: How To Flash A Keyboard using qmk tool box.
2+
title: How To Make A Keymap With QMK Configurator
3+
description: How To Make A Keymap With QMK Configurator
44
author: Boardsource
55
product_link: https://boardsource.xyz/store/628b95b494dfa308a6581622
66
subcategory: easy
@@ -12,16 +12,6 @@ banner: https://boardsource.imgix.net/3f11ba0e-4a8f-4dd6-894d-4e275a073c4c.jpg
1212
thumbnail: https://boardsource.imgix.net/f2a7c864-074e-406f-9c23-1d26813114e4.jpg?auto=format&ixlib=react-9.2.0&q=80&w=200&dpr=1
1313
---
1414

15-
# A quick note before we go further
16-
17-
If your keyboard is sold as presoldered by default, or you have a Blok
18-
controller, you will probably not be able to use this guide. You will want to
19-
use QMK's [newbs](https://docs.qmk.fm/#/newbs) tutorial as QMK configurator and
20-
QMK toolbox is meant for much older chips, and as of the time of writing, hasn't
21-
been updated to support the latest and greatest of chips that we generally
22-
offer. If you are unsure, you can read ahead, and if those steps don't work for
23-
you, the [newbs](https://docs.qmk.fm/#/newbs) guide will work for almost any
24-
device that we sell.
2515

2616
# Overview
2717

@@ -63,27 +53,27 @@ input. The keymap, hence the inclusion of the word map, tells your computer
6353
which key does what. Whether that is a simple key like the letter “A” or a more
6454
complex Macro or function key, it is included in the Keymap. Keymaps are
6555
sometimes referred to as a “Hex file” or a “.hex” because the file-type of a
66-
Keymap is “.hex,” ex. (“sick_keymap.hex”).
56+
Keymap is “.hex or .uf2,” ex. (“sick_keymap.hex”).
6757

6858
QMK Configurator: A web-based application that allows you to create a Keymap in
6959
a visual way using Drag and Drop tiles (symbolizing keys), with pre-set Keymaps
7060
available for any keyboard in QMK. The QMK Configurator allows you to create a
7161
keymap without writing any code, and then simply hit a button to produce a
72-
completed (compiled) .hex file.
62+
completed (compiled) .hex or .uf2 file.
7363

7464
Flashing: The process of putting a piece of software onto a piece of hardware.
75-
In the world of keyboards, flashing simply means putting your Keymap (the .hex
65+
In the world of keyboards, flashing simply means putting your Keymap (the .hex or .uf2
7666
file produced by the QMK Configurator) onto the Micro Controller (generally a
77-
Pro Micro or Elite-C).
67+
Pro Micro / Elite-C or Blok).
7868

79-
QMK Toolbox: A desktop application that allows you to take your Keymap (.hex
69+
QMK Toolbox: A desktop application that allows you to take your Keymap (.hex or .uf2
8070
file) produced by QMK Configurator and then flash it onto your keyboard.
8171

8272
With knowledge of what those terms mean and what they are referring to, you’re
8373
now ready to move onto actually creating a Keymap and flashing your board!
8474

8575
# Step 1: Create Your Keymap (Part A)
86-
The first step of flashing a keyboard is to create and download a Keymap (.hex
76+
The first step of flashing a keyboard is to create and download a Keymap (.hex or .uf2
8777
file). Remember, the keymap is produced by the QMK Configurator so let’s head
8878
over there. The URL for the QMK Configurator is [QMK
8979
Configurator](https://config.qmk.fm/).
@@ -104,7 +94,6 @@ All Boardsource boards that do not overlap with an existing keymap will be
10494
listed under “boardsource/NAME_OF_BOARD,” so the 3x4 Macro Pad is listed under
10595
“boardsource/3x4.”
10696

107-
![qmk configurator keyboard selection dropdown]()
10897

10998
Here is what the page will look like after you make your selection (although the
11099
preview of the keyboard layout should of course look like the keyboard you’re
@@ -121,9 +110,9 @@ any changes you want to the Keymap prior to Compiling.
121110
After you are satisfied with your Keymap, simply hit the Compile button, and
122111
wait for the potato animation to complete. When the potato is done baking (the
123112
Keymap is done Compiling) you can click the Green “Firmware” button with a
124-
download icon next to it, and you completed .hex Keymap file will be downloaded.
113+
download icon next to it, and you completed .hex or .uf2 Keymap file will be downloaded.
125114

126-
After you have successfully downloaded the Keymap file (.hex), you are
115+
After you have successfully downloaded the Keymap file (.hex or .uf2), you are
127116
officially done in the QMK Configurator, and the rest of the process is
128117
completed within the QMK Toolbox.
129118

@@ -134,59 +123,17 @@ potato](https://boardsource.imgix.net/42f08c42-8bd5-4df2-b717-b5cb688a85ce.jpg)
134123
![qmk configurator compiling
135124
download](https://boardsource.imgix.net/4a8f1e2b-644c-4cdc-a86d-83d255babbd5.jpg)
136125

137-
# Step 3: Flash Your Keyboard
138-
With the completed Keymap produced by QMK Configurator ready to go, we can move
139-
on to the next step and use the QMK Toolbox. If you don’t have that installed
140-
yet, head over to [QMK Firmware - QMK Toolbox](https://qmk.fm/toolbox/) and
141-
download the software.
142-
143-
QMK Toolbox allows us to flash the Keymap onto our keyboard, and it is very easy
144-
to do so using the Toolbox.
145-
146-
## Open QMK Toolbox
147-
148-
Open QMK Toolbox, you should see something similar to this:
149-
150-
![qmk
151-
toolbox](https://boardsource.imgix.net/ec89f4c8-ea52-4536-95f9-18eb386f051a.jpg)
152-
153-
## Connect Device to QMK Toolbox:
154-
155-
In order to flash the keyboard, we have to make QMK Toolbox recognize the device
156-
as something it can flash. In order to do, we must have QMK Toolbox open and
157-
then press the reset button on our keyboard while it is plugged in. If you’re
158-
using an Elite-C you can use the on-board reset button, if your keyboard kit has
159-
a reset switch included that you installed, simply press that reset switch. If
160-
you need help figuring out how to reset your keyboard, just ask us in Discord.
161-
162-
If you successfully reset your keyboard while it is plugged in with QMK Toolbox
163-
open, you should see this message in the photo below, written in yellow. If you
164-
see that message, you’re good to move on to the next step and you’re almost
165-
done!
126+
# Step 3: Flashing
166127

167-
![qmk toolbox reset success yellow
168-
message](https://boardsource.imgix.net/44a1b3f9-086c-45aa-946c-0bd966a99282.jpg)
128+
Flashing your keyboard is the process of putting the keymap onto the keyboard.
129+
The whole time we have been working to produce a (.hex or .uf2) and it has not mattered so far.
130+
But now we will go down 2 paths to flash the keyboard.
169131

170-
## Flash Keyboard
132+
## `.hex`
171133

172-
With your keyboard successfully reset and QMK recognizing it as a device it can
173-
flash, you’re ready to flash your Keymap! Using the file browser in QMK Toolbox
174-
navigate to the location you saved your Keymap (.hex file) earlier that QMK
175-
Configurator gave you. After you have the correct Keymap selected, you may click
176-
“Flash” in QMK Toolbox. If successful, it will read “DFU Device Disconnected,”
177-
because QMK Toolbox automatically disconnects your device after a successful
178-
flash, and a few lines above that you should see the work ‘success.’ If you are
179-
flashing a split keyboard, simply plug in your other half, reset it, and flash
180-
the same Keymap to that half. If you are flashing a non-split board, you’re
181-
done!
134+
If you just produced a .hex/.bin please follow [this guide on using QMK TOOL BOX](https://www.boardsource.xyz/docs/guides-flashing_with_qmk_toolbox)
182135

183-
![qmk toolbox successful flash
184-
message](https://boardsource.imgix.net/29e30042-a448-40c2-bab8-796e23dadceb.jpg)
185136

186-
## All Done
137+
## `.uf2`
187138

188-
There you go, now you've successfully flashed a keyboard using QMK Configurator
189-
to build your map, and QMK Toolbox to flash the keymap onto your keyboard. If
190-
your keyboard is built properly, this should be a very smooth process. Now that
191-
you know the easy steps to follow to flash you keyboard, you can spend some time
192-
making the perfect keymap for yourself.
139+
Otherwise if you just produced a .uf2 please continue to [this guide on how to flash a .uf2](https://www.boardsource.xyz/docs/guides-flashing_a_uf2)

0 commit comments

Comments
 (0)