Skip to content

Commit

Permalink
[Documentation] Update installation
Browse files Browse the repository at this point in the history
  • Loading branch information
ipa-nhg committed Nov 13, 2023
1 parent c9fb502 commit ada034d
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 30 deletions.
26 changes: 26 additions & 0 deletions docu/Environment_setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Setup the environment and start the eclipse application

### 0: Start the ROS tooling application

:bangbang::bangbang: This is only needed if you installed the toolig from [source](#option-2-using-the-eclipse-installer---source-installation-ros-tooling-developers), if you installed the release version please continue directly with the [step 1](#1-switch-to-the-ros-developer-perspective)

select de.fraunhofer.ipa.ros.plugin and press the button *Run*

![alt text](images/run_ros_tooling.png)

### 1: Switch to the ROS Developer perspective

Go to Menu Window -> Perspective -> Open Perspective -> Other... -> ROS developer. Your application toolbar will be automatically configured.

### 2: Import the common communication objects project

import the project located under the "ROSCommonObjects" folder of this repository to the workbench of your application:
```
de.fraunhofer.ipa.ros.communication.objects
```

If you have internet a button can clone from GitHub the objects to your workspace and import them automatically:

![alt text](images/clone_and_import.png)

Now that your workspace is setup, you can start creating your [project and defining your ROS system](#Tutorials)
43 changes: 13 additions & 30 deletions docu/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

### Option 1: Using the Release version (Recommended)

The first step is to install eclipse. Please download the installer from the official eclipse [website](https://www.eclipse.org/downloads/packages/installer). Once you start the installer, select the package "Eclipse Modeling Tools".
First the java environment have to be setup:

```
sudo apt-get install openjdk-19-jre
```

Then Eclipse can be installes. Please download the installer from the official eclipse [website](https://www.eclipse.org/downloads/packages/installer). Once you start the installer, select the package "Eclipse Modeling Tools".

![alt text](images/install_eclipse_modeling.png)

Expand All @@ -13,11 +19,15 @@ Press next, and then pick the java version 19 and the folder where you would lik
Continue the installation, acepting the license, as usual.

Once the installation is completed, go to *Help* > *Install New Software...*. To install the latest version of the ROS tooling, add the update site URL [https://raw.githubusercontent.com/ipa320/RosTooling-update-site/main](https://raw.githubusercontent.com/ipa320/RosTooling-update-site/main)(*) in the *Work with* section.

![alt text](images/install_updatesite.png)

If none package is listed, please uncheck the option *Group items by category*. The category *ROS Model* appears in the *Name* area. Check the box in front of *ROS model* and click *Next* to review the list of items to be installed. Click *Next* again to read and accept the terms of the license agreements and afterwards click *Finish*. Eclipse will then start to install the ROS tooling and its dependencies. If you get a security warning about the authenticity, click OK. Finally, when asked, restart Eclipse to complete the installation process.

To start using the ROS tooling continue with the [step 1](#1-switch-to-the-ros-developer-perspective)
To start using the ROS tooling continue with the [step 1](Environment_setup.md/#1-switch-to-the-ros-developer-perspective)


## Alternative installations

### Option 2: Using the Eclipse Installer - Source installation (ROS tooling developers)

Expand Down Expand Up @@ -50,31 +60,4 @@ By default the ROS tooling installation will be saved under the folder *ros-mode

Follow the installation instructions of the Oompth installer dialog, after the installation eclipse will be restarted to launch the ROS tooling configuration. Finally, when all the startup tasks finished press "Workbench".

To start using the ROS tooling continue with the [step 0](#0-start-the-ros-tooling-application)

# Setup the environment and start the eclipse application

### 0: Start the ROS tooling application

:bangbang::bangbang: This is only needed if you installed the toolig from [source](#option-2-using-the-eclipse-installer---source-installation-ros-tooling-developers), if you installed the release version please continue directly with the [step 1](#1-switch-to-the-ros-developer-perspective)

select de.fraunhofer.ipa.ros.plugin and press the button *Run*

![alt text](images/run_ros_tooling.png)

### 1: Switch to the ROS Developer perspective

Go to Menu Window -> Perspective -> Open Perspective -> Other... -> ROS developer. Your application toolbar will be automatically configured.

### 2: Import the common communication objects project

import the project located under the "ROSCommonObjects" folder of this repository to the workbench of your application:
```
de.fraunhofer.ipa.ros.communication.objects
```

If you have internet a button can clone from GitHub the objects to your workspace and import them automatically:

![alt text](images/clone_and_import.png)

Now that your workspace is setup, you can start creating your [project and defining your ROS system](#Tutorials)
To start using the ROS tooling continue with the [step 0](Environment_setup.md/#0-start-the-ros-tooling-application)
Binary file modified docu/images/install_eclipse_modeling.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docu/images/install_updatesite.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ada034d

Please sign in to comment.