This is an old revision of the document!
Installation and Setup
For a successfull installation process you have to carefully follow the instructions below. Notably you have to
- Fullfill the Prerequisites.
- Get the sources Getting the Sources with a Script for the right platform.
Prerequisites
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:
$ apt-get install git make cmake g++
Please make sure to use a g++ version of at least 5.3.
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, comedi or flink. In addition to one of this libraries you need the appropriate eeros wrapper library.
Using our SDK
Setting up the correct way of compiling and using EEROS can be quite cumbersome. We strongly recommend to use our build scripts and if you cross develop then use our prebuilt images together with the associated SDKs (software development kit). These images already contain the necessary libraries. All you have to do is build your own application and deploy it. What to you want to do with EEROS?
- Run examples, use with the simulator → see Use on the Host
- Run on the host together with ROS → see use_with_ros
- Run on the host with comedi → see Use with Comedi
- Use it on the Beaglebone Blue board → see Use on a Beaglebone Blue Board
- Use it on the cb20 board with flink or CAN → see Use on a cb20 Board
- Use it with EtherCAT on x86 platform → see https://wiki.ntb.ch/infoportal/embedded_systems/ethercat/start
Getting the Sources Manually
Do this only, if you are not using the scripts mentioned above and know what you do. Clone the eeros source repository:
$ git clone https://github.com/eeros-project/eeros-framework.git
Checkout a stable version of EEROS:
$ cd eeros-framework $ git checkout v1.2.0
In addition to the eeros library you need to install libraries for hardware access together with the appropriate eeros wrapper libraries, see Installing Hardware Libraries.