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: Update Sphinx documentation #123

Merged
merged 1 commit into from
Jan 27, 2025

Conversation

Shetty-Anush
Copy link
Contributor

Add a step in stm32 build to demonstrate how to generate a binary file

@@ -70,6 +70,10 @@ and generate executable file (.bin/.hex)
.. image:: /source/build/stm32_exclude_syscalls.png
:width: 600

* Select 'Convert to binary file' to generate a .bin file as a post build output
Copy link
Contributor

Choose a reason for hiding this comment

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

Can elaborate this @Shetty-Anush ? Something like (right click on the project->click properties->....)

Copy link
Contributor

Choose a reason for hiding this comment

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

Probably adding a screenshot would help?

* Select 'Convert to binary file' to generate a .bin file as a post build output
.. image:: /source/build/stm32_convert_to_binary.png
:width: 600

* Program by clicking on the "Run adxxxx_iio" option seen or by performing a copy->paste option of the .hex file seen in the STM32/Debug folder
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this also can be updated making it more relevant and straight-forward.
Run builds the code and tries to program the board but with SDP-K1 (which isn't a native STM32 dev board although we use the stm32 mcu) and no available ST-Link; debug/run configurations need to be set for the programming to happen (either OpenOCD or J-Link) and a Segger J-Link probe (in case of J-Link).

We can just mention how to build code here with a screenshot: Project->right_click->build project

And flashing part is already being covered in the 'Running a project' section.

@SaikiranGudla SaikiranGudla added the documentation Improvements or additions to documentation label Jan 24, 2025
Add a step in stm32 build to demonstrate how to generate a binary file

Signed-off-by: Anush Shetty <[email protected]>
@SaikiranGudla SaikiranGudla merged commit 071aa53 into analogdevicesinc:main Jan 27, 2025
5 of 28 checks passed
@Shetty-Anush Shetty-Anush deleted the post_build_output branch February 3, 2025 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants