Difference between revisions of "Quick start guide"
From ERIKA WIKI
(→Anatomy of a ERIKA v3 Project) |
|||
| Line 13: | Line 13: | ||
* RT-Druid can be downloaded using the [http://www.erika-enterprise.com/index.php/download/erika-v3-download.html download web page] | * RT-Druid can be downloaded using the [http://www.erika-enterprise.com/index.php/download/erika-v3-download.html download web page] | ||
* To download RT-Druid, you have to accept [http://www.erika-enterprise.com/index.php/erika3/licensing.html the RT-Druid and the ERIKA v3 licenses] | * To download RT-Druid, you have to accept [http://www.erika-enterprise.com/index.php/erika3/licensing.html the RT-Druid and the ERIKA v3 licenses] | ||
| − | ** The ERIKA v3 license is a GPL v2, whereas the RT- | + | ** 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 |
* [[Release_schedule_and_build_numbers|Here]] is possible to find more details about the release scheduling and ''build numbers'' of RT-Druid packaging. | * [[Release_schedule_and_build_numbers|Here]] is possible to find more details about the release scheduling and ''build numbers'' of RT-Druid packaging. | ||
| Line 21: | Line 21: | ||
= Starting RT-Druid = | = Starting RT-Druid = | ||
| − | * Double-Click on '''eclipse.exe''' application located into ''eclipse'' folder extracted from the RT-Druid Package and | + | * Double-Click on '''eclipse.exe''' application located into ''eclipse'' folder extracted from the RT-Druid Package and then the workspace selection window will appear as shown the following figure: |
[[File:Arduino tutorial 1.png|thumb|center|Figure 1: RT-Druid Eclipse IDE workspace selection.]] | [[File:Arduino tutorial 1.png|thumb|center|Figure 1: RT-Druid Eclipse IDE workspace selection.]] | ||
| Line 29: | Line 29: | ||
[[File:Arduino tutorial 2.png|thumb|center|Figure 2: RT-Druid Eclipse IDE welcome.]] | [[File:Arduino tutorial 2.png|thumb|center|Figure 2: RT-Druid Eclipse IDE welcome.]] | ||
| − | * Click on ''Welcome tab-sheet close'' button to show the default RT-Druid | + | * Click on ''Welcome tab-sheet close'' button to show the default RT-Druid Eclipse IDE C/C++ perspective as shown in the following figure: |
[[File:Arduino tutorial 3.png|thumb|center|Figure 3: RT-Druid Eclipse IDE C/C++ perspective.]] | [[File:Arduino tutorial 3.png|thumb|center|Figure 3: RT-Druid Eclipse IDE C/C++ perspective.]] | ||
| Line 42: | Line 42: | ||
* other configurations (e.g., as serial port numbers, baud rates, ...) | * other configurations (e.g., as serial port numbers, baud rates, ...) | ||
| − | RT-Druid stores the preferences | + | RT-Druid stores the preferences inside 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: | To open the preferences window, please click on ''Window->Preferences'' menu entry as shown in the following figure: | ||
| Line 51: | Line 51: | ||
* Auto - the location is automatically defined by the tool (typically the ERIKA v3 source code is distributed inside an Eclipse plugin); | * 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; | * 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 | + | * 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. | * Plugins - In this case, the code will be pulled from the specific ERIKA v3 plugin installed in the current eclipse installation. | ||
| Line 57: | Line 57: | ||
[[File:Erika3 preferences.png|thumb|center|Figure 5: Erika Preferences.]] | [[File:Erika3 preferences.png|thumb|center|Figure 5: Erika Preferences.]] | ||
| − | The second setting page, as shown in the following figure, lists the available properties which can be modified by the user (you can double click on a property to modify its value). | + | The second setting page, as shown in the following figure, lists the available properties which can be modified by the user (you can double-click on a property to modify its value). |
[[File:Arduino tutorial 12.png|thumb|center|Figure 6: RT-Druid Eclipse Preferences OIL.]] | [[File:Arduino tutorial 12.png|thumb|center|Figure 6: RT-Druid Eclipse Preferences OIL.]] | ||
| − | For more details about RT-Druid Configuration, see the [[RT-Druid_configuration|RT-Druid | + | For more details about RT-Druid Configuration, see the [[RT-Druid_configuration|RT-Druid configuration wiki page]]. |
= RT-Druid Project = | = RT-Druid Project = | ||
| Line 75: | Line 75: | ||
[[File:Arduino tutorial 5.png|thumb|center|Figure 8: RT-Druid C/C++ Project Wizard.]] | [[File:Arduino tutorial 5.png|thumb|center|Figure 8: RT-Druid C/C++ Project Wizard.]] | ||
| − | * Type the name of | + | * Type the name of 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. | * If you are using Windows OS, you should select the ''Cygwin GCC'' toolchain, and then click on the ''Next'' button. | ||
| Line 83: | Line 83: | ||
[[File:Arduino tutorial 6.png|thumb|center|Figure 9: RT-Druid Project Template Wizard.]] | [[File:Arduino tutorial 6.png|thumb|center|Figure 9: RT-Druid Project Template Wizard.]] | ||
| − | * Click on ''Create a project using one of these templates'' check-box to let the Template Wizard | + | * Click on ''Create a project using one of these templates'' check-box to let the Template Wizard show the available templates as illustrated in the following figure: |
[[File:Arduino tutorial 7.png|thumb|center|Figure 10: RT-Druid Available Templates Wizard.]] | [[File:Arduino tutorial 7.png|thumb|center|Figure 10: RT-Druid Available Templates Wizard.]] | ||
| − | * As example, expand ''AVR8'' and ''Arduino Uno'' entries and choose | + | * As an example, expand ''AVR8'' and ''Arduino Uno'' entries and choose the 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: | * Finally, click on ''Finish'' button to instantiate an RT-Druid Eclipse project from a chosen template as shown in the following figure: | ||
| Line 101: | Line 101: | ||
[[File:Arduino tutorial 19.png|thumb|center|Figure 12: Erika project build.]] | [[File:Arduino tutorial 19.png|thumb|center|Figure 12: Erika project build.]] | ||
| − | * The build process | + | * The build process starts as shown in the following figure: |
[[File:Arduino tutorial 20.png|thumb|center|Figure 13: Erika build process.]] | [[File:Arduino tutorial 20.png|thumb|center|Figure 13: Erika build process.]] | ||
| Line 111: | Line 111: | ||
= Erika distribution clean = | = 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 | + | To completely clean your project, you have to remove both generated and compiled files. This is done using the ''Clean Erika'' functions, as explained 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: | * 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: | ||
| Line 129: | Line 129: | ||
'''NOTE:''' this operation may be necessary every time an Erika or RT-Druid configuration property is modified. | '''NOTE:''' this operation may be necessary every time an Erika or RT-Druid configuration property is modified. | ||
| − | = Anatomy of | + | = Anatomy of an ERIKA v3 Project = |
T.B.D. | T.B.D. | ||
<!-- | <!-- | ||
* explain the directories | * explain the directories | ||
* explain the role of each directory / main files | * explain the role of each directory / main files | ||
| − | * check the auto-generated | + | * check the auto-generated documentation... |
--> | --> | ||
= Per Architecture tutorials = | = Per Architecture tutorials = | ||
* [[AVR8_-_Arduino_application_build_on_Windows|AVR8: Arduino application build on Windows]] | * [[AVR8_-_Arduino_application_build_on_Windows|AVR8: Arduino application build on Windows]] | ||
Revision as of 17:39, 22 December 2017
Contents
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)
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 then the workspace selection window will appear as shown the following figure:
- 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:
- Click on Welcome tab-sheet close button to show the default RT-Druid Eclipse IDE C/C++ perspective as shown in the following figure:
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 inside 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:
The first setting page 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.
The second setting page, as shown in the following figure, lists the available properties which can be modified by the user (you can double-click on a property to modify its value).
For more details about RT-Druid Configuration, see the RT-Druid configuration wiki page.
RT-Druid Project
To create an RT-Druid Project, please follow the steps below:
- Click on File->New->RT-Druid v3 Oil and C/C++ Project menu entry as shown in the following figure:
- The RT-Druid C/C++ Project Wizard will open as shown in the following figure:
- Type the name of 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:
- Click on Create a project using one of these templates check-box to let the Template Wizard show the available templates as illustrated in the following figure:
- As an example, expand AVR8 and Arduino Uno entries and choose the 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:
Building a project
To build an RT-Druid Project, please follow the steps below:
- 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:
- The build process starts as shown in the following figure:
- The build process ends successfully as shown in the following figure:
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 explained 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:
- The Clean up Erika Files dialog window will appear as shown in the following figure:
- 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.
NOTE: this operation may be necessary every time an Erika or RT-Druid configuration property is modified.
Anatomy of an ERIKA v3 Project
T.B.D.
