UM1718

Installing and running STM32CubeMX

To run STM32CubeMX as a standalone application on Windows select STM32CubeMX

from Program Files > ST Microelectronics > STM32CubeMX or double-click

STM32CubeMX icon on your desktop.

To run STM32CubeMX as a standalone application on Linux, launch the STM32CubeMX

executable from STM32CubeMX installation directory.

To run STM32CubeMX as a standalone application on macOS, launch the STM32CubeMX

application from the launchpad.

Note:

There is no STM32CubeMX desktop icon on macOS.

UM1718 Rev 41

35/453

Installing and running STM32CubeMX

UM1718

Command line

Purpose

Example

help

Displays the list of available commands.

help

swmgr refresh

Refreshes the list of embedded software

swmgr refresh

package versions available for download.

swmgr install

Installs the specified STM32Cube MCU

stm32cube_<series>

swmgr install stm32cube_f1_1.8.0 ask

package version.

_<version> ask

swmgr remove

Removes the specified STM32Cube MCU

stm32cube_<series>

swmgr remove stm32cube_f1_1.8.0

_<version>

package version.

swmgr install

swmgr install STMicroelectronics.

<packVendor>.<packName>.

Installs the specified pack version.

X-CUBE-NFC4.1.4.1 ask

<packVersion> ask

swmgr remove

swmgr remove STMicroelectronics.

<packVendor>.<packName>.

Removes the specified pack version.

X-CUBE-BLE1.4.2.0

<packVersion>

36/453

UM1718 Rev 41

UM1718

Installing and running STM32CubeMX

Table 1. Command line summary (continued)

Command line

Purpose

Example

Selects a software pack component to add

in the project.

The presence of “/” in the second and/or

pack enable <vendor>

the fifth parameter(s) indicates,

respectively, the explicit mention of a

pack enable STMicroelectronics

<pack>[/bundle] <version>

bundle and/or a subgroup (reference: Arm

<class> <group>[/subgroup]

CMSIS pack pdsc format).

“X-CUBE-BLE1/BlueNRG-MS” 1.0.0

"Wireless" "Controller"

[variant]

To find out the pack / bundle / class / group

/ subgroup names of the component to

enable, select the component and click

“Hide/Show details” from the Additional

Software window.

Applies in the project all pack components

pack validate

enabled since the “pack validate”

pack validate

command was last called.

load <mcu>

Loads the selected MCU.

load STM32F101RCTx

load STM32F101Z(F-G)Tx

load <board part number>

Loads the selected board with all

loadboard NUCLEO-F030R8

peripherals configured in their default

allmodes

<allmodes|nomode>

mode (allmodes) or without any

loadboard NUCLEO-F030R8 nomode

configuration (nomode).

config load <filename>

Loads a previously saved configuration.

config load

“C:\Cube\ccmram\ccmram.ioc”

config save <filename>

Saves the current configuration.

config save

“C:\Cube\ccmram\ccmram.ioc”

Saves the current configuration with all

config saveext <filename>

parameters, including those for which

config saveext

values have been kept to default

“C:\Cube\ccmram\ccmram.ioc”

(unchanged by the user).

config saveas <filename>

Saves the current project under a new

config saveas

name.

“C:\Cube\ccmram2\ccmram2.ioc”

csv pinout <filename>

Exports the current pin configuration as a

Csv pinout mypinout.csv

csv file. This file can be (later) imported

into a board layout tool.

script <filename>

Runs all commands in the script file. There

script myscript.txt

must be one command per line.

This option allows the user to choose

between 0 (to generate the peripheral

project couplefilesbyip <0|1>

initializations in the main) and 1 (to

project couplefilesbyip 1

generate each peripheral initialization in

dedicated .c/.h files).

UM1718 Rev 41

37/453

Installing and running STM32CubeMX

UM1718

Table 1. Command line summary (continued)

Command line

Purpose

Example

For the supported series, STM32CubeMX

can generate peripheral initialization code

setDriver <Peripheral Name>

based on LL or on HAL drivers. This

setDriver ADC LL

command line allows the user to choose,

<HAL | LL>

for each peripheral, between HALand LL-

setDriver I2C HAL

based code generation. By default code

generation is based on HAL drivers.

Generates only “STM32CubeMX

generated” code and not a complete

generate code <path>

project (including STM32Cube firmware

generate code C:\mypath

libraries and toolchains project files).

To generate a project, use “project

generate”.

Sets the path to the source folder

set tpl_path <path>

containing the .ftl user template files.

set tpl_path C:\myTemplates\

All the template files stored in this folder

are used for code generation.

Sets the path to the destination folder that

set dest_path <path>

will hold the code generated according to

set dest_path C:\myMXProject\inc\

user templates.

get tpl_path

Retrieves the path name of the user

get tpl_path

template source folder.

get dest_path

Retrieves the path name of the user

get dest_path

template destination folder.

SetStructure

Selects the project structure to generate.

SetStructure Basic

<Advanced/Basic>

SetCopyLibrary

Selects how the reference libraries are

<copy all / copy only /

SetCopyLibrary "copy all"

copied to the projects.

copy as reference>

project setCustomFWPath

Specifies a path to STM32Cube MCU

project SetCustomFwPath

software libraries different from

"F:/SharedRepository/STM32Cube_F

<CustomFwLocation>

STM32Cube repository path (specified

W_F0_V1.11.0"

under Help > Updater settings).

Specifies the toolchain to be used for the

EWARM

project toolchain <toolchain>

project.

“MDK-ARM V4”

Use the “project generate” command to

“MDK-ARM V5”

generate the project for that toolchain.

STM32CubeIDE

project name <name>

Specifies the project name.

project name ccmram

project path <path>

Specifies the path where to generate the

project path C:\Cube\ccmram

project.

project generate

Generates the full project.

project generate

login < email_adress>

Allows you to login to download software

login john.smith@st.com mypassword

<password> <remember_me>

packages.

y

exit

Ends STM32CubeMX process.

exit

38/453

UM1718 Rev 41