Skip to main content
Associate
October 22, 2024
Solved

STM32CubeMX API documentation

  • October 22, 2024
  • 2 replies
  • 1709 views

Hi,

I'm new to STM32 tools.

If I add a new component in STM32CubeMX, where can I find the documentation to the added sonftware modules?

E.g. if I add DMA2D from the left pane software is added to the project.

How do I know what this software offers and how to use it.

All I get are references to the controller datasheet and reference manual on mouseover.

Greets,

Joerg

Best answer by Andrew Neil

Now we know the family ...

Go to the 'Tools and Software' tab, click 'MCU and MPU embedded software':

AndrewNeil_0-1729591072115.png

You want the STM32CubeH7 pack:

AndrewNeil_2-1729591236637.png

The User Manual is on the software page, 'Documentation' tab:

https://www.st.com/en/embedded-software/stm32cubeh7.html#documentation

 

Don't know why that isn't directly linked from CubeMX - @STTwo-32 ?


2 replies

ST Employee
October 22, 2024

Hello @joergk

You can find Documentation or user manual in the Help menu in STM32CubeMX, but most importantly, when you generate the code, for DMA2D for example, you will find in your main.c MX_DMA2D_Init(); where you can find the configuration you did using cubeMX.

Check:

Introduction to STM32CubeMX

How to build a “Blink LED” project from STM32CubeMX for ST/Atollic TrueSTUDIO® for STM32™ (youtube.com)

 

 

Andrew Neil
Super User
October 22, 2024

See also the HAL documentation for the particular STM32 family - it will be linked from the Product Page for the family

A complex system that works is invariably found to have evolved from a simple system that worked.A complex system designed from scratch never works and cannot be patched up to make it work.
joergkAuthor
Associate
October 22, 2024

"it will be linked from the Product Page for the family"

Where? On the website? Can not find it there.

https://www.st.com/en/microcontrollers-microprocessors/stm32h7-series.html 

Andrew Neil
Andrew NeilBest answer
Super User
October 22, 2024

Now we know the family ...

Go to the 'Tools and Software' tab, click 'MCU and MPU embedded software':

AndrewNeil_0-1729591072115.png

You want the STM32CubeH7 pack:

AndrewNeil_2-1729591236637.png

The User Manual is on the software page, 'Documentation' tab:

https://www.st.com/en/embedded-software/stm32cubeh7.html#documentation

 

Don't know why that isn't directly linked from CubeMX - @STTwo-32 ?


A complex system that works is invariably found to have evolved from a simple system that worked.A complex system designed from scratch never works and cannot be patched up to make it work.
STTwo-32
Technical Moderator
October 22, 2024

Hi @Andrew Neil 

I will escalate this suggestion to the STM32CubeMX team to consider it on the Future. Thank you.

Best Regards.

STTwo-32