Difference between revisions of "STM32MotorControl:STM32 MC Motor Pilot - Start-up guide"

[quality revision] [quality revision]
m
m
 


Based on STM32 MC Motor Pilot 5.Y.2 V0.9.7 (included in STM32 MC-SDK 5.Y.2).

1

Missing features to be added soon

1 Overview of the STM32 MC motor-pilot tool[edit]

STM32 MC Motor Pilot is a monitoring tool for STM32 motor-control applications that:

  • Connects connects to MC applications built with the UI module through the serial port
  • Uses uses the same protocol as the current monitor
  • Allows allows for controlling, monitoring, and tuning MC applications
  • Will replace replaces in the future the monitor part of STM32 MC workbench
    • Current current available version is an already usable preview
STM32 MC MotorPilot slide3.png

STM32 MC Motor Pilot added values are:

  • Enhanced enhanced plotting feature: the user can now plot most registers
  • The the user can easily customize GUI at run time
    • To to fit specific needs or to experiment with new firmware features
  • Solid solid foundation to support future firmware features
    • ACIM, 6-Step, Sensorless Zero sensor-less zero speed, enhanced debug features
  • Runs runs on all three MCD target platforms: Windows, Mac, and Linux

2 STM32 MC Motor Pilot Quick Guidemotor-pilot quick guide[edit]

2.1 Installation and Runrun[edit]

STM32 MC Motor Pilot is now automatically installed with STM32 MC SDK.

A shortcut is now created in Windows menus to run it.

2.2 Quick Startstart-up[edit]

2.2.1 Quick step 1[edit]

  1. MotorPilot:
    • Starts starts unconnected
      STM32 MC MotorPilot slide6 1.png
    • Lists lists available serial ports
      STM32 MC MotorPilot slide6 2.png
    • Displays displays the default UI
  2. Connect a Motor Pilot board to the PC.
  3. Click on Connect.
STM32 MC MotorPilot slide6 3.png

2.2.2 Quick step 2[edit]

  1. When MotorPilot is connected, it:
    • Displays displays version of embedded firmware
      STM32 MC MotorPilot slide7 1.png
      Shows the
    • current state and the errors retrieves importants parameters for motor control form the board and adjust the GUI with theses informations
    • starts to monitor parameters needed by the GUI
      STM32 MC MotorPilot slide7 3.png
  2. Spin the motor:
    • Click on the Start button.
      STM32 MC MotorPilot slide7 2.png
  3. Motors starts and the monitor displays the speed pilot updates the GUI.
    STM32 MC MotorPilot slide7 4.png
    • And the currents
    • And other information

2.2.3 Quick step 3[edit]

  1. Control the motor:
    • Slide the knob to set the speed
      STM32 MC MotorPilot slide8 1.png
    • Set Target Speed, Duration and
Click
    • click to apply a ramp
      STM32 MC MotorPilot slide8 2.png
STM32 MC MotorPilot slide8 3.png
  • Click Stop Ramp to stop it before end
    STM32 MC MotorPilot slide9 1.png
  • Click Stop to stop spinning the motor
    STM32 MC MotorPilot slide9 2.png
STM32 MC MotorPilot slide9 3.png

3 MC application parameters[edit]

STM32 MC Motor Pilot gets MC application parameters from the board and adapts widgets to them.

4 MC application advanced settings[edit]

4.1 Speed PID, Toque PID, Flux PID and Flux reference[edit]

  1. Click Advanced Configuration:
    • Displays displays additional panel with more settings
      STM32 MC MotorPilot slide11.png
  2. As in the current monitor, customizes:
    • Speed PID
    • Toque PID
    • Flux PID
    • Set Flux reference

4.2 State Observer, PLL parameters, CORDIC parameters and DAC settings[edit]

  1. Click Advanced Configuration
    • Displays additional panel with more settings
  2. As in the current monitor, customizes:
    • State Observer + PLL parameters
    • State Observer + CORDIC parameters
  3. Missing from the current monitor:
    • Revup phases configuration
      • Will be present in future versions of the tool
  4. DAC settings are at the bottom left
