The catkin
plugin is useful when building ROS 1 parts.
Plugin-specific features and syntax are dependent on which base is being used, as outlined below:
This plugin uses the common plugin keywords as well as those for “sources”. For more information, see Snapcraft parts metadata.
For core20, this plugin is designed to work with the ROS 1 Noetic extension. If not using this extension, it is required to set the ROS_DISTRO
environment variable to noetic
using build-environment
.
This plugin enables the following plugin-specific keywords on core20:
Additionally, this plugin uses the following plugin-specific keywords:
catkin-packages
(list of strings)
List of catkin packages to build. If not specified, all packages in the
workspace will be built. If set to an empty list ([]
), no packages will
be built, which could be useful if you only want ROS debs in the snap.
catkin-packages-ignore
(list of strings)
List of catkin packages to ignore (i.e. not build or install). If not specified or set to an empty list ([]), no packages will be ignored.
catkin-cmake-args
(list of strings)
Arguments to pass to cmake projects.
For core, this plugin is designed to work with the ROS Kinetic distro.
For core18, this plugin is designed to work with the ROS Melodic distro.
This plugin enables the following plugin-specific keywords on core|core18:
catkin-packages
(list of strings)[]
), no packages willsource-space
(string)src
.include-roscore
(boolean)rosinstall-files
(list of strings)recursive-rosinstall
(boolean)catkin-cmake-args
(list of strings)underlay
(object)build-path
(string)$SNAPCRAFT_STAGE/opt/ros/kinetic
.run-path
(string)catkin-ros-master-uri
(string)http://localhost:11311
.See the catkin-tools plugin plugin for additional methods for building ROS 1 parts. Also see the colcon plugin for building ROS 2 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 5 months ago. Help improve this document in the forum.