Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change acronym meaning of OSMP #83

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Change acronym meaning of OSMP #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8aa630
change acronym meaning in multiple places
Apr 6, 2022
a947813
further changes on acronym meaning
Apr 6, 2022
706e13c
changed link + deleted TODO
Apr 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ A clear and concise description of what you want to happen.
A clear and concise description of any alternative solutions or features you have considered.

#### Describe the backwards compatibility
How does the feature impact the backwards compatibility of the current major version of OSI Sensor Model Packaging?
If the suggested feature would be implemented would there be an issue with the previous versions of OSI Sensor Model Packaging? What part of OSI Sensor Model Packaging would break or improve by this feature?
How does the feature impact the backwards compatibility of the current major version of OSI Simulation Model Packaging?
If the suggested feature would be implemented would there be an issue with the previous versions of OSI Simulation Model Packaging? What part of OSI Simulation Model Packaging would break or improve by this feature?

#### Additional context
Add any other context or screenshots about the feature request here.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Add @mentions of the person or team responsible for reviewing proposed changes.
#### Check the checklist

- [ ] I have performed a self-review of my own code.
- [ ] I have made corresponding changes to the [documentation](https://github.com/OpenSimulationInterface/osi-documentation) for osi-sensor-model-packaging.
- [ ] I have made corresponding changes to the [documentation](https://github.com/OpenSimulationInterface/osi-documentation) for osi-simulation-model-packaging.
- [ ] My changes generate no new warnings.
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] New and existing unit tests / Github Actions pass locally with my changes.
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# OSI Sensor Model Packaging
# OSI Simulation Model Packaging

[![ProtoBuf CI Builds](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/actions/workflows/protobuf.yml/badge.svg)](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/actions/workflows/protobuf.yml)
[![ProtoBuf CI Builds](https://github.com/OpenSimulationInterface/osi-simulation-model-packaging/actions/workflows/protobuf.yml/badge.svg)](https://github.com/OpenSimulationInterface/osi-simulation-model-packaging/actions/workflows/protobuf.yml)

OSI Sensor Model Packaging specifies ways in which models (like e.g. environmental effect models, sensor models and logical models) using the [Open Simulation Interface (OSI)][] are to be packaged for their use in simulation environments using FMI 2.0.
The specification can be found in the [doc/osi-sensor-model-packaging_spec.adoc](doc/osi-sensor-model-packaging_spec.adoc) document in this repository.
OSI Simulation Model Packaging specifies ways in which models (like e.g. environmental effect models, sensor models and logical models) using the [Open Simulation Interface (OSI)][] are to be packaged for their use in simulation environments using FMI 2.0.
The specification can be found in the [doc/osi-simulation-model-packaging_spec.adoc](doc/osi-simulation-model-packaging_spec.adoc) document in this repository.

For more detailed information see the [official documentation](https://opensimulationinterface.github.io/osi-documentation/#_osi_sensor_model_packaging).
For more detailed information see the [official documentation](https://opensimulationinterface.github.io/osi-documentation/#_osi_simulation_model_packaging).

[Open Simulation Interface (OSI)]: https://github.com/OpenSimulationInterface/open-simulation-interface

## Usage
The examples in the directory [`examples`](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/tree/master/examples) of this repository can be built using CMake. They require that the open-simulation-interface submodule of the repository is populated.
The examples in the directory [`examples`](https://github.com/OpenSimulationInterface/osi-simulation-model-packaging/tree/master/examples) of this repository can be built using CMake. They require that the open-simulation-interface submodule of the repository is populated.

The [`OSMPDummySource`](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/tree/master/examples/OSMPDummySource) example can be used as a simplistic source of SensorView (including GroundTruth) data, that can be connected to the input of an OSMPDummySensor model, for simple testing and demonstration purposes.
The [`OSMPDummySource`](https://github.com/OpenSimulationInterface/osi-simulation-model-packaging/tree/master/examples/OSMPDummySource) example can be used as a simplistic source of SensorView (including GroundTruth) data, that can be connected to the input of an OSMPDummySensor model, for simple testing and demonstration purposes.

The [`OSMPCNetworkProxy`](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/tree/master/examples/OSMPCNetworkProxy) example demonstrates a simple C network proxy that can send and receive OSI data via TCP sockets.
The [`OSMPCNetworkProxy`](https://github.com/OpenSimulationInterface/osi-simulation-model-packaging/tree/master/examples/OSMPCNetworkProxy) example demonstrates a simple C network proxy that can send and receive OSI data via TCP sockets.

The [`OSMPDummySensor`](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/tree/master/examples/OSMPDummySensor) example can be used as a simple dummy sensor model, demonstrating the use of OSI for sensor models consuming SensorView data and generating SensorData output.
The [`OSMPDummySensor`](https://github.com/OpenSimulationInterface/osi-simulation-model-packaging/tree/master/examples/OSMPDummySensor) example can be used as a simple dummy sensor model, demonstrating the use of OSI for sensor models consuming SensorView data and generating SensorData output.

## Installation
##### Dependencies
Expand All @@ -32,8 +32,8 @@ $ sudo apt-get install libprotobuf-dev protobuf-compiler

##### Build examples
```bash
$ git clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.git
$ cd osi-sensor-model-packaging
$ git clone https://github.com/OpenSimulationInterface/osi-simulation-model-packaging.git
$ cd osi-simulation-model-packaging
$ git submodule update --init
$ cd examples
$ mkdir -p build
Expand Down
16 changes: 8 additions & 8 deletions doc/misc/example.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,51 +8,51 @@ The example describes a sensor model FMU with one input, one output, and no addi
<?xml version="1.0" encoding="UTF-8"?>
<fmiModelDescription
fmiVersion="2.0"
modelName="OSI Sensor Model Packaging Demo FMU"
modelName="OSI Simulation Model Packaging Demo FMU"
guid="aabc2174e20f08597cfae6947c96bf86"
variableNamingConvention="structured">
<CoSimulation
modelIdentifier="OSMPDemoFMU"
canNotUseMemoryManagementFunctions="true"/>
<DefaultExperiment startTime="0.0" stepSize="0.020"/>
<VendorAnnotations>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp version="1.2.0" osi-version="3.4.0"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp version="1.2.0" osi-version="3.4.0"/></Tool>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pmai please have a look if the changes in the VendorAnnotations for the example fmus are fine for you (just a result of replace all...).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

None of this can be done in a minor release, since it completely changes the syntax of the standard (different namespace). If we are going to do this, the namespace should be changed to an ASAM-owned domain along the way.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But it is not wrong :)
@engelben would we have a suitable domain at ASAM reserved for this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would vote for a change, as well.

However, things brings me to the more general question of changing OSI to OpenInterface or similar

  1. to be consistent in ASAM with OpenScenario, OpenDrive, OpenODD, etc.
  2. to be clearly distinguished from the OSI model, which was the first acronym out there and is confusing conversations all the time..

</VendorAnnotations>
<ModelVariables>
<ScalarVariable name="OSMPSensorViewIn.base.lo" valueReference="0" causality="input" variability="discrete">
<Integer start="0"/>
<Annotations>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.4.0"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.4.0"/></Tool>
</Annotations>
</ScalarVariable>
<ScalarVariable name="OSMPSensorViewIn.base.hi" valueReference="1" causality="input" variability="discrete">
<Integer start="0"/>
<Annotations>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.4.0"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.4.0"/></Tool>
</Annotations>
</ScalarVariable>
<ScalarVariable name="OSMPSensorViewIn.size" valueReference="2" causality="input" variability="discrete">
<Integer start="0"/>
<Annotations>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="size" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.4.0"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="size" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.4.0"/></Tool>
</Annotations>
</ScalarVariable>
<ScalarVariable name="OSMPSensorDataOut.base.lo" valueReference="3" causality="output" variability="discrete" initial="exact">
<Integer start="0"/>
<Annotations>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.4.0"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.4.0"/></Tool>
</Annotations>
</ScalarVariable>
<ScalarVariable name="OSMPSensorDataOut.base.hi" valueReference="4" causality="output" variability="discrete" initial="exact">
<Integer start="0"/>
<Annotations>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.4.0"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.4.0"/></Tool>
</Annotations>
</ScalarVariable>
<ScalarVariable name="OSMPSensorDataOut.size" valueReference="5" causality="output" variability="discrete" initial="exact">
<Integer start="0"/>
<Annotations>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="size" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.4.0"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="size" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.4.0"/></Tool>
</Annotations>
</ScalarVariable>
</ModelVariables>
Expand Down
2 changes: 1 addition & 1 deletion doc/misc/introduction.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Introduction

_OSI Sensor Model Packaging_ (OSMP) is a package layer specification for the _Open Simulation Interface_ (OSI).
_OSI Simulation Model Packaging_ (OSMP) is a package layer specification for the _Open Simulation Interface_ (OSI).
It specifies how models that use OSI are packaged as _Functional Mock-up Units_ (FMUs) in accordance with the _Functional Mock-up Interface 2.0_ (FMI 2.0).

This is version 1.2.0 of this specification. The version number is to be
Expand Down
2 changes: 1 addition & 1 deletion doc/osi-sensor-model-packaging_spec.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ include::{asciidoc-resources}/preamble.adoc[]

endif::[]

= OSI Sensor Model Packaging
= OSI Simulation Model Packaging

include::./misc/introduction.adoc[leveloffset=+1]

Expand Down
4 changes: 2 additions & 2 deletions doc/setup/build_install_example.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ Demonstrates a simple C network proxy that can send and receive OSI data via TCP
. Clone the OSMP repository.
+
----
git clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.git
git clone https://github.com/OpenSimulationInterface/osi-simulation-model-packaging.git
----
+
. Switch to the OSMP repository.
+
----
cd osi-sensor-model-packaging
cd osi-simulation-model-packaging
----
+
. Update and initialize the OSI submodule.
Expand Down
2 changes: 1 addition & 1 deletion doc/spec/basic_conventions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The following annotation shall be placed into the `<VendorAnnotations>` element

[source,xml]
----
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp version="1.2.0" osi-version="x.y.z"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp version="1.2.0" osi-version="x.y.z"/></Tool>
----

The `@osi-version` attribute should contain the major, minor, and patch version number of the OSI specification that this model was compiled against.
Expand Down
2 changes: 1 addition & 1 deletion doc/spec/binary_variables.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The three actual variables shall contain an annotation of the following form in

[source,xml]
----
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="<prefix>" role="<role>" mime-type="<mime-type>"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp-binary-variable name="<prefix>" role="<role>" mime-type="<mime-type>"/></Tool>
----

`<prefix>` is the prefix as defined above, and `@role` is either `base.lo`, `base.hi`, or `size`, depending on the variable.
Expand Down
14 changes: 7 additions & 7 deletions examples/OSMPCNetworkProxy/modelDescription.in.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,43 +24,43 @@
</LogCategories>
<DefaultExperiment startTime="0.0" stepSize="0.020"/>
<VendorAnnotations>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp version="@OSMPVERSION@" osi-version="@OSIVERSION@"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp version="@OSMPVERSION@" osi-version="@OSIVERSION@"/></Tool>
</VendorAnnotations>
<ModelVariables>
<ScalarVariable name="OSMPSensorViewIn.base.lo" valueReference="0" causality="input" variability="discrete">
<Integer start="0"/>
<Annotations>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorView; version=@OSIVERSION@"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorView; version=@OSIVERSION@"/></Tool>
</Annotations>
</ScalarVariable>
<ScalarVariable name="OSMPSensorViewIn.base.hi" valueReference="1" causality="input" variability="discrete">
<Integer start="0"/>
<Annotations>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorView; version=@OSIVERSION@"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorView; version=@OSIVERSION@"/></Tool>
</Annotations>
</ScalarVariable>
<ScalarVariable name="OSMPSensorViewIn.size" valueReference="2" causality="input" variability="discrete">
<Integer start="0"/>
<Annotations>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="size" mime-type="application/x-open-simulation-interface; type=SensorView; version=@OSIVERSION@"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="size" mime-type="application/x-open-simulation-interface; type=SensorView; version=@OSIVERSION@"/></Tool>
</Annotations>
</ScalarVariable>
<ScalarVariable name="OSMPSensorDataOut.base.lo" valueReference="3" causality="output" variability="discrete" initial="exact">
<Integer start="0"/>
<Annotations>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorData; version=@OSIVERSION@"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorData; version=@OSIVERSION@"/></Tool>
</Annotations>
</ScalarVariable>
<ScalarVariable name="OSMPSensorDataOut.base.hi" valueReference="4" causality="output" variability="discrete" initial="exact">
<Integer start="0"/>
<Annotations>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorData; version=@OSIVERSION@"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorData; version=@OSIVERSION@"/></Tool>
</Annotations>
</ScalarVariable>
<ScalarVariable name="OSMPSensorDataOut.size" valueReference="5" causality="output" variability="discrete" initial="exact">
<Integer start="0"/>
<Annotations>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="size" mime-type="application/x-open-simulation-interface; type=SensorData; version=@OSIVERSION@"/></Tool>
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISimulationModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="size" mime-type="application/x-open-simulation-interface; type=SensorData; version=@OSIVERSION@"/></Tool>
</Annotations>
</ScalarVariable>
<ScalarVariable name="dummy" valueReference="0" causality="parameter" variability="fixed">
Expand Down
Loading