Command-line execution - Peripherals Tool
This section describes the Command Line Interface (CLI) commands supported by the Peripherals Tool.
| Command name | Definition and parameters | Description | Restriction | Example |
|---|---|---|---|---|
| Enable tool | -Enable |
Enables the tool if it is disabled in the current configuration. |
Requires -HeadlessTool Peripherals | -HeadlessTool Peripherals -Enable |
|
Import C files |
-ImportC |
Imports .c files into the configuration. Importing is done after loading mex and before generating outputs. |
Requires -HeadlessTool Peripherals | -HeadlessTool Peripherals -ImportC C:/imports/file1.c C:/imports/file2.c |
|
Export all generated files (to simplify all exports commands to one command) |
-ExportAll |
Exports generated files (with source code and so on) The code is regenerated before the export. Includes -ExportSrc, -ExportHTML, and in framework -ExportMEX The argument is expected to be a folder. |
Requires -HeadlessTool Peripherals | -HeadlessTool Peripherals -ExportAll C:/exports/generated |
| Export Source files | -ExportSrc |
Exports generated source files. The code is regenerated before the export. The argument is expected to be a folder. |
Requires -HeadlessTool Peripherals | -HeadlessTool Peripherals -ExportSrc C:/exports/src |
| Export the HTML report file | -ExportHTML |
Exports the generated HTML report file. The code is regenerated before the export. The argument is expected to be a folder. |
Requires -HeadlessTool Peripherals | -HeadlessTool Peripherals -ExportHTML C:/exports/html |
| Migrate all Peripherals tool components to the versions used in toolchain project | -MigrateComponentsToToolchainVersion | Migrates all instances of Peripherals tool components, which are not configuring the version used in the toolchain project, to the version of SDK component used in toolchain project. No changes are done when toolchain is not linked or the Peripherals tool component already configures the version of the SDK component used in the toolchain project. | Requires -HeadlessTool Peripherals | -HeadlessTool Peripherals -MigrateComponentsToToolchainVersion -ExportAll C:/exports/toolchainVersions |
| Migrate all Peripherals tool components to the highest supported version of the SDK component | -MigrateComponentsToLatestVersion | Migrates all instances of Peripherals tool components to the MCU's highest supported version of the SDK component, which the Peripherals tool component configures. No changes are done when already using the highest version available on the MCU. | Requires -HeadlessTool Peripherals | -HeadlessTool Peripherals -MigrateComponentsToLatestVersion -ExportAll C:/exports/toolchainVersions |
| Regenerate all PLU configurations | -PLURegenerateConfigurations | Regenerates content of all PLU instances present in the configuration. Currently only the PLU instances in Verilog file and Verilog text modes are regenerated by new Verilog code synthesis and optimization of the model. Requires usage of mapping comment in the Verilog code. | Requires -HeadlessTool Peripherals | -Load C:/xyz.mex -HeadlessTool Peripherals -PLURegenerateConfigurations - ExportAll C:/exports/plu |