Skip to content

Commit 80470f4

Browse files
committed
docs: reverted changes in release notes
Signed-off-by: Patrick Schedlbauer <patrick.schedlbauer@parson-europe.com>
1 parent fe4b4a6 commit 80470f4

File tree

8 files changed

+94
-94
lines changed

8 files changed

+94
-94
lines changed

doc/releases/v02.00.adoc

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,27 @@ This is the initial version of the Open Simulation Interface (OSI).
66
== Overview
77

88
OSI is a generic interface for the environmental perception of automated driving functions in virtual scenarios.
9-
It has been primarily conceived to enable easy and straightforward compatibility between automated driving functions and the variety of driving simulation frameworks that are available.
10-
The data description has been derived from the perspective of sensor modeling for automated testing and validation of highly automated driving functions.
9+
It is primarily conceived to enable easy and straightforward compatibility between automated driving functions and the variety of driving simulation frameworks available.
10+
The data description has been derived from the perspective of sensor modeling for automated test and validation of highly automated driving functions.
1111

1212
== Implementation
1313

14-
OSI primarily contains an object based environment description using the message format of the protocol buffers library, which Google has developed and maintains.
14+
OSI primarily contains an object based environment description using the message format of the protocol buffers library developed and maintained by Google.
1515

1616
== Detailed description
1717

18-
Top-level interfaces::
18+
19+
Top level interfaces::
1920
OSI consists of two individual top level interfaces for object data: The ``OSI::GroundTruth`` and the ``OSI::SensorData`` interface.
2021
+
21-
* The ``OSI::GroundTruth`` interface provides an exact view of the simulated objects in a global coordinate system.
22-
This message is populated using the internally available data of the used (driving) simulation framework and then published to external subscribers with an exporter plugin.
22+
* The ``OSI::GroundTruth`` interface provides an exact view on the simulated objects in a global coordinate system.
23+
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.
2324
* The ``OSI::SensorData`` interface describes the objects in the reference frame of a sensor for environmental perception.
24-
It is generated from an ``OSI::GroundTruth`` message and can either be used to directly connect to an automated driving function using ideal simulated data, or it may serve as an input for a sensor model simulating limited perception as a replication of real world sensor behavior.
25+
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.
2526

26-
Low-level interfaces::
27+
Low level interfaces::
2728
+
28-
In addition to the two top-level interfaces, OSI contains an ``OSI::LowLevelData`` message.
29+
Additionally to the two top level interfaces, OSI contains an ``OSI::LowLevelData`` message.
2930
This message describes the output of a (physical) model of the measurement process before tracking and object hypothesis.
30-
It does not deal with object data, but may comprise the geometrical influence of 3D simulations, for example, generating Lidar point clouds with a ray-tracer plugin.
31-
This message also supports generic radar reflection lists and will be extended to supporting low-level camera data in the future.
31+
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.
32+
In addition this message supports generic radar reflection lists and will be extended to supporting low level camera data in the future.

doc/releases/v02.01.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
== Purpose
44

5-
This is the initial BASE VERSION for tool development.
5+
This is the initial BASE VERSION for Tool Development.
66

77
https://github.com/OpenSimulationInterface/open-simulation-interface/milestone/1?closed=1[Content/Changes]
88

99
== Remarks
1010

11-
We will be releasing the versions using the name of a https://en.wikipedia.org/wiki/List_of_Formula_One_drivers[Formula 1 driver]!
11+
We will now release the versions using the name of a https://en.wikipedia.org/wiki/List_of_Formula_One_drivers[Formula 1 driver]!
1212
Naming convention: "adjective + last name driver" -> Alliteration necessary!

doc/releases/v02.02.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ This release focuses on optimizing the build process and documentation.
77
== https://github.com/OpenSimulationInterface/open-simulation-interface/milestone/2?closed=1[Content/Changes]
88

99
* Added a shared library target to the CMake build script.
10-
* Generated proper doxygen documentation.
10+
* Generated a proper doxygen documentation.
1111
* Placed the version number in one file (VERSION).
1212
* Added unit testing mechanism including style guide checking.
1313
* Redefined precipitation and added a fog definition to the environmental conditions message.
14-
* Added a layer id to low-level point cloud data.
14+
* Added layer id to low level point cloud data.
1515
* Reworked large parts of the build instructions in the WIKI.
1616

1717
= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.1[v2.2.1 - OSI "Brave Brabham", Update 1]
@@ -22,5 +22,5 @@ This release focuses on optimizing the build process and ensures the proper inst
2222

2323
== https://github.com/OpenSimulationInterface/open-simulation-interface/compare/maintenance/v2.2.x[Content/Changes]
2424

25-
* Allowed several OSI versions on the same computer.
26-
* Improved CI builds to also test the installation cmake targets for proper completion.
25+
* Allowing several OSI versions on the same computer.
26+
* Improves CI builds to also test the installation cmake targets for proper completion.

doc/releases/v03.00.adoc

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
== Purpose
44

5-
This release is a complete rework and includes feedback from many OSI users.
5+
This release is a complete rework including the feedback from many OSI users.
66
Thank you!
77
We are aligned with the ongoing discussions for the upcoming ISO 23150 standard for hardware sensor outputs in order to bring simulation and the hardware in the car closer together.
88

@@ -12,46 +12,46 @@ We are aligned with the ongoing discussions for the upcoming ISO 23150 standard
1212
* Added new top-level messages (new concept SensorView (Configuration),etc.).
1313
** GroundTruth.
1414
** SensorView.
15-
** SensorData/FeatureData.
15+
** SensorData / FeatureData.
1616
** SensorViewConfiguration (used for auto-configuration of SensorView).
1717
* Added technology-specific SensorView sub-messages to aid physical models.
1818
* Introduced conceptual separation of “SensorModels” and “LogicModels”.
19-
* Extended enumerations (for example, traffic sign type according to StVO and vehicle type).
19+
* Extended enumerations (e.g. traffic sign Type according to StVO, vehicle Type, etc.).
2020
* Improved messages and definitions (additional RoadConditions, country code in GT, AmbientIllumination, etc.).
21-
* Introduced ISO 8855 coordinate systems (incompatible with earlier OSI versions).
21+
* Use ISO 8855 coordinate systems (incompatible with earlier OSI versions).
2222
* Redefined DetectedXXX messages.
2323
* Introduced DetectedStationaryObjects.
2424
* Merged MovingObjects and Vehicle messages.
2525
* Redefined Lane messages (with separated lane boundary messages and intersections).
2626
* Redefined TrafficLight messages.
27-
* Redefined TrafficSigns (1 x MainSign + n x SupplementarySign including BaseStationary).
27+
* Redefined TrafficSigns (1 x MainSign + n x SupplementarySign inclusive BaseStationary).
2828
* New FeatureData messages (rework of previous LowLevelData message) - aligned with an upcoming standard ISO 23150.
29-
* Made FeatureData usable for fusion units.
30-
* Extended and clarified the existing doxygen documentation.
29+
* FeatureData usable for fusion units.
30+
* Extension and clarification of the existing doxygen documentation.
3131
* Improved doxygen collaboration diagrams.
32-
* Improved Build process and added install targets.
32+
* Build process improvements, added install targets.
3333
* Made proto definitions compatible with proto3 restrictions to allow concurrent use with proto3-only implementations in the future.
3434
* Fixed version-checking of transmitted data.
35-
* AND MUCH MORE, SO PLEASE ENJOY!!!
35+
* AND MUCH MORE ENJOY!!!
3636

37-
https://github.com/OpenSimulationInterface/open-simulation-interface/files/2297162/osi_overview_v2.2_vs_v3.0.pdf>[For more information, view the `changelog`]
37+
https://github.com/OpenSimulationInterface/open-simulation-interface/files/2297162/osi_overview_v2.2_vs_v3.0.pdf>[See for more information the `changelog`]
3838

