Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add STM32 serial bootloader #68

Conversation

pradeeka7
Copy link
Collaborator

Summary

A guide on flashing the GNSE using a USB to UART interfaces
Please refer to the issue #18

Screenshots

image

Changes

  • ...
  • ...

Notes for Reviewers

@azerimaker

Checklist

  • Scope: The referenced issue is addressed, there are no unrelated changes.
  • Run Locally: Verified that the docs build using make server, posted screenshots, verified external links.
  • New Features Marked: Documentation for new features is marked using the new-in-version shortcode, according to the guidelines in CONTRIBUTING.
  • Style Guidelines: Documentation obeys style guidelines in CONTRIBUTING.
  • Commits: Commit messages follow guidelines in CONTRIBUTING, there are no fixup commits left.

azerimaker
azerimaker previously approved these changes Apr 20, 2023
Copy link
Contributor

@azerimaker azerimaker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@pradeeka7
Copy link
Collaborator Author

@azerimaker and @nejraselimovic Shall we finalize this?

Copy link
Contributor

@nejraselimovic nejraselimovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't even aware of this PR as I wasn't tagged as a reviewer. Please tag me for future PRs you want me to check out. Please fix these few small things for readability before merging


If you don't have an ST-LINK V3 probe for programming the Generic Node Sensor Edition, you can program it through a **USB-to-UART TTL converter** (sometimes referred to as a serial converter). They are commonly available as breakout boards, such as the [SparkFun FTDI Basic Breakout - 3.3V](https://www.sparkfun.com/products/9873), for example.

{{< note "Make sure to use an USB-to-UART converter board configured to 3.3v for both power output and I/O levels. If you have a 5V FTDI breakout board, check if it has a jumper that allows you to switch it to 3.3v." />}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{< note "Make sure to use an USB-to-UART converter board configured to 3.3v for both power output and I/O levels. If you have a 5V FTDI breakout board, check if it has a jumper that allows you to switch it to 3.3v." />}}
{{< note "Make sure to use a USB-to-UART converter board configured to 3.3V for both power output and I/O levels. If you have a 5V FTDI breakout board, check if it has a jumper that allows you to switch it to 3.3V." />}}

Comment on lines 12 to 16
Install drivers on your computer if they are not already installed. Follow the tutorials on the **SparkFun** website to learn how to install them on different operating systems:

- Windows: https://learn.sparkfun.com/tutorials/how-to-install-ftdi-drivers/windows---in-depth
- Mac: https://learn.sparkfun.com/tutorials/how-to-install-ftdi-drivers/mac
- Linux: https://learn.sparkfun.com/tutorials/how-to-install-ftdi-drivers/linux
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Install drivers on your computer if they are not already installed. Follow the tutorials on the **SparkFun** website to learn how to install them on different operating systems:
- Windows: https://learn.sparkfun.com/tutorials/how-to-install-ftdi-drivers/windows---in-depth
- Mac: https://learn.sparkfun.com/tutorials/how-to-install-ftdi-drivers/mac
- Linux: https://learn.sparkfun.com/tutorials/how-to-install-ftdi-drivers/linux
Install drivers on your computer if they are not already installed. Follow the tutorials on the SparkFun website to learn how to install them on [Windows](https://learn.sparkfun.com/tutorials/how-to-install-ftdi-drivers/windows---in-depth), [Mac](https://learn.sparkfun.com/tutorials/how-to-install-ftdi-drivers/mac) or [Linux](https://learn.sparkfun.com/tutorials/how-to-install-ftdi-drivers/linux).

distributions: null
---

If you don't have an ST-LINK V3 probe for programming the Generic Node Sensor Edition, you can program it through a **USB-to-UART TTL converter** (sometimes referred to as a serial converter). They are commonly available as breakout boards, such as the [SparkFun FTDI Basic Breakout - 3.3V](https://www.sparkfun.com/products/9873), for example.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you don't have an ST-LINK V3 probe for programming the Generic Node Sensor Edition, you can program it through a **USB-to-UART TTL converter** (sometimes referred to as a serial converter). They are commonly available as breakout boards, such as the [SparkFun FTDI Basic Breakout - 3.3V](https://www.sparkfun.com/products/9873), for example.
If you don't have an ST-LINK V3 probe for programming the Generic Node Sensor Edition (GNSE), you can program it through a **USB-to-UART TTL converter** (sometimes referred to as a serial converter). They are commonly available as breakout boards, such as the [SparkFun FTDI Basic Breakout - 3.3V](https://www.sparkfun.com/products/9873), for example.


Connect FTDI to the computer using miniUSB cable.

Now, you need the `.bin` file of your project to flash onto the GNSE using [STM32CubeProgrammer]({{< ref "/getting-started/programming-software/st-examples/stcubeprog" >}}). This file can be generated during the build process with the [STM32CubeIDE]({{< ref "/getting-started/programming-software/st-examples/stcubeide" >}}). To configure the generation of a `.bin` file, right-click on the **project** and select **Properties** from the shortcut menu.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Now, you need the `.bin` file of your project to flash onto the GNSE using [STM32CubeProgrammer]({{< ref "/getting-started/programming-software/st-examples/stcubeprog" >}}). This file can be generated during the build process with the [STM32CubeIDE]({{< ref "/getting-started/programming-software/st-examples/stcubeide" >}}). To configure the generation of a `.bin` file, right-click on the **project** and select **Properties** from the shortcut menu.
Now, you need to flash the `.bin` file of your project onto the GNSE using [STM32CubeProgrammer]({{< ref "/getting-started/programming-software/st-examples/stcubeprog" >}}). This file can be generated during the build process with the [STM32CubeIDE]({{< ref "/getting-started/programming-software/st-examples/stcubeide" >}}). To configure the generation of a `.bin` file, right-click on the **Project** and select **Properties** from the shortcut menu.

@pradeeka7
Copy link
Collaborator Author

wasn't even aware of this PR as I wasn't tagged as a reviewer. Please tag me for future PRs you want me to check out. Please fix these few small things for readability before merging

@nejraselimovic Sorry for that. I don't have permission to assign reviewers. Thanks for reviewing!

@pradeeka7
Copy link
Collaborator Author

@nejraselimovic done

@nejraselimovic nejraselimovic merged commit f78a59d into TheThingsIndustries:master Jun 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants