STMicroelectronics STSW-WBC2STUDIO Software User Guide

UM3287
User manual
STSW-WBC2STUDIO user guide
Introduction
The purpose of this document is to provide a comprehensive user guide for the STSW-WBC2STUDIO software. It aims to
provide clear instructions on how to install, execute, and use the features provided by the software.
This document is intended for end-users of the STSW-WBC2STUDIO software, who have all the required hardware settings.
The scope of this document is limited to the STSW-WBC2STUDIO software.
UM3287 - Rev 1 - February 2024
For further information contact your local STMicroelectronics sales office.
www.st.com
UM3287
Abbreviations, acronyms, and definitions
1
Abbreviations, acronyms, and definitions
1.1
Abbreviation, and acronyms
Table 1. List of abbreviations
Abbreviation
1.2
Description
UART
Universal Asynchronous Receiver-Transmitter
HW
Hardware
NVM
Non-Volatile Memory
PRx
Power Receiver
PTx
Power Transmitter
Rx
Receiver/Receive. Unless explicitly mention, this is used interchangeably with PRx
Tx
Transmitter/Transmit. Unless explicitly mention, this is used interchangeably with PTx
UI
User Interface
Definitions
Table 2. List of definition
UM3287 - Rev 1
Name
Description
application processor
A microcontroller or microprocessor that controls the device of interest. Typically, an application
processor is the main processor of the system or subsystem in which the device is connected to
customer
The person, or persons, who pay for the product and usually (but not necessarily) decide the
requirements. In the context of this recommended practice the customer and the supplier may be
members of the same organization
host
A master system that controls the device of interest. In the case that the host is a microcontroller
or microprocessor, it is referred as an application processor
user
The person, or persons, who operate or interact directly with the product
page 2/20
UM3287
System requirements
2
System requirements
Table 3. List of system requirement
Description
Minimum requirement
Operating system Microsoft® Windows® 10
UM3287 - Rev 1
Processor
1 Ghz processor
RAM
4 GBytes or higher (Minimum 8 GB preferred for better performance, 16 GB recommended in debug
mode)
Hard disk space
15 Mbytes or more
page 3/20
UM3287
Software installation
3
Software installation
STSW-WBC2STUDIO software does not require specific installation steps. To execute the software:
1. Extract the contents of STSW-WBC2STUDIO Vx.x.x.zip into C driver
2. Double click on STSW-WBC2STUDIO.exe to launch the software
In case of using ST-LINK as USB-UART bridge, install USB driver.
UM3287 - Rev 1
page 4/20
UM3287
Hardware connection
4
Hardware connection
Before starting the software, ensure the target evaluation kit is connected to the PC via a USB-UART bridge and
powered up. The Table 4. List of supported USB-UART bridge shows a list of ST-LINK bridge supported by the
STSW-WBC2STUDIO software.
The STSW-WBC2STUDIO can connect one USB-UART bridge at a time for UART serial communication.
The Table 5. List of supported WLC evaluation kit lists the WBC2 evaluation kit supported by the
STSW‑WBC2STUDIO software.
Figure 1. STSW-WBC2STUDIO HW connection
Table 4. List of supported USB-UART bridge
Part number
Description
STLINK-V3SET
USB-UART bridge
STLINK-V3MINI
USB-UART bridge
STLINK-V3MINIE
USB-UART bridge
USB-UART bridge
Generic USB-UART bridge
Table 5. List of supported WLC evaluation kit
UM3287 - Rev 1
Part number
PTx
STEVAL-WBC2TX70
PTx
General application PTx upto 70 W
STEVAL-WBC2TX50
PTx
General application PTx upto 50 W
Description
page 5/20
UM3287
Interface description
5
Interface description
The STSW-WBC2STUDIO main interface consists of three main sections: Top menu, Side Menu Bar, and the
Output Window.
The Side Menu Bar selects the output in the Output Window, details can be found in Section 5.2: Output Window.
For details about Top menu refer to Section 5.1: Top menu section.
Figure 2. STSW-WBC2STUDIO main interface
UM3287 - Rev 1
page 6/20
UM3287
Interface description
5.1
Top menu section
The Top Menu Section hosts the interface to access the software’s setup, settings, and information about the
software.
Figure 3. Top Menu Section
Table 6. Top menu UI element(s) description
UI element(s)
5.1.1
Description
Expander
Allows user to expand and collapse Side Menu bar. This feature allows the user to have a
bigger view of Output Window when needed
Connect
Toggle button allows to connect or disconnect WBC2 device
Settings
The Settings button opens the Settings window, for details refer to Section 5.1.1: Settings
window
About
Opens the About window, for details refer to Section 5.1.2: About Window
Settings window
Figure 4. Settings window
UM3287 - Rev 1
page 7/20
UM3287
Interface description
Table 7. Settings Window UI element(s) description
UI Element(s)
Tx/Rx Settings
Description
Option to manually choose or auto-select com port for WBC2 UART
Option to choose WBC2 Param xml version
Configures chart plotting features
Charts Settings
Buffer size [large: 100, medium: 50, small: 10] plot entries
Older data in plots are cleared to add new data when the plot entries exceed configured size
Verbosity Settings
5.1.2
Enable traces based on category
About Window
Figure 5. About Window
Table 8. About Window UI element(s) description
UI Element(s)
Product Version
UM3287 - Rev 1
Description
Software version number
page 8/20
UM3287
Interface description
5.2
Output Window
5.2.1
Info
Info Window displays main metrics of running STWBC2 device.
Figure 6. Info Window
Table 9. Info Window UI element(s) description
UI Element(s)
Status Semaphore
Event Box
UM3287 - Rev 1
Description
Provides current status of Tx device
Display device status events. Clear button allows to clear events
Device Metrics
Device metrics indicate current status of device
Tx Info
Hardware and Firmware details of the Tx device
Rx Info
Last identified power receiver information
Input Power Supply
Current input power supply of Tx device
page 9/20
UM3287
Interface description
5.2.2
Charts
Charts allow users to monitor key operational parameters in real time. Charts settings are configurable in Settings
Window.
The maximum buffer size (time span) available is 50 seconds. The data is plotted once every 500 ms and up to 4
different charts can be displayed at a time. Check box select option in Legend allows user to choose charts for
display. We recommend clearing the previously captured charts, using the Clear button, before starting a new
capture.
Figure 7. Charts Window
Table 10. Charts Window UI element(s) description
UI Element(s)
Start/Pause
Description
Toggle button allows user to start or pause sampling and plotting
Clear
Clear existing plot(s)
Save
Save current plot into .csv file
Plot Area
Shows one or multiple plots
Legend
Legend for plot area. Click on the check box to enable/disable plotting
Table 11. Charts controller description
Action
Pan
Right mouse button
Zoom
Mouse wheel
Zoom by rectangle
Reset
Show ‘tracker’
Reset axes
UM3287 - Rev 1
Gesture
Ctrl+Right mouse button, Middle mouse button
Ctrl+Right mouse button double-click, Middle mouse button double-click
Left mouse button
‘A’ , Home
page 10/20
UM3287
Interface description
5.2.3
Parameters
The parameters page allows the user to configure the device and to save and load the prepared configuration.
Figure 8. Parameters Window
Table 12. Parameters Window UI element(s) description
UI Element(s)
Read
Read from the device RAM and display in GUI
Write
Write parameters configured in GUI to device RAM
Write NVM
Write parameters configured in GUI to device RAM and NVM
Save
Save Parameters to configuration file
Load
Load parameter configuration file to GUI
Parameters Display
UM3287 - Rev 1
Description
Display box for parameters in GUI
page 11/20
UM3287
Interface description
5.2.4
Traces
Traces are used to monitor key operating parameters of the device and to keep track of ongoing firmware tasks.
Figure 9. Traces Window
Table 13. Traces Window UI element(s) description
UI Element(s)
UM3287 - Rev 1
Description
Scroll
Enables auto scrolling to latest Trace log
Backup
Enables partial back up. When the trace buffer is full(2000 recordings), the traces are stored to
the file and the Trace log is cleared
Start
Toggle button allows to Enable/disable trace logs to display. By default traces shall be enabled
Clear
Clears Trace logs from display
Save
Opens a dialog to save Trace logs to file, refer to Section 5.2.4.1: Traces save
Load
Loads previously saved traces
Filter
Enables trace filter based on user selection
Information
Allows user to click on individual traces for more details
Trace Log
Display box for traces
page 12/20
UM3287
Interface description
5.2.4.1
Traces save
Figure 10. Traces save window
Table 14. Traces save window UI element(s) description
UI Element(s)
Save
5.2.5
Description
Save Trace logs to csv file
Save Filtered
Save only filtered trace logs to csv file
Save FOD
Save traces to be used for FOD tuning
FOD tuning
Details about FOD tuning are separately available in the respective application notes.
UM3287 - Rev 1
page 13/20
UM3287
Interface description
5.2.6
FW
FW Window enables the user to load and change firmware of the device. This Window allows *.hex format
firmware file.
Figure 11. Programming Window
Table 15. Programming Window UI element(s) description
UI Element(s)
UM3287 - Rev 1
Description
Load
Selects the firmware source file *.hex
Write
Start programming firmware into device NVM
Calibrate
To execute calibration manually. It is recommended to perform calibration after each firmware
update
Read All
Allows user to read and save contents of the NVM (both firmware and Parameters) into a *.hex
file. The generated file can also be used later in mass production
page 14/20
UM3287
Interface description
5.2.7
Log
The Log Window displays logs of all the UART transactions performed during any session. These logs may be
saved into a file.
Figure 12. Logger Window
Table 16. Log Window UI element(s) description
UI Element(s)
UM3287 - Rev 1
Description
Debug
Enables log level up to debug
Clear
Clears the debug trace log
Save
Saves current trace log into a .txt file
Scroll
Enables auto scrolling to latest log
Backup
Enables partial back up when log buffer full
Log Trace
Display box for traces
page 15/20
UM3287
Revision history
Table 17. Document revision history
UM3287 - Rev 1
Date
Revision
09-Feb-2024
1
Changes
Initial release.
page 16/20
UM3287
Contents
Contents
1
Abbreviations, acronyms, and definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1
Abbreviation, and acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.2
Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2
System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
3
Software installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
4
Hardware connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
5
Interface description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
5.1
5.2
Top menu section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
5.1.1
Settings window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
5.1.2
About Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Output Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.2.1
Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.2.2
Charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
5.2.3
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
5.2.4
Traces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
5.2.5
FOD tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.2.6
FW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
5.2.7
Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
UM3287 - Rev 1
page 17/20
UM3287
List of tables
List of tables
Table 1.
Table 2.
Table 3.
Table 4.
Table 5.
Table 6.
Table 7.
Table 8.
Table 9.
Table 10.
Table 11.
Table 12.
Table 13.
Table 14.
Table 15.
Table 16.
Table 17.
List of abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
List of definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
List of system requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
List of supported USB-UART bridge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
List of supported WLC evaluation kit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Top menu UI element(s) description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Settings Window UI element(s) description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
About Window UI element(s) description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Info Window UI element(s) description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Charts Window UI element(s) description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Charts controller description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Parameters Window UI element(s) description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Traces Window UI element(s) description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Traces save window UI element(s) description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Programming Window UI element(s) description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Log Window UI element(s) description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Document revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
UM3287 - Rev 1
page 18/20
UM3287
List of figures
List of figures
Figure 1.
Figure 2.
Figure 3.
Figure 4.
Figure 5.
Figure 6.
Figure 7.
Figure 8.
Figure 9.
Figure 10.
Figure 11.
Figure 12.
UM3287 - Rev 1
STSW-WBC2STUDIO HW connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
STSW-WBC2STUDIO main interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Top Menu Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Settings window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
About Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Info Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Charts Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Parameters Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Traces Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Traces save window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Programming Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Logger Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
page 19/20
UM3287
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.
© 2024 STMicroelectronics – All rights reserved
UM3287 - Rev 1
page 20/20
">