3939
= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.1[v3.0.1 - OSI "Cosmic Coulthard", Update 1]
4040

41-
https://www.youtube.com/watch?v=yG0oBPtyNb0[Summer time :)]
41+
https://www.youtube.com/watch?v=yG0oBPtyNb0[Summertime :)]
4242

4343
== Purpose
4444

45-
This release is a patch reworking parts of the documentation in order to avoid ambiguities and improve the OSI build/installation process.
45+
This release is a patch reworking parts of the documentation in order to avoid ambiguities and improving the build/installation process of OSI.
4646

4747
== https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?page=1&q=is%3Apr+is%3Aclosed+milestone%3Av3.0.1[Content/Changes]
4848

49-
* Added script to automatically convert the messages from proto2 to proto3 with on the wire compatibility.
50-
* Made cmake enhancements to enable multi-version support for OSI 2 and OSI 3.
51-
* Added Python 3 support.
52-
* Clarified multiple comments.
53-
* Added explanatory images in the documentation.
54-
* Improved centerline definition.
55-
* Corrected signal_strength definition in LidarSensorView.
56-
* Clarified FeatureData::ambiguity_id definition.
57-
* Clarified RadarSensorViewConfiguration::AntennaDiagram::response definition.
49+
* Added script to automatically convert the messages from proto2 to proto3 with on the wire compatibility
50+
* cmake enhancements to enable multi-version support of OSI 2 and OSI 3
51+
* Added Python 3 support
52+
* Clarification of multiple comments
53+
* Added explanatory images in the documentation
54+
* centerline definition improved
55+
* signal_strength definition in LidarSensorView corrected
56+
* FeatureData::ambiguity_id definition clarified
57+
* RadarSensorViewConfiguration::AntennaDiagram::response definition clarified

doc/releases/v03.01.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ https://www.youtube.com/watch?v=fu3uA8K6ApQ>[(O SI)lent night]
44

55
== Purpose
66

7-
At this time of the year Santa goes on his rounds and has also given thought to this planet’s sensor modelers.”.
8-
We have taken note of the current status of the ISO 23150 discussions, including ultrasonic and camera detections.
7+
This time of the year Santa comes with presents and has also thought about the sensor modelers of this planet.
8+
We introduce the current state of the ISO 23150 discussions including Ultrasonic and Camera Detections.
99
The traffic signs have been reworked and the documentation has been extended for a perfect user experience.
1010
Trust me - it's amazing!
1111

1212
== https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.0>[Content/Changes]
1313

14-
* Completely reworked traffic signs including images in documentation.
15-
* Added camera detections in osi_featuredata.proto.
16-
* Added ultrasonic detections in osi_featuredata.proto.
14+
* Complete rework of traffic signs including images in documentation.
15+
* Added Camera Detections in osi_featuredata.proto.
16+
* Added Ultrasonic Detections in osi_featuredata.proto.
1717
* Introduced light states for emergency and service vehicles.
1818
* Added orientation_acceleration and updated formulas.
1919
* Extended documentation with svg images.
@@ -27,8 +27,8 @@ Trust me - it's amazing!
2727

2828
== https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.1[Content/Changes]
2929

30-
* **Bug Fix**: Changed open_simulation_interface target back from being a static library to its previous state as a shared library (this reverts an inadvertent change in v3.1.0 from previous releases).
31-
v3.1.0 breaks all users of the shared library (that is, everyone building on Linux/Unix systems, and even some using the DLL on Windows).
30+
* **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).
31+
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).
3232

3333
= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.2[v3.1.2 - OSI "Dynamic Duncan", Update 2]
3434

doc/releases/v03.02.adoc

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,35 @@ https://www.youtube.com/watch?v=SJUhlRoBL8M[Think p(OSI)tive!]
44