STM32 MC MotorPilot slide12.png
STM32 MC MotorPilot ADVANCED CONFIG.png
  1. if DAC is available on your board you can select which register you want to output on it

4.3 Handling Errorserrors[edit]

4.3.1 Control Board disconnection[edit]

Board freeze due to firmware critical error or breakpoint trigger:

  • Resume execution or reset the board, and the connection will resumeresumes.
STM32 MC MotorPilot slide13.pngSTM32 MC MotorPilot Connect ERROR.png

4.3.2 Firmware errors[edit]

  • As with the current monitor, current and past errors are indicated.
  • Clicking the Ack Faults button has no effect in the FAULT_NOW state
STM32 MC MotorPilot slide14.pngSTM32 MC MotorPilot FAULT NOW.png


  • Wait for the fault conditions to vanish to enter the FAULT_OVER state
STM32 MC MotorPilot FAULT OVER.png
  • Then click on Ack Faults to go back to IDLESTM32 MC MotorPilot slide15 1.png
STM32 MC MotorPilot FAULT ACK.png
STM32 MC MotorPilot slide15 2.png


4.4 Viewing and plotting registers by pooling (with low-speed plotting)[edit]

With this method of plot, any register can be plot but at low rate (polling every 200 ms by default)

  1. Clicking the Registers tab displays the list of all registers
    STM32 MC MotorPilot slide16 1.png
    Clicking a (see (1) on the following figure)
    STM32 Motor Pilot - new picture.png
  2. Click a "Click to Plot" button (see (2) on the figure)
    • Opens a plot window the first time
    • Lets the user decide where to plot the other times (see (3) on the figure)
      STM32 MC MotorPilot slide16 2.png
    • Lets the user choose to stop showing the already pointed register (see (4) on the figure).

4.

4.1 And soon in this start-up guide:[edit]
  • Viewing and plotting registers by pooling for high-speed plotting
  • frame logger and decoder

4.5 5 Viewing and plotting registers with high-speed plotting[edit]

With this method of plot, only a subset of registers can be plot at PWM frequency rate

  • Once the motor is connected (and motor started)
  • Click on the "Plot" button
STM32 MC MotorPilot plot button.png
  • A "High Frequency Plot" window opens:
STM32 MC Motor Pilot plot1.png
  • Click again to open more plot windows
  • Resize these windows to optimize the display of plots on your desktop
  • Right-click to select the register you want to plot:
STM32 MC Motor Pilot plot2.png
  • Click again to plot more registers:
STM32 MC Motor Pilot plot3.png
  • The data display width is defined by adjusting the buffer size (change buffering to display more data):
STM32 MC Motor Pilot plot4.png
  • When displaying 2 registers, you can switch to the X / Y plot:
STM32 MC Motor Pilot plot5.png
  • Dynamic plot display can be paused and resumed as desired.
  • Each register plot can be hidden or displayed by double-clicking on the register name in the plot legend (then when the register plot is hidden, the corresponding register name is strikethrough).
STM32 MC Motor Pilot plot6.png

4.6 Rev-up configuration[edit]

  • Click on "Rev-up" button and then the application panel is replaced by rev-up configuration panel.
STM32 MC Motor Pilot revup.png
  • This panel allows to set up to 5 rev-up steps by direct edit in the corresponding table for which a step rev-up duration, a final torque value and a final speed value are defined. (use the same values to have less steps).


4.7 UI is changeable at run-time[edit]

  • Click on menu item File => Load
    • Search for a .qml file and open it.
    • For instance, GUI\PositionControlApp.qml found in the release.
  • This will load loads a new GUI with other features
    • In the case of PositionControlApp.qml, a position control enabled monitoring application.
  • Future versions of the tool will let users change this UI themselves
STM32 MC MotorPilot slide19.png

5 Current limitations and future plans[edit]

