Add guide for serial flashing #47
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ThomasGravekamp
requested changes
Nov 7, 2022
guides/flashing.md
Outdated
| @@ -14,6 +14,19 @@ Before flashing code on your device, there are some things to be checked first. | |||
|
|
|||
| Each template contains a make file located at the root of the template and is called `Makefile`. This make file contains a variable called `DEVICE`. This variable should contain the name of the device you want to compile your code for. You should format the name of your device like this: `STM32____x_`, where the "_" should be replaced by characters from the actual name (uppercase!) and the "x" is fixed. There are some exceptions to this naming scheme for STM32F4 devices, see the [Device name mapping page]({{ site.url }}/cheatsheets/device-name-mapping) for more information. | |||
|
|
|||
| ### Flashing tool | |||
|
|
|||
| There are differennt interfaces (serial, I2C, SPI, SWD, etc.) and programs you can use to flash code to your device. Make sure to set the `FLASHING_TOOL` variable in your makefile to the name of your flashing tool. Currently the project has two options available: | |||
There was a problem hiding this comment.
Spelling error in here "There are differennt interfaces"
A user does not have to "make sure to set the FLASHING_TOOL variable". This variable only applies when you want to use the non default stm32flash tool. So you could actually make this whole text simpler by removing that sentence and...
guides/flashing.md
Outdated
| - [st-flash](https://github.com/stlink-org/stlink) uses SWD interface. (default) | ||
| - [stm32flash](https://github.com/stm32duino/stm32flash) uses serial interface. | ||
|
|
||
| ### Serial port |
There was a problem hiding this comment.
... remove this header and explain briefly how to use stm32flash with the STM32-base project:
"If you want to use stm32flash, set the FLASHING_TOOL variable in your makefile with the value stm32flash. Make sure to also set the FLASHING_SERIAL_PORT variable to the name of the serial port you want to use."
DarinelSanguino
force-pushed
the
add-guide-for-serial-flashing
branch
from
003b011 to
eef8190
Compare
|
Thanks for also updating the docs |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added section 'Flashing tool' indicating how to select flashing tool.
Added section "Serial port" instructing to set FLASHING_SERIAL_PORT variable in case stm32flash is used.