https://github.com/opensimulationinterface/osi-sensor-model-packaging
This document specifies the ways in which sensor models are to be packaged for use in simulation environments with FMI 2.0
https://github.com/opensimulationinterface/osi-sensor-model-packaging
asam open-simulation-interface osi simulation
Last synced: 3 months ago
JSON representation
This document specifies the ways in which sensor models are to be packaged for use in simulation environments with FMI 2.0
- Host: GitHub
- URL: https://github.com/opensimulationinterface/osi-sensor-model-packaging
- Owner: OpenSimulationInterface
- License: other
- Created: 2017-01-31T16:21:37.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-11-13T11:53:15.000Z (7 months ago)
- Last Synced: 2025-12-17T07:01:44.704Z (5 months ago)
- Topics: asam, open-simulation-interface, osi, simulation
- Language: Batchfile
- Homepage:
- Size: 751 KB
- Stars: 43
- Watchers: 21
- Forks: 18
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OSI Sensor Model Packaging
[](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/actions/workflows/build.yaml)
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.
For more detailed information see the [official documentation](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/sensor-model/misc/introduction.html).
[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 [`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 [`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 [`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.
## Installation
##### Dependencies
Install `cmake` 3.10.2:
```bash
$ sudo apt-get install cmake
```
Install `protobuf` 3.0.0:
```bash
$ 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 submodule update --init
$ cd examples
$ mkdir -p build
$ cd build
$ cmake ..
$ cmake --build .
```