Skip to main content

Updating to a new TouchGFX Version

When a TouchGFX Designer application is created, the .touchgfx project file created will have the same version as the TouchGFX version used to create the application. But this does not mean that you are only able to use that specific version of TouchGFX to further develop your application.

TouchGFX is backwards-compatible by design and in most cases it requires a very simple procedure to make an older versioned application work with a new version of TouchGFX.

Simply open your newly installed version of TouchGFX Designer and try to open your older application either through recent applications or the Open dialog. You will be greeted with the following popup:

Update popup

Caution
As stated in the popup, it is recommended to always have a backup of your application before running the updater.

Press 'Yes' and the updater will start. After it is finished, the application will open as normal in TouchGFX Designer and you are ready to use the new version.

In rare cases, you will have to do some manual changes to an application to make it fully updated to a new TouchGFX version. Consult the Known Issues section if you are having additional problems updating an application to a new version.

Update TouchGFX Generator​

After installing X-Cube-TouchGFX-4.17.0 in STM32CubeMX 6.2.1 or later by following Installing TouchGFX Generator in STM32CubeMX open the project and navigate to Software Packs -> Select Components (or press Alt + U)

Software Pack Component Selector

In the details and warnings pane select the version to migrate to and press try. STM32CubeMX will perform a trail migration and present the result, some refparameters are not able to be migrated to the new version and therefore will be presented as null values. Select accept to save the migration and then press OK to close the Software Pack Component Selector window.

Software Pack Component Selector : Migrate Parameters for TouchGFX Generator

Now TouchGFX Generator is migrated to the new version and the changes are saved in the .ioc file. Please validate the configuration of TouchGFX Generator before generating code with STM32CubeMX. After generating code with STM32CubeMX open TouchGFX Designer and validate the ui before generating code from TouchGFX Designer.

Caution
  • The migration is a two step process to update TouchGFX to the new version. It requires code generation from both STM32CubeMX and TouchGFX Designer.
  • C++ code provided by TouchGFX Generator is first written to disk after the Generate Code button in STM32CubeMX has been pressed.