STMicroelectronics STSW-OUT16F4 User Manual

UM3433
User manual
Getting started with STSW-OUT16F4 demonstration firmware for NUCLEOF401RE enabling STSW-IFAPGUI on X-NUCLEO-OUT16A1 and X-NUCLEOOUT17A1 expansion boards
Introduction
The STSW-OUT16F4 firmware runs on the NUCLEO-F401RE development board and allows controlling the X-NUCLEOOUT16A1 and X-NUCLEO-OUT17A1 expansion boards using the STSW-IFAPGUI graphical user interface.
The STSW-OUT16F4 contains the software routines that enable the USB-based communication between the NUCLEO-F401RE
and the system where the STSW-IFAPGUI runs, and the control of the X-NUCLEO-OUT16A1 or X-NUCLEO-OUT17A1
expansion board.
In GPIO/Parallel Mode, the firmware can control a single expansion board. In SPI Mode, the firmware can control 8-bits or 16bits data width and single expansion board or two stacked boards configured in daisy chaining mode.
The STSW-IFAPGUI is based on a common engine and several plug-ins designed to communicate through the USB connection
with the application layer running on the NUCLEO-F401RE development board stacked with the expansion board.
UM3433 - Rev 1 - October 2024
For further information contact your local STMicroelectronics sales office.
www.st.com
UM3433
Overview
1
Overview
•
•
Full control of the X-NUCLEO-OUT16A1 and X-NUCLEO-OUT17A1 expansion boards via the STSWIFAPGUI graphical user interface
Control of:
–
–
–
–
output channel switching frequency and duty cycle configuration
both SPI (8-bits w/o parity check and 16-bits with parity check) and GPIO/Parallel Control Modes
management
both Single and Daisy Chain (only for SPI Mode) management
visualization of diagnostic signals
◦
◦
UM3433 - Rev 1
GPIO/Parallel Mode: case overtemperature, power good, common junction overtemperature
SPI Mode: case overtemperature, power good, common junction overtemperature /
communication fault, per-channel overtemperature, MCU freeze
page 2/23
UM3433
How to control the single expansion board with default set-up (GPIO/Parallel mode) with IFAPGUI
2
How to control the single expansion board with default set-up
(GPIO/Parallel mode) with IFAPGUI
This application scenario is based on the default on-board switches and resistors configuration of the X-NUCLEOOUT16A1 and X-NUCLEO-OUT17A1.
Step 1.
Stack the X-NUCLEO-OUT16A1 (or X-NUCLEO-OUT17A1) on top of the NUCLEO-F401RE flashed
with the STSW-OUT16F4 firmware, through the Arduino® UNO R3 connectors.
Step 2.
Connect the two stacked boards to your PC or laptop USB port through a mini-USB cable (for
NUCLEO-F401RE). The STM32 is supplied via USB (3.3 V) and the flashed firmware starts running.
Step 3.
Connect the load and supply the power stage of the X-NUCLEO-OUT16A1 (or X-NUCLEO-OUT17A1)
with a 24 V rail via the CN1 connector.
Step 4.
Launch the STSW-IFAPGUI. When the application starts, the firmware running on the STM32 is
automatically detected and a COM port is opened for communication.
Figure 1. STSW-IFAPGUI, COM port opened
Step 5.
UM3433 - Rev 1
Click on the GUI STM32 Nucleo icon after it turns blue (it remains green until the firmware Identification
is complete). The GUI automatically identifies the board configuration based on the information
provided by the firmware. The firmware identifies the current configuration of the board by checking the
status of the JP21 jumper. When JP21 is open the board is configured in parallel mode while JP21
closed is used for the SPI configuration.
page 3/23
UM3433
How to control the single expansion board with default set-up (GPIO/Parallel mode) with IFAPGUI
Step 6.
The STSW-IFAPGUI appears on the screen.
Figure 2. STSW-IFAPGUI, main control panel
All the buttons with blue text are related to the currently active functions.The channel control sections
are used to switch on or off the channels in steady state and PWM mode. For additional details, refer to
UM2509.
UM3433 - Rev 1
page 4/23
UM3433
How to control a single expansion board configured in SPI Mode (8-bits or 16-bits) with IFAPGUI
3
How to control a single expansion board configured in SPI Mode (8bits or 16-bits) with IFAPGUI
This application scenario is based with on-board jumper and switches configuration enabling the SPI 8-bits or 16bits Mode of the X-NUCLEO-OUT16A1 and X-NUCLEO-OUT17A1. Please refer to the documentation of the
boards for further details.
Step 1.
Stack the X-NUCLEO-OUT16A1 (or X-NUCLEO-OUT17A1) on top of the NUCLEO-F401RE flashed
with the STSW-OUT16F4 firmware, through the Arduino® UNO R3 connectors.
Step 2.
Connect the two stacked boards to your PC or laptop USB port through a mini-USB cable. The STM32
is supplied via USB (3.3 V) and the flashed firmware starts running.
Step 3.
Connect the load and supply the power stage of the X-NUCLEO-OUT16A1 (or X-NUCLEO-OUT17A1)
with a 24 V rail via the CN1 connector.
Step 4.
Launch the STSW-IFAPGUI. When the application starts, the firmware running on the STM32 is
automatically detected and a COM port is opened for communication.
Figure 3. STSW-IFAPGUI, COM port opened
Step 5.
Click on the GUI STM32 Nucleo icon after it turns blue. It will turn green once it has recognized the
correct interface and opened it. The GUI automatically identifies the board configuration based on the
jumper and switch configuration and opens the correct GUI.
Figure 4. STSW-IFAPGUI, identification completed
UM3433 - Rev 1
page 5/23
UM3433
How to control a single expansion board configured in SPI Mode (8-bits or 16-bits) with IFAPGUI
Step 6.
The STSW-IFAPGUI appears on the screen. In this phase, an interface is shown that allows you to
select the physical system you want to use, for example a single board system or a system with two
boards connected in a daisy chain.
Figure 5. STSW-IFAPGUI, main control panel for 8-bit SPI configuration before single board or
daisy chain selection
UM3433 - Rev 1
page 6/23
UM3433
How to control a single expansion board configured in SPI Mode (8-bits or 16-bits) with IFAPGUI
Figure 6. STSW-IFAPGUI, main control panel for 16-bit SPI configuration before single board or
daisy chain selection
Step 7.
Use the [SINGLE BOARD] or [DAISY CHAIN] buttons to select the configuration. In this case click on
[SINGLE BOARD]. The choice must be consistent with the physical system you are using. Otherwise,
correct operation will not occur. If you make a mistake, you will need to close the main control panel
and reopen it again as previously described. At this point it will be possible to make a new choice.
Figure 7. STSW-IFAPGUI, System configuration selection
UM3433 - Rev 1
page 7/23
UM3433
How to control a single expansion board configured in SPI Mode (8-bits or 16-bits) with IFAPGUI
Step 8.
After the proper system configuration selection, the correct interface will appear on the screen:
Figure 8. STSW-IFAPGUI, main control panel for 8-bit SPI single board configuration
Figure 9. STSW-IFAPGUI, main control panel for 16-bit SPI single board configuration
UM3433 - Rev 1
page 8/23
UM3433
How to control a single expansion board configured in SPI Mode (8-bits or 16-bits) with IFAPGUI
All the buttons with blue text refer to the functions currently active, when the text is gray the function
will be activated after a preliminary action, such as enabling the outputs or setting the frequency and
duty cycle of the PWM. For additional details, refer to UM2509.
UM3433 - Rev 1
page 9/23
UM3433
How to control two boards (daisy chaining) configured in SPI Mode (8-bits or 16-bits) with IFAPGUI
4
How to control two boards (daisy chaining) configured in SPI Mode
(8-bits or 16-bits) with IFAPGUI
This application scenario is based on the X-NUCLEO-OUT16A1 (or X-NUCLEO-OUT17A1) boards connected in
daisy chain and configured in 8-bit or 16-bit SPI mode. In the following notes the two boards will be identified as
board 0 the one at the beginning of the chain and board 1 the one at the end.
Step 1.
Configure two X-NUCLEO-OUT16A1 (or X-NUCLEO-OUT17A1) as board 0 and board 1 and stack
them on top of the NUCLEO-F401RE flashed with the STSW-OUT16F4 firmware, through the Arduino®
UNO R3 connectors. Check your switch and jumper configuration carefully as they differ between the
two boards.
Step 2.
Connect the three stacked boards to your PC or laptop USB port through a mini-USB cable (for
NUCLEO-F401RE). The STM32 is supplied via USB (3.3 V) and the flashed firmware starts running.
Step 3.
Connect the load and supply the power stage of the two X-NUCLEO-OUT16A1 (or X-NUCLEOOUT17A1) with a 24 V rail via the CN1 connector.
Step 4.
Launch the STSW-IFAPGUI. When the application starts, the firmware running on the STM32 is
automatically detected and a COM port is opened for communication.
Figure 10. STSW-IFAPGUI, COM port opened
Step 5.
Click on the GUI STM32 Nucleo icon after it turns blue It will turn green when it has recognized the
correct interface and opened it. The GUI automatically identifies the board configuration based on the
jumper and switch configuration and opens the correct GUI.
Figure 11. STSW-IFAPGUI, identification complete
UM3433 - Rev 1
page 10/23
UM3433
How to control two boards (daisy chaining) configured in SPI Mode (8-bits or 16-bits) with IFAPGUI
Step 6.
The STSW-IFAPGUI appears on the screen. In this phase, an interface is shown that allows you to
select the physical system you want to use, for example a single board system or a system with two
boards connected in a daisy chain.
Figure 12. STSW-IFAPGUI, main control panel for 8-bit SPI configuration before single board or
daisy chain selection
UM3433 - Rev 1
page 11/23
UM3433
How to control two boards (daisy chaining) configured in SPI Mode (8-bits or 16-bits) with IFAPGUI
Figure 13. STSW-IFAPGUI, main control panel for 16-bit SPI configuration before single board or
daisy chain selection
Step 7.
Use the [SINGLE BOARD] or [DAISY CHAIN] buttons to select the configuration. In this case click on
[DAISY CHAIN]. The choice must be consistent with the physical system you are using. Otherwise,
correct operation will not occur. If you make a mistake, you will need to close the main control panel
and reopen it again as previously described. At this point it will be possible to make a new choice.
Figure 14. STSW-IFAPGUI, System Configuration Selection
UM3433 - Rev 1
page 12/23
UM3433
How to control two boards (daisy chaining) configured in SPI Mode (8-bits or 16-bits) with IFAPGUI
Step 8.
After the System Selections, the correct interface will appear on the screen:
Figure 15. STSW-IFAPGUI, main control panel for 8-bit SPI Daisy Chain configuration
Figure 16. STSW-IFAPGUI, main control panel for 16-bit SPI Daisy Chain configuration
UM3433 - Rev 1
page 13/23
UM3433
How to control two boards (daisy chaining) configured in SPI Mode (8-bits or 16-bits) with IFAPGUI
All the buttons with blue text refer to the functions currently active, when the text is gray the function
will be activated after a preliminary action, such as enabling the outputs or setting the frequency and
duty cycle of the PWM.
Step 9.
Board 0 or Board 1 selection.
–
The interface contains two tabs that can be switched to choose which of the two boards to send
the commands. The following figures show how to choose one of the two boards.
Figure 17. STSW-IFAPGUI, Board 0 or Board 1 selection
For additional details, refer to UM2509.
UM3433 - Rev 1
page 14/23
UM3433
How to control the system with Command Line Interface
5
How to control the system with Command Line Interface
There are three application scenarios, respectively based on:
•
•
•
UM3433 - Rev 1
Default on-board switches configuration, by means Single board in GPIO/Parallel Mode
Single board configured in SPI 8-bits, or 16-bits
Two boards configured in SPI (8-bits, or 16-bits) and Daisy Chain mode
Step 1.
Plug the X-NUCLEO-OUT16A1 or the X-NUCLEO-OUT17A1 expansion board on top of the NUCLEOF401RE board, flashed with the STSW-OUT16F4 firmware, through the Arduino® UNO R3 connectors.
Step 2.
Connect the two stacked boards to your PC or laptop USB port through a mini-USB cable. The STM32
is supplied via USB (3.3 V) and the flashed firmware starts running. Press the black button on the
NUCLEO-F401RE board to reset the firmware.
page 15/23
UM3433
How to control the system with Command Line Interface
Step 3.
Launch the serial communication terminal application (Tera Term). When the application starts, the
serial communication must be configured as follows:
Figure 18. Tera Term: select serial communication method
Figure 19. Tera Term: Setup/Terminal
Figure 20. Tera Term: Setup/Serial port
UM3433 - Rev 1
page 16/23
UM3433
How to control the system with Command Line Interface
Step 4.
Press [Enter] and type [h] for help:
Figure 21. CLI help
UM3433 - Rev 1
page 17/23
UM3433
How to control the system with Command Line Interface
Step 5.
Type [w?] for a list of available commands:
Figure 22. Command list
UM3433 - Rev 1
page 18/23
UM3433
How to control the system with Command Line Interface
Step 6.
Initialize the device using [w0] command:
Figure 23. Device initialization board 0
Figure 24. Device initialization board 1
Step 7.
Continue to interact with the device using commands from the available command list (see above).
Note:
–
–
–
–
–
UM3433 - Rev 1
Commands ID 0-6, 8, 10-15, 17-19 are available in all operating modes
Commands ID 7 and 9 are available in GPIO Mode and in SPI Mode (single board)
Commands ID 21 is available only in SPI Mode
Commands ID 22-25 are available only in Daisy Chain Mode
Commands ID 26 is available in SPI Mode and in Daisy Chain Mode
page 19/23
UM3433
Revision history
Table 1. Document revision history
UM3433 - Rev 1
Date
Revision
14-Oct-2024
1
Changes
Initial release.
page 20/23
UM3433
Contents
Contents
1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
2
How to control the single expansion board with default set-up (GPIO/Parallel
mode) with IFAPGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
3
How to control a single expansion board configured in SPI Mode (8-bits or 16bits) with IFAPGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
4
How to control two boards (daisy chaining) configured in SPI Mode (8-bits or
16-bits) with IFAPGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
5
How to control the system with Command Line Interface . . . . . . . . . . . . . . . . . . . . . . . . . .15
Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
List of figures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
UM3433 - Rev 1
page 21/23
UM3433
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.
Figure 13.
Figure 14.
Figure 15.
Figure 16.
Figure 17.
Figure 18.
Figure 19.
Figure 20.
Figure 21.
Figure 22.
Figure 23.
Figure 24.
UM3433 - Rev 1
STSW-IFAPGUI, COM port opened. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
STSW-IFAPGUI, main control panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
STSW-IFAPGUI, COM port opened. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
STSW-IFAPGUI, identification completed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
STSW-IFAPGUI, main control panel for 8-bit SPI configuration before single board or daisy chain selection . . . . 6
STSW-IFAPGUI, main control panel for 16-bit SPI configuration before single board or daisy chain selection . . . 7
STSW-IFAPGUI, System configuration selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
STSW-IFAPGUI, main control panel for 8-bit SPI single board configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 8
STSW-IFAPGUI, main control panel for 16-bit SPI single board configuration . . . . . . . . . . . . . . . . . . . . . . . . . 8
STSW-IFAPGUI, COM port opened. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
STSW-IFAPGUI, identification complete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
STSW-IFAPGUI, main control panel for 8-bit SPI configuration before single board or daisy chain selection . . . 11
STSW-IFAPGUI, main control panel for 16-bit SPI configuration before single board or daisy chain selection . . 12
STSW-IFAPGUI, System Configuration Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
STSW-IFAPGUI, main control panel for 8-bit SPI Daisy Chain configuration . . . . . . . . . . . . . . . . . . . . . . . . . 13
STSW-IFAPGUI, main control panel for 16-bit SPI Daisy Chain configuration . . . . . . . . . . . . . . . . . . . . . . . . 13
STSW-IFAPGUI, Board 0 or Board 1 selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Tera Term: select serial communication method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Tera Term: Setup/Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Tera Term: Setup/Serial port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
CLI help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Command list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Device initialization board 0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Device initialization board 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
page 22/23
UM3433
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
UM3433 - Rev 1
page 23/23
">