5.1 Missing features to be added soon[edit]

  • Revup configuration UI
  • Dual Drive support
  • Filtering and sorting registers’ view
  • UI API description and development guide
    • To let users customize the UI for their own needs
STM32 MC MotorPilot slide19.png
  • Users are able to change the UI by copying an existing ".qml" file and editing it.



{{DISPLAYTITLE:STM32 MC Motor Pilot - Start-up guide}}

Based on STM32 MC Motor Pilot 5.Y.2 V0.9.7 (included in STM32 MC-SDK 5.Y.2).

==Overview of the STM32 MC motor-pilot tool==

STM32 MC Motor Pilot is a monitoring tool for STM32 motor-control applications:
* Connects  that:
*connects to MC applications built with the UI module through the serial port 
*Usesuses the same protocol as the current monitor
*Allowsallows for controlling, monitoring, and tuning MC applications
* Will replace replaces in the future the monitor part of STM32 MC workbench
** Currentcurrent available version is an already usable preview
[[file:STM32_MC_MotorPilot_slide3.png|600px|center]]

STM32 MC Motor Pilot added values:
* Enhanced are:
* enhanced plotting feature: the user can now plot most registers
* Thethe user can easily customize GUI at run time
** Toto fit specific needs or to experiment with new firmware features
* Solidsolid foundation to support future firmware features
** ACIM, 6-Step, Sensorless Zerosensor-less zero speed, enhanced debug features
* Runsruns on all three MCD target platforms: Windows, Mac, and Linux

==STM32 MC Motor Pilot Quick Guide==

===Installation and Runmotor-pilot quick guide==

===Installation and run===

STM32 MC Motor Pilot is now automatically installed with STM32 MC SDK.

A shortcut is now created in Windows menus to run it.

===Quick Startstart-up===

====Quick step 1====

# MotorPilot:
#* Startsstarts unconnected [[file:STM32_MC_MotorPilot_slide6_1.png|200px|center]]
#* Listslists available serial ports [[file:STM32_MC_MotorPilot_slide6_2.png|200px|center]]
#* Displaysdisplays the default UI
# Connect a Motor Pilot board to the PC.

# Click on Connect.


[[file:STM32_MC_MotorPilot_slide6_3.png|600px|center]]

====Quick step 2====

# When MotorPilot is connected, it:
#* Displaysdisplays version of embedded firmware [[file:STM32_MC_MotorPilot_slide7_1.png|200px|center]]
#* Shows the current state and the errors retrieves importants parameters for motor control form the board and adjust the GUI with theses informations
#* starts to monitor parameters needed by the GUI [[file:STM32_MC_MotorPilot_slide7_3.png|600px|center]]
# Spin the motor:
#* Click on the Start button. [[file:STM32_MC_MotorPilot_slide7_2.png|200px|center]]
# Motors starts and the monitor displayspilot updates the speedGUI. [[file:STM32_MC_MotorPilot_slide7_4.png|200px|center]]#* And the currents
#* And other information

====Quick step 3====

* Control the motor
**

====Quick step 3====

# Control the motor:
#* Slide the knob to set the speed [[file:STM32_MC_MotorPilot_slide8_1.png|200px|center]]**#* Set Target Speed, Duration and Clickclick to apply a ramp [[file:STM32_MC_MotorPilot_slide8_2.png|200px|center]]

[[file:STM32_MC_MotorPilot_slide8_3.png|600px|center]]

** Click Stop Ramp to stop it before end [[file:STM32_MC_MotorPilot_slide9_1.png|200px|center]]
** Click Stop to stop spinning the motor [[file:STM32_MC_MotorPilot_slide9_2.png|200px|center]]

[[file:STM32_MC_MotorPilot_slide9_3.png|200px|center]]

==MC application parameters==

STM32 MC Motor Pilot gets MC application parameters from the board and adapts widgets to them.

==MC application advanced settings==

===Speed PID, Toque PID, Flux PID and Flux reference===

# Click Advanced Configuration:

