Skip to content

Commit

Permalink
Update build/flash documentation.
Browse files Browse the repository at this point in the history
Updated docs for the build and flash to have similar content to the new board page.

Added a bit about DFU in case someone were searching for that term.
  • Loading branch information
aaron-nunley authored and petejohanson committed Feb 2, 2021
1 parent 592b98c commit bcc3d9b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
14 changes: 10 additions & 4 deletions docs/docs/development/build-flash.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,11 +118,17 @@ Now start VSCode and rebuild the container after being prompted. You should be a

## Flashing

Once built, the previously supplied parameters will be remembered so you can run the following to flash your
board with it in bootloader mode:
The above build commands generate a UF2 file in `build/zephyr` (or
`build/left|right/zephyr` if you followed the instructions for splits) and is by
default named `zmk.uf2`. If your board supports USB Flashing Format (UF2), copy
that file onto the root of the USB mass storage device for your board. The
controller should flash your built firmware and automatically restart once
flashing is complete.

Alternatively, if your board supports flashing and you're not developing from
within a Dockerized environment, enable Device Firmware Upgrade (DFU) mode on
your board and run the following command to flash:

```
west flash
```

For boards that have drag and drop .uf2 flashing capability, the .uf2 file to flash can be found in `build/zephyr` (or `build/left|right/zephyr` if you followed the instructions for splits) and is by default named `zmk.uf2`.
3 changes: 2 additions & 1 deletion docs/docs/development/new-shield.md
Original file line number Diff line number Diff line change
Expand Up @@ -469,7 +469,8 @@ storage device for your board. The controller should flash your built firmware
and automatically restart once flashing is complete.

Alternatively, if your board supports flashing and you're not developing from
within a Dockerized environment, then you can test your build with:
within a Dockerized environment, enable Device Firmware Upgrade (DFU) mode on
your board and run the following command to test your build:

```
west flash
Expand Down

0 comments on commit bcc3d9b

Please sign in to comment.