Python bindings for Inter-Module Communication Protocol (IMC) used to communicate between modules in the LSTS toolchain.

• Linux-based host operating system is required.
• git
• python3

git clone --recursive [email protected]:oceanscan/imcpy-omst.git

This includes the pybind11 submodule.

      COMMAND ${DUNE_PROGRAM_PYTHON}
      ${PROJECT_SOURCE_DIR}/programs/generators/imc_addresses.py
      ${extra_flags}
      -x ${DUNE_IMC_ADDRESSES_XML} ${PROJECT_SOURCE_DIR}/etc/common/imc-addresses.ini

pip3 install .

If you use the system python and only want to install for a single user, you can add --user to the install command without needing administrator rights. On Windows, the Windows SDK must be installed with Visual Studio and the CMake executable must be on the system PATH.

Replace the dune/imc submodules with the target versions

A config file named whitelist.cfg can be placed in the root folder to only create bindings for a subset of the IMC messages. This can be necessary when compiling on embedded systems, as the linker consumes much memory for the full message set. If an unknown message is parsed, it will be returned as the Message baseclass rather than a specialized message. Look at minimal_whitelist.cfg for a set of messages that should always be included.

• The imcpy library generates stub files for the bindings, meaning that you can have autocomplete and static type checking if your IDE supports them. This can for example be PyCharm or Jedi-based editors.