55
== Purpose
66

7-
It was previously the case that the company BMW AG organized most of the work on the OSI project.
8-
To make it possible for as many interested parties as possible to contribute to the success of the Open Simulation Interface, the project has been transferred to https://www.asam.net/[ASAM e.V.].
9-
This 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].
10-
A new chapter in the development of OSI has been opened with the https://www.asam.net/conferences-events/detail/asam-osi-kick-off-workshop/[kickoff workshop], which will hopefully generate lots of project proposals to streamline the efficient future development of the interface.
11-
Whith this release, we therefore decided to focus on improving processes and documentation.
7+
The work on the OSI project was until now mainly organized by the BMW AG.
8+
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].
9+
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.
10+
Due to this we decided to focus on the improvement of processes and documentation with this release.
1211

1312
== https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.2.0[Content/Changes]
1413

1514

16-
* Updated README according to K(eep) I(t) S(imply) S(tupid) principle.
17-
* Added Issue and Pullrequest templates.
18-
* Updated Travis CI.
19-
** Updated to bionic 18.04.
20-
** Added tests for building protobuf 2.6 and 3.0 in parallel.
21-
** Bugfixed the display of doubled documentation.
22-
* Fixed several typos in the comments.
23-
* Added a centralized documentation in https://github.com/OpenSimulationInterface/osi-documentation[OSI-Documentation].
24-
** Added contributors guidelines.
25-
** Added commenting style guidelines.
26-
** Added a uniform citation style based on APA.
27-
** Updated installation guides for osi in Linux and Windows.
28-
** Added a reference in sphinx based on generated doxygen documentation.
29-
* Added rules to the comments to enforce osi message validation with the https://github.com/OpenSimulationInterface/osi-validation[OSI-Validator].
30-
* Added the rule definitions in the rules.yml.
31-
* Modularized testing of commenting style into python unit tests.
32-
* Defined a standardized file format for reading trace files (*.osi).
33-
* Defined naming conventions for osi files.
34-
* Added a *.txt to *.osi file converter for backward compatibility.
35-
* Added a script to make traces readable for plausibility checks.
36-
* Corrected the citing style for OSI Bibtex.
37-
* Corrected unit specifications and references according to DIN (for example, removed Unit: []).
38-
* Added a timestamp in osi_environment.
39-
* Added is_out_of_service bool to traffic light / traffic sign.
15+
* Updated README according to K(eep) I(t) S(imply) S(tupid) principle
16+
* Added Issue and Pullrequest templates
17+
* Travis CI updated
18+
** Update to bionic 18.04
19+
** Added tests for building protobuf 2.6 and 3.0 in parallel
20+
** Bugfixed the display of doubled documentation
21+
* Fixed several typos in the comments
22+
* Added a centralized documentation in https://github.com/OpenSimulationInterface/osi-documentation[OSI-Documentation]
23+
** Added contributors guidelines
24+
** Added commenting style guidelines
25+
** Added uniform citation style according to APA
26+
** Updated installation guides for osi in Linux and Windows
27+
** Added a reference in sphinx based on the generated doxygen documentation
28+
* Added rules to the comments in order to enforce osi message validation with the https://github.com/OpenSimulationInterface/osi-validation[OSI-Validator]
29+
* Added the rule definitions in the rules.yml
30+
* Modularized testing of commenting style into python unit tests
31+
* Defined a standardazied a file format for reading trace files (*.osi)
32+
* Defined naming conventions of osi files
33+
* Added a *.txt to *.osi file converter for backward compatibility
34+
* Added a script to make traces readable for plausibility checks
35+
* Corrected the citing style for OSI Bibtex
36+
* Corrected unit specifications and references according to DIN (e.g. removed Unit: [])
37+
* Added timestamp in osi_environment
38+
* Added is_out_of_service bool to traffic light / traffic sign

0 commit comments

Comments
 (0)