5.3.1.21.18. cli.helpers.project_context

Shared helpers to detect foxBMS project/package execution context.

cli.helpers.project_context.PROJECT_ROOT

Path to the root of the project repository or package.

cli.helpers.project_context.ROOT_IS_PROJECT

True, when in the foxBMS repository, otherwise False.

cli.helpers.project_context.PROJECT_BUILD_ROOT

Path to the project’s build directory.

cli.helpers.project_context.FOXBMS_ELF_FILE

Path to the foxBMS ELF file.

cli.helpers.project_context.FOXBMS_BIN_FILE

Path to the foxBMS binary file.

cli.helpers.project_context.FOXBMS_APP_CRC_FILE

Path to the foxBMS CRC CSV file.

cli.helpers.project_context.FOXBMS_APP_INFO_FILE

Path to the foxBMS CRC info JSON file.

cli.helpers.project_context.APP_DBC_FILE

Path to the application DBC file.

cli.helpers.project_context.BOOTLOADER_DBC_FILE

Path to the bootloader DBC file.

Functions

get_env()

Check if command is run in the foxBMS repository or the fox CLI package and whether it is valid in this environment.

get_file_path()

Return path to the directory containing project-files if in the package, otherwise return PROJECT_ROOT

get_project_root([path])

Find the repository or package root directory.