Advanced Scripting

Warning

Advanced Scripting is recommended for Advanced Users and requires knowledge of the Python language.

Warning

Dynamic build flags is a highly recommended alternative to advanced scripting, where you can use any programming language. Also, that option is useful if you need to apply changes to the project before the building/uploading process, such as:

• Macro with the latest VCS revision/tag “on-the-fly”

• Generate dynamic headers (*.h)

• Process media content before generating SPIFFS image

• Make some changes to source code or related libraries

Contents

• Advanced Scripting

The PlatformIO Build System allows the user to extend the build process with custom scripts using the Python interpreter and the SCons construction tool. Build flags, upload flags, targets, toolchains data and other information are available for modification as SCons Construction Environments. Custom scripts are included with extra_scripts

Warning

You can not run or debug these scripts manually with a Python interpreter. They will be loaded automatically when the pio run command processes the project environment.

• Launch Types
• Construction Environments
• Before/Pre and After/Post Actions
• Build Middlewares
• Custom Targets
  • Build System API
  • Examples
• Examples
  • Custom options in platformio.ini
  • Split C/C++ build flags
  • Extra linker flags without -Wl, prefix
  • Custom upload tool
  • Upload to Cloud (OTA)
  • Custom firmware/program name
  • Override package files
  • Override board configuration
  • Custom debug flags
  • Extra Python packages
  • Build external sources