Skip to content

Commit f8e05f2

Browse files
Add documentation for StreamingUpdate
- Align figure - Add architecture information - Add section to top-level interface Signed-off-by: Thomas Sedlmayer <tsedlmayer@pmsfit.de>
1 parent 910a743 commit f8e05f2

File tree

4 files changed

+18
-4
lines changed

4 files changed

+18
-4
lines changed

doc/architecture/architecture_overview.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,16 @@ The following figure shows a more advanced use case for traffic participants.
3232
.Traffic participant with sensor models, AD function, and dynamic model
3333
image::{images_open_simulation_interface}/osi-traffic-participant-advanced.png[1100]
3434

35-
[#fig-interface-streaming]
36-
.Interface for Streaming
37-
image::{images_open_simulation_interface}/osi-streaming-principle.png[1100]
38-
3935
The `HostVehicleData` interface describes the measured internal states of a traffic participant.
4036
OSI currently provides only limited support for data structures that describe measured internal states of traffic participants.
4137
Actuator intentions are currently not covered by OSI and must be handled using a different data description format.
4238

39+
The `StreamingUpdate` interface enables partial ground truth updates to modules that favor performance, especially latency, over data completeness/consistency (e.g. visualization applications) or that do not require complete data in the first place (e.g. logging applications).
40+
41+
[#fig-interface-streaming]
42+
.Interface for partial ground truth updates
43+
image::{images_open_simulation_interface}/osi-streaming-principle.png[1100]
44+
4345
NOTE: OSI uses singular instead of plural for `repeated` field names.
4446

4547
NOTE: All fields in an interface are set to `optional`.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
ifndef::include-only-once[]
2+
:root-path: ../
3+
include::{root-path}_config.adoc[]
4+
endif::[]
5+
= Streaming update
6+
7+
The `StreamingUpdate` message provides an interface to transmit a subset of ground truth and/or vehicle internal data.
8+
This interface mainly addresses applications with low latency requirements and no need for highly consistent and complete data, e.g. visualization applications.
9+
Static and/or non-relevant objects can be omitted as required for the specific use case.
10+
Note that the receiver of partial updates can only rely on the most up-to-date information at the corresponding timestamp. E.g. omitting objects does not indicate static behaviour but it may be sufficient for the use case to update certain objects at a later point in time.
11 KB
Loading

doc/open-simulation-interface_user_guide.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ include::./architecture/traffic_command.adoc[leveloffset=+3]
2727

2828
include::./architecture/traffic_update.adoc[leveloffset=+3]
2929

30+
include::./architecture/streaming_update.adoc[leveloffset=+3]
31+
3032
=== Model types
3133

3234
include::./architecture/environmental_effect_model.adoc[leveloffset=+3]

0 commit comments

Comments
 (0)