Skip to content

Commit 471cb63

Browse files
pmaijdsika
pmai
authored and
jdsika
committed
Fix docs and spec references, build instructions (#52)
1 parent a1eab05 commit 471cb63

File tree

2 files changed

+11
-72
lines changed

2 files changed

+11
-72
lines changed

‎README.md

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

33
[![Build Status](https://travis-ci.org/OpenSimulationInterface/osi-sensor-model-packaging.svg?branch=master)](https://travis-ci.org/OpenSimulationInterface/osi-sensor-model-packaging)
44

5-
OSI Sensor Model Packaging specifies ways in which 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. For more detailed information see the [official documentation](https://opensimulationinterface.github.io/osi-documentation/osi-sensor-model-packaging/README.html).
5+
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.
6+
The specification can be found in the [doc/specification.rst](doc/specification.rst) document in this repository.
7+
8+
For more detailed information see the [official documentation](https://opensimulationinterface.github.io/osi-documentation/osi-sensor-model-packaging/README.html).
69

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

@@ -13,69 +16,7 @@ The [`OSMPDummySource`](https://github.com/OpenSimulationInterface/osi-sensor-mo
1316

1417
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.
1518

16-
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. Below you can find an example `modelDescription.xml` file that would satisfy the requirements of this document for a sensor model FMU with one input and output and no additional features:
17-
18-
```XML
19-
<?xml version="1.0" encoding="UTF-8"?>
20-
<fmiModelDescription
21-
fmiVersion="2.0"
22-
modelName="OSI Sensor Model Packaging Demo FMU"
23-
guid="aabc2174e20f08597cfae6947c96bf86"
24-
variableNamingConvention="structured">
25-
<CoSimulation
26-
modelIdentifier="OSMPDemoFMU"
27-
canNotUseMemoryManagementFunctions="true"/>
28-
<DefaultExperiment startTime="0.0" stepSize="0.020"/>
29-
<VendorAnnotations>
30-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp version="1.0.0" osi-version="3.0.0"/></Tool>
31-
</VendorAnnotations>
32-
<ModelVariables>
33-
<ScalarVariable name="OSMPSensorViewIn.base.lo" valueReference="0" causality="input" variability="discrete">
34-
<Integer start="0"/>
35-
<Annotations>
36-
<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.0.0"/></Tool>
37-
</Annotations>
38-
</ScalarVariable>
39-
<ScalarVariable name="OSMPSensorViewIn.base.hi" valueReference="1" causality="input" variability="discrete">
40-
<Integer start="0"/>
41-
<Annotations>
42-
<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.0.0"/></Tool>
43-
</Annotations>
44-
</ScalarVariable>
45-
<ScalarVariable name="OSMPSensorViewIn.size" valueReference="2" causality="input" variability="discrete">
46-
<Integer start="0"/>
47-
<Annotations>
48-
<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.0.0"/></Tool>
49-
</Annotations>
50-
</ScalarVariable>
51-
<ScalarVariable name="OSMPSensorDataOut.base.lo" valueReference="3" causality="output" variability="discrete" initial="exact">
52-
<Integer start="0"/>
53-
<Annotations>
54-
<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.0.0"/></Tool>
55-
</Annotations>
56-
</ScalarVariable>
57-
<ScalarVariable name="OSMPSensorDataOut.base.hi" valueReference="4" causality="output" variability="discrete" initial="exact">
58-
<Integer start="0"/>
59-
<Annotations>
60-
<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.0.0"/></Tool>
61-
</Annotations>
62-
</ScalarVariable>
63-
<ScalarVariable name="OSMPSensorDataOut.size" valueReference="5" causality="output" variability="discrete" initial="exact">
64-
<Integer start="0"/>
65-
<Annotations>
66-
<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.0.0"/></Tool>
67-
</Annotations>
68-
</ScalarVariable>
69-
</ModelVariables>
70-
<ModelStructure>
71-
<Outputs>
72-
<Unknown index="4"/>
73-
<Unknown index="5"/>
74-
<Unknown index="6"/>
75-
</Outputs>
76-
</ModelStructure>
77-
</fmiModelDescription>
78-
```
19+
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.
7920

8021
## Installation
8122
##### Dependencies
@@ -92,11 +33,12 @@ $ sudo apt-get install libprotobuf-dev protobuf-compiler
9233
##### Build and install example
9334
```bash
9435
$ git clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.git
95-
$ cd osi-sensor-model-packaging/examples
96-
$ git clone https://github.com/OpenSimulationInterface/open-simulation-interface.git
36+
$ cd osi-sensor-model-packaging
37+
$ git submodule update --init
38+
$ cd examples
9739
$ mkdir -p build
9840
$ cd build
9941
$ cmake ..
10042
$ make
10143
$ sudo make install
102-
```
44+
```

‎doc/description.rst renamed to ‎doc/specification.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
General Description
2-
==========================
1+
OSI Sensor Model Packaging Specification
2+
========================================
33

44
This document specifies the ways in which environmental effect models,
55
sensor models and logical models using the `Open Simulation Interface`_
@@ -469,6 +469,3 @@ released.
469469
.. _RFC 2119: https://www.ietf.org/rfc/rfc2119.txt
470470
.. _FMI: https://fmi-standard.org/
471471
.. _FMI 2.0 standard: https://svn.modelica.org/fmi/branches/public/specifications/v2.0/FMI_for_ModelExchange_and_CoSimulation_v2.0.pdf
472-
473-
.. |Build Status| image:: https://travis-ci.org/OpenSimulationInterface/osi-sensor-model-packaging.svg?branch=master
474-
:target: https://travis-ci.org/OpenSimulationInterface/osi-sensor-model-packaging

0 commit comments

Comments
 (0)