STSW-WBC2STUDIO User Guide
This document provides a comprehensive user guide for the STSW-WBC2STUDIO software, offering clear instructions for installation, execution, and feature utilization. It is intended for end-users with the necessary hardware configurations.
1 Abbreviations, Acronyms, and Definitions
1.1 Abbreviations and Acronyms
Table 1 lists common abbreviations:
| Abbreviation | Description |
|---|---|
| UART | Universal Asynchronous Receiver-Transmitter |
| HW | Hardware |
| NVM | Non-Volatile Memory |
| PRx | Power Receiver |
| PTx | Power Transmitter |
| Rx | Receiver/Receive (interchangeable with PRx unless specified) |
| Tx | Transmitter/Transmit (interchangeable with PTx unless specified) |
| UI | User Interface |
1.2 Definitions
Table 2 defines key terms:
| Name | Description |
|---|---|
| application processor | A microcontroller or microprocessor controlling the device of interest, typically the main processor of the system. |
| customer | The individual or group paying for the product and often defining its requirements. |
| host | A master system controlling the device of interest. If it's a microcontroller or microprocessor, it's called an application processor. |
| user | The person or persons directly operating or interacting with the product. |
2 System Requirements
Table 3 outlines the system requirements:
| Description | Minimum Requirement |
|---|---|
| Operating system | Microsoft® Windows® 10 |
| Processor | 1 GHz processor |
| RAM | 4 GBytes or higher (8 GB preferred, 16 GB recommended for debug mode) |
| Hard disk space | 15 Mbytes or more |
3 Software Installation
The STSW-WBC2STUDIO software does not require a complex installation. To execute the software:
- Extract the contents of
STSW-WBC2STUDIO Vx.x.x.zipto the C: drive. - Double-click on
STSW-WBC2STUDIO.exeto launch the software.
If using ST-LINK as a USB-UART bridge, ensure the USB driver is installed.
4 Hardware Connection
Before launching the software, connect the target evaluation kit to the PC via a USB-UART bridge and power it up. Table 4 lists supported USB-UART bridges, and Table 5 lists supported WBC2 evaluation kits.
The STSW-WBC2STUDIO can connect to one USB-UART bridge at a time for UART serial communication.
A diagram illustrating the hardware connection shows a PC running STSW-WBC2STUDIO connected via USB to a USB-UART converter dongle. The dongle's RX, TX, and GND pins are connected to the corresponding RX, TX, and GND pins of the STWBC2 Evaluation Kit.
| 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 |
| Part Number | PTx | Description |
|---|---|---|
| STEVAL-WBC2TX70 | PTx | General application PTx up to 70 W |
| STEVAL-WBC2TX50 | PTx | General application PTx up to 50 W |
5 Interface Description
The STSW-WBC2STUDIO main interface comprises three sections: the Top Menu, the Side Menu Bar, and the Output Window. The Side Menu Bar allows selection of content displayed in the Output Window, detailed in Section 5.2. The Top Menu is described in Section 5.1.
A screenshot shows the main interface with the Top Menu containing icons for STMicroelectronics, Connect, Settings, and Help. The Side Menu Bar lists Info, Charts, Parameters, Traces, FOD Tuning, FW, and Log. The Output Window displays various metrics and controls.
5.1 Top Menu Section
The Top Menu provides access to software setup, settings, and information.
A table details the UI elements:
| UI Element | Description |
|---|---|
| Expander | Allows expanding and collapsing the Side Menu bar for a larger Output Window view. |
| Connect | A toggle button to connect or disconnect the WBC2 device. |
| Settings | Opens the Settings window (refer to Section 5.1.1). |
| About | Opens the About window (refer to Section 5.1.2). |
5.1.1 Settings Window
The Settings window allows configuration of connection, charts, and trace verbosity.
A screenshot shows the Settings window with options for Connection (STLINK Baud Rate, COM Port, Param XML version), Charts (Buffer Size), and Trace Verbosity.
| UI Element(s) | Description |
|---|---|
| Tx/Rx Settings | Manually choose or auto-select COM port for WBC2 UART; choose WBC2 Param XML version. |
| Charts Settings | Configures chart plotting features. Buffer size options: Large (100), Medium (50), Small (10) plot entries. Older data is cleared when the plot entries exceed the configured size. |
| Verbosity Settings | Enables traces based on category. |
5.1.2 About Window
The About window displays product version and ownership information.
| UI Element(s) | Description |
|---|---|
| Product Version | Software version number. |
The About window also provides a link for more information: https://www.st.com/. It states that the product is owned by STMicroelectronics and all rights are reserved (c) 2024 STMicroelectronics.
5.2 Output Window
5.2.1 Info
The Info Window displays the main metrics of the running STWBC2 device.
A screenshot shows the Info Window with sections for Status Semaphore, Event Box, Device Metrics, Tx Info, Rx Info, and Input Power Supply.
| UI Element(s) | Description |
|---|---|
| Status Semaphore | Provides the current status of the Tx device. |
| Event Box | Displays device status events. The Clear button clears events. |
| Device Metrics | Indicates the current status of the device, including Frequency, Duty Cycle, Bridge Voltage, Supply Voltage, Coil Temperature, Coil Current, FOD Margin, Current State, Bridge Mode, RefQfactor, and MeasQfactor. |
| Tx Info | Shows Hardware and Firmware details of the Tx device. |
| Rx Info | Displays information about the last identified power receiver. |
| Input Power Supply | Shows the current input power supply of the Tx device, with options for 5 V/3 A, 9 V/3 A, 12 V/3 A, 15 V/3 A, and 20 V/4.3 A. |
5.2.2 Charts
Charts allow users to monitor key operational parameters in real-time. Chart settings are configurable in the Settings Window. The maximum buffer size is 50 seconds, with data plotted every 500 ms. Up to four charts can be displayed simultaneously. The Legend allows users to select which charts to display. It is recommended to clear previous charts before starting a new capture.
A screenshot shows the Charts Window with plot areas for Voltage, Duty Cycle, Current, Power, and Others. The Legend on the right allows enabling/disabling plots for Voltage, Supply Voltage, Current, Coil Current, Temperature, Coil Temperature, Frequency, Percentage, Duty Cycle, Power, RX Reported Power, Control Error, and FOD Margin.
| UI Element(s) | Description |
|---|---|
| Start/Pause | Toggle button to start or pause sampling and plotting. |
| Clear | Clears existing plot(s). |
| Save | Saves the current plot to a .csv file. |
| Plot Area | Displays one or multiple plots. |
| Legend | Provides labels for the plot area. Checkboxes enable/disable plotting. |
Chart interaction gestures are described:
| Action | Gesture |
|---|---|
| Pan | Right mouse button |
| Zoom | Mouse wheel |
| Zoom by rectangle | Ctrl + Right mouse button, Middle mouse button |
| Reset | Ctrl + Right mouse button double-click, Middle mouse button double-click |
| Show 'tracker' | Left mouse button |
| Reset axes | 'A', Home |
5.2.3 Parameters
The Parameters page allows users to configure the device and save/load configurations. Users can read parameters from the device RAM, write to device RAM, or write to RAM and NVM. Configurations can also be saved to and loaded from files.
A screenshot shows the Parameters Window with controls for Read, Write, Write NVM, Save, and Load. The Parameters Display section shows various configurable parameters like FORCE_HIGH_POWER, DeadTime, PotentialPowerW, PowerProfileType, etc., each with a slider for adjustment.
| UI Element(s) | Description |
|---|---|
| Read | Reads from the device RAM and displays in the GUI. |
| Write | Writes configured parameters from the GUI to device RAM. |
| Write NVM | Writes configured parameters from the GUI to device RAM and NVM. |
| Save | Saves parameters to a configuration file. |
| Load | Loads a parameter configuration file into the GUI. |
| Parameters Display | Displays parameters in the GUI for adjustment. |
5.2.4 Traces
Traces monitor key operating parameters and track firmware tasks. The window includes controls for scrolling, backup, starting/stopping trace logs, clearing logs, saving, loading, and filtering traces. The Trace Log displays the recorded data.
A screenshot shows the Traces Window with options like Scroll (Auto Scroll, Partial Back Up), Start, Clear, Save, and Load. The Trace Log area displays Time, Module Name, and Trace details. A Filter section allows selection of specific traces, and a Selected Trace Information box shows details for a selected trace.
| UI Element(s) | Description |
|---|---|
| Scroll | Enables auto-scrolling to the latest trace log. |
| Backup | Enables partial backup. When the trace buffer is full (2000 recordings), traces are stored to a file, and the log is cleared. |
| Start | Toggles the display of trace logs (enabled by default). |
| Clear | Clears trace logs from the display. |
| Save | Opens a dialog to save trace logs to a file (refer to Section 5.2.4.1). |
| Load | Loads previously saved traces. |
| Filter | Enables trace filtering based on user selection. |
| Information | Allows clicking on individual traces for more details. |
| Trace Log | Displays the traces. |
5.2.4.1 Traces Save
The Traces save window allows saving trace logs in different formats:
| Save Type Selection | Action |
|---|---|
| Save Log as CSV file | Save |
| Save Filtered Log as CSV file | Save Filtered |
| Save FOD measurement data | Save FOD |
| UI Element(s) | Description |
|---|---|
| Save | Saves trace logs to a CSV file. |
| Save Filtered | Saves only filtered trace logs to a CSV file. |
| Save FOD | Saves traces for FOD tuning. |
5.2.5 FOD Tuning
Details regarding FOD tuning are available in separate application notes.
5.2.6 FW
The FW Window allows users to load and change the device firmware, supporting *.hex format files. Users can load firmware files, write firmware to the device NVM, perform manual calibration after firmware updates, and read all NVM contents (firmware and parameters) into a *.hex file for mass production.
A screenshot shows the FW Window with buttons for Load, Write, Calibrate, and Read All. The file path for the firmware is displayed.
| UI Element(s) | Description |
|---|---|
| Load | Selects the firmware source file (*.hex). |
| Write | Starts programming firmware into the device NVM. |
| Calibrate | Executes calibration manually. Calibration is recommended after each firmware update. |
| Read All | Reads and saves the contents of the NVM (firmware and parameters) into a *.hex file, usable for mass production. |
5.2.7 Log
The Log Window displays logs of all UART transactions during a session and allows saving these logs to a file. Options include Debug mode, Clear, Save, Scroll, and Backup.
A screenshot shows the Log Window with controls for Debug, Clear, Save, Scroll, and Backup. The Log Trace area displays Time, Type, and Message details of the UART transactions.
| UI Element(s) | Description |
|---|---|
| Debug | Enables log level up to debug. |
| Clear | Clears the debug trace log. |
| Save | Saves the current trace log to a .txt file. |
| Scroll | Enables auto-scrolling to the latest log. |
| Backup | Enables partial backup when the log buffer is full. |
| Log Trace | Displays the traces. |
Revision History
Table 17 details the document revisions:
| Date | Revision | Changes |
|---|---|---|
| 09-Feb-2024 | 1 | Initial release. |
List of Tables
The document contains the following tables:
- Table 1: List of abbreviations
- Table 2: List of definitions
- Table 3: List of system requirements
- Table 4: List of supported USB-UART bridges
- Table 5: List of supported WLC evaluation kits
- Table 6: Top menu UI element(s) description
- Table 7: Settings Window UI element(s) description
- Table 8: About Window UI element(s) description
- Table 9: Info Window UI element(s) description
- Table 10: Charts Window UI element(s) description
- Table 11: Charts controller description
- Table 12: Parameters Window UI element(s) description
- Table 13: Traces Window UI element(s) description
- Table 14: Traces save window UI element(s) description
- Table 15: Programming Window UI element(s) description
- Table 16: Log Window UI element(s) description
- Table 17: Document revision history
List of Figures
The document contains the following figures:
- Figure 1: STSW-WBC2STUDIO HW connection
- Figure 2: STSW-WBC2STUDIO main interface
- Figure 3: Top Menu Section
- Figure 4: Settings window
- Figure 5: About Window
- Figure 6: Info Window
- Figure 7: Charts Window
- Figure 8: Parameters Window
- Figure 9: Traces Window
- Figure 10: Traces save window
- Figure 11: Programming Window
- Figure 12: Logger Window
IMPORTANT NOTICE - READ CAREFULLY
STMicroelectronics NV and its subsidiaries reserve the right to make changes, corrections, enhancements, modifications, and improvements to ST products and 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. (c) 2024 STMicroelectronics - All rights reserved.
