Anders Blomdell / mbed-sdk-tools

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

sources::project Namespace Reference
Functions

sources::project Namespace Reference

Functions

def setup_project
def export
def main

Detailed Description

The CLI entry point for exporting projects from the mbed tools to any of the
supported IDEs or project structures.

Function Documentation

def sources::project::export (   target,
  ide,
  build = None,
  src = None,
  macros = None,
  project_id = None,
  zip_proj = False,
  build_profile = None,
  export_path = None,
  notify = None,
  app_config = None,
  ignore = None 
) 
Do an export of a project.

Positional arguments:
target - MCU that the project will compile for
ide - the IDE or project structure to export to

Keyword arguments:
build - to use the compiled mbed libraries or not
src - directory or directories that contain the source to export
macros - extra macros to add to the project
project_id - the name of the project
clean - start from a clean state before exporting
zip_proj - create a zip file or not
ignore - list of paths to add to mbedignore

Returns an object of type Exporter (tools/exports/exporters.py)

Definition at line 110 of file project.py.

def sources::project::main (  ) 
Entry point

Definition at line 362 of file project.py.

def sources::project::setup_project (   ide,
  target,
  zip,
  program,
  source_dir,
  build,
  export_path 
) 
Generate a name, if not provided, and find dependencies

Positional arguments:
ide - IDE or project structure that will soon be exported to
target - MCU that the project will build for

Keyword arguments:
program - the index of a test program
source_dir - the directory, or directories that contain all of the sources
build - a directory that will contain the result of the export

Definition at line 57 of file project.py.

Generated on Tue Jul 12 2022 17:12:48 by  doxygen 1.7.2