2019-05-28 10:47 AM
Hello,
I am looking for a document or online resource that lists the available functions and provides information on their functionality, inputs and outputs.
For example, if searching for HAL I2C functions, then can use this:
However, looking for an official ST document or link to online resource.
Thanks!
Solved! Go to Solution.
2019-05-30 04:58 AM
The mcu has no API, it has peripheral registers, and these are described in detail in the reference manual.
But you probably mean CubeF7/HAL API. It's at the CubeF7 webpage, https://www.st.com/en/embedded-software/stm32cubef7.html#resource under Resources, User Manuals, UM1905.
Most of those almost 2000 pages are doxygened from the Cube sources, so you can simply dig into them, too.
JW
2019-05-28 11:11 AM
ST provides the library source, with the function parameters documented in-line, most of the documentation is a digest of that. I've personally found that adequate.
Most IDE these days provide for auto-complete, and function navigation, and there are assorted static analysis tools in common use.
2019-05-30 04:27 AM
@Community member thanks for the answer. It does help when coding.
At the same time, there are other activities not done within an IDE e.g., design, organizational communication etc, that require adding pointers to some online resources that the other party can reference easily. For example, when communicating on Java APIs, can point to Oracle JDK online JavaDocs etc.
Would be great to have such online resource as well. Any link would be much appreciated.
Thanks!
2019-05-30 04:58 AM
The mcu has no API, it has peripheral registers, and these are described in detail in the reference manual.
But you probably mean CubeF7/HAL API. It's at the CubeF7 webpage, https://www.st.com/en/embedded-software/stm32cubef7.html#resource under Resources, User Manuals, UM1905.
Most of those almost 2000 pages are doxygened from the Cube sources, so you can simply dig into them, too.
JW