Vitis Python API - 2024.2 English - UG1400

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)

Document ID
UG1400
Release Date
2025-01-20
Version
2024.2 English
Graphical development environments such as the Vitis IDE are useful for getting up to speed on development for a new processor architecture. It helps to abstract away and group most of the common functions into logical wizards that even a novice can use. However, scriptability of a tool is also essential for providing the flexibility to extend what is done with that tool. It is particularly useful when developing regression tests that be run nightly or when running a set of commands that are frequently used.

The Vitis command line interface (API) is an interactive and scriptable command-line interface to the Vitis IDE. As with other AMD tools, the scripting language for Vitis API is based on the Python. You can run Vitis API commands interactively or script the commands for automation.

Vitis API supports Vitis project management, configuration, building, and debugging, such as:

  • Creating platform projects and domains
  • Creating system and application projects
  • Configuring and building domains/BSPs and applications
  • Managing repositories
  • Downloading and running applications on hardware targets
  • Reading and writing registers
  • Setting break points and watch expressions
Note: You can view all the Python APIs from the Vitis menu: go to HelpDocumentVitis Python API Documentation.