Difference between revisions of "Quick start guide"

From ERIKA WIKI
Jump to: navigation, search
(Prerequisites)
(RT-Druid Project)
Line 55: Line 55:
  
 
= RT-Druid Project =
 
= RT-Druid Project =
* Where to create a new project
+
 
* Step-by-step creation of a projet (select Cygwin, name, template)
+
* Click on ''File->New->RT-Druid v3 Oil and C/C++ Project'' menu entry as shown in the following figure:
 +
 
 +
[[File:Arduino tutorial 4.png|thumb|center|Figure 4: RT-Druid v3 Oil and C/C++ Project.]]
 +
 
 +
* The ''RT-Druid C/C++ Project Wizard'' will open as shown in the following figure:
 +
 
 +
[[File:Arduino tutorial 5.png|thumb|center|Figure 5: 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:
 +
 
 +
[[File:Arduino tutorial 6.png|thumb|center|Figure 6: 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:
 +
 
 +
[[File:Arduino tutorial 7.png|thumb|center|Figure 7: 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:
 +
 
 +
[[File:Arduino tutorial 8.png|thumb|center|Figure 8: RT-Druid Eclipse Project.]]
  
 
= Building a project =
 
= Building a project =

Revision as of 12:28, 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
    • for running Eclipse
  • Cygwin
    • for the GNU make tool (and optionally Doxygen)
  • Doxygen
    • for the automatic documentation
  • target compiler (depending on the architecture)

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 makefiles need to make reference to external directories (e.g., for specifying the compiler path), or other configurations (such as serial port numbers, baud rates, ...).

  • Click on Window->Preferences menu entry as shown in the following figure:
Figure 11: RT-Druid Eclipse Preferences.
  • ERIKA PREFERENCES
Figure 12: Erika Preferences.
  • The RT-Druid Eclipse Preferences window will open as shown in the following figure:
Figure 13: RT-Druid Eclipse Preferences OIL.


  • RT-Druid Generator can be configured, as example, to use a specific path for the AVR8 compiler.
This configuration is done using properties, that can be set as explained here

RT-Druid Project

  • Click on File->New->RT-Druid v3 Oil and C/C++ Project menu entry as shown in the following figure:
Figure 4: RT-Druid v3 Oil and C/C++ Project.
  • The RT-Druid C/C++ Project Wizard will open as shown in the following figure:
Figure 5: 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 6: 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 7: 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 8: RT-Druid Eclipse Project.

Building a project

  • How to build / clean a project

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

  • list of the available tutorials (AVR8)