ST life augmented UM3016 Motor Control Software Development Kit User Manual
The STM32 motor control software development kit (MC SDK) is part of the STMicroelectronics motor-control ecosystem. It is referenced as X-CUBE-MCSDK or X-CUBE-MCSDK-FUL according to the software license agreement applied. It includes:
- ST MC FOC firmware library for permanent magnet synchronous motor (PMSM) field-oriented control (FOC)
- ST MC 6-step firmware library
- ST motor profiler
- ST motor pilot
- ST MC workbench software tool, a graphical user interface (GUI) for the configuration of MC SDK firmware library parameters
This user manual explains how to use the ST motor profiler software tool included within the MC SDK firmware version 6.0.
The ST motor profiler software tool is part of the MC SDK that is used for the development of motor control applications running on STM32 32-bit microcontrollers, based on the Arm® Cortex®‑M processor.
The ST motor profiler provides the user with an easy and friendly way to find profiled information for a user custom motor and save it as user motor.
It runs on a PC system using Windows® and requires a USB Type-A connector.
Refer to the STM32 MC SDK release note to get all information about the ST motor profiler usage possibilities.
Note: Arm is a registered trademark of Arm Limited (or its subsidiaries) in the US and/or elsewhere.
Documents available from Arm® infocenter website
- Cortex®-M0 Technical Reference Manual
- Cortex®-M3 Technical Reference Manual
- Cortex®-M4 Technical Reference Manual
Documents available from www.st.com or your STMicroelectronics sales office
- STM32F0xx datasheets
- STM32F3xx datasheets
- STM32F4xx datasheets
- STM32G4xx datasheets
- STM32G0xx datasheets
- STM32F7xx datasheets
- STM32H7xx datasheets
- STM32L4xx datasheets
Motor control reference documents
Table 1 presents the documentation that helps to get a deeper understanding of the STMicroelectronics motor control solution.
Table 1. Reference documentation
1. UM3026 and UM3027 are respectively the evolutions of UM2374 and UM2380 for MC SDK 6.0.
The ST motor profiler
The ST motor profiler software tool can be used to identify the main permanent magnet synchronous motor (PMSM) characteristics, which are further transferred to the ST MC workbench.
3.1 Launch the ST motor profiler
Launch the ST Motor Profiler software tool by clicking either its icon (Figure 1) or either running directly from the installation folder.
Figure 1. ST Motor Profiler – Icon
The user can also launch the ST Motor Profiler software tool from the dedicated link button from the ST motor control workbench GUI (Figure 2).
Figure 2. ST Motor Profiler – GUI (Home page toolbar)
Then, the ST motor profiler starts up a GUI window as shown in Figure 3.
Figure 3. ST Motor Profiler – Start-up GUI
3.2 Configure your hardware setup
Click on the Select Boards button to display the list of supported boards (Figure 3), then choose your ST application board setup. Note that the ST motor profiler software tool can be used only with the ST hardware setup listed there. Figure 4 presents an example from this list.
Figure 4. ST Motor Profiler – Hardware setup list examples
Just click on the ST hardware setup to select it, thus configure the ST motor profiler software tool. As an example, Figure 4 shows the P-NUCLEO-IHM001 selection.
Then, complete the parameter fields with your motor information:
- The number of pole pairs inside your motor (mandatory field)
- The Max Speed of your motor (optional field):
– By default, the ST motor profiler software tool looks for the maximum allowed speed matching the motor and the hardware setup used.
- The Max Current admissible by your motor (optional field)
– By default, it is the maximum peak current deliverable by your hardware setup.
- The nominal DC bus voltage used by your hardware setup (optional field):
– By default, it is the power supply stage as either the bus voltage for low voltage applications (DC voltage) or the √2VACrms for high voltage applications (AC voltage).
- The magnetic build-in type (mandatory field):
– By default, it is the SM-PMSM with is selected.
- The Ld/Lq ratio (mandatory field) only in the case of I-PMSM build-in (Figure 6).
Figure 5 provides example values for the BR2804-1700KV-1 motor provided with the P-NUCLEO-IHM001 hardware setup.
Figure 5. ST Motor Profiler – SM-PMSM parameters example
Figure 6. ST Motor Profiler – I-PMSM parameters example
3.3 Connect to your hardware setup
When the ST motor profiler is configured, click on the Connect button (Fuchsia area in Figure 7).
Figure 7. ST Motor Profiler – Configured GUI
Then, depending on your hardware setup history, a status window appears as shown in Figure 7. ST Motor Profiler – Configured GUI. In case of a problem, a troubleshot message window will pop up (Table 2) to support your recovery action
Figure 8. ST Motor Profiler – Download status window
Table 2. ST Motor Profiler – Possible window messages
When successfully connected to your hardware setup, the Start Profile button must appear as surrounded in fuchsia in Figure 9.
Figure 9. ST Motor Profiler – Connected GUI
3.4 Profile your motor
Click on the Start Profile button as surrounded in Figure 9 to profile the motor.
First, the electrical parameters are identified, then the mechanical ones. In the case of over‑current fault detection, the profiling is restarted with a reduced current. When profiling is completed, all the motor measurements are shown in green or orange colors (Figure 10) depending on the relative accuracy. When red color is used, please check your hardware setup and restart the motor profiling sequence.
Figure 10. ST Motor Profiler – Profiled motor GUI
3.5 Save your profiled motor
Click on the Save… button (Figure 10) to store the motor measurements for later usage with the ST motor control workbench software tool.
Figure 11 shows the saving window in that case, then the user may provide the motor information:
- Naming of your profiled motor
- Provide details about your profiled motor
- Click on Save
Figure 11. ST Motor Profiler – Save window
3.6 Play with your motor
Click on the Play button (Figure 10. ST Motor Profiler – Profiled motor GUI) to spin your just profiled motor.
Figure 12 shows the spin control window. Preset the maximum acceleration and click on the Start button to activate your motor control. Then, select your Speed [RPM] with the cursor.
Figure 12. ST Motor Profiler – Spin control window (Start)
Figure 13 presents how to stop properly playing with your motor.
Figure 13. ST Motor Profiler – Spin control window (Stop)
3.7 End the ST motor profiler
Click on the Disconnect button (Figure 10) to stop properly the ST motor profiler software tool, then close the window using the upper‑right cross icon.
If you forgot to save your motor parameters, then select the No button (Figure 14), click on the Connect button (Figure 7) and save your motor parameters (Refer to Section 3.5 ). However, clicking on the Yes button loses your unsaved motor parameters and closes the ST motor profiler software tool.
Figure 14. ST Motor Profiler – Tool closure confirmation window
Table 3. Document revision history
IMPORTANT NOTICE – READ CAREFULLY
STMicroelectronics NV and its subsidiaries (“ST”) reserve the right to make changes, corrections, enhancements, modifications, and improvements to ST products and/or to this document at any time without notice. Purchasers should obtain the latest relevant information on ST products before placing orders. ST products are sold pursuant to ST’s terms and conditions of sale in place at the time of order acknowledgment.
Purchasers are solely responsible for the choice, selection, and use of ST products and ST assumes no liability for application assistance or the design of purchasers’ products.
No license, express or implied, to any intellectual property right is granted by ST herein.
Resale of ST products with provisions different from the information set forth herein shall void any warranty granted by ST for such product.
ST and the ST logo are trademarks of ST. For additional information about ST trademarks, refer to www.st.com/trademarks. All other product or service names are the property of their respective owners.
Information in this document supersedes and replaces information previously supplied in any prior versions of this document.
© 2022 STMicroelectronics – All rights reserved
Documents / Resources
|ST life augmented UM3016 Motor Control Software Development Kit [pdf] User Manual|
UM3016, Motor Control Software Development Kit, Software Development Kit, Motor Control Software, UM3016, Control Software
- STMicroelectronics: Our technology starts with you - STMicroelectronics
- STMicroelectronics Trademark List - STMicroelectronics
- X-CUBE-MCSDK-FUL - STM32 Motor Control Software Development Kit (MCSDK) - FULL source code - Registration and approbation needed for download - STMicroelectronics
- X-CUBE-MCSDK - STM32 Motor Control Software Development Kit (MCSDK) - STMicroelectronics
- Home - STMicroelectronics