Maintainer: nate AT openrobotics DOT org
Build | Status |
---|---|
Test coverage | |
Ubuntu Bionic | |
Homebrew | |
Windows |
Ignition Launch, a component of Ignition Robotics, provides a command line interface to run and manager application and plugins.
Ignition Launch is used to run and manage plugins and programs. A
configuration script can be used to specify which programs and plugins to
execute. Alternatively, individual programs and plugins can be run from the
command line. Example configuration scripts are located in the examples
directory.
- Automatic ERB parsing of configuration files.
- Pass arguments to launch files from the command line.
- Plugins to launch Gazebo, joystick interface, and a websocket server for simulation.
We recommend following the Binary Install instructions to get up and running as quickly and painlessly as possible.
The Source Install instructions should be used if you need the very latest software improvements, you need to modify the code, or you plan to make a contribution.
On Ubuntu systems, apt
can be used to install ignition-launch
:
sudo apt install libignition-launch<#>
Be sure to replace <#>
with a number value, such as 1 or 2, depending on
which version you need.
Source installation can be performed in UNIX systems by first installing the necessary prerequisites followed by building from source.
-
Install third-party libraries:
sudo apt-get -y install cmake build-essential curl cppcheck g++-8 doxygen ruby-ronn libtinyxml2-dev software-properties-common
-
Install required Ignition libraries
sudo sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list'
sudo sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-prerelease `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-prerelease.list'
wget http://packages.osrfoundation.org/gazebo.key -O - | sudo apt-key add -
sudo apt-get update
sudo apt-get -y install libignition-cmake2-dev libignition-gazebo2-dev
-
Clone the repository
git clone https://github.com/ignitionrobotics/ign-launch
-
Configure and build
cd ign-launch; mkdir build; cd build; cmake ..; make
-
Optionally, install Ignition Launch
sudo make install
Sample launch configuration files are in the examples directory.
Example
-
Run a configuration that launches Gazebo.
ign launch gazebo.ign
In the event that the installation is a mix of Debian and from source, command
line tools from ign-tools
may not work correctly.
A workaround for a single package is to define the environment variable
IGN_CONFIG_PATH
to point to the location of the Ignition library installation,
where the YAML file for the package is found, such as
export IGN_CONFIG_PATH=/usr/local/share/ignition
However, that environment variable only takes a single path, which means if the installations from source are in different locations, only one can be specified.
Another workaround for working with multiple Ignition libraries on the command line is using symbolic links to each library's YAML file.
mkdir ~/.ignition/tools/configs -p
cd ~/.ignition/tools/configs/
ln -s /usr/local/share/ignition/fuel4.yaml .
ln -s /usr/local/share/ignition/transport7.yaml .
ln -s /usr/local/share/ignition/transportlog7.yaml .
...
export IGN_CONFIG_PATH=$HOME/.ignition/tools/configs
This issue is tracked here.
API and tutorials can be found at https://ignitionrobotics.org/libs/launch.
You can also generate the documentation from a clone of this repository by following these steps.
-
You will need Doxygen. On Ubuntu Doxygen can be installed using
sudo apt-get install doxygen
-
Clone the repository
git clone https://github.com/ignitionrobotics/ign-launch
-
Configure and build the documentation.
cd ign-launch; mkdir build; cd build; cmake ../; make doc
-
View the documentation by running the following command from the build directory.
firefox doxygen/html/index.html
Follow these steps to run tests and static code analysis in your clone of this repository.
-
Follow the source install instruction.
-
Run tests.
make test
-
Static code checker.
make codecheck
Refer to the following table for information about important directories and files in this repository.
ign-launch
├── examples Example launch configurations.
├── include/ignition/launch Header files.
├── src Source files and unit tests.
├── test
│ ├── integration Integration tests.
│ ├── performance Performance tests.
│ └── regression Regression tests.
├── plugins Launch plugins, one per subdirectory.
├── Changelog.md Changelog.
└── CMakeLists.txt CMake build script.
Please see the contribution guide.
Please see CODE_OF_CONDUCT.md.
This library uses Semantic Versioning. Additionally, this library is part of the Ignition Robotics project which periodically releases a versioned set of compatible and complimentary libraries. See the Ignition Robotics website for version and release information.
This library is licensed under Apache 2.0. See also the LICENSE file.