Maintainer: caguero AT openrobotics DOT org
| Build | Status |
|---|---|
| Test coverage |  |
| Ubuntu Bionic | |
| Homebrew | |
| Windows |
Ignition Transport, a component of Ignition Robotics, provides fast and efficient asyncronous message passing, services, and data logging.
Ignition Transport is an open source communication library that allows exchanging data between clients. In our context, a client is called a node. Nodes might be running within the same process in the same machine or in machines located in different continents. Ignition Transport is multi-platform (Linux, Mac OS X, and Windows), so all the low level details, such as data alignment or endianness are hidden for you.
Ignition Transport uses Google Protocol buffers as the data serialization format for communicating between nodes. Users can define their own messages using the Protobuf utils, and then, exchange them between the nodes. Ignition Transport discovers, serializes and delivers messages to the destinations using a combination of custom code and ZeroMQ.
See the installation tutorial.
See tutorials and the example directory in the source code.
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 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
This issue is tracked here.
Visit the documentation page.
ign-transport
├── conf Configuration file for the integration with the `ign` CLI tool.
├── docker Dockerfile with ign-transport installed and scripts to build and run the code.
├── example Example programs that use most of the Ignition Transport API.
├── include Header files that get installed.
├── log All the code related with Ignition Transport logging.
├── src Source code of the core library.
├── test A directory of integration, performance and regression tests.
└── tutorials A set of tutorials about Ignition Transport features.
Please see CONTRIBUTING.md.
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.