Add usage example (#62)

Signed-off-by: Maximilian Rosin <maximilian.rosin@parson-europe.com>
OpenSimulationInterface · Jun 3, 2021 · 96ae671 · 96ae671
1 parent 3b290dc
commit 96ae671
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/doc/misc/example_visualizer.adoc b/doc/misc/example_visualizer.adoc
@@ -0,0 +1,13 @@
+= Example use of OSI Visualizer
+
+In this example, channel 1 of OSI Visualizer reads a trace file containing `SensorView` messages and publishes these messages at port 5564.
+An intermediary runs at localhost using a OSMP sensor model .
+The intermediary processes `SensorView` messages received at port 5564, transforms them into `SensorData` messages, and sends them to port 5563.
+OSI Visualizer listens at port 5564 for `SensorData` messages and visualizes them in channel 2.
+
+[[image-demo]]
+image::demo.png[title = "Example configuration of OSI Visualizer."]
+
+After clicking **Play** for channel 1 and 2, OSI Visualizer visualizes the communication between the two channels.
+Channel 1 plays the selected OSI input file scenario and sends out the OSI message to port 5564 at the same time.
+Channel 2 visualizes the received OSI messages at localhost at port 5563 showing it on the canvas.
diff --git a/doc/osi-visualizer_user_guide.adoc b/doc/osi-visualizer_user_guide.adoc
@@ -50,3 +50,5 @@ include::./use/saving_messages.adoc[leveloffset=+2]
 include::./use/comparing_messages.adoc[leveloffset=+2]
 
 include::./use/configuring_view.adoc[leveloffset=+2]
+
+include::./misc/example_visualizer.adoc[leveloffset=+2]