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.
Fork of OmniWheels by
tools::export Namespace Reference
Namespaces | |
namespace | atmelstudio |
namespace | cces |
namespace | cmake |
namespace | coide |
namespace | ds5_5 |
namespace | e2studio |
namespace | embitz |
namespace | exporters |
namespace | gnuarmeclipse |
namespace | kds |
namespace | lpcxpresso |
namespace | makefile |
namespace | mcuxpresso |
namespace | qtcreator |
namespace | simplicity |
namespace | sw4stm32 |
namespace | zip |
Functions | |
def | mcu_ide_list |
def | mcu_ide_matrix |
def | get_exporter_toolchain |
def | rewrite_basepath |
def | subtract_basepath |
def | generate_project_files |
def | zip_export |
def | export_project |
Detailed Description
The generic interface for all exporters.
Function Documentation
def tools::export::export_project | ( | src_paths, | |
export_path, | |||
target, | |||
ide, | |||
libraries_paths = None , |
|||
linker_script = None , |
|||
notify = None , |
|||
verbose = False , |
|||
name = None , |
|||
inc_dirs = None , |
|||
jobs = 1 , |
|||
silent = False , |
|||
extra_verbose = False , |
|||
config = None , |
|||
macros = None , |
|||
zip_proj = None , |
|||
inc_repos = False , |
|||
build_profile = None , |
|||
app_config = None |
|||
) |
Generates a project file and creates a zip archive if specified Positional Arguments: src_paths - a list of paths from which to find source files export_path - a path specifying the location of generated project files target - the mbed board/mcu for which to generate the executable ide - the ide for which to generate the project fields Keyword Arguments: libraries_paths - paths to additional libraries linker_script - path to the linker script for the specified target notify - function is passed all events, and expected to handle notification of the user, emit the events to a log, etc. verbose - assigns the notify function to toolchains print_notify_verbose name - project name inc_dirs - additional include directories jobs - number of threads silent - silent build - no output extra_verbose - assigns the notify function to toolchains print_notify_verbose config - toolchain's config object macros - User-defined macros zip_proj - string name of the zip archive you wish to creat (exclude arg if you do not wish to create an archive
Definition at line 254 of file export/__init__.py.
def tools::export::generate_project_files | ( | resources, | |
export_path, | |||
target, | |||
name, | |||
toolchain, | |||
ide, | |||
macros = None |
|||
) |
Generate the project files for a project Positional arguments: resources - a Resources object containing all of the files needed to build this project export_path - location to place project files name - name of the project toolchain - a toolchain class that corresponds to the toolchain used by the IDE or makefile ide - IDE name to export to Optional arguments: macros - additional macros that should be defined within the exported project
Definition at line 187 of file export/__init__.py.
def tools::export::get_exporter_toolchain | ( | ide ) |
Return the exporter class and the toolchain string as a tuple Positional arguments: ide - the ide name of an exporter
Definition at line 136 of file export/__init__.py.
def tools::export::mcu_ide_list | ( | ) |
Shows list of exportable ides
Definition at line 76 of file export/__init__.py.
def tools::export::mcu_ide_matrix | ( | verbose_html = False ) |
Shows target map using prettytable Keyword argumets: verbose_html - print the matrix in html format
Definition at line 84 of file export/__init__.py.
def tools::export::rewrite_basepath | ( | file_name, | |
resources, | |||
export_path, | |||
loc | |||
) |
Replace the basepath of filename with export_path Positional arguments: file_name - the absolute path to a file resources - the resources object that the file came from export_path - the final destination of the file after export
Definition at line 145 of file export/__init__.py.
def tools::export::subtract_basepath | ( | resources, | |
export_path, | |||
loc = "" |
|||
) |
Rewrite all of the basepaths with the export_path Positional arguments: resources - the resource object to rewrite the basepaths of export_path - the final destination of the resources with respect to the generated project files
Definition at line 158 of file export/__init__.py.
def tools::export::zip_export | ( | file_name, | |
prefix, | |||
resources, | |||
project_files, | |||
inc_repos | |||
) |
Create a zip file from an exported project. Positional Parameters: file_name - the file name of the resulting zip file prefix - a directory name that will prefix the entire zip file's contents resources - a resources object with files that must be included in the zip project_files - a list of extra files to be added to the root of the prefix directory
Definition at line 212 of file export/__init__.py.
Generated on Fri Jul 22 2022 04:54:17 by
