How to Upgrade TouchGFX version
This article explains how to upgrade TouchGFX to a new version for your existing application. It covers updating the TouchGFX framework files, your BoardConfiguration and your TouchGFX environment shell. Not all these steps are necessary for all updates.
Overview of TouchGFX Versioning
TouchGFX releases follow a semantic versioning scheme, where backwards compatibility is ensured as long as the major version number does not change. This means that if you have an existing application that runs on e.g. TouchGFX 4.3.0, you can upgrade to TouchGFX 4.5.0 without changing anything in the application. The same goes for the HAL code and BoardConfiguration, which can also be re-used without modifications. In the event of critical bugs, performance or feature issues which cannot be implemented without an API breaking change, these will be explicitly mentioned in the Known Issues article. It is therefore recommended to take a look at the known issues list before upgrading, to see if there are any particular concerns for your application.
Upgrading TouchGFX (MSI installer)
It is possible to have several different versions of TouchGFX installed ont he same pc. When a new version is available, you can choose to uninstall the old one via Add/Remove programs if you only want the new one installed.
Running the MSI installer will guide you through the installation process.
- The installation path must not contain spaces.
- Keep installation path short, as some IDEs have problems with long file paths
Enabling new optional features
Often TouchGFX releases will contain new configuration features that are optional to use and needs to be explicitly enabled for them to have effect on your existing application. Examples of these are the finger size feature (introduced in 4.4.0) and the frame rate compensation feature (introduced in 4.5.0). Such features will be mentioned in the changelog.txt file accompanying the new release, and you can see how it is enabled in any of the BoardConfiguration.cpp files distributed with the new release. Pick the one most closely resembling your platform.
TouchGFX environment shell
When using the MSI installer, you will automatically get a new version of the environment shell. If you have made any changes to your old one (like .profile settings etc.) you need to manually copy these to the new installation.
As mentioned earlier, always check the Known Issues article to see if there is anything specifically that needs to be done by you, depending on which old and new TouchGFX version you are using.