Commit 56634395 by Sebastian Stern

added readme

parent 6cbcb567
H1 Dokumentation - ADTF Plugingenerator ROS2
# Dokumentation - ADTF Plugingenerator ROS2
Dieses Dokument die beschreibt die Nutzung des Plugingenerator Scriptes zur Generierung von ADTF-Plugins in Kombination mit ROS2.
H2 Voraussetzungen
## Voraussetzungen
H3 Python
### Python
* Version 3.6.5
* cogapp >= 2.5.1
......@@ -13,19 +13,17 @@ H3 Python
Alternativ kann auch die beiliegende VENV oder Anaconda Umgebung genutzt werden, zu empfehlen ist Anaconda.
H3 ROS2
### ROS2
* Version == Ardent Apalone - 2018-03-07
H3 ADTF
### ADTF
* Version >= 3.3.1
H3 Visual Studio
### Visual Studio
* Version == 2015
H3 Erste Schritte
## Erste Schritte
Damit ROS2 in ADTF genutzt werden kann müssen Umgebungsvariablen ergänzt werden.
Dazu im Configuration-Editor das gewünschte System auswählen und im Bereich System-Editor >> Environment-Variables folgende Einträge ergänzen.
......@@ -50,11 +48,11 @@ Das Script kann über die Konsole mit python main.py gestartet werden. Bei erste
Diese sind unter dem Menü (5) Settings zu finden. Nach dem anpassen bzw. ergänzen der Parameter kann das Script genutzt werden.
H2 Funktionen
## Funktionen
Das Script bietet drei Grundfunktionen
H3 Create Subscriber
### Create Subscriber
Mit Hilfe dieser Funktion kann aus einer ROS2 Message Datei (*.msg) ein ROS2 Subscriber bzw. eine ADTF-Streaming Source erstellt werden.
Die zur Verfügung stehenden Message Dateien können mit dem Menü (6) Show ROS2 msg files angezeigt werden.
......@@ -78,7 +76,7 @@ DDL =
Die nun generierte Streaming Source sendet mit jedem neuen Datenpaket das aus dem ROS2 DDL Nety empfangen wird ein neues Sample mit o.g. Beschreibung in das ADTF Netz.
H3 Create Publisher
### Create Publisher
Diese Funktion erstellt aus gegebener DDL Beschreibung im XML oder cString Format eine eine oder mehrere Message Dateien und im Anschluss daran einen oder mehrere ROS2 Publisher bzw. eine ADTF-Streaming Sinks.
......@@ -130,7 +128,7 @@ TSimpleStruct s_simple_struct
In einem zweiten Schritt werden dann den gewünschten Publisher bzw. Streaming Sinks erstellt entsprechende des jeweiligen DDL-Structs und der korrespondieren ROS2 Message.
Diese Streaming Sinks publizieren mit jedem neuen Datenpaket aus dem ADTF-Netz diese in das ROS2-Netz.
H3 Create Message
### Create Message
Diese Funktion erstellt nur eine Message Datei nach gleichem Schema wie die Funktion "Create Publisher"
......
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