Skip to main content

Installation

TouchGFX is distributed as an X-CUBE-TOUCHGFX zip file which has the following components inside:

  • TouchGFX Designer - Build a UI through a Windows-based GUI Builder
  • TouchGFX Generator - Create a custom TouchGFX HAL through STM32CubeMX
  • TouchGFX Engine - The TouchGFX C++ framework that drives the UI application

Prototyping on STM32 Evaluation kits​

If your intention is to simply try TouchGFX Designer and perhaps do some prototyping on STM32 Evaluation kits, refer to the section Installing TouchGFX Designer. 

Installing TouchGFX Designer​

Download X-CUBE-TOUCHGFX from the ST.com official website to anywhere on your hard drive and extract it.

Downloading X-CUBE-TOUCHGFX from st.com

Inside the extracted folder, you will find the TouchGFX .msi installer in the following path:

Utilities\PC_Software\TouchGFXDesigner

Double-clicking the .msi file will bring up the installer. Follow the instructions to complete the installation process.

Installing TouchGFX Designer

Tip
You need the following tools to be able to flash your board directly from within TouchGFX Designer:

Installing STM32CubeProgrammer​

After downloading STM32CubeProgrammer from STM32CubeProgrammer download location, uncompress the downloaded .zip file and launch the .exe installer file. Then Follow the instructions to complete the installation process.

Installing TouchGFX Designer

Caution
In order for the TouchGFX Designer and Makefiles to be able to use STM32CubeProgrammer for flashing target hardware it must be installed at the default install location: C:\Program Files\STMicroelectronics\STM32Cube\STM32CubeProgrammer

After downloading STM32 ST-LINK Utility from STM32 ST-LINK utility location, simply open the downloaded .exe file and follow the instructions to complete the installation process.

Installing STM32 ST-LINK Utility

Caution
In order for the TouchGFX Designer and Makefiles to be able to use STM32 ST-LINK Utility for flashing target hardware it must be installed at the default install location: C:\Program Files (x86)\STMicroelectronics\STM32 ST-LINK Utility

Custom Product Development​

If your intention is to run TouchGFX applications on either ST display kits or your own custom STM32 based platform, refer to the section Installing TouchGFX Generator in STM32CubeMX.

Installing TouchGFX Generator in STM32CubeMX​

To install X-CUBE-TOUCHGFX through STM32CubeMX, start by selecting "Manage Embedded Software Packages" under "Help" (or press Alt + U).

Help -> Manage embedded software packages

Click "Refresh" to get an updated list of available packages.

Refresh to update available packages

Go to the "STMicroelectronics" tab. Scroll until you find "X-CUBE-TOUCHGFX" and expand the node. Check the checkbox for "TouchGFX Generator" and click "Install Now". This will download the package and bring up the license agreement.

Finding the TouchGFX Generator package

Read and accept the license agreement and click "Finish" to install TouchGFX Generator inside STM32CubeMX.

Accepting the license agreement

The X-CUBE-TOUCHGFX distribution is now unpacked to the following path: 

C:\Users\<user>\STM32Cube\Repository\Packs\STMicroelectronics\X-CUBE-TOUCHGFX\4.13.0

Location of the X-CUBE-TOUCHGFX package