General information about this repository, including legal information, build instructions and known issues/limitations, are given in README.md in the repository root.

The fmi_adapter_examples package

This ROS 2 package provides few examples for the use of the fmi_adapter package. It contains two FMU files DampedPendulum.fmu and TransportDelay.fmu (both created with the FMU SDK) and corresponding launch files. Furthermore, it includes a model of a damped pendulum in the Modelica language to create your own FMU.

Running the provided sample FMUs

Use ros2 launch fmi_adapter_examples simple_damped_pendulum.launch.py to simulate a damped pendulum (share/DampedPendulum.fmu) with a length of 1m. The pendulum's angle is published at topic /a with the default rate of 100Hz. The step size of the FMU's solver is 1ms.

To print the angle data on another console, invoke ros2 topic echo /a.

damped_pendulum_with_transport_delay.launch.py starts two nodes named /example/damped_pendulum and /example/transport_delay. The first one simulates share/DampedPendulum.fmu, where the length parameter is set to 25m by the launch file. The second node runs share/TransportDelay.fmu, where the delay parameter is set to 2.33s. The input subscription of the transport delay is remapped to the pendulum's angle topic and the delayed angle is published at /example/y.

Create and simulate your own DampedPendulum.fmu

There are several modeling tools that support the Modelica language and provide FMU export. Examples are Dymola, JModelica, and OpenModelica.

In the following, we explain the process by the example of OpenModelica, which has been also used to create the model of the damped pendulum at share/DampedPendulum.mo.

• Download and install OpenModelica for Linux as described in https://openmodelica.org/download/download-linux.
• Launch OMEdit and load the share/DampedPendulum.mo model file.
• Click on the DampedPendulum model in the project tree on the left.

• Navigate to Tools -> Options -> FMI and ensure that Version=2.0, Type=Co-Simulation and Platforms=Dynamic is selected.
• Then click File -> Export -> FMU.
• The path of the resulting FMU file is shown in the message browser at the bottom of the window, typically /tmp/OpenModelica_[user]/OMEdit/DampedPendulum/DampedPendulum.fmu.

Now, you are prepared for simulating the FMU using the fmi_adapter package.

• Use the generic launch file of the package ros2 launch fmi_adapter fmi_adapter_node.launch.py fmu_path:=/tmp/OpenModelica_[user]/OMEdit/DampedPendulum/DampedPendulum.fmu

• You may print the pendulum's angle to the console by ros2 topic echo /revolute1_angle

Please see the README.md of the fmi_adapter package for how to load and run an FMU inside an application-specific ROS node or library.

Note on bug with mmc_mk_modelica_array in OpenModelica 1.12.0: If fmi_adapter crashes with the error message undefined symbol: mmc_mk_modelica_array, please patch the files

• /usr/include/omc/c/meta/meta_modelica.h
• /usr/include/omc/c/meta/meta_modelica_data.h

according to https://github.com/OpenModelica/OMCompiler/pull/2397/files and export the FMU again. Details on this bug are given in https://trac.openmodelica.org/OpenModelica/ticket/4899.

Changelog for package fmi_adapter_examples

2.1.2 (2023-04-13)

2.1.1 (2021-06-11)

2.1.0 (2021-03-24)

• Adapted launch files to API changes.

2.0.0 (2021-03-24)

0.1.8 (2020-05-14)

• Prepared for Foxy release.

0.1.7 (2020-01-30)

• Updated instructions for FMU export from OpenModelica.
• Created explicit output revolute1_angle.

0.1.6 (2019-11-05)

• Release for ROS 2 Eloquent.

0.1.5 (2019-05-24)

• Added example of launch file with new node composition feature.

0.1.4 (2019-05-23)

• Fixed link to FMU-SDK.

0.1.3 (2019-02-01)

0.1.2 (2019-01-25)

• Cleaned up dependency entries in package.xml.

0.1.1 (2019-01-23)

• Fixed missing testing and launch dependencies.

0.1.0 (2019-01-18)

• Initial version for ROS 2, ported from https://github.com/boschresearch/fmi_adapter/