#* Displaysdisplays additional panel with more settings [[file:STM32_MC_MotorPilot_slide11.png|600px|center]]
# As in the current monitor, customizes:
#* Speed PID
#* Toque PID
#* Flux PID
#* Set Flux reference

===State Observer, PLL parameters, CORDIC parameters and DAC settings===

# Click Advanced Configuration
#* Displays additional panel with more settings
# As in the current monitor, customizes:
#* State Observer + PLL parameters
#* State Observer + CORDIC parameters# Missing from the current monitor:
#* Revup phases configuration
#** Will be present in future versions of the tool
# DAC settings are at the bottom left

[[file:STM32_MC_MotorPilot_slide12.png|600px|center]]

===Handling Errors[[File:STM32 MC MotorPilot ADVANCED CONFIG.png|600px|center]]
# if DAC is available on your board you can select which register you want to output on it

===Handling errors===

====Control Board disconnection====

Board freeze due to firmware critical error or breakpoint trigger:
* Resume execution or reset the board, and the connection will resume

[[file:STM32_MC_MotorPilot_slide13resumes.

[[File:STM32 MC MotorPilot Connect ERROR.png|600px|center]]

====Firmware errors====

* As with the current monitor, current and past errors are indicated.
* Clicking the Ack Faults button has no effect in the FAULT_NOW state

[[file[[File:STM32_ MC_ MotorPilot_slide14 FAULT NOW.png|600px|center]]

* Wait for the fault conditions to vanish to enter the FAULT_OVER state[[File:STM32 MC MotorPilot FAULT OVER.png|600px|center]]* Then click on Ack Faults to go back to IDLE [[file

[[File:STM32_ MC_ MotorPilot_slide15_1 FAULT ACK.png|200px600px|center]]
<br clear=all>
[[file:STM32_MC_MotorPilot_slide15_2.png|600px|center]]

===Viewing and plotting registers by pooling (with low-speed plotting)===
 ===
With this method of plot, any register can be plot but at low rate (polling every 200 ms by default)<!-- to be delete in the database : [[file:STM32_MC_MotorPilot_slide16_1.png|600px|center]] -->

# Clicking the Registers tab displays the list of all registers[[file:STM32_MC_MotorPilot_slide16_1 (see (1) on the following figure) [[file:STM32_Motor_Pilot_-_new_picture.png|600px|center]]
# ClickingClick a "Click to Plot" button #(see (2) on the figure)
#* Opens a plot window the first time
#* Lets the user decide where to plot the other times  (see (3) on the figure) [[file:STM32_MC_MotorPilot_slide16_2.png|600px|center]]
#* Lets the user choose to stop showing the already pointed register.

====And soon in this start-up guide:====

* Viewing and plotting registers by pooling for high-speed plotting
* frame logger and decoder
 (see (4) on the figure).

===Viewing and plotting registers with high-speed plotting ===
With this method of plot, only a subset of registers can be plot at PWM frequency rate

* Once the motor is connected (and motor started)
* Click on the "Plot" button
[[file:STM32_MC_MotorPilot_plot_button.png|center]]
* A "High Frequency Plot" window opens:
[[file:STM32_MC_Motor_Pilot_plot1.png|600px|center]]
* Click again to open more plot windows
* Resize these windows to optimize the display of plots on your desktop
* Right-click to select the register you want to plot:
[[file:STM32_MC_Motor_Pilot_plot2.png|600px|center]]
* Click again to plot more registers:
[[file:STM32_MC_Motor_Pilot_plot3.png|600px|center]]
* The data display width is defined by adjusting the buffer size (change buffering to display more data):
[[file:STM32_MC_Motor_Pilot_plot4.png|600px|center]]
* When displaying 2 registers, you can switch to the X / Y plot:
[[file:STM32_MC_Motor_Pilot_plot5.png|600px|center]]
* Dynamic plot display can be paused and resumed as desired.
* Each register plot can be hidden or displayed by double-clicking on the register name in the plot legend (then when the register plot is hidden, the corresponding register name is strikethrough).
[[file:STM32_MC_Motor_Pilot_plot6.png|600px|center]]

===Rev-up configuration===

* Click on "Rev-up" button and then the application panel is replaced by rev-up configuration panel.

[[file:STM32_MC_Motor_Pilot_revup.png|800px|center]]

* This panel allows to set  up to 5 rev-up steps by direct edit in the corresponding table for which a step rev-up duration, a final torque value and a final speed value are defined. (use the same values to have less steps).
<!--
====And soon in this start-up guide:====

* frame logger and decoder
-->

===UI is changeable at run-time===

* Click on menu item File => Load
** Search for a .qml file and open it.
** For instance, GUI\PositionControlApp.qml found in the release.

* This will load loads a new GUI with other features
**In the case of PositionControlApp.qml, a position control enabled monitoring application.* Future versions of the tool will let users change this UI themselves

[[file:STM32_MC_MotorPilot_slide19.png|600px|center]]
==Current limitations and future plans==

===Missing features to be added soon===

* Revup configuration UI
* Dual Drive support
* Filtering and sorting registers’ view
* UI API description and development guide
** To let users customize the UI for their own needs
* Users are able to change the UI by copying an existing ".qml" file and editing it.
<!--
==Current limitations and future plans==

===Missing features to be added soon===

* Dual Drive support
* Filtering and sorting registers’ view
* UI API description and development guide
** To let users customize the UI for their own needs
-->

<noinclude>

[[Category:Motor Control]]
{{PublicationRequestId | 21096 | 9/13/2021 | Souade MENDJELI }}
{{PublicationRequestId | 22275 | 19/01/2022 | under TW assignment}}<noinclude>

<!--
Internal source: "Motor Pilot 0.9.X - Start up Guide.pptx" VX.0
-->
(33 intermediate revisions by 4 users not shown)
Line 5: Line 5:
 
==Overview of the STM32 MC motor-pilot tool==
 
==Overview of the STM32 MC motor-pilot tool==
   
STM32 MC Motor Pilot is a monitoring tool for STM32 motor-control applications:
+
STM32 MC Motor Pilot is a monitoring tool for STM32 motor-control applications that:
* Connects to MC applications built with the UI module through the serial port  
+
*connects to MC applications built with the UI module through the serial port  
*Uses the same protocol as the current monitor
+
*uses the same protocol as the current monitor
*Allows for controlling, monitoring, and tuning MC applications
+
*allows for controlling, monitoring, and tuning MC applications
* Will replace the monitor part of STM32 MC workbench
+
*replaces in the future the monitor part of STM32 MC workbench
** Current available version is an already usable preview
+
** current available version is an already usable preview
 
[[file:STM32_MC_MotorPilot_slide3.png|600px|center]]
 
[[file:STM32_MC_MotorPilot_slide3.png|600px|center]]
   
STM32 MC Motor Pilot added values:
+
STM32 MC Motor Pilot added values are:
* Enhanced plotting feature: the user can now plot most registers
+
* enhanced plotting feature: the user can now plot most registers
* The user can easily customize GUI at run time
+
* the user can easily customize GUI at run time
** To fit specific needs or to experiment with new firmware features
+
** to fit specific needs or to experiment with new firmware features
* Solid foundation to support future firmware features
+
* solid foundation to support future firmware features
** ACIM, 6-Step, Sensorless Zero speed, enhanced debug features
+
** ACIM, 6-Step, sensor-less zero speed, enhanced debug features
* Runs on all three MCD target platforms: Windows, Mac, and Linux
+
* runs on all three MCD target platforms: Windows, Mac, and Linux
   
==STM32 MC Motor Pilot Quick Guide==
+
==STM32 MC motor-pilot quick guide==
   
===Installation and Run===
+
===Installation and run===
   
 
STM32 MC Motor Pilot is now automatically installed with STM32 MC SDK.
 
STM32 MC Motor Pilot is now automatically installed with STM32 MC SDK.
Line 29: Line 29:
 
A shortcut is now created in Windows menus to run it.
 
A shortcut is now created in Windows menus to run it.
   
===Quick Start-up===
+
===Quick start-up===
   
 
====Quick step 1====
 
====Quick step 1====
   
 
# MotorPilot:
 
# MotorPilot:
#* Starts unconnected [[file:STM32_MC_MotorPilot_slide6_1.png|200px|center]]
+
#* starts unconnected [[file:STM32_MC_MotorPilot_slide6_1.png|200px|center]]
#* Lists available serial ports [[file:STM32_MC_MotorPilot_slide6_2.png|200px|center]]
+
#* lists available serial ports [[file:STM32_MC_MotorPilot_slide6_2.png|200px|center]]
#* Displays the default UI
+
#* displays the default UI
# Connect a Motor Pilot board to the PC
+
# Connect a Motor Pilot board to the PC.
# Click on Connect
+
# Click on Connect.
   
 
[[file:STM32_MC_MotorPilot_slide6_3.png|600px|center]]
 
[[file:STM32_MC_MotorPilot_slide6_3.png|600px|center]]
Line 44: Line 44:
 
====Quick step 2====
 
====Quick step 2====
   
# MotorPilot is connected:
+
# When MotorPilot is connected, it:
#* Displays version of embedded firmware [[file:STM32_MC_MotorPilot_slide7_1.png|200px|center]]
+
#* displays version of embedded firmware [[file:STM32_MC_MotorPilot_slide7_1.png|200px|center]]
#* Shows the current state and the errors [[file:STM32_MC_MotorPilot_slide7_3.png|600px|center]]
+
#* retrieves importants parameters for motor control form the board and adjust the GUI with theses informations
  +
#* starts to monitor parameters needed by the GUI [[file:STM32_MC_MotorPilot_slide7_3.png|600px|center]]
 
# Spin the motor:
 
# Spin the motor:
#* Click on the Start button [[file:STM32_MC_MotorPilot_slide7_2.png|200px|center]]
+
#* Click on the Start button. [[file:STM32_MC_MotorPilot_slide7_2.png|200px|center]]
# Motors starts and the monitor displays the speed [[file:STM32_MC_MotorPilot_slide7_4.png|200px|center]]
+
# Motors starts and the pilot updates the GUI. [[file:STM32_MC_MotorPilot_slide7_4.png|200px|center]]
#* And the currents
 
#* And other information
 
   
 
====Quick step 3====
 
====Quick step 3====
   
* Control the motor
+
# Control the motor:
** Slide the knob to set the speed [[file:STM32_MC_MotorPilot_slide8_1.png|200px|center]]
+
#* Slide the knob to set the speed [[file:STM32_MC_MotorPilot_slide8_1.png|200px|center]]
** Set Target Speed, Duration and Click to apply a ramp [[file:STM32_MC_MotorPilot_slide8_2.png|200px|center]]
+
#* Set Target Speed, Duration and click to apply a ramp [[file:STM32_MC_MotorPilot_slide8_2.png|200px|center]]
   
 
[[file:STM32_MC_MotorPilot_slide8_3.png|600px|center]]
 
[[file:STM32_MC_MotorPilot_slide8_3.png|600px|center]]
   
** Click Stop Ramp to stop it before end [[file:STM32_MC_MotorPilot_slide9_1.png|200px|center]]
+
* Click Stop Ramp to stop it before end [[file:STM32_MC_MotorPilot_slide9_1.png|200px|center]]
** Click Stop to stop spinning the motor [[file:STM32_MC_MotorPilot_slide9_2.png|200px|center]]
+
* Click Stop to stop spinning the motor [[file:STM32_MC_MotorPilot_slide9_2.png|200px|center]]
   
 
[[file:STM32_MC_MotorPilot_slide9_3.png|200px|center]]
 
[[file:STM32_MC_MotorPilot_slide9_3.png|200px|center]]
Line 74: Line 73:
 
===Speed PID, Toque PID, Flux PID and Flux reference===
 
===Speed PID, Toque PID, Flux PID and Flux reference===
   
# Click Advanced Configuration
+
# Click Advanced Configuration:
#* Displays additional panel with more settings [[file:STM32_MC_MotorPilot_slide11.png|600px|center]]
+
#* displays additional panel with more settings [[file:STM32_MC_MotorPilot_slide11.png|600px|center]]
 
# As in the current monitor, customizes:
 
# As in the current monitor, customizes:
 
#* Speed PID
 
#* Speed PID
Line 89: Line 88:
 
#* State Observer + PLL parameters
 
#* State Observer + PLL parameters
 
#* State Observer + CORDIC parameters
 
#* State Observer + CORDIC parameters
# Missing from the current monitor:
+
[[File:STM32 MC MotorPilot ADVANCED CONFIG.png|600px|center]]
#* Revup phases configuration
+
# if DAC is available on your board you can select which register you want to output on it
#** Will be present in future versions of the tool
 
# DAC settings are at the bottom left
 
   
[[file:STM32_MC_MotorPilot_slide12.png|600px|center]]
+
===Handling errors===
 
 
===Handling Errors===
 
   
 
====Control Board disconnection====
 
====Control Board disconnection====
   
 
Board freeze due to firmware critical error or breakpoint trigger:
 
Board freeze due to firmware critical error or breakpoint trigger:
* Resume execution or reset the board, and the connection will resume
+
* Resume execution or reset the board, and the connection resumes.
   
[[file:STM32_MC_MotorPilot_slide13.png|600px|center]]
+
[[File:STM32 MC MotorPilot Connect ERROR.png|600px|center]]
   
 
====Firmware errors====
 
====Firmware errors====
Line 109: Line 104:
 
* As with the current monitor, current and past errors are indicated.
 
* As with the current monitor, current and past errors are indicated.
 
* Clicking the Ack Faults button has no effect in the FAULT_NOW state
 
* Clicking the Ack Faults button has no effect in the FAULT_NOW state
  +
[[File:STM32 MC MotorPilot FAULT NOW.png|600px|center]]
   
[[file:STM32_MC_MotorPilot_slide14.png|600px|center]]
 
   
 
* Wait for the fault conditions to vanish to enter the FAULT_OVER state
 
* Wait for the fault conditions to vanish to enter the FAULT_OVER state
* Then click on Ack Faults to go back to IDLE [[file:STM32_MC_MotorPilot_slide15_1.png|200px|center]]
+
[[File:STM32 MC MotorPilot FAULT OVER.png|600px|center]]
  +
* Then click on Ack Faults to go back to IDLE  
  +
[[File:STM32 MC MotorPilot FAULT ACK.png|600px|center]]
   
 
<br clear=all>
 
<br clear=all>
[[file:STM32_MC_MotorPilot_slide15_2.png|600px|center]]
 
   
===Viewing and plotting registers by pooling (low-speed plotting)===
+
===Viewing and plotting registers with low-speed plotting ===
  +
With this method of plot, any register can be plot but at low rate (polling every 200 ms by default)
  +
<!-- to be delete in the database : [[file:STM32_MC_MotorPilot_slide16_1.png|600px|center]] -->
   
# Clicking the Registers tab displays the list of all registers[[file:STM32_MC_MotorPilot_slide16_1.png|600px|center]]
+
# Clicking the Registers tab displays the list of all registers (see (1) on the following figure) [[file:STM32_Motor_Pilot_-_new_picture.png|600px|center]]
# Clicking a Click to Plot button
+
# Click a "Click to Plot" button (see (2) on the figure)
# Opens a plot window the first time
+
#* Opens a plot window the first time
#* Lets the user decide where to plot the other times[[file:STM32_MC_MotorPilot_slide16_2.png|600px|center]]
+
#* Lets the user decide where to plot the other times (see (3) on the figure) [[file:STM32_MC_MotorPilot_slide16_2.png|600px|center]]
#* Lets the user choose to stop showing the already pointed register.
+
#* Lets the user choose to stop showing the already pointed register (see (4) on the figure).
   
  +
===Viewing and plotting registers with high-speed plotting ===
  +
With this method of plot, only a subset of registers can be plot at PWM frequency rate
  +
  +
* Once the motor is connected (and motor started)
  +
* Click on the "Plot" button
  +
[[file:STM32_MC_MotorPilot_plot_button.png|center]]
  +
* A "High Frequency Plot" window opens:
  +
[[file:STM32_MC_Motor_Pilot_plot1.png|600px|center]]
  +
* Click again to open more plot windows
  +
* Resize these windows to optimize the display of plots on your desktop
  +
* Right-click to select the register you want to plot:
  +
[[file:STM32_MC_Motor_Pilot_plot2.png|600px|center]]
  +
* Click again to plot more registers:
  +
[[file:STM32_MC_Motor_Pilot_plot3.png|600px|center]]
  +
* The data display width is defined by adjusting the buffer size (change buffering to display more data):
  +
[[file:STM32_MC_Motor_Pilot_plot4.png|600px|center]]
  +
* When displaying 2 registers, you can switch to the X / Y plot:
  +
[[file:STM32_MC_Motor_Pilot_plot5.png|600px|center]]
  +
* Dynamic plot display can be paused and resumed as desired.
  +
* Each register plot can be hidden or displayed by double-clicking on the register name in the plot legend (then when the register plot is hidden, the corresponding register name is strikethrough).
  +
[[file:STM32_MC_Motor_Pilot_plot6.png|600px|center]]
  +
  +
===Rev-up configuration===
  +
  +
* Click on "Rev-up" button and then the application panel is replaced by rev-up configuration panel.
  +
  +
[[file:STM32_MC_Motor_Pilot_revup.png|800px|center]]
  +
  +
* This panel allows to set  up to 5 rev-up steps by direct edit in the corresponding table for which a step rev-up duration, a final torque value and a final speed value are defined. (use the same values to have less steps).
  +
  +
<!--
 
====And soon in this start-up guide:====
 
====And soon in this start-up guide:====
   
* Viewing and plotting registers by pooling for high-speed plotting
 
 
* frame logger and decoder
 
* frame logger and decoder
  +
-->
   
 
===UI is changeable at run-time===
 
===UI is changeable at run-time===
Line 135: Line 164:
 
* Click on menu item File => Load
 
* Click on menu item File => Load
 
** Search for a .qml file and open it.
 
** Search for a .qml file and open it.
** For instance, GUI\PositionControlApp.qml found in the release
+
** For instance, GUI\PositionControlApp.qml found in the release.
* This will load a new GUI with other features
+
* This loads a new GUI with other features
 
**In the case of PositionControlApp.qml, a position control enabled monitoring application.
 
**In the case of PositionControlApp.qml, a position control enabled monitoring application.
* Future versions of the tool will let users change this UI themselves
 
   
 
[[file:STM32_MC_MotorPilot_slide19.png|600px|center]]
 
[[file:STM32_MC_MotorPilot_slide19.png|600px|center]]
   
  +
* Users are able to change the UI by copying an existing ".qml" file and editing it.
  +
  +
<!--
 
==Current limitations and future plans==
 
==Current limitations and future plans==
   
 
===Missing features to be added soon===
 
===Missing features to be added soon===
   
* Revup configuration UI
 
 
* Dual Drive support
 
* Dual Drive support
 
* Filtering and sorting registers’ view
 
* Filtering and sorting registers’ view
 
* UI API description and development guide
 
* UI API description and development guide
 
** To let users customize the UI for their own needs
 
** To let users customize the UI for their own needs
  +
-->
   
 
<noinclude>
 
<noinclude>
 
[[Category:Motor Control]]
 
[[Category:Motor Control]]
{{PublicationRequestId | 21096 | 9/13/2021 | under TW assignment}}
+
{{PublicationRequestId | 21096 | 9/13/2021 | Souade MENDJELI }}
  +
{{PublicationRequestId | 22275 | 19/01/2022 | under TW assignment}}
 
<noinclude>
 
<noinclude>