Commit 9dd6a399 authored by Jean Meurice's avatar Jean Meurice
Browse files

Readme update

parent 1b86c7bc
Pipeline #115958 passed with stage
in 3 minutes and 13 seconds
...@@ -27,14 +27,19 @@ or download the project as a [.zip file](https://github.com/MontiSim/server/arch ...@@ -27,14 +27,19 @@ or download the project as a [.zip file](https://github.com/MontiSim/server/arch
__NOTE:__ _MontiSim_ is the directory, in which MontiSim-belonging projects should be clonned. It has to be manually created. __NOTE:__ _MontiSim_ is the directory, in which MontiSim-belonging projects should be clonned. It has to be manually created.
Additionally [RMIModelServer](https://github.com/MontiSim/RMIModelServer) repository has to be cloned, in order to be used and to allow integration of external vehicle models. This can be done via the following commands: Additionally [RMIModelServer](https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/RMIModelServer) repository has to be cloned, in order to be used and to allow integration of external vehicle autopilot models. This can be done via the following commands:
cd MontiSim cd MontiSim
git clone https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/RMIModelServer.git git clone https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/RMIModelServer.git
cd ./RMIModelServer cd ./RMIModelServer
mvn clean install ./scripts/compile_install.bat or ./scripts/compile_install.sh
To use an external vehicle model, one has to clone the corresponding repository. For the _Autopilot emam_ vehicle model, located in [Autopilot emam repository](https://github.com/MontiSim/EMAM-showcase), the following commands have to be executed: The RMIModelServer uses the [HardwareEmulator](https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/hardware_emulator) project to run the autopilots.
A pre-compiled version of the HardwareEmulator is contained in the `install` folder of the RMI server.
The install folder also contains a `run.bat` / `run.sh` script that starts the RMI server within the install folder and uses the `autopilots` folder it contains to load autopilots.
The install folder has to be updated if a new version of the _HardwareEmulator_ is used.
To use an external vehicle autopilot, one has to clone the corresponding repository. For the _Autopilot emam_ vehicle model, located in [Autopilot emam repository](https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/EMAM-showcase), the following commands have to be executed:
cd MontiSim cd MontiSim
git clone https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/EMAM-showcase.git git clone https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/EMAM-showcase.git
...@@ -43,10 +48,8 @@ To use an external vehicle model, one has to clone the corresponding repository. ...@@ -43,10 +48,8 @@ To use an external vehicle model, one has to clone the corresponding repository.
main.bat main.bat
The last command `main.bat` will compile the model and run it in a server container to test it. One can close the server container right after its start, since the only reason the `main.bat` is used in current case is to generate the _Autopilot_ dll library. The last command `main.bat` will compile the model and run it in a server container to test it. One can close the server container right after its start, since the only reason the `main.bat` is used in current case is to generate the _Autopilot_ dll library.
This dll (os `.so` for linux) file can be renamed to a desired autopilot name and placed inside the `autopilots` folder used by the RMIModelServer.
__NOTE:__ Autopilot EMAM model works only in _Windows 64 bit_ environment. This folder contains the last version of the _EMAM-showcase_ autopilot (_AutopilotAdapter_).
To run the RMIModelServer, one has to run the `run.bat` or `run.sh` scripts located in `RMIModelServer/scripts/` directory. Pay attention to the version of the RMIModelServer. The filename of the form `rmi-model-server-*.jar` (where * stands for some version) in `run.bat` should match the generated jar-file in the `RMIModelServer/target/` directory.
# Installation # Installation
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment