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: Improve Programming software - STM32CubeIDE #37

Merged
merged 2 commits into from
Sep 14, 2021

Conversation

pradeeka7
Copy link
Collaborator

Summary

The current page (https://www.genericnode.com/docs/getting-started/programming-software/st-examples/stcubeide/) has a lack of information about running a project. This pull request includes some additional information that can be helpful to users when they running a project.

Screenshots

image

Changes

  • Explained how the compiled program cab be flashed to GNSE by running a project
  • Explained how to view serial data
  • Explained how to reset GNSE
  • Provided link to drag and drop flash programming
  • Added some screen captures

Notes for Reviewers

@elsalahy

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.

@CLAassistant
Copy link

CLAassistant commented Sep 13, 2021

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@elsalahy elsalahy left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution @pradeeka7
Could you please handle the minor recommended fixes?

@@ -7,10 +7,26 @@ distributions: null

If you are using [STM32CubeIDE](https://www.st.com/en/development-tools/stm32cubeide.html) as your build environment, then using the same tool to program your {{% gnse %}} is convenient.

<!--more-->
Copy link
Contributor

Choose a reason for hiding this comment

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

Why remove this line?

This line protects the documentation framework from having all the page information on the thumbnail.

See how this looks now

Screen Shot 2021-09-13 at 18 01 19

in comparison to the old overview

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

fixed


{{< figure src="run_as.png" alt="project run as" >}}

This will start to **flash** the compiled program (bin file) to the {{% gnse %}}. The following figure shows the **Console** output, for example, when running the [basic]({{< ref "/applications/se-basic" >}}) project.
Copy link
Contributor

Choose a reason for hiding this comment

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

This actually flashes the .elf file as it uses GDB server to do so.
I think there is no need to mention the file type.

image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks for the clarification. I thought it was the bin file.
fixed

@elsalahy elsalahy self-requested a review September 14, 2021 07:58
Copy link
Contributor

@elsalahy elsalahy 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, will be deployed by the end of the week.

@elsalahy elsalahy merged commit 4fa441e into TheThingsIndustries:master Sep 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants