Release Notes for ST MC Workbench

STlogo

Copyright © 2022 STMicroelectronics

The ST Motor Control Workbench software tool provides the following features:

Supported devices and boards

Known Limitations

Update History

5.Y.4.21533-1.6.0.template-22-01-11/ 18-January-2022

Main Changes

Version 5.Y.4 of the Motor Control Software Development Kit (X-CUBE-MCDSK) is a bug fix release of version 5.Y.3. Its main purpose is to add support of STM32CubeMx version 6.4.0.

In addition, it also fixes the following issues:

STM32Cube Environment

Development Toolchains

5.Y.2.21279-1.5.0.template-21-06-29 / 22-July-2021

Main Changes

Version 5.Y.2 of the Motor Control Software Development Kit (X-CUBE-MCDSK) is a bug fix release for supporting STM32CubeMX version 6.3.0. In addition, it provides a few other updates and improvements on top of 5.Y.1:

Parameters visibility in STM32CubeMx

The Six Step drive firmware currently delivered with the SDK is not configurable with the Motor Control Workbench yet and it is only available through examples. However, the user can have some level of control over the configuration of the examples thanks to STM32CubeMx. Loading the .IOC file produced by the workbench into STM32CubeMx, navigating to the Pinout & Configuration pane, Component List (Categories) column, MiddleWare section and then clicking on MotorControl displays a configuration panel (See below).

STM32CubeMx

This panel appears on the right of the Component list column and displays a subset of the parameters of the Motor Control firmware. Refer to the documentation for the meaning of these parameters and how to change them. Most of these parameters belong to the Six Step drive firmware while some are shared with the FOC drive. Among the latter, ASPEP_OVER_UART and those which name starts with MCP_ configure the remote communication with the application with Motor Control Protocol. Users should not change them from STM32CubeMx unless they know the consequences.

Note that parameters shared with FOC drive are also displayed in STM32CubeMx in FOC configurations. However in this context, they must not be changed from STM32CubeMx. Indeed, some other, non visible, but related parameters may not be updated accordingly and changes made in the IOC file are not propagated back to the .STMCX MC Workbench project file.

STM32Cube Environment

Development Toolchains

5.Y.1.21203-1.3.0.template-21-03-25 / 3-May-2021

Main Changes

Version 5.Y.1 of the Motor Control Software Development Kit (X-CUBE-MCDSK) is a bug fix release of version 5.Y.0.

It fixes the following issue: The descriptions of EVSPIN32F0x inverter boards delivered with the Workbench had wrong DC & AC voltage supply ranges. These have been corrected as follows:

InverterWrong AC supply rangeCorrected AC supply rangeDC supply range
EVSPIN32F02Q1S1, EVSPIN32F0251S120 - 120 Vac15 - 120 Vac20 - 170 Vdc
EVSPIN32F06Q1S1, EVSPIN32F0601S150 - 280 Vac35 - 280 Vac50 - 400 Vdc
EVSPIN32F06Q2S1, EVSPIN32F0602S150 - 280 Vac35 - 280 Vac50 - 400 Vdc
EVSPIN32F06Q1S3, EVSPIN32F0601S350 - 280 Vac35 - 280 Vac50 - 400 Vdc

5.Y.0.21172 / 23-Apr-2021

The release 5.Y.0 of the Motor Control Software Development Kit (X-CUBE-MCDSK) is a step in between the current legacy version (v5.4.6 ) and the coming Version 6.

X-CUBE-MCSDK version 6 will allow:

Main Changes

In version 5.Y.0, the following changes are introduced:

5.4.6.21068-1.2.3.template-21-02-18 / 15-Mar-2021

Main Changes

Version 5.4.6 is a bug fix release of X-Cube-MCSDK v5.4.5.

Note: This bug fix release of X-Cube-MCSDK still supports IARM EWARM 7.x. See the 5.4.5.20506 release section and IAR EWARM 7.x end of support paragraph below

5.4.5.20506-1.2.2.template-20-11-05 / 18-Dec-2020

Main Changes

Version 5.4.4 is mainly a bug fix release of X-Cube-MCSDK v5.4.4. It also introduces a few new features.

IAR EWARM 7.x end of support

This section is meaningful for the web variant of the MCSDK only. The Full variant of MCSDK is not impacted since it is not delivered with binary libraries.

Binary libraries built with version 7.x of IAR EWARM can be used to generate MCSDK projects that build with IAR EWARM 7.x and 8.x. However, when used in EWARM 8.x projects, warnings are generated due to different sizes of the wchar_t type between EWARM 7.x and 8.x. These warnings are a source of frequent problem reports though they do not have negative consequences. In addition, EWARM 8.x has been available for a few years now. So, it is time now to definitively switch to EWARM 8.x and drop support for EWARM 7.x.

Starting with the next release of MCSDK, Web variant binary libraries will be built with EWAM 8.x. This will make it impossible to build with EWARM 7.x and older.

For the present release, Web variant binary libraries are provided both for EWARM 7.x and EWARM 8.x. However, when generating a project for IAR EWARM, only EWARM 8.x libraries are pulled in the project even if EWARM 7.x was selected in the workbench. To use the EWARM 7.x libraries the following procedure can be used:

  1. Remove the EWARM 8.x library from the generated project. It is located in the MCSDK_v5.4.5/MotorControl/lib folder in the generated project and named libmc-iar_M*.a, with M* the name of the Cortex M core used by the STM32 in the project. The folder contains all the libraries for all the cores and toolchains. Only one of them is actually used and its name is listed in the EWARM project.
  2. Copy the EWARM 7.x library file needed for the project from the Middlewares/ST/MotorControl/lib folder found in the MCSDK installation location. In this folder, EWARM v7.x libraries are named libmc-iar7_M*.a.
  3. Rename the libmc-iar7_M*.a file into libmc-iar_M*.a.

 

5.4.4.20160-1.1.0.template-20-04-17 / 19-May-2020

Main Changes

Pin assignment with NUCLEO-G431RB

The selection of NUCLEO-G431RB in combination with any power board that require the X-NUCLEO-IHM09 adapter now results in the following settings:

Over current settings correction for some power boards

Analyzing the UM of the boards and, verifying the formula with the application team, it appears that the UMs contain typos on the suggested values for the following OCP fields:

As a consequence, values has been changes as following:

 

V5.4.3.19514-1.0.6.template-19-11-14 / 18-Nov-2019

Main Changes

Using STM32CubeIDE with the Motor Control SDK

It is now possible to generate Motor Control application projects for STM32CubeIDE. These projects come with two build configuration, Release and Debug.

The Release configuration builds the application with the highest level of optimization, geared towards speed (-Ofast) but does not provide any debug capability. This configuration is meant for production firmware.

The Debug configuration, on the contrary, will provide the highest level of debug capability (-g3) but no optimization (-O0). Unfortunately, this configuration may not work out of the box with Motor Control Application:

To be able to debug the application, the Debugbuild configuration needs to be modified to add optimization. This can be done in the Project properties dialog, section C/C++ Build, selecting the Debug configuration and selecting Optimize for Speed for the MCU GCC Compiler / Optimization item.

 

V5.4.2.19506-1.0.6.template-19-10-28 / 04-Nov-2019

Main Changes

Using the Position Control feature

The position control feature can be activated on any configuration that uses an Encoder for speed and position feedback. To activate it, open the Drive Settings dialog from the main configuration panel of the workbench, and select the Position Control item from the Control mode combo box. Dual drive configurations are also supported; the position control can then be activated on any motor equipped with an Encoder.

V5.4.1.19301.1.0.3.template-19-06-27 / 05-July-2019

Main Changes

V5.4.0.19215-1.0.2.template-19-05-15 / 27-May-2019

Main Changes

Working with STM32CubeIDE for Motor Control projects

Motor Control projects generated with STM32 Motor Control Workbench fail to build. Before a solution can be developed for this issue, a work around exists that allows to use ST's new IDE with Motor Control projects by following the procedure described in this section and by respecting a few rules.

  1. In STM32 Motor Control Workbench, when generating or updating a project, choose either ST SW4 STM32 or ST TrueSTUDIO as the Target Toolchain. Note: STM32G4 based projects cannot be generated with TrueSTUDIO.
  2. Open STM32CubeIDE, go to the File menu and select the "Open Projects from File System..." item.
  3. In the dialog that opens, click the "Directory..." button on the "Import source" line. Navigate to the directory that contains the generated project and select it.
  4. The Dialog should now propose two projects for import. Select only the one that has the "Convert 'TrueSTUDIO..." or "Convert 'System Workbench..." mention in the "Import as column". The other one must not be selected.
  5. the imported project should build and run as expected.

It is important to follow a few rules when working with such imported projects:

STM32Cube Environment

Development Toolchains

V5.3.2.18569-0.15.6.template-19-01-16 / 18-Jan-2018

Main Changes

STM32Cube Environment

Development Toolchains

V5.3.2.18569-0.15.6.template-18-12-06 / 21-Dec-2018

Main Changes

STM32Cube Environment

Development Toolchains

 

V5.3.0.18528-0.15.6.template-18-12-06 / 10-Dec-2018

Main Changes

STM32Cube Environment

Development Toolchains

V5.2.0.18501-0.13.2.template-18-08-02

Main Changes

STM32Cube Environment

Development Toolchains

V5.1.2.18276-0.11.6.template-18-06-25 / 06-Jul-2018

This release is a bug fix release.

Main Changes

Development Toolchains

STM32Cube Environment

V5.1.0.18254C+WB_to_Mx_0.11.5.template-18-06-05 / 07-Jun-2018

This release is a bug fix release.

Main Changes

Development Toolchains

STM32Cube Environment

V5.1.0.18254C+WB_to_Mx_0.11.5.template-18-06-04 / 05-Jun-2018

Main Changes

Development Toolchains

STM32CubeMX Environment

V5.0.2+WB_to_Mx_0.9.9.templates-18-03-22B / 17-Apr-2018

Main Changes

Development Toolchains

STM32CubeMX Environment

V5.0.2 / 04-Apr-2018

Main Changes

Parallel Motor Control SDKversions support

Several versions of the Motor Control SDK can be installed in parallel on the same PC.Version 5.0.1 of the Motor Control Workbench would install the Motor Control Firmware in the user’s STM32Cube repository in the MotorControl folder (typically in C:\Users\<username>\STM32Cube\Repository\MotorControl). With version 5.0.2 onwards, the firmware is installed in the MCSDK_vX.Y.Z\MotorControl subfolder of the user’s STM32Cube repository where X.Y.Z is the version of the SDK (for instance C:\Users\JohnDoe\STM32Cube\Repository\MCSDK_v5.0.2\MotorControl). This allows for keeping several versions of the SDK and so to keep on working on application projects developed with different versions of the SDK.

The version of the SDK used on a given project is that of the Motor Control Workbench used to generate that project. Put in other words, Motor Control Workbench generates projects for the SDK version it is delivered with.

The version of the SDK to use is not stated in the .stmcx file. It is in the .ioc file generated by the workbench. So, when a project has been generated with a given version of the workbench is sticks to it. Unless it is generated again or updated with another version of the Workbench. In that latter case, it is recommended to erase the MCSDK_vX.Y.Z folder from the previous version…

V5.0.1 / 08-Mar-2018

Main Changes

Development Toolchains

STM32CubeMX Environment

License

This software package is licensed by ST under ST license SLA0048, the "License"; You may not use this package except in compliance with the License. You may obtain a copy of the License at:

For a complete documentation on STM32 Microcontrollers, please visit us at http://www.st.com/STM32