aboutsummaryrefslogtreecommitdiff
path: root/docs/newbs_flashing.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/newbs_flashing.md')
-rw-r--r--docs/newbs_flashing.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/docs/newbs_flashing.md b/docs/newbs_flashing.md
index 3bf582d7f..4fb2f91d5 100644
--- a/docs/newbs_flashing.md
+++ b/docs/newbs_flashing.md
@@ -215,7 +215,7 @@ Additionally, if you want to flash multiple boards, use the following command:
215When you're done flashing boards, you'll need to hit Ctrl + C or whatever the correct keystroke is for your operating system to break the loop. 215When you're done flashing boards, you'll need to hit Ctrl + C or whatever the correct keystroke is for your operating system to break the loop.
216 216
217 217
218## HalfKay 218### HalfKay
219 219
220For the PJRC devices (Teensy's), when you're ready to compile and flash your firmware, open up your terminal window and run the build command: 220For the PJRC devices (Teensy's), when you're ready to compile and flash your firmware, open up your terminal window and run the build command:
221 221
@@ -248,7 +248,7 @@ Programming.....................................................................
248Booting 248Booting
249``` 249```
250 250
251## BootloadHID 251### BootloadHID
252 252
253For Bootmapper Client(BMC)/bootloadHID/ATmega32A based boards, when you're ready to compile and flash your firmware, open up your terminal window and run the build command: 253For Bootmapper Client(BMC)/bootloadHID/ATmega32A based boards, when you're ready to compile and flash your firmware, open up your terminal window and run the build command:
254 254
@@ -284,7 +284,7 @@ Uploading 22016 (0x5600) bytes starting at 0 (0x0)
2840x05580 ... 0x05600 2840x05580 ... 0x05600
285``` 285```
286 286
287## STM32 (ARM) 287### STM32 (ARM)
288 288
289For a majority of ARM boards (including the Proton C, Planck Rev 6, and Preonic Rev 3), when you're ready to compile and flash your firmware, open up your terminal window and run the build command: 289For a majority of ARM boards (including the Proton C, Planck Rev 6, and Preonic Rev 3), when you're ready to compile and flash your firmware, open up your terminal window and run the build command:
290 290
@@ -334,6 +334,16 @@ File downloaded successfully
334Transitioning to dfuMANIFEST state 334Transitioning to dfuMANIFEST state
335``` 335```
336 336
337#### STM32 Commands
338
339There are a number of DFU commands that you can use to flash firmware to a STM32 device:
340
341* `:dfu-util` - The default command for flashing to STM32 devices.
342* `:dfu-util-wait` - This works like the default command, but it gives you a (configurable) 10 second timeout before it attempts to flash the firmware. You can use `TIME_DELAY=20` from the command line to change the timeout.
343 * Eg: `make <keyboard>:<keymap>:dfu-util TIME_DELAY=5`
344* `:dfu-util-split-left` - This flashes the normal firmware, just like the default option (`:dfu-util`). However, this also configures the "Left Side" EEPROM setting for split keyboards.
345* `:dfu-util-split-right` - This flashes the normal firmware, just like the default option (`:dfu-util`). However, this also configures the "Right Side" EEPROM setting for split keyboards.
346
337## Test It Out! 347## Test It Out!
338 348
339Congrats! Your custom firmware has been programmed to your keyboard! 349Congrats! Your custom firmware has been programmed to your keyboard!