From 1b31d40d7e845abef35cdb8857c6f6f5d4823d89 Mon Sep 17 00:00:00 2001 From: pasched Date: Tue, 26 Oct 2021 10:54:20 +0200 Subject: [PATCH 01/12] adjusted linking method Signed-off-by: pasched --- doc/architecture/formatting_scripts.adoc | 2 +- doc/architecture/trace_file_formats.adoc | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/architecture/formatting_scripts.adoc b/doc/architecture/formatting_scripts.adoc index d1ee28b3d..2ff767ce4 100644 --- a/doc/architecture/formatting_scripts.adoc +++ b/doc/architecture/formatting_scripts.adoc @@ -49,4 +49,4 @@ The default value is `None`. **Related topics** -* <<#top-1a2f4b0c-195c-4f18-89ad-d48a123bd8c1>>[OSI trace file formats] \ No newline at end of file +* <<_osi_trace_file_formats>> \ No newline at end of file diff --git a/doc/architecture/trace_file_formats.adoc b/doc/architecture/trace_file_formats.adoc index a029d2d1b..510797dff 100644 --- a/doc/architecture/trace_file_formats.adoc +++ b/doc/architecture/trace_file_formats.adoc @@ -1,4 +1,3 @@ -[#top-1a2f4b0c-195c-4f18-89ad-d48a123bd8c1] = OSI trace file formats There are multiple formats for storing multiple serialized OSI messages in one trace file. From cd39c16a827634edc3344cdfbd51046baa11aade Mon Sep 17 00:00:00 2001 From: pasched Date: Tue, 26 Oct 2021 11:09:23 +0200 Subject: [PATCH 02/12] moved versioning.adoc to osi-documentation Signed-off-by: pasched --- doc/releases/versioning.adoc | 35 ----------------------------------- 1 file changed, 35 deletions(-) delete mode 100644 doc/releases/versioning.adoc diff --git a/doc/releases/versioning.adoc b/doc/releases/versioning.adoc deleted file mode 100644 index f8d347b48..000000000 --- a/doc/releases/versioning.adoc +++ /dev/null @@ -1,35 +0,0 @@ -= Versioning and compatibility - -The version number is defined in `InterfaceVersion::version_number` in `osi_version.proto` as the field's default value. - -OSI uses https://semver.org/[Semantic Versioning]. - -Major:: -A change in the major version makes the code and recorded proto messages incompatible. -+ -Major changes include: -+ -* An existing field with a number changing its meaning. -Example: `optional double field = 1;` changes to `repeated double field = 1;`. -* Changing the definition of units or the interpretation of a field. -* Deleting a field and reusing the field number. -* Changing the technology from Protocol Buffers to FlatBuffers. - -Minor:: -A change in the minor version indicates there is still compatibility with previously recorded files. -However, the code needs fixing. -+ -Minor changes include: -+ -* Renaming a field without changing the field number. -* Changing the names of messages. -* Adding a new field in a message without changing the numbering of other fields. - -Patch:: -Both recorded files and code still have compatibility. -+ -Patches include: -+ -* File or folder structure that does not affect integration of the code in other projects. -* Changing or adding comments. -* Clarifying text passages explaining the message content. From 885e1a7db9ed11c8c633383b0a3a931b2225fa8f Mon Sep 17 00:00:00 2001 From: pasched Date: Tue, 26 Oct 2021 15:10:53 +0200 Subject: [PATCH 03/12] docs: revise message formatting Signed-off-by: pasched --- .../environmental_effect_model.adoc | 4 +-- doc/architecture/feature_data.adoc | 4 +-- doc/architecture/ground_truth.adoc | 4 +-- doc/architecture/logical_model.adoc | 2 +- doc/architecture/sensor_data.adoc | 4 +-- doc/architecture/sensor_model.adoc | 3 +-- doc/architecture/sensor_view.adoc | 2 +- .../sensor_view_configuration.adoc | 26 +++++++++---------- doc/architecture/trace_file_naming.adoc | 10 +++---- doc/architecture/traffic_command.adoc | 2 +- doc/architecture/traffic_update.adoc | 2 +- 11 files changed, 31 insertions(+), 32 deletions(-) diff --git a/doc/architecture/environmental_effect_model.adoc b/doc/architecture/environmental_effect_model.adoc index c58432a40..7ef1e7dbb 100644 --- a/doc/architecture/environmental_effect_model.adoc +++ b/doc/architecture/environmental_effect_model.adoc @@ -1,7 +1,7 @@ = Environmental effect model -Environmental effect models consume sensor-view messages and produce sensor-view messages. -Environmental effect models may, for example, alter sensor-view messages to include effects and phenomena caused by: +Environmental effect models consume `SensorView` messages and produce `SensorView` messages. +Environmental effect models may, for example, alter `SensorView` messages to include effects and phenomena caused by: * Shadows and occlusions * Weather effects diff --git a/doc/architecture/feature_data.adoc b/doc/architecture/feature_data.adoc index e9b1c9c81..79527d6f9 100644 --- a/doc/architecture/feature_data.adoc +++ b/doc/architecture/feature_data.adoc @@ -1,5 +1,5 @@ = Feature data -Feature-data messages contain detected features in the reference frame of a sensor. -Feature-data messages are generated from ground-truth messages. +`FeatureData` messages contain detected features in the reference frame of a sensor. +`FeatureData` messages are generated from `GroundTruth` messages. They serve, for example, as an input to sensor models simulating object detection or feature fusion models. diff --git a/doc/architecture/ground_truth.adoc b/doc/architecture/ground_truth.adoc index b6599acf0..6cbeda809 100644 --- a/doc/architecture/ground_truth.adoc +++ b/doc/architecture/ground_truth.adoc @@ -1,5 +1,5 @@ = Ground truth -Ground-truth messages describe the simulated environment containing all simulated objects in the global coordinate system at consecutive time instances. +`GroundTruth` messages describe the simulated environment containing all simulated objects in the global coordinate system at consecutive time instances. They are based on data available to the simulation environment. -Ground-truth messages are typically contained in sensor view messages. \ No newline at end of file +`GroundTruth messages are typically contained in `Sensorview` messages. \ No newline at end of file diff --git a/doc/architecture/logical_model.adoc b/doc/architecture/logical_model.adoc index ee5111cb5..3fec5de78 100644 --- a/doc/architecture/logical_model.adoc +++ b/doc/architecture/logical_model.adoc @@ -1,6 +1,6 @@ = Logical model -Logical models consume sensor-data messages and produce sensor-data messages. +Logical models consume `SensorData` messages and produce `SensorData` messages. An example of a logical model is a sensor-fusion model, which combines the output of multiple sensor models to produce data with less uncertainty. Another use case is the fault-injection model which, contrary to a sensor-fusion model, may be used to increase uncertainties. \ No newline at end of file diff --git a/doc/architecture/sensor_data.adoc b/doc/architecture/sensor_data.adoc index 17722ac78..6096fbb76 100644 --- a/doc/architecture/sensor_data.adoc +++ b/doc/architecture/sensor_data.adoc @@ -1,7 +1,7 @@ = Sensor data -Sensor-data messages imitate the output of real sensors. -They can be generated from ground-truth messages, sensor-view messages, feature-data messages, or sensor-data messages. +`SensorData` messages imitate the output of real sensors. +They can be generated from `GroundTruth` messages, `SensorView` messages, `FeatureData` messages, or `SensorData` messages. With the exception of feature data, all information regarding the environment is given with respect to the virtual sensor coordinate system. Feature data is given with respect to the physical sensor coordinate system. Sensor data can be used as input for an automated driving function, a sensor model simulating limited perception, or a sensor fusion model. diff --git a/doc/architecture/sensor_model.adoc b/doc/architecture/sensor_model.adoc index 9bf981079..423ea0668 100644 --- a/doc/architecture/sensor_model.adoc +++ b/doc/architecture/sensor_model.adoc @@ -1,5 +1,4 @@ = Sensor model -Sensor models consume sensor-view messages and produce sensor-data messages. - +Sensor models consume `SensorView` messages and produce `SensorData` messages. Sensor-model output does not represent raw data but detected features or classified objects. \ No newline at end of file diff --git a/doc/architecture/sensor_view.adoc b/doc/architecture/sensor_view.adoc index a143ed182..e89a62812 100644 --- a/doc/architecture/sensor_view.adoc +++ b/doc/architecture/sensor_view.adoc @@ -1,7 +1,7 @@ = Sensor view The sensor view provides the input to OSI sensor models. -Sensor-view messages are derived from ground-truth messages. +`SensorView` messages are derived from 'GroundTruth' messages. All information regarding the environment is given with respect to the virtual sensor coordinate system, with two exceptions: * Physical technology-specific data, given with respect to the physical sensor coordinate system specified in the corresponding physical sensor's mounting position. diff --git a/doc/architecture/sensor_view_configuration.adoc b/doc/architecture/sensor_view_configuration.adoc index ed8165a5f..9bba9d973 100644 --- a/doc/architecture/sensor_view_configuration.adoc +++ b/doc/architecture/sensor_view_configuration.adoc @@ -1,27 +1,27 @@ -= Sensor view configuration += Sensor-view configuration The sensor view is flexibly defined to provide different kinds of sensor models with an appropriate input. -The sensor view configuration defines the configuration of a particular sensor view. +The sensor-view configuration defines the configuration of a particular sensor view. -The sensor-view-configuration message is used in the initialization phase of a simulation to negotiate the sensor view configuration for a particular sensor view input. -It is also included as a sub-message in sensor view messages to indicate that the sensor view configuration is valid for a particular sensor view message. +The `SensorViewConfiguration` message is used in the initialization phase of a simulation to negotiate the sensor-view configuration for a particular `SensorView` input. +It is also included as a sub-message in `SensorView` messages to indicate that the sensor-view configuration is valid for a particular `SensorView` message. -Sensor-view-configuration data has two main applications: +`SensorViewConfiguration` data has two main applications: -- Enable the environment simulation to provide the necessary input to a sensor model. -- Enable a sensor model to check whether the input matches its requirements. +* Enable the environment simulation to provide the necessary input to a sensor model. +* Enable a sensor model to check whether the input matches its requirements. If the input does not match the requirements, the sensor model may terminate the simulation. -NOTE: Sensor-view-configuration data is intended for the automatic configuration of the sensor view interface between an environment simulation and sensor model. +NOTE: `SensorViewConfiguration` data is intended for the automatic configuration of the `SensorView` interface between an environment simulation and sensor model. The data is not intended to be a mechanism for parametrizing a generic sensor model. -During the initialization phase, there are two sources for sensor-view-configuration data: +During the initialization phase, there are two sources for `SensorViewConfiguration` data: -1. Sensor-view configuration data may be provided by the sensor model to the environment simulation. +. `SensorViewConfiguration` data may be provided by the sensor model to the environment simulation. In this case, the data describes the input configuration that is requested by the sensor model. If the sensor model does not provide such data, then the environment simulation will fall back to manual configuration of the sensor view. - -2. Sensor-view configuration data may be provided by the environment simulation. ++ +. `SensorViewConfiguration` data may be provided by the environment simulation. In response to the request by the sensor model, or based on manual configuration, the environment simulation configures the input and provides a new message that describes the actual configuration. The configuration requested by the sensor model may differ from the configuration provided by the environment simulation. @@ -31,4 +31,4 @@ In response to this difference, the sensor model can either accept this differen The packaging layer defines the specifics of this auto-negotiation mechanism. -After the initialization phase, the environment simulation provides the actual sensor view configuration as part of each sensor view message. \ No newline at end of file +After the initialization phase, the environment simulation provides the actual sensor-view configuration as part of each `SensorView` message. \ No newline at end of file diff --git a/doc/architecture/trace_file_naming.adoc b/doc/architecture/trace_file_naming.adoc index 06164f49a..6899b8ce9 100644 --- a/doc/architecture/trace_file_naming.adoc +++ b/doc/architecture/trace_file_naming.adoc @@ -11,19 +11,19 @@ The names of OSI trace files should have the following format: **Types** `sd`:: -Trace file contains sensor-data messages. +Trace file contains `SensorData` messages. `sv`:: -Trace file contains sensor-view messages. +Trace file contains `SensorView` messages. `gt`:: -Trace file contains ground-truth messages. +Trace file contains `GroundTruth` messages. `tu`:: -Trace file contains traffic-update messages. +Trace file contains `TrafficUpdate` messages. `tc`:: -Trace file contains traffic-command messages. +Trace file contains `TrafficCommand` messages. **Example** diff --git a/doc/architecture/traffic_command.adoc b/doc/architecture/traffic_command.adoc index 7f911cb1a..b8fd41657 100644 --- a/doc/architecture/traffic_command.adoc +++ b/doc/architecture/traffic_command.adoc @@ -1,3 +1,3 @@ = Traffic command -Traffic-command messages contain control commands from the scenario engine to traffic participant models. \ No newline at end of file +`TrafficCommand` messages contain control commands from the scenario engine to traffic participant models. \ No newline at end of file diff --git a/doc/architecture/traffic_update.adoc b/doc/architecture/traffic_update.adoc index 528056991..e788df8be 100644 --- a/doc/architecture/traffic_update.adoc +++ b/doc/architecture/traffic_update.adoc @@ -1,4 +1,4 @@ = Traffic update -Traffic-update messages are provided by traffic participants. +`TrafficUpdate` messages are provided by traffic participants. They provide updates on the position, state, and future trajectory of a traffic participant back to the simulation environment. \ No newline at end of file From d6f93e5908244d21aacaebde19a71681f74aaca4 Mon Sep 17 00:00:00 2001 From: pasched Date: Wed, 27 Oct 2021 09:04:26 +0200 Subject: [PATCH 04/12] docs: revise message formatting (continued) Signed-off-by: pasched --- doc/architecture/environmental_effect_model.adoc | 2 +- doc/architecture/ground_truth.adoc | 2 +- doc/architecture/sensor_view.adoc | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/architecture/environmental_effect_model.adoc b/doc/architecture/environmental_effect_model.adoc index 7ef1e7dbb..89bc02b7e 100644 --- a/doc/architecture/environmental_effect_model.adoc +++ b/doc/architecture/environmental_effect_model.adoc @@ -6,4 +6,4 @@ Environmental effect models may, for example, alter `SensorView` messages to inc * Shadows and occlusions * Weather effects * Physics of a sensor -* Pre-processing of raw sensor data +* Pre-processing of raw sensor data \ No newline at end of file diff --git a/doc/architecture/ground_truth.adoc b/doc/architecture/ground_truth.adoc index 6cbeda809..2a03bc137 100644 --- a/doc/architecture/ground_truth.adoc +++ b/doc/architecture/ground_truth.adoc @@ -2,4 +2,4 @@ `GroundTruth` messages describe the simulated environment containing all simulated objects in the global coordinate system at consecutive time instances. They are based on data available to the simulation environment. -`GroundTruth messages are typically contained in `Sensorview` messages. \ No newline at end of file +`GroundTruth` messages are typically contained in `Sensorview` messages. \ No newline at end of file diff --git a/doc/architecture/sensor_view.adoc b/doc/architecture/sensor_view.adoc index e89a62812..394d26ab4 100644 --- a/doc/architecture/sensor_view.adoc +++ b/doc/architecture/sensor_view.adoc @@ -1,7 +1,7 @@ = Sensor view The sensor view provides the input to OSI sensor models. -`SensorView` messages are derived from 'GroundTruth' messages. +`SensorView` messages are derived from `GroundTruth` messages. All information regarding the environment is given with respect to the virtual sensor coordinate system, with two exceptions: * Physical technology-specific data, given with respect to the physical sensor coordinate system specified in the corresponding physical sensor's mounting position. From ccb1ccdc8663d9c7d279826a67772ef4b592e006 Mon Sep 17 00:00:00 2001 From: pasched Date: Wed, 27 Oct 2021 09:27:14 +0200 Subject: [PATCH 05/12] docs: exclude versioning.adoc in map, moved to osi-documentation Signed-off-by: pasched --- doc/open-simulation-interface_user_guide.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/open-simulation-interface_user_guide.adoc b/doc/open-simulation-interface_user_guide.adoc index 80511fdf3..3bf59c66f 100644 --- a/doc/open-simulation-interface_user_guide.adoc +++ b/doc/open-simulation-interface_user_guide.adoc @@ -120,7 +120,7 @@ include::./misc/osi_reference.adoc[leveloffset=+1] == Releases -include::./releases/versioning.adoc[leveloffset=+2] +//include::./releases/versioning.adoc[leveloffset=+2] include::./releases/releases.adoc[leveloffset=+2] From 5f3d65c7fdb38491f5774b60f0d0506c6106cb44 Mon Sep 17 00:00:00 2001 From: pasched Date: Wed, 27 Oct 2021 09:49:35 +0200 Subject: [PATCH 06/12] docs: excluded release notes Signed-off-by: pasched --- doc/open-simulation-interface_user_guide.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/open-simulation-interface_user_guide.adoc b/doc/open-simulation-interface_user_guide.adoc index 3bf59c66f..4a989603f 100644 --- a/doc/open-simulation-interface_user_guide.adoc +++ b/doc/open-simulation-interface_user_guide.adoc @@ -118,9 +118,10 @@ include::./setup/installing_windows_python.adoc[leveloffset=+2] include::./misc/osi_reference.adoc[leveloffset=+1] +//// == Releases -//include::./releases/versioning.adoc[leveloffset=+2] +include::./releases/versioning.adoc[leveloffset=+2] include::./releases/releases.adoc[leveloffset=+2] @@ -139,3 +140,4 @@ include::./releases/v03.02.adoc[leveloffset=+3] include::./releases/v03.03.adoc[leveloffset=+3] //include::./releases/compatibility.adoc[leveloffset=+2] +//// \ No newline at end of file From 90e9776a720e2d9812f3ea333a41985c1e93ab0f Mon Sep 17 00:00:00 2001 From: pasched Date: Wed, 27 Oct 2021 16:01:42 +0200 Subject: [PATCH 07/12] moved release notes to repo osi-documentation, appendix Signed-off-by: pasched --- doc/open-simulation-interface_user_guide.adoc | 26 +-------- doc/releases/compatibility.adoc | 11 ---- doc/releases/releases.adoc | 1 - doc/releases/v02.00.adoc | 32 ----------- doc/releases/v02.01.adoc | 12 ---- doc/releases/v02.02.adoc | 26 --------- doc/releases/v03.00.adoc | 57 ------------------- doc/releases/v03.01.adoc | 37 ------------ doc/releases/v03.02.adoc | 38 ------------- doc/releases/v03.03.adoc | 39 ------------- doc/releases/v03.03.rst | 42 -------------- 11 files changed, 1 insertion(+), 320 deletions(-) delete mode 100644 doc/releases/compatibility.adoc delete mode 100644 doc/releases/releases.adoc delete mode 100644 doc/releases/v02.00.adoc delete mode 100644 doc/releases/v02.01.adoc delete mode 100644 doc/releases/v02.02.adoc delete mode 100644 doc/releases/v03.00.adoc delete mode 100644 doc/releases/v03.01.adoc delete mode 100644 doc/releases/v03.02.adoc delete mode 100644 doc/releases/v03.03.adoc delete mode 100644 doc/releases/v03.03.rst diff --git a/doc/open-simulation-interface_user_guide.adoc b/doc/open-simulation-interface_user_guide.adoc index 4a989603f..4bab2c985 100644 --- a/doc/open-simulation-interface_user_guide.adoc +++ b/doc/open-simulation-interface_user_guide.adoc @@ -116,28 +116,4 @@ include::./setup/installing_windows_python.adoc[leveloffset=+2] //TODO: Define topics and issues regarding performance. -include::./misc/osi_reference.adoc[leveloffset=+1] - -//// -== Releases - -include::./releases/versioning.adoc[leveloffset=+2] - -include::./releases/releases.adoc[leveloffset=+2] - -include::./releases/v02.00.adoc[leveloffset=+3] - -include::./releases/v02.01.adoc[leveloffset=+3] - -include::./releases/v02.02.adoc[leveloffset=+3] - -include::./releases/v03.00.adoc[leveloffset=+3] - -include::./releases/v03.01.adoc[leveloffset=+3] - -include::./releases/v03.02.adoc[leveloffset=+3] - -include::./releases/v03.03.adoc[leveloffset=+3] - -//include::./releases/compatibility.adoc[leveloffset=+2] -//// \ No newline at end of file +include::./misc/osi_reference.adoc[leveloffset=+1] \ No newline at end of file diff --git a/doc/releases/compatibility.adoc b/doc/releases/compatibility.adoc deleted file mode 100644 index c81058eb7..000000000 --- a/doc/releases/compatibility.adoc +++ /dev/null @@ -1,11 +0,0 @@ -= Compatibility - -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. -Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file diff --git a/doc/releases/releases.adoc b/doc/releases/releases.adoc deleted file mode 100644 index 88d8f4619..000000000 --- a/doc/releases/releases.adoc +++ /dev/null @@ -1 +0,0 @@ -= Releases diff --git a/doc/releases/v02.00.adoc b/doc/releases/v02.00.adoc deleted file mode 100644 index 38f903060..000000000 --- a/doc/releases/v02.00.adoc +++ /dev/null @@ -1,32 +0,0 @@ -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.0.0[v2.0.0 - OSI Initial Commit] - - -This is the initial version of the Open Simulation Interface (OSI). - -== Overview - -OSI is a generic interface for the environmental perception of automated driving functions in virtual scenarios. -It is primarily conceived to enable easy and straightforward compatibility between automated driving functions and the variety of driving simulation frameworks available. -The data description has been derived from the perspective of sensor modeling for automated test and validation of highly automated driving functions. - -== Implementation - -OSI primarily contains an object based environment description using the message format of the protocol buffers library developed and maintained by Google. - -== Detailed description - - -Top level interfaces:: -OSI consists of two individual top level interfaces for object data: The ``OSI::GroundTruth`` and the ``OSI::SensorData`` interface. -+ -* The ``OSI::GroundTruth`` interface provides an exact view on the simulated objects in a global coordinate system. -This message is populated using the internally available data of the used (driving)-simulation framework and is afterwards published to external subscribers with an exporter plugin. -* The ``OSI::SensorData`` interface describes the objects in the reference frame of a sensor for environmental perception. -It is generated from a ``OSI::GroundTruth`` message and can either be used to directly connect to an automated driving function using ideal simulated data, or may serve as input for a sensor model simulating limited perception as a replication of real world sensor behavior. - -Low level interfaces:: -+ -Additionally to the two top level interfaces, OSI contains an ``OSI::LowLevelData`` message. -This message describes the output of a (physical) model of the measurement process before tracking and object hypothesis. -It does not deal with object data, but may comprise the geometrical influence of 3D simulations e.g. generating Lidar point clouds with a ray-tracer plugin. -In addition this message supports generic radar reflection lists and will be extended to supporting low level camera data in the future. diff --git a/doc/releases/v02.01.adoc b/doc/releases/v02.01.adoc deleted file mode 100644 index 005e4e1ac..000000000 --- a/doc/releases/v02.01.adoc +++ /dev/null @@ -1,12 +0,0 @@ -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.1.0[v2.1.0 - OSI "Agile Andretti"] - -== Purpose - -This is the initial BASE VERSION for Tool Development. - -https://github.com/OpenSimulationInterface/open-simulation-interface/milestone/1?closed=1[Content/Changes] - -== Remarks - -We will now release the versions using the name of a https://en.wikipedia.org/wiki/List_of_Formula_One_drivers[Formula 1 driver]! -Naming convention: "adjective + last name driver" -> Alliteration necessary! \ No newline at end of file diff --git a/doc/releases/v02.02.adoc b/doc/releases/v02.02.adoc deleted file mode 100644 index a0ef709e7..000000000 --- a/doc/releases/v02.02.adoc +++ /dev/null @@ -1,26 +0,0 @@ -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.0[v2.2.0 - OSI "Brave Brabham"] - -== Purpose - -This release focuses on optimizing the build process and documentation. - -== https://github.com/OpenSimulationInterface/open-simulation-interface/milestone/2?closed=1[Content/Changes] - -* Added a shared library target to the CMake build script. -* Generated a proper doxygen documentation. -* Placed the version number in one file (VERSION). -* Added unit testing mechanism including style guide checking. -* Redefined precipitation and added a fog definition to the environmental conditions message. -* Added layer id to low level point cloud data. -* Reworked large parts of the build instructions in the WIKI. - -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.1[v2.2.1 - OSI "Brave Brabham", Update 1] - -== Purpose - -This release focuses on optimizing the build process and ensures the proper installation of different versions of OSI on a single system. - -== https://github.com/OpenSimulationInterface/open-simulation-interface/compare/maintenance/v2.2.x[Content/Changes] - -* Allowing several OSI versions on the same computer. -* Improves CI builds to also test the installation cmake targets for proper completion. diff --git a/doc/releases/v03.00.adoc b/doc/releases/v03.00.adoc deleted file mode 100644 index f76ea7b80..000000000 --- a/doc/releases/v03.00.adoc +++ /dev/null @@ -1,57 +0,0 @@ -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.0[v3.0.0 - OSI "Cosmic Coulthard"] - -== Purpose - -This release is a complete rework including the feedback from many OSI users. -Thank you! -We are aligned with the ongoing discussions for the upcoming ISO 23150 cite:[iso23150] standard for hardware sensor outputs in order to bring simulation and the hardware in the car closer together. - -== https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?page=1&q=is%3Apr+is%3Aclosed+milestone%3Av3.0.0[Content/Changes] - -* Added major version to package label (osi3), allowing concurrent use of OSI 2.x and OSI 3.x in one process. -* Added new top-level messages (new concept SensorView (Configuration),etc.). -** GroundTruth. -** SensorView. -** SensorData / FeatureData. -** SensorViewConfiguration (used for auto-configuration of SensorView). -* Added technology-specific SensorView sub-messages to aid physical models. -* Introduced conceptual separation of “SensorModels” and “LogicModels”. -* Extended enumerations (e.g. traffic sign Type according to StVO, vehicle Type, etc.). -* Improved messages and definitions (additional RoadConditions, country code in GT, AmbientIllumination, etc.). -* Use ISO 8855 cite:[iso8855] coordinate systems (incompatible with earlier OSI versions). -* Redefined DetectedXXX messages. -* Introduced DetectedStationaryObjects. -* Merged MovingObjects and Vehicle messages. -* Redefined Lane messages (with separated lane boundary messages and intersections). -* Redefined TrafficLight messages. -* Redefined TrafficSigns (1 x MainSign + n x SupplementarySign inclusive BaseStationary). -* New FeatureData messages (rework of previous LowLevelData message) - aligned with an upcoming standard ISO 23150 cite:[iso23150]. -* FeatureData usable for fusion units. -* Extension and clarification of the existing doxygen documentation. -* Improved doxygen collaboration diagrams. -* Build process improvements, added install targets. -* Made proto definitions compatible with proto3 restrictions to allow concurrent use with proto3-only implementations in the future. -* Fixed version-checking of transmitted data. -* AND MUCH MORE ENJOY!!! - -https://github.com/OpenSimulationInterface/open-simulation-interface/files/2297162/osi_overview_v2.2_vs_v3.0.pdf>[See for more information the `changelog`] - -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.1[v3.0.1 - OSI "Cosmic Coulthard", Update 1] - -https://www.youtube.com/watch?v=yG0oBPtyNb0[Summertime :)] - -== Purpose - -This release is a patch reworking parts of the documentation in order to avoid ambiguities and improving the build/installation process of OSI. - -== https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?page=1&q=is%3Apr+is%3Aclosed+milestone%3Av3.0.1[Content/Changes] - -* Added script to automatically convert the messages from proto2 to proto3 with on the wire compatibility -* cmake enhancements to enable multi-version support of OSI 2 and OSI 3 -* Added Python 3 support -* Clarification of multiple comments -* Added explanatory images in the documentation -* centerline definition improved -* signal_strength definition in LidarSensorView corrected -* FeatureData::ambiguity_id definition clarified -* RadarSensorViewConfiguration::AntennaDiagram::response definition clarified diff --git a/doc/releases/v03.01.adoc b/doc/releases/v03.01.adoc deleted file mode 100644 index bc694ff99..000000000 --- a/doc/releases/v03.01.adoc +++ /dev/null @@ -1,37 +0,0 @@ -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.0[v3.1.0 - OSI "Dynamic Duncan"] - -https://www.youtube.com/watch?v=fu3uA8K6ApQ>[(O SI)lent night] - -== Purpose - -This time of the year Santa comes with presents and has also thought about the sensor modelers of this planet. -We introduce the current state of the ISO 23150 cite:[iso23150]] discussions including Ultrasonic and Camera Detections. -The traffic signs have been reworked and the documentation has been extended for a perfect user experience. -Trust me - it's amazing! - -== https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.0>[Content/Changes] - -* Complete rework of traffic signs including images in documentation. -* Added Camera Detections in osi_featuredata.proto. -* Added Ultrasonic Detections in osi_featuredata.proto. -* Introduced light states for emergency and service vehicles. -* Added orientation_acceleration and updated formulas. -* Extended documentation with svg images. -* Added model_reference for static and moving objects. -* Added map_reference in ground truth. -* Added proj4 string for coordinate transformations. -* Introduced raster_lidar_proposal from innoviz. -* Improved documentation with HTML tables and images for all traffic signs. - -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.1[v3.1.1 - OSI "Dynamic Duncan", Update 1] - -== https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.1[Content/Changes] - -* **Bug Fix**: Changed open_simulation_interface target back from being a static library to a shared library, as before (this reverts an inadvertent change in v3.1.0 from previous releases). -v3.1.0 breaks all users of the shared library (i.e. everyone building on Linux/Unix systems, and even some using the DLL on Windows). - -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.2[v3.1.2 - OSI "Dynamic Duncan", Update 2] - -== https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.2[Content/Changes] - -* **Bugfix**: The version number is now correct in the VERSION file. diff --git a/doc/releases/v03.02.adoc b/doc/releases/v03.02.adoc deleted file mode 100644 index 28fa51e97..000000000 --- a/doc/releases/v03.02.adoc +++ /dev/null @@ -1,38 +0,0 @@ -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.2.0[v3.2.0 - OSI "Editorial Eaton"] - -https://www.youtube.com/watch?v=SJUhlRoBL8M[Think p(OSI)tive!] - -== Purpose - -The work on the OSI project was until now mainly organized by the BMW AG. -In order to enable as many interested parties as possible to contribute to the success of the Open Simulation Interface the project has been transferred to the https://www.asam.net/[ASAM e.V.] which has been made public in the https://www.asam.net/news-media/news/detail/news/bmw-transfers-open-simulation-interface-osi-to-asam/[ASAM press release]. -A new chapter in the development of OSI is now opened with the https://www.asam.net/conferences-events/detail/asam-osi-kick-off-workshop/[kickoff workshop] leading to hopefully many project proposals streamlining the efficient future development of the interface. -Due to this we decided to focus on the improvement of processes and documentation with this release. - -== https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.2.0[Content/Changes] - - -* Updated README according to K(eep) I(t) S(imply) S(tupid) principle -* Added Issue and Pullrequest templates -* Travis CI updated -** Update to bionic 18.04 -** Added tests for building protobuf 2.6 and 3.0 in parallel -** Bugfixed the display of doubled documentation -* Fixed several typos in the comments -* Added a centralized documentation in https://github.com/OpenSimulationInterface/osi-documentation[OSI-Documentation] -** Added contributors guidelines -** Added commenting style guidelines -** Added uniform citation style according to APA -** Updated installation guides for osi in Linux and Windows -** Added a reference in sphinx based on the generated doxygen documentation -* Added rules to the comments in order to enforce osi message validation with the https://github.com/OpenSimulationInterface/osi-validation[OSI-Validator] -* Added the rule definitions in the rules.yml -* Modularized testing of commenting style into python unit tests -* Defined a standardazied a file format for reading trace files (*.osi) -* Defined naming conventions of osi files -* Added a *.txt to *.osi file converter for backward compatibility -* Added a script to make traces readable for plausibility checks -* Corrected the citing style for OSI Bibtex -* Corrected unit specifications and references according to DIN (e.g. removed Unit: []) -* Added timestamp in osi_environment -* Added is_out_of_service bool to traffic light / traffic sign diff --git a/doc/releases/v03.03.adoc b/doc/releases/v03.03.adoc deleted file mode 100644 index 457c12e21..000000000 --- a/doc/releases/v03.03.adoc +++ /dev/null @@ -1,39 +0,0 @@ -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.3.0[v3.3.0 - OSI "Fabulous Fangio"] - -Stay p(OSI)tive! - -== Purpose - -As a part of the increasing adoption of OSI in the industry, and its movement to ASAM as its home, several new use cases and extensions for OSI have been identified. -This minor release highlights the work that has been done on several working packages including the introduction of brand new top level messages which extend OSI's scope beyond the specialized world of sensor modeling. - -== https://github.com/OpenSimulationInterface/open-simulation-interface/milestone/13?closed=1[Content/Changes] - -* Introduced the TrafficCommand top-level message which enables event-based control of traffic participant models, e.g. with regard to a scenario specification. -* Introduced the TrafficUpdate top-level message to send updated properties of traffic participant models. -* Add new LogicalDetectionData message to SensorData, which provides detection data with respect to the reference frame of the logical/virtual sensor. -* Added a new submessage to further specify wheel data. -* Added a new field to support future trajectories of moving objects. -* Added a new subtype message to osi_lane to better align with OpenDrive's lane type information and enable traffic participant models to identify lanes on which they are supposed to move. -* Extended traffic lights and signs messages to include the model_references attribute that can be used to point out to a 3D-model. -* Add global model reference to ground truth that can be used to specify the 3D model representing the environment. -* Extended the camera sensor view configuration to better support the configuration of the simulation environment. -* Added a new field to describe the position of the steering wheel. -* Added a message MovingObjectClassification for classify-able attributes that are shared between different moving object types. - Introduced the assigned lane id and the assigned lane percentage of a moving object there. - -* Updated to checklist for pull requests to provide clearer orientation for all users. -* Updated the documentation of centerline and lane boundaries (ordering of the points, describing those lines). -* Updated the documentation of 3D bounding boxes. -* Update the documentation of ground clearance. - -* Make handling of enums in rules check more robust, especially ones. -* Set the default compiler to C++ 11 to support protobuf>3.6. - -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.3.1[v3.3.1 - OSI "Fabulous Fangio", Update 1] - -== https://github.com/OpenSimulationInterface/open-simulation-interface/milestone/18?closed=1[Content/Changes] - -* **Bug Fix**: Fixed outdated version information in VERSION file in 3.3.0. -This led to wrong versioning in proto definitions and Doxygen documentation. -* **Bug Fix**: Removed outdated picture in README.md. diff --git a/doc/releases/v03.03.rst b/doc/releases/v03.03.rst deleted file mode 100644 index 77c96f95f..000000000 --- a/doc/releases/v03.03.rst +++ /dev/null @@ -1,42 +0,0 @@ -`v3.3.0 - OSI "Fabulous Fangio" `_ -============================== - -Stay p(OSI)tive! - -Purpose: ---------- -As a part of the increasing adoption of OSI in the industry, and its movement to ASAM as its home, -several new use cases and extensions for OSI have been identified. -This minor release highlights the work that has been done on several working packages including -the introduction of brand new top level messages which extend OSI's scope beyond the specialized world of sensor modeling. - -`Content/Changes `_: ---------------------------------------------------------------------------------------------------------------------------------------------- - -- Introduced the TrafficCommand top-level message which enables event-based control of traffic participant models, e.g. with regard to a scenario specification. -- Introduced the TrafficUpdate top-level message to send updated properties of traffic participant models. -- Add new LogicalDetectionData message to SensorData, which provides detection data with respect to the reference frame of the logical/virtual sensor. -- Added a new submessage to further specify wheel data. -- Added a new field to support future trajectories of moving objects. -- Added a new subtype message to osi_lane to better align with OpenDrive's lane type information and enable traffic participant models to identify lanes on which they are supposed to move. -- Extended traffic lights and signs messages to include the model_references attribute that can be used to point out to a 3D-model. -- Add global model reference to ground truth that can be used to specify the 3D model representing the environment. -- Extended the camera sensor view configuration to better support the configuration of the simulation environment. -- Added a new field to describe the position of the steering wheel. -- Added a message MovingObjectClassification for classify-able attributes that are shared between different moving object types. Introduced the assigned lane id and the assigned lane percentage of a moving object there. - -- Updated to checklist for pull requests to provide clearer orientation for all users. -- Updated the documentation of centerline and lane boundaries (ordering of the points, describing those lines). -- Updated the documentation of 3D bounding boxes. -- Update the documentation of ground clearance. - -- Make handling of enums in rules check more robust, especially ones. -- Set the default compiler to C++ 11 to support protobuf>3.6. - -`v3.3.1 - OSI "Fabulous Fangio", Update 1 `_ -========================================== - -`Content/Changes `_: ---------------------------------------------------------------------------------------------------------------------------------------------- -- **Bug Fix**: Fixed outdated version information in VERSION file in 3.3.0. This lead to wrong versioning in proto definitions and Doxygen documentation. -- **Bug Fix**: Removed outdated picture in README.md. From 07cb53c449dfef421a9bf59e6f08cdc18e465319 Mon Sep 17 00:00:00 2001 From: pasched Date: Thu, 28 Oct 2021 12:42:02 +0200 Subject: [PATCH 08/12] docs: removed chapter with link to reference doc, to be inserted in deliverables Signed-off-by: pasched --- doc/misc/osi_reference.adoc | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 doc/misc/osi_reference.adoc diff --git a/doc/misc/osi_reference.adoc b/doc/misc/osi_reference.adoc deleted file mode 100644 index f9203d706..000000000 --- a/doc/misc/osi_reference.adoc +++ /dev/null @@ -1,5 +0,0 @@ -= Reference documentation - -The reference documentation for OSI is generated with Doxygen. -It is available at: -https://opensimulationinterface.github.io/open-simulation-interface/ From 702d7f80d896baa67af083334f9c943d7909ddeb Mon Sep 17 00:00:00 2001 From: Stefan Cyliax Date: Thu, 28 Oct 2021 13:01:55 +0200 Subject: [PATCH 09/12] restructured modeling a traffic participant Signed-off-by: Stefan Cyliax --- doc/open-simulation-interface_user_guide.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/open-simulation-interface_user_guide.adoc b/doc/open-simulation-interface_user_guide.adoc index 4bab2c985..78fcdffe6 100644 --- a/doc/open-simulation-interface_user_guide.adoc +++ b/doc/open-simulation-interface_user_guide.adoc @@ -50,7 +50,7 @@ include::./architecture/logical_model.adoc[leveloffset=+3] include::./architecture/traffic_participant.adoc[leveloffset=+3] -include::./usecases/modeling_traffic_participant.adoc[leveloffset=+3] +include::./usecases/modeling_traffic_participant.adoc[leveloffset=+4] //include::./architecture/vehicle_dynamics.adoc[leveloffset=+3] From 7518c5d069effbd46d94a47332110be91f170cf0 Mon Sep 17 00:00:00 2001 From: Stefan Cyliax Date: Thu, 28 Oct 2021 21:25:44 +0200 Subject: [PATCH 10/12] doc: removed include of osi_reference.adoc Signed-off-by: Stefan Cyliax --- doc/open-simulation-interface_user_guide.adoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/open-simulation-interface_user_guide.adoc b/doc/open-simulation-interface_user_guide.adoc index 78fcdffe6..6c8e619fb 100644 --- a/doc/open-simulation-interface_user_guide.adoc +++ b/doc/open-simulation-interface_user_guide.adoc @@ -115,5 +115,3 @@ include::./setup/installing_windows_python.adoc[leveloffset=+2] //== Improving performance //TODO: Define topics and issues regarding performance. - -include::./misc/osi_reference.adoc[leveloffset=+1] \ No newline at end of file From d571b9ea8f0157ef6c82b25eced8cbca714edb0c Mon Sep 17 00:00:00 2001 From: Stefan Cyliax Date: Thu, 28 Oct 2021 22:11:49 +0200 Subject: [PATCH 11/12] doc: small fix to rendering of install steps Signed-off-by: Stefan Cyliax --- doc/setup/installing_linux_python.adoc | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/doc/setup/installing_linux_python.adoc b/doc/setup/installing_linux_python.adoc index d83150a68..84f507461 100644 --- a/doc/setup/installing_linux_python.adoc +++ b/doc/setup/installing_linux_python.adoc @@ -35,5 +35,14 @@ source venv/bin/activate ---- + . Install Open Simulation Interface. -Local installation:: `pip3 install .` -Global installation:: `sudo pip3 install .` +.. Local installation ++ +---- +pip3 install . +---- ++ +.. Global installation ++ +---- +sudo pip3 install . +---- From 6b92e9cec14507078c69dbfe80d87abe299735d8 Mon Sep 17 00:00:00 2001 From: Stefan Cyliax Date: Thu, 28 Oct 2021 22:19:09 +0200 Subject: [PATCH 12/12] doc: fix of naming of standard Signed-off-by: Stefan Cyliax --- doc/misc/osi_vision.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/misc/osi_vision.adoc b/doc/misc/osi_vision.adoc index 9e5cb6171..f0bc4ec3a 100644 --- a/doc/misc/osi_vision.adoc +++ b/doc/misc/osi_vision.adoc @@ -1,5 +1,5 @@ = Idea behind Open Simulation Interface -The Open Simulation Interface (OSI) is a specification for interfaces between models and components of a distributed simulation. +{THIS_STANDARD} Open Simulation Interface is a specification for interfaces between models and components of a distributed simulation. OSI is strongly focused on the environmental perception of automated driving functions. However, OSI also specifies interfaces for modeling traffic participants. \ No newline at end of file