[to be continued...] Working on up-to-date documentation

Author: ipa-nhg

README.md

@@ -1,4 +1,4 @@
-# Ros Model
+# RosTooling
 
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![ros-model CI](https://github.com/ipa320/ros-model/actions/workflows/build.yml/badge.svg)](https://github.com/ipa320/ros-model/actions/workflows/build.yml)
 
@@ -11,25 +11,18 @@ The models have associated tools, the following are some examples:
 - Code geneators to automatically generate code, documentation, helper scripts...
 - (ToBeDone) Graphical editor
 
-
 Technical Maintainer: [**ipa-nhg**](https://github.com/ipa-nhg/) (**Nadia Hammoudeh Garcia**, **Fraunhofer IPA**) - **[email protected]**
 
 ## Projects/Links related to this repository:
 
-- Eclipse Tooling update site: Tbd
-
 Related repositories:
 - ROS2 embedded code generator: [rossdl](https://github.com/CoreSenseEU/rossdl)
 - Python parsers (packed as a ROS package) for the ROS and ROSsystem models: [ros_model_parser](https://github.com/ipa320/ros_model_parser)
 - Python implementation for the static code analyzers and docker containers setups for different ROS distros: [ros-model-extractors](https://github.com/ipa320/ros-model-extractors)
 - Runtime monitoring pipelines:
   - ROS1: [rosgraph_monitor](https://github.com/ipa320/rosgraph_monitor)
   - ROS2: [ros2mode](https://github.com/ipa-cmh/ros2model/)
-  
-OLD:
-- Language server for the RosModels (web-based models editor): [theia-ros-model](https://github.com/ipa-nhg/theia-ros-model)
-- Web interface to automatically extract models from public source code: [model extractor](http://ros-model.seronet-project.de/)
-- Source code for the web interface (extract models for non-public available ROS packages): [ros-model-cloud](https://github.com/ipa320/ros-model-cloud)
+- Eclipse update site: [RosTooling-update-site](https://github.com/ipa320/RosTooling-update-site)
 
 Publications:
 - Paper: Bootstrapping MDE Development from ROS Manual Code - Part 1: Metamodeling [IRC19 paper](https://ieeexplore.ieee.org/document/8675668)
@@ -39,32 +32,40 @@ Publications:
 
 ---------------------------------------------------------
 
-# ROS TOOLING MANUAL
+# RosTooling Manual
 
 ## Installation
 
-Tbd
-- [As VS Code plugin](tbd)
+- [Eclipse feature](docu/Installation.md#option-1-using-the-release-version-recommended)
 - [(Only for tooling developers) From Source code in eclipse](docu/Installation.md#option-2-using-the-eclipse-installer---source-installation-ros-tooling-developers)
+- VS Code plugin(tbd) - WIP [vscode-RosTooling](https://github.com/ipa320/vscode-RosTooling)
 
 ## Tutorials
 
 - Create component models:
-
   - (Prerequisite) [Add communication objects](docu/NewCommunicationObjects.md)
   - [Create a ROS model from your source code(static code analyzer)](docu/NewRosModel.md)
   - [Create a ROS model from a deployed robot using our introspection at runtime tool](docu/IntrospectionNode.md)
   - [Create new ROS component description](docu/RosModelDescription.md)
   - [Generation of code from models](docu/CodeGeneration.md)
 
 - Combine components to form a ROS System
-
   - [Create manually a new RosSystem description](docu/RosSystemModelDescription.md)
-  - [Create a ROS system model from your source code (static code analyzer)](docu/NewRosSystemModel.md)
-  - [System Model extraction using introspection at runtime](docu/IntrospectionSystem.md)
+  
+- Examples:
+  - [Simple publisher-subscriber](docu/Example_PubSub.md)
+  - [Turtlesim](docu/Example_Turtlesim.md)
 
 - [Update Release versions (only for administrators)](docu/Release.md)
 
 ## Model examples
 
 The repository [ros-model-examples](https://github.com/ipa-nhg/ros-model-examples) contains a set components and system examples.
+
+---------------------------------------------------------
+# OLD (out-of-date)
+
+Links to related repositories:
+- Language server for the RosModels (web-based models editor): [theia-ros-model](https://github.com/ipa-nhg/theia-ros-model)
+- Web interface to automatically extract models from public source code: [model extractor](http://ros-model.seronet-project.de/)
+- Source code for the web interface (extract models for non-public available ROS packages): [ros-model-cloud](https://github.com/ipa320/ros-model-cloud)

docu/Installation.md

@@ -2,43 +2,42 @@
 
 ### Option 1: Using the Release version (Recommended)
 
-In Eclipse, go to *Help* > *Install New Software...*. To install the latest version of the ROS tooling, add the update site URL [http://ros-model.seronet-project.de/updatesite/latest/](http://ros-model.seronet-project.de/updatesite/latest/)(*) in the *Work with* section. If you wish to install an earlier version instead, go to the [the update site](http://ros-model.seronet-project.de/updatesite/), choose the desired version and copy its URL.
+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".
 
-![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.
+![alt text](images/install_eclipse_modeling.png)
 
+Press next, and then pick the java version 19 and the folder where you would like to install eclipse.
 
-(*) Apart of the latest stable release of the tooling, some pre-releases for new feautures are available. See the following list of current pre-releases:
+![alt text](images/install_eclipse_jdk_version.png)
 
-| Name | Code version | Update Site Link | Description |
-|---|---|---|---|
-|TestComponentStack|https://github.com/ipa320/ros-model/tree/1.4.0_TestComponentStacks|http://ros-model.seronet-project.de/updatesite/TestComponentStacks/latest/| Added to the RosSystem metamodel the option to group components forming components stacks. This pre-release is backward compatible for the models, but the validators and generators are **not** updated. If Xtext report errors, please ignore them. |
-| v1.5 | https://github.com/ipa320/ros-model/tree/1.5.0_pre-release |http://ros-model.seronet-project.de/updatesite/pre-release/latest/| Long term version of the grammar (simplified for the 1.4 release). **This version is not backwards compatible with 1.3 and earlier releases**|
+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)
 
 ### Option 2: Using the Eclipse Installer - Source installation (ROS tooling developers)
 
-First the java environment have to be setup, for eclipse it is recomended the installation of the version 8 (i.e. X=8) for Ubuntu 16.04 and 11 (i.e. X=11) for the 18.04 and 20.04:
+First the java environment have to be setup:
 ```
-sudo apt-get install openjdk-11-jre
+sudo apt-get install openjdk-19-jre
 ```
-Download the official [Eclipse Installer](https://www.eclipse.org/downloads/packages/installer) for your preferred operating system. Execute the installer and choose the advanced mode (menu on the right-up corner). Select the Product *Eclipse Modeling tools* package, for the version it is recommended *2021-12*.
+Download the official [Eclipse Installer](https://www.eclipse.org/downloads/packages/installer) for your preferred operating system. Execute the installer and choose the advanced mode (menu on the right-up corner). Select the Product *Eclipse Modeling tools* package. And then pick the java version 19.
 
 ![alt text](images/eclipse_installer1.png)
 
 Press *Next* and add a new *User project* pressing the green button *+*:
 ```
 Catalog: Github Projects
-Resource URIs: https://raw.githubusercontent.com/ipa320/ros-model/master/EclipseInstaller/ROSModel.setup
+Resource URIs: https://raw.githubusercontent.com/ipa320/RosTooling/main/EclipseInstaller/ROSModel.setup
 ```
 Sometimes eclipse is not able to find the file, for those cases we recommend to download the file to the local memory of the machine and import it:
 
 ```
-wget https://raw.githubusercontent.com/ipa320/ros-model/master/EclipseInstaller/ROSModel.setup
+wget https://raw.githubusercontent.com/ipa320/RosTooling/main/EclipseInstaller/ROSModel.setup
 ```
 
 ![alt text](images/eclipse_installer2.png)

docu/Introspection.md renamed to docu/IntrospectionNode.md

@@ -0,0 +1 @@
+## TBD

docu/RosModelDescription.md

@@ -0,0 +1 @@
+## TBD

docu/RosSystemModelDescription.md

@@ -4,14 +4,14 @@ If you want to check that the model of your node is following a concrete specifi
 
 Press the button of ROS model checker:
 
-![alt text](images/compare_icon.png)
+![alt text](../images/compare_icon.png)
 
 Select as input your model file and as specification the model that defines the standard you want to follow (some specifications are available under **de.fraunhofer.ipa.ros.communication.objects/BasicSpecs**).
 
-![alt text](images/compare_select.png)
+![alt text](../images/compare_select.png)
 
 To use this feature you have to locate your model file in your eclipse workspace by importing the project that contains it.
 
 By pressing *Finish* a dialog will give you a summary of your analysis:
 
-![alt text](images/compare_result.png)
+![alt text](../images/compare_result.png)

docu/images/install_eclipse_jdk_version.png

@@ -6,11 +6,11 @@ This feature allows the merge of two different ROS system models.   To combine t
 
 
 
-![CombineModels](images/CombineModels_1.png)
+![CombineModels](../images/CombineModels_1.png)
 
 A pop-up menu will ask you for the two models to combine (have to be on imported project of your workspace) and the path where to save the resulted file (that will be called *result.rossystem*. Finally the user can check the box "Combine to the minimal model (restrictive strategy)"  to switch the strategy.
 
-![CombineModels](images/CombineModels_2.png)
+![CombineModels](../images/CombineModels_2.png)