embutils.repo.build module

Project build utilities.

date: 2021
author: Christian Wiche
contact: cwichel@gmail.com
license: The MIT License (MIT)

embutils.repo.build.build_cubeide(name: str, config: str, project: Union[bytes, bytearray, str, pathlib.Path], workspace: Union[bytes, bytearray, str, pathlib.Path], indexer: bool = False, clean: bool = True, log: Optional[Union[bytes, bytearray, str, pathlib.Path]] = None, pipe: bool = False, cwd: Optional[Union[bytes, bytearray, str, pathlib.Path]] = None) → subprocess.CompletedProcess[source]

Calls the STM32 CubeIDE headless builder on the specified project.

Note

stm32cubeidec executable must be in the PATH.
You cannot build if the workspace is already in use.
Reference: https://gnu-mcu-eclipse.github.io/advanced/headless-builds/

Parameters

name (str) – Project name.
config (str) – Build configuration to be used. Ex: Debug, Release.
project (TPPath) – Path to CubeIDE project.
workspace (TPPath) – Path to CubeIDE workspace.
indexer (bool) – Runs the indexer on build.
clean (bool) – Performs a clean build.
log (TPPath) – Path to store the build logs.
pipe (bool) – Enable pipe output to terminal.
cwd (TPPath) – Execution CWD.

Returns

Execution results.

Return type

sp.CompletedProcess

embutils.repo.build.build_iar(config: str, project: Union[bytes, bytearray, str, pathlib.Path], clean: bool = True, log: Optional[Union[bytes, bytearray, str, pathlib.Path]] = None, pipe: bool = False, cwd: Optional[Union[bytes, bytearray, str, pathlib.Path]] = None) → subprocess.CompletedProcess[source]

Calls the IAR headless builder on the specified project.