Revision as of 13:59, 22 December 2017

Prerequisites

The following is the list of software that should be already be installed in your system before installing ERIKA v3:

• Java (link)
  • for running Eclipse
• Cygwin (link)
  • for the GNU make tool (and optionally Doxygen)
• Doxygen (link)
  • for the automatic documentation
• target compiler (depending on the architecture)
  • Arduino SDK (link)

Downloading ERIKA v3 and RT-Druid

• RT-Druid can be downloaded using the download web page
• To download RT-Druid, you have to accept the RT-Druid and the ERIKA v3 licenses
  • The ERIKA v3 license is a GPL v2, whereas the RT-druid license is a proprietary license that allows you to use the provided version of RT-Druid at no cost
• Here is possible to find more details about the release scheduling and build numbers of RT-Druid packaging.

Installing RT-Druid

RT-Druid is provided as a compressed archive, which can be unpacked in your user directories. On Windows machines, we typically unpack the tool under C:\Evidence\versionnumber, where 'versionnumber' is the build number.

Starting RT-Druid

• Double-Click on eclipse.exe application located into eclipse folder extracted from the RT-Druid Package and than the workspace selection window will appear as shown the following figure:

Figure 1: RT-Druid Eclipse IDE workspace selection.

• Browse the File-System to select Workspace folder and then click on the OK button to let the RT-Druid Eclipse IDE start as shown in the following figure:

Figure 2: RT-Druid Eclipse IDE welcome.

• Click on Welcome tab-sheet close button to show the default RT-Druid Eclipe IDE C/C++ perspective as shown in the following figure:

Figure 3: RT-Druid Eclipse IDE C/C++ perspective.

RT-Druid Preferences

The RT-Druid code generator and the makefile it generates need to make reference to external values, typically named "preferences". These preferences typically store:

• directories (e.g., for specifying the compiler path)
• other configurations (e.g., as serial port numbers, baud rates, ...)

RT-Druid stores the preferences in side the workspace. The following screenshots show how to modify the RT-Druid preferences. Each preference is then described in the specific architecture port.

To open the preferences window, please click on Window->Preferences menu entry as shown in the following figure:

Figure 4: RT-Druid Eclipse Preferences.

The first setting which can be altered is related to the location of the ERIKA v3 codebase. In particular, the codebase can be stored in various locations, and the tool needs to know where to retrieve the code. The possible options are:

• Auto - the location is automatically defined by the tool (typically the ERIKA v3 source code is distributed inside an Eclipse plugin);
• Manual - you can manually specify a root directory (useful in case you have a separate repository on your PC that you want to use;
• ERIKA_FILES / common_oil.pref - in these two cases the tool will retrieve the location either from the ERIKA_FILES environment variable, or from the ERIKA_FILES variable specified in the preference file common_oil.pref
• Plugins - In this case, the code will be pulled from the specific ERIKA v3 plugin installed in the current eclipse installation.

Figure 5: Erika Preferences.

• The RT-Druid Eclipse Preferences window will open as shown in the following figure:

Figure 6: RT-Druid Eclipse Preferences OIL.

For more details about RT-Druid Configuration, see the RT-Druid configuraiton wiki page.

RT-Druid Project

• Click on File->New->RT-Druid v3 Oil and C/C++ Project menu entry as shown in the following figure:

Figure 7: RT-Druid v3 Oil and C/C++ Project.

• The RT-Druid C/C++ Project Wizard will open as shown in the following figure:

Figure 8: RT-Druid C/C++ Project Wizard.

• Type the name of the the project in the Project name text-box: ArduinoEE3 for example.

• If you are using Windows OS, you should select the Cygwin GCC toolchain, and then click on the Next button.

• The wizard will show the window to select a project template as shown in the following figure:

Figure 9: RT-Druid Project Template Wizard.

• Click on Create a project using one of these templates check-box to let the Template Wizard to show the available templates as shown in the following figure:

Figure 10: RT-Druid Available Templates Wizard.

• As example, expand AVR8 and Arduino Uno entries and choose a desired template to instantiate: Full Demo 2 for example.

• Finally, click on Finish button to instantiate an RT-Druid Eclipse project from a chosen template as shown in the following figure:

Figure 11: RT-Druid Eclipse Project.

Building a project

• Right-Click on your project, as example ArduinoEE3, shown in the Eclipse Project Explorer panel, and then click on Build Project context-menu entry as shown in the following figure:

Figure 12: Erika project build.

• The build process start as shown in the following figure:

Figure 13: Erika build process.

• The build process ends successfully as shown in the following figure:

Figure 14: Erika build successfully.

Erika distribution clean

To completely clean your project, you have to remove both generated and compiled files. This is done using the Clean Erika functions, as explain below.

• Right-Click on your project, as example ArduinoEE3, shown in the Eclipse Project Explorer panel, and then click on Clean Erika context-menu entry as shown in the following figure:

Figure 15: Erika Clean.

• The Clean up Erika Files dialog window will appear as shown in the following figure:

Figure 16: Clean up Erika Files.

• Click on Yes button to clean the entire Erika distribution.

NOTE: the distribution folder will be automatically regenerated, if the flag Build Automatically is enabled.

Figure 17: Build automatically flag.

NOTE: this operation may be necessary every time an Erika or RT-Druid configuration property is modified.

Anatomy of a ERIKA v3 Project

• explain the directories
• explain the role of each directory / main files
• check the auto-generated documenattion...

Per Architecture tutorials

• AVR8: Arduino application build on Windows