STM32Cube Software Example Table of Contents ¶

Table Of Contents

• STM32Cube Software Examples
  • Indices and tables
• How to use an example
  • What is an example?
    • What is in it for me ?
    • Categories of examples
    • HAL1 and HAL2-based examples
  • How to get STM32Cube Software Examples ?
    • STMicroelectronics GitHub
    • Folder structures
  • How to build and run
    • Step 1: Project extraction
    • Step 2: Open the IDE project
    • Step 3: Build the project
    • Step 4: Flash the project
    • Step 5: Run the project
  • User interactions
    • Using the board parts
      • User LED
      • User button
    • Using the pinout connections
    • Using the console
      • Logs evacuation
      • Terminal settings
    • Using the debugger
      • Build profile
      • System variables
  • Board to board examples
    • Vocabulary
    • Typical usage
    • Hardware setup
    • Typical communication logic
    • Observing the board to board communication
• How to read an example
  • Structure of the examples
    • Folder structure
    • Inclusion model
    • Code structure
  • README
    • How to display the README file?
    • What is in this file?
    • How to find it in the code?
      • Tags system
      • Writing conventions
    • Detailed explanations
      • Example behavior
      • Example configuration
    • See also section
  • Use-case code
    • Overview
    • Infrastructure
    • Processing
    • Conventions
      • Admonitions
      • Naming rules
  • Resources configuration
    • STM32 hardware resources
      • Files
      • Services
      • Naming conventions
    • Other resources
• How to configure an example
• How to debug an example
  • General debug tips
    • Flashing issues
    • Startup issues
    • Issues to connect to the board
    • HAL timing issues
    • Debug build profile
      • Observability
      • Step by step debugging
    • Debug toolbox
  • Fault exceptions
  • Debug FAQ
• How to port an example
  • Example architecture
    • Layered architecture
    • Example dependencies
      • Typical dependencies
      • Encapsulation concept
    • Resources handling
  • How to port the example to another board
• Get more with STM32Cube
  • Examples catalog
    • Get them
  • See also