Skip to content

setup.md

Latest commit

 

History

History
48 lines (31 loc) · 853 Bytes

setup.md

File metadata and controls

48 lines (31 loc) · 853 Bytes

Template Project Setup

1. Prerequisites

  • VSCode (recommended)
  • CMake + Ninja
  • Python 3

For MCU build/flash/debug:

  • STM32CubeCLT
  • openocd or ST-LINK_gdbserver
  • arm-none-eabi-gdb
  • tio (recommended for ./hyper uart; cu remains the fallback when available)

2. Quick Initialization

From the repository root:

./hyper init

This command:

  • creates virtual/
  • installs Python dependencies from requirements.txt
  • initializes template and deps/ST-LIB submodules

On Windows:

python hyper init

3. BOARD_NAME Configuration (codegen)

Code generation uses BOARD_NAME (CMake cache variable), and the value must exist in:

  • Core/Inc/Code_generation/JSON_ADE/boards.json

Example:

./hyper build main --preset board-debug --board-name TEST

If not set, the default value is TEST.