Differences

This shows you the differences between two versions of the page.

--- getting_started:install_and_setup_development_environment [2019/04/24 21:31] – [Getting the Sources with a Script] graf
+++ getting_started:install_and_setup_development_environment [2021/02/12 16:34] – [Prerequisites] ursgraf
@@ Line 1: / Line 1: @@
 ====== Installation and Setup ======
+For a successfull installation process you have to carefully follow the instructions below. Notably you have to
+  - Fullfill the [[getting_started:install_and_setup_development_environment#prerequisites|Prerequisites]].
+  - Get the sources [[getting_started:install_and_setup_development_environment#Getting_the_sources_with_a_script|Getting the Sources with a Script]] for the right platform.
+  - [[getting_started:compile_eeros|]]
+  - [[getting_started:deploy|]]
 ===== Prerequisites =====
-We use Ubuntu 14.04 LTS or 16.04 LTS on the host machine. Other distributions are supported but not documented here. Further, you have to patch the kernel with a realtime patch as described in [[https://rt.wiki.kernel.org/index.php/Main_Page]]. It is possible to work without the realtime patch. However, the latency of the system will be much worse and will depend greatly on the load of other programs running on the system.
+We use Ubuntu on the host machine. Other distributions are supported but not documented here. Further, you have to patch the kernel with a realtime patch as described in [[https://rt.wiki.kernel.org/index.php/Main_Page]]. It is possible to work without the realtime patch. However, the latency of the system will be much worse and will depend greatly on the load of other programs running on the system.
 To use EEROS on the host machine the following packages have to be installed:
@@ Line 11: / Line 16: @@
 Please make sure to use a g++ version of at least 4.8.
-If you are not only doing simulations you will have to install further software in order to communicate with your underlying hardware. This could be libraries supporting EtherCAT, CANOpen, [[http://www.comedi.org|comedi]] or [[http://www.flink-project.ch|flink]]. In addition to one of this libraries you need the appropriate eeros wrapper library.
+If you are not only doing simulations you will have to install further software in order to communicate with your underlying hardware. This could be libraries supporting EtherCAT, CANopen, [[http://www.comedi.org|comedi]] or [[http://www.flink-project.ch|flink]]. In addition to one of this libraries you need the appropriate eeros wrapper library.
 ===== Getting the Sources with a Script =====
-Setting up the correct way of compiling EEROS can be quite cumbersome. We strongly recommend to use our scripts. Create a new and empty directory and download the scripts from
+Setting up the correct way of compiling EEROS can be quite cumbersome. We strongly recommend to use our scripts. How to setup these scripts depends on your platform. What to you want to do with EEROS?
-<code>
+  * Run examples, use with the simulator → see [[getting_started:install_and_setup_development_environment:use_on_host|]]
-$ git clone https://github.com/eeros-project/eeros-build-scripts.git
+  * Run on the host together with ROS → see [[getting_started:install_and_setup_development_environment:use_with_ros|]]
-</code>
+  * Run on the host with comedi → see [[getting_started:install_and_setup_development_environment:use_with_comedi|]]
-  - Copy all files from the cloned directory into your working directory. This is the place where you want to have all necessary repositories together with your appplication.
+  * Use it on the Beaglebone Blue board → see [[getting_started:install_and_setup_development_environment:use_on_bbb|]]
-  - Edit the ''config.sh.in'' file. Choose an appropriate toolchain file. The toolchain file basically determines which compiler you are going to use. If you work on the host and want to use the standard compiler you can omit this toolchain file. See [[arm_toolchain]] for an example of a toolchain file.
+  * Use it on the cb20 board with flink or CAN → see [[getting_started:install_and_setup_development_environment:use_with_cb20]]
-  - Choose a meaningful name for the build and install directory.
+  * Use it with EtherCAT on x86 platform → see [[https://wiki.ntb.ch/infoportal/embedded_systems/ethercat/start]]
-  - Comment or uncomment the necessary hardware libraries. The script will fetch those left uncommented.
-  - Change the name of your application directory so that it fits your application. Per default a simple motor control will be downloaded. If you don't want to download this and have no other application to download yet, please comment these two lines out.
-Now you can run the ''clone'' script
-<code>
-$ ./clone.sh
-</code>
 ===== Getting the Sources Manually =====
-Clone the eeros source repository:
+Do this only, if you are not using the scripts mentioned above and know what you do. Clone the eeros source repository:
 <code>
 $ git clone https://github.com/eeros-project/eeros-framework.git
@@ Line 38: / Line 37: @@
 <code>
 $ cd eeros-framework
-$ git checkout v0.5
+$ git checkout v1.1.0
 </code>
 In addition to the eeros library you need to install libraries for hardware access together with the appropriate eeros wrapper libraries, see [[install_wrapper]].