Skip to content

ETS ‐ HOW TO GENERATE A NEW INSTALLER FOR 2FOC AND EMS4

Davide Tomé edited this page May 31, 2024 · 4 revisions

1 Document Scope

ℹ️ This document explains how to generate new ETS installers for 2FOC and EMS4 boards

2 Requirements

3 2FOC

Here is described how to modify the XML configuration file for ETS test suite (i.e. add/remove/modify a test) and generate the new installer.

3.1 Modifying the XML

In the electronics-legacy repository go to the 2FOC board install package folder

The test is split in 2 phases, the first is for the board with the only SMD components solderd and its XML configuration file is default.xml, the second phase is made after THT components soldering and its XML file is called fase2.xml.

Edit the XML file as per need, a documentation is provided here.

ℹ️ The tests which will be executed are inside the sequence XML tag

3.2 Adding/Removing files

If you need to add or remove any file you must edit the NSIS script with a text editor (recommended VS code + NSIS extension) in the Section "2FOC TEST sw (required)" section:

Add/remove the files needed in the section in the file list :

3.3 Compile the script

To generate the new installer, open NSIS and click on Compile NSI scripts

It opens the NSIS GUI, then File -> Load Script... and browse for the installer.nsi file:

The script will be automatically compiled, then check for successful operation :

The new installer is located here :

4 EMS4

Here is described how to modify the XML configuration file for ETS test suite (i.e. add/remove/modify a test) and generate the new installer.

4.1 Modifying the XML

In the electronics-legacy repository go to the EMS4 board install package folder

The XML file that configures the tests is default.xml

Edit the XML file as per need, a documentation is provided here.

ℹ️ The tests which will be executed are inside the sequence XML tag

4.2 Adding/Removing files

If you need to add or remove any file you must edit the NSIS script with a text editor (recommended VS code + NSIS extension) in the EMS4 (STM32F407) - V 1.0" section:

Add/remove the files needed in the section in the file list :

4.3 Compile the script

To generate the new installer, open NSIS and click on Compile NSI scripts

It opens the NSIS GUI, then File -> Load Script... and browse for the installer.nsi file:

The script will be automatically compiled, then check for successful operation :

The new installer is located here :

5 Produce a new ETS release

To produce a new GitHub release of ETS both for 2FOC and EMS4 boards :

5.1 Go to the Releases section of the repo

<img src ="https://github.com/icub-tech-iit/ipts/blob/master/assets/wiki/ipts/ipts-releases.png >

Search the last ETS release available to know which tag has to be created

In this case, the new release will be 1.0.4

5.2 Click on Draft a new release

5.3 Fill in the Release title and body following the previous formats

5.4 Add attachments to the release

Needed attachments are the new installer, the test procedure (i.e. 2FOC)

5.5 Tag the new release

ℹ️ The link to the new release should be provided to the supplier who will test the new boards