The catkin plugin

The catkin plugin is useful when building ROS parts.

This plugin uses the common plugin keywords as well as those for “sources”. For more information, see Snapcraft parts metadata.

Additionally, this plugin uses the following plugin-specific keywords:

  • catkin-packages (list of strings)
    List of catkin packages to build.
  • source-space (string)
    The source space containing Catkin packages.
    Defaults to src.
  • rosdistro (string)
    The ROS distro required by this system.
    Defaults to indigo.
  • include-roscore (boolean)
    Whether or not to include roscore with the part.
    Defaults to true.
  • rosinstall-files (list of strings)
    List of rosinstall files to merge while pulling. Paths are relative to the source.
  • recursive-rosinstall (boolean)
    Whether or not to recursively merge/update rosinstall files from fetched sources. Will continue until all rosinstall files have been merged.
    Defaults to false.
  • catkin-cmake-args (list of strings)
    Configure flags to pass onto the cmake invocation from Catkin.
  • underlay (object)
    Used to inform Snapcraft that this snap isn’t standalone, and is actually overlaying a workspace from another snap via content sharing.
    Made up of two properties:
    • build-path (string)
      Build-time path to existing workspace to underlay the one being built, for example $SNAPCRAFT_STAGE/opt/ros/kinetic.
    • run-path (string)
      Run-time path of the underlay workspace (e.g. a subdirectory of the content interface’s target attribute.)
  • catkin-ros-master-uri (string)
    The URI to ros master setting the env variable ROS_MASTER_URI.
    Defaults to http://localhost:11311.

See The catkin-tools plugin for additional options related to building ROS parts.

For a simple example, see ROS applications, or search GitHub for projects already using the plugin.

This is a snapcraft plugin. See Snapcraft plugins and Supported plugins for further details on how plugins are used.

Last updated 7 months ago. Help improve this document in the forum.