Repository Summary
Checkout URI | https://github.com/ros2/rosidl_typesupport_gurumdds.git |
VCS Type | git |
VCS Version | galactic |
Last Updated | 2022-05-09 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
Name | Version |
---|---|
gurumdds_cmake_module | 2.1.1 |
README
rosidl_typesupport_gurumdds
Typesupport package which generates interfaces used by rmw_gurumdds
.
Requirements
This project requires GurumDDS to be built. You can get trial version of GurumDDS here.
To use this, extract the archive to ~/gurumdds
or any directory you want. After that, move your gurumdds.lic
file to where you extracted the archive and set the environment variable GURUMDDS_LICENSE_PATH
to your gurumdds.lic
file. For example, if you extracted the archive to ~/gurumdds
, it should be GURUMDDS_LICENSE_PATH=~/gurumdds/gurumdds.lic
.
Packages
This project consists of three packages, gurumdds_cmake_module
, rosidl_typesupport_gurumdds_c
, and rosidl_typesupport_gurumdds_cpp
.
gurumdds_cmake_module
gurumdds_cmake_module
looks for GurumDDS, and provides the information to other packages.
For gurumdds_cmake_module
to work properly, you need to set GURUMDDS_HOME
environment variable to where GurumDDS is located.
For example, if you set GURUMDDS_HOME=~/gurumdds
, the directory ~/gurumdds
should look like this:
gurumdds
├── gurumdds.lic
├── gurumdds.yaml
├── examples
│ └── ...
├── include
│ └── gurumdds
│ ├── dcps.h
│ ├── dcpsx.h
│ ├── typesupport.h
│ └── xml.h
├── lib
│ └── libgurumdds.so
├── Makefile
└── tool
└── gurumidl
rosidl_typesupport_gurumdds_c and rosidl_typesupport_gurumdds_cpp(deprecated)
rosidl_typesupport_gurumdds_c
and rosidl_typesupport_gurumdds_cpp
generate C and C++ interfaces using GurumIDL, the preprocessor. These interfaces are used by rmw_gurumdds
. For more information, see README.md of the project
Branches
There are four active branches in this project: master, humble, galactic and foxy. New changes made in ROS2 repository will be applied to the master branch. If you want to use this project with ROS2 Rolling Ridley, Humble Hawksbill or Foxy Fitzroy, please use master, humble or foxy branch, respectively.
CONTRIBUTING
Any contribution that you make to this repository will be under the Apache 2 License, as dictated by that license:
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.