cancel
Showing results for 
Search instead for 
Did you mean: 

Knowledge Base Articles

Offloading the Manifest Files of ModusToolbox - KBA230953

Employee

Offloading the Manifest Files of ModusToolbox - KBA230953

Author: DheerajK_81           Version: *B

Translation - Japanese: ModusToolboxのマニフェストファイルのオフロード - KBA230953 - Community Translated (JA)

Question:

ModusToolbox™ 2.x is not able to access the site that hosts the manifest files when creating a new application. The Project Creator fails with the error “Failed to access remote server”. Can I offload the file request to the manifest files in any way to resolve this error?

pastedImage_0.png

Answer:

When you create a new application in ModusToolbox, information is fetched from files called “manifests” to display Board Support Packages (BSP) and code example templates  (see the “Manifest Files” chapter in the ModusToolbox User Guide.

The manifest files are hosted on the Cypress GitHub Repository. The website raw.githubusercontent.com is used to serve files kept in GitHub repositories.

In some countries or in situations when access to this domain is restricted, there are three options to work around this problem:

Method 1 or 2 is recommended if you have access to the internet but only face problems accessing the Github domain through raw http access. It allows you to get the latest libraries, code examples, BSPs etc. each time you create a new application.

Method 3 involves downloading a static offline package. Note that this package is a few hundreds of MBs in size and updated on a quarterly basis. To get the new libraries and code examples, you need to download it from time to time. It is only recommended when working offline.

Use the methods in priority order as stated below.

1. Method 1: Offloading the manifests to a different remote server location

This is a one-time process; all new applications created will use these offloaded manifests.

Do the following to offload manifest files to a different server (in our case from GitHub to itools.infineon.cn):

a. Run the in-built bash shell if you are a Linux/MacOS user. Windows users can skip to the next step.

b. Set the System Variable:

  • Windows users: Set the system environment variable to override the manifests permanently. Set the variable name to CyRemoteManifestOverride  

pastedImage_8.png

  • Linux/MacOS users: Execute the following command in the bash shell:

i. For ModusToolbox 2.1 users:

  >> export CyRemoteManifestOverride=https://itools.infineon.cn/mtb/manifests/mtb-super-manifest.xml

ii. For ModusToolbox 2.2 users:

  >> export CyRemoteManifestOverride=https://itools.infineon.cn/mtb/manifests/mtb-super-manifest-fv2.xml

c. Create a new application:

  • Windows users: Launch Eclipse IDE for ModusToolbox or Project Creator standalone tool to create a new application. Both methods invoke the Project Creator window.
  • Linux/MacOS users: Invoke Eclipse IDE for ModusToolbox or Project Creator standalone tool from the bash shell in the same bash session. The variable set in the previous step will only have effect in the same bash session.

To invoke Eclipse IDE for ModusToolbox run the command:

>> ~/ModusToolbox/ide_2.2/eclipse/ModusToolbox.exe

To invoke Project Creator tool run the command:

>> ~/ModusToolbox/tools_2.2/project-creator/project-creator.exe

     Note: Change the path accordingly if you have installed ModusToolbox in a custom location.

You will notice that the manifest files are now being fetched from a different server location.

pastedImage_12.png

 

2. Method 2: Offloading the manifests to a location on the disk

This is a one-time process; all new applications created will use these offloaded manifests.

Do the following to offload manifest files:

a. Download the zip archive of the manifest files from here.

b. Extract the files to ~/.modustoolbox directory. In case you don’t see this directory, create a directory named “.modustoolbox” and extract inside it.

  pastedImage_13.png

c. Run the in-built bash shell if you are a Linux/MacOS user. Windows users can skip to the next step.

d. Set the System Variable:

  • Windows users: Set the system environment variable to override the manifests permanently. Set the variable name to CyRemoteManifestOverride
  • For MTB 2.1 users, the variable value is:

<path_to_file>/.modustoolbox/mtb-super-manifest.xml

  • For MTB 2.2 users, the variable value is:

<path_to_file>/.modustoolbox/mtb-super-manifest-fv2.xml

 

pastedImage_18.png

  • Linux/MacOS users: Execute the following command in the bash shell:

i. For ModusToolbox 2.1 users:

  >> export CyRemoteManifestOverride=file:///$HOME/.modustoolbox/mtb-super-manifest.xml

ii. For ModusToolbox 2.2 users:

  >> export CyRemoteManifestOverride=file:///$HOME/.modustoolbox/mtb-super-manifest-fv2.xml

e. Create a new application:

  • Windows users: Launch Eclipse IDE for ModusToolbox or Project Creator standalone tool to create a new application. Both methods invoke the Project Creator window.
  • Linux/MacOS users: Invoke Eclipse IDE for ModusToolbox or Project Creator standalone tool from the bash shell in the same session. The variable set in the previous step will only have effect in the same bash session.

To invoke Eclipse IDE for ModusToolbox run the command:

>> ~/ModusToolbox/ide_2.2/eclipse/ModusToolbox.exe

To invoke Project Creator tool run the command:

>> ~/ModusToolbox/tools_2.2/project-creator/project-creator.exe

          Note: Change the path accordingly if you have installed ModusToolbox in a custom location.

You will notice that the manifest files are now being fetched from the location on the disk.

  pastedImage_26.png

3. Method 3: Using ModusToolbox Offline Package

ModusToolbox provides an offline content package that you can download and use to create new applications. This method should only be used as a last resort option. Asset releases occur frequently while offline content releases are not. So, the offline content may not always reflect the latest updates. For more information on using the offline package, see this article: https://community.cypress.com/docs/DOC-19903


0 Likes
Version history
Revision #:
1 of 1
Last update:
‎Aug 12, 2020 11:48 PM
Updated by:
 
Contributors